/mandos/trunk : revision 237.4.53

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/python2.7

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

import shlex

83

72

84

73

import dbus

85

74

import dbus.service

86

import gi

87

from gi.repository import GLib

75

import gobject

76

import avahi

88

77

from dbus.mainloop.glib import DBusGMainLoop

89

78

import ctypes

90

79

import ctypes.util

91

80

import xml.dom.minidom

92

81

import inspect

93

82

94

if sys.version_info.major == 2:

95

__metaclass__ = type

96

str = unicode

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

83

try:

122

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

85

except AttributeError:

124

86

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

87

from IN import SO_BINDTODEVICE

128

88

except ImportError:

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.14"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.8"

147

92

stored_state_file = "clients.pickle"

148

93

149

94

logger = logging.getLogger()

150

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

151

95

syslogger = None

152

96

153

97

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

156

101

except (OSError, AttributeError):

157

158

102

def if_nametoindex(interface):

159

103

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

160

104

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

161

105

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

162

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

163

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

164

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

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

165

111

return interface_index

166

112

167

113

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

184

114

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

185

115

"""init logger and add loglevel"""

186

116

187

117

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

191

122

syslogger.setFormatter(logging.Formatter

192

123

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

193

124

' %(message)s'))

194

125

logger.addHandler(syslogger)

195

126

196

127

if debug:

197

128

console = logging.StreamHandler()

198

129

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

208

139

pass

209

140

210

141

211

class PGPEngine:

142

class PGPEngine(object):

212

143

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

213

214

144

def __init__(self):

215

145

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

146

self.gnupgargs = ['--batch',

228

'--homedir', self.tempdir,

147

'--home', self.tempdir,

229

148

'--force-mdc',

230

'--quiet']

231

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

232

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

233

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

234

149

'--quiet',

150

'--no-use-agent']

151

235

152

def __enter__(self):

236

153

return self

237

154

238

155

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

239

156

self._cleanup()

240

157

return False

241

158

242

159

def __del__(self):

243

160

self._cleanup()

244

161

245

162

def _cleanup(self):

246

163

if self.tempdir is not None:

247

164

# Delete contents of tempdir

248

165

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

249

topdown=False):

166

topdown = False):

250

167

for filename in files:

251

168

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

252

169

for dirname in dirs:

254

171

# Remove tempdir

255

172

os.rmdir(self.tempdir)

256

173

self.tempdir = None

257

174

258

175

def password_encode(self, password):

259

176

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

260

177

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

265

182

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

266

183

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

267

184

return encoded

268

185

269

186

def encrypt(self, data, password):

270

187

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

273

190

passfile.write(passphrase)

274

191

passfile.flush()

275

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

192

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

276

193

'--passphrase-file',

277

194

passfile.name]

278

195

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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

283

200

if proc.returncode != 0:

284

201

raise PGPError(err)

285

202

return ciphertext

286

203

287

204

def decrypt(self, data, password):

288

205

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

291

208

passfile.write(passphrase)

292

209

passfile.flush()

293

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

210

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

294

211

'--passphrase-file',

295

212

passfile.name]

296

213

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

301

219

if proc.returncode != 0:

302

220

raise PGPError(err)

303

221

return decrypted_plaintext

304

222

305

223

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

332

224

class AvahiError(Exception):

333

225

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

334

226

self.value = value

335

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

336

**kwargs)

337

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

338

230

339

231

class AvahiServiceError(AvahiError):

340

232

pass

341

233

342

343

234

class AvahiGroupError(AvahiError):

344

235

pass

345

236

346

237

347

class AvahiService:

238

class AvahiService(object):

348

239

"""An Avahi (Zeroconf) service.

349

240

350

241

Attributes:

351

242

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

352

243

Used to optionally bind to the specified interface.

364

255

server: D-Bus Server

365

256

bus: dbus.SystemBus()

366

257

"""

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

379

263

self.interface = interface

380

264

self.name = name

381

265

self.type = servicetype

390

274

self.server = None

391

275

self.bus = bus

392

276

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

277

278

def rename(self):

395

279

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

396

280

if self.rename_count >= self.max_renames:

397

281

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

398

282

" after %i retries, exiting.",

399

283

self.rename_count)

400

284

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

404

287

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

405

288

self.name)

406

if remove:

407

self.remove()

289

self.remove()

408

290

try:

409

291

self.add()

410

292

except dbus.exceptions.DBusException as error:

411

if (error.get_dbus_name()

412

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

413

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

414

return self.rename(remove=False)

415

else:

416

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

417

self.cleanup()

418

os._exit(1)

419

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

420

298

def remove(self):

421

299

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

422

300

if self.entry_group_state_changed_match is not None:

424

302

self.entry_group_state_changed_match = None

425

303

if self.group is not None:

426

304

self.group.Reset()

427

305

428

306

def add(self):

429

307

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

430

308

self.remove()

447

325

dbus.UInt16(self.port),

448

326

avahi.string_array_to_txt_array(self.TXT))

449

327

self.group.Commit()

450

328

451

329

def entry_group_state_changed(self, state, error):

452

330

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

453

331

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

454

332

455

333

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

334

logger.debug("Zeroconf service established.")

457

335

elif state == avahi.ENTRY_GROUP_COLLISION:

459

337

self.rename()

460

338

elif state == avahi.ENTRY_GROUP_FAILURE:

461

339

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

462

str(error))

463

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

464

340

unicode(error))

341

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

342

.format(error))

343

465

344

def cleanup(self):

466

345

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

467

346

if self.group is not None:

472

351

pass

473

352

self.group = None

474

353

self.remove()

475

354

476

355

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

477

356

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

478

357

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

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"Zeroconf server failure" }

485

365

if state in bad_states:

486

366

if bad_states[state] is not None:

487

367

if error is None:

490

370

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

491

371

self.cleanup()

492

372

elif state == avahi.SERVER_RUNNING:

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

logger.info("Local Zeroconf service name"

499

" collision.")

500

return self.rename(remove=False)

501

else:

502

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

503

self.cleanup()

504

os._exit(1)

373

self.add()

505

374

else:

506

375

if error is None:

507

376

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

508

377

else:

509

378

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

510

379

511

380

def activate(self):

512

381

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

513

382

if self.server is None:

517

386

follow_name_owner_changes=True),

518

387

avahi.DBUS_INTERFACE_SERVER)

519

388

self.server.connect_to_signal("StateChanged",

520

self.server_state_changed)

389

self.server_state_changed)

521

390

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

522

391

523

392

524

393

class AvahiServiceToSyslog(AvahiService):

525

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

394

def rename(self):

526

395

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

527

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

528

**kwargs)

529

syslogger.setFormatter(logging.Formatter(

530

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

531

.format(self.name)))

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

.format(self.name)))

532

401

return ret

533

402

534

403

535

# Pretend that we have a GnuTLS module

536

class gnutls:

537

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

538

539

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

540

if library is None:

541

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

542

_library = ctypes.cdll.LoadLibrary(library)

543

del library

544

545

# Unless otherwise indicated, the constants and types below are

546

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

547

548

# Constants

549

E_SUCCESS = 0

550

E_INTERRUPTED = -52

551

E_AGAIN = -28

552

CRT_OPENPGP = 2

553

CRT_RAWPK = 3

554

CLIENT = 2

555

SHUT_RDWR = 0

556

CRD_CERTIFICATE = 1

557

E_NO_CERTIFICATE_FOUND = -49

558

X509_FMT_DER = 0

559

NO_TICKETS = 1<<10

560

ENABLE_RAWPK = 1<<18

561

CTYPE_PEERS = 3

562

KEYID_USE_SHA256 = 1 # gnutls/x509.h

563

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

564

565

# Types

566

class _session_int(ctypes.Structure):

567

_fields_ = []

568

session_t = ctypes.POINTER(_session_int)

569

570

class certificate_credentials_st(ctypes.Structure):

571

_fields_ = []

572

certificate_credentials_t = ctypes.POINTER(

573

certificate_credentials_st)

574

certificate_type_t = ctypes.c_int

575

576

class datum_t(ctypes.Structure):

577

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

578

('size', ctypes.c_uint)]

579

580

class _openpgp_crt_int(ctypes.Structure):

581

_fields_ = []

582

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

583

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

584

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

585

credentials_type_t = ctypes.c_int

586

transport_ptr_t = ctypes.c_void_p

587

close_request_t = ctypes.c_int

588

589

# Exceptions

590

class Error(Exception):

591

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

592

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

593

# code is passed, convert it to a string with

594

# gnutls.strerror()

595

self.code = code

596

if message is None and code is not None:

597

message = gnutls.strerror(code).decode(

598

"utf-8", errors="replace")

599

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

600

message, *args)

601

602

class CertificateSecurityError(Error):

603

pass

604

605

class PointerTo:

606

def __init__(self, cls):

607

self.cls = cls

608

609

def from_param(self, obj):

610

if not isinstance(obj, self.cls):

611

raise TypeError("Not of type {}: {!r}"

612

.format(self.cls.__name__, obj))

613

return ctypes.byref(obj.from_param(obj))

614

615

class CastToVoidPointer:

616

def __init__(self, cls):

617

self.cls = cls

618

619

def from_param(self, obj):

620

if not isinstance(obj, self.cls):

621

raise TypeError("Not of type {}: {!r}"

622

.format(self.cls.__name__, obj))

623

return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)

624

625

class With_from_param:

626

@classmethod

627

def from_param(cls, obj):

628

return obj._as_parameter_

629

630

# Classes

631

class Credentials(With_from_param):

632

def __init__(self):

633

self._as_parameter_ = gnutls.certificate_credentials_t()

634

gnutls.certificate_allocate_credentials(self)

635

self.type = gnutls.CRD_CERTIFICATE

636

637

def __del__(self):

638

gnutls.certificate_free_credentials(self)

639

640

class ClientSession(With_from_param):

641

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

642

self._as_parameter_ = gnutls.session_t()

643

gnutls_flags = gnutls.CLIENT

644

if gnutls.check_version(b"3.5.6"):

645

gnutls_flags |= gnutls.NO_TICKETS

646

if gnutls.has_rawpk:

647

gnutls_flags |= gnutls.ENABLE_RAWPK

648

gnutls.init(self, gnutls_flags)

649

del gnutls_flags

650

gnutls.set_default_priority(self)

651

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

652

gnutls.handshake_set_private_extensions(self, True)

653

self.socket = socket

654

if credentials is None:

655

credentials = gnutls.Credentials()

656

gnutls.credentials_set(self, credentials.type,

657

credentials)

658

self.credentials = credentials

659

660

def __del__(self):

661

gnutls.deinit(self)

662

663

def handshake(self):

664

return gnutls.handshake(self)

665

666

def send(self, data):

667

data = bytes(data)

668

data_len = len(data)

669

while data_len > 0:

670

data_len -= gnutls.record_send(self, data[-data_len:],

671

data_len)

672

673

def bye(self):

674

return gnutls.bye(self, gnutls.SHUT_RDWR)

675

676

# Error handling functions

677

def _error_code(result):

678

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

679

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

680

if result >= gnutls.E_SUCCESS:

681

return result

682

if result == gnutls.E_NO_CERTIFICATE_FOUND:

683

raise gnutls.CertificateSecurityError(code=result)

684

raise gnutls.Error(code=result)

685

686

def _retry_on_error(result, func, arguments,

687

_error_code=_error_code):

688

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

689

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

690

while result < gnutls.E_SUCCESS:

691

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

692

return _error_code(result)

693

result = func(*arguments)

694

return result

695

696

# Unless otherwise indicated, the function declarations below are

697

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

698

699

# Functions

700

priority_set_direct = _library.gnutls_priority_set_direct

701

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

702

ctypes.POINTER(ctypes.c_char_p)]

703

priority_set_direct.restype = _error_code

704

705

init = _library.gnutls_init

706

init.argtypes = [PointerTo(ClientSession), ctypes.c_int]

707

init.restype = _error_code

708

709

set_default_priority = _library.gnutls_set_default_priority

710

set_default_priority.argtypes = [ClientSession]

711

set_default_priority.restype = _error_code

712

713

record_send = _library.gnutls_record_send

714

record_send.argtypes = [ClientSession, ctypes.c_void_p,

715

ctypes.c_size_t]

716

record_send.restype = ctypes.c_ssize_t

717

record_send.errcheck = _retry_on_error

718

719

certificate_allocate_credentials = (

720

_library.gnutls_certificate_allocate_credentials)

721

certificate_allocate_credentials.argtypes = [

722

PointerTo(Credentials)]

723

certificate_allocate_credentials.restype = _error_code

724

725

certificate_free_credentials = (

726

_library.gnutls_certificate_free_credentials)

727

certificate_free_credentials.argtypes = [Credentials]

728

certificate_free_credentials.restype = None

729

730

handshake_set_private_extensions = (

731

_library.gnutls_handshake_set_private_extensions)

732

handshake_set_private_extensions.argtypes = [ClientSession,

733

ctypes.c_int]

734

handshake_set_private_extensions.restype = None

735

736

credentials_set = _library.gnutls_credentials_set

737

credentials_set.argtypes = [ClientSession, credentials_type_t,

738

CastToVoidPointer(Credentials)]

739

credentials_set.restype = _error_code

740

741

strerror = _library.gnutls_strerror

742

strerror.argtypes = [ctypes.c_int]

743

strerror.restype = ctypes.c_char_p

744

745

certificate_type_get = _library.gnutls_certificate_type_get

746

certificate_type_get.argtypes = [ClientSession]

747

certificate_type_get.restype = _error_code

748

749

certificate_get_peers = _library.gnutls_certificate_get_peers

750

certificate_get_peers.argtypes = [ClientSession,

751

ctypes.POINTER(ctypes.c_uint)]

752

certificate_get_peers.restype = ctypes.POINTER(datum_t)

753

754

global_set_log_level = _library.gnutls_global_set_log_level

755

global_set_log_level.argtypes = [ctypes.c_int]

756

global_set_log_level.restype = None

757

758

global_set_log_function = _library.gnutls_global_set_log_function

759

global_set_log_function.argtypes = [log_func]

760

global_set_log_function.restype = None

761

762

deinit = _library.gnutls_deinit

763

deinit.argtypes = [ClientSession]

764

deinit.restype = None

765

766

handshake = _library.gnutls_handshake

767

handshake.argtypes = [ClientSession]

768

handshake.restype = ctypes.c_int

769

handshake.errcheck = _retry_on_error

770

771

transport_set_ptr = _library.gnutls_transport_set_ptr

772

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

773

transport_set_ptr.restype = None

774

775

bye = _library.gnutls_bye

776

bye.argtypes = [ClientSession, close_request_t]

777

bye.restype = ctypes.c_int

778

bye.errcheck = _retry_on_error

779

780

check_version = _library.gnutls_check_version

781

check_version.argtypes = [ctypes.c_char_p]

782

check_version.restype = ctypes.c_char_p

783

784

_need_version = b"3.3.0"

785

if check_version(_need_version) is None:

786

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

787

.format(_need_version))

788

789

_tls_rawpk_version = b"3.6.6"

790

has_rawpk = bool(check_version(_tls_rawpk_version))

791

792

if has_rawpk:

793

# Types

794

class pubkey_st(ctypes.Structure):

795

_fields = []

796

pubkey_t = ctypes.POINTER(pubkey_st)

797

798

x509_crt_fmt_t = ctypes.c_int

799

800

# All the function declarations below are from

801

# gnutls/abstract.h

802

pubkey_init = _library.gnutls_pubkey_init

803

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

804

pubkey_init.restype = _error_code

805

806

pubkey_import = _library.gnutls_pubkey_import

807

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

808

x509_crt_fmt_t]

809

pubkey_import.restype = _error_code

810

811

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

812

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

813

ctypes.POINTER(ctypes.c_ubyte),

814

ctypes.POINTER(ctypes.c_size_t)]

815

pubkey_get_key_id.restype = _error_code

816

817

pubkey_deinit = _library.gnutls_pubkey_deinit

818

pubkey_deinit.argtypes = [pubkey_t]

819

pubkey_deinit.restype = None

820

else:

821

# All the function declarations below are from

822

# gnutls/openpgp.h

823

824

openpgp_crt_init = _library.gnutls_openpgp_crt_init

825

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

826

openpgp_crt_init.restype = _error_code

827

828

openpgp_crt_import = _library.gnutls_openpgp_crt_import

829

openpgp_crt_import.argtypes = [openpgp_crt_t,

830

ctypes.POINTER(datum_t),

831

openpgp_crt_fmt_t]

832

openpgp_crt_import.restype = _error_code

833

834

openpgp_crt_verify_self = \

835

_library.gnutls_openpgp_crt_verify_self

836

openpgp_crt_verify_self.argtypes = [

837

openpgp_crt_t,

838

ctypes.c_uint,

839

ctypes.POINTER(ctypes.c_uint),

840

]

841

openpgp_crt_verify_self.restype = _error_code

842

843

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

844

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

845

openpgp_crt_deinit.restype = None

846

847

openpgp_crt_get_fingerprint = (

848

_library.gnutls_openpgp_crt_get_fingerprint)

849

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

850

ctypes.c_void_p,

851

ctypes.POINTER(

852

ctypes.c_size_t)]

853

openpgp_crt_get_fingerprint.restype = _error_code

854

855

if check_version(b"3.6.4"):

856

certificate_type_get2 = _library.gnutls_certificate_type_get2

857

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

858

certificate_type_get2.restype = _error_code

859

860

# Remove non-public functions

861

del _error_code, _retry_on_error

862

863

864

def call_pipe(connection, # : multiprocessing.Connection

865

func, *args, **kwargs):

866

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

867

868

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

869

return value on the provided multiprocessing.Connection.

870

"""

871

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

872

connection.close()

873

874

875

class Client:

404

class Client(object):

876

405

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

877

406

878

407

Attributes:

879

408

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

880

409

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

881

410

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

882

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

883

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

884

running.

885

checker_callback_tag: a GLib event source tag, or None

411

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

412

to see if the client lives.

413

'None' if no process is running.

414

checker_callback_tag: a gobject event source tag, or None

886

415

checker_command: string; External command which is run to check

887

416

if client lives. %() expansions are done at

888

417

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

889

418

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

890

checker_initiator_tag: a GLib event source tag, or None

419

checker_initiator_tag: a gobject event source tag, or None

891

420

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

892

421

client_structure: Object describing what attributes a client has

893

422

and is used for storing the client at exit

894

423

current_checker_command: string; current running checker_command

895

disable_initiator_tag: a GLib event source tag, or None

424

disable_initiator_tag: a gobject event source tag, or None

896

425

enabled: bool()

897

426

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

898

uniquely identify an OpenPGP client

899

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

900

a client using raw public keys

427

uniquely identify the client

901

428

host: string; available for use by the checker command

902

429

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

903

430

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

905

432

last_checker_status: integer between 0 and 255 reflecting exit

906

433

status of last checker. -1 reflects crashed

907

434

checker, -2 means no checker completed yet.

908

last_checker_signal: The signal which killed the last checker, if

909

last_checker_status is -1

910

435

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

911

436

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

912

437

D-Bus identifiers

919

444

disabled, or None

920

445

server_settings: The server_settings dict from main()

921

446

"""

922

447

923

448

runtime_expansions = ("approval_delay", "approval_duration",

924

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

449

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

925

450

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

926

451

"last_approval_request", "last_checked_ok",

927

452

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

928

client_defaults = {

929

"timeout": "PT5M",

930

"extended_timeout": "PT15M",

931

"interval": "PT2M",

932

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

933

"host": "",

934

"approval_delay": "PT0S",

935

"approval_duration": "PT1S",

936

"approved_by_default": "True",

937

"enabled": "True",

938

}

939

453

client_defaults = { "timeout": "PT5M",

454

"extended_timeout": "PT15M",

455

"interval": "PT2M",

456

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

457

"host": "",

458

"approval_delay": "PT0S",

459

"approval_duration": "PT1S",

460

"approved_by_default": "True",

461

"enabled": "True",

462

}

463

940

464

@staticmethod

941

465

def config_parser(config):

942

466

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

949

473

for client_name in config.sections():

950

474

section = dict(config.items(client_name))

951

475

client = settings[client_name] = {}

952

476

953

477

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

954

478

# Reformat values from string types to Python types

955

479

client["approved_by_default"] = config.getboolean(

956

480

client_name, "approved_by_default")

957

481

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

958

482

"enabled")

959

960

# Uppercase and remove spaces from key_id and fingerprint

961

# for later comparison purposes with return value from the

962

# key_id() and fingerprint() functions

963

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

964

.replace(" ", ""))

483

965

484

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

966

485

.replace(" ", ""))

967

486

if "secret" in section:

968

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

969

.encode("utf-8"),

970

"base64")

487

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

971

488

elif "secfile" in section:

972

489

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

973

490

(section["secfile"])),

988

505

client["last_approval_request"] = None

989

506

client["last_checked_ok"] = None

990

507

client["last_checker_status"] = -2

991

508

992

509

return settings

993

994

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

510

511

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

995

512

self.name = name

996

513

if server_settings is None:

997

514

server_settings = {}

999

516

# adding all client settings

1000

517

for setting, value in settings.items():

1001

518

setattr(self, setting, value)

1002

519

1003

520

if self.enabled:

1004

521

if not hasattr(self, "last_enabled"):

1005

522

self.last_enabled = datetime.datetime.utcnow()

1009

526

else:

1010

527

self.last_enabled = None

1011

528

self.expires = None

1012

529

1013

530

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

1014

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

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the fingerprint()

533

# function

1015

534

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

1016

535

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

1017

536

datetime.datetime.utcnow())

1018

537

1019

538

# attributes specific for this server instance

1020

539

self.checker = None

1021

540

self.checker_initiator_tag = None

1024

543

self.current_checker_command = None

1025

544

self.approved = None

1026

545

self.approvals_pending = 0

1027

self.changedstate = multiprocessing_manager.Condition(

1028

multiprocessing_manager.Lock())

1029

self.client_structure = [attr

1030

for attr in self.__dict__.keys()

546

self.changedstate = (multiprocessing_manager

547

.Condition(multiprocessing_manager

548

.Lock()))

549

self.client_structure = [attr for attr in

550

self.__dict__.iterkeys()

1031

551

if not attr.startswith("_")]

1032

552

self.client_structure.append("client_structure")

1033

1034

for name, t in inspect.getmembers(

1035

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

553

554

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

555

lambda obj:

556

isinstance(obj,

557

property)):

1036

558

if not name.startswith("_"):

1037

559

self.client_structure.append(name)

1038

560

1039

561

# Send notice to process children that client state has changed

1040

562

def send_changedstate(self):

1041

563

with self.changedstate:

1042

564

self.changedstate.notify_all()

1043

565

1044

566

def enable(self):

1045

567

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

1046

568

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

1051

573

self.last_enabled = datetime.datetime.utcnow()

1052

574

self.init_checker()

1053

575

self.send_changedstate()

1054

576

1055

577

def disable(self, quiet=True):

1056

578

"""Disable this client."""

1057

579

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

1059

581

if not quiet:

1060

582

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

1061

583

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

1062

GLib.source_remove(self.disable_initiator_tag)

584

gobject.source_remove(self.disable_initiator_tag)

1063

585

self.disable_initiator_tag = None

1064

586

self.expires = None

1065

587

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

1066

GLib.source_remove(self.checker_initiator_tag)

588

gobject.source_remove(self.checker_initiator_tag)

1067

589

self.checker_initiator_tag = None

1068

590

self.stop_checker()

1069

591

self.enabled = False

1070

592

if not quiet:

1071

593

self.send_changedstate()

1072

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

594

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

1073

595

return False

1074

596

1075

597

def __del__(self):

1076

598

self.disable()

1077

599

1078

600

def init_checker(self):

1079

601

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

1080

602

# and every interval from then on.

1081

603

if self.checker_initiator_tag is not None:

1082

GLib.source_remove(self.checker_initiator_tag)

1083

self.checker_initiator_tag = GLib.timeout_add(

1084

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

1085

+ 1)),

1086

self.start_checker)

604

gobject.source_remove(self.checker_initiator_tag)

605

self.checker_initiator_tag = (gobject.timeout_add

606

(int(self.interval

607

.total_seconds() * 1000),

608

self.start_checker))

1087

609

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

1088

610

if self.disable_initiator_tag is not None:

1089

GLib.source_remove(self.disable_initiator_tag)

1090

self.disable_initiator_tag = GLib.timeout_add(

1091

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

611

gobject.source_remove(self.disable_initiator_tag)

612

self.disable_initiator_tag = (gobject.timeout_add

613

(int(self.timeout

614

.total_seconds() * 1000),

615

self.disable))

1092

616

# Also start a new checker *right now*.

1093

617

self.start_checker()

1094

1095

def checker_callback(self, source, condition, connection,

1096

command):

618

619

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

1097

620

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

1098

# Read return code from connection (see call_pipe)

1099

returncode = connection.recv()

1100

connection.close()

1101

if self.checker is not None:

1102

self.checker.join()

1103

621

self.checker_callback_tag = None

1104

622

self.checker = None

1105

1106

if returncode >= 0:

1107

self.last_checker_status = returncode

1108

self.last_checker_signal = None

623

if os.WIFEXITED(condition):

624

self.last_checker_status = os.WEXITSTATUS(condition)

1109

625

if self.last_checker_status == 0:

1110

626

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

1111

627

vars(self))

1112

628

self.checked_ok()

1113

629

else:

1114

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

630

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

631

vars(self))

1115

632

else:

1116

633

self.last_checker_status = -1

1117

self.last_checker_signal = -returncode

1118

634

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

1119

635

vars(self))

1120

return False

1121

636

1122

637

def checked_ok(self):

1123

638

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

1124

639

self.last_checked_ok = datetime.datetime.utcnow()

1125

640

self.last_checker_status = 0

1126

self.last_checker_signal = None

1127

641

self.bump_timeout()

1128

642

1129

643

def bump_timeout(self, timeout=None):

1130

644

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

1131

645

if timeout is None:

1132

646

timeout = self.timeout

1133

647

if self.disable_initiator_tag is not None:

1134

GLib.source_remove(self.disable_initiator_tag)

648

gobject.source_remove(self.disable_initiator_tag)

1135

649

self.disable_initiator_tag = None

1136

650

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

1137

self.disable_initiator_tag = GLib.timeout_add(

1138

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

651

self.disable_initiator_tag = (gobject.timeout_add

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

1139

654

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

1140

655

1141

656

def need_approval(self):

1142

657

self.last_approval_request = datetime.datetime.utcnow()

1143

658

1144

659

def start_checker(self):

1145

660

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

1146

661

1147

662

If a checker already exists, leave it running and do

1148

663

nothing."""

1149

664

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

1154

669

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

1155

670

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

1156

671

# should be.

1157

1158

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

1159

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

1160

self.checker.join()

1161

self.checker = None

672

673

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

674

try:

675

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

676

except AttributeError:

677

pass

678

except OSError as error:

679

if error.errno != errno.ECHILD:

680

raise

681

else:

682

if pid:

683

logger.warning("Checker was a zombie")

684

gobject.source_remove(self.checker_callback_tag)

685

self.checker_callback(pid, status,

686

self.current_checker_command)

1162

687

# Start a new checker if needed

1163

688

if self.checker is None:

1164

689

# Escape attributes for the shell

1165

escaped_attrs = {

1166

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

1167

for attr in self.runtime_expansions}

690

escaped_attrs = { attr:

691

re.escape(unicode(getattr(self,

692

attr)))

693

for attr in self.runtime_expansions }

1168

694

try:

1169

695

command = self.checker_command % escaped_attrs

1170

696

except TypeError as error:

1171

697

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

1172

self.checker_command,

698

self.checker_command, exc_info=error)

699

return True # Try again later

700

self.current_checker_command = command

701

try:

702

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

703

command, self.name)

704

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

705

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

706

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

707

# always replaced by /dev/null.)

708

# The exception is when not debugging but nevertheless

709

# running in the foreground; use the previously

710

# created wnull.

711

popen_args = {}

712

if (not self.server_settings["debug"]

713

and self.server_settings["foreground"]):

714

popen_args.update({"stdout": wnull,

715

"stderr": wnull })

716

self.checker = subprocess.Popen(command,

717

close_fds=True,

718

shell=True, cwd="/",

719

**popen_args)

720

except OSError as error:

721

logger.error("Failed to start subprocess",

1173

722

exc_info=error)

1174

return True # Try again later

1175

self.current_checker_command = command

1176

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

1177

self.name)

1178

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

1179

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

1180

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

1181

# always replaced by /dev/null.)

1182

# The exception is when not debugging but nevertheless

1183

# running in the foreground; use the previously

1184

# created wnull.

1185

popen_args = {"close_fds": True,

1186

"shell": True,

1187

"cwd": "/"}

1188

if (not self.server_settings["debug"]

1189

and self.server_settings["foreground"]):

1190

popen_args.update({"stdout": wnull,

1191

"stderr": wnull})

1192

pipe = multiprocessing.Pipe(duplex=False)

1193

self.checker = multiprocessing.Process(

1194

target=call_pipe,

1195

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

1196

kwargs=popen_args)

1197

self.checker.start()

1198

self.checker_callback_tag = GLib.io_add_watch(

1199

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

1200

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1201

self.checker_callback, pipe[0], command)

1202

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

723

return True

724

self.checker_callback_tag = (gobject.child_watch_add

725

(self.checker.pid,

726

self.checker_callback,

727

data=command))

728

# The checker may have completed before the gobject

729

# watch was added. Check for this.

730

try:

731

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

732

except OSError as error:

733

if error.errno == errno.ECHILD:

734

# This should never happen

735

logger.error("Child process vanished",

736

exc_info=error)

737

return True

738

raise

739

if pid:

740

gobject.source_remove(self.checker_callback_tag)

741

self.checker_callback(pid, status, command)

742

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

1203

743

return True

1204

744

1205

745

def stop_checker(self):

1206

746

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

1207

747

if self.checker_callback_tag:

1208

GLib.source_remove(self.checker_callback_tag)

748

gobject.source_remove(self.checker_callback_tag)

1209

749

self.checker_callback_tag = None

1210

750

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

1211

751

return

1212

752

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

1213

self.checker.terminate()

753

try:

754

self.checker.terminate()

755

#time.sleep(0.5)

756

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

757

# self.checker.kill()

758

except OSError as error:

759

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

760

raise

1214

761

self.checker = None

1215

762

1216

763

1217

def dbus_service_property(dbus_interface,

1218

signature="v",

1219

access="readwrite",

1220

byte_arrays=False):

764

def dbus_service_property(dbus_interface, signature="v",

765

access="readwrite", byte_arrays=False):

1221

766

"""Decorators for marking methods of a DBusObjectWithProperties to

1222

767

become properties on the D-Bus.

1223

768

1224

769

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

1225

770

and with one argument by "Set".

1226

771

1227

772

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

1228

773

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

1229

774

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

1233

778

if byte_arrays and signature != "ay":

1234

779

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

1235

780

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

1236

1237

781

def decorator(func):

1238

782

func._dbus_is_property = True

1239

783

func._dbus_interface = dbus_interface

1242

786

func._dbus_name = func.__name__

1243

787

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

1244

788

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

1245

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

789

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1246

790

return func

1247

1248

791

return decorator

1249

792

1250

793

1251

794

def dbus_interface_annotations(dbus_interface):

1252

795

"""Decorator for marking functions returning interface annotations

1253

796

1254

797

Usage:

1255

798

1256

799

@dbus_interface_annotations("org.example.Interface")

1257

800

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

1258

801

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

1259

802

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

1260

803

"false"}

1261

804

"""

1262

1263

805

def decorator(func):

1264

806

func._dbus_is_interface = True

1265

807

func._dbus_interface = dbus_interface

1266

808

func._dbus_name = dbus_interface

1267

809

return func

1268

1269

810

return decorator

1270

811

1271

812

1272

813

def dbus_annotations(annotations):

1273

814

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

1274

815

Usage:

1275

1276

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

1277

"org.freedesktop.DBus.Property."

1278

"EmitsChangedSignal": "false"})

816

1279

817

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

1280

818

access="r")

819

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

820

"org.freedesktop.DBus.Property."

821

"EmitsChangedSignal": "false"})

1281

822

def Property_dbus_property(self):

1282

823

return dbus.Boolean(False)

1283

1284

See also the DBusObjectWithAnnotations class.

1285

824

"""

1286

1287

825

def decorator(func):

1288

826

func._dbus_annotations = annotations

1289

827

return func

1290

1291

828

return decorator

1292

829

1293

830

1294

831

class DBusPropertyException(dbus.exceptions.DBusException):

1295

832

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

1296

833

"""

1297

pass

834

def __unicode__(self):

835

return unicode(str(self))

1298

836

1299

837

1300

838

class DBusPropertyAccessException(DBusPropertyException):

1309

847

pass

1310

848

1311

849

1312

class DBusObjectWithAnnotations(dbus.service.Object):

1313

"""A D-Bus object with annotations.

1314

1315

Classes inheriting from this can use the dbus_annotations

1316

decorator to add annotations to methods or signals.

850

class DBusObjectWithProperties(dbus.service.Object):

851

"""A D-Bus object with properties.

852

853

Classes inheriting from this can use the dbus_service_property

854

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

855

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

1317

856

"""

1318

857

1319

858

@staticmethod

1320

859

def _is_dbus_thing(thing):

1321

860

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

1322

861

1323

862

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

1324

863

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

1325

864

"""

1326

865

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

1327

866

False)

1328

867

1329

868

def _get_all_dbus_things(self, thing):

1330

869

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

1331

870

"""

1332

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

871

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

872

name),

1333

873

athing.__get__(self))

1334

874

for cls in self.__class__.__mro__

1335

875

for name, athing in

1336

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

1337

1338

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1339

out_signature="s",

1340

path_keyword='object_path',

1341

connection_keyword='connection')

1342

def Introspect(self, object_path, connection):

1343

"""Overloading of standard D-Bus method.

1344

1345

Inserts annotation tags on methods and signals.

1346

"""

1347

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

1348

connection)

1349

try:

1350

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

1351

1352

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

1353

# Add annotation tags

1354

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

1355

for tag in if_tag.getElementsByTagName(typ):

1356

annots = dict()

1357

for name, prop in (self.

1358

_get_all_dbus_things(typ)):

1359

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

1360

and prop._dbus_interface

1361

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

1362

annots.update(getattr(

1363

prop, "_dbus_annotations", {}))

1364

for name, value in annots.items():

1365

ann_tag = document.createElement(

1366

"annotation")

1367

ann_tag.setAttribute("name", name)

1368

ann_tag.setAttribute("value", value)

1369

tag.appendChild(ann_tag)

1370

# Add interface annotation tags

1371

for annotation, value in dict(

1372

itertools.chain.from_iterable(

1373

annotations().items()

1374

for name, annotations

1375

in self._get_all_dbus_things("interface")

1376

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

1377

)).items():

1378

ann_tag = document.createElement("annotation")

1379

ann_tag.setAttribute("name", annotation)

1380

ann_tag.setAttribute("value", value)

1381

if_tag.appendChild(ann_tag)

1382

# Fix argument name for the Introspect method itself

1383

if (if_tag.getAttribute("name")

1384

== dbus.INTROSPECTABLE_IFACE):

1385

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

1386

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

1387

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

1388

if (arg.getAttribute("direction")

1389

== "out"):

1390

arg.setAttribute("name",

1391

"xml_data")

1392

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

1393

document.unlink()

1394

except (AttributeError, xml.dom.DOMException,

1395

xml.parsers.expat.ExpatError) as error:

1396

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

1397

exc_info=error)

1398

return xmlstring

1399

1400

1401

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1402

"""A D-Bus object with properties.

1403

1404

Classes inheriting from this can use the dbus_service_property

1405

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

1406

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

1407

"""

1408

876

inspect.getmembers(cls,

877

self._is_dbus_thing(thing)))

878

1409

879

def _get_dbus_property(self, interface_name, property_name):

1410

880

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

1411

881

property with the specified name and interface.

1412

882

"""

1413

for cls in self.__class__.__mro__:

1414

for name, value in inspect.getmembers(

1415

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

883

for cls in self.__class__.__mro__:

884

for name, value in (inspect.getmembers

885

(cls,

886

self._is_dbus_thing("property"))):

1416

887

if (value._dbus_name == property_name

1417

888

and value._dbus_interface == interface_name):

1418

889

return value.__get__(self)

1419

890

1420

891

# No such property

1421

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

1422

self.dbus_object_path, interface_name, property_name))

1423

1424

@classmethod

1425

def _get_all_interface_names(cls):

1426

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

1427

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

1428

"_dbus_interface", None)

1429

for x in (inspect.getmro(cls))

1430

for attr in dir(x))

1431

if name is not None)

1432

1433

@dbus.service.method(dbus.PROPERTIES_IFACE,

1434

in_signature="ss",

892

raise DBusPropertyNotFound(self.dbus_object_path + ":"

893

+ interface_name + "."

894

+ property_name)

895

896

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

1435

897

out_signature="v")

1436

898

def Get(self, interface_name, property_name):

1437

899

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

1443

905

if not hasattr(value, "variant_level"):

1444

906

return value

1445

907

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

1446

908

1447

909

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

1448

910

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

1449

911

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

1458

920

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

1459

921

"'ay' signature {!r}"

1460

922

.format(prop._dbus_signature))

1461

value = dbus.ByteArray(bytes(value))

923

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

924

for byte in value))

1462

925

prop(value)

1463

1464

@dbus.service.method(dbus.PROPERTIES_IFACE,

1465

in_signature="s",

926

927

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

1466

928

out_signature="a{sv}")

1467

929

def GetAll(self, interface_name):

1468

930

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

1469

931

standard.

1470

932

1471

933

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

1472

934

"""

1473

935

properties = {}

1483

945

if not hasattr(value, "variant_level"):

1484

946

properties[name] = value

1485

947

continue

1486

properties[name] = type(value)(

1487

value, variant_level=value.variant_level + 1)

948

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

949

value.variant_level+1)

1488

950

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

1489

1490

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

1491

def PropertiesChanged(self, interface_name, changed_properties,

1492

invalidated_properties):

1493

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

1494

standard.

1495

"""

1496

pass

1497

951

1498

952

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1499

953

out_signature="s",

1500

954

path_keyword='object_path',

1501

955

connection_keyword='connection')

1502

956

def Introspect(self, object_path, connection):

1503

957

"""Overloading of standard D-Bus method.

1504

958

1505

959

Inserts property tags and interface annotation tags.

1506

960

"""

1507

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1508

object_path,

1509

connection)

961

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

962

connection)

1510

963

try:

1511

964

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

1512

1513

965

def make_tag(document, name, prop):

1514

966

e = document.createElement("property")

1515

967

e.setAttribute("name", name)

1516

968

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

1517

969

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

1518

970

return e

1519

1520

971

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

1521

972

# Add property tags

1522

973

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

1525

976

if prop._dbus_interface

1526

977

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

1527

978

if_tag.appendChild(tag)

1528

# Add annotation tags for properties

1529

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

1530

annots = dict()

1531

for name, prop in self._get_all_dbus_things(

1532

"property"):

1533

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

1534

and prop._dbus_interface

1535

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

1536

annots.update(getattr(

1537

prop, "_dbus_annotations", {}))

1538

for name, value in annots.items():

1539

ann_tag = document.createElement(

1540

"annotation")

1541

ann_tag.setAttribute("name", name)

1542

ann_tag.setAttribute("value", value)

1543

tag.appendChild(ann_tag)

979

# Add annotation tags

980

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

981

for tag in if_tag.getElementsByTagName(typ):

982

annots = dict()

983

for name, prop in (self.

984

_get_all_dbus_things(typ)):

985

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

986

and prop._dbus_interface

987

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

988

annots.update(getattr

989

(prop,

990

"_dbus_annotations",

991

{}))

992

for name, value in annots.items():

993

ann_tag = document.createElement(

994

"annotation")

995

ann_tag.setAttribute("name", name)

996

ann_tag.setAttribute("value", value)

997

tag.appendChild(ann_tag)

998

# Add interface annotation tags

999

for annotation, value in dict(

1000

itertools.chain.from_iterable(

1001

annotations().items()

1002

for name, annotations in

1003

self._get_all_dbus_things("interface")

1004

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

1005

)).items():

1006

ann_tag = document.createElement("annotation")

1007

ann_tag.setAttribute("name", annotation)

1008

ann_tag.setAttribute("value", value)

1009

if_tag.appendChild(ann_tag)

1544

1010

# Add the names to the return values for the

1545

1011

# "org.freedesktop.DBus.Properties" methods

1546

1012

if (if_tag.getAttribute("name")

1565

1031

return xmlstring

1566

1032

1567

1033

1568

try:

1569

dbus.OBJECT_MANAGER_IFACE

1570

except AttributeError:

1571

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

1572

1573

1574

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1575

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

1576

1577

Classes inheriting from this exposes the standard

1578

GetManagedObjects call and the InterfacesAdded and

1579

InterfacesRemoved signals on the standard

1580

"org.freedesktop.DBus.ObjectManager" interface.

1581

1582

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

1583

manually.

1584

"""

1585

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1586

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

1587

def GetManagedObjects(self):

1588

"""This function must be overridden"""

1589

raise NotImplementedError()

1590

1591

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1592

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

1593

def InterfacesAdded(self, object_path, interfaces_and_properties):

1594

pass

1595

1596

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

1597

def InterfacesRemoved(self, object_path, interfaces):

1598

pass

1599

1600

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1601

out_signature="s",

1602

path_keyword='object_path',

1603

connection_keyword='connection')

1604

def Introspect(self, object_path, connection):

1605

"""Overloading of standard D-Bus method.

1606

1607

Override return argument name of GetManagedObjects to be

1608

"objpath_interfaces_and_properties"

1609

"""

1610

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1611

object_path,

1612

connection)

1613

try:

1614

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

1615

1616

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

1617

# Fix argument name for the GetManagedObjects method

1618

if (if_tag.getAttribute("name")

1619

== dbus.OBJECT_MANAGER_IFACE):

1620

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

1621

if (cn.getAttribute("name")

1622

== "GetManagedObjects"):

1623

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

1624

if (arg.getAttribute("direction")

1625

== "out"):

1626

arg.setAttribute(

1627

"name",

1628

"objpath_interfaces"

1629

"_and_properties")

1630

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

1631

document.unlink()

1632

except (AttributeError, xml.dom.DOMException,

1633

xml.parsers.expat.ExpatError) as error:

1634

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

1635

exc_info=error)

1636

return xmlstring

1637

1638

1639

1034

def datetime_to_dbus(dt, variant_level=0):

1640

1035

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

1641

1036

if dt is None:

1642

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

1643

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

1037

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

1038

return dbus.String(dt.isoformat(),

1039

variant_level=variant_level)

1644

1040

1645

1041

1646

1042

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1648

1044

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

1649

1045

interface names according to the "alt_interface_names" mapping.

1650

1046

Usage:

1651

1047

1652

1048

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

1653

1049

"net.example.AlternateInterface"})

1654

1050

class SampleDBusObject(dbus.service.Object):

1655

1051

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

1656

1052

def SampleDBusMethod():

1657

1053

pass

1658

1054

1659

1055

The above "SampleDBusMethod" on "SampleDBusObject" will be

1660

1056

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

1661

1057

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

1662

1058

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

1663

1059

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

1664

1060

1665

1061

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

1666

1062

(from DBusObjectWithProperties) and interfaces (from the

1667

1063

dbus_interface_annotations decorator).

1668

1064

"""

1669

1670

1065

def wrapper(cls):

1671

1066

for orig_interface_name, alt_interface_name in (

1672

alt_interface_names.items()):

1067

alt_interface_names.items()):

1673

1068

attr = {}

1674

1069

interface_names = set()

1675

1070

# Go though all attributes of the class

1677

1072

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

1678

1073

# with the wrong interface name

1679

1074

if (not hasattr(attribute, "_dbus_interface")

1680

or not attribute._dbus_interface.startswith(

1681

orig_interface_name)):

1075

or not attribute._dbus_interface

1076

.startswith(orig_interface_name)):

1682

1077

continue

1683

1078

# Create an alternate D-Bus interface name based on

1684

1079

# the current name

1685

alt_interface = attribute._dbus_interface.replace(

1686

orig_interface_name, alt_interface_name)

1080

alt_interface = (attribute._dbus_interface

1081

.replace(orig_interface_name,

1082

alt_interface_name))

1687

1083

interface_names.add(alt_interface)

1688

1084

# Is this a D-Bus signal?

1689

1085

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

1690

1086

# Extract the original non-method undecorated

1691

1087

# function by black magic

1692

if sys.version_info.major == 2:

1693

nonmethod_func = (dict(

1088

nonmethod_func = (dict(

1694

1089

zip(attribute.func_code.co_freevars,

1695

attribute.__closure__))

1696

["func"].cell_contents)

1697

else:

1698

nonmethod_func = (dict(

1699

zip(attribute.__code__.co_freevars,

1700

attribute.__closure__))

1701

["func"].cell_contents)

1090

attribute.__closure__))["func"]

1091

.cell_contents)

1702

1092

# Create a new, but exactly alike, function

1703

1093

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

1704

1094

# with the alternate D-Bus interface name

1705

new_function = copy_function(nonmethod_func)

1706

new_function = (dbus.service.signal(

1707

alt_interface,

1708

attribute._dbus_signature)(new_function))

1095

new_function = (dbus.service.signal

1096

(alt_interface,

1097

attribute._dbus_signature)

1098

(types.FunctionType(

1099

nonmethod_func.func_code,

1100

nonmethod_func.func_globals,

1101

nonmethod_func.func_name,

1102

nonmethod_func.func_defaults,

1103

nonmethod_func.func_closure)))

1709

1104

# Copy annotations, if any

1710

1105

try:

1711

new_function._dbus_annotations = dict(

1712

attribute._dbus_annotations)

1106

new_function._dbus_annotations = (

1107

dict(attribute._dbus_annotations))

1713

1108

except AttributeError:

1714

1109

pass

1715

1716

1110

# Define a creator of a function to call both the

1717

1111

# original and alternate functions, so both the

1718

1112

# original and alternate signals gets sent when

1721

1115

"""This function is a scope container to pass

1722

1116

func1 and func2 to the "call_both" function

1723

1117

outside of its arguments"""

1724

1725

@functools.wraps(func2)

1726

1118

def call_both(*args, **kwargs):

1727

1119

"""This function will emit two D-Bus

1728

1120

signals by calling func1 and func2"""

1729

1121

func1(*args, **kwargs)

1730

1122

func2(*args, **kwargs)

1731

# Make wrapper function look like a D-Bus

1732

# signal

1733

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

1734

if name.startswith("_dbus_"):

1735

setattr(call_both, name, attr)

1736

1737

1123

return call_both

1738

1124

# Create the "call_both" function and add it to

1739

1125

# the class

1744

1130

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

1745

1131

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

1746

1132

# to the class.

1747

attr[attrname] = (

1748

dbus.service.method(

1749

alt_interface,

1750

attribute._dbus_in_signature,

1751

attribute._dbus_out_signature)

1752

(copy_function(attribute)))

1133

attr[attrname] = (dbus.service.method

1134

(alt_interface,

1135

attribute._dbus_in_signature,

1136

attribute._dbus_out_signature)

1137

(types.FunctionType

1138

(attribute.func_code,

1139

attribute.func_globals,

1140

attribute.func_name,

1141

attribute.func_defaults,

1142

attribute.func_closure)))

1753

1143

# Copy annotations, if any

1754

1144

try:

1755

attr[attrname]._dbus_annotations = dict(

1756

attribute._dbus_annotations)

1145

attr[attrname]._dbus_annotations = (

1146

dict(attribute._dbus_annotations))

1757

1147

except AttributeError:

1758

1148

pass

1759

1149

# Is this a D-Bus property?

1762

1152

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

1763

1153

# property with the alternate D-Bus interface

1764

1154

# name. Add it to the class.

1765

attr[attrname] = (dbus_service_property(

1766

alt_interface, attribute._dbus_signature,

1767

attribute._dbus_access,

1768

attribute._dbus_get_args_options

1769

["byte_arrays"])

1770

(copy_function(attribute)))

1155

attr[attrname] = (dbus_service_property

1156

(alt_interface,

1157

attribute._dbus_signature,

1158

attribute._dbus_access,

1159

attribute

1160

._dbus_get_args_options

1161

["byte_arrays"])

1162

(types.FunctionType

1163

(attribute.func_code,

1164

attribute.func_globals,

1165

attribute.func_name,

1166

attribute.func_defaults,

1167

attribute.func_closure)))

1771

1168

# Copy annotations, if any

1772

1169

try:

1773

attr[attrname]._dbus_annotations = dict(

1774

attribute._dbus_annotations)

1170

attr[attrname]._dbus_annotations = (

1171

dict(attribute._dbus_annotations))

1775

1172

except AttributeError:

1776

1173

pass

1777

1174

# Is this a D-Bus interface?

1780

1177

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

1781

1178

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

1782

1179

# to the class.

1783

attr[attrname] = (

1784

dbus_interface_annotations(alt_interface)

1785

(copy_function(attribute)))

1180

attr[attrname] = (dbus_interface_annotations

1181

(alt_interface)

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

attribute.func_closure)))

1786

1188

if deprecate:

1787

1189

# Deprecate all alternate interfaces

1788

iname = "_AlternateDBusNames_interface_annotation{}"

1190

iname="_AlternateDBusNames_interface_annotation{}"

1789

1191

for interface_name in interface_names:

1790

1791

1192

@dbus_interface_annotations(interface_name)

1792

1193

def func(self):

1793

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

1794

"true"}

1194

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

1195

"true" }

1795

1196

# Find an unused name

1796

1197

for aname in (iname.format(i)

1797

1198

for i in itertools.count()):

1801

1202

if interface_names:

1802

1203

# Replace the class with a new subclass of it with

1803

1204

# methods, signals, etc. as created above.

1804

if sys.version_info.major == 2:

1805

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

1806

(cls, ), attr)

1807

else:

1808

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

1809

(cls, ), attr)

1205

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

1206

(cls,), attr)

1810

1207

return cls

1811

1812

1208

return wrapper

1813

1209

1814

1210

1815

1211

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

1816

"se.bsnet.fukt.Mandos"})

1212

"se.bsnet.fukt.Mandos"})

1817

1213

class ClientDBus(Client, DBusObjectWithProperties):

1818

1214

"""A Client class using D-Bus

1819

1215

1820

1216

Attributes:

1821

1217

dbus_object_path: dbus.ObjectPath

1822

1218

bus: dbus.SystemBus()

1823

1219

"""

1824

1220

1825

1221

runtime_expansions = (Client.runtime_expansions

1826

+ ("dbus_object_path", ))

1827

1828

_interface = "se.recompile.Mandos.Client"

1829

1222

+ ("dbus_object_path",))

1223

1830

1224

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

1831

1832

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

1225

1226

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

1833

1227

self.bus = bus

1834

1228

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

1835

1229

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

1836

1230

# the D-Bus

1837

client_object_name = str(self.name).translate(

1231

client_object_name = unicode(self.name).translate(

1838

1232

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

1839

1233

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

1840

self.dbus_object_path = dbus.ObjectPath(

1841

"/clients/" + client_object_name)

1234

self.dbus_object_path = (dbus.ObjectPath

1235

("/clients/" + client_object_name))

1842

1236

DBusObjectWithProperties.__init__(self, self.bus,

1843

1237

self.dbus_object_path)

1844

1845

def notifychangeproperty(transform_func, dbus_name,

1846

type_func=lambda x: x,

1847

variant_level=1,

1848

invalidate_only=False,

1849

_interface=_interface):

1238

1239

def notifychangeproperty(transform_func,

1240

dbus_name, type_func=lambda x: x,

1241

variant_level=1):

1850

1242

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

1851

1243

its changes to DBus.

1852

1244

1853

1245

transform_fun: Function that takes a value and a variant_level

1854

1246

and transforms it to a D-Bus type.

1855

1247

dbus_name: D-Bus name of the variable

1858

1250

variant_level: D-Bus variant level. Default: 1

1859

1251

"""

1860

1252

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

1861

1862

1253

def setter(self, value):

1863

1254

if hasattr(self, "dbus_object_path"):

1864

1255

if (not hasattr(self, attrname) or

1865

1256

type_func(getattr(self, attrname, None))

1866

1257

!= type_func(value)):

1867

if invalidate_only:

1868

self.PropertiesChanged(

1869

_interface, dbus.Dictionary(),

1870

dbus.Array((dbus_name, )))

1871

else:

1872

dbus_value = transform_func(

1873

type_func(value),

1874

variant_level=variant_level)

1875

self.PropertyChanged(dbus.String(dbus_name),

1876

dbus_value)

1877

self.PropertiesChanged(

1878

_interface,

1879

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

1880

dbus_value}),

1881

dbus.Array())

1258

dbus_value = transform_func(type_func(value),

1259

variant_level

1260

=variant_level)

1261

self.PropertyChanged(dbus.String(dbus_name),

1262

dbus_value)

1882

1263

setattr(self, attrname, value)

1883

1264

1884

1265

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

1885

1266

1886

1267

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1887

1268

approvals_pending = notifychangeproperty(dbus.Boolean,

1888

1269

"ApprovalPending",

1889

type_func=bool)

1270

type_func = bool)

1890

1271

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

1891

1272

last_enabled = notifychangeproperty(datetime_to_dbus,

1892

1273

"LastEnabled")

1893

checker = notifychangeproperty(

1894

dbus.Boolean, "CheckerRunning",

1895

type_func=lambda checker: checker is not None)

1274

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

1275

type_func = lambda checker:

1276

checker is not None)

1896

1277

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1897

1278

"LastCheckedOK")

1898

1279

last_checker_status = notifychangeproperty(dbus.Int16,

1901

1282

datetime_to_dbus, "LastApprovalRequest")

1902

1283

approved_by_default = notifychangeproperty(dbus.Boolean,

1903

1284

"ApprovedByDefault")

1904

approval_delay = notifychangeproperty(

1905

dbus.UInt64, "ApprovalDelay",

1906

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

1285

approval_delay = notifychangeproperty(dbus.UInt64,

1286

"ApprovalDelay",

1287

type_func =

1288

lambda td: td.total_seconds()

1289

* 1000)

1907

1290

approval_duration = notifychangeproperty(

1908

1291

dbus.UInt64, "ApprovalDuration",

1909

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

1292

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

1910

1293

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

1911

timeout = notifychangeproperty(

1912

dbus.UInt64, "Timeout",

1913

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

1294

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

1295

type_func = lambda td:

1296

td.total_seconds() * 1000)

1914

1297

extended_timeout = notifychangeproperty(

1915

1298

dbus.UInt64, "ExtendedTimeout",

1916

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

1917

interval = notifychangeproperty(

1918

dbus.UInt64, "Interval",

1919

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

1299

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

1300

interval = notifychangeproperty(dbus.UInt64,

1301

"Interval",

1302

type_func =

1303

lambda td: td.total_seconds()

1304

* 1000)

1920

1305

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

1921

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

1922

invalidate_only=True)

1923

1306

1924

1307

del notifychangeproperty

1925

1308

1926

1309

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

1927

1310

try:

1928

1311

self.remove_from_connection()

1931

1314

if hasattr(DBusObjectWithProperties, "__del__"):

1932

1315

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

1933

1316

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

1934

1935

def checker_callback(self, source, condition,

1936

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

1937

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

1938

connection, command, *args,

1939

**kwargs)

1940

exitstatus = self.last_checker_status

1941

if exitstatus >= 0:

1317

1318

def checker_callback(self, pid, condition, command,

1319

*args, **kwargs):

1320

self.checker_callback_tag = None

1321

self.checker = None

1322

if os.WIFEXITED(condition):

1323

exitstatus = os.WEXITSTATUS(condition)

1942

1324

# Emit D-Bus signal

1943

1325

self.CheckerCompleted(dbus.Int16(exitstatus),

1944

# This is specific to GNU libC

1945

dbus.Int64(exitstatus << 8),

1326

dbus.Int64(condition),

1946

1327

dbus.String(command))

1947

1328

else:

1948

1329

# Emit D-Bus signal

1949

1330

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

1950

dbus.Int64(

1951

# This is specific to GNU libC

1952

(exitstatus << 8)

1953

| self.last_checker_signal),

1331

dbus.Int64(condition),

1954

1332

dbus.String(command))

1955

return ret

1956

1333

1334

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

1335

*args, **kwargs)

1336

1957

1337

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

1958

1338

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

1959

1339

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

1963

1343

# Emit D-Bus signal

1964

1344

self.CheckerStarted(self.current_checker_command)

1965

1345

return r

1966

1346

1967

1347

def _reset_approved(self):

1968

1348

self.approved = None

1969

1349

return False

1970

1350

1971

1351

def approve(self, value=True):

1972

1352

self.approved = value

1973

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

1974

* 1000), self._reset_approved)

1353

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

1354

* 1000), self._reset_approved)

1975

1355

self.send_changedstate()

1976

1977

# D-Bus methods, signals & properties

1978

1979

# Interfaces

1980

1981

# Signals

1982

1356

1357

## D-Bus methods, signals & properties

1358

_interface = "se.recompile.Mandos.Client"

1359

1360

## Interfaces

1361

1362

@dbus_interface_annotations(_interface)

1363

def _foo(self):

1364

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

1365

"false"}

1366

1367

## Signals

1368

1983

1369

# CheckerCompleted - signal

1984

1370

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

1985

1371

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

1986

1372

"D-Bus signal"

1987

1373

pass

1988

1374

1989

1375

# CheckerStarted - signal

1990

1376

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

1991

1377

def CheckerStarted(self, command):

1992

1378

"D-Bus signal"

1993

1379

pass

1994

1380

1995

1381

# PropertyChanged - signal

1996

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

1997

1382

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

1998

1383

def PropertyChanged(self, property, value):

1999

1384

"D-Bus signal"

2000

1385

pass

2001

1386

2002

1387

# GotSecret - signal

2003

1388

@dbus.service.signal(_interface)

2004

1389

def GotSecret(self):

2007

1392

server to mandos-client

2008

1393

"""

2009

1394

pass

2010

1395

2011

1396

# Rejected - signal

2012

1397

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

2013

1398

def Rejected(self, reason):

2014

1399

"D-Bus signal"

2015

1400

pass

2016

1401

2017

1402

# NeedApproval - signal

2018

1403

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

2019

1404

def NeedApproval(self, timeout, default):

2020

1405

"D-Bus signal"

2021

1406

return self.need_approval()

2022

2023

# Methods

2024

1407

1408

## Methods

1409

2025

1410

# Approve - method

2026

1411

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

2027

1412

def Approve(self, value):

2028

1413

self.approve(value)

2029

1414

2030

1415

# CheckedOK - method

2031

1416

@dbus.service.method(_interface)

2032

1417

def CheckedOK(self):

2033

1418

self.checked_ok()

2034

1419

2035

1420

# Enable - method

2036

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

2037

1421

@dbus.service.method(_interface)

2038

1422

def Enable(self):

2039

1423

"D-Bus method"

2040

1424

self.enable()

2041

1425

2042

1426

# StartChecker - method

2043

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

2044

1427

@dbus.service.method(_interface)

2045

1428

def StartChecker(self):

2046

1429

"D-Bus method"

2047

1430

self.start_checker()

2048

1431

2049

1432

# Disable - method

2050

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

2051

1433

@dbus.service.method(_interface)

2052

1434

def Disable(self):

2053

1435

"D-Bus method"

2054

1436

self.disable()

2055

1437

2056

1438

# StopChecker - method

2057

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

2058

1439

@dbus.service.method(_interface)

2059

1440

def StopChecker(self):

2060

1441

self.stop_checker()

2061

2062

# Properties

2063

1442

1443

## Properties

1444

2064

1445

# ApprovalPending - property

2065

1446

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

2066

1447

def ApprovalPending_dbus_property(self):

2067

1448

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

2068

1449

2069

1450

# ApprovedByDefault - property

2070

@dbus_service_property(_interface,

2071

signature="b",

1451

@dbus_service_property(_interface, signature="b",

2072

1452

access="readwrite")

2073

1453

def ApprovedByDefault_dbus_property(self, value=None):

2074

1454

if value is None: # get

2075

1455

return dbus.Boolean(self.approved_by_default)

2076

1456

self.approved_by_default = bool(value)

2077

1457

2078

1458

# ApprovalDelay - property

2079

@dbus_service_property(_interface,

2080

signature="t",

1459

@dbus_service_property(_interface, signature="t",

2081

1460

access="readwrite")

2082

1461

def ApprovalDelay_dbus_property(self, value=None):

2083

1462

if value is None: # get

2084

1463

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

2085

1464

* 1000)

2086

1465

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

2087

1466

2088

1467

# ApprovalDuration - property

2089

@dbus_service_property(_interface,

2090

signature="t",

1468

@dbus_service_property(_interface, signature="t",

2091

1469

access="readwrite")

2092

1470

def ApprovalDuration_dbus_property(self, value=None):

2093

1471

if value is None: # get

2094

1472

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

2095

1473

* 1000)

2096

1474

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

2097

1475

2098

1476

# Name - property

2099

@dbus_annotations(

2100

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

2101

1477

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

2102

1478

def Name_dbus_property(self):

2103

1479

return dbus.String(self.name)

2104

2105

# KeyID - property

2106

@dbus_annotations(

2107

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

2108

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

2109

def KeyID_dbus_property(self):

2110

return dbus.String(self.key_id)

2111

1480

2112

1481

# Fingerprint - property

2113

@dbus_annotations(

2114

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

2115

1482

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

2116

1483

def Fingerprint_dbus_property(self):

2117

1484

return dbus.String(self.fingerprint)

2118

1485

2119

1486

# Host - property

2120

@dbus_service_property(_interface,

2121

signature="s",

1487

@dbus_service_property(_interface, signature="s",

2122

1488

access="readwrite")

2123

1489

def Host_dbus_property(self, value=None):

2124

1490

if value is None: # get

2125

1491

return dbus.String(self.host)

2126

self.host = str(value)

2127

1492

self.host = unicode(value)

1493

2128

1494

# Created - property

2129

@dbus_annotations(

2130

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

2131

1495

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

2132

1496

def Created_dbus_property(self):

2133

1497

return datetime_to_dbus(self.created)

2134

1498

2135

1499

# LastEnabled - property

2136

1500

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

2137

1501

def LastEnabled_dbus_property(self):

2138

1502

return datetime_to_dbus(self.last_enabled)

2139

1503

2140

1504

# Enabled - property

2141

@dbus_service_property(_interface,

2142

signature="b",

1505

@dbus_service_property(_interface, signature="b",

2143

1506

access="readwrite")

2144

1507

def Enabled_dbus_property(self, value=None):

2145

1508

if value is None: # get

2148

1511

self.enable()

2149

1512

else:

2150

1513

self.disable()

2151

1514

2152

1515

# LastCheckedOK - property

2153

@dbus_service_property(_interface,

2154

signature="s",

1516

@dbus_service_property(_interface, signature="s",

2155

1517

access="readwrite")

2156

1518

def LastCheckedOK_dbus_property(self, value=None):

2157

1519

if value is not None:

2158

1520

self.checked_ok()

2159

1521

return

2160

1522

return datetime_to_dbus(self.last_checked_ok)

2161

1523

2162

1524

# LastCheckerStatus - property

2163

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

1525

@dbus_service_property(_interface, signature="n",

1526

access="read")

2164

1527

def LastCheckerStatus_dbus_property(self):

2165

1528

return dbus.Int16(self.last_checker_status)

2166

1529

2167

1530

# Expires - property

2168

1531

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

2169

1532

def Expires_dbus_property(self):

2170

1533

return datetime_to_dbus(self.expires)

2171

1534

2172

1535

# LastApprovalRequest - property

2173

1536

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

2174

1537

def LastApprovalRequest_dbus_property(self):

2175

1538

return datetime_to_dbus(self.last_approval_request)

2176

1539

2177

1540

# Timeout - property

2178

@dbus_service_property(_interface,

2179

signature="t",

1541

@dbus_service_property(_interface, signature="t",

2180

1542

access="readwrite")

2181

1543

def Timeout_dbus_property(self, value=None):

2182

1544

if value is None: # get

2194

1556

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

2195

1557

is None):

2196

1558

return

2197

GLib.source_remove(self.disable_initiator_tag)

2198

self.disable_initiator_tag = GLib.timeout_add(

2199

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

2200

self.disable)

2201

1559

gobject.source_remove(self.disable_initiator_tag)

1560

self.disable_initiator_tag = (

1561

gobject.timeout_add(

1562

int((self.expires - now).total_seconds()

1563

* 1000), self.disable))

1564

2202

1565

# ExtendedTimeout - property

2203

@dbus_service_property(_interface,

2204

signature="t",

1566

@dbus_service_property(_interface, signature="t",

2205

1567

access="readwrite")

2206

1568

def ExtendedTimeout_dbus_property(self, value=None):

2207

1569

if value is None: # get

2208

1570

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

2209

1571

* 1000)

2210

1572

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

2211

1573

2212

1574

# Interval - property

2213

@dbus_service_property(_interface,

2214

signature="t",

1575

@dbus_service_property(_interface, signature="t",

2215

1576

access="readwrite")

2216

1577

def Interval_dbus_property(self, value=None):

2217

1578

if value is None: # get

2221

1582

return

2222

1583

if self.enabled:

2223

1584

# Reschedule checker run

2224

GLib.source_remove(self.checker_initiator_tag)

2225

self.checker_initiator_tag = GLib.timeout_add(

2226

value, self.start_checker)

2227

self.start_checker() # Start one now, too

2228

1585

gobject.source_remove(self.checker_initiator_tag)

1586

self.checker_initiator_tag = (gobject.timeout_add

1587

(value, self.start_checker))

1588

self.start_checker() # Start one now, too

1589

2229

1590

# Checker - property

2230

@dbus_service_property(_interface,

2231

signature="s",

1591

@dbus_service_property(_interface, signature="s",

2232

1592

access="readwrite")

2233

1593

def Checker_dbus_property(self, value=None):

2234

1594

if value is None: # get

2235

1595

return dbus.String(self.checker_command)

2236

self.checker_command = str(value)

2237

1596

self.checker_command = unicode(value)

1597

2238

1598

# CheckerRunning - property

2239

@dbus_service_property(_interface,

2240

signature="b",

1599

@dbus_service_property(_interface, signature="b",

2241

1600

access="readwrite")

2242

1601

def CheckerRunning_dbus_property(self, value=None):

2243

1602

if value is None: # get

2246

1605

self.start_checker()

2247

1606

else:

2248

1607

self.stop_checker()

2249

1608

2250

1609

# ObjectPath - property

2251

@dbus_annotations(

2252

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

2253

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

2254

1610

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

2255

1611

def ObjectPath_dbus_property(self):

2256

return self.dbus_object_path # is already a dbus.ObjectPath

2257

1612

return self.dbus_object_path # is already a dbus.ObjectPath

1613

2258

1614

# Secret = property

2259

@dbus_annotations(

2260

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

2261

"invalidates"})

2262

@dbus_service_property(_interface,

2263

signature="ay",

2264

access="write",

2265

byte_arrays=True)

1615

@dbus_service_property(_interface, signature="ay",

1616

access="write", byte_arrays=True)

2266

1617

def Secret_dbus_property(self, value):

2267

self.secret = bytes(value)

2268

1618

self.secret = str(value)

1619

2269

1620

del _interface

2270

1621

2271

1622

2272

class ProxyClient:

2273

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

1623

class ProxyClient(object):

1624

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

2274

1625

self._pipe = child_pipe

2275

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

1626

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

2276

1627

if not self._pipe.recv():

2277

raise KeyError(key_id or fpr)

2278

1628

raise KeyError()

1629

2279

1630

def __getattribute__(self, name):

2280

1631

if name == '_pipe':

2281

1632

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

2284

1635

if data[0] == 'data':

2285

1636

return data[1]

2286

1637

if data[0] == 'function':

2287

2288

1638

def func(*args, **kwargs):

2289

1639

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

2290

1640

return self._pipe.recv()[1]

2291

2292

1641

return func

2293

1642

2294

1643

def __setattr__(self, name, value):

2295

1644

if name == '_pipe':

2296

1645

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

2299

1648

2300

1649

class ClientHandler(socketserver.BaseRequestHandler, object):

2301

1650

"""A class to handle client connections.

2302

1651

2303

1652

Instantiated once for each connection to handle it.

2304

1653

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

2305

1654

2306

1655

def handle(self):

2307

1656

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

2308

1657

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

2309

str(self.client_address))

1658

unicode(self.client_address))

2310

1659

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

2311

1660

self.server.child_pipe.fileno())

2312

2313

session = gnutls.ClientSession(self.request)

2314

2315

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

2316

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

2317

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

2318

# "+DHE-DSS"))

1661

1662

session = (gnutls.connection

1663

.ClientSession(self.request,

1664

gnutls.connection

1665

.X509Credentials()))

1666

1667

# Note: gnutls.connection.X509Credentials is really a

1668

# generic GnuTLS certificate credentials object so long as

1669

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

1670

# here despite using OpenPGP certificates.

1671

1672

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

1673

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

1674

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

1675

# "+DHE-DSS"))

2319

1676

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

2320

1677

priority = self.server.gnutls_priority

2321

1678

if priority is None:

2322

1679

priority = "NORMAL"

2323

gnutls.priority_set_direct(session,

2324

priority.encode("utf-8"), None)

2325

1680

(gnutls.library.functions

1681

.gnutls_priority_set_direct(session._c_object,

1682

priority, None))

1683

2326

1684

# Start communication using the Mandos protocol

2327

1685

# Get protocol number

2328

1686

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

2333

1691

except (ValueError, IndexError, RuntimeError) as error:

2334

1692

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

2335

1693

return

2336

1694

2337

1695

# Start GnuTLS connection

2338

1696

try:

2339

1697

session.handshake()

2340

except gnutls.Error as error:

1698

except gnutls.errors.GNUTLSError as error:

2341

1699

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

2342

1700

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

2343

1701

# established. Just abandon the request.

2344

1702

return

2345

1703

logger.debug("Handshake succeeded")

2346

1704

2347

1705

approval_required = False

2348

1706

try:

2349

if gnutls.has_rawpk:

2350

fpr = b""

2351

try:

2352

key_id = self.key_id(

2353

self.peer_certificate(session))

2354

except (TypeError, gnutls.Error) as error:

2355

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

2356

return

2357

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

2358

key_id.decode("utf-8",

2359

errors="replace"))

2360

2361

else:

2362

key_id = b""

2363

try:

2364

fpr = self.fingerprint(

2365

self.peer_certificate(session))

2366

except (TypeError, gnutls.Error) as error:

2367

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

2368

return

2369

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

2370

2371

try:

2372

client = ProxyClient(child_pipe, key_id, fpr,

1707

try:

1708

fpr = self.fingerprint(self.peer_certificate

1709

(session))

1710

except (TypeError,

1711

gnutls.errors.GNUTLSError) as error:

1712

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

1713

return

1714

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

1715

1716

try:

1717

client = ProxyClient(child_pipe, fpr,

2373

1718

self.client_address)

2374

1719

except KeyError:

2375

1720

return

2376

1721

2377

1722

if client.approval_delay:

2378

1723

delay = client.approval_delay

2379

1724

client.approvals_pending += 1

2380

1725

approval_required = True

2381

1726

2382

1727

while True:

2383

1728

if not client.enabled:

2384

1729

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

2385

client.name)

1730

client.name)

2386

1731

if self.server.use_dbus:

2387

1732

# Emit D-Bus signal

2388

1733

client.Rejected("Disabled")

2389

1734

return

2390

1735

2391

1736

if client.approved or not client.approval_delay:

2392

# We are approved or approval is disabled

1737

#We are approved or approval is disabled

2393

1738

break

2394

1739

elif client.approved is None:

2395

1740

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

2406

1751

# Emit D-Bus signal

2407

1752

client.Rejected("Denied")

2408

1753

return

2409

2410

# wait until timeout or approved

1754

1755

#wait until timeout or approved

2411

1756

time = datetime.datetime.now()

2412

1757

client.changedstate.acquire()

2413

1758

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

2426

1771

break

2427

1772

else:

2428

1773

delay -= time2 - time

2429

2430

try:

2431

session.send(client.secret)

2432

except gnutls.Error as error:

2433

logger.warning("gnutls send failed",

2434

exc_info=error)

2435

return

2436

1774

1775

sent_size = 0

1776

while sent_size < len(client.secret):

1777

try:

1778

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

1779

except gnutls.errors.GNUTLSError as error:

1780

logger.warning("gnutls send failed",

1781

exc_info=error)

1782

return

1783

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

1784

sent, len(client.secret)

1785

- (sent_size + sent))

1786

sent_size += sent

1787

2437

1788

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

2438

1789

# bump the timeout using extended_timeout

2439

1790

client.bump_timeout(client.extended_timeout)

2440

1791

if self.server.use_dbus:

2441

1792

# Emit D-Bus signal

2442

1793

client.GotSecret()

2443

1794

2444

1795

finally:

2445

1796

if approval_required:

2446

1797

client.approvals_pending -= 1

2447

1798

try:

2448

1799

session.bye()

2449

except gnutls.Error as error:

1800

except gnutls.errors.GNUTLSError as error:

2450

1801

logger.warning("GnuTLS bye failed",

2451

1802

exc_info=error)

2452

1803

2453

1804

@staticmethod

2454

1805

def peer_certificate(session):

2455

"Return the peer's certificate as a bytestring"

2456

try:

2457

cert_type = gnutls.certificate_type_get2(

2458

session, gnutls.CTYPE_PEERS)

2459

except AttributeError:

2460

cert_type = gnutls.certificate_type_get(session)

2461

if gnutls.has_rawpk:

2462

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2463

else:

2464

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2465

# If not a valid certificate type...

2466

if cert_type not in valid_cert_types:

2467

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

2468

valid_cert_types)

2469

# ...return invalid data

2470

return b""

1806

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

1807

# If not an OpenPGP certificate...

1808

if (gnutls.library.functions

1809

.gnutls_certificate_type_get(session._c_object)

1810

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1811

# ...do the normal thing

1812

return session.peer_certificate

2471

1813

list_size = ctypes.c_uint(1)

2472

cert_list = (gnutls.certificate_get_peers

2473

(session, ctypes.byref(list_size)))

1814

cert_list = (gnutls.library.functions

1815

.gnutls_certificate_get_peers

1816

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

2474

1817

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

2475

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

1818

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

1819

" certificate")

2476

1820

if list_size.value == 0:

2477

1821

return None

2478

1822

cert = cert_list[0]

2479

1823

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

2480

2481

@staticmethod

2482

def key_id(certificate):

2483

"Convert a certificate bytestring to a hexdigit key ID"

2484

# New GnuTLS "datum" with the public key

2485

datum = gnutls.datum_t(

2486

ctypes.cast(ctypes.c_char_p(certificate),

2487

ctypes.POINTER(ctypes.c_ubyte)),

2488

ctypes.c_uint(len(certificate)))

2489

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

2490

# New empty GnuTLS certificate

2491

pubkey = gnutls.pubkey_t()

2492

gnutls.pubkey_init(ctypes.byref(pubkey))

2493

# Import the raw public key into the certificate

2494

gnutls.pubkey_import(pubkey,

2495

ctypes.byref(datum),

2496

gnutls.X509_FMT_DER)

2497

# New buffer for the key ID

2498

buf = ctypes.create_string_buffer(32)

2499

buf_len = ctypes.c_size_t(len(buf))

2500

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

2501

gnutls.pubkey_get_key_id(

2502

pubkey,

2503

gnutls.KEYID_USE_SHA256,

2504

ctypes.cast(ctypes.byref(buf),

2505

ctypes.POINTER(ctypes.c_ubyte)),

2506

ctypes.byref(buf_len))

2507

# Deinit the certificate

2508

gnutls.pubkey_deinit(pubkey)

2509

2510

# Convert the buffer to a Python bytestring

2511

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

2512

# Convert the bytestring to hexadecimal notation

2513

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

2514

return hex_key_id

2515

1824

2516

1825

@staticmethod

2517

1826

def fingerprint(openpgp):

2518

1827

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2519

1828

# New GnuTLS "datum" with the OpenPGP public key

2520

datum = gnutls.datum_t(

2521

ctypes.cast(ctypes.c_char_p(openpgp),

2522

ctypes.POINTER(ctypes.c_ubyte)),

2523

ctypes.c_uint(len(openpgp)))

1829

datum = (gnutls.library.types

1830

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

1831

ctypes.POINTER

1832

(ctypes.c_ubyte)),

1833

ctypes.c_uint(len(openpgp))))

2524

1834

# New empty GnuTLS certificate

2525

crt = gnutls.openpgp_crt_t()

2526

gnutls.openpgp_crt_init(ctypes.byref(crt))

1835

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1836

(gnutls.library.functions

1837

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2527

1838

# Import the OpenPGP public key into the certificate

2528

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

2529

gnutls.OPENPGP_FMT_RAW)

1839

(gnutls.library.functions

1840

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

1841

gnutls.library.constants

1842

.GNUTLS_OPENPGP_FMT_RAW))

2530

1843

# Verify the self signature in the key

2531

1844

crtverify = ctypes.c_uint()

2532

gnutls.openpgp_crt_verify_self(crt, 0,

2533

ctypes.byref(crtverify))

1845

(gnutls.library.functions

1846

.gnutls_openpgp_crt_verify_self(crt, 0,

1847

ctypes.byref(crtverify)))

2534

1848

if crtverify.value != 0:

2535

gnutls.openpgp_crt_deinit(crt)

2536

raise gnutls.CertificateSecurityError(code

2537

=crtverify.value)

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1850

raise (gnutls.errors.CertificateSecurityError

1851

("Verify failed"))

2538

1852

# New buffer for the fingerprint

2539

1853

buf = ctypes.create_string_buffer(20)

2540

1854

buf_len = ctypes.c_size_t()

2541

1855

# Get the fingerprint from the certificate into the buffer

2542

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

2543

ctypes.byref(buf_len))

1856

(gnutls.library.functions

1857

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

1858

ctypes.byref(buf_len)))

2544

1859

# Deinit the certificate

2545

gnutls.openpgp_crt_deinit(crt)

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2546

1861

# Convert the buffer to a Python bytestring

2547

1862

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

2548

1863

# Convert the bytestring to hexadecimal notation

2550

1865

return hex_fpr

2551

1866

2552

1867

2553

class MultiprocessingMixIn:

1868

class MultiprocessingMixIn(object):

2554

1869

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

2555

2556

1870

def sub_process_main(self, request, address):

2557

1871

try:

2558

1872

self.finish_request(request, address)

2559

1873

except Exception:

2560

1874

self.handle_error(request, address)

2561

1875

self.close_request(request)

2562

1876

2563

1877

def process_request(self, request, address):

2564

1878

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

2565

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

2566

args=(request, address))

1879

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

1880

args = (request, address))

2567

1881

proc.start()

2568

1882

return proc

2569

1883

2570

1884

2571

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1885

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2572

1886

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

2573

2574

1887

def process_request(self, request, client_address):

2575

1888

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

2576

1889

2577

1890

This function creates a new pipe in self.pipe

2578

1891

"""

2579

1892

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2580

1893

2581

1894

proc = MultiprocessingMixIn.process_request(self, request,

2582

1895

client_address)

2583

1896

self.child_pipe.close()

2584

1897

self.add_pipe(parent_pipe, proc)

2585

1898

2586

1899

def add_pipe(self, parent_pipe, proc):

2587

1900

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

2588

1901

raise NotImplementedError()

2589

1902

2590

1903

2591

1904

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2592

socketserver.TCPServer):

1905

socketserver.TCPServer, object):

2593

1906

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

2594

1907

2595

1908

Attributes:

2596

1909

enabled: Boolean; whether this server is activated yet

2597

1910

interface: None or a network interface name (string)

2598

1911

use_ipv6: Boolean; to use IPv6 or not

2599

1912

"""

2600

2601

1913

def __init__(self, server_address, RequestHandlerClass,

2602

interface=None,

2603

use_ipv6=True,

2604

socketfd=None):

1914

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

2605

1915

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

2606

1916

creating a new one with socket.socket().

2607

1917

"""

2613

1923

self.socketfd = socketfd

2614

1924

# Save the original socket.socket() function

2615

1925

self.socket_socket = socket.socket

2616

2617

1926

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

2618

#

1927

#

2619

1928

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

2620

1929

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

2621

1930

# patching socket.socket.)

2622

#

1931

#

2623

1932

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

2624

1933

@functools.wraps(socket.socket)

2625

1934

def socket_wrapper(*args, **kwargs):

2637

1946

# socket_wrapper(), if socketfd was set.

2638

1947

socketserver.TCPServer.__init__(self, server_address,

2639

1948

RequestHandlerClass)

2640

1949

2641

1950

def server_bind(self):

2642

1951

"""This overrides the normal server_bind() function

2643

1952

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

2644

1953

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

2645

global SO_BINDTODEVICE

2646

1954

if self.interface is not None:

2647

1955

if SO_BINDTODEVICE is None:

2648

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

2649

# common enough.

2650

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

2651

SO_BINDTODEVICE = 25

2652

try:

2653

self.socket.setsockopt(

2654

socket.SOL_SOCKET, SO_BINDTODEVICE,

2655

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

2656

except socket.error as error:

2657

if error.errno == errno.EPERM:

2658

logger.error("No permission to bind to"

2659

" interface %s", self.interface)

2660

elif error.errno == errno.ENOPROTOOPT:

2661

logger.error("SO_BINDTODEVICE not available;"

2662

" cannot bind to interface %s",

2663

self.interface)

2664

elif error.errno == errno.ENODEV:

2665

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

2666

" cannot bind", self.interface)

2667

else:

2668

raise

1956

logger.error("SO_BINDTODEVICE does not exist;"

1957

" cannot bind to interface %s",

1958

self.interface)

1959

else:

1960

try:

1961

self.socket.setsockopt(socket.SOL_SOCKET,

1962

SO_BINDTODEVICE,

1963

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

1964

except socket.error as error:

1965

if error.errno == errno.EPERM:

1966

logger.error("No permission to bind to"

1967

" interface %s", self.interface)

1968

elif error.errno == errno.ENOPROTOOPT:

1969

logger.error("SO_BINDTODEVICE not available;"

1970

" cannot bind to interface %s",

1971

self.interface)

1972

elif error.errno == errno.ENODEV:

1973

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

1974

" cannot bind", self.interface)

1975

else:

1976

raise

2669

1977

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

2670

1978

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

2671

if self.server_address[1]:

2672

self.allow_reuse_address = True

2673

1979

if not self.server_address[0]:

2674

1980

if self.address_family == socket.AF_INET6:

2675

any_address = "::" # in6addr_any

1981

any_address = "::" # in6addr_any

2676

1982

else:

2677

any_address = "0.0.0.0" # INADDR_ANY

1983

any_address = "0.0.0.0" # INADDR_ANY

2678

1984

self.server_address = (any_address,

2679

1985

self.server_address[1])

2680

1986

elif not self.server_address[1]:

2681

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

1987

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

1988

0)

2682

1989

# if self.interface:

2683

1990

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

2684

1991

# 0, # port

2690

1997

2691

1998

class MandosServer(IPv6_TCPServer):

2692

1999

"""Mandos server.

2693

2000

2694

2001

Attributes:

2695

2002

clients: set of Client objects

2696

2003

gnutls_priority GnuTLS priority string

2697

2004

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

2698

2699

Assumes a GLib.MainLoop event loop.

2005

2006

Assumes a gobject.MainLoop event loop.

2700

2007

"""

2701

2702

2008

def __init__(self, server_address, RequestHandlerClass,

2703

interface=None,

2704

use_ipv6=True,

2705

clients=None,

2706

gnutls_priority=None,

2707

use_dbus=True,

2708

socketfd=None):

2009

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

2010

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

2709

2011

self.enabled = False

2710

2012

self.clients = clients

2711

2013

if self.clients is None:

2714

2016

self.gnutls_priority = gnutls_priority

2715

2017

IPv6_TCPServer.__init__(self, server_address,

2716

2018

RequestHandlerClass,

2717

interface=interface,

2718

use_ipv6=use_ipv6,

2719

socketfd=socketfd)

2720

2019

interface = interface,

2020

use_ipv6 = use_ipv6,

2021

socketfd = socketfd)

2721

2022

def server_activate(self):

2722

2023

if self.enabled:

2723

2024

return socketserver.TCPServer.server_activate(self)

2724

2025

2725

2026

def enable(self):

2726

2027

self.enabled = True

2727

2028

2728

2029

def add_pipe(self, parent_pipe, proc):

2729

2030

# Call "handle_ipc" for both data and EOF events

2730

GLib.io_add_watch(

2731

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

2732

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

2733

functools.partial(self.handle_ipc,

2734

parent_pipe=parent_pipe,

2735

proc=proc))

2736

2737

def handle_ipc(self, source, condition,

2738

parent_pipe=None,

2739

proc=None,

2740

client_object=None):

2031

gobject.io_add_watch(parent_pipe.fileno(),

2032

gobject.IO_IN | gobject.IO_HUP,

2033

functools.partial(self.handle_ipc,

2034

parent_pipe =

2035

parent_pipe,

2036

proc = proc))

2037

2038

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

2039

proc = None, client_object=None):

2741

2040

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

2742

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

2041

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

2743

2042

# Wait for other process to exit

2744

2043

proc.join()

2745

2044

return False

2746

2045

2747

2046

# Read a request from the child

2748

2047

request = parent_pipe.recv()

2749

2048

command = request[0]

2750

2049

2751

2050

if command == 'init':

2752

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

2753

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

2754

address = request[3]

2755

2756

for c in self.clients.values():

2757

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2758

"27AE41E4649B934CA495991B7852B855"):

2759

continue

2760

if key_id and c.key_id == key_id:

2761

client = c

2762

break

2763

if fpr and c.fingerprint == fpr:

2051

fpr = request[1]

2052

address = request[2]

2053

2054

for c in self.clients.itervalues():

2055

if c.fingerprint == fpr:

2764

2056

client = c

2765

2057

break

2766

2058

else:

2767

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

2768

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

2059

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

2060

"dress: %s", fpr, address)

2769

2061

if self.use_dbus:

2770

2062

# Emit D-Bus signal

2771

mandos_dbus_service.ClientNotFound(key_id or fpr,

2063

mandos_dbus_service.ClientNotFound(fpr,

2772

2064

address[0])

2773

2065

parent_pipe.send(False)

2774

2066

return False

2775

2776

GLib.io_add_watch(

2777

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

2778

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

2779

functools.partial(self.handle_ipc,

2780

parent_pipe=parent_pipe,

2781

proc=proc,

2782

client_object=client))

2067

2068

gobject.io_add_watch(parent_pipe.fileno(),

2069

gobject.IO_IN | gobject.IO_HUP,

2070

functools.partial(self.handle_ipc,

2071

parent_pipe =

2072

parent_pipe,

2073

proc = proc,

2074

client_object =

2075

client))

2783

2076

parent_pipe.send(True)

2784

2077

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

2785

2078

# same fileno

2788

2081

funcname = request[1]

2789

2082

args = request[2]

2790

2083

kwargs = request[3]

2791

2084

2792

2085

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

2793

2086

funcname)(*args,

2794

**kwargs)))

2795

2087

**kwargs)))

2088

2796

2089

if command == 'getattr':

2797

2090

attrname = request[1]

2798

if isinstance(client_object.__getattribute__(attrname),

2799

collections.abc.Callable):

2800

parent_pipe.send(('function', ))

2091

if callable(client_object.__getattribute__(attrname)):

2092

parent_pipe.send(('function',))

2801

2093

else:

2802

parent_pipe.send((

2803

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

2804

2094

parent_pipe.send(('data', client_object

2095

.__getattribute__(attrname)))

2096

2805

2097

if command == 'setattr':

2806

2098

attrname = request[1]

2807

2099

value = request[2]

2808

2100

setattr(client_object, attrname, value)

2809

2101

2810

2102

return True

2811

2103

2812

2104

2813

2105

def rfc3339_duration_to_delta(duration):

2814

2106

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

2815

2816

>>> timedelta = datetime.timedelta

2817

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

2818

True

2819

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

2820

True

2821

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

2822

True

2823

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

2824

True

2825

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

2826

True

2827

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

2828

True

2829

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

2830

True

2831

>>> del timedelta

2107

2108

>>> rfc3339_duration_to_delta("P7D")

2109

datetime.timedelta(7)

2110

>>> rfc3339_duration_to_delta("PT60S")

2111

datetime.timedelta(0, 60)

2112

>>> rfc3339_duration_to_delta("PT60M")

2113

datetime.timedelta(0, 3600)

2114

>>> rfc3339_duration_to_delta("PT24H")

2115

datetime.timedelta(1)

2116

>>> rfc3339_duration_to_delta("P1W")

2117

datetime.timedelta(7)

2118

>>> rfc3339_duration_to_delta("PT5M30S")

2119

datetime.timedelta(0, 330)

2120

>>> rfc3339_duration_to_delta("P1DT3M20S")

2121

datetime.timedelta(1, 200)

2832

2122

"""

2833

2123

2834

2124

# Parsing an RFC 3339 duration with regular expressions is not

2835

2125

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

2836

2126

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

2837

2127

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

2838

2128

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

2839

2129

# avoid excessive use of external libraries.

2840

2130

2841

2131

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

2842

Token = collections.namedtuple("Token", (

2843

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

2844

# a "group" containing digits

2845

"value", # datetime.timedelta or None

2846

"followers")) # Tokens valid after this token

2132

Token = collections.namedtuple("Token",

2133

("regexp", # To match token; if

2134

# "value" is not None,

2135

# must have a "group"

2136

# containing digits

2137

"value", # datetime.timedelta or

2138

# None

2139

"followers")) # Tokens valid after

2140

# this token

2847

2141

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

2848

2142

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

2849

2143

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

2850

2144

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

2851

2145

datetime.timedelta(seconds=1),

2852

frozenset((token_end, )))

2146

frozenset((token_end,)))

2853

2147

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

2854

2148

datetime.timedelta(minutes=1),

2855

2149

frozenset((token_second, token_end)))

2871

2165

frozenset((token_month, token_end)))

2872

2166

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

2873

2167

datetime.timedelta(weeks=1),

2874

frozenset((token_end, )))

2168

frozenset((token_end,)))

2875

2169

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

2876

2170

frozenset((token_year, token_month,

2877

2171

token_day, token_time,

2878

2172

token_week)))

2879

# Define starting values:

2880

# Value so far

2881

value = datetime.timedelta()

2173

# Define starting values

2174

value = datetime.timedelta() # Value so far

2882

2175

found_token = None

2883

# Following valid tokens

2884

followers = frozenset((token_duration, ))

2885

# String left to parse

2886

s = duration

2176

followers = frozenset((token_duration,)) # Following valid tokens

2177

s = duration # String left to parse

2887

2178

# Loop until end token is found

2888

2179

while found_token is not token_end:

2889

2180

# Search for any currently valid tokens

2905

2196

break

2906

2197

else:

2907

2198

# No currently valid tokens were found

2908

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

2909

.format(duration))

2199

raise ValueError("Invalid RFC 3339 duration")

2910

2200

# End token found

2911

2201

return value

2912

2202

2913

2203

2914

2204

def string_to_delta(interval):

2915

2205

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

2916

2917

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

2918

True

2919

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

2920

True

2921

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

2922

True

2923

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

2924

True

2925

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

2926

True

2927

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

2928

True

2206

2207

>>> string_to_delta('7d')

2208

datetime.timedelta(7)

2209

>>> string_to_delta('60s')

2210

datetime.timedelta(0, 60)

2211

>>> string_to_delta('60m')

2212

datetime.timedelta(0, 3600)

2213

>>> string_to_delta('24h')

2214

datetime.timedelta(1)

2215

>>> string_to_delta('1w')

2216

datetime.timedelta(7)

2217

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

2218

datetime.timedelta(0, 330)

2929

2219

"""

2930

2220

2931

2221

try:

2932

2222

return rfc3339_duration_to_delta(interval)

2933

2223

except ValueError:

2934

2224

pass

2935

2225

2936

2226

timevalue = datetime.timedelta(0)

2937

2227

for s in interval.split():

2938

2228

try:

2939

suffix = s[-1]

2229

suffix = unicode(s[-1])

2940

2230

value = int(s[:-1])

2941

2231

if suffix == "d":

2942

2232

delta = datetime.timedelta(value)

2949

2239

elif suffix == "w":

2950

2240

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

2951

2241

else:

2952

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

2242

raise ValueError("Unknown suffix {!r}"

2243

.format(suffix))

2953

2244

except IndexError as e:

2954

2245

raise ValueError(*(e.args))

2955

2246

timevalue += delta

2956

2247

return timevalue

2957

2248

2958

2249

2959

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

2250

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

2960

2251

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

2961

2252

2962

2253

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

2963

2254

if os.fork():

2964

2255

sys.exit()

2971

2262

# Close all standard open file descriptors

2972

2263

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

2973

2264

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

2974

raise OSError(errno.ENODEV,

2975

"{} not a character device"

2265

raise OSError(errno.ENODEV, "{} not a character device"

2976

2266

.format(os.devnull))

2977

2267

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

2978

2268

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

2982

2272

2983

2273

2984

2274

def main():

2985

2275

2986

2276

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

2987

2277

# Parsing of options, both command line and config file

2988

2278

2989

2279

parser = argparse.ArgumentParser()

2990

2280

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

2991

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

2281

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

2992

2282

help="show version number and exit")

2993

2283

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

2994

2284

help="Bind to interface IF")

3030

2320

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

3031

2321

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

3032

2322

default=None)

3033

2323

3034

2324

options = parser.parse_args()

3035

2325

2326

if options.check:

2327

import doctest

2328

fail_count, test_count = doctest.testmod()

2329

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

2330

3036

2331

# Default values for config file for server-global settings

3037

if gnutls.has_rawpk:

3038

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

3039

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

3040

else:

3041

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

3042

":+SIGN-DSA-SHA256")

3043

server_defaults = {"interface": "",

3044

"address": "",

3045

"port": "",

3046

"debug": "False",

3047

"priority": priority,

3048

"servicename": "Mandos",

3049

"use_dbus": "True",

3050

"use_ipv6": "True",

3051

"debuglevel": "",

3052

"restore": "True",

3053

"socket": "",

3054

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

3055

"foreground": "False",

3056

"zeroconf": "True",

3057

}

3058

del priority

3059

2332

server_defaults = { "interface": "",

2333

"address": "",

2334

"port": "",

2335

"debug": "False",

2336

"priority":

2337

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

2338

"servicename": "Mandos",

2339

"use_dbus": "True",

2340

"use_ipv6": "True",

2341

"debuglevel": "",

2342

"restore": "True",

2343

"socket": "",

2344

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

2345

"foreground": "False",

2346

"zeroconf": "True",

2347

}

2348

3060

2349

# Parse config file for server-global settings

3061

server_config = configparser.ConfigParser(server_defaults)

2350

server_config = configparser.SafeConfigParser(server_defaults)

3062

2351

del server_defaults

3063

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

3064

# Convert the ConfigParser object to a dict

2352

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

2353

"mandos.conf"))

2354

# Convert the SafeConfigParser object to a dict

3065

2355

server_settings = server_config.defaults()

3066

2356

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

3067

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

3068

"foreground", "zeroconf"):

2357

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

3069

2358

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

3070

2359

option)

3071

2360

if server_settings["port"]:

3081

2370

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

3082

2371

["socket"])

3083

2372

del server_config

3084

2373

3085

2374

# Override the settings from the config file with command line

3086

2375

# options, if set.

3087

2376

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

3088

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

3089

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

3090

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

2377

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

2378

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

2379

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

3091

2380

value = getattr(options, option)

3092

2381

if value is not None:

3093

2382

server_settings[option] = value

3094

2383

del options

3095

2384

# Force all strings to be unicode

3096

2385

for option in server_settings.keys():

3097

if isinstance(server_settings[option], bytes):

3098

server_settings[option] = (server_settings[option]

3099

.decode("utf-8"))

2386

if type(server_settings[option]) is str:

2387

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

3100

2388

# Force all boolean options to be boolean

3101

2389

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

3102

2390

"foreground", "zeroconf"):

3105

2393

if server_settings["debug"]:

3106

2394

server_settings["foreground"] = True

3107

2395

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

3108

2396

3109

2397

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

3110

3111

if (not server_settings["zeroconf"]

3112

and not (server_settings["port"]

3113

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

3114

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

3115

2398

2399

if (not server_settings["zeroconf"] and

2400

not (server_settings["port"]

2401

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

2402

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

2403

" Zeroconf")

2404

3116

2405

# For convenience

3117

2406

debug = server_settings["debug"]

3118

2407

debuglevel = server_settings["debuglevel"]

3122

2411

stored_state_file)

3123

2412

foreground = server_settings["foreground"]

3124

2413

zeroconf = server_settings["zeroconf"]

3125

2414

3126

2415

if debug:

3127

2416

initlogger(debug, logging.DEBUG)

3128

2417

else:

3131

2420

else:

3132

2421

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

3133

2422

initlogger(debug, level)

3134

2423

3135

2424

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

3136

syslogger.setFormatter(

3137

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

3138

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

3139

server_settings["servicename"])))

3140

2425

syslogger.setFormatter(logging.Formatter

2426

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

2427

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

2428

.format(server_settings

2429

["servicename"])))

2430

3141

2431

# Parse config file with clients

3142

client_config = configparser.ConfigParser(Client.client_defaults)

2432

client_config = configparser.SafeConfigParser(Client

2433

.client_defaults)

3143

2434

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

3144

2435

"clients.conf"))

3145

2436

3146

2437

global mandos_dbus_service

3147

2438

mandos_dbus_service = None

3148

2439

3149

2440

socketfd = None

3150

2441

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

3151

2442

socketfd = server_settings["socket"]

3152

tcp_server = MandosServer(

3153

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

3154

ClientHandler,

3155

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

3156

use_ipv6=use_ipv6,

3157

gnutls_priority=server_settings["priority"],

3158

use_dbus=use_dbus,

3159

socketfd=socketfd)

2443

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

2444

server_settings["port"]),

2445

ClientHandler,

2446

interface=(server_settings["interface"]

2447

or None),

2448

use_ipv6=use_ipv6,

2449

gnutls_priority=

2450

server_settings["priority"],

2451

use_dbus=use_dbus,

2452

socketfd=socketfd)

3160

2453

if not foreground:

3161

2454

pidfilename = "/run/mandos.pid"

3162

2455

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

3163

2456

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

3164

2457

pidfile = None

3165

2458

try:

3166

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

2459

pidfile = open(pidfilename, "w")

3167

2460

except IOError as e:

3168

2461

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

3169

2462

exc_info=e)

3170

3171

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

3172

("mandos", "mandos"),

3173

("nobody", "nogroup")):

2463

2464

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

3174

2465

try:

3175

2466

uid = pwd.getpwnam(name).pw_uid

3176

gid = pwd.getpwnam(group).pw_gid

2467

gid = pwd.getpwnam(name).pw_gid

3177

2468

break

3178

2469

except KeyError:

3179

2470

continue

3183

2474

try:

3184

2475

os.setgid(gid)

3185

2476

os.setuid(uid)

3186

if debug:

3187

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

3188

gid))

3189

2477

except OSError as error:

3190

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

3191

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

3192

2478

if error.errno != errno.EPERM:

3193

2479

raise

3194

2480

3195

2481

if debug:

3196

2482

# Enable all possible GnuTLS debugging

3197

2483

3198

2484

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

3199

2485

# - GnuTLS manual

3200

gnutls.global_set_log_level(11)

3201

3202

@gnutls.log_func

2486

gnutls.library.functions.gnutls_global_set_log_level(11)

2487

2488

@gnutls.library.types.gnutls_log_func

3203

2489

def debug_gnutls(level, string):

3204

logger.debug("GnuTLS: %s",

3205

string[:-1].decode("utf-8",

3206

errors="replace"))

3207

3208

gnutls.global_set_log_function(debug_gnutls)

3209

2490

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

2491

2492

(gnutls.library.functions

2493

.gnutls_global_set_log_function(debug_gnutls))

2494

3210

2495

# Redirect stdin so all checkers get /dev/null

3211

2496

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

3212

2497

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

3213

2498

if null > 2:

3214

2499

os.close(null)

3215

2500

3216

2501

# Need to fork before connecting to D-Bus

3217

2502

if not foreground:

3218

2503

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

3219

2504

daemon()

3220

3221

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

3222

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

3223

# need to inform GLib that threads will be used.

3224

GLib.threads_init()

3225

2505

2506

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

2507

# need to inform gobject that threads will be used.

2508

gobject.threads_init()

2509

3226

2510

global main_loop

3227

2511

# From the Avahi example code

3228

2512

DBusGMainLoop(set_as_default=True)

3229

main_loop = GLib.MainLoop()

2513

main_loop = gobject.MainLoop()

3230

2514

bus = dbus.SystemBus()

3231

2515

# End of Avahi example code

3232

2516

if use_dbus:

3233

2517

try:

3234

2518

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

3235

bus,

3236

do_not_queue=True)

3237

old_bus_name = dbus.service.BusName(

3238

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

3239

do_not_queue=True)

3240

except dbus.exceptions.DBusException as e:

2519

bus, do_not_queue=True)

2520

old_bus_name = (dbus.service.BusName

2521

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

2522

do_not_queue=True))

2523

except dbus.exceptions.NameExistsException as e:

3241

2524

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

3242

2525

use_dbus = False

3243

2526

server_settings["use_dbus"] = False

3244

2527

tcp_server.use_dbus = False

3245

2528

if zeroconf:

3246

2529

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3247

service = AvahiServiceToSyslog(

3248

name=server_settings["servicename"],

3249

servicetype="_mandos._tcp",

3250

protocol=protocol,

3251

bus=bus)

2530

service = AvahiServiceToSyslog(name =

2531

server_settings["servicename"],

2532

servicetype = "_mandos._tcp",

2533

protocol = protocol, bus = bus)

3252

2534

if server_settings["interface"]:

3253

service.interface = if_nametoindex(

3254

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

3255

2535

service.interface = (if_nametoindex

2536

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

2537

3256

2538

global multiprocessing_manager

3257

2539

multiprocessing_manager = multiprocessing.Manager()

3258

2540

3259

2541

client_class = Client

3260

2542

if use_dbus:

3261

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

3262

2543

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

2544

3263

2545

client_settings = Client.config_parser(client_config)

3264

2546

old_client_settings = {}

3265

2547

clients_data = {}

3266

2548

3267

2549

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

3268

2550

global wnull

3269

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

2551

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

3270

2552

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

3271

2553

# mode

3272

2554

if debug or not foreground:

3273

2555

wnull.close()

3274

2556

3275

2557

# Get client data and settings from last running state.

3276

2558

if server_settings["restore"]:

3277

2559

try:

3278

2560

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

3279

if sys.version_info.major == 2:

3280

clients_data, old_client_settings = pickle.load(

3281

stored_state)

3282

else:

3283

bytes_clients_data, bytes_old_client_settings = (

3284

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

3285

# Fix bytes to strings

3286

# clients_data

3287

# .keys()

3288

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

3289

if isinstance(key, bytes)

3290

else key): value

3291

for key, value in

3292

bytes_clients_data.items()}

3293

del bytes_clients_data

3294

for key in clients_data:

3295

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

3296

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

3297

for k, v in

3298

clients_data[key].items()}

3299

clients_data[key] = value

3300

# .client_structure

3301

value["client_structure"] = [

3302

(s.decode("utf-8")

3303

if isinstance(s, bytes)

3304

else s) for s in

3305

value["client_structure"]]

3306

# .name, .host, and .checker_command

3307

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

3308

if isinstance(value[k], bytes):

3309

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

3310

if "key_id" not in value:

3311

value["key_id"] = ""

3312

elif "fingerprint" not in value:

3313

value["fingerprint"] = ""

3314

# old_client_settings

3315

# .keys()

3316

old_client_settings = {

3317

(key.decode("utf-8")

3318

if isinstance(key, bytes)

3319

else key): value

3320

for key, value in

3321

bytes_old_client_settings.items()}

3322

del bytes_old_client_settings

3323

# .host and .checker_command

3324

for value in old_client_settings.values():

3325

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

3326

if isinstance(value[attribute], bytes):

3327

value[attribute] = (value[attribute]

3328

.decode("utf-8"))

2561

clients_data, old_client_settings = (pickle.load

2562

(stored_state))

3329

2563

os.remove(stored_state_path)

3330

2564

except IOError as e:

3331

2565

if e.errno == errno.ENOENT:

3332

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

3333

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

2566

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

2567

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

3334

2568

else:

3335

2569

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

3336

2570

exc_info=e)

3337

2571

raise

3338

2572

except EOFError as e:

3339

2573

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

3340

"EOFError:",

3341

exc_info=e)

3342

2574

"EOFError:", exc_info=e)

2575

3343

2576

with PGPEngine() as pgp:

3344

2577

for client_name, client in clients_data.items():

3345

2578

# Skip removed clients

3346

2579

if client_name not in client_settings:

3347

2580

continue

3348

2581

3349

2582

# Decide which value to use after restoring saved state.

3350

2583

# We have three different values: Old config file,

3351

2584

# new config file, and saved state.

3356

2589

# For each value in new config, check if it

3357

2590

# differs from the old config value (Except for

3358

2591

# the "secret" attribute)

3359

if (name != "secret"

3360

and (value !=

3361

old_client_settings[client_name][name])):

2592

if (name != "secret" and

2593

value != old_client_settings[client_name]

2594

[name]):

3362

2595

client[name] = value

3363

2596

except KeyError:

3364

2597

pass

3365

2598

3366

2599

# Clients who has passed its expire date can still be

3367

# enabled if its last checker was successful. A Client

2600

# enabled if its last checker was successful. Clients

3368

2601

# whose checker succeeded before we stored its state is

3369

2602

# assumed to have successfully run all checkers during

3370

2603

# downtime.

3373

2606

if not client["last_checked_ok"]:

3374

2607

logger.warning(

3375

2608

"disabling client {} - Client never "

3376

"performed a successful checker".format(

3377

client_name))

2609

"performed a successful checker"

2610

.format(client_name))

3378

2611

client["enabled"] = False

3379

2612

elif client["last_checker_status"] != 0:

3380

2613

logger.warning(

3381

2614

"disabling client {} - Client last"

3382

" checker failed with error code"

3383

" {}".format(

3384

client_name,

3385

client["last_checker_status"]))

2615

" checker failed with error code {}"

2616

.format(client_name,

2617

client["last_checker_status"]))

3386

2618

client["enabled"] = False

3387

2619

else:

3388

client["expires"] = (

3389

datetime.datetime.utcnow()

3390

+ client["timeout"])

2620

client["expires"] = (datetime.datetime

2621

.utcnow()

2622

+ client["timeout"])

3391

2623

logger.debug("Last checker succeeded,"

3392

" keeping {} enabled".format(

3393

client_name))

2624

" keeping {} enabled"

2625

.format(client_name))

3394

2626

try:

3395

client["secret"] = pgp.decrypt(

3396

client["encrypted_secret"],

3397

client_settings[client_name]["secret"])

2627

client["secret"] = (

2628

pgp.decrypt(client["encrypted_secret"],

2629

client_settings[client_name]

2630

["secret"]))

3398

2631

except PGPError:

3399

2632

# If decryption fails, we use secret from new settings

3400

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

3401

client_name))

3402

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

3403

["secret"])

3404

2633

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

2634

.format(client_name))

2635

client["secret"] = (

2636

client_settings[client_name]["secret"])

2637

3405

2638

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

3406

2639

for client_name in (set(old_client_settings)

3407

2640

- set(client_settings)):

3409

2642

for client_name in (set(client_settings)

3410

2643

- set(old_client_settings)):

3411

2644

clients_data[client_name] = client_settings[client_name]

3412

2645

3413

2646

# Create all client objects

3414

2647

for client_name, client in clients_data.items():

3415

2648

tcp_server.clients[client_name] = client_class(

3416

name=client_name,

3417

settings=client,

3418

server_settings=server_settings)

3419

2649

name = client_name, settings = client,

2650

server_settings = server_settings)

2651

3420

2652

if not tcp_server.clients:

3421

2653

logger.warning("No clients defined")

3422

2654

3423

2655

if not foreground:

3424

2656

if pidfile is not None:

3425

pid = os.getpid()

3426

2657

try:

3427

2658

with pidfile:

3428

print(pid, file=pidfile)

2659

pid = os.getpid()

2660

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

3429

2661

except IOError:

3430

2662

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

3431

2663

pidfilename, pid)

3432

2664

del pidfile

3433

2665

del pidfilename

3434

3435

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

3436

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3437

lambda: main_loop.quit() and False)

3438

2666

2667

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

2668

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

2669

3439

2670

if use_dbus:

3440

3441

@alternate_dbus_interfaces(

3442

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

3443

class MandosDBusService(DBusObjectWithObjectManager):

2671

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

2672

"se.bsnet.fukt.Mandos"})

2673

class MandosDBusService(DBusObjectWithProperties):

3444

2674

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

3445

3446

2675

def __init__(self):

3447

2676

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

3448

3449

2677

_interface = "se.recompile.Mandos"

3450

2678

2679

@dbus_interface_annotations(_interface)

2680

def _foo(self):

2681

return { "org.freedesktop.DBus.Property"

2682

".EmitsChangedSignal":

2683

"false"}

2684

3451

2685

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

3452

2686

def ClientAdded(self, objpath):

3453

2687

"D-Bus signal"

3454

2688

pass

3455

2689

3456

2690

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

3457

def ClientNotFound(self, key_id, address):

2691

def ClientNotFound(self, fingerprint, address):

3458

2692

"D-Bus signal"

3459

2693

pass

3460

3461

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

3462

"true"})

2694

3463

2695

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

3464

2696

def ClientRemoved(self, objpath, name):

3465

2697

"D-Bus signal"

3466

2698

pass

3467

3468

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

3469

"true"})

2699

3470

2700

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

3471

2701

def GetAllClients(self):

3472

2702

"D-Bus method"

3473

return dbus.Array(c.dbus_object_path for c in

3474

tcp_server.clients.values())

3475

3476

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

3477

"true"})

2703

return dbus.Array(c.dbus_object_path

2704

for c in

2705

tcp_server.clients.itervalues())

2706

3478

2707

@dbus.service.method(_interface,

3479

2708

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

3480

2709

def GetAllClientsWithProperties(self):

3481

2710

"D-Bus method"

3482

2711

return dbus.Dictionary(

3483

{c.dbus_object_path: c.GetAll(

3484

"se.recompile.Mandos.Client")

3485

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

2712

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

2713

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

3486

2714

signature="oa{sv}")

3487

2715

3488

2716

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

3489

2717

def RemoveClient(self, object_path):

3490

2718

"D-Bus method"

3491

for c in tcp_server.clients.values():

2719

for c in tcp_server.clients.itervalues():

3492

2720

if c.dbus_object_path == object_path:

3493

2721

del tcp_server.clients[c.name]

3494

2722

c.remove_from_connection()

3495

# Don't signal the disabling

2723

# Don't signal anything except ClientRemoved

3496

2724

c.disable(quiet=True)

3497

# Emit D-Bus signal for removal

3498

self.client_removed_signal(c)

2725

# Emit D-Bus signal

2726

self.ClientRemoved(object_path, c.name)

3499

2727

return

3500

2728

raise KeyError(object_path)

3501

2729

3502

2730

del _interface

3503

3504

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3505

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

3506

def GetManagedObjects(self):

3507

"""D-Bus method"""

3508

return dbus.Dictionary(

3509

{client.dbus_object_path:

3510

dbus.Dictionary(

3511

{interface: client.GetAll(interface)

3512

for interface in

3513

client._get_all_interface_names()})

3514

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

3515

3516

def client_added_signal(self, client):

3517

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

3518

if use_dbus:

3519

# New standard signal

3520

self.InterfacesAdded(

3521

client.dbus_object_path,

3522

dbus.Dictionary(

3523

{interface: client.GetAll(interface)

3524

for interface in

3525

client._get_all_interface_names()}))

3526

# Old signal

3527

self.ClientAdded(client.dbus_object_path)

3528

3529

def client_removed_signal(self, client):

3530

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

3531

if use_dbus:

3532

# New standard signal

3533

self.InterfacesRemoved(

3534

client.dbus_object_path,

3535

client._get_all_interface_names())

3536

# Old signal

3537

self.ClientRemoved(client.dbus_object_path,

3538

client.name)

3539

2731

3540

2732

mandos_dbus_service = MandosDBusService()

3541

3542

# Save modules to variables to exempt the modules from being

3543

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

3544

mp = multiprocessing

3545

wn = wnull

3546

2733

3547

2734

def cleanup():

3548

2735

"Cleanup function; run on exit"

3549

2736

if zeroconf:

3550

2737

service.cleanup()

3551

3552

mp.active_children()

3553

wn.close()

2738

2739

multiprocessing.active_children()

2740

wnull.close()

3554

2741

if not (tcp_server.clients or client_settings):

3555

2742

return

3556

2743

3557

2744

# Store client before exiting. Secrets are encrypted with key

3558

2745

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

3559

2746

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

3560

2747

clients = {}

3561

2748

with PGPEngine() as pgp:

3562

for client in tcp_server.clients.values():

2749

for client in tcp_server.clients.itervalues():

3563

2750

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

3564

2751

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

3565

2752

key)

3566

2753

client_dict = {}

3567

2754

3568

2755

# A list of attributes that can not be pickled

3569

2756

# + secret.

3570

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

3571

"checker", "server_settings"}

3572

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

3573

.Object):

2757

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

2758

"checker", "server_settings" }

2759

for name, typ in (inspect.getmembers

2760

(dbus.service.Object)):

3574

2761

exclude.add(name)

3575

2762

3576

2763

client_dict["encrypted_secret"] = (client

3577

2764

.encrypted_secret)

3578

2765

for attr in client.client_structure:

3579

2766

if attr not in exclude:

3580

2767

client_dict[attr] = getattr(client, attr)

3581

2768

3582

2769

clients[client.name] = client_dict

3583

2770

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

3584

2771

3585

2772

try:

3586

with tempfile.NamedTemporaryFile(

3587

mode='wb',

3588

suffix=".pickle",

3589

prefix='clients-',

3590

dir=os.path.dirname(stored_state_path),

3591

delete=False) as stored_state:

3592

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

3593

protocol=2)

3594

tempname = stored_state.name

2773

with (tempfile.NamedTemporaryFile

2774

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

2775

dir=os.path.dirname(stored_state_path),

2776

delete=False)) as stored_state:

2777

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

2778

tempname=stored_state.name

3595

2779

os.rename(tempname, stored_state_path)

3596

2780

except (IOError, OSError) as e:

3597

2781

if not debug:

3606

2790

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

3607

2791

exc_info=e)

3608

2792

raise

3609

2793

3610

2794

# Delete all clients, and settings from config

3611

2795

while tcp_server.clients:

3612

2796

name, client = tcp_server.clients.popitem()

3613

2797

if use_dbus:

3614

2798

client.remove_from_connection()

3615

# Don't signal the disabling

2799

# Don't signal anything except ClientRemoved

3616

2800

client.disable(quiet=True)

3617

# Emit D-Bus signal for removal

3618

2801

if use_dbus:

3619

mandos_dbus_service.client_removed_signal(client)

2802

# Emit D-Bus signal

2803

mandos_dbus_service.ClientRemoved(client

2804

.dbus_object_path,

2805

client.name)

3620

2806

client_settings.clear()

3621

2807

3622

2808

atexit.register(cleanup)

3623

3624

for client in tcp_server.clients.values():

2809

2810

for client in tcp_server.clients.itervalues():

3625

2811

if use_dbus:

3626

# Emit D-Bus signal for adding

3627

mandos_dbus_service.client_added_signal(client)

2812

# Emit D-Bus signal

2813

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3628

2814

# Need to initiate checking of clients

3629

2815

if client.enabled:

3630

2816

client.init_checker()

3631

2817

3632

2818

tcp_server.enable()

3633

2819

tcp_server.server_activate()

3634

2820

3635

2821

# Find out what port we got

3636

2822

if zeroconf:

3637

2823

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

3642

2828

else: # IPv4

3643

2829

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

3644

2830

*tcp_server.socket.getsockname())

3645

3646

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

3647

2831

2832

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

2833

3648

2834

try:

3649

2835

if zeroconf:

3650

2836

# From the Avahi example code

3655

2841

cleanup()

3656

2842

sys.exit(1)

3657

2843

# End of Avahi example code

3658

3659

GLib.io_add_watch(

3660

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

3661

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3662

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

3663

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

3664

2844

2845

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

2846

lambda *args, **kwargs:

2847

(tcp_server.handle_request

2848

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

2849

3665

2850

logger.debug("Starting main loop")

3666

2851

main_loop.run()

3667

2852

except AvahiError as error:

3676

2861

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

3677

2862

cleanup()

3678

2863

3679

3680

def should_only_run_tests():

3681

parser = argparse.ArgumentParser(add_help=False)

3682

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

3683

args, unknown_args = parser.parse_known_args()

3684

run_tests = args.check

3685

if run_tests:

3686

# Remove --check argument from sys.argv

3687

sys.argv[1:] = unknown_args

3688

return run_tests

3689

3690

# Add all tests from doctest strings

3691

def load_tests(loader, tests, none):

3692

import doctest

3693

tests.addTests(doctest.DocTestSuite())

3694

return tests

3695

3696

2864

if __name__ == '__main__':

3697

try:

3698

if should_only_run_tests():

3699

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

3700

unittest.main()

3701

else:

3702

main()

3703

finally:

3704

logging.shutdown()

2865

main()