/mandos/release : revision 237.7.772

1

#!/usr/bin/python

2

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

3

#

1

#!/usr/bin/python3 -bI

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

80

import unittest

81

import random

82

import shlex

72

83

73

84

import dbus

74

85

import dbus.service

75

import gobject

76

import avahi

86

import gi

87

from gi.repository import GLib

77

88

from dbus.mainloop.glib import DBusGMainLoop

78

89

import ctypes

79

90

import ctypes.util

80

91

import xml.dom.minidom

81

92

import inspect

82

93

83

try:

94

if sys.version_info.major == 2:

95

__metaclass__ = type

96

str = unicode

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

84

122

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

123

except AttributeError:

86

124

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

87

127

from IN import SO_BINDTODEVICE

88

128

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.6"

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.12"

92

147

stored_state_file = "clients.pickle"

93

148

94

149

logger = logging.getLogger()

150

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

95

151

syslogger = None

96

152

97

153

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

101

156

except (OSError, AttributeError):

157

102

158

def if_nametoindex(interface):

103

159

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

104

160

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

105

161

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

106

162

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

163

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

164

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

111

165

return interface_index

112

166

113

167

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

114

184

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

115

185

"""init logger and add loglevel"""

116

186

117

187

global syslogger

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

122

191

syslogger.setFormatter(logging.Formatter

123

192

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

124

193

' %(message)s'))

125

194

logger.addHandler(syslogger)

126

195

127

196

if debug:

128

197

console = logging.StreamHandler()

129

198

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

139

208

pass

140

209

141

210

142

class PGPEngine(object):

211

class PGPEngine:

143

212

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

213

144

214

def __init__(self):

145

215

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

146

227

self.gnupgargs = ['--batch',

147

'--home', self.tempdir,

228

'--homedir', self.tempdir,

148

229

'--force-mdc',

149

'--quiet',

150

'--no-use-agent']

151

230

'--quiet']

231

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

232

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

233

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

234

152

235

def __enter__(self):

153

236

return self

154

237

155

238

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

156

239

self._cleanup()

157

240

return False

158

241

159

242

def __del__(self):

160

243

self._cleanup()

161

244

162

245

def _cleanup(self):

163

246

if self.tempdir is not None:

164

247

# Delete contents of tempdir

165

248

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

166

topdown = False):

249

topdown=False):

167

250

for filename in files:

168

251

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

169

252

for dirname in dirs:

171

254

# Remove tempdir

172

255

os.rmdir(self.tempdir)

173

256

self.tempdir = None

174

257

175

258

def password_encode(self, password):

176

259

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

177

260

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

182

265

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

183

266

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

184

267

return encoded

185

268

186

269

def encrypt(self, data, password):

187

270

passphrase = self.password_encode(password)

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

190

273

passfile.write(passphrase)

191

274

passfile.flush()

192

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

275

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

193

276

'--passphrase-file',

194

277

passfile.name]

195

278

+ self.gnupgargs,

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

200

283

if proc.returncode != 0:

201

284

raise PGPError(err)

202

285

return ciphertext

203

286

204

287

def decrypt(self, data, password):

205

288

passphrase = self.password_encode(password)

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

208

291

passfile.write(passphrase)

209

292

passfile.flush()

210

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

293

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

211

294

'--passphrase-file',

212

295

passfile.name]

213

296

+ self.gnupgargs,

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

219

301

if proc.returncode != 0:

220

302

raise PGPError(err)

221

303

return decrypted_plaintext

222

304

223

305

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

224

332

class AvahiError(Exception):

225

333

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

226

334

self.value = value

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

335

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

336

**kwargs)

337

230

338

231

339

class AvahiServiceError(AvahiError):

232

340

pass

233

341

342

234

343

class AvahiGroupError(AvahiError):

235

344

pass

236

345

237

346

238

class AvahiService(object):

347

class AvahiService:

239

348

"""An Avahi (Zeroconf) service.

240

349

241

350

Attributes:

242

351

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

243

352

Used to optionally bind to the specified interface.

255

364

server: D-Bus Server

256

365

bus: dbus.SystemBus()

257

366

"""

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

263

379

self.interface = interface

264

380

self.name = name

265

381

self.type = servicetype

274

390

self.server = None

275

391

self.bus = bus

276

392

self.entry_group_state_changed_match = None

277

278

def rename(self):

393

394

def rename(self, remove=True):

279

395

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

280

396

if self.rename_count >= self.max_renames:

281

397

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

282

398

" after %i retries, exiting.",

283

399

self.rename_count)

284

400

raise AvahiServiceError("Too many renames")

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

287

404

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

288

405

self.name)

289

self.remove()

406

if remove:

407

self.remove()

290

408

try:

291

409

self.add()

292

410

except dbus.exceptions.DBusException as error:

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

411

if (error.get_dbus_name()

412

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

413

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

414

return self.rename(remove=False)

415

else:

416

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

417

self.cleanup()

418

os._exit(1)

419

298

420

def remove(self):

299

421

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

300

422

if self.entry_group_state_changed_match is not None:

302

424

self.entry_group_state_changed_match = None

303

425

if self.group is not None:

304

426

self.group.Reset()

305

427

306

428

def add(self):

307

429

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

308

430

self.remove()

325

447

dbus.UInt16(self.port),

326

448

avahi.string_array_to_txt_array(self.TXT))

327

449

self.group.Commit()

328

450

329

451

def entry_group_state_changed(self, state, error):

330

452

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

331

453

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

332

454

333

455

if state == avahi.ENTRY_GROUP_ESTABLISHED:

334

456

logger.debug("Zeroconf service established.")

335

457

elif state == avahi.ENTRY_GROUP_COLLISION:

337

459

self.rename()

338

460

elif state == avahi.ENTRY_GROUP_FAILURE:

339

461

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

340

unicode(error))

341

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

342

.format(error))

343

462

str(error))

463

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

464

344

465

def cleanup(self):

345

466

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

346

467

if self.group is not None:

351

472

pass

352

473

self.group = None

353

474

self.remove()

354

475

355

476

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

356

477

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

357

478

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

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"Zeroconf server failure" }

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

365

485

if state in bad_states:

366

486

if bad_states[state] is not None:

367

487

if error is None:

370

490

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

371

491

self.cleanup()

372

492

elif state == avahi.SERVER_RUNNING:

373

self.add()

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

logger.info("Local Zeroconf service name"

499

" collision.")

500

return self.rename(remove=False)

501

else:

502

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

503

self.cleanup()

504

os._exit(1)

374

505

else:

375

506

if error is None:

376

507

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

377

508

else:

378

509

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

379

510

380

511

def activate(self):

381

512

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

382

513

if self.server is None:

386

517

follow_name_owner_changes=True),

387

518

avahi.DBUS_INTERFACE_SERVER)

388

519

self.server.connect_to_signal("StateChanged",

389

self.server_state_changed)

520

self.server_state_changed)

390

521

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

391

522

392

523

393

524

class AvahiServiceToSyslog(AvahiService):

394

def rename(self):

525

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

395

526

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

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

.format(self.name)))

527

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

528

**kwargs)

529

syslogger.setFormatter(logging.Formatter(

530

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

531

.format(self.name)))

401

532

return ret

402

533

403

534

404

def timedelta_to_milliseconds(td):

405

"Convert a datetime.timedelta() to milliseconds"

406

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

407

+ (td.seconds * 1000)

408

+ (td.microseconds // 1000))

409

410

411

class Client(object):

535

# Pretend that we have a GnuTLS module

536

class gnutls:

537

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

538

539

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

540

if library is None:

541

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

542

_library = ctypes.cdll.LoadLibrary(library)

543

del library

544

545

# Unless otherwise indicated, the constants and types below are

546

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

547

548

# Constants

549

E_SUCCESS = 0

550

E_INTERRUPTED = -52

551

E_AGAIN = -28

552

CRT_OPENPGP = 2

553

CRT_RAWPK = 3

554

CLIENT = 2

555

SHUT_RDWR = 0

556

CRD_CERTIFICATE = 1

557

E_NO_CERTIFICATE_FOUND = -49

558

X509_FMT_DER = 0

559

NO_TICKETS = 1<<10

560

ENABLE_RAWPK = 1<<18

561

CTYPE_PEERS = 3

562

KEYID_USE_SHA256 = 1 # gnutls/x509.h

563

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

564

565

# Types

566

class session_int(ctypes.Structure):

567

_fields_ = []

568

session_t = ctypes.POINTER(session_int)

569

570

class certificate_credentials_st(ctypes.Structure):

571

_fields_ = []

572

certificate_credentials_t = ctypes.POINTER(

573

certificate_credentials_st)

574

certificate_type_t = ctypes.c_int

575

576

class datum_t(ctypes.Structure):

577

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

578

('size', ctypes.c_uint)]

579

580

class openpgp_crt_int(ctypes.Structure):

581

_fields_ = []

582

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

583

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

584

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

585

credentials_type_t = ctypes.c_int

586

transport_ptr_t = ctypes.c_void_p

587

close_request_t = ctypes.c_int

588

589

# Exceptions

590

class Error(Exception):

591

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

592

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

593

# code is passed, convert it to a string with

594

# gnutls.strerror()

595

self.code = code

596

if message is None and code is not None:

597

message = gnutls.strerror(code)

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

# Classes

605

class Credentials:

606

def __init__(self):

607

self._c_object = gnutls.certificate_credentials_t()

608

gnutls.certificate_allocate_credentials(

609

ctypes.byref(self._c_object))

610

self.type = gnutls.CRD_CERTIFICATE

611

612

def __del__(self):

613

gnutls.certificate_free_credentials(self._c_object)

614

615

class ClientSession:

616

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

617

self._c_object = gnutls.session_t()

618

gnutls_flags = gnutls.CLIENT

619

if gnutls.check_version(b"3.5.6"):

620

gnutls_flags |= gnutls.NO_TICKETS

621

if gnutls.has_rawpk:

622

gnutls_flags |= gnutls.ENABLE_RAWPK

623

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

624

del gnutls_flags

625

gnutls.set_default_priority(self._c_object)

626

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

627

gnutls.handshake_set_private_extensions(self._c_object,

628

True)

629

self.socket = socket

630

if credentials is None:

631

credentials = gnutls.Credentials()

632

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

633

ctypes.cast(credentials._c_object,

634

ctypes.c_void_p))

635

self.credentials = credentials

636

637

def __del__(self):

638

gnutls.deinit(self._c_object)

639

640

def handshake(self):

641

return gnutls.handshake(self._c_object)

642

643

def send(self, data):

644

data = bytes(data)

645

data_len = len(data)

646

while data_len > 0:

647

data_len -= gnutls.record_send(self._c_object,

648

data[-data_len:],

649

data_len)

650

651

def bye(self):

652

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

653

654

# Error handling functions

655

def _error_code(result):

656

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

657

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

658

if result >= 0:

659

return result

660

if result == gnutls.E_NO_CERTIFICATE_FOUND:

661

raise gnutls.CertificateSecurityError(code=result)

662

raise gnutls.Error(code=result)

663

664

def _retry_on_error(result, func, arguments):

665

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

666

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

667

while result < 0:

668

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

669

return _error_code(result)

670

result = func(*arguments)

671

return result

672

673

# Unless otherwise indicated, the function declarations below are

674

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

675

676

# Functions

677

priority_set_direct = _library.gnutls_priority_set_direct

678

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

679

ctypes.POINTER(ctypes.c_char_p)]

680

priority_set_direct.restype = _error_code

681

682

init = _library.gnutls_init

683

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

684

init.restype = _error_code

685

686

set_default_priority = _library.gnutls_set_default_priority

687

set_default_priority.argtypes = [session_t]

688

set_default_priority.restype = _error_code

689

690

record_send = _library.gnutls_record_send

691

record_send.argtypes = [session_t, ctypes.c_void_p,

692

ctypes.c_size_t]

693

record_send.restype = ctypes.c_ssize_t

694

record_send.errcheck = _retry_on_error

695

696

certificate_allocate_credentials = (

697

_library.gnutls_certificate_allocate_credentials)

698

certificate_allocate_credentials.argtypes = [

699

ctypes.POINTER(certificate_credentials_t)]

700

certificate_allocate_credentials.restype = _error_code

701

702

certificate_free_credentials = (

703

_library.gnutls_certificate_free_credentials)

704

certificate_free_credentials.argtypes = [

705

certificate_credentials_t]

706

certificate_free_credentials.restype = None

707

708

handshake_set_private_extensions = (

709

_library.gnutls_handshake_set_private_extensions)

710

handshake_set_private_extensions.argtypes = [session_t,

711

ctypes.c_int]

712

handshake_set_private_extensions.restype = None

713

714

credentials_set = _library.gnutls_credentials_set

715

credentials_set.argtypes = [session_t, credentials_type_t,

716

ctypes.c_void_p]

717

credentials_set.restype = _error_code

718

719

strerror = _library.gnutls_strerror

720

strerror.argtypes = [ctypes.c_int]

721

strerror.restype = ctypes.c_char_p

722

723

certificate_type_get = _library.gnutls_certificate_type_get

724

certificate_type_get.argtypes = [session_t]

725

certificate_type_get.restype = _error_code

726

727

certificate_get_peers = _library.gnutls_certificate_get_peers

728

certificate_get_peers.argtypes = [session_t,

729

ctypes.POINTER(ctypes.c_uint)]

730

certificate_get_peers.restype = ctypes.POINTER(datum_t)

731

732

global_set_log_level = _library.gnutls_global_set_log_level

733

global_set_log_level.argtypes = [ctypes.c_int]

734

global_set_log_level.restype = None

735

736

global_set_log_function = _library.gnutls_global_set_log_function

737

global_set_log_function.argtypes = [log_func]

738

global_set_log_function.restype = None

739

740

deinit = _library.gnutls_deinit

741

deinit.argtypes = [session_t]

742

deinit.restype = None

743

744

handshake = _library.gnutls_handshake

745

handshake.argtypes = [session_t]

746

handshake.restype = _error_code

747

handshake.errcheck = _retry_on_error

748

749

transport_set_ptr = _library.gnutls_transport_set_ptr

750

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

751

transport_set_ptr.restype = None

752

753

bye = _library.gnutls_bye

754

bye.argtypes = [session_t, close_request_t]

755

bye.restype = _error_code

756

bye.errcheck = _retry_on_error

757

758

check_version = _library.gnutls_check_version

759

check_version.argtypes = [ctypes.c_char_p]

760

check_version.restype = ctypes.c_char_p

761

762

_need_version = b"3.3.0"

763

if check_version(_need_version) is None:

764

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

765

.format(_need_version))

766

767

_tls_rawpk_version = b"3.6.6"

768

has_rawpk = bool(check_version(_tls_rawpk_version))

769

770

if has_rawpk:

771

# Types

772

class pubkey_st(ctypes.Structure):

773

_fields = []

774

pubkey_t = ctypes.POINTER(pubkey_st)

775

776

x509_crt_fmt_t = ctypes.c_int

777

778

# All the function declarations below are from

779

# gnutls/abstract.h

780

pubkey_init = _library.gnutls_pubkey_init

781

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

782

pubkey_init.restype = _error_code

783

784

pubkey_import = _library.gnutls_pubkey_import

785

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

786

x509_crt_fmt_t]

787

pubkey_import.restype = _error_code

788

789

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

790

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

791

ctypes.POINTER(ctypes.c_ubyte),

792

ctypes.POINTER(ctypes.c_size_t)]

793

pubkey_get_key_id.restype = _error_code

794

795

pubkey_deinit = _library.gnutls_pubkey_deinit

796

pubkey_deinit.argtypes = [pubkey_t]

797

pubkey_deinit.restype = None

798

else:

799

# All the function declarations below are from

800

# gnutls/openpgp.h

801

802

openpgp_crt_init = _library.gnutls_openpgp_crt_init

803

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

804

openpgp_crt_init.restype = _error_code

805

806

openpgp_crt_import = _library.gnutls_openpgp_crt_import

807

openpgp_crt_import.argtypes = [openpgp_crt_t,

808

ctypes.POINTER(datum_t),

809

openpgp_crt_fmt_t]

810

openpgp_crt_import.restype = _error_code

811

812

openpgp_crt_verify_self = \

813

_library.gnutls_openpgp_crt_verify_self

814

openpgp_crt_verify_self.argtypes = [

815

openpgp_crt_t,

816

ctypes.c_uint,

817

ctypes.POINTER(ctypes.c_uint),

818

]

819

openpgp_crt_verify_self.restype = _error_code

820

821

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

822

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

823

openpgp_crt_deinit.restype = None

824

825

openpgp_crt_get_fingerprint = (

826

_library.gnutls_openpgp_crt_get_fingerprint)

827

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

828

ctypes.c_void_p,

829

ctypes.POINTER(

830

ctypes.c_size_t)]

831

openpgp_crt_get_fingerprint.restype = _error_code

832

833

if check_version(b"3.6.4"):

834

certificate_type_get2 = _library.gnutls_certificate_type_get2

835

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

836

certificate_type_get2.restype = _error_code

837

838

# Remove non-public functions

839

del _error_code, _retry_on_error

840

841

842

def call_pipe(connection, # : multiprocessing.Connection

843

func, *args, **kwargs):

844

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

845

846

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

847

return value on the provided multiprocessing.Connection.

848

"""

849

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

850

connection.close()

851

852

853

class Client:

412

854

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

413

855

414

856

Attributes:

415

857

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

416

858

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

417

859

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

418

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

419

to see if the client lives.

420

'None' if no process is running.

421

checker_callback_tag: a gobject event source tag, or None

860

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

861

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

862

running.

863

checker_callback_tag: a GLib event source tag, or None

422

864

checker_command: string; External command which is run to check

423

865

if client lives. %() expansions are done at

424

866

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

425

867

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

426

checker_initiator_tag: a gobject event source tag, or None

868

checker_initiator_tag: a GLib event source tag, or None

427

869

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

428

870

client_structure: Object describing what attributes a client has

429

871

and is used for storing the client at exit

430

872

current_checker_command: string; current running checker_command

431

disable_initiator_tag: a gobject event source tag, or None

873

disable_initiator_tag: a GLib event source tag, or None

432

874

enabled: bool()

433

875

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

434

uniquely identify the client

876

uniquely identify an OpenPGP client

877

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

878

a client using raw public keys

435

879

host: string; available for use by the checker command

436

880

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

437

881

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

439

883

last_checker_status: integer between 0 and 255 reflecting exit

440

884

status of last checker. -1 reflects crashed

441

885

checker, -2 means no checker completed yet.

886

last_checker_signal: The signal which killed the last checker, if

887

last_checker_status is -1

442

888

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

443

889

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

444

890

D-Bus identifiers

451

897

disabled, or None

452

898

server_settings: The server_settings dict from main()

453

899

"""

454

900

455

901

runtime_expansions = ("approval_delay", "approval_duration",

456

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

902

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

457

903

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

458

904

"last_approval_request", "last_checked_ok",

459

905

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

460

client_defaults = { "timeout": "PT5M",

461

"extended_timeout": "PT15M",

462

"interval": "PT2M",

463

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

464

"host": "",

465

"approval_delay": "PT0S",

466

"approval_duration": "PT1S",

467

"approved_by_default": "True",

468

"enabled": "True",

469

}

470

471

def timeout_milliseconds(self):

472

"Return the 'timeout' attribute in milliseconds"

473

return timedelta_to_milliseconds(self.timeout)

474

475

def extended_timeout_milliseconds(self):

476

"Return the 'extended_timeout' attribute in milliseconds"

477

return timedelta_to_milliseconds(self.extended_timeout)

478

479

def interval_milliseconds(self):

480

"Return the 'interval' attribute in milliseconds"

481

return timedelta_to_milliseconds(self.interval)

482

483

def approval_delay_milliseconds(self):

484

return timedelta_to_milliseconds(self.approval_delay)

485

906

client_defaults = {

907

"timeout": "PT5M",

908

"extended_timeout": "PT15M",

909

"interval": "PT2M",

910

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

911

"host": "",

912

"approval_delay": "PT0S",

913

"approval_duration": "PT1S",

914

"approved_by_default": "True",

915

"enabled": "True",

916

}

917

486

918

@staticmethod

487

919

def config_parser(config):

488

920

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

495

927

for client_name in config.sections():

496

928

section = dict(config.items(client_name))

497

929

client = settings[client_name] = {}

498

930

499

931

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

500

932

# Reformat values from string types to Python types

501

933

client["approved_by_default"] = config.getboolean(

502

934

client_name, "approved_by_default")

503

935

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

504

936

"enabled")

505

937

938

# Uppercase and remove spaces from key_id and fingerprint

939

# for later comparison purposes with return value from the

940

# key_id() and fingerprint() functions

941

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

942

.replace(" ", ""))

506

943

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

507

944

.replace(" ", ""))

508

945

if "secret" in section:

509

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

946

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

947

.encode("utf-8"),

948

"base64")

510

949

elif "secfile" in section:

511

950

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

512

951

(section["secfile"])),

513

952

"rb") as secfile:

514

953

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

515

954

else:

516

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

955

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

517

956

.format(section))

518

957

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

519

958

client["extended_timeout"] = string_to_delta(

527

966

client["last_approval_request"] = None

528

967

client["last_checked_ok"] = None

529

968

client["last_checker_status"] = -2

530

969

531

970

return settings

532

533

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

971

972

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

534

973

self.name = name

535

974

if server_settings is None:

536

975

server_settings = {}

537

976

self.server_settings = server_settings

538

977

# adding all client settings

539

for setting, value in settings.iteritems():

978

for setting, value in settings.items():

540

979

setattr(self, setting, value)

541

980

542

981

if self.enabled:

543

982

if not hasattr(self, "last_enabled"):

544

983

self.last_enabled = datetime.datetime.utcnow()

548

987

else:

549

988

self.last_enabled = None

550

989

self.expires = None

551

990

552

991

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

553

# Uppercase and remove spaces from fingerprint for later

554

# comparison purposes with return value from the fingerprint()

555

# function

992

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

556

993

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

557

994

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

558

995

datetime.datetime.utcnow())

559

996

560

997

# attributes specific for this server instance

561

998

self.checker = None

562

999

self.checker_initiator_tag = None

565

1002

self.current_checker_command = None

566

1003

self.approved = None

567

1004

self.approvals_pending = 0

568

self.changedstate = (multiprocessing_manager

569

.Condition(multiprocessing_manager

570

.Lock()))

571

self.client_structure = [attr for attr in

572

self.__dict__.iterkeys()

1005

self.changedstate = multiprocessing_manager.Condition(

1006

multiprocessing_manager.Lock())

1007

self.client_structure = [attr

1008

for attr in self.__dict__.keys()

573

1009

if not attr.startswith("_")]

574

1010

self.client_structure.append("client_structure")

575

576

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

577

lambda obj:

578

isinstance(obj,

579

property)):

1011

1012

for name, t in inspect.getmembers(

1013

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

580

1014

if not name.startswith("_"):

581

1015

self.client_structure.append(name)

582

1016

583

1017

# Send notice to process children that client state has changed

584

1018

def send_changedstate(self):

585

1019

with self.changedstate:

586

1020

self.changedstate.notify_all()

587

1021

588

1022

def enable(self):

589

1023

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

590

1024

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

595

1029

self.last_enabled = datetime.datetime.utcnow()

596

1030

self.init_checker()

597

1031

self.send_changedstate()

598

1032

599

1033

def disable(self, quiet=True):

600

1034

"""Disable this client."""

601

1035

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

603

1037

if not quiet:

604

1038

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

605

1039

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

606

gobject.source_remove(self.disable_initiator_tag)

1040

GLib.source_remove(self.disable_initiator_tag)

607

1041

self.disable_initiator_tag = None

608

1042

self.expires = None

609

1043

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

610

gobject.source_remove(self.checker_initiator_tag)

1044

GLib.source_remove(self.checker_initiator_tag)

611

1045

self.checker_initiator_tag = None

612

1046

self.stop_checker()

613

1047

self.enabled = False

614

1048

if not quiet:

615

1049

self.send_changedstate()

616

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

1050

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

617

1051

return False

618

1052

619

1053

def __del__(self):

620

1054

self.disable()

621

1055

622

1056

def init_checker(self):

623

1057

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

624

1058

# and every interval from then on.

625

1059

if self.checker_initiator_tag is not None:

626

gobject.source_remove(self.checker_initiator_tag)

627

self.checker_initiator_tag = (gobject.timeout_add

628

(self.interval_milliseconds(),

629

self.start_checker))

1060

GLib.source_remove(self.checker_initiator_tag)

1061

self.checker_initiator_tag = GLib.timeout_add(

1062

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

1063

+ 1)),

1064

self.start_checker)

630

1065

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

631

1066

if self.disable_initiator_tag is not None:

632

gobject.source_remove(self.disable_initiator_tag)

633

self.disable_initiator_tag = (gobject.timeout_add

634

(self.timeout_milliseconds(),

635

self.disable))

1067

GLib.source_remove(self.disable_initiator_tag)

1068

self.disable_initiator_tag = GLib.timeout_add(

1069

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

636

1070

# Also start a new checker *right now*.

637

1071

self.start_checker()

638

639

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

1072

1073

def checker_callback(self, source, condition, connection,

1074

command):

640

1075

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

1076

# Read return code from connection (see call_pipe)

1077

returncode = connection.recv()

1078

connection.close()

1079

if self.checker is not None:

1080

self.checker.join()

641

1081

self.checker_callback_tag = None

642

1082

self.checker = None

643

if os.WIFEXITED(condition):

644

self.last_checker_status = os.WEXITSTATUS(condition)

1083

1084

if returncode >= 0:

1085

self.last_checker_status = returncode

1086

self.last_checker_signal = None

645

1087

if self.last_checker_status == 0:

646

1088

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

647

1089

vars(self))

648

1090

self.checked_ok()

649

1091

else:

650

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

651

vars(self))

1092

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

652

1093

else:

653

1094

self.last_checker_status = -1

1095

self.last_checker_signal = -returncode

654

1096

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

655

1097

vars(self))

656

1098

return False

1099

657

1100

def checked_ok(self):

658

1101

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

659

1102

self.last_checked_ok = datetime.datetime.utcnow()

660

1103

self.last_checker_status = 0

1104

self.last_checker_signal = None

661

1105

self.bump_timeout()

662

1106

663

1107

def bump_timeout(self, timeout=None):

664

1108

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

665

1109

if timeout is None:

666

1110

timeout = self.timeout

667

1111

if self.disable_initiator_tag is not None:

668

gobject.source_remove(self.disable_initiator_tag)

1112

GLib.source_remove(self.disable_initiator_tag)

669

1113

self.disable_initiator_tag = None

670

1114

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

671

self.disable_initiator_tag = (gobject.timeout_add

672

(timedelta_to_milliseconds

673

(timeout), self.disable))

1115

self.disable_initiator_tag = GLib.timeout_add(

1116

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

674

1117

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

675

1118

676

1119

def need_approval(self):

677

1120

self.last_approval_request = datetime.datetime.utcnow()

678

1121

679

1122

def start_checker(self):

680

1123

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

681

1124

682

1125

If a checker already exists, leave it running and do

683

1126

nothing."""

684

1127

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

689

1132

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

690

1133

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

691

1134

# should be.

692

693

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

694

try:

695

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

696

except AttributeError:

697

pass

698

except OSError as error:

699

if error.errno != errno.ECHILD:

700

raise

701

else:

702

if pid:

703

logger.warning("Checker was a zombie")

704

gobject.source_remove(self.checker_callback_tag)

705

self.checker_callback(pid, status,

706

self.current_checker_command)

1135

1136

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

1137

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

1138

self.checker.join()

1139

self.checker = None

707

1140

# Start a new checker if needed

708

1141

if self.checker is None:

709

1142

# Escape attributes for the shell

710

escaped_attrs = dict(

711

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

712

for attr in

713

self.runtime_expansions)

1143

escaped_attrs = {

1144

attr: shlex.quote(str(getattr(self, attr)))

1145

for attr in self.runtime_expansions}

714

1146

try:

715

1147

command = self.checker_command % escaped_attrs

716

1148

except TypeError as error:

717

1149

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

718

self.checker_command, exc_info=error)

719

return True # Try again later

1150

self.checker_command,

1151

exc_info=error)

1152

return True # Try again later

720

1153

self.current_checker_command = command

721

try:

722

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

723

command, self.name)

724

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

725

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

726

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

727

# always replaced by /dev/null.)

728

# The exception is when not debugging but nevertheless

729

# running in the foreground; use the previously

730

# created wnull.

731

popen_args = {}

732

if (not self.server_settings["debug"]

733

and self.server_settings["foreground"]):

734

popen_args.update({"stdout": wnull,

735

"stderr": wnull })

736

self.checker = subprocess.Popen(command,

737

close_fds=True,

738

shell=True, cwd="/",

739

**popen_args)

740

except OSError as error:

741

logger.error("Failed to start subprocess",

742

exc_info=error)

743

return True

744

self.checker_callback_tag = (gobject.child_watch_add

745

(self.checker.pid,

746

self.checker_callback,

747

data=command))

748

# The checker may have completed before the gobject

749

# watch was added. Check for this.

750

try:

751

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

752

except OSError as error:

753

if error.errno == errno.ECHILD:

754

# This should never happen

755

logger.error("Child process vanished",

756

exc_info=error)

757

return True

758

raise

759

if pid:

760

gobject.source_remove(self.checker_callback_tag)

761

self.checker_callback(pid, status, command)

762

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

1154

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

1155

self.name)

1156

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

1157

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

1158

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

1159

# always replaced by /dev/null.)

1160

# The exception is when not debugging but nevertheless

1161

# running in the foreground; use the previously

1162

# created wnull.

1163

popen_args = {"close_fds": True,

1164

"shell": True,

1165

"cwd": "/"}

1166

if (not self.server_settings["debug"]

1167

and self.server_settings["foreground"]):

1168

popen_args.update({"stdout": wnull,

1169

"stderr": wnull})

1170

pipe = multiprocessing.Pipe(duplex=False)

1171

self.checker = multiprocessing.Process(

1172

target=call_pipe,

1173

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

1174

kwargs=popen_args)

1175

self.checker.start()

1176

self.checker_callback_tag = GLib.io_add_watch(

1177

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

1178

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1179

self.checker_callback, pipe[0], command)

1180

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

763

1181

return True

764

1182

765

1183

def stop_checker(self):

766

1184

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

767

1185

if self.checker_callback_tag:

768

gobject.source_remove(self.checker_callback_tag)

1186

GLib.source_remove(self.checker_callback_tag)

769

1187

self.checker_callback_tag = None

770

1188

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

771

1189

return

772

1190

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

773

try:

774

self.checker.terminate()

775

#time.sleep(0.5)

776

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

777

# self.checker.kill()

778

except OSError as error:

779

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

780

raise

1191

self.checker.terminate()

781

1192

self.checker = None

782

1193

783

1194

784

def dbus_service_property(dbus_interface, signature="v",

785

access="readwrite", byte_arrays=False):

1195

def dbus_service_property(dbus_interface,

1196

signature="v",

1197

access="readwrite",

1198

byte_arrays=False):

786

1199

"""Decorators for marking methods of a DBusObjectWithProperties to

787

1200

become properties on the D-Bus.

788

1201

789

1202

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

790

1203

and with one argument by "Set".

791

1204

792

1205

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

793

1206

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

794

1207

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

797

1210

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

798

1211

if byte_arrays and signature != "ay":

799

1212

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

800

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

1213

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

1214

801

1215

def decorator(func):

802

1216

func._dbus_is_property = True

803

1217

func._dbus_interface = dbus_interface

806

1220

func._dbus_name = func.__name__

807

1221

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

808

1222

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

809

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1223

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

810

1224

return func

1225

811

1226

return decorator

812

1227

813

1228

814

1229

def dbus_interface_annotations(dbus_interface):

815

1230

"""Decorator for marking functions returning interface annotations

816

1231

817

1232

Usage:

818

1233

819

1234

@dbus_interface_annotations("org.example.Interface")

820

1235

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

821

1236

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

822

1237

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

823

1238

"false"}

824

1239

"""

1240

825

1241

def decorator(func):

826

1242

func._dbus_is_interface = True

827

1243

func._dbus_interface = dbus_interface

828

1244

func._dbus_name = dbus_interface

829

1245

return func

1246

830

1247

return decorator

831

1248

832

1249

833

1250

def dbus_annotations(annotations):

834

1251

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

835

1252

Usage:

836

1253

1254

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

1255

"org.freedesktop.DBus.Property."

1256

"EmitsChangedSignal": "false"})

837

1257

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

838

1258

access="r")

839

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

840

"org.freedesktop.DBus.Property."

841

"EmitsChangedSignal": "false"})

842

1259

def Property_dbus_property(self):

843

1260

return dbus.Boolean(False)

1261

1262

See also the DBusObjectWithAnnotations class.

844

1263

"""

1264

845

1265

def decorator(func):

846

1266

func._dbus_annotations = annotations

847

1267

return func

1268

848

1269

return decorator

849

1270

850

1271

851

1272

class DBusPropertyException(dbus.exceptions.DBusException):

852

1273

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

853

1274

"""

854

def __unicode__(self):

855

return unicode(str(self))

1275

pass

856

1276

857

1277

858

1278

class DBusPropertyAccessException(DBusPropertyException):

867

1287

pass

868

1288

869

1289

870

class DBusObjectWithProperties(dbus.service.Object):

871

"""A D-Bus object with properties.

872

873

Classes inheriting from this can use the dbus_service_property

874

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

875

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

1290

class DBusObjectWithAnnotations(dbus.service.Object):

1291

"""A D-Bus object with annotations.

1292

1293

Classes inheriting from this can use the dbus_annotations

1294

decorator to add annotations to methods or signals.

876

1295

"""

877

1296

878

1297

@staticmethod

879

1298

def _is_dbus_thing(thing):

880

1299

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

881

1300

882

1301

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

883

1302

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

884

1303

"""

885

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

1304

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

886

1305

False)

887

1306

888

1307

def _get_all_dbus_things(self, thing):

889

1308

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

890

1309

"""

891

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

892

name),

1310

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

893

1311

athing.__get__(self))

894

1312

for cls in self.__class__.__mro__

895

1313

for name, athing in

896

inspect.getmembers(cls,

897

self._is_dbus_thing(thing)))

898

1314

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

1315

1316

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1317

out_signature="s",

1318

path_keyword='object_path',

1319

connection_keyword='connection')

1320

def Introspect(self, object_path, connection):

1321

"""Overloading of standard D-Bus method.

1322

1323

Inserts annotation tags on methods and signals.

1324

"""

1325

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

1326

connection)

1327

try:

1328

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

1329

1330

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

1331

# Add annotation tags

1332

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

1333

for tag in if_tag.getElementsByTagName(typ):

1334

annots = dict()

1335

for name, prop in (self.

1336

_get_all_dbus_things(typ)):

1337

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

1338

and prop._dbus_interface

1339

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

1340

annots.update(getattr(

1341

prop, "_dbus_annotations", {}))

1342

for name, value in annots.items():

1343

ann_tag = document.createElement(

1344

"annotation")

1345

ann_tag.setAttribute("name", name)

1346

ann_tag.setAttribute("value", value)

1347

tag.appendChild(ann_tag)

1348

# Add interface annotation tags

1349

for annotation, value in dict(

1350

itertools.chain.from_iterable(

1351

annotations().items()

1352

for name, annotations

1353

in self._get_all_dbus_things("interface")

1354

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

1355

)).items():

1356

ann_tag = document.createElement("annotation")

1357

ann_tag.setAttribute("name", annotation)

1358

ann_tag.setAttribute("value", value)

1359

if_tag.appendChild(ann_tag)

1360

# Fix argument name for the Introspect method itself

1361

if (if_tag.getAttribute("name")

1362

== dbus.INTROSPECTABLE_IFACE):

1363

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

1364

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

1365

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

1366

if (arg.getAttribute("direction")

1367

== "out"):

1368

arg.setAttribute("name",

1369

"xml_data")

1370

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

1371

document.unlink()

1372

except (AttributeError, xml.dom.DOMException,

1373

xml.parsers.expat.ExpatError) as error:

1374

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

1375

exc_info=error)

1376

return xmlstring

1377

1378

1379

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1380

"""A D-Bus object with properties.

1381

1382

Classes inheriting from this can use the dbus_service_property

1383

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

1384

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

1385

"""

1386

899

1387

def _get_dbus_property(self, interface_name, property_name):

900

1388

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

901

1389

property with the specified name and interface.

902

1390

"""

903

for cls in self.__class__.__mro__:

904

for name, value in (inspect.getmembers

905

(cls,

906

self._is_dbus_thing("property"))):

1391

for cls in self.__class__.__mro__:

1392

for name, value in inspect.getmembers(

1393

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

907

1394

if (value._dbus_name == property_name

908

1395

and value._dbus_interface == interface_name):

909

1396

return value.__get__(self)

910

1397

911

1398

# No such property

912

raise DBusPropertyNotFound(self.dbus_object_path + ":"

913

+ interface_name + "."

914

+ property_name)

915

916

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

1399

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

1400

self.dbus_object_path, interface_name, property_name))

1401

1402

@classmethod

1403

def _get_all_interface_names(cls):

1404

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

1405

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

1406

"_dbus_interface", None)

1407

for x in (inspect.getmro(cls))

1408

for attr in dir(x))

1409

if name is not None)

1410

1411

@dbus.service.method(dbus.PROPERTIES_IFACE,

1412

in_signature="ss",

917

1413

out_signature="v")

918

1414

def Get(self, interface_name, property_name):

919

1415

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

925

1421

if not hasattr(value, "variant_level"):

926

1422

return value

927

1423

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

928

1424

929

1425

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

930

1426

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

931

1427

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

938

1434

# signatures other than "ay".

939

1435

if prop._dbus_signature != "ay":

940

1436

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

941

"'ay' signature {0!r}"

1437

"'ay' signature {!r}"

942

1438

.format(prop._dbus_signature))

943

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

944

for byte in value))

1439

value = dbus.ByteArray(bytes(value))

945

1440

prop(value)

946

947

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

1441

1442

@dbus.service.method(dbus.PROPERTIES_IFACE,

1443

in_signature="s",

948

1444

out_signature="a{sv}")

949

1445

def GetAll(self, interface_name):

950

1446

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

951

1447

standard.

952

1448

953

1449

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

954

1450

"""

955

1451

properties = {}

965

1461

if not hasattr(value, "variant_level"):

966

1462

properties[name] = value

967

1463

continue

968

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

969

value.variant_level+1)

1464

properties[name] = type(value)(

1465

value, variant_level=value.variant_level + 1)

970

1466

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

971

1467

1468

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

1469

def PropertiesChanged(self, interface_name, changed_properties,

1470

invalidated_properties):

1471

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

1472

standard.

1473

"""

1474

pass

1475

972

1476

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

973

1477

out_signature="s",

974

1478

path_keyword='object_path',

975

1479

connection_keyword='connection')

976

1480

def Introspect(self, object_path, connection):

977

1481

"""Overloading of standard D-Bus method.

978

1482

979

1483

Inserts property tags and interface annotation tags.

980

1484

"""

981

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

982

connection)

1485

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1486

object_path,

1487

connection)

983

1488

try:

984

1489

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

1490

985

1491

def make_tag(document, name, prop):

986

1492

e = document.createElement("property")

987

1493

e.setAttribute("name", name)

988

1494

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

989

1495

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

990

1496

return e

1497

991

1498

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

992

1499

# Add property tags

993

1500

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

996

1503

if prop._dbus_interface

997

1504

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

998

1505

if_tag.appendChild(tag)

999

# Add annotation tags

1000

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

1001

for tag in if_tag.getElementsByTagName(typ):

1002

annots = dict()

1003

for name, prop in (self.

1004

_get_all_dbus_things(typ)):

1005

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

1006

and prop._dbus_interface

1007

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

1008

annots.update(getattr

1009

(prop,

1010

"_dbus_annotations",

1011

{}))

1012

for name, value in annots.iteritems():

1013

ann_tag = document.createElement(

1014

"annotation")

1015

ann_tag.setAttribute("name", name)

1016

ann_tag.setAttribute("value", value)

1017

tag.appendChild(ann_tag)

1018

# Add interface annotation tags

1019

for annotation, value in dict(

1020

itertools.chain.from_iterable(

1021

annotations().iteritems()

1022

for name, annotations in

1023

self._get_all_dbus_things("interface")

1024

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

1025

)).iteritems():

1026

ann_tag = document.createElement("annotation")

1027

ann_tag.setAttribute("name", annotation)

1028

ann_tag.setAttribute("value", value)

1029

if_tag.appendChild(ann_tag)

1506

# Add annotation tags for properties

1507

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

1508

annots = dict()

1509

for name, prop in self._get_all_dbus_things(

1510

"property"):

1511

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

1512

and prop._dbus_interface

1513

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

1514

annots.update(getattr(

1515

prop, "_dbus_annotations", {}))

1516

for name, value in annots.items():

1517

ann_tag = document.createElement(

1518

"annotation")

1519

ann_tag.setAttribute("name", name)

1520

ann_tag.setAttribute("value", value)

1521

tag.appendChild(ann_tag)

1030

1522

# Add the names to the return values for the

1031

1523

# "org.freedesktop.DBus.Properties" methods

1032

1524

if (if_tag.getAttribute("name")

1051

1543

return xmlstring

1052

1544

1053

1545

1546

try:

1547

dbus.OBJECT_MANAGER_IFACE

1548

except AttributeError:

1549

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

1550

1551

1552

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1553

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

1554

1555

Classes inheriting from this exposes the standard

1556

GetManagedObjects call and the InterfacesAdded and

1557

InterfacesRemoved signals on the standard

1558

"org.freedesktop.DBus.ObjectManager" interface.

1559

1560

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

1561

manually.

1562

"""

1563

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1564

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

1565

def GetManagedObjects(self):

1566

"""This function must be overridden"""

1567

raise NotImplementedError()

1568

1569

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1570

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

1571

def InterfacesAdded(self, object_path, interfaces_and_properties):

1572

pass

1573

1574

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

1575

def InterfacesRemoved(self, object_path, interfaces):

1576

pass

1577

1578

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1579

out_signature="s",

1580

path_keyword='object_path',

1581

connection_keyword='connection')

1582

def Introspect(self, object_path, connection):

1583

"""Overloading of standard D-Bus method.

1584

1585

Override return argument name of GetManagedObjects to be

1586

"objpath_interfaces_and_properties"

1587

"""

1588

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1589

object_path,

1590

connection)

1591

try:

1592

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

1593

1594

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

1595

# Fix argument name for the GetManagedObjects method

1596

if (if_tag.getAttribute("name")

1597

== dbus.OBJECT_MANAGER_IFACE):

1598

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

1599

if (cn.getAttribute("name")

1600

== "GetManagedObjects"):

1601

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

1602

if (arg.getAttribute("direction")

1603

== "out"):

1604

arg.setAttribute(

1605

"name",

1606

"objpath_interfaces"

1607

"_and_properties")

1608

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

1609

document.unlink()

1610

except (AttributeError, xml.dom.DOMException,

1611

xml.parsers.expat.ExpatError) as error:

1612

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

1613

exc_info=error)

1614

return xmlstring

1615

1616

1054

1617

def datetime_to_dbus(dt, variant_level=0):

1055

1618

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

1056

1619

if dt is None:

1057

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

1058

return dbus.String(dt.isoformat(),

1059

variant_level=variant_level)

1620

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

1621

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

1060

1622

1061

1623

1062

1624

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1064

1626

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

1065

1627

interface names according to the "alt_interface_names" mapping.

1066

1628

Usage:

1067

1629

1068

1630

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

1069

1631

"net.example.AlternateInterface"})

1070

1632

class SampleDBusObject(dbus.service.Object):

1071

1633

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

1072

1634

def SampleDBusMethod():

1073

1635

pass

1074

1636

1075

1637

The above "SampleDBusMethod" on "SampleDBusObject" will be

1076

1638

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

1077

1639

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

1078

1640

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

1079

1641

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

1080

1642

1081

1643

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

1082

1644

(from DBusObjectWithProperties) and interfaces (from the

1083

1645

dbus_interface_annotations decorator).

1084

1646

"""

1647

1085

1648

def wrapper(cls):

1086

1649

for orig_interface_name, alt_interface_name in (

1087

alt_interface_names.iteritems()):

1650

alt_interface_names.items()):

1088

1651

attr = {}

1089

1652

interface_names = set()

1090

1653

# Go though all attributes of the class

1092

1655

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

1093

1656

# with the wrong interface name

1094

1657

if (not hasattr(attribute, "_dbus_interface")

1095

or not attribute._dbus_interface

1096

.startswith(orig_interface_name)):

1658

or not attribute._dbus_interface.startswith(

1659

orig_interface_name)):

1097

1660

continue

1098

1661

# Create an alternate D-Bus interface name based on

1099

1662

# the current name

1100

alt_interface = (attribute._dbus_interface

1101

.replace(orig_interface_name,

1102

alt_interface_name))

1663

alt_interface = attribute._dbus_interface.replace(

1664

orig_interface_name, alt_interface_name)

1103

1665

interface_names.add(alt_interface)

1104

1666

# Is this a D-Bus signal?

1105

1667

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

1106

1668

# Extract the original non-method undecorated

1107

1669

# function by black magic

1108

nonmethod_func = (dict(

1670

if sys.version_info.major == 2:

1671

nonmethod_func = (dict(

1109

1672

zip(attribute.func_code.co_freevars,

1110

attribute.__closure__))["func"]

1111

.cell_contents)

1673

attribute.__closure__))

1674

["func"].cell_contents)

1675

else:

1676

nonmethod_func = (dict(

1677

zip(attribute.__code__.co_freevars,

1678

attribute.__closure__))

1679

["func"].cell_contents)

1112

1680

# Create a new, but exactly alike, function

1113

1681

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

1114

1682

# with the alternate D-Bus interface name

1115

new_function = (dbus.service.signal

1116

(alt_interface,

1117

attribute._dbus_signature)

1118

(types.FunctionType(

1119

nonmethod_func.func_code,

1120

nonmethod_func.func_globals,

1121

nonmethod_func.func_name,

1122

nonmethod_func.func_defaults,

1123

nonmethod_func.func_closure)))

1683

new_function = copy_function(nonmethod_func)

1684

new_function = (dbus.service.signal(

1685

alt_interface,

1686

attribute._dbus_signature)(new_function))

1124

1687

# Copy annotations, if any

1125

1688

try:

1126

new_function._dbus_annotations = (

1127

dict(attribute._dbus_annotations))

1689

new_function._dbus_annotations = dict(

1690

attribute._dbus_annotations)

1128

1691

except AttributeError:

1129

1692

pass

1693

1130

1694

# Define a creator of a function to call both the

1131

1695

# original and alternate functions, so both the

1132

1696

# original and alternate signals gets sent when

1135

1699

"""This function is a scope container to pass

1136

1700

func1 and func2 to the "call_both" function

1137

1701

outside of its arguments"""

1702

1703

@functools.wraps(func2)

1138

1704

def call_both(*args, **kwargs):

1139

1705

"""This function will emit two D-Bus

1140

1706

signals by calling func1 and func2"""

1141

1707

func1(*args, **kwargs)

1142

1708

func2(*args, **kwargs)

1709

# Make wrapper function look like a D-Bus

1710

# signal

1711

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

1712

if name.startswith("_dbus_"):

1713

setattr(call_both, name, attr)

1714

1143

1715

return call_both

1144

1716

# Create the "call_both" function and add it to

1145

1717

# the class

1150

1722

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

1151

1723

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

1152

1724

# to the class.

1153

attr[attrname] = (dbus.service.method

1154

(alt_interface,

1155

attribute._dbus_in_signature,

1156

attribute._dbus_out_signature)

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1725

attr[attrname] = (

1726

dbus.service.method(

1727

alt_interface,

1728

attribute._dbus_in_signature,

1729

attribute._dbus_out_signature)

1730

(copy_function(attribute)))

1163

1731

# Copy annotations, if any

1164

1732

try:

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1733

attr[attrname]._dbus_annotations = dict(

1734

attribute._dbus_annotations)

1167

1735

except AttributeError:

1168

1736

pass

1169

1737

# Is this a D-Bus property?

1172

1740

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

1173

1741

# property with the alternate D-Bus interface

1174

1742

# name. Add it to the class.

1175

attr[attrname] = (dbus_service_property

1176

(alt_interface,

1177

attribute._dbus_signature,

1178

attribute._dbus_access,

1179

attribute

1180

._dbus_get_args_options

1181

["byte_arrays"])

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

attribute.func_closure)))

1743

attr[attrname] = (dbus_service_property(

1744

alt_interface, attribute._dbus_signature,

1745

attribute._dbus_access,

1746

attribute._dbus_get_args_options

1747

["byte_arrays"])

1748

(copy_function(attribute)))

1188

1749

# Copy annotations, if any

1189

1750

try:

1190

attr[attrname]._dbus_annotations = (

1191

dict(attribute._dbus_annotations))

1751

attr[attrname]._dbus_annotations = dict(

1752

attribute._dbus_annotations)

1192

1753

except AttributeError:

1193

1754

pass

1194

1755

# Is this a D-Bus interface?

1197

1758

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

1198

1759

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

1199

1760

# to the class.

1200

attr[attrname] = (dbus_interface_annotations

1201

(alt_interface)

1202

(types.FunctionType

1203

(attribute.func_code,

1204

attribute.func_globals,

1205

attribute.func_name,

1206

attribute.func_defaults,

1207

attribute.func_closure)))

1761

attr[attrname] = (

1762

dbus_interface_annotations(alt_interface)

1763

(copy_function(attribute)))

1208

1764

if deprecate:

1209

1765

# Deprecate all alternate interfaces

1210

iname="_AlternateDBusNames_interface_annotation{0}"

1766

iname = "_AlternateDBusNames_interface_annotation{}"

1211

1767

for interface_name in interface_names:

1768

1212

1769

@dbus_interface_annotations(interface_name)

1213

1770

def func(self):

1214

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

1215

"true" }

1771

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

1772

"true"}

1216

1773

# Find an unused name

1217

1774

for aname in (iname.format(i)

1218

1775

for i in itertools.count()):

1222

1779

if interface_names:

1223

1780

# Replace the class with a new subclass of it with

1224

1781

# methods, signals, etc. as created above.

1225

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

1226

(cls,), attr)

1782

if sys.version_info.major == 2:

1783

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

1784

(cls, ), attr)

1785

else:

1786

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

1787

(cls, ), attr)

1227

1788

return cls

1789

1228

1790

return wrapper

1229

1791

1230

1792

1231

1793

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

1232

"se.bsnet.fukt.Mandos"})

1794

"se.bsnet.fukt.Mandos"})

1233

1795

class ClientDBus(Client, DBusObjectWithProperties):

1234

1796

"""A Client class using D-Bus

1235

1797

1236

1798

Attributes:

1237

1799

dbus_object_path: dbus.ObjectPath

1238

1800

bus: dbus.SystemBus()

1239

1801

"""

1240

1802

1241

1803

runtime_expansions = (Client.runtime_expansions

1242

+ ("dbus_object_path",))

1243

1804

+ ("dbus_object_path", ))

1805

1806

_interface = "se.recompile.Mandos.Client"

1807

1244

1808

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

1245

1246

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

1809

1810

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

1247

1811

self.bus = bus

1248

1812

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

1249

1813

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

1250

1814

# the D-Bus

1251

client_object_name = unicode(self.name).translate(

1815

client_object_name = str(self.name).translate(

1252

1816

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

1253

1817

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

1254

self.dbus_object_path = (dbus.ObjectPath

1255

("/clients/" + client_object_name))

1818

self.dbus_object_path = dbus.ObjectPath(

1819

"/clients/" + client_object_name)

1256

1820

DBusObjectWithProperties.__init__(self, self.bus,

1257

1821

self.dbus_object_path)

1258

1259

def notifychangeproperty(transform_func,

1260

dbus_name, type_func=lambda x: x,

1261

variant_level=1):

1822

1823

def notifychangeproperty(transform_func, dbus_name,

1824

type_func=lambda x: x,

1825

variant_level=1,

1826

invalidate_only=False,

1827

_interface=_interface):

1262

1828

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

1263

1829

its changes to DBus.

1264

1830

1265

1831

transform_fun: Function that takes a value and a variant_level

1266

1832

and transforms it to a D-Bus type.

1267

1833

dbus_name: D-Bus name of the variable

1269

1835

to the D-Bus. Default: no transform

1270

1836

variant_level: D-Bus variant level. Default: 1

1271

1837

"""

1272

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

1838

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

1839

1273

1840

def setter(self, value):

1274

1841

if hasattr(self, "dbus_object_path"):

1275

1842

if (not hasattr(self, attrname) or

1276

1843

type_func(getattr(self, attrname, None))

1277

1844

!= type_func(value)):

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1281

self.PropertyChanged(dbus.String(dbus_name),

1282

dbus_value)

1845

if invalidate_only:

1846

self.PropertiesChanged(

1847

_interface, dbus.Dictionary(),

1848

dbus.Array((dbus_name, )))

1849

else:

1850

dbus_value = transform_func(

1851

type_func(value),

1852

variant_level=variant_level)

1853

self.PropertyChanged(dbus.String(dbus_name),

1854

dbus_value)

1855

self.PropertiesChanged(

1856

_interface,

1857

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

1858

dbus_value}),

1859

dbus.Array())

1283

1860

setattr(self, attrname, value)

1284

1861

1285

1862

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

1286

1863

1287

1864

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1288

1865

approvals_pending = notifychangeproperty(dbus.Boolean,

1289

1866

"ApprovalPending",

1290

type_func = bool)

1867

type_func=bool)

1291

1868

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

1292

1869

last_enabled = notifychangeproperty(datetime_to_dbus,

1293

1870

"LastEnabled")

1294

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

1295

type_func = lambda checker:

1296

checker is not None)

1871

checker = notifychangeproperty(

1872

dbus.Boolean, "CheckerRunning",

1873

type_func=lambda checker: checker is not None)

1297

1874

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1298

1875

"LastCheckedOK")

1299

1876

last_checker_status = notifychangeproperty(dbus.Int16,

1302

1879

datetime_to_dbus, "LastApprovalRequest")

1303

1880

approved_by_default = notifychangeproperty(dbus.Boolean,

1304

1881

"ApprovedByDefault")

1305

approval_delay = notifychangeproperty(dbus.UInt64,

1306

"ApprovalDelay",

1307

type_func =

1308

timedelta_to_milliseconds)

1882

approval_delay = notifychangeproperty(

1883

dbus.UInt64, "ApprovalDelay",

1884

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

1309

1885

approval_duration = notifychangeproperty(

1310

1886

dbus.UInt64, "ApprovalDuration",

1311

type_func = timedelta_to_milliseconds)

1887

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

1312

1888

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

1313

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

1314

type_func =

1315

timedelta_to_milliseconds)

1889

timeout = notifychangeproperty(

1890

dbus.UInt64, "Timeout",

1891

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

1316

1892

extended_timeout = notifychangeproperty(

1317

1893

dbus.UInt64, "ExtendedTimeout",

1318

type_func = timedelta_to_milliseconds)

1319

interval = notifychangeproperty(dbus.UInt64,

1320

"Interval",

1321

type_func =

1322

timedelta_to_milliseconds)

1894

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

1895

interval = notifychangeproperty(

1896

dbus.UInt64, "Interval",

1897

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

1323

1898

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

1324

1899

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

1900

invalidate_only=True)

1901

1325

1902

del notifychangeproperty

1326

1903

1327

1904

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

1328

1905

try:

1329

1906

self.remove_from_connection()

1332

1909

if hasattr(DBusObjectWithProperties, "__del__"):

1333

1910

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

1334

1911

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

1335

1336

def checker_callback(self, pid, condition, command,

1337

*args, **kwargs):

1338

self.checker_callback_tag = None

1339

self.checker = None

1340

if os.WIFEXITED(condition):

1341

exitstatus = os.WEXITSTATUS(condition)

1912

1913

def checker_callback(self, source, condition,

1914

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

1915

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

1916

connection, command, *args,

1917

**kwargs)

1918

exitstatus = self.last_checker_status

1919

if exitstatus >= 0:

1342

1920

# Emit D-Bus signal

1343

1921

self.CheckerCompleted(dbus.Int16(exitstatus),

1344

dbus.Int64(condition),

1922

# This is specific to GNU libC

1923

dbus.Int64(exitstatus << 8),

1345

1924

dbus.String(command))

1346

1925

else:

1347

1926

# Emit D-Bus signal

1348

1927

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

1349

dbus.Int64(condition),

1928

dbus.Int64(

1929

# This is specific to GNU libC

1930

(exitstatus << 8)

1931

| self.last_checker_signal),

1350

1932

dbus.String(command))

1351

1352

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

1353

*args, **kwargs)

1354

1933

return ret

1934

1355

1935

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

1356

1936

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

1357

1937

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

1361

1941

# Emit D-Bus signal

1362

1942

self.CheckerStarted(self.current_checker_command)

1363

1943

return r

1364

1944

1365

1945

def _reset_approved(self):

1366

1946

self.approved = None

1367

1947

return False

1368

1948

1369

1949

def approve(self, value=True):

1370

1950

self.approved = value

1371

gobject.timeout_add(timedelta_to_milliseconds

1372

(self.approval_duration),

1373

self._reset_approved)

1951

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

1952

* 1000), self._reset_approved)

1374

1953

self.send_changedstate()

1375

1376

## D-Bus methods, signals & properties

1377

_interface = "se.recompile.Mandos.Client"

1378

1379

## Interfaces

1380

1381

@dbus_interface_annotations(_interface)

1382

def _foo(self):

1383

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

1384

"false"}

1385

1386

## Signals

1387

1954

1955

# D-Bus methods, signals & properties

1956

1957

# Interfaces

1958

1959

# Signals

1960

1388

1961

# CheckerCompleted - signal

1389

1962

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

1390

1963

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

1391

1964

"D-Bus signal"

1392

1965

pass

1393

1966

1394

1967

# CheckerStarted - signal

1395

1968

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

1396

1969

def CheckerStarted(self, command):

1397

1970

"D-Bus signal"

1398

1971

pass

1399

1972

1400

1973

# PropertyChanged - signal

1974

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

1401

1975

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

1402

1976

def PropertyChanged(self, property, value):

1403

1977

"D-Bus signal"

1404

1978

pass

1405

1979

1406

1980

# GotSecret - signal

1407

1981

@dbus.service.signal(_interface)

1408

1982

def GotSecret(self):

1411

1985

server to mandos-client

1412

1986

"""

1413

1987

pass

1414

1988

1415

1989

# Rejected - signal

1416

1990

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

1417

1991

def Rejected(self, reason):

1418

1992

"D-Bus signal"

1419

1993

pass

1420

1994

1421

1995

# NeedApproval - signal

1422

1996

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

1423

1997

def NeedApproval(self, timeout, default):

1424

1998

"D-Bus signal"

1425

1999

return self.need_approval()

1426

1427

## Methods

1428

2000

2001

# Methods

2002

1429

2003

# Approve - method

1430

2004

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

1431

2005

def Approve(self, value):

1432

2006

self.approve(value)

1433

2007

1434

2008

# CheckedOK - method

1435

2009

@dbus.service.method(_interface)

1436

2010

def CheckedOK(self):

1437

2011

self.checked_ok()

1438

2012

1439

2013

# Enable - method

2014

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

1440

2015

@dbus.service.method(_interface)

1441

2016

def Enable(self):

1442

2017

"D-Bus method"

1443

2018

self.enable()

1444

2019

1445

2020

# StartChecker - method

2021

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

1446

2022

@dbus.service.method(_interface)

1447

2023

def StartChecker(self):

1448

2024

"D-Bus method"

1449

2025

self.start_checker()

1450

2026

1451

2027

# Disable - method

2028

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

1452

2029

@dbus.service.method(_interface)

1453

2030

def Disable(self):

1454

2031

"D-Bus method"

1455

2032

self.disable()

1456

2033

1457

2034

# StopChecker - method

2035

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

1458

2036

@dbus.service.method(_interface)

1459

2037

def StopChecker(self):

1460

2038

self.stop_checker()

1461

1462

## Properties

1463

2039

2040

# Properties

2041

1464

2042

# ApprovalPending - property

1465

2043

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

1466

2044

def ApprovalPending_dbus_property(self):

1467

2045

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

1468

2046

1469

2047

# ApprovedByDefault - property

1470

@dbus_service_property(_interface, signature="b",

2048

@dbus_service_property(_interface,

2049

signature="b",

1471

2050

access="readwrite")

1472

2051

def ApprovedByDefault_dbus_property(self, value=None):

1473

2052

if value is None: # get

1474

2053

return dbus.Boolean(self.approved_by_default)

1475

2054

self.approved_by_default = bool(value)

1476

2055

1477

2056

# ApprovalDelay - property

1478

@dbus_service_property(_interface, signature="t",

2057

@dbus_service_property(_interface,

2058

signature="t",

1479

2059

access="readwrite")

1480

2060

def ApprovalDelay_dbus_property(self, value=None):

1481

2061

if value is None: # get

1482

return dbus.UInt64(self.approval_delay_milliseconds())

2062

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

2063

* 1000)

1483

2064

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

1484

2065

1485

2066

# ApprovalDuration - property

1486

@dbus_service_property(_interface, signature="t",

2067

@dbus_service_property(_interface,

2068

signature="t",

1487

2069

access="readwrite")

1488

2070

def ApprovalDuration_dbus_property(self, value=None):

1489

2071

if value is None: # get

1490

return dbus.UInt64(timedelta_to_milliseconds(

1491

self.approval_duration))

2072

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

2073

* 1000)

1492

2074

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

1493

2075

1494

2076

# Name - property

2077

@dbus_annotations(

2078

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

1495

2079

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

1496

2080

def Name_dbus_property(self):

1497

2081

return dbus.String(self.name)

1498

2082

2083

# KeyID - property

2084

@dbus_annotations(

2085

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

2086

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

2087

def KeyID_dbus_property(self):

2088

return dbus.String(self.key_id)

2089

1499

2090

# Fingerprint - property

2091

@dbus_annotations(

2092

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

1500

2093

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

1501

2094

def Fingerprint_dbus_property(self):

1502

2095

return dbus.String(self.fingerprint)

1503

2096

1504

2097

# Host - property

1505

@dbus_service_property(_interface, signature="s",

2098

@dbus_service_property(_interface,

2099

signature="s",

1506

2100

access="readwrite")

1507

2101

def Host_dbus_property(self, value=None):

1508

2102

if value is None: # get

1509

2103

return dbus.String(self.host)

1510

self.host = unicode(value)

1511

2104

self.host = str(value)

2105

1512

2106

# Created - property

2107

@dbus_annotations(

2108

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

1513

2109

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

1514

2110

def Created_dbus_property(self):

1515

2111

return datetime_to_dbus(self.created)

1516

2112

1517

2113

# LastEnabled - property

1518

2114

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

1519

2115

def LastEnabled_dbus_property(self):

1520

2116

return datetime_to_dbus(self.last_enabled)

1521

2117

1522

2118

# Enabled - property

1523

@dbus_service_property(_interface, signature="b",

2119

@dbus_service_property(_interface,

2120

signature="b",

1524

2121

access="readwrite")

1525

2122

def Enabled_dbus_property(self, value=None):

1526

2123

if value is None: # get

1529

2126

self.enable()

1530

2127

else:

1531

2128

self.disable()

1532

2129

1533

2130

# LastCheckedOK - property

1534

@dbus_service_property(_interface, signature="s",

2131

@dbus_service_property(_interface,

2132

signature="s",

1535

2133

access="readwrite")

1536

2134

def LastCheckedOK_dbus_property(self, value=None):

1537

2135

if value is not None:

1538

2136

self.checked_ok()

1539

2137

return

1540

2138

return datetime_to_dbus(self.last_checked_ok)

1541

2139

1542

2140

# LastCheckerStatus - property

1543

@dbus_service_property(_interface, signature="n",

1544

access="read")

2141

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

1545

2142

def LastCheckerStatus_dbus_property(self):

1546

2143

return dbus.Int16(self.last_checker_status)

1547

2144

1548

2145

# Expires - property

1549

2146

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

1550

2147

def Expires_dbus_property(self):

1551

2148

return datetime_to_dbus(self.expires)

1552

2149

1553

2150

# LastApprovalRequest - property

1554

2151

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

1555

2152

def LastApprovalRequest_dbus_property(self):

1556

2153

return datetime_to_dbus(self.last_approval_request)

1557

2154

1558

2155

# Timeout - property

1559

@dbus_service_property(_interface, signature="t",

2156

@dbus_service_property(_interface,

2157

signature="t",

1560

2158

access="readwrite")

1561

2159

def Timeout_dbus_property(self, value=None):

1562

2160

if value is None: # get

1563

return dbus.UInt64(self.timeout_milliseconds())

2161

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

1564

2162

old_timeout = self.timeout

1565

2163

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

1566

2164

# Reschedule disabling

1574

2172

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

1575

2173

is None):

1576

2174

return

1577

gobject.source_remove(self.disable_initiator_tag)

1578

self.disable_initiator_tag = (

1579

gobject.timeout_add(

1580

timedelta_to_milliseconds(self.expires - now),

1581

self.disable))

1582

2175

GLib.source_remove(self.disable_initiator_tag)

2176

self.disable_initiator_tag = GLib.timeout_add(

2177

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

2178

self.disable)

2179

1583

2180

# ExtendedTimeout - property

1584

@dbus_service_property(_interface, signature="t",

2181

@dbus_service_property(_interface,

2182

signature="t",

1585

2183

access="readwrite")

1586

2184

def ExtendedTimeout_dbus_property(self, value=None):

1587

2185

if value is None: # get

1588

return dbus.UInt64(self.extended_timeout_milliseconds())

2186

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

2187

* 1000)

1589

2188

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

1590

2189

1591

2190

# Interval - property

1592

@dbus_service_property(_interface, signature="t",

2191

@dbus_service_property(_interface,

2192

signature="t",

1593

2193

access="readwrite")

1594

2194

def Interval_dbus_property(self, value=None):

1595

2195

if value is None: # get

1596

return dbus.UInt64(self.interval_milliseconds())

2196

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

1597

2197

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

1598

2198

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

1599

2199

return

1600

2200

if self.enabled:

1601

2201

# Reschedule checker run

1602

gobject.source_remove(self.checker_initiator_tag)

1603

self.checker_initiator_tag = (gobject.timeout_add

1604

(value, self.start_checker))

1605

self.start_checker() # Start one now, too

1606

2202

GLib.source_remove(self.checker_initiator_tag)

2203

self.checker_initiator_tag = GLib.timeout_add(

2204

value, self.start_checker)

2205

self.start_checker() # Start one now, too

2206

1607

2207

# Checker - property

1608

@dbus_service_property(_interface, signature="s",

2208

@dbus_service_property(_interface,

2209

signature="s",

1609

2210

access="readwrite")

1610

2211

def Checker_dbus_property(self, value=None):

1611

2212

if value is None: # get

1612

2213

return dbus.String(self.checker_command)

1613

self.checker_command = unicode(value)

1614

2214

self.checker_command = str(value)

2215

1615

2216

# CheckerRunning - property

1616

@dbus_service_property(_interface, signature="b",

2217

@dbus_service_property(_interface,

2218

signature="b",

1617

2219

access="readwrite")

1618

2220

def CheckerRunning_dbus_property(self, value=None):

1619

2221

if value is None: # get

1622

2224

self.start_checker()

1623

2225

else:

1624

2226

self.stop_checker()

1625

2227

1626

2228

# ObjectPath - property

2229

@dbus_annotations(

2230

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

2231

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

1627

2232

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

1628

2233

def ObjectPath_dbus_property(self):

1629

return self.dbus_object_path # is already a dbus.ObjectPath

1630

2234

return self.dbus_object_path # is already a dbus.ObjectPath

2235

1631

2236

# Secret = property

1632

@dbus_service_property(_interface, signature="ay",

1633

access="write", byte_arrays=True)

2237

@dbus_annotations(

2238

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

2239

"invalidates"})

2240

@dbus_service_property(_interface,

2241

signature="ay",

2242

access="write",

2243

byte_arrays=True)

1634

2244

def Secret_dbus_property(self, value):

1635

self.secret = str(value)

1636

2245

self.secret = bytes(value)

2246

1637

2247

del _interface

1638

2248

1639

2249

1640

class ProxyClient(object):

1641

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

2250

class ProxyClient:

2251

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

1642

2252

self._pipe = child_pipe

1643

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

2253

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

1644

2254

if not self._pipe.recv():

1645

raise KeyError()

1646

2255

raise KeyError(key_id or fpr)

2256

1647

2257

def __getattribute__(self, name):

1648

2258

if name == '_pipe':

1649

2259

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

1652

2262

if data[0] == 'data':

1653

2263

return data[1]

1654

2264

if data[0] == 'function':

2265

1655

2266

def func(*args, **kwargs):

1656

2267

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

1657

2268

return self._pipe.recv()[1]

2269

1658

2270

return func

1659

2271

1660

2272

def __setattr__(self, name, value):

1661

2273

if name == '_pipe':

1662

2274

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

1665

2277

1666

2278

class ClientHandler(socketserver.BaseRequestHandler, object):

1667

2279

"""A class to handle client connections.

1668

2280

1669

2281

Instantiated once for each connection to handle it.

1670

2282

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

1671

2283

1672

2284

def handle(self):

1673

2285

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

1674

2286

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

1675

unicode(self.client_address))

2287

str(self.client_address))

1676

2288

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

1677

2289

self.server.child_pipe.fileno())

1678

1679

session = (gnutls.connection

1680

.ClientSession(self.request,

1681

gnutls.connection

1682

.X509Credentials()))

1683

1684

# Note: gnutls.connection.X509Credentials is really a

1685

# generic GnuTLS certificate credentials object so long as

1686

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

1687

# here despite using OpenPGP certificates.

1688

1689

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

1690

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

1691

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

1692

# "+DHE-DSS"))

2290

2291

session = gnutls.ClientSession(self.request)

2292

2293

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

2294

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

2295

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

2296

# "+DHE-DSS"))

1693

2297

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

1694

2298

priority = self.server.gnutls_priority

1695

2299

if priority is None:

1696

2300

priority = "NORMAL"

1697

(gnutls.library.functions

1698

.gnutls_priority_set_direct(session._c_object,

1699

priority, None))

1700

2301

gnutls.priority_set_direct(session._c_object,

2302

priority.encode("utf-8"),

2303

None)

2304

1701

2305

# Start communication using the Mandos protocol

1702

2306

# Get protocol number

1703

2307

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

1708

2312

except (ValueError, IndexError, RuntimeError) as error:

1709

2313

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

1710

2314

return

1711

2315

1712

2316

# Start GnuTLS connection

1713

2317

try:

1714

2318

session.handshake()

1715

except gnutls.errors.GNUTLSError as error:

2319

except gnutls.Error as error:

1716

2320

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

1717

2321

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

1718

2322

# established. Just abandon the request.

1719

2323

return

1720

2324

logger.debug("Handshake succeeded")

1721

2325

1722

2326

approval_required = False

1723

2327

try:

1724

try:

1725

fpr = self.fingerprint(self.peer_certificate

1726

(session))

1727

except (TypeError,

1728

gnutls.errors.GNUTLSError) as error:

1729

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

1730

return

1731

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

1732

1733

try:

1734

client = ProxyClient(child_pipe, fpr,

2328

if gnutls.has_rawpk:

2329

fpr = b""

2330

try:

2331

key_id = self.key_id(

2332

self.peer_certificate(session))

2333

except (TypeError, gnutls.Error) as error:

2334

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

2335

return

2336

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

2337

2338

else:

2339

key_id = b""

2340

try:

2341

fpr = self.fingerprint(

2342

self.peer_certificate(session))

2343

except (TypeError, gnutls.Error) as error:

2344

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

2345

return

2346

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

2347

2348

try:

2349

client = ProxyClient(child_pipe, key_id, fpr,

1735

2350

self.client_address)

1736

2351

except KeyError:

1737

2352

return

1738

2353

1739

2354

if client.approval_delay:

1740

2355

delay = client.approval_delay

1741

2356

client.approvals_pending += 1

1742

2357

approval_required = True

1743

2358

1744

2359

while True:

1745

2360

if not client.enabled:

1746

2361

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

1747

client.name)

2362

client.name)

1748

2363

if self.server.use_dbus:

1749

2364

# Emit D-Bus signal

1750

2365

client.Rejected("Disabled")

1751

2366

return

1752

2367

1753

2368

if client.approved or not client.approval_delay:

1754

#We are approved or approval is disabled

2369

# We are approved or approval is disabled

1755

2370

break

1756

2371

elif client.approved is None:

1757

2372

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

1759

2374

if self.server.use_dbus:

1760

2375

# Emit D-Bus signal

1761

2376

client.NeedApproval(

1762

client.approval_delay_milliseconds(),

1763

client.approved_by_default)

2377

client.approval_delay.total_seconds()

2378

* 1000, client.approved_by_default)

1764

2379

else:

1765

2380

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

1766

2381

client.name)

1768

2383

# Emit D-Bus signal

1769

2384

client.Rejected("Denied")

1770

2385

return

1771

1772

#wait until timeout or approved

2386

2387

# wait until timeout or approved

1773

2388

time = datetime.datetime.now()

1774

2389

client.changedstate.acquire()

1775

client.changedstate.wait(

1776

float(timedelta_to_milliseconds(delay)

1777

/ 1000))

2390

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

1778

2391

client.changedstate.release()

1779

2392

time2 = datetime.datetime.now()

1780

2393

if (time2 - time) >= delay:

1790

2403

break

1791

2404

else:

1792

2405

delay -= time2 - time

1793

1794

sent_size = 0

1795

while sent_size < len(client.secret):

1796

try:

1797

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

1798

except gnutls.errors.GNUTLSError as error:

1799

logger.warning("gnutls send failed",

1800

exc_info=error)

1801

return

1802

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

1803

sent, len(client.secret)

1804

- (sent_size + sent))

1805

sent_size += sent

1806

2406

2407

try:

2408

session.send(client.secret)

2409

except gnutls.Error as error:

2410

logger.warning("gnutls send failed",

2411

exc_info=error)

2412

return

2413

1807

2414

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

1808

2415

# bump the timeout using extended_timeout

1809

2416

client.bump_timeout(client.extended_timeout)

1810

2417

if self.server.use_dbus:

1811

2418

# Emit D-Bus signal

1812

2419

client.GotSecret()

1813

2420

1814

2421

finally:

1815

2422

if approval_required:

1816

2423

client.approvals_pending -= 1

1817

2424

try:

1818

2425

session.bye()

1819

except gnutls.errors.GNUTLSError as error:

2426

except gnutls.Error as error:

1820

2427

logger.warning("GnuTLS bye failed",

1821

2428

exc_info=error)

1822

2429

1823

2430

@staticmethod

1824

2431

def peer_certificate(session):

1825

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

1826

# If not an OpenPGP certificate...

1827

if (gnutls.library.functions

1828

.gnutls_certificate_type_get(session._c_object)

1829

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1830

# ...do the normal thing

1831

return session.peer_certificate

2432

"Return the peer's certificate as a bytestring"

2433

try:

2434

cert_type = gnutls.certificate_type_get2(session._c_object,

2435

gnutls.CTYPE_PEERS)

2436

except AttributeError:

2437

cert_type = gnutls.certificate_type_get(session._c_object)

2438

if gnutls.has_rawpk:

2439

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2440

else:

2441

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2442

# If not a valid certificate type...

2443

if cert_type not in valid_cert_types:

2444

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

2445

valid_cert_types)

2446

# ...return invalid data

2447

return b""

1832

2448

list_size = ctypes.c_uint(1)

1833

cert_list = (gnutls.library.functions

1834

.gnutls_certificate_get_peers

2449

cert_list = (gnutls.certificate_get_peers

1835

2450

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

1836

2451

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

1837

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

1838

" certificate")

2452

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

1839

2453

if list_size.value == 0:

1840

2454

return None

1841

2455

cert = cert_list[0]

1842

2456

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

1843

2457

2458

@staticmethod

2459

def key_id(certificate):

2460

"Convert a certificate bytestring to a hexdigit key ID"

2461

# New GnuTLS "datum" with the public key

2462

datum = gnutls.datum_t(

2463

ctypes.cast(ctypes.c_char_p(certificate),

2464

ctypes.POINTER(ctypes.c_ubyte)),

2465

ctypes.c_uint(len(certificate)))

2466

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

2467

# New empty GnuTLS certificate

2468

pubkey = gnutls.pubkey_t()

2469

gnutls.pubkey_init(ctypes.byref(pubkey))

2470

# Import the raw public key into the certificate

2471

gnutls.pubkey_import(pubkey,

2472

ctypes.byref(datum),

2473

gnutls.X509_FMT_DER)

2474

# New buffer for the key ID

2475

buf = ctypes.create_string_buffer(32)

2476

buf_len = ctypes.c_size_t(len(buf))

2477

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

2478

gnutls.pubkey_get_key_id(

2479

pubkey,

2480

gnutls.KEYID_USE_SHA256,

2481

ctypes.cast(ctypes.byref(buf),

2482

ctypes.POINTER(ctypes.c_ubyte)),

2483

ctypes.byref(buf_len))

2484

# Deinit the certificate

2485

gnutls.pubkey_deinit(pubkey)

2486

2487

# Convert the buffer to a Python bytestring

2488

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

2489

# Convert the bytestring to hexadecimal notation

2490

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

2491

return hex_key_id

2492

1844

2493

@staticmethod

1845

2494

def fingerprint(openpgp):

1846

2495

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1847

2496

# New GnuTLS "datum" with the OpenPGP public key

1848

datum = (gnutls.library.types

1849

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

1850

ctypes.POINTER

1851

(ctypes.c_ubyte)),

1852

ctypes.c_uint(len(openpgp))))

2497

datum = gnutls.datum_t(

2498

ctypes.cast(ctypes.c_char_p(openpgp),

2499

ctypes.POINTER(ctypes.c_ubyte)),

2500

ctypes.c_uint(len(openpgp)))

1853

2501

# New empty GnuTLS certificate

1854

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1855

(gnutls.library.functions

1856

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2502

crt = gnutls.openpgp_crt_t()

2503

gnutls.openpgp_crt_init(ctypes.byref(crt))

1857

2504

# Import the OpenPGP public key into the certificate

1858

(gnutls.library.functions

1859

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

1860

gnutls.library.constants

1861

.GNUTLS_OPENPGP_FMT_RAW))

2505

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

2506

gnutls.OPENPGP_FMT_RAW)

1862

2507

# Verify the self signature in the key

1863

2508

crtverify = ctypes.c_uint()

1864

(gnutls.library.functions

1865

.gnutls_openpgp_crt_verify_self(crt, 0,

1866

ctypes.byref(crtverify)))

2509

gnutls.openpgp_crt_verify_self(crt, 0,

2510

ctypes.byref(crtverify))

1867

2511

if crtverify.value != 0:

1868

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1869

raise (gnutls.errors.CertificateSecurityError

1870

("Verify failed"))

2512

gnutls.openpgp_crt_deinit(crt)

2513

raise gnutls.CertificateSecurityError(code

2514

=crtverify.value)

1871

2515

# New buffer for the fingerprint

1872

2516

buf = ctypes.create_string_buffer(20)

1873

2517

buf_len = ctypes.c_size_t()

1874

2518

# Get the fingerprint from the certificate into the buffer

1875

(gnutls.library.functions

1876

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

1877

ctypes.byref(buf_len)))

2519

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

2520

ctypes.byref(buf_len))

1878

2521

# Deinit the certificate

1879

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2522

gnutls.openpgp_crt_deinit(crt)

1880

2523

# Convert the buffer to a Python bytestring

1881

2524

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

1882

2525

# Convert the bytestring to hexadecimal notation

1884

2527

return hex_fpr

1885

2528

1886

2529

1887

class MultiprocessingMixIn(object):

2530

class MultiprocessingMixIn:

1888

2531

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

2532

1889

2533

def sub_process_main(self, request, address):

1890

2534

try:

1891

2535

self.finish_request(request, address)

1892

2536

except Exception:

1893

2537

self.handle_error(request, address)

1894

2538

self.close_request(request)

1895

2539

1896

2540

def process_request(self, request, address):

1897

2541

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

1898

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

1899

args = (request, address))

2542

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

2543

args=(request, address))

1900

2544

proc.start()

1901

2545

return proc

1902

2546

1903

2547

1904

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2548

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1905

2549

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

2550

1906

2551

def process_request(self, request, client_address):

1907

2552

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

1908

2553

1909

2554

This function creates a new pipe in self.pipe

1910

2555

"""

1911

2556

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1912

2557

1913

2558

proc = MultiprocessingMixIn.process_request(self, request,

1914

2559

client_address)

1915

2560

self.child_pipe.close()

1916

2561

self.add_pipe(parent_pipe, proc)

1917

2562

1918

2563

def add_pipe(self, parent_pipe, proc):

1919

2564

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

1920

2565

raise NotImplementedError()

1921

2566

1922

2567

1923

2568

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1924

socketserver.TCPServer, object):

2569

socketserver.TCPServer):

1925

2570

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

1926

2571

1927

2572

Attributes:

1928

2573

enabled: Boolean; whether this server is activated yet

1929

2574

interface: None or a network interface name (string)

1930

2575

use_ipv6: Boolean; to use IPv6 or not

1931

2576

"""

2577

1932

2578

def __init__(self, server_address, RequestHandlerClass,

1933

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

2579

interface=None,

2580

use_ipv6=True,

2581

socketfd=None):

1934

2582

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

1935

2583

creating a new one with socket.socket().

1936

2584

"""

1942

2590

self.socketfd = socketfd

1943

2591

# Save the original socket.socket() function

1944

2592

self.socket_socket = socket.socket

2593

1945

2594

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

1946

#

2595

#

1947

2596

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

1948

2597

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

1949

2598

# patching socket.socket.)

1950

#

2599

#

1951

2600

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

1952

2601

@functools.wraps(socket.socket)

1953

2602

def socket_wrapper(*args, **kwargs):

1965

2614

# socket_wrapper(), if socketfd was set.

1966

2615

socketserver.TCPServer.__init__(self, server_address,

1967

2616

RequestHandlerClass)

1968

2617

1969

2618

def server_bind(self):

1970

2619

"""This overrides the normal server_bind() function

1971

2620

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

1972

2621

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

2622

global SO_BINDTODEVICE

1973

2623

if self.interface is not None:

1974

2624

if SO_BINDTODEVICE is None:

1975

logger.error("SO_BINDTODEVICE does not exist;"

1976

" cannot bind to interface %s",

1977

self.interface)

1978

else:

1979

try:

1980

self.socket.setsockopt(socket.SOL_SOCKET,

1981

SO_BINDTODEVICE,

1982

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

1983

except socket.error as error:

1984

if error.errno == errno.EPERM:

1985

logger.error("No permission to bind to"

1986

" interface %s", self.interface)

1987

elif error.errno == errno.ENOPROTOOPT:

1988

logger.error("SO_BINDTODEVICE not available;"

1989

" cannot bind to interface %s",

1990

self.interface)

1991

elif error.errno == errno.ENODEV:

1992

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

1993

" cannot bind", self.interface)

1994

else:

1995

raise

2625

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

2626

# common enough.

2627

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

2628

SO_BINDTODEVICE = 25

2629

try:

2630

self.socket.setsockopt(

2631

socket.SOL_SOCKET, SO_BINDTODEVICE,

2632

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

2633

except socket.error as error:

2634

if error.errno == errno.EPERM:

2635

logger.error("No permission to bind to"

2636

" interface %s", self.interface)

2637

elif error.errno == errno.ENOPROTOOPT:

2638

logger.error("SO_BINDTODEVICE not available;"

2639

" cannot bind to interface %s",

2640

self.interface)

2641

elif error.errno == errno.ENODEV:

2642

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

2643

" cannot bind", self.interface)

2644

else:

2645

raise

1996

2646

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

1997

2647

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

2648

if self.server_address[1]:

2649

self.allow_reuse_address = True

1998

2650

if not self.server_address[0]:

1999

2651

if self.address_family == socket.AF_INET6:

2000

any_address = "::" # in6addr_any

2652

any_address = "::" # in6addr_any

2001

2653

else:

2002

any_address = "0.0.0.0" # INADDR_ANY

2654

any_address = "0.0.0.0" # INADDR_ANY

2003

2655

self.server_address = (any_address,

2004

2656

self.server_address[1])

2005

2657

elif not self.server_address[1]:

2006

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

2007

0)

2658

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

2008

2659

# if self.interface:

2009

2660

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

2010

2661

# 0, # port

2016

2667

2017

2668

class MandosServer(IPv6_TCPServer):

2018

2669

"""Mandos server.

2019

2670

2020

2671

Attributes:

2021

2672

clients: set of Client objects

2022

2673

gnutls_priority GnuTLS priority string

2023

2674

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

2024

2025

Assumes a gobject.MainLoop event loop.

2675

2676

Assumes a GLib.MainLoop event loop.

2026

2677

"""

2678

2027

2679

def __init__(self, server_address, RequestHandlerClass,

2028

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

2029

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

2680

interface=None,

2681

use_ipv6=True,

2682

clients=None,

2683

gnutls_priority=None,

2684

use_dbus=True,

2685

socketfd=None):

2030

2686

self.enabled = False

2031

2687

self.clients = clients

2032

2688

if self.clients is None:

2035

2691

self.gnutls_priority = gnutls_priority

2036

2692

IPv6_TCPServer.__init__(self, server_address,

2037

2693

RequestHandlerClass,

2038

interface = interface,

2039

use_ipv6 = use_ipv6,

2040

socketfd = socketfd)

2694

interface=interface,

2695

use_ipv6=use_ipv6,

2696

socketfd=socketfd)

2697

2041

2698

def server_activate(self):

2042

2699

if self.enabled:

2043

2700

return socketserver.TCPServer.server_activate(self)

2044

2701

2045

2702

def enable(self):

2046

2703

self.enabled = True

2047

2704

2048

2705

def add_pipe(self, parent_pipe, proc):

2049

2706

# Call "handle_ipc" for both data and EOF events

2050

gobject.io_add_watch(parent_pipe.fileno(),

2051

gobject.IO_IN | gobject.IO_HUP,

2052

functools.partial(self.handle_ipc,

2053

parent_pipe =

2054

parent_pipe,

2055

proc = proc))

2056

2057

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

2058

proc = None, client_object=None):

2707

GLib.io_add_watch(

2708

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

2709

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

2710

functools.partial(self.handle_ipc,

2711

parent_pipe=parent_pipe,

2712

proc=proc))

2713

2714

def handle_ipc(self, source, condition,

2715

parent_pipe=None,

2716

proc=None,

2717

client_object=None):

2059

2718

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

2060

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

2719

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

2061

2720

# Wait for other process to exit

2062

2721

proc.join()

2063

2722

return False

2064

2723

2065

2724

# Read a request from the child

2066

2725

request = parent_pipe.recv()

2067

2726

command = request[0]

2068

2727

2069

2728

if command == 'init':

2070

fpr = request[1]

2071

address = request[2]

2072

2073

for c in self.clients.itervalues():

2074

if c.fingerprint == fpr:

2729

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

2730

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

2731

address = request[3]

2732

2733

for c in self.clients.values():

2734

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2735

"27AE41E4649B934CA495991B7852B855"):

2736

continue

2737

if key_id and c.key_id == key_id:

2738

client = c

2739

break

2740

if fpr and c.fingerprint == fpr:

2075

2741

client = c

2076

2742

break

2077

2743

else:

2078

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

2079

"dress: %s", fpr, address)

2744

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

2745

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

2080

2746

if self.use_dbus:

2081

2747

# Emit D-Bus signal

2082

mandos_dbus_service.ClientNotFound(fpr,

2748

mandos_dbus_service.ClientNotFound(key_id or fpr,

2083

2749

address[0])

2084

2750

parent_pipe.send(False)

2085

2751

return False

2086

2087

gobject.io_add_watch(parent_pipe.fileno(),

2088

gobject.IO_IN | gobject.IO_HUP,

2089

functools.partial(self.handle_ipc,

2090

parent_pipe =

2091

parent_pipe,

2092

proc = proc,

2093

client_object =

2094

client))

2752

2753

GLib.io_add_watch(

2754

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

2755

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

2756

functools.partial(self.handle_ipc,

2757

parent_pipe=parent_pipe,

2758

proc=proc,

2759

client_object=client))

2095

2760

parent_pipe.send(True)

2096

2761

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

2097

2762

# same fileno

2100

2765

funcname = request[1]

2101

2766

args = request[2]

2102

2767

kwargs = request[3]

2103

2768

2104

2769

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

2105

2770

funcname)(*args,

2106

**kwargs)))

2107

2771

**kwargs)))

2772

2108

2773

if command == 'getattr':

2109

2774

attrname = request[1]

2110

if callable(client_object.__getattribute__(attrname)):

2111

parent_pipe.send(('function',))

2775

if isinstance(client_object.__getattribute__(attrname),

2776

collections.abc.Callable):

2777

parent_pipe.send(('function', ))

2112

2778

else:

2113

parent_pipe.send(('data', client_object

2114

.__getattribute__(attrname)))

2115

2779

parent_pipe.send((

2780

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

2781

2116

2782

if command == 'setattr':

2117

2783

attrname = request[1]

2118

2784

value = request[2]

2119

2785

setattr(client_object, attrname, value)

2120

2786

2121

2787

return True

2122

2788

2123

2789

2124

2790

def rfc3339_duration_to_delta(duration):

2125

2791

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

2126

2127

>>> rfc3339_duration_to_delta("P7D")

2128

datetime.timedelta(7)

2129

>>> rfc3339_duration_to_delta("PT60S")

2130

datetime.timedelta(0, 60)

2131

>>> rfc3339_duration_to_delta("PT60M")

2132

datetime.timedelta(0, 3600)

2133

>>> rfc3339_duration_to_delta("PT24H")

2134

datetime.timedelta(1)

2135

>>> rfc3339_duration_to_delta("P1W")

2136

datetime.timedelta(7)

2137

>>> rfc3339_duration_to_delta("PT5M30S")

2138

datetime.timedelta(0, 330)

2139

>>> rfc3339_duration_to_delta("P1DT3M20S")

2140

datetime.timedelta(1, 200)

2792

2793

>>> timedelta = datetime.timedelta

2794

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

2795

True

2796

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

2797

True

2798

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

2799

True

2800

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

2801

True

2802

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

2803

True

2804

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

2805

True

2806

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

2807

True

2808

>>> del timedelta

2141

2809

"""

2142

2810

2143

2811

# Parsing an RFC 3339 duration with regular expressions is not

2144

2812

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

2145

2813

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

2146

2814

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

2147

2815

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

2148

2816

# avoid excessive use of external libraries.

2149

2817

2150

2818

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

2151

Token = collections.namedtuple("Token",

2152

("regexp", # To match token; if

2153

# "value" is not None,

2154

# must have a "group"

2155

# containing digits

2156

"value", # datetime.timedelta or

2157

# None

2158

"followers")) # Tokens valid after

2159

# this token

2819

Token = collections.namedtuple("Token", (

2820

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

2821

# a "group" containing digits

2822

"value", # datetime.timedelta or None

2823

"followers")) # Tokens valid after this token

2160

2824

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

2161

2825

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

2162

2826

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

2163

2827

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

2164

2828

datetime.timedelta(seconds=1),

2165

frozenset((token_end,)))

2829

frozenset((token_end, )))

2166

2830

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

2167

2831

datetime.timedelta(minutes=1),

2168

2832

frozenset((token_second, token_end)))

2184

2848

frozenset((token_month, token_end)))

2185

2849

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

2186

2850

datetime.timedelta(weeks=1),

2187

frozenset((token_end,)))

2851

frozenset((token_end, )))

2188

2852

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

2189

2853

frozenset((token_year, token_month,

2190

2854

token_day, token_time,

2191

token_week))),

2192

# Define starting values

2193

value = datetime.timedelta() # Value so far

2855

token_week)))

2856

# Define starting values:

2857

# Value so far

2858

value = datetime.timedelta()

2194

2859

found_token = None

2195

followers = frozenset(token_duration,) # Following valid tokens

2196

s = duration # String left to parse

2860

# Following valid tokens

2861

followers = frozenset((token_duration, ))

2862

# String left to parse

2863

s = duration

2197

2864

# Loop until end token is found

2198

2865

while found_token is not token_end:

2199

2866

# Search for any currently valid tokens

2215

2882

break

2216

2883

else:

2217

2884

# No currently valid tokens were found

2218

raise ValueError("Invalid RFC 3339 duration")

2885

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

2886

.format(duration))

2219

2887

# End token found

2220

2888

return value

2221

2889

2222

2890

2223

2891

def string_to_delta(interval):

2224

2892

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

2225

2226

>>> string_to_delta('7d')

2227

datetime.timedelta(7)

2228

>>> string_to_delta('60s')

2229

datetime.timedelta(0, 60)

2230

>>> string_to_delta('60m')

2231

datetime.timedelta(0, 3600)

2232

>>> string_to_delta('24h')

2233

datetime.timedelta(1)

2234

>>> string_to_delta('1w')

2235

datetime.timedelta(7)

2236

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

2237

datetime.timedelta(0, 330)

2893

2894

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

2895

True

2896

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

2897

True

2898

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

2899

True

2900

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

2901

True

2902

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

2903

True

2904

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

2905

True

2238

2906

"""

2239

2907

2240

2908

try:

2241

2909

return rfc3339_duration_to_delta(interval)

2242

2910

except ValueError:

2243

2911

pass

2244

2912

2245

2913

timevalue = datetime.timedelta(0)

2246

2914

for s in interval.split():

2247

2915

try:

2248

suffix = unicode(s[-1])

2916

suffix = s[-1]

2249

2917

value = int(s[:-1])

2250

2918

if suffix == "d":

2251

2919

delta = datetime.timedelta(value)

2258

2926

elif suffix == "w":

2259

2927

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

2260

2928

else:

2261

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

2262

.format(suffix))

2929

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

2263

2930

except IndexError as e:

2264

2931

raise ValueError(*(e.args))

2265

2932

timevalue += delta

2266

2933

return timevalue

2267

2934

2268

2935

2269

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

2936

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

2270

2937

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

2271

2938

2272

2939

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

2273

2940

if os.fork():

2274

2941

sys.exit()

2282

2949

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

2283

2950

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

2284

2951

raise OSError(errno.ENODEV,

2285

"{0} not a character device"

2952

"{} not a character device"

2286

2953

.format(os.devnull))

2287

2954

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

2288

2955

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

2292

2959

2293

2960

2294

2961

def main():

2295

2962

2296

2963

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

2297

2964

# Parsing of options, both command line and config file

2298

2965

2299

2966

parser = argparse.ArgumentParser()

2300

2967

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

2301

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

2968

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

2302

2969

help="show version number and exit")

2303

2970

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

2304

2971

help="Bind to interface IF")

2340

3007

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

2341

3008

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

2342

3009

default=None)

2343

3010

2344

3011

options = parser.parse_args()

2345

2346

if options.check:

2347

import doctest

2348

fail_count, test_count = doctest.testmod()

2349

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

2350

3012

2351

3013

# Default values for config file for server-global settings

2352

server_defaults = { "interface": "",

2353

"address": "",

2354

"port": "",

2355

"debug": "False",

2356

"priority":

2357

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

2358

"servicename": "Mandos",

2359

"use_dbus": "True",

2360

"use_ipv6": "True",

2361

"debuglevel": "",

2362

"restore": "True",

2363

"socket": "",

2364

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

2365

"foreground": "False",

2366

"zeroconf": "True",

2367

}

2368

3014

if gnutls.has_rawpk:

3015

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

3016

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

3017

else:

3018

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

3019

":+SIGN-DSA-SHA256")

3020

server_defaults = {"interface": "",

3021

"address": "",

3022

"port": "",

3023

"debug": "False",

3024

"priority": priority,

3025

"servicename": "Mandos",

3026

"use_dbus": "True",

3027

"use_ipv6": "True",

3028

"debuglevel": "",

3029

"restore": "True",

3030

"socket": "",

3031

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

3032

"foreground": "False",

3033

"zeroconf": "True",

3034

}

3035

del priority

3036

2369

3037

# Parse config file for server-global settings

2370

server_config = configparser.SafeConfigParser(server_defaults)

3038

server_config = configparser.ConfigParser(server_defaults)

2371

3039

del server_defaults

2372

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

2373

"mandos.conf"))

2374

# Convert the SafeConfigParser object to a dict

3040

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

3041

# Convert the ConfigParser object to a dict

2375

3042

server_settings = server_config.defaults()

2376

3043

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

2377

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

3044

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

3045

"foreground", "zeroconf"):

2378

3046

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

2379

3047

option)

2380

3048

if server_settings["port"]:

2390

3058

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

2391

3059

["socket"])

2392

3060

del server_config

2393

3061

2394

3062

# Override the settings from the config file with command line

2395

3063

# options, if set.

2396

3064

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

2397

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

2398

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

2399

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

3065

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

3066

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

3067

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

2400

3068

value = getattr(options, option)

2401

3069

if value is not None:

2402

3070

server_settings[option] = value

2403

3071

del options

2404

3072

# Force all strings to be unicode

2405

3073

for option in server_settings.keys():

2406

if type(server_settings[option]) is str:

2407

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

3074

if isinstance(server_settings[option], bytes):

3075

server_settings[option] = (server_settings[option]

3076

.decode("utf-8"))

2408

3077

# Force all boolean options to be boolean

2409

3078

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

2410

3079

"foreground", "zeroconf"):

2413

3082

if server_settings["debug"]:

2414

3083

server_settings["foreground"] = True

2415

3084

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

2416

3085

2417

3086

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

2418

2419

if (not server_settings["zeroconf"] and

2420

not (server_settings["port"]

2421

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

2422

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

2423

" Zeroconf")

2424

3087

3088

if (not server_settings["zeroconf"]

3089

and not (server_settings["port"]

3090

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

3091

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

3092

2425

3093

# For convenience

2426

3094

debug = server_settings["debug"]

2427

3095

debuglevel = server_settings["debuglevel"]

2431

3099

stored_state_file)

2432

3100

foreground = server_settings["foreground"]

2433

3101

zeroconf = server_settings["zeroconf"]

2434

3102

2435

3103

if debug:

2436

3104

initlogger(debug, logging.DEBUG)

2437

3105

else:

2440

3108

else:

2441

3109

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

2442

3110

initlogger(debug, level)

2443

3111

2444

3112

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

2445

syslogger.setFormatter(logging.Formatter

2446

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

2447

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

2448

.format(server_settings

2449

["servicename"])))

2450

3113

syslogger.setFormatter(

3114

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

3115

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

3116

server_settings["servicename"])))

3117

2451

3118

# Parse config file with clients

2452

client_config = configparser.SafeConfigParser(Client

2453

.client_defaults)

3119

client_config = configparser.ConfigParser(Client.client_defaults)

2454

3120

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

2455

3121

"clients.conf"))

2456

3122

2457

3123

global mandos_dbus_service

2458

3124

mandos_dbus_service = None

2459

3125

2460

3126

socketfd = None

2461

3127

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

2462

3128

socketfd = server_settings["socket"]

2463

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

2464

server_settings["port"]),

2465

ClientHandler,

2466

interface=(server_settings["interface"]

2467

or None),

2468

use_ipv6=use_ipv6,

2469

gnutls_priority=

2470

server_settings["priority"],

2471

use_dbus=use_dbus,

2472

socketfd=socketfd)

3129

tcp_server = MandosServer(

3130

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

3131

ClientHandler,

3132

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

3133

use_ipv6=use_ipv6,

3134

gnutls_priority=server_settings["priority"],

3135

use_dbus=use_dbus,

3136

socketfd=socketfd)

2473

3137

if not foreground:

2474

3138

pidfilename = "/run/mandos.pid"

2475

3139

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

2476

3140

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

2477

3141

pidfile = None

2478

3142

try:

2479

pidfile = open(pidfilename, "w")

3143

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

2480

3144

except IOError as e:

2481

3145

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

2482

3146

exc_info=e)

2483

2484

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

3147

3148

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

3149

("mandos", "mandos"),

3150

("nobody", "nogroup")):

2485

3151

try:

2486

3152

uid = pwd.getpwnam(name).pw_uid

2487

gid = pwd.getpwnam(name).pw_gid

3153

gid = pwd.getpwnam(group).pw_gid

2488

3154

break

2489

3155

except KeyError:

2490

3156

continue

2494

3160

try:

2495

3161

os.setgid(gid)

2496

3162

os.setuid(uid)

3163

if debug:

3164

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

3165

gid))

2497

3166

except OSError as error:

3167

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

3168

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

2498

3169

if error.errno != errno.EPERM:

2499

3170

raise

2500

3171

2501

3172

if debug:

2502

3173

# Enable all possible GnuTLS debugging

2503

3174

2504

3175

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

2505

3176

# - GnuTLS manual

2506

gnutls.library.functions.gnutls_global_set_log_level(11)

2507

2508

@gnutls.library.types.gnutls_log_func

3177

gnutls.global_set_log_level(11)

3178

3179

@gnutls.log_func

2509

3180

def debug_gnutls(level, string):

2510

3181

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

2511

2512

(gnutls.library.functions

2513

.gnutls_global_set_log_function(debug_gnutls))

2514

3182

3183

gnutls.global_set_log_function(debug_gnutls)

3184

2515

3185

# Redirect stdin so all checkers get /dev/null

2516

3186

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

2517

3187

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

2518

3188

if null > 2:

2519

3189

os.close(null)

2520

3190

2521

3191

# Need to fork before connecting to D-Bus

2522

3192

if not foreground:

2523

3193

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

2524

3194

daemon()

2525

2526

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

2527

# need to inform gobject that threads will be used.

2528

gobject.threads_init()

2529

3195

3196

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

3197

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

3198

# need to inform GLib that threads will be used.

3199

GLib.threads_init()

3200

2530

3201

global main_loop

2531

3202

# From the Avahi example code

2532

3203

DBusGMainLoop(set_as_default=True)

2533

main_loop = gobject.MainLoop()

3204

main_loop = GLib.MainLoop()

2534

3205

bus = dbus.SystemBus()

2535

3206

# End of Avahi example code

2536

3207

if use_dbus:

2537

3208

try:

2538

3209

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

2539

bus, do_not_queue=True)

2540

old_bus_name = (dbus.service.BusName

2541

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

2542

do_not_queue=True))

2543

except dbus.exceptions.NameExistsException as e:

3210

bus,

3211

do_not_queue=True)

3212

old_bus_name = dbus.service.BusName(

3213

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

3214

do_not_queue=True)

3215

except dbus.exceptions.DBusException as e:

2544

3216

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

2545

3217

use_dbus = False

2546

3218

server_settings["use_dbus"] = False

2547

3219

tcp_server.use_dbus = False

2548

3220

if zeroconf:

2549

3221

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2550

service = AvahiServiceToSyslog(name =

2551

server_settings["servicename"],

2552

servicetype = "_mandos._tcp",

2553

protocol = protocol, bus = bus)

3222

service = AvahiServiceToSyslog(

3223

name=server_settings["servicename"],

3224

servicetype="_mandos._tcp",

3225

protocol=protocol,

3226

bus=bus)

2554

3227

if server_settings["interface"]:

2555

service.interface = (if_nametoindex

2556

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

2557

3228

service.interface = if_nametoindex(

3229

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

3230

2558

3231

global multiprocessing_manager

2559

3232

multiprocessing_manager = multiprocessing.Manager()

2560

3233

2561

3234

client_class = Client

2562

3235

if use_dbus:

2563

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

2564

3236

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

3237

2565

3238

client_settings = Client.config_parser(client_config)

2566

3239

old_client_settings = {}

2567

3240

clients_data = {}

2568

3241

2569

3242

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

2570

3243

global wnull

2571

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

3244

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

2572

3245

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

2573

3246

# mode

2574

3247

if debug or not foreground:

2575

3248

wnull.close()

2576

3249

2577

3250

# Get client data and settings from last running state.

2578

3251

if server_settings["restore"]:

2579

3252

try:

2580

3253

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

2581

clients_data, old_client_settings = (pickle.load

2582

(stored_state))

3254

if sys.version_info.major == 2:

3255

clients_data, old_client_settings = pickle.load(

3256

stored_state)

3257

else:

3258

bytes_clients_data, bytes_old_client_settings = (

3259

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

3260

# Fix bytes to strings

3261

# clients_data

3262

# .keys()

3263

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

3264

if isinstance(key, bytes)

3265

else key): value

3266

for key, value in

3267

bytes_clients_data.items()}

3268

del bytes_clients_data

3269

for key in clients_data:

3270

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

3271

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

3272

for k, v in

3273

clients_data[key].items()}

3274

clients_data[key] = value

3275

# .client_structure

3276

value["client_structure"] = [

3277

(s.decode("utf-8")

3278

if isinstance(s, bytes)

3279

else s) for s in

3280

value["client_structure"]]

3281

# .name, .host, and .checker_command

3282

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

3283

if isinstance(value[k], bytes):

3284

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

3285

if "key_id" not in value:

3286

value["key_id"] = ""

3287

elif "fingerprint" not in value:

3288

value["fingerprint"] = ""

3289

# old_client_settings

3290

# .keys()

3291

old_client_settings = {

3292

(key.decode("utf-8")

3293

if isinstance(key, bytes)

3294

else key): value

3295

for key, value in

3296

bytes_old_client_settings.items()}

3297

del bytes_old_client_settings

3298

# .host and .checker_command

3299

for value in old_client_settings.values():

3300

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

3301

if isinstance(value[attribute], bytes):

3302

value[attribute] = (value[attribute]

3303

.decode("utf-8"))

2583

3304

os.remove(stored_state_path)

2584

3305

except IOError as e:

2585

3306

if e.errno == errno.ENOENT:

2586

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

2587

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

3307

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

3308

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

2588

3309

else:

2589

3310

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

2590

3311

exc_info=e)

2591

3312

raise

2592

3313

except EOFError as e:

2593

3314

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

2594

"EOFError:", exc_info=e)

2595

3315

"EOFError:",

3316

exc_info=e)

3317

2596

3318

with PGPEngine() as pgp:

2597

for client_name, client in clients_data.iteritems():

3319

for client_name, client in clients_data.items():

2598

3320

# Skip removed clients

2599

3321

if client_name not in client_settings:

2600

3322

continue

2601

3323

2602

3324

# Decide which value to use after restoring saved state.

2603

3325

# We have three different values: Old config file,

2604

3326

# new config file, and saved state.

2609

3331

# For each value in new config, check if it

2610

3332

# differs from the old config value (Except for

2611

3333

# the "secret" attribute)

2612

if (name != "secret" and

2613

value != old_client_settings[client_name]

2614

[name]):

3334

if (name != "secret"

3335

and (value !=

3336

old_client_settings[client_name][name])):

2615

3337

client[name] = value

2616

3338

except KeyError:

2617

3339

pass

2618

3340

2619

3341

# Clients who has passed its expire date can still be

2620

# enabled if its last checker was successful. Clients

3342

# enabled if its last checker was successful. A Client

2621

3343

# whose checker succeeded before we stored its state is

2622

3344

# assumed to have successfully run all checkers during

2623

3345

# downtime.

2625

3347

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

2626

3348

if not client["last_checked_ok"]:

2627

3349

logger.warning(

2628

"disabling client {0} - Client never "

2629

"performed a successful checker"

2630

.format(client_name))

3350

"disabling client {} - Client never "

3351

"performed a successful checker".format(

3352

client_name))

2631

3353

client["enabled"] = False

2632

3354

elif client["last_checker_status"] != 0:

2633

3355

logger.warning(

2634

"disabling client {0} - Client "

2635

"last checker failed with error code {1}"

2636

.format(client_name,

2637

client["last_checker_status"]))

3356

"disabling client {} - Client last"

3357

" checker failed with error code"

3358

" {}".format(

3359

client_name,

3360

client["last_checker_status"]))

2638

3361

client["enabled"] = False

2639

3362

else:

2640

client["expires"] = (datetime.datetime

2641

.utcnow()

2642

+ client["timeout"])

3363

client["expires"] = (

3364

datetime.datetime.utcnow()

3365

+ client["timeout"])

2643

3366

logger.debug("Last checker succeeded,"

2644

" keeping {0} enabled"

2645

.format(client_name))

3367

" keeping {} enabled".format(

3368

client_name))

2646

3369

try:

2647

client["secret"] = (

2648

pgp.decrypt(client["encrypted_secret"],

2649

client_settings[client_name]

2650

["secret"]))

3370

client["secret"] = pgp.decrypt(

3371

client["encrypted_secret"],

3372

client_settings[client_name]["secret"])

2651

3373

except PGPError:

2652

3374

# If decryption fails, we use secret from new settings

2653

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

2654

.format(client_name))

2655

client["secret"] = (

2656

client_settings[client_name]["secret"])

2657

3375

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

3376

client_name))

3377

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

3378

["secret"])

3379

2658

3380

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

2659

3381

for client_name in (set(old_client_settings)

2660

3382

- set(client_settings)):

2662

3384

for client_name in (set(client_settings)

2663

3385

- set(old_client_settings)):

2664

3386

clients_data[client_name] = client_settings[client_name]

2665

3387

2666

3388

# Create all client objects

2667

for client_name, client in clients_data.iteritems():

3389

for client_name, client in clients_data.items():

2668

3390

tcp_server.clients[client_name] = client_class(

2669

name = client_name, settings = client,

2670

server_settings = server_settings)

2671

3391

name=client_name,

3392

settings=client,

3393

server_settings=server_settings)

3394

2672

3395

if not tcp_server.clients:

2673

3396

logger.warning("No clients defined")

2674

3397

2675

3398

if not foreground:

2676

3399

if pidfile is not None:

3400

pid = os.getpid()

2677

3401

try:

2678

3402

with pidfile:

2679

pid = os.getpid()

2680

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

3403

print(pid, file=pidfile)

2681

3404

except IOError:

2682

3405

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

2683

3406

pidfilename, pid)

2684

3407

del pidfile

2685

3408

del pidfilename

2686

2687

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

2688

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

2689

3409

3410

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

3411

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3412

lambda: main_loop.quit() and False)

3413

2690

3414

if use_dbus:

2691

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

2692

"se.bsnet.fukt.Mandos"})

2693

class MandosDBusService(DBusObjectWithProperties):

3415

3416

@alternate_dbus_interfaces(

3417

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

3418

class MandosDBusService(DBusObjectWithObjectManager):

2694

3419

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

3420

2695

3421

def __init__(self):

2696

3422

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

3423

2697

3424

_interface = "se.recompile.Mandos"

2698

2699

@dbus_interface_annotations(_interface)

2700

def _foo(self):

2701

return { "org.freedesktop.DBus.Property"

2702

".EmitsChangedSignal":

2703

"false"}

2704

3425

2705

3426

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

2706

3427

def ClientAdded(self, objpath):

2707

3428

"D-Bus signal"

2708

3429

pass

2709

3430

2710

3431

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

2711

def ClientNotFound(self, fingerprint, address):

3432

def ClientNotFound(self, key_id, address):

2712

3433

"D-Bus signal"

2713

3434

pass

2714

3435

3436

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

3437

"true"})

2715

3438

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

2716

3439

def ClientRemoved(self, objpath, name):

2717

3440

"D-Bus signal"

2718

3441

pass

2719

3442

3443

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

3444

"true"})

2720

3445

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

2721

3446

def GetAllClients(self):

2722

3447

"D-Bus method"

2723

return dbus.Array(c.dbus_object_path

2724

for c in

2725

tcp_server.clients.itervalues())

2726

3448

return dbus.Array(c.dbus_object_path for c in

3449

tcp_server.clients.values())

3450

3451

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

3452

"true"})

2727

3453

@dbus.service.method(_interface,

2728

3454

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

2729

3455

def GetAllClientsWithProperties(self):

2730

3456

"D-Bus method"

2731

3457

return dbus.Dictionary(

2732

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

2733

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

3458

{c.dbus_object_path: c.GetAll(

3459

"se.recompile.Mandos.Client")

3460

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

2734

3461

signature="oa{sv}")

2735

3462

2736

3463

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

2737

3464

def RemoveClient(self, object_path):

2738

3465

"D-Bus method"

2739

for c in tcp_server.clients.itervalues():

3466

for c in tcp_server.clients.values():

2740

3467

if c.dbus_object_path == object_path:

2741

3468

del tcp_server.clients[c.name]

2742

3469

c.remove_from_connection()

2743

# Don't signal anything except ClientRemoved

3470

# Don't signal the disabling

2744

3471

c.disable(quiet=True)

2745

# Emit D-Bus signal

2746

self.ClientRemoved(object_path, c.name)

3472

# Emit D-Bus signal for removal

3473

self.client_removed_signal(c)

2747

3474

return

2748

3475

raise KeyError(object_path)

2749

3476

2750

3477

del _interface

2751

3478

3479

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3480

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

3481

def GetManagedObjects(self):

3482

"""D-Bus method"""

3483

return dbus.Dictionary(

3484

{client.dbus_object_path:

3485

dbus.Dictionary(

3486

{interface: client.GetAll(interface)

3487

for interface in

3488

client._get_all_interface_names()})

3489

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

3490

3491

def client_added_signal(self, client):

3492

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

3493

if use_dbus:

3494

# New standard signal

3495

self.InterfacesAdded(

3496

client.dbus_object_path,

3497

dbus.Dictionary(

3498

{interface: client.GetAll(interface)

3499

for interface in

3500

client._get_all_interface_names()}))

3501

# Old signal

3502

self.ClientAdded(client.dbus_object_path)

3503

3504

def client_removed_signal(self, client):

3505

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

3506

if use_dbus:

3507

# New standard signal

3508

self.InterfacesRemoved(

3509

client.dbus_object_path,

3510

client._get_all_interface_names())

3511

# Old signal

3512

self.ClientRemoved(client.dbus_object_path,

3513

client.name)

3514

2752

3515

mandos_dbus_service = MandosDBusService()

2753

3516

3517

# Save modules to variables to exempt the modules from being

3518

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

3519

mp = multiprocessing

3520

wn = wnull

3521

2754

3522

def cleanup():

2755

3523

"Cleanup function; run on exit"

2756

3524

if zeroconf:

2757

3525

service.cleanup()

2758

2759

multiprocessing.active_children()

2760

wnull.close()

3526

3527

mp.active_children()

3528

wn.close()

2761

3529

if not (tcp_server.clients or client_settings):

2762

3530

return

2763

3531

2764

3532

# Store client before exiting. Secrets are encrypted with key

2765

3533

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

2766

3534

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

2767

3535

clients = {}

2768

3536

with PGPEngine() as pgp:

2769

for client in tcp_server.clients.itervalues():

3537

for client in tcp_server.clients.values():

2770

3538

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

2771

3539

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

2772

3540

key)

2773

3541

client_dict = {}

2774

3542

2775

3543

# A list of attributes that can not be pickled

2776

3544

# + secret.

2777

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

2778

"checker", "server_settings"))

2779

for name, typ in (inspect.getmembers

2780

(dbus.service.Object)):

3545

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

3546

"checker", "server_settings"}

3547

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

3548

.Object):

2781

3549

exclude.add(name)

2782

3550

2783

3551

client_dict["encrypted_secret"] = (client

2784

3552

.encrypted_secret)

2785

3553

for attr in client.client_structure:

2786

3554

if attr not in exclude:

2787

3555

client_dict[attr] = getattr(client, attr)

2788

3556

2789

3557

clients[client.name] = client_dict

2790

3558

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

2791

3559

2792

3560

try:

2793

with (tempfile.NamedTemporaryFile

2794

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

2795

dir=os.path.dirname(stored_state_path),

2796

delete=False)) as stored_state:

2797

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

2798

tempname=stored_state.name

3561

with tempfile.NamedTemporaryFile(

3562

mode='wb',

3563

suffix=".pickle",

3564

prefix='clients-',

3565

dir=os.path.dirname(stored_state_path),

3566

delete=False) as stored_state:

3567

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

3568

protocol=2)

3569

tempname = stored_state.name

2799

3570

os.rename(tempname, stored_state_path)

2800

3571

except (IOError, OSError) as e:

2801

3572

if not debug:

2804

3575

except NameError:

2805

3576

pass

2806

3577

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

2807

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

3578

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

2808

3579

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

2809

3580

else:

2810

3581

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

2811

3582

exc_info=e)

2812

3583

raise

2813

3584

2814

3585

# Delete all clients, and settings from config

2815

3586

while tcp_server.clients:

2816

3587

name, client = tcp_server.clients.popitem()

2817

3588

if use_dbus:

2818

3589

client.remove_from_connection()

2819

# Don't signal anything except ClientRemoved

3590

# Don't signal the disabling

2820

3591

client.disable(quiet=True)

3592

# Emit D-Bus signal for removal

2821

3593

if use_dbus:

2822

# Emit D-Bus signal

2823

mandos_dbus_service.ClientRemoved(client

2824

.dbus_object_path,

2825

client.name)

3594

mandos_dbus_service.client_removed_signal(client)

2826

3595

client_settings.clear()

2827

3596

2828

3597

atexit.register(cleanup)

2829

2830

for client in tcp_server.clients.itervalues():

3598

3599

for client in tcp_server.clients.values():

2831

3600

if use_dbus:

2832

# Emit D-Bus signal

2833

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3601

# Emit D-Bus signal for adding

3602

mandos_dbus_service.client_added_signal(client)

2834

3603

# Need to initiate checking of clients

2835

3604

if client.enabled:

2836

3605

client.init_checker()

2837

3606

2838

3607

tcp_server.enable()

2839

3608

tcp_server.server_activate()

2840

3609

2841

3610

# Find out what port we got

2842

3611

if zeroconf:

2843

3612

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

2848

3617

else: # IPv4

2849

3618

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

2850

3619

*tcp_server.socket.getsockname())

2851

2852

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

2853

3620

3621

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

3622

2854

3623

try:

2855

3624

if zeroconf:

2856

3625

# From the Avahi example code

2861

3630

cleanup()

2862

3631

sys.exit(1)

2863

3632

# End of Avahi example code

2864

2865

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

2866

lambda *args, **kwargs:

2867

(tcp_server.handle_request

2868

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

2869

3633

3634

GLib.io_add_watch(

3635

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

3636

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3637

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

3638

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

3639

2870

3640

logger.debug("Starting main loop")

2871

3641

main_loop.run()

2872

3642

except AvahiError as error:

2881

3651

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

2882

3652

cleanup()

2883

3653

3654

3655

def should_only_run_tests():

3656

parser = argparse.ArgumentParser(add_help=False)

3657

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

3658

args, unknown_args = parser.parse_known_args()

3659

run_tests = args.check

3660

if run_tests:

3661

# Remove --check argument from sys.argv

3662

sys.argv[1:] = unknown_args

3663

return run_tests

3664

3665

# Add all tests from doctest strings

3666

def load_tests(loader, tests, none):

3667

import doctest

3668

tests.addTests(doctest.DocTestSuite())

3669

return tests

3670

2884

3671

if __name__ == '__main__':

2885

main()

3672

try:

3673

if should_only_run_tests():

3674

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

3675

unittest.main()

3676

else:

3677

main()

3678

finally:

3679

logging.shutdown()