/mandos/release : revision 237.7.167

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import unittest

81

import random

82

72

83

73

import dbus

84

74

import dbus.service

85

import gi

86

from gi.repository import GLib

75

import gobject

76

import avahi

87

77

from dbus.mainloop.glib import DBusGMainLoop

88

78

import ctypes

89

79

import ctypes.util

90

80

import xml.dom.minidom

91

81

import inspect

92

82

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

97

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

98

try:

99

collections.abc.Callable

100

except AttributeError:

101

class abc:

102

Callable = collections.Callable

103

collections.abc = abc

104

del abc

105

106

# Show warnings by default

107

if not sys.warnoptions:

108

import warnings

109

warnings.simplefilter("default")

110

111

# Try to find the value of SO_BINDTODEVICE:

112

try:

113

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

114

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

83

try:

115

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

116

85

except AttributeError:

117

86

try:

118

# This is where SO_BINDTODEVICE was up to and including Python

119

# 2.6, and also 3.2:

120

87

from IN import SO_BINDTODEVICE

121

88

except ImportError:

122

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

123

# Try running the C preprocessor:

124

try:

125

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

126

"/dev/stdin"],

127

stdin=subprocess.PIPE,

128

stdout=subprocess.PIPE)

129

stdout = cc.communicate(

130

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

131

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

132

except (OSError, ValueError, IndexError):

133

# No value found

134

SO_BINDTODEVICE = None

135

136

if sys.version_info < (3, 2):

137

configparser.Configparser = configparser.SafeConfigParser

138

139

version = "1.8.9"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.0"

140

92

stored_state_file = "clients.pickle"

141

93

142

94

logger = logging.getLogger()

143

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

144

syslogger = None

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

145

98

146

99

try:

147

if_nametoindex = ctypes.cdll.LoadLibrary(

148

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

149

103

except (OSError, AttributeError):

150

151

104

def if_nametoindex(interface):

152

105

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

153

106

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

154

107

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

155

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

156

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

157

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

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

158

113

return interface_index

159

114

160

115

161

def copy_function(func):

162

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

163

if sys.version_info.major == 2:

164

return types.FunctionType(func.func_code,

165

func.func_globals,

166

func.func_name,

167

func.func_defaults,

168

func.func_closure)

169

else:

170

return types.FunctionType(func.__code__,

171

func.__globals__,

172

func.__name__,

173

func.__defaults__,

174

func.__closure__)

175

176

177

116

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

178

117

"""init logger and add loglevel"""

179

180

global syslogger

181

syslogger = (logging.handlers.SysLogHandler(

182

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

183

address="/dev/log"))

118

184

119

syslogger.setFormatter(logging.Formatter

185

120

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

186

121

' %(message)s'))

187

122

logger.addHandler(syslogger)

188

123

189

124

if debug:

190

125

console = logging.StreamHandler()

191

126

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

201

136

pass

202

137

203

138

204

class PGPEngine:

139

class PGPEngine(object):

205

140

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

206

207

141

def __init__(self):

208

142

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

209

self.gpg = "gpg"

210

try:

211

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

212

for line in output.splitlines():

213

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

214

if name == b"gpg":

215

self.gpg = path

216

break

217

except OSError as e:

218

if e.errno != errno.ENOENT:

219

raise

220

143

self.gnupgargs = ['--batch',

221

'--homedir', self.tempdir,

144

'--home', self.tempdir,

222

145

'--force-mdc',

223

'--quiet']

224

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

225

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

226

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

227

146

'--quiet',

147

'--no-use-agent']

148

228

149

def __enter__(self):

229

150

return self

230

151

231

152

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

232

153

self._cleanup()

233

154

return False

234

155

235

156

def __del__(self):

236

157

self._cleanup()

237

158

238

159

def _cleanup(self):

239

160

if self.tempdir is not None:

240

161

# Delete contents of tempdir

241

162

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

242

topdown=False):

163

topdown = False):

243

164

for filename in files:

244

165

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

245

166

for dirname in dirs:

247

168

# Remove tempdir

248

169

os.rmdir(self.tempdir)

249

170

self.tempdir = None

250

171

251

172

def password_encode(self, password):

252

173

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

253

174

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

254

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

255

if len(encoded) > 2048:

256

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

257

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

258

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

259

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

260

return encoded

261

175

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

176

262

177

def encrypt(self, data, password):

263

178

passphrase = self.password_encode(password)

264

with tempfile.NamedTemporaryFile(

265

dir=self.tempdir) as passfile:

179

with tempfile.NamedTemporaryFile(dir=self.tempdir

180

) as passfile:

266

181

passfile.write(passphrase)

267

182

passfile.flush()

268

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

183

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

269

184

'--passphrase-file',

270

185

passfile.name]

271

186

+ self.gnupgargs,

272

stdin=subprocess.PIPE,

273

stdout=subprocess.PIPE,

274

stderr=subprocess.PIPE)

275

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

187

stdin = subprocess.PIPE,

188

stdout = subprocess.PIPE,

189

stderr = subprocess.PIPE)

190

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

276

191

if proc.returncode != 0:

277

192

raise PGPError(err)

278

193

return ciphertext

279

194

280

195

def decrypt(self, data, password):

281

196

passphrase = self.password_encode(password)

282

with tempfile.NamedTemporaryFile(

283

dir=self.tempdir) as passfile:

197

with tempfile.NamedTemporaryFile(dir = self.tempdir

198

) as passfile:

284

199

passfile.write(passphrase)

285

200

passfile.flush()

286

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

201

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

287

202

'--passphrase-file',

288

203

passfile.name]

289

204

+ self.gnupgargs,

290

stdin=subprocess.PIPE,

291

stdout=subprocess.PIPE,

292

stderr=subprocess.PIPE)

293

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

205

stdin = subprocess.PIPE,

206

stdout = subprocess.PIPE,

207

stderr = subprocess.PIPE)

208

decrypted_plaintext, err = proc.communicate(input

209

= data)

294

210

if proc.returncode != 0:

295

211

raise PGPError(err)

296

212

return decrypted_plaintext

297

213

298

214

299

# Pretend that we have an Avahi module

300

class avahi:

301

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

302

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

303

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

304

PROTO_INET = 0 # avahi-common/address.h

305

PROTO_INET6 = 1 # avahi-common/address.h

306

DBUS_NAME = "org.freedesktop.Avahi"

307

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

308

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

309

DBUS_PATH_SERVER = "/"

310

311

@staticmethod

312

def string_array_to_txt_array(t):

313

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

314

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

315

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

316

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

317

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

318

SERVER_INVALID = 0 # avahi-common/defs.h

319

SERVER_REGISTERING = 1 # avahi-common/defs.h

320

SERVER_RUNNING = 2 # avahi-common/defs.h

321

SERVER_COLLISION = 3 # avahi-common/defs.h

322

SERVER_FAILURE = 4 # avahi-common/defs.h

323

324

325

215

class AvahiError(Exception):

326

216

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

327

217

self.value = value

328

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

329

**kwargs)

330

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

331

221

332

222

class AvahiServiceError(AvahiError):

333

223

pass

334

224

335

336

225

class AvahiGroupError(AvahiError):

337

226

pass

338

227

339

228

340

class AvahiService:

229

class AvahiService(object):

341

230

"""An Avahi (Zeroconf) service.

342

231

343

232

Attributes:

344

233

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

345

234

Used to optionally bind to the specified interface.

357

246

server: D-Bus Server

358

247

bus: dbus.SystemBus()

359

248

"""

360

361

def __init__(self,

362

interface=avahi.IF_UNSPEC,

363

name=None,

364

servicetype=None,

365

port=None,

366

TXT=None,

367

domain="",

368

host="",

369

max_renames=32768,

370

protocol=avahi.PROTO_UNSPEC,

371

bus=None):

249

250

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

251

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

252

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

253

protocol = avahi.PROTO_UNSPEC, bus = None):

372

254

self.interface = interface

373

255

self.name = name

374

256

self.type = servicetype

383

265

self.server = None

384

266

self.bus = bus

385

267

self.entry_group_state_changed_match = None

386

387

def rename(self, remove=True):

268

269

def rename(self):

388

270

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

389

271

if self.rename_count >= self.max_renames:

390

272

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

391

273

" after %i retries, exiting.",

392

274

self.rename_count)

393

275

raise AvahiServiceError("Too many renames")

394

self.name = str(

395

self.server.GetAlternativeServiceName(self.name))

396

self.rename_count += 1

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

397

278

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

398

279

self.name)

399

if remove:

400

self.remove()

280

self.remove()

401

281

try:

402

282

self.add()

403

283

except dbus.exceptions.DBusException as error:

404

if (error.get_dbus_name()

405

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

406

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

407

return self.rename(remove=False)

408

else:

409

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

410

self.cleanup()

411

os._exit(1)

412

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

288

413

289

def remove(self):

414

290

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

415

291

if self.entry_group_state_changed_match is not None:

417

293

self.entry_group_state_changed_match = None

418

294

if self.group is not None:

419

295

self.group.Reset()

420

296

421

297

def add(self):

422

298

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

423

299

self.remove()

440

316

dbus.UInt16(self.port),

441

317

avahi.string_array_to_txt_array(self.TXT))

442

318

self.group.Commit()

443

319

444

320

def entry_group_state_changed(self, state, error):

445

321

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

446

322

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

447

323

448

324

if state == avahi.ENTRY_GROUP_ESTABLISHED:

449

325

logger.debug("Zeroconf service established.")

450

326

elif state == avahi.ENTRY_GROUP_COLLISION:

452

328

self.rename()

453

329

elif state == avahi.ENTRY_GROUP_FAILURE:

454

330

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

455

str(error))

456

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

457

331

unicode(error))

332

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

333

.format(error))

334

458

335

def cleanup(self):

459

336

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

460

337

if self.group is not None:

465

342

pass

466

343

self.group = None

467

344

self.remove()

468

345

469

346

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

470

347

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

471

348

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

472

bad_states = {

473

avahi.SERVER_INVALID: "Zeroconf server invalid",

474

avahi.SERVER_REGISTERING: None,

475

avahi.SERVER_COLLISION: "Zeroconf server name collision",

476

avahi.SERVER_FAILURE: "Zeroconf server failure",

477

}

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

478

356

if state in bad_states:

479

357

if bad_states[state] is not None:

480

358

if error is None:

483

361

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

484

362

self.cleanup()

485

363

elif state == avahi.SERVER_RUNNING:

486

try:

487

self.add()

488

except dbus.exceptions.DBusException as error:

489

if (error.get_dbus_name()

490

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

491

logger.info("Local Zeroconf service name"

492

" collision.")

493

return self.rename(remove=False)

494

else:

495

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

496

self.cleanup()

497

os._exit(1)

364

self.add()

498

365

else:

499

366

if error is None:

500

367

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

501

368

else:

502

369

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

503

370

504

371

def activate(self):

505

372

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

506

373

if self.server is None:

510

377

follow_name_owner_changes=True),

511

378

avahi.DBUS_INTERFACE_SERVER)

512

379

self.server.connect_to_signal("StateChanged",

513

self.server_state_changed)

380

self.server_state_changed)

514

381

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

515

382

516

383

517

384

class AvahiServiceToSyslog(AvahiService):

518

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

385

def rename(self):

519

386

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

520

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

521

syslogger.setFormatter(logging.Formatter(

522

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

523

.format(self.name)))

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

524

392

return ret

525

393

526

394

527

# Pretend that we have a GnuTLS module

528

class gnutls:

529

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

530

531

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

532

if library is None:

533

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

534

_library = ctypes.cdll.LoadLibrary(library)

535

del library

536

537

# Unless otherwise indicated, the constants and types below are

538

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

539

540

# Constants

541

E_SUCCESS = 0

542

E_INTERRUPTED = -52

543

E_AGAIN = -28

544

CRT_OPENPGP = 2

545

CRT_RAWPK = 3

546

CLIENT = 2

547

SHUT_RDWR = 0

548

CRD_CERTIFICATE = 1

549

E_NO_CERTIFICATE_FOUND = -49

550

X509_FMT_DER = 0

551

NO_TICKETS = 1<<10

552

ENABLE_RAWPK = 1<<18

553

CTYPE_PEERS = 3

554

KEYID_USE_SHA256 = 1 # gnutls/x509.h

555

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

556

557

# Types

558

class session_int(ctypes.Structure):

559

_fields_ = []

560

session_t = ctypes.POINTER(session_int)

561

562

class certificate_credentials_st(ctypes.Structure):

563

_fields_ = []

564

certificate_credentials_t = ctypes.POINTER(

565

certificate_credentials_st)

566

certificate_type_t = ctypes.c_int

567

568

class datum_t(ctypes.Structure):

569

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

570

('size', ctypes.c_uint)]

571

572

class openpgp_crt_int(ctypes.Structure):

573

_fields_ = []

574

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

575

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

576

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

577

credentials_type_t = ctypes.c_int

578

transport_ptr_t = ctypes.c_void_p

579

close_request_t = ctypes.c_int

580

581

# Exceptions

582

class Error(Exception):

583

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

584

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

585

# code is passed, convert it to a string with

586

# gnutls.strerror()

587

self.code = code

588

if message is None and code is not None:

589

message = gnutls.strerror(code)

590

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

591

message, *args)

592

593

class CertificateSecurityError(Error):

594

pass

595

596

# Classes

597

class Credentials:

598

def __init__(self):

599

self._c_object = gnutls.certificate_credentials_t()

600

gnutls.certificate_allocate_credentials(

601

ctypes.byref(self._c_object))

602

self.type = gnutls.CRD_CERTIFICATE

603

604

def __del__(self):

605

gnutls.certificate_free_credentials(self._c_object)

606

607

class ClientSession:

608

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

609

self._c_object = gnutls.session_t()

610

gnutls_flags = gnutls.CLIENT

611

if gnutls.check_version(b"3.5.6"):

612

gnutls_flags |= gnutls.NO_TICKETS

613

if gnutls.has_rawpk:

614

gnutls_flags |= gnutls.ENABLE_RAWPK

615

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

616

del gnutls_flags

617

gnutls.set_default_priority(self._c_object)

618

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

619

gnutls.handshake_set_private_extensions(self._c_object,

620

True)

621

self.socket = socket

622

if credentials is None:

623

credentials = gnutls.Credentials()

624

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

625

ctypes.cast(credentials._c_object,

626

ctypes.c_void_p))

627

self.credentials = credentials

628

629

def __del__(self):

630

gnutls.deinit(self._c_object)

631

632

def handshake(self):

633

return gnutls.handshake(self._c_object)

634

635

def send(self, data):

636

data = bytes(data)

637

data_len = len(data)

638

while data_len > 0:

639

data_len -= gnutls.record_send(self._c_object,

640

data[-data_len:],

641

data_len)

642

643

def bye(self):

644

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

645

646

# Error handling functions

647

def _error_code(result):

648

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

649

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

650

if result >= 0:

651

return result

652

if result == gnutls.E_NO_CERTIFICATE_FOUND:

653

raise gnutls.CertificateSecurityError(code=result)

654

raise gnutls.Error(code=result)

655

656

def _retry_on_error(result, func, arguments):

657

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

658

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

659

while result < 0:

660

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

661

return _error_code(result)

662

result = func(*arguments)

663

return result

664

665

# Unless otherwise indicated, the function declarations below are

666

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

667

668

# Functions

669

priority_set_direct = _library.gnutls_priority_set_direct

670

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

671

ctypes.POINTER(ctypes.c_char_p)]

672

priority_set_direct.restype = _error_code

673

674

init = _library.gnutls_init

675

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

676

init.restype = _error_code

677

678

set_default_priority = _library.gnutls_set_default_priority

679

set_default_priority.argtypes = [session_t]

680

set_default_priority.restype = _error_code

681

682

record_send = _library.gnutls_record_send

683

record_send.argtypes = [session_t, ctypes.c_void_p,

684

ctypes.c_size_t]

685

record_send.restype = ctypes.c_ssize_t

686

record_send.errcheck = _retry_on_error

687

688

certificate_allocate_credentials = (

689

_library.gnutls_certificate_allocate_credentials)

690

certificate_allocate_credentials.argtypes = [

691

ctypes.POINTER(certificate_credentials_t)]

692

certificate_allocate_credentials.restype = _error_code

693

694

certificate_free_credentials = (

695

_library.gnutls_certificate_free_credentials)

696

certificate_free_credentials.argtypes = [

697

certificate_credentials_t]

698

certificate_free_credentials.restype = None

699

700

handshake_set_private_extensions = (

701

_library.gnutls_handshake_set_private_extensions)

702

handshake_set_private_extensions.argtypes = [session_t,

703

ctypes.c_int]

704

handshake_set_private_extensions.restype = None

705

706

credentials_set = _library.gnutls_credentials_set

707

credentials_set.argtypes = [session_t, credentials_type_t,

708

ctypes.c_void_p]

709

credentials_set.restype = _error_code

710

711

strerror = _library.gnutls_strerror

712

strerror.argtypes = [ctypes.c_int]

713

strerror.restype = ctypes.c_char_p

714

715

certificate_type_get = _library.gnutls_certificate_type_get

716

certificate_type_get.argtypes = [session_t]

717

certificate_type_get.restype = _error_code

718

719

certificate_get_peers = _library.gnutls_certificate_get_peers

720

certificate_get_peers.argtypes = [session_t,

721

ctypes.POINTER(ctypes.c_uint)]

722

certificate_get_peers.restype = ctypes.POINTER(datum_t)

723

724

global_set_log_level = _library.gnutls_global_set_log_level

725

global_set_log_level.argtypes = [ctypes.c_int]

726

global_set_log_level.restype = None

727

728

global_set_log_function = _library.gnutls_global_set_log_function

729

global_set_log_function.argtypes = [log_func]

730

global_set_log_function.restype = None

731

732

deinit = _library.gnutls_deinit

733

deinit.argtypes = [session_t]

734

deinit.restype = None

735

736

handshake = _library.gnutls_handshake

737

handshake.argtypes = [session_t]

738

handshake.restype = _error_code

739

handshake.errcheck = _retry_on_error

740

741

transport_set_ptr = _library.gnutls_transport_set_ptr

742

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

743

transport_set_ptr.restype = None

744

745

bye = _library.gnutls_bye

746

bye.argtypes = [session_t, close_request_t]

747

bye.restype = _error_code

748

bye.errcheck = _retry_on_error

749

750

check_version = _library.gnutls_check_version

751

check_version.argtypes = [ctypes.c_char_p]

752

check_version.restype = ctypes.c_char_p

753

754

_need_version = b"3.3.0"

755

if check_version(_need_version) is None:

756

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

757

.format(_need_version))

758

759

_tls_rawpk_version = b"3.6.6"

760

has_rawpk = bool(check_version(_tls_rawpk_version))

761

762

if has_rawpk:

763

# Types

764

class pubkey_st(ctypes.Structure):

765

_fields = []

766

pubkey_t = ctypes.POINTER(pubkey_st)

767

768

x509_crt_fmt_t = ctypes.c_int

769

770

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

771

pubkey_init = _library.gnutls_pubkey_init

772

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

773

pubkey_init.restype = _error_code

774

775

pubkey_import = _library.gnutls_pubkey_import

776

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

777

x509_crt_fmt_t]

778

pubkey_import.restype = _error_code

779

780

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

781

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

782

ctypes.POINTER(ctypes.c_ubyte),

783

ctypes.POINTER(ctypes.c_size_t)]

784

pubkey_get_key_id.restype = _error_code

785

786

pubkey_deinit = _library.gnutls_pubkey_deinit

787

pubkey_deinit.argtypes = [pubkey_t]

788

pubkey_deinit.restype = None

789

else:

790

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

791

792

openpgp_crt_init = _library.gnutls_openpgp_crt_init

793

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

794

openpgp_crt_init.restype = _error_code

795

796

openpgp_crt_import = _library.gnutls_openpgp_crt_import

797

openpgp_crt_import.argtypes = [openpgp_crt_t,

798

ctypes.POINTER(datum_t),

799

openpgp_crt_fmt_t]

800

openpgp_crt_import.restype = _error_code

801

802

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

803

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

804

ctypes.POINTER(ctypes.c_uint)]

805

openpgp_crt_verify_self.restype = _error_code

806

807

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

808

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

809

openpgp_crt_deinit.restype = None

810

811

openpgp_crt_get_fingerprint = (

812

_library.gnutls_openpgp_crt_get_fingerprint)

813

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

814

ctypes.c_void_p,

815

ctypes.POINTER(

816

ctypes.c_size_t)]

817

openpgp_crt_get_fingerprint.restype = _error_code

818

819

if check_version(b"3.6.4"):

820

certificate_type_get2 = _library.gnutls_certificate_type_get2

821

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

822

certificate_type_get2.restype = _error_code

823

824

# Remove non-public functions

825

del _error_code, _retry_on_error

826

827

828

def call_pipe(connection, # : multiprocessing.Connection

829

func, *args, **kwargs):

830

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

831

832

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

833

return value on the provided multiprocessing.Connection.

834

"""

835

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

836

connection.close()

837

838

839

class Client:

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

400

401

402

class Client(object):

840

403

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

841

404

842

405

Attributes:

843

406

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

844

407

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

845

408

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

846

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

847

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

848

running.

849

checker_callback_tag: a GLib event source tag, or None

409

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

410

to see if the client lives.

411

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

850

413

checker_command: string; External command which is run to check

851

414

if client lives. %() expansions are done at

852

415

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

853

416

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

854

checker_initiator_tag: a GLib event source tag, or None

417

checker_initiator_tag: a gobject event source tag, or None

855

418

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

856

419

client_structure: Object describing what attributes a client has

857

420

and is used for storing the client at exit

858

421

current_checker_command: string; current running checker_command

859

disable_initiator_tag: a GLib event source tag, or None

422

disable_initiator_tag: a gobject event source tag, or None

860

423

enabled: bool()

861

424

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

862

uniquely identify an OpenPGP client

863

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

864

a client using raw public keys

425

uniquely identify the client

865

426

host: string; available for use by the checker command

866

427

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

867

428

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

869

430

last_checker_status: integer between 0 and 255 reflecting exit

870

431

status of last checker. -1 reflects crashed

871

432

checker, -2 means no checker completed yet.

872

last_checker_signal: The signal which killed the last checker, if

873

last_checker_status is -1

874

433

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

875

434

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

876

435

D-Bus identifiers

883

442

disabled, or None

884

443

server_settings: The server_settings dict from main()

885

444

"""

886

445

887

446

runtime_expansions = ("approval_delay", "approval_duration",

888

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

447

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

889

448

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

890

449

"last_approval_request", "last_checked_ok",

891

450

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

892

client_defaults = {

893

"timeout": "PT5M",

894

"extended_timeout": "PT15M",

895

"interval": "PT2M",

896

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

897

"host": "",

898

"approval_delay": "PT0S",

899

"approval_duration": "PT1S",

900

"approved_by_default": "True",

901

"enabled": "True",

902

}

903

451

client_defaults = { "timeout": "PT5M",

452

"extended_timeout": "PT15M",

453

"interval": "PT2M",

454

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

455

"host": "",

456

"approval_delay": "PT0S",

457

"approval_duration": "PT1S",

458

"approved_by_default": "True",

459

"enabled": "True",

460

}

461

462

def timeout_milliseconds(self):

463

"Return the 'timeout' attribute in milliseconds"

464

return timedelta_to_milliseconds(self.timeout)

465

466

def extended_timeout_milliseconds(self):

467

"Return the 'extended_timeout' attribute in milliseconds"

468

return timedelta_to_milliseconds(self.extended_timeout)

469

470

def interval_milliseconds(self):

471

"Return the 'interval' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.interval)

473

474

def approval_delay_milliseconds(self):

475

return timedelta_to_milliseconds(self.approval_delay)

476

904

477

@staticmethod

905

478

def config_parser(config):

906

479

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

913

486

for client_name in config.sections():

914

487

section = dict(config.items(client_name))

915

488

client = settings[client_name] = {}

916

489

917

490

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

918

491

# Reformat values from string types to Python types

919

492

client["approved_by_default"] = config.getboolean(

920

493

client_name, "approved_by_default")

921

494

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

922

495

"enabled")

923

924

# Uppercase and remove spaces from key_id and fingerprint

925

# for later comparison purposes with return value from the

926

# key_id() and fingerprint() functions

927

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

928

.replace(" ", ""))

496

929

497

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

930

498

.replace(" ", ""))

931

499

if "secret" in section:

932

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

933

.encode("utf-8"),

934

"base64")

500

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

935

501

elif "secfile" in section:

936

502

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

937

503

(section["secfile"])),

938

504

"rb") as secfile:

939

505

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

940

506

else:

941

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

507

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

942

508

.format(section))

943

509

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

944

510

client["extended_timeout"] = string_to_delta(

952

518

client["last_approval_request"] = None

953

519

client["last_checked_ok"] = None

954

520

client["last_checker_status"] = -2

955

521

956

522

return settings

957

958

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

523

524

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

959

525

self.name = name

960

526

if server_settings is None:

961

527

server_settings = {}

962

528

self.server_settings = server_settings

963

529

# adding all client settings

964

for setting, value in settings.items():

530

for setting, value in settings.iteritems():

965

531

setattr(self, setting, value)

966

532

967

533

if self.enabled:

968

534

if not hasattr(self, "last_enabled"):

969

535

self.last_enabled = datetime.datetime.utcnow()

973

539

else:

974

540

self.last_enabled = None

975

541

self.expires = None

976

542

977

543

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

978

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

544

# Uppercase and remove spaces from fingerprint for later

545

# comparison purposes with return value from the fingerprint()

546

# function

979

547

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

980

548

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

981

549

datetime.datetime.utcnow())

982

550

983

551

# attributes specific for this server instance

984

552

self.checker = None

985

553

self.checker_initiator_tag = None

988

556

self.current_checker_command = None

989

557

self.approved = None

990

558

self.approvals_pending = 0

991

self.changedstate = multiprocessing_manager.Condition(

992

multiprocessing_manager.Lock())

993

self.client_structure = [attr

994

for attr in self.__dict__.keys()

559

self.changedstate = (multiprocessing_manager

560

.Condition(multiprocessing_manager

561

.Lock()))

562

self.client_structure = [attr for attr in

563

self.__dict__.iterkeys()

995

564

if not attr.startswith("_")]

996

565

self.client_structure.append("client_structure")

997

998

for name, t in inspect.getmembers(

999

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

566

567

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

568

lambda obj:

569

isinstance(obj,

570

property)):

1000

571

if not name.startswith("_"):

1001

572

self.client_structure.append(name)

1002

573

1003

574

# Send notice to process children that client state has changed

1004

575

def send_changedstate(self):

1005

576

with self.changedstate:

1006

577

self.changedstate.notify_all()

1007

578

1008

579

def enable(self):

1009

580

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

1010

581

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

1015

586

self.last_enabled = datetime.datetime.utcnow()

1016

587

self.init_checker()

1017

588

self.send_changedstate()

1018

589

1019

590

def disable(self, quiet=True):

1020

591

"""Disable this client."""

1021

592

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

1023

594

if not quiet:

1024

595

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

1025

596

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

1026

GLib.source_remove(self.disable_initiator_tag)

597

gobject.source_remove(self.disable_initiator_tag)

1027

598

self.disable_initiator_tag = None

1028

599

self.expires = None

1029

600

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

1030

GLib.source_remove(self.checker_initiator_tag)

601

gobject.source_remove(self.checker_initiator_tag)

1031

602

self.checker_initiator_tag = None

1032

603

self.stop_checker()

1033

604

self.enabled = False

1034

605

if not quiet:

1035

606

self.send_changedstate()

1036

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

607

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

1037

608

return False

1038

609

1039

610

def __del__(self):

1040

611

self.disable()

1041

612

1042

613

def init_checker(self):

1043

614

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

1044

615

# and every interval from then on.

1045

616

if self.checker_initiator_tag is not None:

1046

GLib.source_remove(self.checker_initiator_tag)

1047

self.checker_initiator_tag = GLib.timeout_add(

1048

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

1049

+ 1)),

1050

self.start_checker)

617

gobject.source_remove(self.checker_initiator_tag)

618

self.checker_initiator_tag = (gobject.timeout_add

619

(self.interval_milliseconds(),

620

self.start_checker))

1051

621

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

1052

622

if self.disable_initiator_tag is not None:

1053

GLib.source_remove(self.disable_initiator_tag)

1054

self.disable_initiator_tag = GLib.timeout_add(

1055

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

623

gobject.source_remove(self.disable_initiator_tag)

624

self.disable_initiator_tag = (gobject.timeout_add

625

(self.timeout_milliseconds(),

626

self.disable))

1056

627

# Also start a new checker *right now*.

1057

628

self.start_checker()

1058

1059

def checker_callback(self, source, condition, connection,

1060

command):

629

630

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

1061

631

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

1062

# Read return code from connection (see call_pipe)

1063

returncode = connection.recv()

1064

connection.close()

1065

if self.checker is not None:

1066

self.checker.join()

1067

632

self.checker_callback_tag = None

1068

633

self.checker = None

1069

1070

if returncode >= 0:

1071

self.last_checker_status = returncode

1072

self.last_checker_signal = None

634

if os.WIFEXITED(condition):

635

self.last_checker_status = os.WEXITSTATUS(condition)

1073

636

if self.last_checker_status == 0:

1074

637

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

1075

638

vars(self))

1076

639

self.checked_ok()

1077

640

else:

1078

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

641

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

642

vars(self))

1079

643

else:

1080

644

self.last_checker_status = -1

1081

self.last_checker_signal = -returncode

1082

645

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

1083

646

vars(self))

1084

return False

1085

647

1086

648

def checked_ok(self):

1087

649

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

1088

650

self.last_checked_ok = datetime.datetime.utcnow()

1089

651

self.last_checker_status = 0

1090

self.last_checker_signal = None

1091

652

self.bump_timeout()

1092

653

1093

654

def bump_timeout(self, timeout=None):

1094

655

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

1095

656

if timeout is None:

1096

657

timeout = self.timeout

1097

658

if self.disable_initiator_tag is not None:

1098

GLib.source_remove(self.disable_initiator_tag)

659

gobject.source_remove(self.disable_initiator_tag)

1099

660

self.disable_initiator_tag = None

1100

661

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

1101

self.disable_initiator_tag = GLib.timeout_add(

1102

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

662

self.disable_initiator_tag = (gobject.timeout_add

663

(timedelta_to_milliseconds

664

(timeout), self.disable))

1103

665

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

1104

666

1105

667

def need_approval(self):

1106

668

self.last_approval_request = datetime.datetime.utcnow()

1107

669

1108

670

def start_checker(self):

1109

671

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

1110

672

1111

673

If a checker already exists, leave it running and do

1112

674

nothing."""

1113

675

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

1118

680

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

1119

681

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

1120

682

# should be.

1121

1122

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

1123

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

1124

self.checker.join()

1125

self.checker = None

683

684

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

685

try:

686

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

687

except (AttributeError, OSError) as error:

688

if (isinstance(error, OSError)

689

and error.errno != errno.ECHILD):

690

raise error

691

else:

692

if pid:

693

logger.warning("Checker was a zombie")

694

gobject.source_remove(self.checker_callback_tag)

695

self.checker_callback(pid, status,

696

self.current_checker_command)

1126

697

# Start a new checker if needed

1127

698

if self.checker is None:

1128

699

# Escape attributes for the shell

1129

escaped_attrs = {

1130

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

1131

for attr in self.runtime_expansions}

700

escaped_attrs = dict(

701

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

702

for attr in

703

self.runtime_expansions)

1132

704

try:

1133

705

command = self.checker_command % escaped_attrs

1134

706

except TypeError as error:

1135

707

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

1136

self.checker_command,

708

self.checker_command, exc_info=error)

709

return True # Try again later

710

self.current_checker_command = command

711

try:

712

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

713

command, self.name)

714

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

715

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

716

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

717

# always replaced by /dev/null.)

718

# The exception is when not debugging but nevertheless

719

# running in the foreground; use the previously

720

# created wnull.

721

popen_args = {}

722

if (not self.server_settings["debug"]

723

and self.server_settings["foreground"]):

724

popen_args.update({"stdout": wnull,

725

"stderr": wnull })

726

self.checker = subprocess.Popen(command,

727

close_fds=True,

728

shell=True, cwd="/",

729

**popen_args)

730

except OSError as error:

731

logger.error("Failed to start subprocess",

1137

732

exc_info=error)

1138

return True # Try again later

1139

self.current_checker_command = command

1140

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

1141

self.name)

1142

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

1143

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

1144

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

1145

# always replaced by /dev/null.)

1146

# The exception is when not debugging but nevertheless

1147

# running in the foreground; use the previously

1148

# created wnull.

1149

popen_args = {"close_fds": True,

1150

"shell": True,

1151

"cwd": "/"}

1152

if (not self.server_settings["debug"]

1153

and self.server_settings["foreground"]):

1154

popen_args.update({"stdout": wnull,

1155

"stderr": wnull})

1156

pipe = multiprocessing.Pipe(duplex=False)

1157

self.checker = multiprocessing.Process(

1158

target=call_pipe,

1159

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

1160

kwargs=popen_args)

1161

self.checker.start()

1162

self.checker_callback_tag = GLib.io_add_watch(

1163

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

1164

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1165

self.checker_callback, pipe[0], command)

1166

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

733

return True

734

self.checker_callback_tag = (gobject.child_watch_add

735

(self.checker.pid,

736

self.checker_callback,

737

data=command))

738

# The checker may have completed before the gobject

739

# watch was added. Check for this.

740

try:

741

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

742

except OSError as error:

743

if error.errno == errno.ECHILD:

744

# This should never happen

745

logger.error("Child process vanished",

746

exc_info=error)

747

return True

748

raise

749

if pid:

750

gobject.source_remove(self.checker_callback_tag)

751

self.checker_callback(pid, status, command)

752

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

1167

753

return True

1168

754

1169

755

def stop_checker(self):

1170

756

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

1171

757

if self.checker_callback_tag:

1172

GLib.source_remove(self.checker_callback_tag)

758

gobject.source_remove(self.checker_callback_tag)

1173

759

self.checker_callback_tag = None

1174

760

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

1175

761

return

1176

762

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

1177

self.checker.terminate()

763

try:

764

self.checker.terminate()

765

#time.sleep(0.5)

766

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

767

# self.checker.kill()

768

except OSError as error:

769

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

770

raise

1178

771

self.checker = None

1179

772

1180

773

1181

def dbus_service_property(dbus_interface,

1182

signature="v",

1183

access="readwrite",

1184

byte_arrays=False):

774

def dbus_service_property(dbus_interface, signature="v",

775

access="readwrite", byte_arrays=False):

1185

776

"""Decorators for marking methods of a DBusObjectWithProperties to

1186

777

become properties on the D-Bus.

1187

778

1188

779

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

1189

780

and with one argument by "Set".

1190

781

1191

782

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

1192

783

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

1193

784

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

1196

787

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

1197

788

if byte_arrays and signature != "ay":

1198

789

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

1199

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

1200

790

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

1201

791

def decorator(func):

1202

792

func._dbus_is_property = True

1203

793

func._dbus_interface = dbus_interface

1206

796

func._dbus_name = func.__name__

1207

797

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

1208

798

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

1209

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

799

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1210

800

return func

1211

1212

801

return decorator

1213

802

1214

803

1215

804

def dbus_interface_annotations(dbus_interface):

1216

805

"""Decorator for marking functions returning interface annotations

1217

806

1218

807

Usage:

1219

808

1220

809

@dbus_interface_annotations("org.example.Interface")

1221

810

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

1222

811

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

1223

812

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

1224

813

"false"}

1225

814

"""

1226

1227

815

def decorator(func):

1228

816

func._dbus_is_interface = True

1229

817

func._dbus_interface = dbus_interface

1230

818

func._dbus_name = dbus_interface

1231

819

return func

1232

1233

820

return decorator

1234

821

1235

822

1236

823

def dbus_annotations(annotations):

1237

824

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

1238

825

Usage:

1239

1240

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

1241

"org.freedesktop.DBus.Property."

1242

"EmitsChangedSignal": "false"})

826

1243

827

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

1244

828

access="r")

829

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

830

"org.freedesktop.DBus.Property."

831

"EmitsChangedSignal": "false"})

1245

832

def Property_dbus_property(self):

1246

833

return dbus.Boolean(False)

1247

1248

See also the DBusObjectWithAnnotations class.

1249

834

"""

1250

1251

835

def decorator(func):

1252

836

func._dbus_annotations = annotations

1253

837

return func

1254

1255

838

return decorator

1256

839

1257

840

1258

841

class DBusPropertyException(dbus.exceptions.DBusException):

1259

842

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

1260

843

"""

1261

pass

844

def __unicode__(self):

845

return unicode(str(self))

1262

846

1263

847

1264

848

class DBusPropertyAccessException(DBusPropertyException):

1273

857

pass

1274

858

1275

859

1276

class DBusObjectWithAnnotations(dbus.service.Object):

1277

"""A D-Bus object with annotations.

1278

1279

Classes inheriting from this can use the dbus_annotations

1280

decorator to add annotations to methods or signals.

860

class DBusObjectWithProperties(dbus.service.Object):

861

"""A D-Bus object with properties.

862

863

Classes inheriting from this can use the dbus_service_property

864

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

865

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

1281

866

"""

1282

867

1283

868

@staticmethod

1284

869

def _is_dbus_thing(thing):

1285

870

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

1286

871

1287

872

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

1288

873

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

1289

874

"""

1290

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

875

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

1291

876

False)

1292

877

1293

878

def _get_all_dbus_things(self, thing):

1294

879

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

1295

880

"""

1296

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

881

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

882

name),

1297

883

athing.__get__(self))

1298

884

for cls in self.__class__.__mro__

1299

885

for name, athing in

1300

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

1301

1302

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1303

out_signature="s",

1304

path_keyword='object_path',

1305

connection_keyword='connection')

1306

def Introspect(self, object_path, connection):

1307

"""Overloading of standard D-Bus method.

1308

1309

Inserts annotation tags on methods and signals.

1310

"""

1311

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

1312

connection)

1313

try:

1314

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

1315

1316

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

1317

# Add annotation tags

1318

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

1319

for tag in if_tag.getElementsByTagName(typ):

1320

annots = dict()

1321

for name, prop in (self.

1322

_get_all_dbus_things(typ)):

1323

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

1324

and prop._dbus_interface

1325

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

1326

annots.update(getattr(

1327

prop, "_dbus_annotations", {}))

1328

for name, value in annots.items():

1329

ann_tag = document.createElement(

1330

"annotation")

1331

ann_tag.setAttribute("name", name)

1332

ann_tag.setAttribute("value", value)

1333

tag.appendChild(ann_tag)

1334

# Add interface annotation tags

1335

for annotation, value in dict(

1336

itertools.chain.from_iterable(

1337

annotations().items()

1338

for name, annotations

1339

in self._get_all_dbus_things("interface")

1340

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

1341

)).items():

1342

ann_tag = document.createElement("annotation")

1343

ann_tag.setAttribute("name", annotation)

1344

ann_tag.setAttribute("value", value)

1345

if_tag.appendChild(ann_tag)

1346

# Fix argument name for the Introspect method itself

1347

if (if_tag.getAttribute("name")

1348

== dbus.INTROSPECTABLE_IFACE):

1349

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

1350

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

1351

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

1352

if (arg.getAttribute("direction")

1353

== "out"):

1354

arg.setAttribute("name",

1355

"xml_data")

1356

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

1357

document.unlink()

1358

except (AttributeError, xml.dom.DOMException,

1359

xml.parsers.expat.ExpatError) as error:

1360

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

1361

exc_info=error)

1362

return xmlstring

1363

1364

1365

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1366

"""A D-Bus object with properties.

1367

1368

Classes inheriting from this can use the dbus_service_property

1369

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

1370

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

1371

"""

1372

886

inspect.getmembers(cls,

887

self._is_dbus_thing(thing)))

888

1373

889

def _get_dbus_property(self, interface_name, property_name):

1374

890

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

1375

891

property with the specified name and interface.

1376

892

"""

1377

for cls in self.__class__.__mro__:

1378

for name, value in inspect.getmembers(

1379

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

893

for cls in self.__class__.__mro__:

894

for name, value in (inspect.getmembers

895

(cls,

896

self._is_dbus_thing("property"))):

1380

897

if (value._dbus_name == property_name

1381

898

and value._dbus_interface == interface_name):

1382

899

return value.__get__(self)

1383

900

1384

901

# No such property

1385

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

1386

self.dbus_object_path, interface_name, property_name))

1387

1388

@classmethod

1389

def _get_all_interface_names(cls):

1390

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

1391

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

1392

"_dbus_interface", None)

1393

for x in (inspect.getmro(cls))

1394

for attr in dir(x))

1395

if name is not None)

1396

1397

@dbus.service.method(dbus.PROPERTIES_IFACE,

1398

in_signature="ss",

902

raise DBusPropertyNotFound(self.dbus_object_path + ":"

903

+ interface_name + "."

904

+ property_name)

905

906

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

1399

907

out_signature="v")

1400

908

def Get(self, interface_name, property_name):

1401

909

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

1407

915

if not hasattr(value, "variant_level"):

1408

916

return value

1409

917

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

1410

918

1411

919

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

1412

920

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

1413

921

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

1419

927

# The byte_arrays option is not supported yet on

1420

928

# signatures other than "ay".

1421

929

if prop._dbus_signature != "ay":

1422

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

1423

"'ay' signature {!r}"

1424

.format(prop._dbus_signature))

1425

value = dbus.ByteArray(bytes(value))

930

raise ValueError

931

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

932

for byte in value))

1426

933

prop(value)

1427

1428

@dbus.service.method(dbus.PROPERTIES_IFACE,

1429

in_signature="s",

934

935

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

1430

936

out_signature="a{sv}")

1431

937

def GetAll(self, interface_name):

1432

938

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

1433

939

standard.

1434

940

1435

941

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

1436

942

"""

1437

943

properties = {}

1447

953

if not hasattr(value, "variant_level"):

1448

954

properties[name] = value

1449

955

continue

1450

properties[name] = type(value)(

1451

value, variant_level=value.variant_level + 1)

956

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

957

value.variant_level+1)

1452

958

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

1453

1454

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

1455

def PropertiesChanged(self, interface_name, changed_properties,

1456

invalidated_properties):

1457

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

1458

standard.

1459

"""

1460

pass

1461

959

1462

960

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1463

961

out_signature="s",

1464

962

path_keyword='object_path',

1465

963

connection_keyword='connection')

1466

964

def Introspect(self, object_path, connection):

1467

965

"""Overloading of standard D-Bus method.

1468

966

1469

967

Inserts property tags and interface annotation tags.

1470

968

"""

1471

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1472

object_path,

1473

connection)

969

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

970

connection)

1474

971

try:

1475

972

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

1476

1477

973

def make_tag(document, name, prop):

1478

974

e = document.createElement("property")

1479

975

e.setAttribute("name", name)

1480

976

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

1481

977

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

1482

978

return e

1483

1484

979

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

1485

980

# Add property tags

1486

981

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

1489

984

if prop._dbus_interface

1490

985

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

1491

986

if_tag.appendChild(tag)

1492

# Add annotation tags for properties

1493

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

1494

annots = dict()

1495

for name, prop in self._get_all_dbus_things(

1496

"property"):

1497

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

1498

and prop._dbus_interface

1499

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

1500

annots.update(getattr(

1501

prop, "_dbus_annotations", {}))

1502

for name, value in annots.items():

1503

ann_tag = document.createElement(

1504

"annotation")

1505

ann_tag.setAttribute("name", name)

1506

ann_tag.setAttribute("value", value)

1507

tag.appendChild(ann_tag)

987

# Add annotation tags

988

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

989

for tag in if_tag.getElementsByTagName(typ):

990

annots = dict()

991

for name, prop in (self.

992

_get_all_dbus_things(typ)):

993

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

994

and prop._dbus_interface

995

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

996

annots.update(getattr

997

(prop,

998

"_dbus_annotations",

999

{}))

1000

for name, value in annots.iteritems():

1001

ann_tag = document.createElement(

1002

"annotation")

1003

ann_tag.setAttribute("name", name)

1004

ann_tag.setAttribute("value", value)

1005

tag.appendChild(ann_tag)

1006

# Add interface annotation tags

1007

for annotation, value in dict(

1008

itertools.chain.from_iterable(

1009

annotations().iteritems()

1010

for name, annotations in

1011

self._get_all_dbus_things("interface")

1012

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

1013

)).iteritems():

1014

ann_tag = document.createElement("annotation")

1015

ann_tag.setAttribute("name", annotation)

1016

ann_tag.setAttribute("value", value)

1017

if_tag.appendChild(ann_tag)

1508

1018

# Add the names to the return values for the

1509

1019

# "org.freedesktop.DBus.Properties" methods

1510

1020

if (if_tag.getAttribute("name")

1529

1039

return xmlstring

1530

1040

1531

1041

1532

try:

1533

dbus.OBJECT_MANAGER_IFACE

1534

except AttributeError:

1535

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

1536

1537

1538

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1539

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

1540

1541

Classes inheriting from this exposes the standard

1542

GetManagedObjects call and the InterfacesAdded and

1543

InterfacesRemoved signals on the standard

1544

"org.freedesktop.DBus.ObjectManager" interface.

1545

1546

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

1547

manually.

1548

"""

1549

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1550

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

1551

def GetManagedObjects(self):

1552

"""This function must be overridden"""

1553

raise NotImplementedError()

1554

1555

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1556

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

1557

def InterfacesAdded(self, object_path, interfaces_and_properties):

1558

pass

1559

1560

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

1561

def InterfacesRemoved(self, object_path, interfaces):

1562

pass

1563

1564

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1565

out_signature="s",

1566

path_keyword='object_path',

1567

connection_keyword='connection')

1568

def Introspect(self, object_path, connection):

1569

"""Overloading of standard D-Bus method.

1570

1571

Override return argument name of GetManagedObjects to be

1572

"objpath_interfaces_and_properties"

1573

"""

1574

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1575

object_path,

1576

connection)

1577

try:

1578

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

1579

1580

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

1581

# Fix argument name for the GetManagedObjects method

1582

if (if_tag.getAttribute("name")

1583

== dbus.OBJECT_MANAGER_IFACE):

1584

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

1585

if (cn.getAttribute("name")

1586

== "GetManagedObjects"):

1587

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

1588

if (arg.getAttribute("direction")

1589

== "out"):

1590

arg.setAttribute(

1591

"name",

1592

"objpath_interfaces"

1593

"_and_properties")

1594

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

1595

document.unlink()

1596

except (AttributeError, xml.dom.DOMException,

1597

xml.parsers.expat.ExpatError) as error:

1598

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

1599

exc_info=error)

1600

return xmlstring

1601

1602

1603

1042

def datetime_to_dbus(dt, variant_level=0):

1604

1043

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

1605

1044

if dt is None:

1606

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

1607

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

1045

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

1046

return dbus.String(dt.isoformat(),

1047

variant_level=variant_level)

1608

1048

1609

1049

1610

1050

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1612

1052

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

1613

1053

interface names according to the "alt_interface_names" mapping.

1614

1054

Usage:

1615

1055

1616

1056

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

1617

1057

"net.example.AlternateInterface"})

1618

1058

class SampleDBusObject(dbus.service.Object):

1619

1059

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

1620

1060

def SampleDBusMethod():

1621

1061

pass

1622

1062

1623

1063

The above "SampleDBusMethod" on "SampleDBusObject" will be

1624

1064

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

1625

1065

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

1626

1066

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

1627

1067

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

1628

1068

1629

1069

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

1630

1070

(from DBusObjectWithProperties) and interfaces (from the

1631

1071

dbus_interface_annotations decorator).

1632

1072

"""

1633

1634

1073

def wrapper(cls):

1635

1074

for orig_interface_name, alt_interface_name in (

1636

alt_interface_names.items()):

1075

alt_interface_names.iteritems()):

1637

1076

attr = {}

1638

1077

interface_names = set()

1639

1078

# Go though all attributes of the class

1641

1080

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

1642

1081

# with the wrong interface name

1643

1082

if (not hasattr(attribute, "_dbus_interface")

1644

or not attribute._dbus_interface.startswith(

1645

orig_interface_name)):

1083

or not attribute._dbus_interface

1084

.startswith(orig_interface_name)):

1646

1085

continue

1647

1086

# Create an alternate D-Bus interface name based on

1648

1087

# the current name

1649

alt_interface = attribute._dbus_interface.replace(

1650

orig_interface_name, alt_interface_name)

1088

alt_interface = (attribute._dbus_interface

1089

.replace(orig_interface_name,

1090

alt_interface_name))

1651

1091

interface_names.add(alt_interface)

1652

1092

# Is this a D-Bus signal?

1653

1093

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

1654

1094

# Extract the original non-method undecorated

1655

1095

# function by black magic

1656

if sys.version_info.major == 2:

1657

nonmethod_func = (dict(

1096

nonmethod_func = (dict(

1658

1097

zip(attribute.func_code.co_freevars,

1659

attribute.__closure__))

1660

["func"].cell_contents)

1661

else:

1662

nonmethod_func = (dict(

1663

zip(attribute.__code__.co_freevars,

1664

attribute.__closure__))

1665

["func"].cell_contents)

1098

attribute.__closure__))["func"]

1099

.cell_contents)

1666

1100

# Create a new, but exactly alike, function

1667

1101

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

1668

1102

# with the alternate D-Bus interface name

1669

new_function = copy_function(nonmethod_func)

1670

new_function = (dbus.service.signal(

1671

alt_interface,

1672

attribute._dbus_signature)(new_function))

1103

new_function = (dbus.service.signal

1104

(alt_interface,

1105

attribute._dbus_signature)

1106

(types.FunctionType(

1107

nonmethod_func.func_code,

1108

nonmethod_func.func_globals,

1109

nonmethod_func.func_name,

1110

nonmethod_func.func_defaults,

1111

nonmethod_func.func_closure)))

1673

1112

# Copy annotations, if any

1674

1113

try:

1675

new_function._dbus_annotations = dict(

1676

attribute._dbus_annotations)

1114

new_function._dbus_annotations = (

1115

dict(attribute._dbus_annotations))

1677

1116

except AttributeError:

1678

1117

pass

1679

1680

1118

# Define a creator of a function to call both the

1681

1119

# original and alternate functions, so both the

1682

1120

# original and alternate signals gets sent when

1685

1123

"""This function is a scope container to pass

1686

1124

func1 and func2 to the "call_both" function

1687

1125

outside of its arguments"""

1688

1689

@functools.wraps(func2)

1690

1126

def call_both(*args, **kwargs):

1691

1127

"""This function will emit two D-Bus

1692

1128

signals by calling func1 and func2"""

1693

1129

func1(*args, **kwargs)

1694

1130

func2(*args, **kwargs)

1695

# Make wrapper function look like a D-Bus

1696

# signal

1697

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

1698

if name.startswith("_dbus_"):

1699

setattr(call_both, name, attr)

1700

1701

1131

return call_both

1702

1132

# Create the "call_both" function and add it to

1703

1133

# the class

1708

1138

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

1709

1139

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

1710

1140

# to the class.

1711

attr[attrname] = (

1712

dbus.service.method(

1713

alt_interface,

1714

attribute._dbus_in_signature,

1715

attribute._dbus_out_signature)

1716

(copy_function(attribute)))

1141

attr[attrname] = (dbus.service.method

1142

(alt_interface,

1143

attribute._dbus_in_signature,

1144

attribute._dbus_out_signature)

1145

(types.FunctionType

1146

(attribute.func_code,

1147

attribute.func_globals,

1148

attribute.func_name,

1149

attribute.func_defaults,

1150

attribute.func_closure)))

1717

1151

# Copy annotations, if any

1718

1152

try:

1719

attr[attrname]._dbus_annotations = dict(

1720

attribute._dbus_annotations)

1153

attr[attrname]._dbus_annotations = (

1154

dict(attribute._dbus_annotations))

1721

1155

except AttributeError:

1722

1156

pass

1723

1157

# Is this a D-Bus property?

1726

1160

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

1727

1161

# property with the alternate D-Bus interface

1728

1162

# name. Add it to the class.

1729

attr[attrname] = (dbus_service_property(

1730

alt_interface, attribute._dbus_signature,

1731

attribute._dbus_access,

1732

attribute._dbus_get_args_options

1733

["byte_arrays"])

1734

(copy_function(attribute)))

1163

attr[attrname] = (dbus_service_property

1164

(alt_interface,

1165

attribute._dbus_signature,

1166

attribute._dbus_access,

1167

attribute

1168

._dbus_get_args_options

1169

["byte_arrays"])

1170

(types.FunctionType

1171

(attribute.func_code,

1172

attribute.func_globals,

1173

attribute.func_name,

1174

attribute.func_defaults,

1175

attribute.func_closure)))

1735

1176

# Copy annotations, if any

1736

1177

try:

1737

attr[attrname]._dbus_annotations = dict(

1738

attribute._dbus_annotations)

1178

attr[attrname]._dbus_annotations = (

1179

dict(attribute._dbus_annotations))

1739

1180

except AttributeError:

1740

1181

pass

1741

1182

# Is this a D-Bus interface?

1744

1185

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

1745

1186

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

1746

1187

# to the class.

1747

attr[attrname] = (

1748

dbus_interface_annotations(alt_interface)

1749

(copy_function(attribute)))

1188

attr[attrname] = (dbus_interface_annotations

1189

(alt_interface)

1190

(types.FunctionType

1191

(attribute.func_code,

1192

attribute.func_globals,

1193

attribute.func_name,

1194

attribute.func_defaults,

1195

attribute.func_closure)))

1750

1196

if deprecate:

1751

1197

# Deprecate all alternate interfaces

1752

iname = "_AlternateDBusNames_interface_annotation{}"

1198

iname="_AlternateDBusNames_interface_annotation{0}"

1753

1199

for interface_name in interface_names:

1754

1755

1200

@dbus_interface_annotations(interface_name)

1756

1201

def func(self):

1757

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

1758

"true"}

1202

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

1203

"true" }

1759

1204

# Find an unused name

1760

1205

for aname in (iname.format(i)

1761

1206

for i in itertools.count()):

1765

1210

if interface_names:

1766

1211

# Replace the class with a new subclass of it with

1767

1212

# methods, signals, etc. as created above.

1768

if sys.version_info.major == 2:

1769

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

1770

(cls, ), attr)

1771

else:

1772

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

1773

(cls, ), attr)

1213

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

1214

(cls,), attr)

1774

1215

return cls

1775

1776

1216

return wrapper

1777

1217

1778

1218

1779

1219

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

1780

"se.bsnet.fukt.Mandos"})

1220

"se.bsnet.fukt.Mandos"})

1781

1221

class ClientDBus(Client, DBusObjectWithProperties):

1782

1222

"""A Client class using D-Bus

1783

1223

1784

1224

Attributes:

1785

1225

dbus_object_path: dbus.ObjectPath

1786

1226

bus: dbus.SystemBus()

1787

1227

"""

1788

1228

1789

1229

runtime_expansions = (Client.runtime_expansions

1790

+ ("dbus_object_path", ))

1791

1792

_interface = "se.recompile.Mandos.Client"

1793

1230

+ ("dbus_object_path",))

1231

1794

1232

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

1795

1796

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

1233

1234

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

1797

1235

self.bus = bus

1798

1236

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

1799

1237

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

1800

1238

# the D-Bus

1801

client_object_name = str(self.name).translate(

1239

client_object_name = unicode(self.name).translate(

1802

1240

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

1803

1241

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

1804

self.dbus_object_path = dbus.ObjectPath(

1805

"/clients/" + client_object_name)

1242

self.dbus_object_path = (dbus.ObjectPath

1243

("/clients/" + client_object_name))

1806

1244

DBusObjectWithProperties.__init__(self, self.bus,

1807

1245

self.dbus_object_path)

1808

1809

def notifychangeproperty(transform_func, dbus_name,

1810

type_func=lambda x: x,

1811

variant_level=1,

1812

invalidate_only=False,

1813

_interface=_interface):

1246

1247

def notifychangeproperty(transform_func,

1248

dbus_name, type_func=lambda x: x,

1249

variant_level=1):

1814

1250

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

1815

1251

its changes to DBus.

1816

1252

1817

1253

transform_fun: Function that takes a value and a variant_level

1818

1254

and transforms it to a D-Bus type.

1819

1255

dbus_name: D-Bus name of the variable

1821

1257

to the D-Bus. Default: no transform

1822

1258

variant_level: D-Bus variant level. Default: 1

1823

1259

"""

1824

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

1825

1260

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

1826

1261

def setter(self, value):

1827

1262

if hasattr(self, "dbus_object_path"):

1828

1263

if (not hasattr(self, attrname) or

1829

1264

type_func(getattr(self, attrname, None))

1830

1265

!= type_func(value)):

1831

if invalidate_only:

1832

self.PropertiesChanged(

1833

_interface, dbus.Dictionary(),

1834

dbus.Array((dbus_name, )))

1835

else:

1836

dbus_value = transform_func(

1837

type_func(value),

1838

variant_level=variant_level)

1839

self.PropertyChanged(dbus.String(dbus_name),

1840

dbus_value)

1841

self.PropertiesChanged(

1842

_interface,

1843

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

1844

dbus_value}),

1845

dbus.Array())

1266

dbus_value = transform_func(type_func(value),

1267

variant_level

1268

=variant_level)

1269

self.PropertyChanged(dbus.String(dbus_name),

1270

dbus_value)

1846

1271

setattr(self, attrname, value)

1847

1272

1848

1273

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

1849

1274

1850

1275

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1851

1276

approvals_pending = notifychangeproperty(dbus.Boolean,

1852

1277

"ApprovalPending",

1853

type_func=bool)

1278

type_func = bool)

1854

1279

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

1855

1280

last_enabled = notifychangeproperty(datetime_to_dbus,

1856

1281

"LastEnabled")

1857

checker = notifychangeproperty(

1858

dbus.Boolean, "CheckerRunning",

1859

type_func=lambda checker: checker is not None)

1282

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

1283

type_func = lambda checker:

1284

checker is not None)

1860

1285

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1861

1286

"LastCheckedOK")

1862

1287

last_checker_status = notifychangeproperty(dbus.Int16,

1865

1290

datetime_to_dbus, "LastApprovalRequest")

1866

1291

approved_by_default = notifychangeproperty(dbus.Boolean,

1867

1292

"ApprovedByDefault")

1868

approval_delay = notifychangeproperty(

1869

dbus.UInt64, "ApprovalDelay",

1870

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

1293

approval_delay = notifychangeproperty(dbus.UInt64,

1294

"ApprovalDelay",

1295

type_func =

1296

timedelta_to_milliseconds)

1871

1297

approval_duration = notifychangeproperty(

1872

1298

dbus.UInt64, "ApprovalDuration",

1873

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

1299

type_func = timedelta_to_milliseconds)

1874

1300

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

1875

timeout = notifychangeproperty(

1876

dbus.UInt64, "Timeout",

1877

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

1301

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

1302

type_func =

1303

timedelta_to_milliseconds)

1878

1304

extended_timeout = notifychangeproperty(

1879

1305

dbus.UInt64, "ExtendedTimeout",

1880

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

1881

interval = notifychangeproperty(

1882

dbus.UInt64, "Interval",

1883

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

1306

type_func = timedelta_to_milliseconds)

1307

interval = notifychangeproperty(dbus.UInt64,

1308

"Interval",

1309

type_func =

1310

timedelta_to_milliseconds)

1884

1311

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

1885

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

1886

invalidate_only=True)

1887

1312

1888

1313

del notifychangeproperty

1889

1314

1890

1315

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

1891

1316

try:

1892

1317

self.remove_from_connection()

1895

1320

if hasattr(DBusObjectWithProperties, "__del__"):

1896

1321

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

1897

1322

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

1898

1899

def checker_callback(self, source, condition,

1900

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

1901

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

1902

connection, command, *args,

1903

**kwargs)

1904

exitstatus = self.last_checker_status

1905

if exitstatus >= 0:

1323

1324

def checker_callback(self, pid, condition, command,

1325

*args, **kwargs):

1326

self.checker_callback_tag = None

1327

self.checker = None

1328

if os.WIFEXITED(condition):

1329

exitstatus = os.WEXITSTATUS(condition)

1906

1330

# Emit D-Bus signal

1907

1331

self.CheckerCompleted(dbus.Int16(exitstatus),

1908

# This is specific to GNU libC

1909

dbus.Int64(exitstatus << 8),

1332

dbus.Int64(condition),

1910

1333

dbus.String(command))

1911

1334

else:

1912

1335

# Emit D-Bus signal

1913

1336

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

1914

dbus.Int64(

1915

# This is specific to GNU libC

1916

(exitstatus << 8)

1917

| self.last_checker_signal),

1337

dbus.Int64(condition),

1918

1338

dbus.String(command))

1919

return ret

1920

1339

1340

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

1341

*args, **kwargs)

1342

1921

1343

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

1922

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

1344

old_checker = self.checker

1345

if self.checker is not None:

1346

old_checker_pid = self.checker.pid

1347

else:

1348

old_checker_pid = None

1923

1349

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

1924

1350

# Only if new checker process was started

1925

1351

if (self.checker is not None

1927

1353

# Emit D-Bus signal

1928

1354

self.CheckerStarted(self.current_checker_command)

1929

1355

return r

1930

1356

1931

1357

def _reset_approved(self):

1932

1358

self.approved = None

1933

1359

return False

1934

1360

1935

1361

def approve(self, value=True):

1936

1362

self.approved = value

1937

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

1938

* 1000), self._reset_approved)

1363

gobject.timeout_add(timedelta_to_milliseconds

1364

(self.approval_duration),

1365

self._reset_approved)

1939

1366

self.send_changedstate()

1940

1941

# D-Bus methods, signals & properties

1942

1943

# Interfaces

1944

1945

# Signals

1946

1367

1368

## D-Bus methods, signals & properties

1369

_interface = "se.recompile.Mandos.Client"

1370

1371

## Interfaces

1372

1373

@dbus_interface_annotations(_interface)

1374

def _foo(self):

1375

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

1376

"false"}

1377

1378

## Signals

1379

1947

1380

# CheckerCompleted - signal

1948

1381

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

1949

1382

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

1950

1383

"D-Bus signal"

1951

1384

pass

1952

1385

1953

1386

# CheckerStarted - signal

1954

1387

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

1955

1388

def CheckerStarted(self, command):

1956

1389

"D-Bus signal"

1957

1390

pass

1958

1391

1959

1392

# PropertyChanged - signal

1960

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

1961

1393

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

1962

1394

def PropertyChanged(self, property, value):

1963

1395

"D-Bus signal"

1964

1396

pass

1965

1397

1966

1398

# GotSecret - signal

1967

1399

@dbus.service.signal(_interface)

1968

1400

def GotSecret(self):

1971

1403

server to mandos-client

1972

1404

"""

1973

1405

pass

1974

1406

1975

1407

# Rejected - signal

1976

1408

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

1977

1409

def Rejected(self, reason):

1978

1410

"D-Bus signal"

1979

1411

pass

1980

1412

1981

1413

# NeedApproval - signal

1982

1414

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

1983

1415

def NeedApproval(self, timeout, default):

1984

1416

"D-Bus signal"

1985

1417

return self.need_approval()

1986

1987

# Methods

1988

1418

1419

## Methods

1420

1989

1421

# Approve - method

1990

1422

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

1991

1423

def Approve(self, value):

1992

1424

self.approve(value)

1993

1425

1994

1426

# CheckedOK - method

1995

1427

@dbus.service.method(_interface)

1996

1428

def CheckedOK(self):

1997

1429

self.checked_ok()

1998

1430

1999

1431

# Enable - method

2000

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

2001

1432

@dbus.service.method(_interface)

2002

1433

def Enable(self):

2003

1434

"D-Bus method"

2004

1435

self.enable()

2005

1436

2006

1437

# StartChecker - method

2007

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

2008

1438

@dbus.service.method(_interface)

2009

1439

def StartChecker(self):

2010

1440

"D-Bus method"

2011

1441

self.start_checker()

2012

1442

2013

1443

# Disable - method

2014

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

2015

1444

@dbus.service.method(_interface)

2016

1445

def Disable(self):

2017

1446

"D-Bus method"

2018

1447

self.disable()

2019

1448

2020

1449

# StopChecker - method

2021

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

2022

1450

@dbus.service.method(_interface)

2023

1451

def StopChecker(self):

2024

1452

self.stop_checker()

2025

2026

# Properties

2027

1453

1454

## Properties

1455

2028

1456

# ApprovalPending - property

2029

1457

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

2030

1458

def ApprovalPending_dbus_property(self):

2031

1459

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

2032

1460

2033

1461

# ApprovedByDefault - property

2034

@dbus_service_property(_interface,

2035

signature="b",

1462

@dbus_service_property(_interface, signature="b",

2036

1463

access="readwrite")

2037

1464

def ApprovedByDefault_dbus_property(self, value=None):

2038

1465

if value is None: # get

2039

1466

return dbus.Boolean(self.approved_by_default)

2040

1467

self.approved_by_default = bool(value)

2041

1468

2042

1469

# ApprovalDelay - property

2043

@dbus_service_property(_interface,

2044

signature="t",

1470

@dbus_service_property(_interface, signature="t",

2045

1471

access="readwrite")

2046

1472

def ApprovalDelay_dbus_property(self, value=None):

2047

1473

if value is None: # get

2048

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

2049

* 1000)

1474

return dbus.UInt64(self.approval_delay_milliseconds())

2050

1475

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

2051

1476

2052

1477

# ApprovalDuration - property

2053

@dbus_service_property(_interface,

2054

signature="t",

1478

@dbus_service_property(_interface, signature="t",

2055

1479

access="readwrite")

2056

1480

def ApprovalDuration_dbus_property(self, value=None):

2057

1481

if value is None: # get

2058

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

2059

* 1000)

1482

return dbus.UInt64(timedelta_to_milliseconds(

1483

self.approval_duration))

2060

1484

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

2061

1485

2062

1486

# Name - property

2063

@dbus_annotations(

2064

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

2065

1487

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

2066

1488

def Name_dbus_property(self):

2067

1489

return dbus.String(self.name)

2068

2069

# KeyID - property

2070

@dbus_annotations(

2071

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

2072

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

2073

def KeyID_dbus_property(self):

2074

return dbus.String(self.key_id)

2075

1490

2076

1491

# Fingerprint - property

2077

@dbus_annotations(

2078

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

2079

1492

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

2080

1493

def Fingerprint_dbus_property(self):

2081

1494

return dbus.String(self.fingerprint)

2082

1495

2083

1496

# Host - property

2084

@dbus_service_property(_interface,

2085

signature="s",

1497

@dbus_service_property(_interface, signature="s",

2086

1498

access="readwrite")

2087

1499

def Host_dbus_property(self, value=None):

2088

1500

if value is None: # get

2089

1501

return dbus.String(self.host)

2090

self.host = str(value)

2091

1502

self.host = unicode(value)

1503

2092

1504

# Created - property

2093

@dbus_annotations(

2094

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

2095

1505

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

2096

1506

def Created_dbus_property(self):

2097

1507

return datetime_to_dbus(self.created)

2098

1508

2099

1509

# LastEnabled - property

2100

1510

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

2101

1511

def LastEnabled_dbus_property(self):

2102

1512

return datetime_to_dbus(self.last_enabled)

2103

1513

2104

1514

# Enabled - property

2105

@dbus_service_property(_interface,

2106

signature="b",

1515

@dbus_service_property(_interface, signature="b",

2107

1516

access="readwrite")

2108

1517

def Enabled_dbus_property(self, value=None):

2109

1518

if value is None: # get

2112

1521

self.enable()

2113

1522

else:

2114

1523

self.disable()

2115

1524

2116

1525

# LastCheckedOK - property

2117

@dbus_service_property(_interface,

2118

signature="s",

1526

@dbus_service_property(_interface, signature="s",

2119

1527

access="readwrite")

2120

1528

def LastCheckedOK_dbus_property(self, value=None):

2121

1529

if value is not None:

2122

1530

self.checked_ok()

2123

1531

return

2124

1532

return datetime_to_dbus(self.last_checked_ok)

2125

1533

2126

1534

# LastCheckerStatus - property

2127

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

1535

@dbus_service_property(_interface, signature="n",

1536

access="read")

2128

1537

def LastCheckerStatus_dbus_property(self):

2129

1538

return dbus.Int16(self.last_checker_status)

2130

1539

2131

1540

# Expires - property

2132

1541

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

2133

1542

def Expires_dbus_property(self):

2134

1543

return datetime_to_dbus(self.expires)

2135

1544

2136

1545

# LastApprovalRequest - property

2137

1546

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

2138

1547

def LastApprovalRequest_dbus_property(self):

2139

1548

return datetime_to_dbus(self.last_approval_request)

2140

1549

2141

1550

# Timeout - property

2142

@dbus_service_property(_interface,

2143

signature="t",

1551

@dbus_service_property(_interface, signature="t",

2144

1552

access="readwrite")

2145

1553

def Timeout_dbus_property(self, value=None):

2146

1554

if value is None: # get

2147

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

1555

return dbus.UInt64(self.timeout_milliseconds())

2148

1556

old_timeout = self.timeout

2149

1557

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

2150

1558

# Reschedule disabling

2158

1566

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

2159

1567

is None):

2160

1568

return

2161

GLib.source_remove(self.disable_initiator_tag)

2162

self.disable_initiator_tag = GLib.timeout_add(

2163

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

2164

self.disable)

2165

1569

gobject.source_remove(self.disable_initiator_tag)

1570

self.disable_initiator_tag = (

1571

gobject.timeout_add(

1572

timedelta_to_milliseconds(self.expires - now),

1573

self.disable))

1574

2166

1575

# ExtendedTimeout - property

2167

@dbus_service_property(_interface,

2168

signature="t",

1576

@dbus_service_property(_interface, signature="t",

2169

1577

access="readwrite")

2170

1578

def ExtendedTimeout_dbus_property(self, value=None):

2171

1579

if value is None: # get

2172

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

2173

* 1000)

1580

return dbus.UInt64(self.extended_timeout_milliseconds())

2174

1581

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

2175

1582

2176

1583

# Interval - property

2177

@dbus_service_property(_interface,

2178

signature="t",

1584

@dbus_service_property(_interface, signature="t",

2179

1585

access="readwrite")

2180

1586

def Interval_dbus_property(self, value=None):

2181

1587

if value is None: # get

2182

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

1588

return dbus.UInt64(self.interval_milliseconds())

2183

1589

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

2184

1590

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

2185

1591

return

2186

1592

if self.enabled:

2187

1593

# Reschedule checker run

2188

GLib.source_remove(self.checker_initiator_tag)

2189

self.checker_initiator_tag = GLib.timeout_add(

2190

value, self.start_checker)

2191

self.start_checker() # Start one now, too

2192

1594

gobject.source_remove(self.checker_initiator_tag)

1595

self.checker_initiator_tag = (gobject.timeout_add

1596

(value, self.start_checker))

1597

self.start_checker() # Start one now, too

1598

2193

1599

# Checker - property

2194

@dbus_service_property(_interface,

2195

signature="s",

1600

@dbus_service_property(_interface, signature="s",

2196

1601

access="readwrite")

2197

1602

def Checker_dbus_property(self, value=None):

2198

1603

if value is None: # get

2199

1604

return dbus.String(self.checker_command)

2200

self.checker_command = str(value)

2201

1605

self.checker_command = unicode(value)

1606

2202

1607

# CheckerRunning - property

2203

@dbus_service_property(_interface,

2204

signature="b",

1608

@dbus_service_property(_interface, signature="b",

2205

1609

access="readwrite")

2206

1610

def CheckerRunning_dbus_property(self, value=None):

2207

1611

if value is None: # get

2210

1614

self.start_checker()

2211

1615

else:

2212

1616

self.stop_checker()

2213

1617

2214

1618

# ObjectPath - property

2215

@dbus_annotations(

2216

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

2217

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

2218

1619

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

2219

1620

def ObjectPath_dbus_property(self):

2220

return self.dbus_object_path # is already a dbus.ObjectPath

2221

1621

return self.dbus_object_path # is already a dbus.ObjectPath

1622

2222

1623

# Secret = property

2223

@dbus_annotations(

2224

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

2225

"invalidates"})

2226

@dbus_service_property(_interface,

2227

signature="ay",

2228

access="write",

2229

byte_arrays=True)

1624

@dbus_service_property(_interface, signature="ay",

1625

access="write", byte_arrays=True)

2230

1626

def Secret_dbus_property(self, value):

2231

self.secret = bytes(value)

2232

1627

self.secret = str(value)

1628

2233

1629

del _interface

2234

1630

2235

1631

2236

class ProxyClient:

2237

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

1632

class ProxyClient(object):

1633

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

2238

1634

self._pipe = child_pipe

2239

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

1635

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

2240

1636

if not self._pipe.recv():

2241

raise KeyError(key_id or fpr)

2242

1637

raise KeyError()

1638

2243

1639

def __getattribute__(self, name):

2244

1640

if name == '_pipe':

2245

1641

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

2248

1644

if data[0] == 'data':

2249

1645

return data[1]

2250

1646

if data[0] == 'function':

2251

2252

1647

def func(*args, **kwargs):

2253

1648

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

2254

1649

return self._pipe.recv()[1]

2255

2256

1650

return func

2257

1651

2258

1652

def __setattr__(self, name, value):

2259

1653

if name == '_pipe':

2260

1654

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

2263

1657

2264

1658

class ClientHandler(socketserver.BaseRequestHandler, object):

2265

1659

"""A class to handle client connections.

2266

1660

2267

1661

Instantiated once for each connection to handle it.

2268

1662

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

2269

1663

2270

1664

def handle(self):

2271

1665

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

2272

1666

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

2273

str(self.client_address))

1667

unicode(self.client_address))

2274

1668

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

2275

1669

self.server.child_pipe.fileno())

2276

2277

session = gnutls.ClientSession(self.request)

2278

2279

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

2280

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

2281

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

2282

# "+DHE-DSS"))

1670

1671

session = (gnutls.connection

1672

.ClientSession(self.request,

1673

gnutls.connection

1674

.X509Credentials()))

1675

1676

# Note: gnutls.connection.X509Credentials is really a

1677

# generic GnuTLS certificate credentials object so long as

1678

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

1679

# here despite using OpenPGP certificates.

1680

1681

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

1682

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

1683

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

1684

# "+DHE-DSS"))

2283

1685

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

2284

1686

priority = self.server.gnutls_priority

2285

1687

if priority is None:

2286

1688

priority = "NORMAL"

2287

gnutls.priority_set_direct(session._c_object,

2288

priority.encode("utf-8"),

2289

None)

2290

1689

(gnutls.library.functions

1690

.gnutls_priority_set_direct(session._c_object,

1691

priority, None))

1692

2291

1693

# Start communication using the Mandos protocol

2292

1694

# Get protocol number

2293

1695

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

2294

1696

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

2295

1697

try:

2296

1698

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

2297

raise RuntimeError(line)

1699

raise RuntimeError

2298

1700

except (ValueError, IndexError, RuntimeError) as error:

2299

1701

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

2300

1702

return

2301

1703

2302

1704

# Start GnuTLS connection

2303

1705

try:

2304

1706

session.handshake()

2305

except gnutls.Error as error:

1707

except gnutls.errors.GNUTLSError as error:

2306

1708

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

2307

1709

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

2308

1710

# established. Just abandon the request.

2309

1711

return

2310

1712

logger.debug("Handshake succeeded")

2311

1713

2312

1714

approval_required = False

2313

1715

try:

2314

if gnutls.has_rawpk:

2315

fpr = b""

2316

try:

2317

key_id = self.key_id(

2318

self.peer_certificate(session))

2319

except (TypeError, gnutls.Error) as error:

2320

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

2321

return

2322

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

2323

2324

else:

2325

key_id = b""

2326

try:

2327

fpr = self.fingerprint(

2328

self.peer_certificate(session))

2329

except (TypeError, gnutls.Error) as error:

2330

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

2331

return

2332

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

2333

2334

try:

2335

client = ProxyClient(child_pipe, key_id, fpr,

1716

try:

1717

fpr = self.fingerprint(self.peer_certificate

1718

(session))

1719

except (TypeError,

1720

gnutls.errors.GNUTLSError) as error:

1721

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

1722

return

1723

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

1724

1725

try:

1726

client = ProxyClient(child_pipe, fpr,

2336

1727

self.client_address)

2337

1728

except KeyError:

2338

1729

return

2339

1730

2340

1731

if client.approval_delay:

2341

1732

delay = client.approval_delay

2342

1733

client.approvals_pending += 1

2343

1734

approval_required = True

2344

1735

2345

1736

while True:

2346

1737

if not client.enabled:

2347

1738

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

2348

client.name)

1739

client.name)

2349

1740

if self.server.use_dbus:

2350

1741

# Emit D-Bus signal

2351

1742

client.Rejected("Disabled")

2352

1743

return

2353

1744

2354

1745

if client.approved or not client.approval_delay:

2355

# We are approved or approval is disabled

1746

#We are approved or approval is disabled

2356

1747

break

2357

1748

elif client.approved is None:

2358

1749

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

2360

1751

if self.server.use_dbus:

2361

1752

# Emit D-Bus signal

2362

1753

client.NeedApproval(

2363

client.approval_delay.total_seconds()

2364

* 1000, client.approved_by_default)

1754

client.approval_delay_milliseconds(),

1755

client.approved_by_default)

2365

1756

else:

2366

1757

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

2367

1758

client.name)

2369

1760

# Emit D-Bus signal

2370

1761

client.Rejected("Denied")

2371

1762

return

2372

2373

# wait until timeout or approved

1763

1764

#wait until timeout or approved

2374

1765

time = datetime.datetime.now()

2375

1766

client.changedstate.acquire()

2376

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

1767

client.changedstate.wait(

1768

float(timedelta_to_milliseconds(delay)

1769

/ 1000))

2377

1770

client.changedstate.release()

2378

1771

time2 = datetime.datetime.now()

2379

1772

if (time2 - time) >= delay:

2389

1782

break

2390

1783

else:

2391

1784

delay -= time2 - time

2392

2393

try:

2394

session.send(client.secret)

2395

except gnutls.Error as error:

2396

logger.warning("gnutls send failed",

2397

exc_info=error)

2398

return

2399

1785

1786

sent_size = 0

1787

while sent_size < len(client.secret):

1788

try:

1789

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

1790

except gnutls.errors.GNUTLSError as error:

1791

logger.warning("gnutls send failed",

1792

exc_info=error)

1793

return

1794

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

1795

sent, len(client.secret)

1796

- (sent_size + sent))

1797

sent_size += sent

1798

2400

1799

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

2401

1800

# bump the timeout using extended_timeout

2402

1801

client.bump_timeout(client.extended_timeout)

2403

1802

if self.server.use_dbus:

2404

1803

# Emit D-Bus signal

2405

1804

client.GotSecret()

2406

1805

2407

1806

finally:

2408

1807

if approval_required:

2409

1808

client.approvals_pending -= 1

2410

1809

try:

2411

1810

session.bye()

2412

except gnutls.Error as error:

1811

except gnutls.errors.GNUTLSError as error:

2413

1812

logger.warning("GnuTLS bye failed",

2414

1813

exc_info=error)

2415

1814

2416

1815

@staticmethod

2417

1816

def peer_certificate(session):

2418

"Return the peer's certificate as a bytestring"

2419

try:

2420

cert_type = gnutls.certificate_type_get2(session._c_object,

2421

gnutls.CTYPE_PEERS)

2422

except AttributeError:

2423

cert_type = gnutls.certificate_type_get(session._c_object)

2424

if gnutls.has_rawpk:

2425

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2426

else:

2427

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2428

# If not a valid certificate type...

2429

if cert_type not in valid_cert_types:

2430

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

2431

valid_cert_types)

2432

# ...return invalid data

2433

return b""

1817

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

1818

# If not an OpenPGP certificate...

1819

if (gnutls.library.functions

1820

.gnutls_certificate_type_get(session._c_object)

1821

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1822

# ...do the normal thing

1823

return session.peer_certificate

2434

1824

list_size = ctypes.c_uint(1)

2435

cert_list = (gnutls.certificate_get_peers

1825

cert_list = (gnutls.library.functions

1826

.gnutls_certificate_get_peers

2436

1827

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

2437

1828

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

2438

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

1829

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

1830

" certificate")

2439

1831

if list_size.value == 0:

2440

1832

return None

2441

1833

cert = cert_list[0]

2442

1834

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

2443

2444

@staticmethod

2445

def key_id(certificate):

2446

"Convert a certificate bytestring to a hexdigit key ID"

2447

# New GnuTLS "datum" with the public key

2448

datum = gnutls.datum_t(

2449

ctypes.cast(ctypes.c_char_p(certificate),

2450

ctypes.POINTER(ctypes.c_ubyte)),

2451

ctypes.c_uint(len(certificate)))

2452

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

2453

# New empty GnuTLS certificate

2454

pubkey = gnutls.pubkey_t()

2455

gnutls.pubkey_init(ctypes.byref(pubkey))

2456

# Import the raw public key into the certificate

2457

gnutls.pubkey_import(pubkey,

2458

ctypes.byref(datum),

2459

gnutls.X509_FMT_DER)

2460

# New buffer for the key ID

2461

buf = ctypes.create_string_buffer(32)

2462

buf_len = ctypes.c_size_t(len(buf))

2463

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

2464

gnutls.pubkey_get_key_id(pubkey,

2465

gnutls.KEYID_USE_SHA256,

2466

ctypes.cast(ctypes.byref(buf),

2467

ctypes.POINTER(ctypes.c_ubyte)),

2468

ctypes.byref(buf_len))

2469

# Deinit the certificate

2470

gnutls.pubkey_deinit(pubkey)

2471

2472

# Convert the buffer to a Python bytestring

2473

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

2474

# Convert the bytestring to hexadecimal notation

2475

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

2476

return hex_key_id

2477

1835

2478

1836

@staticmethod

2479

1837

def fingerprint(openpgp):

2480

1838

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2481

1839

# New GnuTLS "datum" with the OpenPGP public key

2482

datum = gnutls.datum_t(

2483

ctypes.cast(ctypes.c_char_p(openpgp),

2484

ctypes.POINTER(ctypes.c_ubyte)),

2485

ctypes.c_uint(len(openpgp)))

1840

datum = (gnutls.library.types

1841

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

1842

ctypes.POINTER

1843

(ctypes.c_ubyte)),

1844

ctypes.c_uint(len(openpgp))))

2486

1845

# New empty GnuTLS certificate

2487

crt = gnutls.openpgp_crt_t()

2488

gnutls.openpgp_crt_init(ctypes.byref(crt))

1846

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1847

(gnutls.library.functions

1848

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2489

1849

# Import the OpenPGP public key into the certificate

2490

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

2491

gnutls.OPENPGP_FMT_RAW)

1850

(gnutls.library.functions

1851

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

1852

gnutls.library.constants

1853

.GNUTLS_OPENPGP_FMT_RAW))

2492

1854

# Verify the self signature in the key

2493

1855

crtverify = ctypes.c_uint()

2494

gnutls.openpgp_crt_verify_self(crt, 0,

2495

ctypes.byref(crtverify))

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_verify_self(crt, 0,

1858

ctypes.byref(crtverify)))

2496

1859

if crtverify.value != 0:

2497

gnutls.openpgp_crt_deinit(crt)

2498

raise gnutls.CertificateSecurityError(code

2499

=crtverify.value)

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1861

raise (gnutls.errors.CertificateSecurityError

1862

("Verify failed"))

2500

1863

# New buffer for the fingerprint

2501

1864

buf = ctypes.create_string_buffer(20)

2502

1865

buf_len = ctypes.c_size_t()

2503

1866

# Get the fingerprint from the certificate into the buffer

2504

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

2505

ctypes.byref(buf_len))

1867

(gnutls.library.functions

1868

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

1869

ctypes.byref(buf_len)))

2506

1870

# Deinit the certificate

2507

gnutls.openpgp_crt_deinit(crt)

1871

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2508

1872

# Convert the buffer to a Python bytestring

2509

1873

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

2510

1874

# Convert the bytestring to hexadecimal notation

2512

1876

return hex_fpr

2513

1877

2514

1878

2515

class MultiprocessingMixIn:

1879

class MultiprocessingMixIn(object):

2516

1880

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

2517

2518

1881

def sub_process_main(self, request, address):

2519

1882

try:

2520

1883

self.finish_request(request, address)

2521

1884

except Exception:

2522

1885

self.handle_error(request, address)

2523

1886

self.close_request(request)

2524

1887

2525

1888

def process_request(self, request, address):

2526

1889

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

2527

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

2528

args=(request, address))

1890

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

1891

args = (request, address))

2529

1892

proc.start()

2530

1893

return proc

2531

1894

2532

1895

2533

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1896

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2534

1897

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

2535

2536

1898

def process_request(self, request, client_address):

2537

1899

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

2538

1900

2539

1901

This function creates a new pipe in self.pipe

2540

1902

"""

2541

1903

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2542

1904

2543

1905

proc = MultiprocessingMixIn.process_request(self, request,

2544

1906

client_address)

2545

1907

self.child_pipe.close()

2546

1908

self.add_pipe(parent_pipe, proc)

2547

1909

2548

1910

def add_pipe(self, parent_pipe, proc):

2549

1911

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

2550

raise NotImplementedError()

1912

raise NotImplementedError

2551

1913

2552

1914

2553

1915

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2554

socketserver.TCPServer):

1916

socketserver.TCPServer, object):

2555

1917

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

2556

1918

2557

1919

Attributes:

2558

1920

enabled: Boolean; whether this server is activated yet

2559

1921

interface: None or a network interface name (string)

2560

1922

use_ipv6: Boolean; to use IPv6 or not

2561

1923

"""

2562

2563

1924

def __init__(self, server_address, RequestHandlerClass,

2564

interface=None,

2565

use_ipv6=True,

2566

socketfd=None):

1925

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

2567

1926

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

2568

1927

creating a new one with socket.socket().

2569

1928

"""

2575

1934

self.socketfd = socketfd

2576

1935

# Save the original socket.socket() function

2577

1936

self.socket_socket = socket.socket

2578

2579

1937

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

2580

#

1938

#

2581

1939

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

2582

1940

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

2583

1941

# patching socket.socket.)

2584

#

1942

#

2585

1943

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

2586

1944

@functools.wraps(socket.socket)

2587

1945

def socket_wrapper(*args, **kwargs):

2599

1957

# socket_wrapper(), if socketfd was set.

2600

1958

socketserver.TCPServer.__init__(self, server_address,

2601

1959

RequestHandlerClass)

2602

1960

2603

1961

def server_bind(self):

2604

1962

"""This overrides the normal server_bind() function

2605

1963

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

2606

1964

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

2607

global SO_BINDTODEVICE

2608

1965

if self.interface is not None:

2609

1966

if SO_BINDTODEVICE is None:

2610

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

2611

# common enough.

2612

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

2613

SO_BINDTODEVICE = 25

2614

try:

2615

self.socket.setsockopt(

2616

socket.SOL_SOCKET, SO_BINDTODEVICE,

2617

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

2618

except socket.error as error:

2619

if error.errno == errno.EPERM:

2620

logger.error("No permission to bind to"

2621

" interface %s", self.interface)

2622

elif error.errno == errno.ENOPROTOOPT:

2623

logger.error("SO_BINDTODEVICE not available;"

2624

" cannot bind to interface %s",

2625

self.interface)

2626

elif error.errno == errno.ENODEV:

2627

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

2628

" cannot bind", self.interface)

2629

else:

2630

raise

1967

logger.error("SO_BINDTODEVICE does not exist;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

else:

1971

try:

1972

self.socket.setsockopt(socket.SOL_SOCKET,

1973

SO_BINDTODEVICE,

1974

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

1975

except socket.error as error:

1976

if error.errno == errno.EPERM:

1977

logger.error("No permission to bind to"

1978

" interface %s", self.interface)

1979

elif error.errno == errno.ENOPROTOOPT:

1980

logger.error("SO_BINDTODEVICE not available;"

1981

" cannot bind to interface %s",

1982

self.interface)

1983

elif error.errno == errno.ENODEV:

1984

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

1985

" cannot bind", self.interface)

1986

else:

1987

raise

2631

1988

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

2632

1989

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

2633

if self.server_address[1]:

2634

self.allow_reuse_address = True

2635

1990

if not self.server_address[0]:

2636

1991

if self.address_family == socket.AF_INET6:

2637

any_address = "::" # in6addr_any

1992

any_address = "::" # in6addr_any

2638

1993

else:

2639

any_address = "0.0.0.0" # INADDR_ANY

1994

any_address = "0.0.0.0" # INADDR_ANY

2640

1995

self.server_address = (any_address,

2641

1996

self.server_address[1])

2642

1997

elif not self.server_address[1]:

2643

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

1998

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

1999

0)

2644

2000

# if self.interface:

2645

2001

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

2646

2002

# 0, # port

2652

2008

2653

2009

class MandosServer(IPv6_TCPServer):

2654

2010

"""Mandos server.

2655

2011

2656

2012

Attributes:

2657

2013

clients: set of Client objects

2658

2014

gnutls_priority GnuTLS priority string

2659

2015

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

2660

2661

Assumes a GLib.MainLoop event loop.

2016

2017

Assumes a gobject.MainLoop event loop.

2662

2018

"""

2663

2664

2019

def __init__(self, server_address, RequestHandlerClass,

2665

interface=None,

2666

use_ipv6=True,

2667

clients=None,

2668

gnutls_priority=None,

2669

use_dbus=True,

2670

socketfd=None):

2020

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

2021

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

2671

2022

self.enabled = False

2672

2023

self.clients = clients

2673

2024

if self.clients is None:

2676

2027

self.gnutls_priority = gnutls_priority

2677

2028

IPv6_TCPServer.__init__(self, server_address,

2678

2029

RequestHandlerClass,

2679

interface=interface,

2680

use_ipv6=use_ipv6,

2681

socketfd=socketfd)

2682

2030

interface = interface,

2031

use_ipv6 = use_ipv6,

2032

socketfd = socketfd)

2683

2033

def server_activate(self):

2684

2034

if self.enabled:

2685

2035

return socketserver.TCPServer.server_activate(self)

2686

2036

2687

2037

def enable(self):

2688

2038

self.enabled = True

2689

2039

2690

2040

def add_pipe(self, parent_pipe, proc):

2691

2041

# Call "handle_ipc" for both data and EOF events

2692

GLib.io_add_watch(

2693

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

2694

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

2695

functools.partial(self.handle_ipc,

2696

parent_pipe=parent_pipe,

2697

proc=proc))

2698

2699

def handle_ipc(self, source, condition,

2700

parent_pipe=None,

2701

proc=None,

2702

client_object=None):

2042

gobject.io_add_watch(parent_pipe.fileno(),

2043

gobject.IO_IN | gobject.IO_HUP,

2044

functools.partial(self.handle_ipc,

2045

parent_pipe =

2046

parent_pipe,

2047

proc = proc))

2048

2049

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

2050

proc = None, client_object=None):

2703

2051

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

2704

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

2052

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

2705

2053

# Wait for other process to exit

2706

2054

proc.join()

2707

2055

return False

2708

2056

2709

2057

# Read a request from the child

2710

2058

request = parent_pipe.recv()

2711

2059

command = request[0]

2712

2060

2713

2061

if command == 'init':

2714

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

2715

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

2716

address = request[3]

2717

2718

for c in self.clients.values():

2719

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2720

continue

2721

if key_id and c.key_id == key_id:

2722

client = c

2723

break

2724

if fpr and c.fingerprint == fpr:

2062

fpr = request[1]

2063

address = request[2]

2064

2065

for c in self.clients.itervalues():

2066

if c.fingerprint == fpr:

2725

2067

client = c

2726

2068

break

2727

2069

else:

2728

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

2729

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

2070

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

2071

"dress: %s", fpr, address)

2730

2072

if self.use_dbus:

2731

2073

# Emit D-Bus signal

2732

mandos_dbus_service.ClientNotFound(key_id or fpr,

2074

mandos_dbus_service.ClientNotFound(fpr,

2733

2075

address[0])

2734

2076

parent_pipe.send(False)

2735

2077

return False

2736

2737

GLib.io_add_watch(

2738

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

2739

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

2740

functools.partial(self.handle_ipc,

2741

parent_pipe=parent_pipe,

2742

proc=proc,

2743

client_object=client))

2078

2079

gobject.io_add_watch(parent_pipe.fileno(),

2080

gobject.IO_IN | gobject.IO_HUP,

2081

functools.partial(self.handle_ipc,

2082

parent_pipe =

2083

parent_pipe,

2084

proc = proc,

2085

client_object =

2086

client))

2744

2087

parent_pipe.send(True)

2745

2088

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

2746

2089

# same fileno

2749

2092

funcname = request[1]

2750

2093

args = request[2]

2751

2094

kwargs = request[3]

2752

2095

2753

2096

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

2754

2097

funcname)(*args,

2755

**kwargs)))

2756

2098

**kwargs)))

2099

2757

2100

if command == 'getattr':

2758

2101

attrname = request[1]

2759

if isinstance(client_object.__getattribute__(attrname),

2760

collections.abc.Callable):

2761

parent_pipe.send(('function', ))

2102

if callable(client_object.__getattribute__(attrname)):

2103

parent_pipe.send(('function',))

2762

2104

else:

2763

parent_pipe.send((

2764

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

2765

2105

parent_pipe.send(('data', client_object

2106

.__getattribute__(attrname)))

2107

2766

2108

if command == 'setattr':

2767

2109

attrname = request[1]

2768

2110

value = request[2]

2769

2111

setattr(client_object, attrname, value)

2770

2112

2771

2113

return True

2772

2114

2773

2115

2774

2116

def rfc3339_duration_to_delta(duration):

2775

2117

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

2776

2777

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

2778

True

2779

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

2780

True

2781

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

2782

True

2783

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

2784

True

2785

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

2786

True

2787

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

2788

True

2789

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

2790

True

2118

2119

>>> rfc3339_duration_to_delta("P7D")

2120

datetime.timedelta(7)

2121

>>> rfc3339_duration_to_delta("PT60S")

2122

datetime.timedelta(0, 60)

2123

>>> rfc3339_duration_to_delta("PT60M")

2124

datetime.timedelta(0, 3600)

2125

>>> rfc3339_duration_to_delta("PT24H")

2126

datetime.timedelta(1)

2127

>>> rfc3339_duration_to_delta("P1W")

2128

datetime.timedelta(7)

2129

>>> rfc3339_duration_to_delta("PT5M30S")

2130

datetime.timedelta(0, 330)

2131

>>> rfc3339_duration_to_delta("P1DT3M20S")

2132

datetime.timedelta(1, 200)

2791

2133

"""

2792

2134

2793

2135

# Parsing an RFC 3339 duration with regular expressions is not

2794

2136

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

2795

2137

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

2796

2138

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

2797

2139

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

2798

2140

# avoid excessive use of external libraries.

2799

2141

2800

2142

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

2801

Token = collections.namedtuple("Token", (

2802

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

2803

# a "group" containing digits

2804

"value", # datetime.timedelta or None

2805

"followers")) # Tokens valid after this token

2143

Token = collections.namedtuple("Token",

2144

("regexp", # To match token; if

2145

# "value" is not None,

2146

# must have a "group"

2147

# containing digits

2148

"value", # datetime.timedelta or

2149

# None

2150

"followers")) # Tokens valid after

2151

# this token

2806

2152

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

2807

2153

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

2808

2154

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

2809

2155

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

2810

2156

datetime.timedelta(seconds=1),

2811

frozenset((token_end, )))

2157

frozenset((token_end,)))

2812

2158

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

2813

2159

datetime.timedelta(minutes=1),

2814

2160

frozenset((token_second, token_end)))

2830

2176

frozenset((token_month, token_end)))

2831

2177

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

2832

2178

datetime.timedelta(weeks=1),

2833

frozenset((token_end, )))

2179

frozenset((token_end,)))

2834

2180

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

2835

2181

frozenset((token_year, token_month,

2836

2182

token_day, token_time,

2837

token_week)))

2838

# Define starting values:

2839

# Value so far

2840

value = datetime.timedelta()

2183

token_week))),

2184

# Define starting values

2185

value = datetime.timedelta() # Value so far

2841

2186

found_token = None

2842

# Following valid tokens

2843

followers = frozenset((token_duration, ))

2844

# String left to parse

2845

s = duration

2187

followers = frozenset(token_duration,) # Following valid tokens

2188

s = duration # String left to parse

2846

2189

# Loop until end token is found

2847

2190

while found_token is not token_end:

2848

2191

# Search for any currently valid tokens

2864

2207

break

2865

2208

else:

2866

2209

# No currently valid tokens were found

2867

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

2868

.format(duration))

2210

raise ValueError("Invalid RFC 3339 duration")

2869

2211

# End token found

2870

2212

return value

2871

2213

2872

2214

2873

2215

def string_to_delta(interval):

2874

2216

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

2875

2876

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

2877

True

2878

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

2879

True

2880

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

2881

True

2882

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

2883

True

2884

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

2885

True

2886

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

2887

True

2217

2218

>>> string_to_delta('7d')

2219

datetime.timedelta(7)

2220

>>> string_to_delta('60s')

2221

datetime.timedelta(0, 60)

2222

>>> string_to_delta('60m')

2223

datetime.timedelta(0, 3600)

2224

>>> string_to_delta('24h')

2225

datetime.timedelta(1)

2226

>>> string_to_delta('1w')

2227

datetime.timedelta(7)

2228

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

2229

datetime.timedelta(0, 330)

2888

2230

"""

2889

2231

2890

2232

try:

2891

2233

return rfc3339_duration_to_delta(interval)

2892

2234

except ValueError:

2893

2235

pass

2894

2236

2895

2237

timevalue = datetime.timedelta(0)

2896

2238

for s in interval.split():

2897

2239

try:

2898

suffix = s[-1]

2240

suffix = unicode(s[-1])

2899

2241

value = int(s[:-1])

2900

2242

if suffix == "d":

2901

2243

delta = datetime.timedelta(value)

2908

2250

elif suffix == "w":

2909

2251

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

2910

2252

else:

2911

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

2912

except IndexError as e:

2253

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

2254

.format(suffix))

2255

except (ValueError, IndexError) as e:

2913

2256

raise ValueError(*(e.args))

2914

2257

timevalue += delta

2915

2258

return timevalue

2916

2259

2917

2260

2918

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

2261

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

2919

2262

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

2920

2263

2921

2264

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

2922

2265

if os.fork():

2923

2266

sys.exit()

2931

2274

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

2932

2275

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

2933

2276

raise OSError(errno.ENODEV,

2934

"{} not a character device"

2277

"{0} not a character device"

2935

2278

.format(os.devnull))

2936

2279

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

2937

2280

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

2941

2284

2942

2285

2943

2286

def main():

2944

2287

2945

2288

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

2946

2289

# Parsing of options, both command line and config file

2947

2290

2948

2291

parser = argparse.ArgumentParser()

2949

2292

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

2950

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

2293

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

2951

2294

help="show version number and exit")

2952

2295

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

2953

2296

help="Bind to interface IF")

2986

2329

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

2987

2330

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

2988

2331

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

2989

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

2990

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

2991

default=None)

2992

2332

2993

2333

options = parser.parse_args()

2994

2334

2335

if options.check:

2336

import doctest

2337

doctest.testmod()

2338

sys.exit()

2339

2995

2340

# Default values for config file for server-global settings

2996

if gnutls.has_rawpk:

2997

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

2998

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

2999

else:

3000

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

3001

":+SIGN-DSA-SHA256")

3002

server_defaults = {"interface": "",

3003

"address": "",

3004

"port": "",

3005

"debug": "False",

3006

"priority": priority,

3007

"servicename": "Mandos",

3008

"use_dbus": "True",

3009

"use_ipv6": "True",

3010

"debuglevel": "",

3011

"restore": "True",

3012

"socket": "",

3013

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

3014

"foreground": "False",

3015

"zeroconf": "True",

3016

}

3017

del priority

3018

2341

server_defaults = { "interface": "",

2342

"address": "",

2343

"port": "",

2344

"debug": "False",

2345

"priority":

2346

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

2347

"servicename": "Mandos",

2348

"use_dbus": "True",

2349

"use_ipv6": "True",

2350

"debuglevel": "",

2351

"restore": "True",

2352

"socket": "",

2353

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

2354

"foreground": "False",

2355

}

2356

3019

2357

# Parse config file for server-global settings

3020

server_config = configparser.ConfigParser(server_defaults)

2358

server_config = configparser.SafeConfigParser(server_defaults)

3021

2359

del server_defaults

3022

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

3023

# Convert the ConfigParser object to a dict

2360

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

2361

"mandos.conf"))

2362

# Convert the SafeConfigParser object to a dict

3024

2363

server_settings = server_config.defaults()

3025

2364

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

3026

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

3027

"foreground", "zeroconf"):

2365

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

3028

2366

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

3029

2367

option)

3030

2368

if server_settings["port"]:

3040

2378

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

3041

2379

["socket"])

3042

2380

del server_config

3043

2381

3044

2382

# Override the settings from the config file with command line

3045

2383

# options, if set.

3046

2384

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

3047

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

3048

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

3049

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

2385

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

2386

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

2387

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

3050

2388

value = getattr(options, option)

3051

2389

if value is not None:

3052

2390

server_settings[option] = value

3053

2391

del options

3054

2392

# Force all strings to be unicode

3055

2393

for option in server_settings.keys():

3056

if isinstance(server_settings[option], bytes):

3057

server_settings[option] = (server_settings[option]

3058

.decode("utf-8"))

2394

if type(server_settings[option]) is str:

2395

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

3059

2396

# Force all boolean options to be boolean

3060

2397

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

3061

"foreground", "zeroconf"):

2398

"foreground"):

3062

2399

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

3063

2400

# Debug implies foreground

3064

2401

if server_settings["debug"]:

3065

2402

server_settings["foreground"] = True

3066

2403

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

3067

2404

3068

2405

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

3069

3070

if (not server_settings["zeroconf"]

3071

and not (server_settings["port"]

3072

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

3073

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

3074

2406

3075

2407

# For convenience

3076

2408

debug = server_settings["debug"]

3077

2409

debuglevel = server_settings["debuglevel"]

3080

2412

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

3081

2413

stored_state_file)

3082

2414

foreground = server_settings["foreground"]

3083

zeroconf = server_settings["zeroconf"]

3084

2415

3085

2416

if debug:

3086

2417

initlogger(debug, logging.DEBUG)

3087

2418

else:

3090

2421

else:

3091

2422

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

3092

2423

initlogger(debug, level)

3093

2424

3094

2425

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

3095

syslogger.setFormatter(

3096

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

3097

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

3098

server_settings["servicename"])))

3099

2426

syslogger.setFormatter(logging.Formatter

2427

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

2428

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

2429

.format(server_settings

2430

["servicename"])))

2431

3100

2432

# Parse config file with clients

3101

client_config = configparser.ConfigParser(Client.client_defaults)

2433

client_config = configparser.SafeConfigParser(Client

2434

.client_defaults)

3102

2435

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

3103

2436

"clients.conf"))

3104

2437

3105

2438

global mandos_dbus_service

3106

2439

mandos_dbus_service = None

3107

3108

socketfd = None

3109

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

3110

socketfd = server_settings["socket"]

3111

tcp_server = MandosServer(

3112

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

3113

ClientHandler,

3114

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

3115

use_ipv6=use_ipv6,

3116

gnutls_priority=server_settings["priority"],

3117

use_dbus=use_dbus,

3118

socketfd=socketfd)

2440

2441

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

2442

server_settings["port"]),

2443

ClientHandler,

2444

interface=(server_settings["interface"]

2445

or None),

2446

use_ipv6=use_ipv6,

2447

gnutls_priority=

2448

server_settings["priority"],

2449

use_dbus=use_dbus,

2450

socketfd=(server_settings["socket"]

2451

or None))

3119

2452

if not foreground:

3120

pidfilename = "/run/mandos.pid"

3121

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

3122

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

2453

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

3123

2454

pidfile = None

3124

2455

try:

3125

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

2456

pidfile = open(pidfilename, "w")

3126

2457

except IOError as e:

3127

2458

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

3128

2459

exc_info=e)

3129

3130

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

3131

("mandos", "mandos"),

3132

("nobody", "nogroup")):

2460

2461

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

3133

2462

try:

3134

2463

uid = pwd.getpwnam(name).pw_uid

3135

gid = pwd.getpwnam(group).pw_gid

2464

gid = pwd.getpwnam(name).pw_gid

3136

2465

break

3137

2466

except KeyError:

3138

2467

continue

3142

2471

try:

3143

2472

os.setgid(gid)

3144

2473

os.setuid(uid)

3145

if debug:

3146

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

3147

gid))

3148

2474

except OSError as error:

3149

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

3150

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

3151

2475

if error.errno != errno.EPERM:

3152

raise

3153

2476

raise error

2477

3154

2478

if debug:

3155

2479

# Enable all possible GnuTLS debugging

3156

2480

3157

2481

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

3158

2482

# - GnuTLS manual

3159

gnutls.global_set_log_level(11)

3160

3161

@gnutls.log_func

2483

gnutls.library.functions.gnutls_global_set_log_level(11)

2484

2485

@gnutls.library.types.gnutls_log_func

3162

2486

def debug_gnutls(level, string):

3163

2487

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

3164

3165

gnutls.global_set_log_function(debug_gnutls)

3166

2488

2489

(gnutls.library.functions

2490

.gnutls_global_set_log_function(debug_gnutls))

2491

3167

2492

# Redirect stdin so all checkers get /dev/null

3168

2493

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

3169

2494

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

3170

2495

if null > 2:

3171

2496

os.close(null)

3172

2497

3173

2498

# Need to fork before connecting to D-Bus

3174

2499

if not foreground:

3175

2500

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

3176

2501

daemon()

3177

3178

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

3179

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

3180

# need to inform GLib that threads will be used.

3181

GLib.threads_init()

3182

2502

2503

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

2504

# need to inform gobject that threads will be used.

2505

gobject.threads_init()

2506

3183

2507

global main_loop

3184

2508

# From the Avahi example code

3185

2509

DBusGMainLoop(set_as_default=True)

3186

main_loop = GLib.MainLoop()

2510

main_loop = gobject.MainLoop()

3187

2511

bus = dbus.SystemBus()

3188

2512

# End of Avahi example code

3189

2513

if use_dbus:

3190

2514

try:

3191

2515

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

3192

bus,

3193

do_not_queue=True)

3194

old_bus_name = dbus.service.BusName(

3195

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

3196

do_not_queue=True)

3197

except dbus.exceptions.DBusException as e:

2516

bus, do_not_queue=True)

2517

old_bus_name = (dbus.service.BusName

2518

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

2519

do_not_queue=True))

2520

except dbus.exceptions.NameExistsException as e:

3198

2521

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

3199

2522

use_dbus = False

3200

2523

server_settings["use_dbus"] = False

3201

2524

tcp_server.use_dbus = False

3202

if zeroconf:

3203

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3204

service = AvahiServiceToSyslog(

3205

name=server_settings["servicename"],

3206

servicetype="_mandos._tcp",

3207

protocol=protocol,

3208

bus=bus)

3209

if server_settings["interface"]:

3210

service.interface = if_nametoindex(

3211

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

3212

2525

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2526

service = AvahiServiceToSyslog(name =

2527

server_settings["servicename"],

2528

servicetype = "_mandos._tcp",

2529

protocol = protocol, bus = bus)

2530

if server_settings["interface"]:

2531

service.interface = (if_nametoindex

2532

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

2533

3213

2534

global multiprocessing_manager

3214

2535

multiprocessing_manager = multiprocessing.Manager()

3215

2536

3216

2537

client_class = Client

3217

2538

if use_dbus:

3218

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

3219

2539

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

2540

3220

2541

client_settings = Client.config_parser(client_config)

3221

2542

old_client_settings = {}

3222

2543

clients_data = {}

3223

2544

3224

2545

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

3225

2546

global wnull

3226

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

2547

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

3227

2548

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

3228

2549

# mode

3229

2550

if debug or not foreground:

3230

2551

wnull.close()

3231

2552

3232

2553

# Get client data and settings from last running state.

3233

2554

if server_settings["restore"]:

3234

2555

try:

3235

2556

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

3236

if sys.version_info.major == 2:

3237

clients_data, old_client_settings = pickle.load(

3238

stored_state)

3239

else:

3240

bytes_clients_data, bytes_old_client_settings = (

3241

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

3242

# Fix bytes to strings

3243

# clients_data

3244

# .keys()

3245

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

3246

if isinstance(key, bytes)

3247

else key): value

3248

for key, value in

3249

bytes_clients_data.items()}

3250

del bytes_clients_data

3251

for key in clients_data:

3252

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

3253

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

3254

for k, v in

3255

clients_data[key].items()}

3256

clients_data[key] = value

3257

# .client_structure

3258

value["client_structure"] = [

3259

(s.decode("utf-8")

3260

if isinstance(s, bytes)

3261

else s) for s in

3262

value["client_structure"]]

3263

# .name, .host, and .checker_command

3264

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

3265

if isinstance(value[k], bytes):

3266

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

3267

if "key_id" not in value:

3268

value["key_id"] = ""

3269

elif "fingerprint" not in value:

3270

value["fingerprint"] = ""

3271

# old_client_settings

3272

# .keys()

3273

old_client_settings = {

3274

(key.decode("utf-8")

3275

if isinstance(key, bytes)

3276

else key): value

3277

for key, value in

3278

bytes_old_client_settings.items()}

3279

del bytes_old_client_settings

3280

# .host and .checker_command

3281

for value in old_client_settings.values():

3282

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

3283

if isinstance(value[attribute], bytes):

3284

value[attribute] = (value[attribute]

3285

.decode("utf-8"))

2557

clients_data, old_client_settings = (pickle.load

2558

(stored_state))

3286

2559

os.remove(stored_state_path)

3287

2560

except IOError as e:

3288

2561

if e.errno == errno.ENOENT:

3289

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

3290

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

2562

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

2563

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

3291

2564

else:

3292

2565

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

3293

2566

exc_info=e)

3294

2567

raise

3295

2568

except EOFError as e:

3296

2569

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

3297

"EOFError:",

3298

exc_info=e)

3299

2570

"EOFError:", exc_info=e)

2571

3300

2572

with PGPEngine() as pgp:

3301

for client_name, client in clients_data.items():

2573

for client_name, client in clients_data.iteritems():

3302

2574

# Skip removed clients

3303

2575

if client_name not in client_settings:

3304

2576

continue

3305

2577

3306

2578

# Decide which value to use after restoring saved state.

3307

2579

# We have three different values: Old config file,

3308

2580

# new config file, and saved state.

3313

2585

# For each value in new config, check if it

3314

2586

# differs from the old config value (Except for

3315

2587

# the "secret" attribute)

3316

if (name != "secret"

3317

and (value !=

3318

old_client_settings[client_name][name])):

2588

if (name != "secret" and

2589

value != old_client_settings[client_name]

2590

[name]):

3319

2591

client[name] = value

3320

2592

except KeyError:

3321

2593

pass

3322

2594

3323

2595

# Clients who has passed its expire date can still be

3324

# enabled if its last checker was successful. A Client

2596

# enabled if its last checker was successful. Clients

3325

2597

# whose checker succeeded before we stored its state is

3326

2598

# assumed to have successfully run all checkers during

3327

2599

# downtime.

3329

2601

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

3330

2602

if not client["last_checked_ok"]:

3331

2603

logger.warning(

3332

"disabling client {} - Client never "

3333

"performed a successful checker".format(

3334

client_name))

2604

"disabling client {0} - Client never "

2605

"performed a successful checker"

2606

.format(client_name))

3335

2607

client["enabled"] = False

3336

2608

elif client["last_checker_status"] != 0:

3337

2609

logger.warning(

3338

"disabling client {} - Client last"

3339

" checker failed with error code"

3340

" {}".format(

3341

client_name,

3342

client["last_checker_status"]))

2610

"disabling client {0} - Client "

2611

"last checker failed with error code {1}"

2612

.format(client_name,

2613

client["last_checker_status"]))

3343

2614

client["enabled"] = False

3344

2615

else:

3345

client["expires"] = (

3346

datetime.datetime.utcnow()

3347

+ client["timeout"])

2616

client["expires"] = (datetime.datetime

2617

.utcnow()

2618

+ client["timeout"])

3348

2619

logger.debug("Last checker succeeded,"

3349

" keeping {} enabled".format(

3350

client_name))

2620

" keeping {0} enabled"

2621

.format(client_name))

3351

2622

try:

3352

client["secret"] = pgp.decrypt(

3353

client["encrypted_secret"],

3354

client_settings[client_name]["secret"])

2623

client["secret"] = (

2624

pgp.decrypt(client["encrypted_secret"],

2625

client_settings[client_name]

2626

["secret"]))

3355

2627

except PGPError:

3356

2628

# If decryption fails, we use secret from new settings

3357

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

3358

client_name))

3359

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

3360

["secret"])

3361

2629

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

2630

.format(client_name))

2631

client["secret"] = (

2632

client_settings[client_name]["secret"])

2633

3362

2634

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

3363

2635

for client_name in (set(old_client_settings)

3364

2636

- set(client_settings)):

3366

2638

for client_name in (set(client_settings)

3367

2639

- set(old_client_settings)):

3368

2640

clients_data[client_name] = client_settings[client_name]

3369

2641

3370

2642

# Create all client objects

3371

for client_name, client in clients_data.items():

2643

for client_name, client in clients_data.iteritems():

3372

2644

tcp_server.clients[client_name] = client_class(

3373

name=client_name,

3374

settings=client,

3375

server_settings=server_settings)

3376

2645

name = client_name, settings = client,

2646

server_settings = server_settings)

2647

3377

2648

if not tcp_server.clients:

3378

2649

logger.warning("No clients defined")

3379

2650

3380

2651

if not foreground:

3381

2652

if pidfile is not None:

3382

pid = os.getpid()

3383

2653

try:

3384

2654

with pidfile:

3385

print(pid, file=pidfile)

2655

pid = os.getpid()

2656

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

3386

2657

except IOError:

3387

2658

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

3388

2659

pidfilename, pid)

3389

2660

del pidfile

3390

2661

del pidfilename

3391

3392

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

3393

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3394

lambda: main_loop.quit() and False)

3395

2662

2663

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

2664

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

2665

3396

2666

if use_dbus:

3397

3398

@alternate_dbus_interfaces(

3399

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

3400

class MandosDBusService(DBusObjectWithObjectManager):

2667

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

2668

"se.bsnet.fukt.Mandos"})

2669

class MandosDBusService(DBusObjectWithProperties):

3401

2670

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

3402

3403

2671

def __init__(self):

3404

2672

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

3405

3406

2673

_interface = "se.recompile.Mandos"

3407

2674

2675

@dbus_interface_annotations(_interface)

2676

def _foo(self):

2677

return { "org.freedesktop.DBus.Property"

2678

".EmitsChangedSignal":

2679

"false"}

2680

3408

2681

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

3409

2682

def ClientAdded(self, objpath):

3410

2683

"D-Bus signal"

3411

2684

pass

3412

2685

3413

2686

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

3414

def ClientNotFound(self, key_id, address):

2687

def ClientNotFound(self, fingerprint, address):

3415

2688

"D-Bus signal"

3416

2689

pass

3417

3418

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

3419

"true"})

2690

3420

2691

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

3421

2692

def ClientRemoved(self, objpath, name):

3422

2693

"D-Bus signal"

3423

2694

pass

3424

3425

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

3426

"true"})

2695

3427

2696

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

3428

2697

def GetAllClients(self):

3429

2698

"D-Bus method"

3430

return dbus.Array(c.dbus_object_path for c in

3431

tcp_server.clients.values())

3432

3433

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

3434

"true"})

2699

return dbus.Array(c.dbus_object_path

2700

for c in

2701

tcp_server.clients.itervalues())

2702

3435

2703

@dbus.service.method(_interface,

3436

2704

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

3437

2705

def GetAllClientsWithProperties(self):

3438

2706

"D-Bus method"

3439

2707

return dbus.Dictionary(

3440

{c.dbus_object_path: c.GetAll(

3441

"se.recompile.Mandos.Client")

3442

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

2708

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

2709

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

3443

2710

signature="oa{sv}")

3444

2711

3445

2712

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

3446

2713

def RemoveClient(self, object_path):

3447

2714

"D-Bus method"

3448

for c in tcp_server.clients.values():

2715

for c in tcp_server.clients.itervalues():

3449

2716

if c.dbus_object_path == object_path:

3450

2717

del tcp_server.clients[c.name]

3451

2718

c.remove_from_connection()

3452

# Don't signal the disabling

2719

# Don't signal anything except ClientRemoved

3453

2720

c.disable(quiet=True)

3454

# Emit D-Bus signal for removal

3455

self.client_removed_signal(c)

2721

# Emit D-Bus signal

2722

self.ClientRemoved(object_path, c.name)

3456

2723

return

3457

2724

raise KeyError(object_path)

3458

2725

3459

2726

del _interface

3460

3461

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3462

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

3463

def GetManagedObjects(self):

3464

"""D-Bus method"""

3465

return dbus.Dictionary(

3466

{client.dbus_object_path:

3467

dbus.Dictionary(

3468

{interface: client.GetAll(interface)

3469

for interface in

3470

client._get_all_interface_names()})

3471

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

3472

3473

def client_added_signal(self, client):

3474

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

3475

if use_dbus:

3476

# New standard signal

3477

self.InterfacesAdded(

3478

client.dbus_object_path,

3479

dbus.Dictionary(

3480

{interface: client.GetAll(interface)

3481

for interface in

3482

client._get_all_interface_names()}))

3483

# Old signal

3484

self.ClientAdded(client.dbus_object_path)

3485

3486

def client_removed_signal(self, client):

3487

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

3488

if use_dbus:

3489

# New standard signal

3490

self.InterfacesRemoved(

3491

client.dbus_object_path,

3492

client._get_all_interface_names())

3493

# Old signal

3494

self.ClientRemoved(client.dbus_object_path,

3495

client.name)

3496

2727

3497

2728

mandos_dbus_service = MandosDBusService()

3498

3499

# Save modules to variables to exempt the modules from being

3500

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

3501

mp = multiprocessing

3502

wn = wnull

3503

2729

3504

2730

def cleanup():

3505

2731

"Cleanup function; run on exit"

3506

if zeroconf:

3507

service.cleanup()

3508

3509

mp.active_children()

3510

wn.close()

2732

service.cleanup()

2733

2734

multiprocessing.active_children()

2735

wnull.close()

3511

2736

if not (tcp_server.clients or client_settings):

3512

2737

return

3513

2738

3514

2739

# Store client before exiting. Secrets are encrypted with key

3515

2740

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

3516

2741

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

3517

2742

clients = {}

3518

2743

with PGPEngine() as pgp:

3519

for client in tcp_server.clients.values():

2744

for client in tcp_server.clients.itervalues():

3520

2745

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

3521

2746

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

3522

2747

key)

3523

2748

client_dict = {}

3524

2749

3525

2750

# A list of attributes that can not be pickled

3526

2751

# + secret.

3527

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

3528

"checker", "server_settings"}

3529

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

3530

.Object):

2752

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

2753

"checker", "server_settings"))

2754

for name, typ in (inspect.getmembers

2755

(dbus.service.Object)):

3531

2756

exclude.add(name)

3532

2757

3533

2758

client_dict["encrypted_secret"] = (client

3534

2759

.encrypted_secret)

3535

2760

for attr in client.client_structure:

3536

2761

if attr not in exclude:

3537

2762

client_dict[attr] = getattr(client, attr)

3538

2763

3539

2764

clients[client.name] = client_dict

3540

2765

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

3541

2766

3542

2767

try:

3543

with tempfile.NamedTemporaryFile(

3544

mode='wb',

3545

suffix=".pickle",

3546

prefix='clients-',

3547

dir=os.path.dirname(stored_state_path),

3548

delete=False) as stored_state:

3549

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

3550

protocol=2)

3551

tempname = stored_state.name

2768

with (tempfile.NamedTemporaryFile

2769

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

2770

dir=os.path.dirname(stored_state_path),

2771

delete=False)) as stored_state:

2772

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

2773

tempname=stored_state.name

3552

2774

os.rename(tempname, stored_state_path)

3553

2775

except (IOError, OSError) as e:

3554

2776

if not debug:

3557

2779

except NameError:

3558

2780

pass

3559

2781

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

3560

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

2782

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

3561

2783

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

3562

2784

else:

3563

2785

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

3564

2786

exc_info=e)

3565

raise

3566

2787

raise e

2788

3567

2789

# Delete all clients, and settings from config

3568

2790

while tcp_server.clients:

3569

2791

name, client = tcp_server.clients.popitem()

3570

2792

if use_dbus:

3571

2793

client.remove_from_connection()

3572

# Don't signal the disabling

2794

# Don't signal anything except ClientRemoved

3573

2795

client.disable(quiet=True)

3574

# Emit D-Bus signal for removal

3575

2796

if use_dbus:

3576

mandos_dbus_service.client_removed_signal(client)

2797

# Emit D-Bus signal

2798

mandos_dbus_service.ClientRemoved(client

2799

.dbus_object_path,

2800

client.name)

3577

2801

client_settings.clear()

3578

2802

3579

2803

atexit.register(cleanup)

3580

3581

for client in tcp_server.clients.values():

2804

2805

for client in tcp_server.clients.itervalues():

3582

2806

if use_dbus:

3583

# Emit D-Bus signal for adding

3584

mandos_dbus_service.client_added_signal(client)

2807

# Emit D-Bus signal

2808

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3585

2809

# Need to initiate checking of clients

3586

2810

if client.enabled:

3587

2811

client.init_checker()

3588

2812

3589

2813

tcp_server.enable()

3590

2814

tcp_server.server_activate()

3591

2815

3592

2816

# Find out what port we got

3593

if zeroconf:

3594

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

2817

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

3595

2818

if use_ipv6:

3596

2819

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

3597

2820

" flowinfo %d, scope_id %d",

3599

2822

else: # IPv4

3600

2823

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

3601

2824

*tcp_server.socket.getsockname())

3602

3603

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

3604

2825

2826

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

2827

3605

2828

try:

3606

if zeroconf:

3607

# From the Avahi example code

3608

try:

3609

service.activate()

3610

except dbus.exceptions.DBusException as error:

3611

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

3612

cleanup()

3613

sys.exit(1)

3614

# End of Avahi example code

3615

3616

GLib.io_add_watch(

3617

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

3618

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3619

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

3620

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

3621

2829

# From the Avahi example code

2830

try:

2831

service.activate()

2832

except dbus.exceptions.DBusException as error:

2833

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

2834

cleanup()

2835

sys.exit(1)

2836

# End of Avahi example code

2837

2838

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

2839

lambda *args, **kwargs:

2840

(tcp_server.handle_request

2841

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

2842

3622

2843

logger.debug("Starting main loop")

3623

2844

main_loop.run()

3624

2845

except AvahiError as error:

3633

2854

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

3634

2855

cleanup()

3635

2856

3636

3637

def should_only_run_tests():

3638

parser = argparse.ArgumentParser(add_help=False)

3639

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

3640

args, unknown_args = parser.parse_known_args()

3641

run_tests = args.check

3642

if run_tests:

3643

# Remove --check argument from sys.argv

3644

sys.argv[1:] = unknown_args

3645

return run_tests

3646

3647

# Add all tests from doctest strings

3648

def load_tests(loader, tests, none):

3649

import doctest

3650

tests.addTests(doctest.DocTestSuite())

3651

return tests

3652

3653

2857

if __name__ == '__main__':

3654

try:

3655

if should_only_run_tests():

3656

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

3657

unittest.main()

3658

else:

3659

main()

3660

finally:

3661

logging.shutdown()

2858

main()