/mandos/release : revision 237.7.217

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import unittest

81

import random

82

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

89

SO_BINDTODEVICE = None

90

91

version = "1.6.4"

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

187

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

116

117

syslogger = (logging.handlers.SysLogHandler

118

(facility =

119

logging.handlers.SysLogHandler.LOG_DAEMON,

120

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

191

121

syslogger.setFormatter(logging.Formatter

192

122

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

193

123

' %(message)s'))

194

124

logger.addHandler(syslogger)

195

125

196

126

if debug:

197

127

console = logging.StreamHandler()

198

128

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

208

138

pass

209

139

210

140

211

class PGPEngine:

141

class PGPEngine(object):

212

142

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

213

214

143

def __init__(self):

215

144

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

145

self.gnupgargs = ['--batch',

228

'--homedir', self.tempdir,

146

'--home', self.tempdir,

229

147

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

148

'--quiet',

149

'--no-use-agent']

150

235

151

def __enter__(self):

236

152

return self

237

153

238

154

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

239

155

self._cleanup()

240

156

return False

241

157

242

158

def __del__(self):

243

159

self._cleanup()

244

160

245

161

def _cleanup(self):

246

162

if self.tempdir is not None:

247

163

# Delete contents of tempdir

248

164

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

249

topdown=False):

165

topdown = False):

250

166

for filename in files:

251

167

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

252

168

for dirname in dirs:

254

170

# Remove tempdir

255

171

os.rmdir(self.tempdir)

256

172

self.tempdir = None

257

173

258

174

def password_encode(self, password):

259

175

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

260

176

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

265

181

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

266

182

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

267

183

return encoded

268

184

269

185

def encrypt(self, data, password):

270

186

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

187

with tempfile.NamedTemporaryFile(dir=self.tempdir

188

) as passfile:

273

189

passfile.write(passphrase)

274

190

passfile.flush()

275

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

191

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

276

192

'--passphrase-file',

277

193

passfile.name]

278

194

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

195

stdin = subprocess.PIPE,

196

stdout = subprocess.PIPE,

197

stderr = subprocess.PIPE)

198

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

283

199

if proc.returncode != 0:

284

200

raise PGPError(err)

285

201

return ciphertext

286

202

287

203

def decrypt(self, data, password):

288

204

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

205

with tempfile.NamedTemporaryFile(dir = self.tempdir

206

) as passfile:

291

207

passfile.write(passphrase)

292

208

passfile.flush()

293

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

209

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

294

210

'--passphrase-file',

295

211

passfile.name]

296

212

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

213

stdin = subprocess.PIPE,

214

stdout = subprocess.PIPE,

215

stderr = subprocess.PIPE)

216

decrypted_plaintext, err = proc.communicate(input

217

= data)

301

218

if proc.returncode != 0:

302

219

raise PGPError(err)

303

220

return decrypted_plaintext

304

221

305

222

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

223

class AvahiError(Exception):

333

224

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

334

225

self.value = value

335

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

336

**kwargs)

337

226

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

227

def __unicode__(self):

228

return unicode(repr(self.value))

338

229

339

230

class AvahiServiceError(AvahiError):

340

231

pass

341

232

342

343

233

class AvahiGroupError(AvahiError):

344

234

pass

345

235

346

236

347

class AvahiService:

237

class AvahiService(object):

348

238

"""An Avahi (Zeroconf) service.

349

239

350

240

Attributes:

351

241

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

352

242

Used to optionally bind to the specified interface.

364

254

server: D-Bus Server

365

255

bus: dbus.SystemBus()

366

256

"""

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):

257

258

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

259

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

260

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

261

protocol = avahi.PROTO_UNSPEC, bus = None):

379

262

self.interface = interface

380

263

self.name = name

381

264

self.type = servicetype

390

273

self.server = None

391

274

self.bus = bus

392

275

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

276

277

def rename(self):

395

278

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

396

279

if self.rename_count >= self.max_renames:

397

280

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

398

281

" after %i retries, exiting.",

399

282

self.rename_count)

400

283

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

284

self.name = unicode(self.server

285

.GetAlternativeServiceName(self.name))

404

286

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

405

287

self.name)

406

if remove:

407

self.remove()

288

self.remove()

408

289

try:

409

290

self.add()

410

291

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

292

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

293

self.cleanup()

294

os._exit(1)

295

self.rename_count += 1

296

420

297

def remove(self):

421

298

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

422

299

if self.entry_group_state_changed_match is not None:

424

301

self.entry_group_state_changed_match = None

425

302

if self.group is not None:

426

303

self.group.Reset()

427

304

428

305

def add(self):

429

306

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

430

307

self.remove()

447

324

dbus.UInt16(self.port),

448

325

avahi.string_array_to_txt_array(self.TXT))

449

326

self.group.Commit()

450

327

451

328

def entry_group_state_changed(self, state, error):

452

329

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

453

330

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

454

331

455

332

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

333

logger.debug("Zeroconf service established.")

457

334

elif state == avahi.ENTRY_GROUP_COLLISION:

459

336

self.rename()

460

337

elif state == avahi.ENTRY_GROUP_FAILURE:

461

338

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

462

str(error))

463

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

464

339

unicode(error))

340

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

341

.format(error))

342

465

343

def cleanup(self):

466

344

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

467

345

if self.group is not None:

472

350

pass

473

351

self.group = None

474

352

self.remove()

475

353

476

354

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

477

355

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

478

356

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

}

357

bad_states = { avahi.SERVER_INVALID:

358

"Zeroconf server invalid",

359

avahi.SERVER_REGISTERING: None,

360

avahi.SERVER_COLLISION:

361

"Zeroconf server name collision",

362

avahi.SERVER_FAILURE:

363

"Zeroconf server failure" }

485

364

if state in bad_states:

486

365

if bad_states[state] is not None:

487

366

if error is None:

490

369

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

491

370

self.cleanup()

492

371

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)

372

self.add()

505

373

else:

506

374

if error is None:

507

375

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

508

376

else:

509

377

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

510

378

511

379

def activate(self):

512

380

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

513

381

if self.server is None:

517

385

follow_name_owner_changes=True),

518

386

avahi.DBUS_INTERFACE_SERVER)

519

387

self.server.connect_to_signal("StateChanged",

520

self.server_state_changed)

388

self.server_state_changed)

521

389

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

522

390

523

391

524

392

class AvahiServiceToSyslog(AvahiService):

525

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

393

def rename(self):

526

394

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

527

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

528

syslogger.setFormatter(logging.Formatter(

529

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

530

.format(self.name)))

395

ret = AvahiService.rename(self)

396

syslogger.setFormatter(logging.Formatter

397

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

398

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

399

.format(self.name)))

531

400

return ret

532

401

533

402

534

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

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

539

if library is None:

540

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

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

544

# Unless otherwise indicated, the constants and types below are

545

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

546

547

# Constants

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

CLIENT = 2

554

SHUT_RDWR = 0

555

CRD_CERTIFICATE = 1

556

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

564

# Types

565

class session_int(ctypes.Structure):

566

_fields_ = []

567

session_t = ctypes.POINTER(session_int)

568

569

class certificate_credentials_st(ctypes.Structure):

570

_fields_ = []

571

certificate_credentials_t = ctypes.POINTER(

572

certificate_credentials_st)

573

certificate_type_t = ctypes.c_int

574

575

class datum_t(ctypes.Structure):

576

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

577

('size', ctypes.c_uint)]

578

579

class openpgp_crt_int(ctypes.Structure):

580

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

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

584

credentials_type_t = ctypes.c_int

585

transport_ptr_t = ctypes.c_void_p

586

close_request_t = ctypes.c_int

587

588

# Exceptions

589

class Error(Exception):

590

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

591

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

592

# code is passed, convert it to a string with

593

# gnutls.strerror()

594

self.code = code

595

if message is None and code is not None:

596

message = gnutls.strerror(code)

597

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

598

message, *args)

599

600

class CertificateSecurityError(Error):

601

pass

602

603

# Classes

604

class Credentials:

605

def __init__(self):

606

self._c_object = gnutls.certificate_credentials_t()

607

gnutls.certificate_allocate_credentials(

608

ctypes.byref(self._c_object))

609

self.type = gnutls.CRD_CERTIFICATE

610

611

def __del__(self):

612

gnutls.certificate_free_credentials(self._c_object)

613

614

class ClientSession:

615

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

616

self._c_object = gnutls.session_t()

617

gnutls_flags = gnutls.CLIENT

618

if gnutls.check_version(b"3.5.6"):

619

gnutls_flags |= gnutls.NO_TICKETS

620

if gnutls.has_rawpk:

621

gnutls_flags |= gnutls.ENABLE_RAWPK

622

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

623

del gnutls_flags

624

gnutls.set_default_priority(self._c_object)

625

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

626

gnutls.handshake_set_private_extensions(self._c_object,

627

True)

628

self.socket = socket

629

if credentials is None:

630

credentials = gnutls.Credentials()

631

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

632

ctypes.cast(credentials._c_object,

633

ctypes.c_void_p))

634

self.credentials = credentials

635

636

def __del__(self):

637

gnutls.deinit(self._c_object)

638

639

def handshake(self):

640

return gnutls.handshake(self._c_object)

641

642

def send(self, data):

643

data = bytes(data)

644

data_len = len(data)

645

while data_len > 0:

646

data_len -= gnutls.record_send(self._c_object,

647

data[-data_len:],

648

data_len)

649

650

def bye(self):

651

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

652

653

# Error handling functions

654

def _error_code(result):

655

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

656

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

657

if result >= 0:

658

return result

659

if result == gnutls.E_NO_CERTIFICATE_FOUND:

660

raise gnutls.CertificateSecurityError(code=result)

661

raise gnutls.Error(code=result)

662

663

def _retry_on_error(result, func, arguments):

664

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

665

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

666

while result < 0:

667

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

668

return _error_code(result)

669

result = func(*arguments)

670

return result

671

672

# Unless otherwise indicated, the function declarations below are

673

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

674

675

# Functions

676

priority_set_direct = _library.gnutls_priority_set_direct

677

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

678

ctypes.POINTER(ctypes.c_char_p)]

679

priority_set_direct.restype = _error_code

680

681

init = _library.gnutls_init

682

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

683

init.restype = _error_code

684

685

set_default_priority = _library.gnutls_set_default_priority

686

set_default_priority.argtypes = [session_t]

687

set_default_priority.restype = _error_code

688

689

record_send = _library.gnutls_record_send

690

record_send.argtypes = [session_t, ctypes.c_void_p,

691

ctypes.c_size_t]

692

record_send.restype = ctypes.c_ssize_t

693

record_send.errcheck = _retry_on_error

694

695

certificate_allocate_credentials = (

696

_library.gnutls_certificate_allocate_credentials)

697

certificate_allocate_credentials.argtypes = [

698

ctypes.POINTER(certificate_credentials_t)]

699

certificate_allocate_credentials.restype = _error_code

700

701

certificate_free_credentials = (

702

_library.gnutls_certificate_free_credentials)

703

certificate_free_credentials.argtypes = [

704

certificate_credentials_t]

705

certificate_free_credentials.restype = None

706

707

handshake_set_private_extensions = (

708

_library.gnutls_handshake_set_private_extensions)

709

handshake_set_private_extensions.argtypes = [session_t,

710

ctypes.c_int]

711

handshake_set_private_extensions.restype = None

712

713

credentials_set = _library.gnutls_credentials_set

714

credentials_set.argtypes = [session_t, credentials_type_t,

715

ctypes.c_void_p]

716

credentials_set.restype = _error_code

717

718

strerror = _library.gnutls_strerror

719

strerror.argtypes = [ctypes.c_int]

720

strerror.restype = ctypes.c_char_p

721

722

certificate_type_get = _library.gnutls_certificate_type_get

723

certificate_type_get.argtypes = [session_t]

724

certificate_type_get.restype = _error_code

725

726

certificate_get_peers = _library.gnutls_certificate_get_peers

727

certificate_get_peers.argtypes = [session_t,

728

ctypes.POINTER(ctypes.c_uint)]

729

certificate_get_peers.restype = ctypes.POINTER(datum_t)

730

731

global_set_log_level = _library.gnutls_global_set_log_level

732

global_set_log_level.argtypes = [ctypes.c_int]

733

global_set_log_level.restype = None

734

735

global_set_log_function = _library.gnutls_global_set_log_function

736

global_set_log_function.argtypes = [log_func]

737

global_set_log_function.restype = None

738

739

deinit = _library.gnutls_deinit

740

deinit.argtypes = [session_t]

741

deinit.restype = None

742

743

handshake = _library.gnutls_handshake

744

handshake.argtypes = [session_t]

745

handshake.restype = _error_code

746

handshake.errcheck = _retry_on_error

747

748

transport_set_ptr = _library.gnutls_transport_set_ptr

749

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

750

transport_set_ptr.restype = None

751

752

bye = _library.gnutls_bye

753

bye.argtypes = [session_t, close_request_t]

754

bye.restype = _error_code

755

bye.errcheck = _retry_on_error

756

757

check_version = _library.gnutls_check_version

758

check_version.argtypes = [ctypes.c_char_p]

759

check_version.restype = ctypes.c_char_p

760

761

_need_version = b"3.3.0"

762

if check_version(_need_version) is None:

763

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

764

.format(_need_version))

765

766

_tls_rawpk_version = b"3.6.6"

767

has_rawpk = bool(check_version(_tls_rawpk_version))

768

769

if has_rawpk:

770

# Types

771

class pubkey_st(ctypes.Structure):

772

_fields = []

773

pubkey_t = ctypes.POINTER(pubkey_st)

774

775

x509_crt_fmt_t = ctypes.c_int

776

777

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

778

pubkey_init = _library.gnutls_pubkey_init

779

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

780

pubkey_init.restype = _error_code

781

782

pubkey_import = _library.gnutls_pubkey_import

783

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

784

x509_crt_fmt_t]

785

pubkey_import.restype = _error_code

786

787

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

788

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

789

ctypes.POINTER(ctypes.c_ubyte),

790

ctypes.POINTER(ctypes.c_size_t)]

791

pubkey_get_key_id.restype = _error_code

792

793

pubkey_deinit = _library.gnutls_pubkey_deinit

794

pubkey_deinit.argtypes = [pubkey_t]

795

pubkey_deinit.restype = None

796

else:

797

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

798

799

openpgp_crt_init = _library.gnutls_openpgp_crt_init

800

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

801

openpgp_crt_init.restype = _error_code

802

803

openpgp_crt_import = _library.gnutls_openpgp_crt_import

804

openpgp_crt_import.argtypes = [openpgp_crt_t,

805

ctypes.POINTER(datum_t),

806

openpgp_crt_fmt_t]

807

openpgp_crt_import.restype = _error_code

808

809

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

810

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

811

ctypes.POINTER(ctypes.c_uint)]

812

openpgp_crt_verify_self.restype = _error_code

813

814

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

815

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

816

openpgp_crt_deinit.restype = None

817

818

openpgp_crt_get_fingerprint = (

819

_library.gnutls_openpgp_crt_get_fingerprint)

820

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

821

ctypes.c_void_p,

822

ctypes.POINTER(

823

ctypes.c_size_t)]

824

openpgp_crt_get_fingerprint.restype = _error_code

825

826

if check_version(b"3.6.4"):

827

certificate_type_get2 = _library.gnutls_certificate_type_get2

828

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

829

certificate_type_get2.restype = _error_code

830

831

# Remove non-public functions

832

del _error_code, _retry_on_error

833

834

835

def call_pipe(connection, # : multiprocessing.Connection

836

func, *args, **kwargs):

837

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

838

839

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

840

return value on the provided multiprocessing.Connection.

841

"""

842

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

843

connection.close()

844

845

846

class Client:

403

def timedelta_to_milliseconds(td):

404

"Convert a datetime.timedelta() to milliseconds"

405

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

406

+ (td.seconds * 1000)

407

+ (td.microseconds // 1000))

408

409

410

class Client(object):

847

411

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

848

412

849

413

Attributes:

850

414

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

851

415

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

852

416

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

853

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

854

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

855

running.

856

checker_callback_tag: a GLib event source tag, or None

417

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

418

to see if the client lives.

419

'None' if no process is running.

420

checker_callback_tag: a gobject event source tag, or None

857

421

checker_command: string; External command which is run to check

858

422

if client lives. %() expansions are done at

859

423

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

860

424

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

861

checker_initiator_tag: a GLib event source tag, or None

425

checker_initiator_tag: a gobject event source tag, or None

862

426

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

863

427

client_structure: Object describing what attributes a client has

864

428

and is used for storing the client at exit

865

429

current_checker_command: string; current running checker_command

866

disable_initiator_tag: a GLib event source tag, or None

430

disable_initiator_tag: a gobject event source tag, or None

867

431

enabled: bool()

868

432

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

869

uniquely identify an OpenPGP client

870

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

871

a client using raw public keys

433

uniquely identify the client

872

434

host: string; available for use by the checker command

873

435

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

874

436

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

876

438

last_checker_status: integer between 0 and 255 reflecting exit

877

439

status of last checker. -1 reflects crashed

878

440

checker, -2 means no checker completed yet.

879

last_checker_signal: The signal which killed the last checker, if

880

last_checker_status is -1

881

441

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

882

442

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

883

443

D-Bus identifiers

890

450

disabled, or None

891

451

server_settings: The server_settings dict from main()

892

452

"""

893

453

894

454

runtime_expansions = ("approval_delay", "approval_duration",

895

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

455

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

896

456

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

897

457

"last_approval_request", "last_checked_ok",

898

458

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

899

client_defaults = {

900

"timeout": "PT5M",

901

"extended_timeout": "PT15M",

902

"interval": "PT2M",

903

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

904

"host": "",

905

"approval_delay": "PT0S",

906

"approval_duration": "PT1S",

907

"approved_by_default": "True",

908

"enabled": "True",

909

}

910

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

462

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

463

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

466

"approved_by_default": "True",

467

"enabled": "True",

468

}

469

470

def timeout_milliseconds(self):

471

"Return the 'timeout' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.timeout)

473

474

def extended_timeout_milliseconds(self):

475

"Return the 'extended_timeout' attribute in milliseconds"

476

return timedelta_to_milliseconds(self.extended_timeout)

477

478

def interval_milliseconds(self):

479

"Return the 'interval' attribute in milliseconds"

480

return timedelta_to_milliseconds(self.interval)

481

482

def approval_delay_milliseconds(self):

483

return timedelta_to_milliseconds(self.approval_delay)

484

911

485

@staticmethod

912

486

def config_parser(config):

913

487

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

920

494

for client_name in config.sections():

921

495

section = dict(config.items(client_name))

922

496

client = settings[client_name] = {}

923

497

924

498

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

925

499

# Reformat values from string types to Python types

926

500

client["approved_by_default"] = config.getboolean(

927

501

client_name, "approved_by_default")

928

502

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

929

503

"enabled")

930

931

# Uppercase and remove spaces from key_id and fingerprint

932

# for later comparison purposes with return value from the

933

# key_id() and fingerprint() functions

934

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

935

.replace(" ", ""))

504

936

505

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

937

506

.replace(" ", ""))

938

507

if "secret" in section:

939

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

940

.encode("utf-8"),

941

"base64")

508

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

942

509

elif "secfile" in section:

943

510

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

944

511

(section["secfile"])),

945

512

"rb") as secfile:

946

513

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

947

514

else:

948

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

515

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

949

516

.format(section))

950

517

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

951

518

client["extended_timeout"] = string_to_delta(

959

526

client["last_approval_request"] = None

960

527

client["last_checked_ok"] = None

961

528

client["last_checker_status"] = -2

962

529

963

530

return settings

964

965

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

531

532

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

966

533

self.name = name

967

534

if server_settings is None:

968

535

server_settings = {}

969

536

self.server_settings = server_settings

970

537

# adding all client settings

971

for setting, value in settings.items():

538

for setting, value in settings.iteritems():

972

539

setattr(self, setting, value)

973

540

974

541

if self.enabled:

975

542

if not hasattr(self, "last_enabled"):

976

543

self.last_enabled = datetime.datetime.utcnow()

980

547

else:

981

548

self.last_enabled = None

982

549

self.expires = None

983

550

984

551

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

985

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

552

# Uppercase and remove spaces from fingerprint for later

553

# comparison purposes with return value from the fingerprint()

554

# function

986

555

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

987

556

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

988

557

datetime.datetime.utcnow())

989

558

990

559

# attributes specific for this server instance

991

560

self.checker = None

992

561

self.checker_initiator_tag = None

995

564

self.current_checker_command = None

996

565

self.approved = None

997

566

self.approvals_pending = 0

998

self.changedstate = multiprocessing_manager.Condition(

999

multiprocessing_manager.Lock())

1000

self.client_structure = [attr

1001

for attr in self.__dict__.keys()

567

self.changedstate = (multiprocessing_manager

568

.Condition(multiprocessing_manager

569

.Lock()))

570

self.client_structure = [attr for attr in

571

self.__dict__.iterkeys()

1002

572

if not attr.startswith("_")]

1003

573

self.client_structure.append("client_structure")

1004

1005

for name, t in inspect.getmembers(

1006

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

574

575

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

576

lambda obj:

577

isinstance(obj,

578

property)):

1007

579

if not name.startswith("_"):

1008

580

self.client_structure.append(name)

1009

581

1010

582

# Send notice to process children that client state has changed

1011

583

def send_changedstate(self):

1012

584

with self.changedstate:

1013

585

self.changedstate.notify_all()

1014

586

1015

587

def enable(self):

1016

588

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

1017

589

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

1022

594

self.last_enabled = datetime.datetime.utcnow()

1023

595

self.init_checker()

1024

596

self.send_changedstate()

1025

597

1026

598

def disable(self, quiet=True):

1027

599

"""Disable this client."""

1028

600

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

1030

602

if not quiet:

1031

603

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

1032

604

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

1033

GLib.source_remove(self.disable_initiator_tag)

605

gobject.source_remove(self.disable_initiator_tag)

1034

606

self.disable_initiator_tag = None

1035

607

self.expires = None

1036

608

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

1037

GLib.source_remove(self.checker_initiator_tag)

609

gobject.source_remove(self.checker_initiator_tag)

1038

610

self.checker_initiator_tag = None

1039

611

self.stop_checker()

1040

612

self.enabled = False

1041

613

if not quiet:

1042

614

self.send_changedstate()

1043

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

615

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

1044

616

return False

1045

617

1046

618

def __del__(self):

1047

619

self.disable()

1048

620

1049

621

def init_checker(self):

1050

622

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

1051

623

# and every interval from then on.

1052

624

if self.checker_initiator_tag is not None:

1053

GLib.source_remove(self.checker_initiator_tag)

1054

self.checker_initiator_tag = GLib.timeout_add(

1055

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

1056

+ 1)),

1057

self.start_checker)

625

gobject.source_remove(self.checker_initiator_tag)

626

self.checker_initiator_tag = (gobject.timeout_add

627

(self.interval_milliseconds(),

628

self.start_checker))

1058

629

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

1059

630

if self.disable_initiator_tag is not None:

1060

GLib.source_remove(self.disable_initiator_tag)

1061

self.disable_initiator_tag = GLib.timeout_add(

1062

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

631

gobject.source_remove(self.disable_initiator_tag)

632

self.disable_initiator_tag = (gobject.timeout_add

633

(self.timeout_milliseconds(),

634

self.disable))

1063

635

# Also start a new checker *right now*.

1064

636

self.start_checker()

1065

1066

def checker_callback(self, source, condition, connection,

1067

command):

637

638

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

1068

639

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

1069

# Read return code from connection (see call_pipe)

1070

returncode = connection.recv()

1071

connection.close()

1072

if self.checker is not None:

1073

self.checker.join()

1074

640

self.checker_callback_tag = None

1075

641

self.checker = None

1076

1077

if returncode >= 0:

1078

self.last_checker_status = returncode

1079

self.last_checker_signal = None

642

if os.WIFEXITED(condition):

643

self.last_checker_status = os.WEXITSTATUS(condition)

1080

644

if self.last_checker_status == 0:

1081

645

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

1082

646

vars(self))

1083

647

self.checked_ok()

1084

648

else:

1085

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

649

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

650

vars(self))

1086

651

else:

1087

652

self.last_checker_status = -1

1088

self.last_checker_signal = -returncode

1089

653

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

1090

654

vars(self))

1091

return False

1092

655

1093

656

def checked_ok(self):

1094

657

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

1095

658

self.last_checked_ok = datetime.datetime.utcnow()

1096

659

self.last_checker_status = 0

1097

self.last_checker_signal = None

1098

660

self.bump_timeout()

1099

661

1100

662

def bump_timeout(self, timeout=None):

1101

663

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

1102

664

if timeout is None:

1103

665

timeout = self.timeout

1104

666

if self.disable_initiator_tag is not None:

1105

GLib.source_remove(self.disable_initiator_tag)

667

gobject.source_remove(self.disable_initiator_tag)

1106

668

self.disable_initiator_tag = None

1107

669

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

1108

self.disable_initiator_tag = GLib.timeout_add(

1109

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

670

self.disable_initiator_tag = (gobject.timeout_add

671

(timedelta_to_milliseconds

672

(timeout), self.disable))

1110

673

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

1111

674

1112

675

def need_approval(self):

1113

676

self.last_approval_request = datetime.datetime.utcnow()

1114

677

1115

678

def start_checker(self):

1116

679

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

1117

680

1118

681

If a checker already exists, leave it running and do

1119

682

nothing."""

1120

683

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

1125

688

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

1126

689

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

1127

690

# should be.

1128

1129

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

1130

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

1131

self.checker.join()

1132

self.checker = None

691

692

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

693

try:

694

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

695

except AttributeError:

696

pass

697

except OSError as error:

698

if error.errno != errno.ECHILD:

699

raise

700

else:

701

if pid:

702

logger.warning("Checker was a zombie")

703

gobject.source_remove(self.checker_callback_tag)

704

self.checker_callback(pid, status,

705

self.current_checker_command)

1133

706

# Start a new checker if needed

1134

707

if self.checker is None:

1135

708

# Escape attributes for the shell

1136

escaped_attrs = {

1137

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

1138

for attr in self.runtime_expansions}

709

escaped_attrs = dict(

710

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

711

for attr in

712

self.runtime_expansions)

1139

713

try:

1140

714

command = self.checker_command % escaped_attrs

1141

715

except TypeError as error:

1142

716

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

1143

self.checker_command,

717

self.checker_command, exc_info=error)

718

return True # Try again later

719

self.current_checker_command = command

720

try:

721

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

722

command, self.name)

723

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

724

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

725

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

726

# always replaced by /dev/null.)

727

# The exception is when not debugging but nevertheless

728

# running in the foreground; use the previously

729

# created wnull.

730

popen_args = {}

731

if (not self.server_settings["debug"]

732

and self.server_settings["foreground"]):

733

popen_args.update({"stdout": wnull,

734

"stderr": wnull })

735

self.checker = subprocess.Popen(command,

736

close_fds=True,

737

shell=True, cwd="/",

738

**popen_args)

739

except OSError as error:

740

logger.error("Failed to start subprocess",

1144

741

exc_info=error)

1145

return True # Try again later

1146

self.current_checker_command = command

1147

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

1148

self.name)

1149

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

1150

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

1151

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

1152

# always replaced by /dev/null.)

1153

# The exception is when not debugging but nevertheless

1154

# running in the foreground; use the previously

1155

# created wnull.

1156

popen_args = {"close_fds": True,

1157

"shell": True,

1158

"cwd": "/"}

1159

if (not self.server_settings["debug"]

1160

and self.server_settings["foreground"]):

1161

popen_args.update({"stdout": wnull,

1162

"stderr": wnull})

1163

pipe = multiprocessing.Pipe(duplex=False)

1164

self.checker = multiprocessing.Process(

1165

target=call_pipe,

1166

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

1167

kwargs=popen_args)

1168

self.checker.start()

1169

self.checker_callback_tag = GLib.io_add_watch(

1170

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

1171

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1172

self.checker_callback, pipe[0], command)

1173

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

742

return True

743

self.checker_callback_tag = (gobject.child_watch_add

744

(self.checker.pid,

745

self.checker_callback,

746

data=command))

747

# The checker may have completed before the gobject

748

# watch was added. Check for this.

749

try:

750

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

751

except OSError as error:

752

if error.errno == errno.ECHILD:

753

# This should never happen

754

logger.error("Child process vanished",

755

exc_info=error)

756

return True

757

raise

758

if pid:

759

gobject.source_remove(self.checker_callback_tag)

760

self.checker_callback(pid, status, command)

761

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

1174

762

return True

1175

763

1176

764

def stop_checker(self):

1177

765

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

1178

766

if self.checker_callback_tag:

1179

GLib.source_remove(self.checker_callback_tag)

767

gobject.source_remove(self.checker_callback_tag)

1180

768

self.checker_callback_tag = None

1181

769

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

1182

770

return

1183

771

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

1184

self.checker.terminate()

772

try:

773

self.checker.terminate()

774

#time.sleep(0.5)

775

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

776

# self.checker.kill()

777

except OSError as error:

778

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

779

raise

1185

780

self.checker = None

1186

781

1187

782

1188

def dbus_service_property(dbus_interface,

1189

signature="v",

1190

access="readwrite",

1191

byte_arrays=False):

783

def dbus_service_property(dbus_interface, signature="v",

784

access="readwrite", byte_arrays=False):

1192

785

"""Decorators for marking methods of a DBusObjectWithProperties to

1193

786

become properties on the D-Bus.

1194

787

1195

788

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

1196

789

and with one argument by "Set".

1197

790

1198

791

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

1199

792

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

1200

793

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

1203

796

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

1204

797

if byte_arrays and signature != "ay":

1205

798

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

1206

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

1207

799

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

1208

800

def decorator(func):

1209

801

func._dbus_is_property = True

1210

802

func._dbus_interface = dbus_interface

1213

805

func._dbus_name = func.__name__

1214

806

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

1215

807

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

1216

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

808

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1217

809

return func

1218

1219

810

return decorator

1220

811

1221

812

1222

813

def dbus_interface_annotations(dbus_interface):

1223

814

"""Decorator for marking functions returning interface annotations

1224

815

1225

816

Usage:

1226

817

1227

818

@dbus_interface_annotations("org.example.Interface")

1228

819

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

1229

820

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

1230

821

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

1231

822

"false"}

1232

823

"""

1233

1234

824

def decorator(func):

1235

825

func._dbus_is_interface = True

1236

826

func._dbus_interface = dbus_interface

1237

827

func._dbus_name = dbus_interface

1238

828

return func

1239

1240

829

return decorator

1241

830

1242

831

1243

832

def dbus_annotations(annotations):

1244

833

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

1245

834

Usage:

1246

1247

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

1248

"org.freedesktop.DBus.Property."

1249

"EmitsChangedSignal": "false"})

835

1250

836

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

1251

837

access="r")

838

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

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

1252

841

def Property_dbus_property(self):

1253

842

return dbus.Boolean(False)

1254

1255

See also the DBusObjectWithAnnotations class.

1256

843

"""

1257

1258

844

def decorator(func):

1259

845

func._dbus_annotations = annotations

1260

846

return func

1261

1262

847

return decorator

1263

848

1264

849

1265

850

class DBusPropertyException(dbus.exceptions.DBusException):

1266

851

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

1267

852

"""

1268

pass

853

def __unicode__(self):

854

return unicode(str(self))

1269

855

1270

856

1271

857

class DBusPropertyAccessException(DBusPropertyException):

1280

866

pass

1281

867

1282

868

1283

class DBusObjectWithAnnotations(dbus.service.Object):

1284

"""A D-Bus object with annotations.

1285

1286

Classes inheriting from this can use the dbus_annotations

1287

decorator to add annotations to methods or signals.

869

class DBusObjectWithProperties(dbus.service.Object):

870

"""A D-Bus object with properties.

871

872

Classes inheriting from this can use the dbus_service_property

873

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

874

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

1288

875

"""

1289

876

1290

877

@staticmethod

1291

878

def _is_dbus_thing(thing):

1292

879

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

1293

880

1294

881

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

1295

882

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

1296

883

"""

1297

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

884

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

1298

885

False)

1299

886

1300

887

def _get_all_dbus_things(self, thing):

1301

888

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

1302

889

"""

1303

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

890

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

891

name),

1304

892

athing.__get__(self))

1305

893

for cls in self.__class__.__mro__

1306

894

for name, athing in

1307

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

1308

1309

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1310

out_signature="s",

1311

path_keyword='object_path',

1312

connection_keyword='connection')

1313

def Introspect(self, object_path, connection):

1314

"""Overloading of standard D-Bus method.

1315

1316

Inserts annotation tags on methods and signals.

1317

"""

1318

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

1319

connection)

1320

try:

1321

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

1322

1323

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

1324

# Add annotation tags

1325

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

1326

for tag in if_tag.getElementsByTagName(typ):

1327

annots = dict()

1328

for name, prop in (self.

1329

_get_all_dbus_things(typ)):

1330

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

1331

and prop._dbus_interface

1332

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

1333

annots.update(getattr(

1334

prop, "_dbus_annotations", {}))

1335

for name, value in annots.items():

1336

ann_tag = document.createElement(

1337

"annotation")

1338

ann_tag.setAttribute("name", name)

1339

ann_tag.setAttribute("value", value)

1340

tag.appendChild(ann_tag)

1341

# Add interface annotation tags

1342

for annotation, value in dict(

1343

itertools.chain.from_iterable(

1344

annotations().items()

1345

for name, annotations

1346

in self._get_all_dbus_things("interface")

1347

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

1348

)).items():

1349

ann_tag = document.createElement("annotation")

1350

ann_tag.setAttribute("name", annotation)

1351

ann_tag.setAttribute("value", value)

1352

if_tag.appendChild(ann_tag)

1353

# Fix argument name for the Introspect method itself

1354

if (if_tag.getAttribute("name")

1355

== dbus.INTROSPECTABLE_IFACE):

1356

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

1357

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

1358

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

1359

if (arg.getAttribute("direction")

1360

== "out"):

1361

arg.setAttribute("name",

1362

"xml_data")

1363

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

1364

document.unlink()

1365

except (AttributeError, xml.dom.DOMException,

1366

xml.parsers.expat.ExpatError) as error:

1367

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

1368

exc_info=error)

1369

return xmlstring

1370

1371

1372

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1373

"""A D-Bus object with properties.

1374

1375

Classes inheriting from this can use the dbus_service_property

1376

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

1377

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

1378

"""

1379

895

inspect.getmembers(cls,

896

self._is_dbus_thing(thing)))

897

1380

898

def _get_dbus_property(self, interface_name, property_name):

1381

899

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

1382

900

property with the specified name and interface.

1383

901

"""

1384

for cls in self.__class__.__mro__:

1385

for name, value in inspect.getmembers(

1386

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

902

for cls in self.__class__.__mro__:

903

for name, value in (inspect.getmembers

904

(cls,

905

self._is_dbus_thing("property"))):

1387

906

if (value._dbus_name == property_name

1388

907

and value._dbus_interface == interface_name):

1389

908

return value.__get__(self)

1390

909

1391

910

# No such property

1392

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

1393

self.dbus_object_path, interface_name, property_name))

1394

1395

@classmethod

1396

def _get_all_interface_names(cls):

1397

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

1398

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

1399

"_dbus_interface", None)

1400

for x in (inspect.getmro(cls))

1401

for attr in dir(x))

1402

if name is not None)

1403

1404

@dbus.service.method(dbus.PROPERTIES_IFACE,

1405

in_signature="ss",

911

raise DBusPropertyNotFound(self.dbus_object_path + ":"

912

+ interface_name + "."

913

+ property_name)

914

915

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

1406

916

out_signature="v")

1407

917

def Get(self, interface_name, property_name):

1408

918

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

1414

924

if not hasattr(value, "variant_level"):

1415

925

return value

1416

926

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

1417

927

1418

928

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

1419

929

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

1420

930

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

1427

937

# signatures other than "ay".

1428

938

if prop._dbus_signature != "ay":

1429

939

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

1430

"'ay' signature {!r}"

940

"'ay' signature {0!r}"

1431

941

.format(prop._dbus_signature))

1432

value = dbus.ByteArray(bytes(value))

942

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

943

for byte in value))

1433

944

prop(value)

1434

1435

@dbus.service.method(dbus.PROPERTIES_IFACE,

1436

in_signature="s",

945

946

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

1437

947

out_signature="a{sv}")

1438

948

def GetAll(self, interface_name):

1439

949

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

1440

950

standard.

1441

951

1442

952

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

1443

953

"""

1444

954

properties = {}

1454

964

if not hasattr(value, "variant_level"):

1455

965

properties[name] = value

1456

966

continue

1457

properties[name] = type(value)(

1458

value, variant_level=value.variant_level + 1)

967

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

968

value.variant_level+1)

1459

969

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

1460

1461

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

1462

def PropertiesChanged(self, interface_name, changed_properties,

1463

invalidated_properties):

1464

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

1465

standard.

1466

"""

1467

pass

1468

970

1469

971

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1470

972

out_signature="s",

1471

973

path_keyword='object_path',

1472

974

connection_keyword='connection')

1473

975

def Introspect(self, object_path, connection):

1474

976

"""Overloading of standard D-Bus method.

1475

977

1476

978

Inserts property tags and interface annotation tags.

1477

979

"""

1478

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1479

object_path,

1480

connection)

980

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

981

connection)

1481

982

try:

1482

983

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

1483

1484

984

def make_tag(document, name, prop):

1485

985

e = document.createElement("property")

1486

986

e.setAttribute("name", name)

1487

987

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

1488

988

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

1489

989

return e

1490

1491

990

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

1492

991

# Add property tags

1493

992

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

1496

995

if prop._dbus_interface

1497

996

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

1498

997

if_tag.appendChild(tag)

1499

# Add annotation tags for properties

1500

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

1501

annots = dict()

1502

for name, prop in self._get_all_dbus_things(

1503

"property"):

1504

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

1505

and prop._dbus_interface

1506

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

1507

annots.update(getattr(

1508

prop, "_dbus_annotations", {}))

1509

for name, value in annots.items():

1510

ann_tag = document.createElement(

1511

"annotation")

1512

ann_tag.setAttribute("name", name)

1513

ann_tag.setAttribute("value", value)

1514

tag.appendChild(ann_tag)

998

# Add annotation tags

999

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

1000

for tag in if_tag.getElementsByTagName(typ):

1001

annots = dict()

1002

for name, prop in (self.

1003

_get_all_dbus_things(typ)):

1004

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

1005

and prop._dbus_interface

1006

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

1007

annots.update(getattr

1008

(prop,

1009

"_dbus_annotations",

1010

{}))

1011

for name, value in annots.iteritems():

1012

ann_tag = document.createElement(

1013

"annotation")

1014

ann_tag.setAttribute("name", name)

1015

ann_tag.setAttribute("value", value)

1016

tag.appendChild(ann_tag)

1017

# Add interface annotation tags

1018

for annotation, value in dict(

1019

itertools.chain.from_iterable(

1020

annotations().iteritems()

1021

for name, annotations in

1022

self._get_all_dbus_things("interface")

1023

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

1024

)).iteritems():

1025

ann_tag = document.createElement("annotation")

1026

ann_tag.setAttribute("name", annotation)

1027

ann_tag.setAttribute("value", value)

1028

if_tag.appendChild(ann_tag)

1515

1029

# Add the names to the return values for the

1516

1030

# "org.freedesktop.DBus.Properties" methods

1517

1031

if (if_tag.getAttribute("name")

1536

1050

return xmlstring

1537

1051

1538

1052

1539

try:

1540

dbus.OBJECT_MANAGER_IFACE

1541

except AttributeError:

1542

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

1543

1544

1545

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1546

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

1547

1548

Classes inheriting from this exposes the standard

1549

GetManagedObjects call and the InterfacesAdded and

1550

InterfacesRemoved signals on the standard

1551

"org.freedesktop.DBus.ObjectManager" interface.

1552

1553

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

1554

manually.

1555

"""

1556

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1557

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

1558

def GetManagedObjects(self):

1559

"""This function must be overridden"""

1560

raise NotImplementedError()

1561

1562

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1563

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

1564

def InterfacesAdded(self, object_path, interfaces_and_properties):

1565

pass

1566

1567

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

1568

def InterfacesRemoved(self, object_path, interfaces):

1569

pass

1570

1571

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1572

out_signature="s",

1573

path_keyword='object_path',

1574

connection_keyword='connection')

1575

def Introspect(self, object_path, connection):

1576

"""Overloading of standard D-Bus method.

1577

1578

Override return argument name of GetManagedObjects to be

1579

"objpath_interfaces_and_properties"

1580

"""

1581

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1582

object_path,

1583

connection)

1584

try:

1585

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

1586

1587

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

1588

# Fix argument name for the GetManagedObjects method

1589

if (if_tag.getAttribute("name")

1590

== dbus.OBJECT_MANAGER_IFACE):

1591

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

1592

if (cn.getAttribute("name")

1593

== "GetManagedObjects"):

1594

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

1595

if (arg.getAttribute("direction")

1596

== "out"):

1597

arg.setAttribute(

1598

"name",

1599

"objpath_interfaces"

1600

"_and_properties")

1601

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

1602

document.unlink()

1603

except (AttributeError, xml.dom.DOMException,

1604

xml.parsers.expat.ExpatError) as error:

1605

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

1606

exc_info=error)

1607

return xmlstring

1608

1609

1610

1053

def datetime_to_dbus(dt, variant_level=0):

1611

1054

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

1612

1055

if dt is None:

1613

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

1614

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

1056

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

1057

return dbus.String(dt.isoformat(),

1058

variant_level=variant_level)

1615

1059

1616

1060

1617

1061

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1619

1063

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

1620

1064

interface names according to the "alt_interface_names" mapping.

1621

1065

Usage:

1622

1066

1623

1067

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

1624

1068

"net.example.AlternateInterface"})

1625

1069

class SampleDBusObject(dbus.service.Object):

1626

1070

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

1627

1071

def SampleDBusMethod():

1628

1072

pass

1629

1073

1630

1074

The above "SampleDBusMethod" on "SampleDBusObject" will be

1631

1075

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

1632

1076

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

1633

1077

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

1634

1078

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

1635

1079

1636

1080

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

1637

1081

(from DBusObjectWithProperties) and interfaces (from the

1638

1082

dbus_interface_annotations decorator).

1639

1083

"""

1640

1641

1084

def wrapper(cls):

1642

1085

for orig_interface_name, alt_interface_name in (

1643

alt_interface_names.items()):

1086

alt_interface_names.iteritems()):

1644

1087

attr = {}

1645

1088

interface_names = set()

1646

1089

# Go though all attributes of the class

1648

1091

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

1649

1092

# with the wrong interface name

1650

1093

if (not hasattr(attribute, "_dbus_interface")

1651

or not attribute._dbus_interface.startswith(

1652

orig_interface_name)):

1094

or not attribute._dbus_interface

1095

.startswith(orig_interface_name)):

1653

1096

continue

1654

1097

# Create an alternate D-Bus interface name based on

1655

1098

# the current name

1656

alt_interface = attribute._dbus_interface.replace(

1657

orig_interface_name, alt_interface_name)

1099

alt_interface = (attribute._dbus_interface

1100

.replace(orig_interface_name,

1101

alt_interface_name))

1658

1102

interface_names.add(alt_interface)

1659

1103

# Is this a D-Bus signal?

1660

1104

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

1661

1105

# Extract the original non-method undecorated

1662

1106

# function by black magic

1663

if sys.version_info.major == 2:

1664

nonmethod_func = (dict(

1107

nonmethod_func = (dict(

1665

1108

zip(attribute.func_code.co_freevars,

1666

attribute.__closure__))

1667

["func"].cell_contents)

1668

else:

1669

nonmethod_func = (dict(

1670

zip(attribute.__code__.co_freevars,

1671

attribute.__closure__))

1672

["func"].cell_contents)

1109

attribute.__closure__))["func"]

1110

.cell_contents)

1673

1111

# Create a new, but exactly alike, function

1674

1112

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

1675

1113

# with the alternate D-Bus interface name

1676

new_function = copy_function(nonmethod_func)

1677

new_function = (dbus.service.signal(

1678

alt_interface,

1679

attribute._dbus_signature)(new_function))

1114

new_function = (dbus.service.signal

1115

(alt_interface,

1116

attribute._dbus_signature)

1117

(types.FunctionType(

1118

nonmethod_func.func_code,

1119

nonmethod_func.func_globals,

1120

nonmethod_func.func_name,

1121

nonmethod_func.func_defaults,

1122

nonmethod_func.func_closure)))

1680

1123

# Copy annotations, if any

1681

1124

try:

1682

new_function._dbus_annotations = dict(

1683

attribute._dbus_annotations)

1125

new_function._dbus_annotations = (

1126

dict(attribute._dbus_annotations))

1684

1127

except AttributeError:

1685

1128

pass

1686

1687

1129

# Define a creator of a function to call both the

1688

1130

# original and alternate functions, so both the

1689

1131

# original and alternate signals gets sent when

1692

1134

"""This function is a scope container to pass

1693

1135

func1 and func2 to the "call_both" function

1694

1136

outside of its arguments"""

1695

1696

@functools.wraps(func2)

1697

1137

def call_both(*args, **kwargs):

1698

1138

"""This function will emit two D-Bus

1699

1139

signals by calling func1 and func2"""

1700

1140

func1(*args, **kwargs)

1701

1141

func2(*args, **kwargs)

1702

# Make wrapper function look like a D-Bus

1703

# signal

1704

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

1705

if name.startswith("_dbus_"):

1706

setattr(call_both, name, attr)

1707

1708

1142

return call_both

1709

1143

# Create the "call_both" function and add it to

1710

1144

# the class

1715

1149

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

1716

1150

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

1717

1151

# to the class.

1718

attr[attrname] = (

1719

dbus.service.method(

1720

alt_interface,

1721

attribute._dbus_in_signature,

1722

attribute._dbus_out_signature)

1723

(copy_function(attribute)))

1152

attr[attrname] = (dbus.service.method

1153

(alt_interface,

1154

attribute._dbus_in_signature,

1155

attribute._dbus_out_signature)

1156

(types.FunctionType

1157

(attribute.func_code,

1158

attribute.func_globals,

1159

attribute.func_name,

1160

attribute.func_defaults,

1161

attribute.func_closure)))

1724

1162

# Copy annotations, if any

1725

1163

try:

1726

attr[attrname]._dbus_annotations = dict(

1727

attribute._dbus_annotations)

1164

attr[attrname]._dbus_annotations = (

1165

dict(attribute._dbus_annotations))

1728

1166

except AttributeError:

1729

1167

pass

1730

1168

# Is this a D-Bus property?

1733

1171

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

1734

1172

# property with the alternate D-Bus interface

1735

1173

# name. Add it to the class.

1736

attr[attrname] = (dbus_service_property(

1737

alt_interface, attribute._dbus_signature,

1738

attribute._dbus_access,

1739

attribute._dbus_get_args_options

1740

["byte_arrays"])

1741

(copy_function(attribute)))

1174

attr[attrname] = (dbus_service_property

1175

(alt_interface,

1176

attribute._dbus_signature,

1177

attribute._dbus_access,

1178

attribute

1179

._dbus_get_args_options

1180

["byte_arrays"])

1181

(types.FunctionType

1182

(attribute.func_code,

1183

attribute.func_globals,

1184

attribute.func_name,

1185

attribute.func_defaults,

1186

attribute.func_closure)))

1742

1187

# Copy annotations, if any

1743

1188

try:

1744

attr[attrname]._dbus_annotations = dict(

1745

attribute._dbus_annotations)

1189

attr[attrname]._dbus_annotations = (

1190

dict(attribute._dbus_annotations))

1746

1191

except AttributeError:

1747

1192

pass

1748

1193

# Is this a D-Bus interface?

1751

1196

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

1752

1197

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

1753

1198

# to the class.

1754

attr[attrname] = (

1755

dbus_interface_annotations(alt_interface)

1756

(copy_function(attribute)))

1199

attr[attrname] = (dbus_interface_annotations

1200

(alt_interface)

1201

(types.FunctionType

1202

(attribute.func_code,

1203

attribute.func_globals,

1204

attribute.func_name,

1205

attribute.func_defaults,

1206

attribute.func_closure)))

1757

1207

if deprecate:

1758

1208

# Deprecate all alternate interfaces

1759

iname = "_AlternateDBusNames_interface_annotation{}"

1209

iname="_AlternateDBusNames_interface_annotation{0}"

1760

1210

for interface_name in interface_names:

1761

1762

1211

@dbus_interface_annotations(interface_name)

1763

1212

def func(self):

1764

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

1765

"true"}

1213

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

1214

"true" }

1766

1215

# Find an unused name

1767

1216

for aname in (iname.format(i)

1768

1217

for i in itertools.count()):

1772

1221

if interface_names:

1773

1222

# Replace the class with a new subclass of it with

1774

1223

# methods, signals, etc. as created above.

1775

if sys.version_info.major == 2:

1776

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

1777

(cls, ), attr)

1778

else:

1779

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

1780

(cls, ), attr)

1224

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

1225

(cls,), attr)

1781

1226

return cls

1782

1783

1227

return wrapper

1784

1228

1785

1229

1786

1230

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

1787

"se.bsnet.fukt.Mandos"})

1231

"se.bsnet.fukt.Mandos"})

1788

1232

class ClientDBus(Client, DBusObjectWithProperties):

1789

1233

"""A Client class using D-Bus

1790

1234

1791

1235

Attributes:

1792

1236

dbus_object_path: dbus.ObjectPath

1793

1237

bus: dbus.SystemBus()

1794

1238

"""

1795

1239

1796

1240

runtime_expansions = (Client.runtime_expansions

1797

+ ("dbus_object_path", ))

1798

1799

_interface = "se.recompile.Mandos.Client"

1800

1241

+ ("dbus_object_path",))

1242

1801

1243

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

1802

1803

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

1244

1245

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

1804

1246

self.bus = bus

1805

1247

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

1806

1248

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

1807

1249

# the D-Bus

1808

client_object_name = str(self.name).translate(

1250

client_object_name = unicode(self.name).translate(

1809

1251

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

1810

1252

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

1811

self.dbus_object_path = dbus.ObjectPath(

1812

"/clients/" + client_object_name)

1253

self.dbus_object_path = (dbus.ObjectPath

1254

("/clients/" + client_object_name))

1813

1255

DBusObjectWithProperties.__init__(self, self.bus,

1814

1256

self.dbus_object_path)

1815

1816

def notifychangeproperty(transform_func, dbus_name,

1817

type_func=lambda x: x,

1818

variant_level=1,

1819

invalidate_only=False,

1820

_interface=_interface):

1257

1258

def notifychangeproperty(transform_func,

1259

dbus_name, type_func=lambda x: x,

1260

variant_level=1):

1821

1261

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

1822

1262

its changes to DBus.

1823

1263

1824

1264

transform_fun: Function that takes a value and a variant_level

1825

1265

and transforms it to a D-Bus type.

1826

1266

dbus_name: D-Bus name of the variable

1828

1268

to the D-Bus. Default: no transform

1829

1269

variant_level: D-Bus variant level. Default: 1

1830

1270

"""

1831

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

1832

1271

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

1833

1272

def setter(self, value):

1834

1273

if hasattr(self, "dbus_object_path"):

1835

1274

if (not hasattr(self, attrname) or

1836

1275

type_func(getattr(self, attrname, None))

1837

1276

!= type_func(value)):

1838

if invalidate_only:

1839

self.PropertiesChanged(

1840

_interface, dbus.Dictionary(),

1841

dbus.Array((dbus_name, )))

1842

else:

1843

dbus_value = transform_func(

1844

type_func(value),

1845

variant_level=variant_level)

1846

self.PropertyChanged(dbus.String(dbus_name),

1847

dbus_value)

1848

self.PropertiesChanged(

1849

_interface,

1850

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

1851

dbus_value}),

1852

dbus.Array())

1277

dbus_value = transform_func(type_func(value),

1278

variant_level

1279

=variant_level)

1280

self.PropertyChanged(dbus.String(dbus_name),

1281

dbus_value)

1853

1282

setattr(self, attrname, value)

1854

1283

1855

1284

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

1856

1285

1857

1286

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1858

1287

approvals_pending = notifychangeproperty(dbus.Boolean,

1859

1288

"ApprovalPending",

1860

type_func=bool)

1289

type_func = bool)

1861

1290

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

1862

1291

last_enabled = notifychangeproperty(datetime_to_dbus,

1863

1292

"LastEnabled")

1864

checker = notifychangeproperty(

1865

dbus.Boolean, "CheckerRunning",

1866

type_func=lambda checker: checker is not None)

1293

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

1294

type_func = lambda checker:

1295

checker is not None)

1867

1296

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1868

1297

"LastCheckedOK")

1869

1298

last_checker_status = notifychangeproperty(dbus.Int16,

1872

1301

datetime_to_dbus, "LastApprovalRequest")

1873

1302

approved_by_default = notifychangeproperty(dbus.Boolean,

1874

1303

"ApprovedByDefault")

1875

approval_delay = notifychangeproperty(

1876

dbus.UInt64, "ApprovalDelay",

1877

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

1304

approval_delay = notifychangeproperty(dbus.UInt64,

1305

"ApprovalDelay",

1306

type_func =

1307

timedelta_to_milliseconds)

1878

1308

approval_duration = notifychangeproperty(

1879

1309

dbus.UInt64, "ApprovalDuration",

1880

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

1310

type_func = timedelta_to_milliseconds)

1881

1311

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

1882

timeout = notifychangeproperty(

1883

dbus.UInt64, "Timeout",

1884

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

1312

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

1313

type_func =

1314

timedelta_to_milliseconds)

1885

1315

extended_timeout = notifychangeproperty(

1886

1316

dbus.UInt64, "ExtendedTimeout",

1887

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

1888

interval = notifychangeproperty(

1889

dbus.UInt64, "Interval",

1890

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

1317

type_func = timedelta_to_milliseconds)

1318

interval = notifychangeproperty(dbus.UInt64,

1319

"Interval",

1320

type_func =

1321

timedelta_to_milliseconds)

1891

1322

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

1892

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

1893

invalidate_only=True)

1894

1323

1895

1324

del notifychangeproperty

1896

1325

1897

1326

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

1898

1327

try:

1899

1328

self.remove_from_connection()

1902

1331

if hasattr(DBusObjectWithProperties, "__del__"):

1903

1332

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

1904

1333

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

1905

1906

def checker_callback(self, source, condition,

1907

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

1908

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

1909

connection, command, *args,

1910

**kwargs)

1911

exitstatus = self.last_checker_status

1912

if exitstatus >= 0:

1334

1335

def checker_callback(self, pid, condition, command,

1336

*args, **kwargs):

1337

self.checker_callback_tag = None

1338

self.checker = None

1339

if os.WIFEXITED(condition):

1340

exitstatus = os.WEXITSTATUS(condition)

1913

1341

# Emit D-Bus signal

1914

1342

self.CheckerCompleted(dbus.Int16(exitstatus),

1915

# This is specific to GNU libC

1916

dbus.Int64(exitstatus << 8),

1343

dbus.Int64(condition),

1917

1344

dbus.String(command))

1918

1345

else:

1919

1346

# Emit D-Bus signal

1920

1347

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

1921

dbus.Int64(

1922

# This is specific to GNU libC

1923

(exitstatus << 8)

1924

| self.last_checker_signal),

1348

dbus.Int64(condition),

1925

1349

dbus.String(command))

1926

return ret

1927

1350

1351

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

1352

*args, **kwargs)

1353

1928

1354

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

1929

1355

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

1930

1356

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

1934

1360

# Emit D-Bus signal

1935

1361

self.CheckerStarted(self.current_checker_command)

1936

1362

return r

1937

1363

1938

1364

def _reset_approved(self):

1939

1365

self.approved = None

1940

1366

return False

1941

1367

1942

1368

def approve(self, value=True):

1943

1369

self.approved = value

1944

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

1945

* 1000), self._reset_approved)

1370

gobject.timeout_add(timedelta_to_milliseconds

1371

(self.approval_duration),

1372

self._reset_approved)

1946

1373

self.send_changedstate()

1947

1948

# D-Bus methods, signals & properties

1949

1950

# Interfaces

1951

1952

# Signals

1953

1374

1375

## D-Bus methods, signals & properties

1376

_interface = "se.recompile.Mandos.Client"

1377

1378

## Interfaces

1379

1380

@dbus_interface_annotations(_interface)

1381

def _foo(self):

1382

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

1383

"false"}

1384

1385

## Signals

1386

1954

1387

# CheckerCompleted - signal

1955

1388

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

1956

1389

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

1957

1390

"D-Bus signal"

1958

1391

pass

1959

1392

1960

1393

# CheckerStarted - signal

1961

1394

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

1962

1395

def CheckerStarted(self, command):

1963

1396

"D-Bus signal"

1964

1397

pass

1965

1398

1966

1399

# PropertyChanged - signal

1967

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

1968

1400

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

1969

1401

def PropertyChanged(self, property, value):

1970

1402

"D-Bus signal"

1971

1403

pass

1972

1404

1973

1405

# GotSecret - signal

1974

1406

@dbus.service.signal(_interface)

1975

1407

def GotSecret(self):

1978

1410

server to mandos-client

1979

1411

"""

1980

1412

pass

1981

1413

1982

1414

# Rejected - signal

1983

1415

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

1984

1416

def Rejected(self, reason):

1985

1417

"D-Bus signal"

1986

1418

pass

1987

1419

1988

1420

# NeedApproval - signal

1989

1421

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

1990

1422

def NeedApproval(self, timeout, default):

1991

1423

"D-Bus signal"

1992

1424

return self.need_approval()

1993

1994

# Methods

1995

1425

1426

## Methods

1427

1996

1428

# Approve - method

1997

1429

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

1998

1430

def Approve(self, value):

1999

1431

self.approve(value)

2000

1432

2001

1433

# CheckedOK - method

2002

1434

@dbus.service.method(_interface)

2003

1435

def CheckedOK(self):

2004

1436

self.checked_ok()

2005

1437

2006

1438

# Enable - method

2007

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

2008

1439

@dbus.service.method(_interface)

2009

1440

def Enable(self):

2010

1441

"D-Bus method"

2011

1442

self.enable()

2012

1443

2013

1444

# StartChecker - method

2014

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

2015

1445

@dbus.service.method(_interface)

2016

1446

def StartChecker(self):

2017

1447

"D-Bus method"

2018

1448

self.start_checker()

2019

1449

2020

1450

# Disable - method

2021

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

2022

1451

@dbus.service.method(_interface)

2023

1452

def Disable(self):

2024

1453

"D-Bus method"

2025

1454

self.disable()

2026

1455

2027

1456

# StopChecker - method

2028

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

2029

1457

@dbus.service.method(_interface)

2030

1458

def StopChecker(self):

2031

1459

self.stop_checker()

2032

2033

# Properties

2034

1460

1461

## Properties

1462

2035

1463

# ApprovalPending - property

2036

1464

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

2037

1465

def ApprovalPending_dbus_property(self):

2038

1466

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

2039

1467

2040

1468

# ApprovedByDefault - property

2041

@dbus_service_property(_interface,

2042

signature="b",

1469

@dbus_service_property(_interface, signature="b",

2043

1470

access="readwrite")

2044

1471

def ApprovedByDefault_dbus_property(self, value=None):

2045

1472

if value is None: # get

2046

1473

return dbus.Boolean(self.approved_by_default)

2047

1474

self.approved_by_default = bool(value)

2048

1475

2049

1476

# ApprovalDelay - property

2050

@dbus_service_property(_interface,

2051

signature="t",

1477

@dbus_service_property(_interface, signature="t",

2052

1478

access="readwrite")

2053

1479

def ApprovalDelay_dbus_property(self, value=None):

2054

1480

if value is None: # get

2055

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

2056

* 1000)

1481

return dbus.UInt64(self.approval_delay_milliseconds())

2057

1482

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

2058

1483

2059

1484

# ApprovalDuration - property

2060

@dbus_service_property(_interface,

2061

signature="t",

1485

@dbus_service_property(_interface, signature="t",

2062

1486

access="readwrite")

2063

1487

def ApprovalDuration_dbus_property(self, value=None):

2064

1488

if value is None: # get

2065

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

2066

* 1000)

1489

return dbus.UInt64(timedelta_to_milliseconds(

1490

self.approval_duration))

2067

1491

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

2068

1492

2069

1493

# Name - property

2070

@dbus_annotations(

2071

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

2072

1494

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

2073

1495

def Name_dbus_property(self):

2074

1496

return dbus.String(self.name)

2075

2076

# KeyID - property

2077

@dbus_annotations(

2078

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

2079

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

2080

def KeyID_dbus_property(self):

2081

return dbus.String(self.key_id)

2082

1497

2083

1498

# Fingerprint - property

2084

@dbus_annotations(

2085

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

2086

1499

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

2087

1500

def Fingerprint_dbus_property(self):

2088

1501

return dbus.String(self.fingerprint)

2089

1502

2090

1503

# Host - property

2091

@dbus_service_property(_interface,

2092

signature="s",

1504

@dbus_service_property(_interface, signature="s",

2093

1505

access="readwrite")

2094

1506

def Host_dbus_property(self, value=None):

2095

1507

if value is None: # get

2096

1508

return dbus.String(self.host)

2097

self.host = str(value)

2098

1509

self.host = unicode(value)

1510

2099

1511

# Created - property

2100

@dbus_annotations(

2101

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

2102

1512

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

2103

1513

def Created_dbus_property(self):

2104

1514

return datetime_to_dbus(self.created)

2105

1515

2106

1516

# LastEnabled - property

2107

1517

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

2108

1518

def LastEnabled_dbus_property(self):

2109

1519

return datetime_to_dbus(self.last_enabled)

2110

1520

2111

1521

# Enabled - property

2112

@dbus_service_property(_interface,

2113

signature="b",

1522

@dbus_service_property(_interface, signature="b",

2114

1523

access="readwrite")

2115

1524

def Enabled_dbus_property(self, value=None):

2116

1525

if value is None: # get

2119

1528

self.enable()

2120

1529

else:

2121

1530

self.disable()

2122

1531

2123

1532

# LastCheckedOK - property

2124

@dbus_service_property(_interface,

2125

signature="s",

1533

@dbus_service_property(_interface, signature="s",

2126

1534

access="readwrite")

2127

1535

def LastCheckedOK_dbus_property(self, value=None):

2128

1536

if value is not None:

2129

1537

self.checked_ok()

2130

1538

return

2131

1539

return datetime_to_dbus(self.last_checked_ok)

2132

1540

2133

1541

# LastCheckerStatus - property

2134

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

1542

@dbus_service_property(_interface, signature="n",

1543

access="read")

2135

1544

def LastCheckerStatus_dbus_property(self):

2136

1545

return dbus.Int16(self.last_checker_status)

2137

1546

2138

1547

# Expires - property

2139

1548

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

2140

1549

def Expires_dbus_property(self):

2141

1550

return datetime_to_dbus(self.expires)

2142

1551

2143

1552

# LastApprovalRequest - property

2144

1553

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

2145

1554

def LastApprovalRequest_dbus_property(self):

2146

1555

return datetime_to_dbus(self.last_approval_request)

2147

1556

2148

1557

# Timeout - property

2149

@dbus_service_property(_interface,

2150

signature="t",

1558

@dbus_service_property(_interface, signature="t",

2151

1559

access="readwrite")

2152

1560

def Timeout_dbus_property(self, value=None):

2153

1561

if value is None: # get

2154

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

1562

return dbus.UInt64(self.timeout_milliseconds())

2155

1563

old_timeout = self.timeout

2156

1564

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

2157

1565

# Reschedule disabling

2165

1573

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

2166

1574

is None):

2167

1575

return

2168

GLib.source_remove(self.disable_initiator_tag)

2169

self.disable_initiator_tag = GLib.timeout_add(

2170

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

2171

self.disable)

2172

1576

gobject.source_remove(self.disable_initiator_tag)

1577

self.disable_initiator_tag = (

1578

gobject.timeout_add(

1579

timedelta_to_milliseconds(self.expires - now),

1580

self.disable))

1581

2173

1582

# ExtendedTimeout - property

2174

@dbus_service_property(_interface,

2175

signature="t",

1583

@dbus_service_property(_interface, signature="t",

2176

1584

access="readwrite")

2177

1585

def ExtendedTimeout_dbus_property(self, value=None):

2178

1586

if value is None: # get

2179

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

2180

* 1000)

1587

return dbus.UInt64(self.extended_timeout_milliseconds())

2181

1588

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

2182

1589

2183

1590

# Interval - property

2184

@dbus_service_property(_interface,

2185

signature="t",

1591

@dbus_service_property(_interface, signature="t",

2186

1592

access="readwrite")

2187

1593

def Interval_dbus_property(self, value=None):

2188

1594

if value is None: # get

2189

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

1595

return dbus.UInt64(self.interval_milliseconds())

2190

1596

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

2191

1597

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

2192

1598

return

2193

1599

if self.enabled:

2194

1600

# Reschedule checker run

2195

GLib.source_remove(self.checker_initiator_tag)

2196

self.checker_initiator_tag = GLib.timeout_add(

2197

value, self.start_checker)

2198

self.start_checker() # Start one now, too

2199

1601

gobject.source_remove(self.checker_initiator_tag)

1602

self.checker_initiator_tag = (gobject.timeout_add

1603

(value, self.start_checker))

1604

self.start_checker() # Start one now, too

1605

2200

1606

# Checker - property

2201

@dbus_service_property(_interface,

2202

signature="s",

1607

@dbus_service_property(_interface, signature="s",

2203

1608

access="readwrite")

2204

1609

def Checker_dbus_property(self, value=None):

2205

1610

if value is None: # get

2206

1611

return dbus.String(self.checker_command)

2207

self.checker_command = str(value)

2208

1612

self.checker_command = unicode(value)

1613

2209

1614

# CheckerRunning - property

2210

@dbus_service_property(_interface,

2211

signature="b",

1615

@dbus_service_property(_interface, signature="b",

2212

1616

access="readwrite")

2213

1617

def CheckerRunning_dbus_property(self, value=None):

2214

1618

if value is None: # get

2217

1621

self.start_checker()

2218

1622

else:

2219

1623

self.stop_checker()

2220

1624

2221

1625

# ObjectPath - property

2222

@dbus_annotations(

2223

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

2224

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

2225

1626

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

2226

1627

def ObjectPath_dbus_property(self):

2227

return self.dbus_object_path # is already a dbus.ObjectPath

2228

1628

return self.dbus_object_path # is already a dbus.ObjectPath

1629

2229

1630

# Secret = property

2230

@dbus_annotations(

2231

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

2232

"invalidates"})

2233

@dbus_service_property(_interface,

2234

signature="ay",

2235

access="write",

2236

byte_arrays=True)

1631

@dbus_service_property(_interface, signature="ay",

1632

access="write", byte_arrays=True)

2237

1633

def Secret_dbus_property(self, value):

2238

self.secret = bytes(value)

2239

1634

self.secret = str(value)

1635

2240

1636

del _interface

2241

1637

2242

1638

2243

class ProxyClient:

2244

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

1639

class ProxyClient(object):

1640

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

2245

1641

self._pipe = child_pipe

2246

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

1642

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

2247

1643

if not self._pipe.recv():

2248

raise KeyError(key_id or fpr)

2249

1644

raise KeyError()

1645

2250

1646

def __getattribute__(self, name):

2251

1647

if name == '_pipe':

2252

1648

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

2255

1651

if data[0] == 'data':

2256

1652

return data[1]

2257

1653

if data[0] == 'function':

2258

2259

1654

def func(*args, **kwargs):

2260

1655

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

2261

1656

return self._pipe.recv()[1]

2262

2263

1657

return func

2264

1658

2265

1659

def __setattr__(self, name, value):

2266

1660

if name == '_pipe':

2267

1661

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

2270

1664

2271

1665

class ClientHandler(socketserver.BaseRequestHandler, object):

2272

1666

"""A class to handle client connections.

2273

1667

2274

1668

Instantiated once for each connection to handle it.

2275

1669

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

2276

1670

2277

1671

def handle(self):

2278

1672

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

2279

1673

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

2280

str(self.client_address))

1674

unicode(self.client_address))

2281

1675

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

2282

1676

self.server.child_pipe.fileno())

2283

2284

session = gnutls.ClientSession(self.request)

2285

2286

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

2287

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

2288

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

2289

# "+DHE-DSS"))

1677

1678

session = (gnutls.connection

1679

.ClientSession(self.request,

1680

gnutls.connection

1681

.X509Credentials()))

1682

1683

# Note: gnutls.connection.X509Credentials is really a

1684

# generic GnuTLS certificate credentials object so long as

1685

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

1686

# here despite using OpenPGP certificates.

1687

1688

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

1689

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

1690

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

1691

# "+DHE-DSS"))

2290

1692

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

2291

1693

priority = self.server.gnutls_priority

2292

1694

if priority is None:

2293

1695

priority = "NORMAL"

2294

gnutls.priority_set_direct(session._c_object,

2295

priority.encode("utf-8"),

2296

None)

2297

1696

(gnutls.library.functions

1697

.gnutls_priority_set_direct(session._c_object,

1698

priority, None))

1699

2298

1700

# Start communication using the Mandos protocol

2299

1701

# Get protocol number

2300

1702

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

2305

1707

except (ValueError, IndexError, RuntimeError) as error:

2306

1708

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

2307

1709

return

2308

1710

2309

1711

# Start GnuTLS connection

2310

1712

try:

2311

1713

session.handshake()

2312

except gnutls.Error as error:

1714

except gnutls.errors.GNUTLSError as error:

2313

1715

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

2314

1716

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

2315

1717

# established. Just abandon the request.

2316

1718

return

2317

1719

logger.debug("Handshake succeeded")

2318

1720

2319

1721

approval_required = False

2320

1722

try:

2321

if gnutls.has_rawpk:

2322

fpr = b""

2323

try:

2324

key_id = self.key_id(

2325

self.peer_certificate(session))

2326

except (TypeError, gnutls.Error) as error:

2327

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

2328

return

2329

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

2330

2331

else:

2332

key_id = b""

2333

try:

2334

fpr = self.fingerprint(

2335

self.peer_certificate(session))

2336

except (TypeError, gnutls.Error) as error:

2337

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

2338

return

2339

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

2340

2341

try:

2342

client = ProxyClient(child_pipe, key_id, fpr,

1723

try:

1724

fpr = self.fingerprint(self.peer_certificate

1725

(session))

1726

except (TypeError,

1727

gnutls.errors.GNUTLSError) as error:

1728

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

1729

return

1730

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

1731

1732

try:

1733

client = ProxyClient(child_pipe, fpr,

2343

1734

self.client_address)

2344

1735

except KeyError:

2345

1736

return

2346

1737

2347

1738

if client.approval_delay:

2348

1739

delay = client.approval_delay

2349

1740

client.approvals_pending += 1

2350

1741

approval_required = True

2351

1742

2352

1743

while True:

2353

1744

if not client.enabled:

2354

1745

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

2355

client.name)

1746

client.name)

2356

1747

if self.server.use_dbus:

2357

1748

# Emit D-Bus signal

2358

1749

client.Rejected("Disabled")

2359

1750

return

2360

1751

2361

1752

if client.approved or not client.approval_delay:

2362

# We are approved or approval is disabled

1753

#We are approved or approval is disabled

2363

1754

break

2364

1755

elif client.approved is None:

2365

1756

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

2367

1758

if self.server.use_dbus:

2368

1759

# Emit D-Bus signal

2369

1760

client.NeedApproval(

2370

client.approval_delay.total_seconds()

2371

* 1000, client.approved_by_default)

1761

client.approval_delay_milliseconds(),

1762

client.approved_by_default)

2372

1763

else:

2373

1764

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

2374

1765

client.name)

2376

1767

# Emit D-Bus signal

2377

1768

client.Rejected("Denied")

2378

1769

return

2379

2380

# wait until timeout or approved

1770

1771

#wait until timeout or approved

2381

1772

time = datetime.datetime.now()

2382

1773

client.changedstate.acquire()

2383

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

1774

client.changedstate.wait(

1775

float(timedelta_to_milliseconds(delay)

1776

/ 1000))

2384

1777

client.changedstate.release()

2385

1778

time2 = datetime.datetime.now()

2386

1779

if (time2 - time) >= delay:

2396

1789

break

2397

1790

else:

2398

1791

delay -= time2 - time

2399

2400

try:

2401

session.send(client.secret)

2402

except gnutls.Error as error:

2403

logger.warning("gnutls send failed",

2404

exc_info=error)

2405

return

2406

1792

1793

sent_size = 0

1794

while sent_size < len(client.secret):

1795

try:

1796

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

1797

except gnutls.errors.GNUTLSError as error:

1798

logger.warning("gnutls send failed",

1799

exc_info=error)

1800

return

1801

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

1802

sent, len(client.secret)

1803

- (sent_size + sent))

1804

sent_size += sent

1805

2407

1806

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

2408

1807

# bump the timeout using extended_timeout

2409

1808

client.bump_timeout(client.extended_timeout)

2410

1809

if self.server.use_dbus:

2411

1810

# Emit D-Bus signal

2412

1811

client.GotSecret()

2413

1812

2414

1813

finally:

2415

1814

if approval_required:

2416

1815

client.approvals_pending -= 1

2417

1816

try:

2418

1817

session.bye()

2419

except gnutls.Error as error:

1818

except gnutls.errors.GNUTLSError as error:

2420

1819

logger.warning("GnuTLS bye failed",

2421

1820

exc_info=error)

2422

1821

2423

1822

@staticmethod

2424

1823

def peer_certificate(session):

2425

"Return the peer's certificate as a bytestring"

2426

try:

2427

cert_type = gnutls.certificate_type_get2(session._c_object,

2428

gnutls.CTYPE_PEERS)

2429

except AttributeError:

2430

cert_type = gnutls.certificate_type_get(session._c_object)

2431

if gnutls.has_rawpk:

2432

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2433

else:

2434

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2435

# If not a valid certificate type...

2436

if cert_type not in valid_cert_types:

2437

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

2438

valid_cert_types)

2439

# ...return invalid data

2440

return b""

1824

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

1825

# If not an OpenPGP certificate...

1826

if (gnutls.library.functions

1827

.gnutls_certificate_type_get(session._c_object)

1828

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1829

# ...do the normal thing

1830

return session.peer_certificate

2441

1831

list_size = ctypes.c_uint(1)

2442

cert_list = (gnutls.certificate_get_peers

1832

cert_list = (gnutls.library.functions

1833

.gnutls_certificate_get_peers

2443

1834

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

2444

1835

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

2445

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

1836

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

1837

" certificate")

2446

1838

if list_size.value == 0:

2447

1839

return None

2448

1840

cert = cert_list[0]

2449

1841

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

2450

2451

@staticmethod

2452

def key_id(certificate):

2453

"Convert a certificate bytestring to a hexdigit key ID"

2454

# New GnuTLS "datum" with the public key

2455

datum = gnutls.datum_t(

2456

ctypes.cast(ctypes.c_char_p(certificate),

2457

ctypes.POINTER(ctypes.c_ubyte)),

2458

ctypes.c_uint(len(certificate)))

2459

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

2460

# New empty GnuTLS certificate

2461

pubkey = gnutls.pubkey_t()

2462

gnutls.pubkey_init(ctypes.byref(pubkey))

2463

# Import the raw public key into the certificate

2464

gnutls.pubkey_import(pubkey,

2465

ctypes.byref(datum),

2466

gnutls.X509_FMT_DER)

2467

# New buffer for the key ID

2468

buf = ctypes.create_string_buffer(32)

2469

buf_len = ctypes.c_size_t(len(buf))

2470

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

2471

gnutls.pubkey_get_key_id(pubkey,

2472

gnutls.KEYID_USE_SHA256,

2473

ctypes.cast(ctypes.byref(buf),

2474

ctypes.POINTER(ctypes.c_ubyte)),

2475

ctypes.byref(buf_len))

2476

# Deinit the certificate

2477

gnutls.pubkey_deinit(pubkey)

2478

2479

# Convert the buffer to a Python bytestring

2480

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

2481

# Convert the bytestring to hexadecimal notation

2482

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

2483

return hex_key_id

2484

1842

2485

1843

@staticmethod

2486

1844

def fingerprint(openpgp):

2487

1845

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2488

1846

# New GnuTLS "datum" with the OpenPGP public key

2489

datum = gnutls.datum_t(

2490

ctypes.cast(ctypes.c_char_p(openpgp),

2491

ctypes.POINTER(ctypes.c_ubyte)),

2492

ctypes.c_uint(len(openpgp)))

1847

datum = (gnutls.library.types

1848

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

1849

ctypes.POINTER

1850

(ctypes.c_ubyte)),

1851

ctypes.c_uint(len(openpgp))))

2493

1852

# New empty GnuTLS certificate

2494

crt = gnutls.openpgp_crt_t()

2495

gnutls.openpgp_crt_init(ctypes.byref(crt))

1853

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1854

(gnutls.library.functions

1855

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2496

1856

# Import the OpenPGP public key into the certificate

2497

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

2498

gnutls.OPENPGP_FMT_RAW)

1857

(gnutls.library.functions

1858

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

1859

gnutls.library.constants

1860

.GNUTLS_OPENPGP_FMT_RAW))

2499

1861

# Verify the self signature in the key

2500

1862

crtverify = ctypes.c_uint()

2501

gnutls.openpgp_crt_verify_self(crt, 0,

2502

ctypes.byref(crtverify))

1863

(gnutls.library.functions

1864

.gnutls_openpgp_crt_verify_self(crt, 0,

1865

ctypes.byref(crtverify)))

2503

1866

if crtverify.value != 0:

2504

gnutls.openpgp_crt_deinit(crt)

2505

raise gnutls.CertificateSecurityError(code

2506

=crtverify.value)

1867

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1868

raise (gnutls.errors.CertificateSecurityError

1869

("Verify failed"))

2507

1870

# New buffer for the fingerprint

2508

1871

buf = ctypes.create_string_buffer(20)

2509

1872

buf_len = ctypes.c_size_t()

2510

1873

# Get the fingerprint from the certificate into the buffer

2511

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

2512

ctypes.byref(buf_len))

1874

(gnutls.library.functions

1875

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

1876

ctypes.byref(buf_len)))

2513

1877

# Deinit the certificate

2514

gnutls.openpgp_crt_deinit(crt)

1878

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2515

1879

# Convert the buffer to a Python bytestring

2516

1880

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

2517

1881

# Convert the bytestring to hexadecimal notation

2519

1883

return hex_fpr

2520

1884

2521

1885

2522

class MultiprocessingMixIn:

1886

class MultiprocessingMixIn(object):

2523

1887

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

2524

2525

1888

def sub_process_main(self, request, address):

2526

1889

try:

2527

1890

self.finish_request(request, address)

2528

1891

except Exception:

2529

1892

self.handle_error(request, address)

2530

1893

self.close_request(request)

2531

1894

2532

1895

def process_request(self, request, address):

2533

1896

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

2534

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

2535

args=(request, address))

1897

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

1898

args = (request, address))

2536

1899

proc.start()

2537

1900

return proc

2538

1901

2539

1902

2540

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1903

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2541

1904

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

2542

2543

1905

def process_request(self, request, client_address):

2544

1906

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

2545

1907

2546

1908

This function creates a new pipe in self.pipe

2547

1909

"""

2548

1910

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2549

1911

2550

1912

proc = MultiprocessingMixIn.process_request(self, request,

2551

1913

client_address)

2552

1914

self.child_pipe.close()

2553

1915

self.add_pipe(parent_pipe, proc)

2554

1916

2555

1917

def add_pipe(self, parent_pipe, proc):

2556

1918

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

2557

1919

raise NotImplementedError()

2558

1920

2559

1921

2560

1922

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2561

socketserver.TCPServer):

1923

socketserver.TCPServer, object):

2562

1924

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

2563

1925

2564

1926

Attributes:

2565

1927

enabled: Boolean; whether this server is activated yet

2566

1928

interface: None or a network interface name (string)

2567

1929

use_ipv6: Boolean; to use IPv6 or not

2568

1930

"""

2569

2570

1931

def __init__(self, server_address, RequestHandlerClass,

2571

interface=None,

2572

use_ipv6=True,

2573

socketfd=None):

1932

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

2574

1933

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

2575

1934

creating a new one with socket.socket().

2576

1935

"""

2582

1941

self.socketfd = socketfd

2583

1942

# Save the original socket.socket() function

2584

1943

self.socket_socket = socket.socket

2585

2586

1944

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

2587

#

1945

#

2588

1946

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

2589

1947

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

2590

1948

# patching socket.socket.)

2591

#

1949

#

2592

1950

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

2593

1951

@functools.wraps(socket.socket)

2594

1952

def socket_wrapper(*args, **kwargs):

2606

1964

# socket_wrapper(), if socketfd was set.

2607

1965

socketserver.TCPServer.__init__(self, server_address,

2608

1966

RequestHandlerClass)

2609

1967

2610

1968

def server_bind(self):

2611

1969

"""This overrides the normal server_bind() function

2612

1970

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

2613

1971

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

2614

global SO_BINDTODEVICE

2615

1972

if self.interface is not None:

2616

1973

if SO_BINDTODEVICE is None:

2617

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

2618

# common enough.

2619

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

2620

SO_BINDTODEVICE = 25

2621

try:

2622

self.socket.setsockopt(

2623

socket.SOL_SOCKET, SO_BINDTODEVICE,

2624

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

2625

except socket.error as error:

2626

if error.errno == errno.EPERM:

2627

logger.error("No permission to bind to"

2628

" interface %s", self.interface)

2629

elif error.errno == errno.ENOPROTOOPT:

2630

logger.error("SO_BINDTODEVICE not available;"

2631

" cannot bind to interface %s",

2632

self.interface)

2633

elif error.errno == errno.ENODEV:

2634

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

2635

" cannot bind", self.interface)

2636

else:

2637

raise

1974

logger.error("SO_BINDTODEVICE does not exist;"

1975

" cannot bind to interface %s",

1976

self.interface)

1977

else:

1978

try:

1979

self.socket.setsockopt(socket.SOL_SOCKET,

1980

SO_BINDTODEVICE,

1981

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

1982

except socket.error as error:

1983

if error.errno == errno.EPERM:

1984

logger.error("No permission to bind to"

1985

" interface %s", self.interface)

1986

elif error.errno == errno.ENOPROTOOPT:

1987

logger.error("SO_BINDTODEVICE not available;"

1988

" cannot bind to interface %s",

1989

self.interface)

1990

elif error.errno == errno.ENODEV:

1991

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

1992

" cannot bind", self.interface)

1993

else:

1994

raise

2638

1995

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

2639

1996

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

2640

if self.server_address[1]:

2641

self.allow_reuse_address = True

2642

1997

if not self.server_address[0]:

2643

1998

if self.address_family == socket.AF_INET6:

2644

any_address = "::" # in6addr_any

1999

any_address = "::" # in6addr_any

2645

2000

else:

2646

any_address = "0.0.0.0" # INADDR_ANY

2001

any_address = "0.0.0.0" # INADDR_ANY

2647

2002

self.server_address = (any_address,

2648

2003

self.server_address[1])

2649

2004

elif not self.server_address[1]:

2650

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

2005

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

2006

0)

2651

2007

# if self.interface:

2652

2008

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

2653

2009

# 0, # port

2659

2015

2660

2016

class MandosServer(IPv6_TCPServer):

2661

2017

"""Mandos server.

2662

2018

2663

2019

Attributes:

2664

2020

clients: set of Client objects

2665

2021

gnutls_priority GnuTLS priority string

2666

2022

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

2667

2668

Assumes a GLib.MainLoop event loop.

2023

2024

Assumes a gobject.MainLoop event loop.

2669

2025

"""

2670

2671

2026

def __init__(self, server_address, RequestHandlerClass,

2672

interface=None,

2673

use_ipv6=True,

2674

clients=None,

2675

gnutls_priority=None,

2676

use_dbus=True,

2677

socketfd=None):

2027

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

2028

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

2678

2029

self.enabled = False

2679

2030

self.clients = clients

2680

2031

if self.clients is None:

2683

2034

self.gnutls_priority = gnutls_priority

2684

2035

IPv6_TCPServer.__init__(self, server_address,

2685

2036

RequestHandlerClass,

2686

interface=interface,

2687

use_ipv6=use_ipv6,

2688

socketfd=socketfd)

2689

2037

interface = interface,

2038

use_ipv6 = use_ipv6,

2039

socketfd = socketfd)

2690

2040

def server_activate(self):

2691

2041

if self.enabled:

2692

2042

return socketserver.TCPServer.server_activate(self)

2693

2043

2694

2044

def enable(self):

2695

2045

self.enabled = True

2696

2046

2697

2047

def add_pipe(self, parent_pipe, proc):

2698

2048

# Call "handle_ipc" for both data and EOF events

2699

GLib.io_add_watch(

2700

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

2701

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

2702

functools.partial(self.handle_ipc,

2703

parent_pipe=parent_pipe,

2704

proc=proc))

2705

2706

def handle_ipc(self, source, condition,

2707

parent_pipe=None,

2708

proc=None,

2709

client_object=None):

2049

gobject.io_add_watch(parent_pipe.fileno(),

2050

gobject.IO_IN | gobject.IO_HUP,

2051

functools.partial(self.handle_ipc,

2052

parent_pipe =

2053

parent_pipe,

2054

proc = proc))

2055

2056

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

2057

proc = None, client_object=None):

2710

2058

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

2711

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

2059

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

2712

2060

# Wait for other process to exit

2713

2061

proc.join()

2714

2062

return False

2715

2063

2716

2064

# Read a request from the child

2717

2065

request = parent_pipe.recv()

2718

2066

command = request[0]

2719

2067

2720

2068

if command == 'init':

2721

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

2722

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

2723

address = request[3]

2724

2725

for c in self.clients.values():

2726

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2727

continue

2728

if key_id and c.key_id == key_id:

2729

client = c

2730

break

2731

if fpr and c.fingerprint == fpr:

2069

fpr = request[1]

2070

address = request[2]

2071

2072

for c in self.clients.itervalues():

2073

if c.fingerprint == fpr:

2732

2074

client = c

2733

2075

break

2734

2076

else:

2735

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

2736

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

2077

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

2078

"dress: %s", fpr, address)

2737

2079

if self.use_dbus:

2738

2080

# Emit D-Bus signal

2739

mandos_dbus_service.ClientNotFound(key_id or fpr,

2081

mandos_dbus_service.ClientNotFound(fpr,

2740

2082

address[0])

2741

2083

parent_pipe.send(False)

2742

2084

return False

2743

2744

GLib.io_add_watch(

2745

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

2746

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

2747

functools.partial(self.handle_ipc,

2748

parent_pipe=parent_pipe,

2749

proc=proc,

2750

client_object=client))

2085

2086

gobject.io_add_watch(parent_pipe.fileno(),

2087

gobject.IO_IN | gobject.IO_HUP,

2088

functools.partial(self.handle_ipc,

2089

parent_pipe =

2090

parent_pipe,

2091

proc = proc,

2092

client_object =

2093

client))

2751

2094

parent_pipe.send(True)

2752

2095

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

2753

2096

# same fileno

2756

2099

funcname = request[1]

2757

2100

args = request[2]

2758

2101

kwargs = request[3]

2759

2102

2760

2103

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

2761

2104

funcname)(*args,

2762

**kwargs)))

2763

2105

**kwargs)))

2106

2764

2107

if command == 'getattr':

2765

2108

attrname = request[1]

2766

if isinstance(client_object.__getattribute__(attrname),

2767

collections.abc.Callable):

2768

parent_pipe.send(('function', ))

2109

if callable(client_object.__getattribute__(attrname)):

2110

parent_pipe.send(('function',))

2769

2111

else:

2770

parent_pipe.send((

2771

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

2772

2112

parent_pipe.send(('data', client_object

2113

.__getattribute__(attrname)))

2114

2773

2115

if command == 'setattr':

2774

2116

attrname = request[1]

2775

2117

value = request[2]

2776

2118

setattr(client_object, attrname, value)

2777

2119

2778

2120

return True

2779

2121

2780

2122

2781

2123

def rfc3339_duration_to_delta(duration):

2782

2124

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

2783

2784

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

2785

True

2786

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

2787

True

2788

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

2789

True

2790

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

2791

True

2792

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

2793

True

2794

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

2795

True

2796

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

2797

True

2125

2126

>>> rfc3339_duration_to_delta("P7D")

2127

datetime.timedelta(7)

2128

>>> rfc3339_duration_to_delta("PT60S")

2129

datetime.timedelta(0, 60)

2130

>>> rfc3339_duration_to_delta("PT60M")

2131

datetime.timedelta(0, 3600)

2132

>>> rfc3339_duration_to_delta("PT24H")

2133

datetime.timedelta(1)

2134

>>> rfc3339_duration_to_delta("P1W")

2135

datetime.timedelta(7)

2136

>>> rfc3339_duration_to_delta("PT5M30S")

2137

datetime.timedelta(0, 330)

2138

>>> rfc3339_duration_to_delta("P1DT3M20S")

2139

datetime.timedelta(1, 200)

2798

2140

"""

2799

2141

2800

2142

# Parsing an RFC 3339 duration with regular expressions is not

2801

2143

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

2802

2144

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

2803

2145

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

2804

2146

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

2805

2147

# avoid excessive use of external libraries.

2806

2148

2807

2149

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

2808

Token = collections.namedtuple("Token", (

2809

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

2810

# a "group" containing digits

2811

"value", # datetime.timedelta or None

2812

"followers")) # Tokens valid after this token

2150

Token = collections.namedtuple("Token",

2151

("regexp", # To match token; if

2152

# "value" is not None,

2153

# must have a "group"

2154

# containing digits

2155

"value", # datetime.timedelta or

2156

# None

2157

"followers")) # Tokens valid after

2158

# this token

2813

2159

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

2814

2160

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

2815

2161

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

2816

2162

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

2817

2163

datetime.timedelta(seconds=1),

2818

frozenset((token_end, )))

2164

frozenset((token_end,)))

2819

2165

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

2820

2166

datetime.timedelta(minutes=1),

2821

2167

frozenset((token_second, token_end)))

2837

2183

frozenset((token_month, token_end)))

2838

2184

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

2839

2185

datetime.timedelta(weeks=1),

2840

frozenset((token_end, )))

2186

frozenset((token_end,)))

2841

2187

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

2842

2188

frozenset((token_year, token_month,

2843

2189

token_day, token_time,

2844

token_week)))

2845

# Define starting values:

2846

# Value so far

2847

value = datetime.timedelta()

2190

token_week))),

2191

# Define starting values

2192

value = datetime.timedelta() # Value so far

2848

2193

found_token = None

2849

# Following valid tokens

2850

followers = frozenset((token_duration, ))

2851

# String left to parse

2852

s = duration

2194

followers = frozenset(token_duration,) # Following valid tokens

2195

s = duration # String left to parse

2853

2196

# Loop until end token is found

2854

2197

while found_token is not token_end:

2855

2198

# Search for any currently valid tokens

2871

2214

break

2872

2215

else:

2873

2216

# No currently valid tokens were found

2874

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

2875

.format(duration))

2217

raise ValueError("Invalid RFC 3339 duration")

2876

2218

# End token found

2877

2219

return value

2878

2220

2879

2221

2880

2222

def string_to_delta(interval):

2881

2223

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

2882

2883

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

2884

True

2885

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

2886

True

2887

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

2888

True

2889

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

2890

True

2891

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

2892

True

2893

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

2894

True

2224

2225

>>> string_to_delta('7d')

2226

datetime.timedelta(7)

2227

>>> string_to_delta('60s')

2228

datetime.timedelta(0, 60)

2229

>>> string_to_delta('60m')

2230

datetime.timedelta(0, 3600)

2231

>>> string_to_delta('24h')

2232

datetime.timedelta(1)

2233

>>> string_to_delta('1w')

2234

datetime.timedelta(7)

2235

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

2236

datetime.timedelta(0, 330)

2895

2237

"""

2896

2238

2897

2239

try:

2898

2240

return rfc3339_duration_to_delta(interval)

2899

2241

except ValueError:

2900

2242

pass

2901

2243

2902

2244

timevalue = datetime.timedelta(0)

2903

2245

for s in interval.split():

2904

2246

try:

2905

suffix = s[-1]

2247

suffix = unicode(s[-1])

2906

2248

value = int(s[:-1])

2907

2249

if suffix == "d":

2908

2250

delta = datetime.timedelta(value)

2915

2257

elif suffix == "w":

2916

2258

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

2917

2259

else:

2918

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

2260

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

2261

.format(suffix))

2919

2262

except IndexError as e:

2920

2263

raise ValueError(*(e.args))

2921

2264

timevalue += delta

2922

2265

return timevalue

2923

2266

2924

2267

2925

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

2268

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

2926

2269

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

2927

2270

2928

2271

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

2929

2272

if os.fork():

2930

2273

sys.exit()

2938

2281

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

2939

2282

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

2940

2283

raise OSError(errno.ENODEV,

2941

"{} not a character device"

2284

"{0} not a character device"

2942

2285

.format(os.devnull))

2943

2286

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

2944

2287

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

2948

2291

2949

2292

2950

2293

def main():

2951

2294

2952

2295

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

2953

2296

# Parsing of options, both command line and config file

2954

2297

2955

2298

parser = argparse.ArgumentParser()

2956

2299

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

2957

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

2300

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

2958

2301

help="show version number and exit")

2959

2302

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

2960

2303

help="Bind to interface IF")

2993

2336

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

2994

2337

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

2995

2338

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

2996

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

2997

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

2998

default=None)

2999

2339

3000

2340

options = parser.parse_args()

3001

2341

2342

if options.check:

2343

import doctest

2344

fail_count, test_count = doctest.testmod()

2345

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

2346

3002

2347

# Default values for config file for server-global settings

3003

if gnutls.has_rawpk:

3004

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

3005

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

3006

else:

3007

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

3008

":+SIGN-DSA-SHA256")

3009

server_defaults = {"interface": "",

3010

"address": "",

3011

"port": "",

3012

"debug": "False",

3013

"priority": priority,

3014

"servicename": "Mandos",

3015

"use_dbus": "True",

3016

"use_ipv6": "True",

3017

"debuglevel": "",

3018

"restore": "True",

3019

"socket": "",

3020

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

3021

"foreground": "False",

3022

"zeroconf": "True",

3023

}

3024

del priority

3025

2348

server_defaults = { "interface": "",

2349

"address": "",

2350

"port": "",

2351

"debug": "False",

2352

"priority":

2353

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

2354

"servicename": "Mandos",

2355

"use_dbus": "True",

2356

"use_ipv6": "True",

2357

"debuglevel": "",

2358

"restore": "True",

2359

"socket": "",

2360

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

2361

"foreground": "False",

2362

}

2363

3026

2364

# Parse config file for server-global settings

3027

server_config = configparser.ConfigParser(server_defaults)

2365

server_config = configparser.SafeConfigParser(server_defaults)

3028

2366

del server_defaults

3029

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

3030

# Convert the ConfigParser object to a dict

2367

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

2368

"mandos.conf"))

2369

# Convert the SafeConfigParser object to a dict

3031

2370

server_settings = server_config.defaults()

3032

2371

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

3033

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

3034

"foreground", "zeroconf"):

2372

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

3035

2373

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

3036

2374

option)

3037

2375

if server_settings["port"]:

3047

2385

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

3048

2386

["socket"])

3049

2387

del server_config

3050

2388

3051

2389

# Override the settings from the config file with command line

3052

2390

# options, if set.

3053

2391

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

3054

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

3055

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

3056

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

2392

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

2393

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

2394

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

3057

2395

value = getattr(options, option)

3058

2396

if value is not None:

3059

2397

server_settings[option] = value

3060

2398

del options

3061

2399

# Force all strings to be unicode

3062

2400

for option in server_settings.keys():

3063

if isinstance(server_settings[option], bytes):

3064

server_settings[option] = (server_settings[option]

3065

.decode("utf-8"))

2401

if type(server_settings[option]) is str:

2402

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

3066

2403

# Force all boolean options to be boolean

3067

2404

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

3068

"foreground", "zeroconf"):

2405

"foreground"):

3069

2406

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

3070

2407

# Debug implies foreground

3071

2408

if server_settings["debug"]:

3072

2409

server_settings["foreground"] = True

3073

2410

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

3074

2411

3075

2412

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

3076

3077

if (not server_settings["zeroconf"]

3078

and not (server_settings["port"]

3079

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

3080

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

3081

2413

3082

2414

# For convenience

3083

2415

debug = server_settings["debug"]

3084

2416

debuglevel = server_settings["debuglevel"]

3087

2419

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

3088

2420

stored_state_file)

3089

2421

foreground = server_settings["foreground"]

3090

zeroconf = server_settings["zeroconf"]

3091

2422

3092

2423

if debug:

3093

2424

initlogger(debug, logging.DEBUG)

3094

2425

else:

3097

2428

else:

3098

2429

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

3099

2430

initlogger(debug, level)

3100

2431

3101

2432

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

3102

syslogger.setFormatter(

3103

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

3104

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

3105

server_settings["servicename"])))

3106

2433

syslogger.setFormatter(logging.Formatter

2434

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

2435

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

2436

.format(server_settings

2437

["servicename"])))

2438

3107

2439

# Parse config file with clients

3108

client_config = configparser.ConfigParser(Client.client_defaults)

2440

client_config = configparser.SafeConfigParser(Client

2441

.client_defaults)

3109

2442

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

3110

2443

"clients.conf"))

3111

2444

3112

2445

global mandos_dbus_service

3113

2446

mandos_dbus_service = None

3114

3115

socketfd = None

3116

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

3117

socketfd = server_settings["socket"]

3118

tcp_server = MandosServer(

3119

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

3120

ClientHandler,

3121

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

3122

use_ipv6=use_ipv6,

3123

gnutls_priority=server_settings["priority"],

3124

use_dbus=use_dbus,

3125

socketfd=socketfd)

2447

2448

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

2449

server_settings["port"]),

2450

ClientHandler,

2451

interface=(server_settings["interface"]

2452

or None),

2453

use_ipv6=use_ipv6,

2454

gnutls_priority=

2455

server_settings["priority"],

2456

use_dbus=use_dbus,

2457

socketfd=(server_settings["socket"]

2458

or None))

3126

2459

if not foreground:

3127

2460

pidfilename = "/run/mandos.pid"

3128

2461

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

3129

2462

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

3130

2463

pidfile = None

3131

2464

try:

3132

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

2465

pidfile = open(pidfilename, "w")

3133

2466

except IOError as e:

3134

2467

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

3135

2468

exc_info=e)

3136

3137

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

3138

("mandos", "mandos"),

3139

("nobody", "nogroup")):

2469

2470

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

3140

2471

try:

3141

2472

uid = pwd.getpwnam(name).pw_uid

3142

gid = pwd.getpwnam(group).pw_gid

2473

gid = pwd.getpwnam(name).pw_gid

3143

2474

break

3144

2475

except KeyError:

3145

2476

continue

3149

2480

try:

3150

2481

os.setgid(gid)

3151

2482

os.setuid(uid)

3152

if debug:

3153

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

3154

gid))

3155

2483

except OSError as error:

3156

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

3157

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

3158

2484

if error.errno != errno.EPERM:

3159

2485

raise

3160

2486

3161

2487

if debug:

3162

2488

# Enable all possible GnuTLS debugging

3163

2489

3164

2490

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

3165

2491

# - GnuTLS manual

3166

gnutls.global_set_log_level(11)

3167

3168

@gnutls.log_func

2492

gnutls.library.functions.gnutls_global_set_log_level(11)

2493

2494

@gnutls.library.types.gnutls_log_func

3169

2495

def debug_gnutls(level, string):

3170

2496

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

3171

3172

gnutls.global_set_log_function(debug_gnutls)

3173

2497

2498

(gnutls.library.functions

2499

.gnutls_global_set_log_function(debug_gnutls))

2500

3174

2501

# Redirect stdin so all checkers get /dev/null

3175

2502

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

3176

2503

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

3177

2504

if null > 2:

3178

2505

os.close(null)

3179

2506

3180

2507

# Need to fork before connecting to D-Bus

3181

2508

if not foreground:

3182

2509

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

3183

2510

daemon()

3184

3185

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

3186

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

3187

# need to inform GLib that threads will be used.

3188

GLib.threads_init()

3189

2511

2512

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

2513

# need to inform gobject that threads will be used.

2514

gobject.threads_init()

2515

3190

2516

global main_loop

3191

2517

# From the Avahi example code

3192

2518

DBusGMainLoop(set_as_default=True)

3193

main_loop = GLib.MainLoop()

2519

main_loop = gobject.MainLoop()

3194

2520

bus = dbus.SystemBus()

3195

2521

# End of Avahi example code

3196

2522

if use_dbus:

3197

2523

try:

3198

2524

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

3199

bus,

3200

do_not_queue=True)

3201

old_bus_name = dbus.service.BusName(

3202

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

3203

do_not_queue=True)

3204

except dbus.exceptions.DBusException as e:

2525

bus, do_not_queue=True)

2526

old_bus_name = (dbus.service.BusName

2527

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

2528

do_not_queue=True))

2529

except dbus.exceptions.NameExistsException as e:

3205

2530

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

3206

2531

use_dbus = False

3207

2532

server_settings["use_dbus"] = False

3208

2533

tcp_server.use_dbus = False

3209

if zeroconf:

3210

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3211

service = AvahiServiceToSyslog(

3212

name=server_settings["servicename"],

3213

servicetype="_mandos._tcp",

3214

protocol=protocol,

3215

bus=bus)

3216

if server_settings["interface"]:

3217

service.interface = if_nametoindex(

3218

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

3219

2534

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2535

service = AvahiServiceToSyslog(name =

2536

server_settings["servicename"],

2537

servicetype = "_mandos._tcp",

2538

protocol = protocol, bus = bus)

2539

if server_settings["interface"]:

2540

service.interface = (if_nametoindex

2541

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

2542

3220

2543

global multiprocessing_manager

3221

2544

multiprocessing_manager = multiprocessing.Manager()

3222

2545

3223

2546

client_class = Client

3224

2547

if use_dbus:

3225

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

3226

2548

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

2549

3227

2550

client_settings = Client.config_parser(client_config)

3228

2551

old_client_settings = {}

3229

2552

clients_data = {}

3230

2553

3231

2554

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

3232

2555

global wnull

3233

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

2556

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

3234

2557

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

3235

2558

# mode

3236

2559

if debug or not foreground:

3237

2560

wnull.close()

3238

2561

3239

2562

# Get client data and settings from last running state.

3240

2563

if server_settings["restore"]:

3241

2564

try:

3242

2565

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

3243

if sys.version_info.major == 2:

3244

clients_data, old_client_settings = pickle.load(

3245

stored_state)

3246

else:

3247

bytes_clients_data, bytes_old_client_settings = (

3248

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

3249

# Fix bytes to strings

3250

# clients_data

3251

# .keys()

3252

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

3253

if isinstance(key, bytes)

3254

else key): value

3255

for key, value in

3256

bytes_clients_data.items()}

3257

del bytes_clients_data

3258

for key in clients_data:

3259

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

3260

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

3261

for k, v in

3262

clients_data[key].items()}

3263

clients_data[key] = value

3264

# .client_structure

3265

value["client_structure"] = [

3266

(s.decode("utf-8")

3267

if isinstance(s, bytes)

3268

else s) for s in

3269

value["client_structure"]]

3270

# .name, .host, and .checker_command

3271

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

3272

if isinstance(value[k], bytes):

3273

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

3274

if "key_id" not in value:

3275

value["key_id"] = ""

3276

elif "fingerprint" not in value:

3277

value["fingerprint"] = ""

3278

# old_client_settings

3279

# .keys()

3280

old_client_settings = {

3281

(key.decode("utf-8")

3282

if isinstance(key, bytes)

3283

else key): value

3284

for key, value in

3285

bytes_old_client_settings.items()}

3286

del bytes_old_client_settings

3287

# .host and .checker_command

3288

for value in old_client_settings.values():

3289

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

3290

if isinstance(value[attribute], bytes):

3291

value[attribute] = (value[attribute]

3292

.decode("utf-8"))

2566

clients_data, old_client_settings = (pickle.load

2567

(stored_state))

3293

2568

os.remove(stored_state_path)

3294

2569

except IOError as e:

3295

2570

if e.errno == errno.ENOENT:

3296

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

3297

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

2571

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

2572

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

3298

2573

else:

3299

2574

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

3300

2575

exc_info=e)

3301

2576

raise

3302

2577

except EOFError as e:

3303

2578

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

3304

"EOFError:",

3305

exc_info=e)

3306

2579

"EOFError:", exc_info=e)

2580

3307

2581

with PGPEngine() as pgp:

3308

for client_name, client in clients_data.items():

2582

for client_name, client in clients_data.iteritems():

3309

2583

# Skip removed clients

3310

2584

if client_name not in client_settings:

3311

2585

continue

3312

2586

3313

2587

# Decide which value to use after restoring saved state.

3314

2588

# We have three different values: Old config file,

3315

2589

# new config file, and saved state.

3320

2594

# For each value in new config, check if it

3321

2595

# differs from the old config value (Except for

3322

2596

# the "secret" attribute)

3323

if (name != "secret"

3324

and (value !=

3325

old_client_settings[client_name][name])):

2597

if (name != "secret" and

2598

value != old_client_settings[client_name]

2599

[name]):

3326

2600

client[name] = value

3327

2601

except KeyError:

3328

2602

pass

3329

2603

3330

2604

# Clients who has passed its expire date can still be

3331

# enabled if its last checker was successful. A Client

2605

# enabled if its last checker was successful. Clients

3332

2606

# whose checker succeeded before we stored its state is

3333

2607

# assumed to have successfully run all checkers during

3334

2608

# downtime.

3336

2610

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

3337

2611

if not client["last_checked_ok"]:

3338

2612

logger.warning(

3339

"disabling client {} - Client never "

3340

"performed a successful checker".format(

3341

client_name))

2613

"disabling client {0} - Client never "

2614

"performed a successful checker"

2615

.format(client_name))

3342

2616

client["enabled"] = False

3343

2617

elif client["last_checker_status"] != 0:

3344

2618

logger.warning(

3345

"disabling client {} - Client last"

3346

" checker failed with error code"

3347

" {}".format(

3348

client_name,

3349

client["last_checker_status"]))

2619

"disabling client {0} - Client "

2620

"last checker failed with error code {1}"

2621

.format(client_name,

2622

client["last_checker_status"]))

3350

2623

client["enabled"] = False

3351

2624

else:

3352

client["expires"] = (

3353

datetime.datetime.utcnow()

3354

+ client["timeout"])

2625

client["expires"] = (datetime.datetime

2626

.utcnow()

2627

+ client["timeout"])

3355

2628

logger.debug("Last checker succeeded,"

3356

" keeping {} enabled".format(

3357

client_name))

2629

" keeping {0} enabled"

2630

.format(client_name))

3358

2631

try:

3359

client["secret"] = pgp.decrypt(

3360

client["encrypted_secret"],

3361

client_settings[client_name]["secret"])

2632

client["secret"] = (

2633

pgp.decrypt(client["encrypted_secret"],

2634

client_settings[client_name]

2635

["secret"]))

3362

2636

except PGPError:

3363

2637

# If decryption fails, we use secret from new settings

3364

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

3365

client_name))

3366

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

3367

["secret"])

3368

2638

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

2639

.format(client_name))

2640

client["secret"] = (

2641

client_settings[client_name]["secret"])

2642

3369

2643

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

3370

2644

for client_name in (set(old_client_settings)

3371

2645

- set(client_settings)):

3373

2647

for client_name in (set(client_settings)

3374

2648

- set(old_client_settings)):

3375

2649

clients_data[client_name] = client_settings[client_name]

3376

2650

3377

2651

# Create all client objects

3378

for client_name, client in clients_data.items():

2652

for client_name, client in clients_data.iteritems():

3379

2653

tcp_server.clients[client_name] = client_class(

3380

name=client_name,

3381

settings=client,

3382

server_settings=server_settings)

3383

2654

name = client_name, settings = client,

2655

server_settings = server_settings)

2656

3384

2657

if not tcp_server.clients:

3385

2658

logger.warning("No clients defined")

3386

2659

3387

2660

if not foreground:

3388

2661

if pidfile is not None:

3389

pid = os.getpid()

3390

2662

try:

3391

2663

with pidfile:

3392

print(pid, file=pidfile)

2664

pid = os.getpid()

2665

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

3393

2666

except IOError:

3394

2667

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

3395

2668

pidfilename, pid)

3396

2669

del pidfile

3397

2670

del pidfilename

3398

3399

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

3400

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3401

lambda: main_loop.quit() and False)

3402

2671

2672

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

2673

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

2674

3403

2675

if use_dbus:

3404

3405

@alternate_dbus_interfaces(

3406

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

3407

class MandosDBusService(DBusObjectWithObjectManager):

2676

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

2677

"se.bsnet.fukt.Mandos"})

2678

class MandosDBusService(DBusObjectWithProperties):

3408

2679

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

3409

3410

2680

def __init__(self):

3411

2681

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

3412

3413

2682

_interface = "se.recompile.Mandos"

3414

2683

2684

@dbus_interface_annotations(_interface)

2685

def _foo(self):

2686

return { "org.freedesktop.DBus.Property"

2687

".EmitsChangedSignal":

2688

"false"}

2689

3415

2690

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

3416

2691

def ClientAdded(self, objpath):

3417

2692

"D-Bus signal"

3418

2693

pass

3419

2694

3420

2695

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

3421

def ClientNotFound(self, key_id, address):

2696

def ClientNotFound(self, fingerprint, address):

3422

2697

"D-Bus signal"

3423

2698

pass

3424

3425

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

3426

"true"})

2699

3427

2700

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

3428

2701

def ClientRemoved(self, objpath, name):

3429

2702

"D-Bus signal"

3430

2703

pass

3431

3432

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

3433

"true"})

2704

3434

2705

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

3435

2706

def GetAllClients(self):

3436

2707

"D-Bus method"

3437

return dbus.Array(c.dbus_object_path for c in

3438

tcp_server.clients.values())

3439

3440

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

3441

"true"})

2708

return dbus.Array(c.dbus_object_path

2709

for c in

2710

tcp_server.clients.itervalues())

2711

3442

2712

@dbus.service.method(_interface,

3443

2713

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

3444

2714

def GetAllClientsWithProperties(self):

3445

2715

"D-Bus method"

3446

2716

return dbus.Dictionary(

3447

{c.dbus_object_path: c.GetAll(

3448

"se.recompile.Mandos.Client")

3449

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

2717

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

2718

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

3450

2719

signature="oa{sv}")

3451

2720

3452

2721

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

3453

2722

def RemoveClient(self, object_path):

3454

2723

"D-Bus method"

3455

for c in tcp_server.clients.values():

2724

for c in tcp_server.clients.itervalues():

3456

2725

if c.dbus_object_path == object_path:

3457

2726

del tcp_server.clients[c.name]

3458

2727

c.remove_from_connection()

3459

# Don't signal the disabling

2728

# Don't signal anything except ClientRemoved

3460

2729

c.disable(quiet=True)

3461

# Emit D-Bus signal for removal

3462

self.client_removed_signal(c)

2730

# Emit D-Bus signal

2731

self.ClientRemoved(object_path, c.name)

3463

2732

return

3464

2733

raise KeyError(object_path)

3465

2734

3466

2735

del _interface

3467

3468

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3469

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

3470

def GetManagedObjects(self):

3471

"""D-Bus method"""

3472

return dbus.Dictionary(

3473

{client.dbus_object_path:

3474

dbus.Dictionary(

3475

{interface: client.GetAll(interface)

3476

for interface in

3477

client._get_all_interface_names()})

3478

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

3479

3480

def client_added_signal(self, client):

3481

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

3482

if use_dbus:

3483

# New standard signal

3484

self.InterfacesAdded(

3485

client.dbus_object_path,

3486

dbus.Dictionary(

3487

{interface: client.GetAll(interface)

3488

for interface in

3489

client._get_all_interface_names()}))

3490

# Old signal

3491

self.ClientAdded(client.dbus_object_path)

3492

3493

def client_removed_signal(self, client):

3494

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

3495

if use_dbus:

3496

# New standard signal

3497

self.InterfacesRemoved(

3498

client.dbus_object_path,

3499

client._get_all_interface_names())

3500

# Old signal

3501

self.ClientRemoved(client.dbus_object_path,

3502

client.name)

3503

2736

3504

2737

mandos_dbus_service = MandosDBusService()

3505

3506

# Save modules to variables to exempt the modules from being

3507

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

3508

mp = multiprocessing

3509

wn = wnull

3510

2738

3511

2739

def cleanup():

3512

2740

"Cleanup function; run on exit"

3513

if zeroconf:

3514

service.cleanup()

3515

3516

mp.active_children()

3517

wn.close()

2741

service.cleanup()

2742

2743

multiprocessing.active_children()

2744

wnull.close()

3518

2745

if not (tcp_server.clients or client_settings):

3519

2746

return

3520

2747

3521

2748

# Store client before exiting. Secrets are encrypted with key

3522

2749

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

3523

2750

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

3524

2751

clients = {}

3525

2752

with PGPEngine() as pgp:

3526

for client in tcp_server.clients.values():

2753

for client in tcp_server.clients.itervalues():

3527

2754

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

3528

2755

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

3529

2756

key)

3530

2757

client_dict = {}

3531

2758

3532

2759

# A list of attributes that can not be pickled

3533

2760

# + secret.

3534

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

3535

"checker", "server_settings"}

3536

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

3537

.Object):

2761

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

2762

"checker", "server_settings"))

2763

for name, typ in (inspect.getmembers

2764

(dbus.service.Object)):

3538

2765

exclude.add(name)

3539

2766

3540

2767

client_dict["encrypted_secret"] = (client

3541

2768

.encrypted_secret)

3542

2769

for attr in client.client_structure:

3543

2770

if attr not in exclude:

3544

2771

client_dict[attr] = getattr(client, attr)

3545

2772

3546

2773

clients[client.name] = client_dict

3547

2774

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

3548

2775

3549

2776

try:

3550

with tempfile.NamedTemporaryFile(

3551

mode='wb',

3552

suffix=".pickle",

3553

prefix='clients-',

3554

dir=os.path.dirname(stored_state_path),

3555

delete=False) as stored_state:

3556

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

3557

protocol=2)

3558

tempname = stored_state.name

2777

with (tempfile.NamedTemporaryFile

2778

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

2779

dir=os.path.dirname(stored_state_path),

2780

delete=False)) as stored_state:

2781

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

2782

tempname=stored_state.name

3559

2783

os.rename(tempname, stored_state_path)

3560

2784

except (IOError, OSError) as e:

3561

2785

if not debug:

3564

2788

except NameError:

3565

2789

pass

3566

2790

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

3567

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

2791

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

3568

2792

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

3569

2793

else:

3570

2794

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

3571

2795

exc_info=e)

3572

2796

raise

3573

2797

3574

2798

# Delete all clients, and settings from config

3575

2799

while tcp_server.clients:

3576

2800

name, client = tcp_server.clients.popitem()

3577

2801

if use_dbus:

3578

2802

client.remove_from_connection()

3579

# Don't signal the disabling

2803

# Don't signal anything except ClientRemoved

3580

2804

client.disable(quiet=True)

3581

# Emit D-Bus signal for removal

3582

2805

if use_dbus:

3583

mandos_dbus_service.client_removed_signal(client)

2806

# Emit D-Bus signal

2807

mandos_dbus_service.ClientRemoved(client

2808

.dbus_object_path,

2809

client.name)

3584

2810

client_settings.clear()

3585

2811

3586

2812

atexit.register(cleanup)

3587

3588

for client in tcp_server.clients.values():

2813

2814

for client in tcp_server.clients.itervalues():

3589

2815

if use_dbus:

3590

# Emit D-Bus signal for adding

3591

mandos_dbus_service.client_added_signal(client)

2816

# Emit D-Bus signal

2817

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3592

2818

# Need to initiate checking of clients

3593

2819

if client.enabled:

3594

2820

client.init_checker()

3595

2821

3596

2822

tcp_server.enable()

3597

2823

tcp_server.server_activate()

3598

2824

3599

2825

# Find out what port we got

3600

if zeroconf:

3601

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

2826

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

3602

2827

if use_ipv6:

3603

2828

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

3604

2829

" flowinfo %d, scope_id %d",

3606

2831

else: # IPv4

3607

2832

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

3608

2833

*tcp_server.socket.getsockname())

3609

3610

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

3611

2834

2835

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

2836

3612

2837

try:

3613

if zeroconf:

3614

# From the Avahi example code

3615

try:

3616

service.activate()

3617

except dbus.exceptions.DBusException as error:

3618

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

3619

cleanup()

3620

sys.exit(1)

3621

# End of Avahi example code

3622

3623

GLib.io_add_watch(

3624

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

3625

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3626

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

3627

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

3628

2838

# From the Avahi example code

2839

try:

2840

service.activate()

2841

except dbus.exceptions.DBusException as error:

2842

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

2843

cleanup()

2844

sys.exit(1)

2845

# End of Avahi example code

2846

2847

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

2848

lambda *args, **kwargs:

2849

(tcp_server.handle_request

2850

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

2851

3629

2852

logger.debug("Starting main loop")

3630

2853

main_loop.run()

3631

2854

except AvahiError as error:

3640

2863

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

3641

2864

cleanup()

3642

2865

3643

3644

def should_only_run_tests():

3645

parser = argparse.ArgumentParser(add_help=False)

3646

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

3647

args, unknown_args = parser.parse_known_args()

3648

run_tests = args.check

3649

if run_tests:

3650

# Remove --check argument from sys.argv

3651

sys.argv[1:] = unknown_args

3652

return run_tests

3653

3654

# Add all tests from doctest strings

3655

def load_tests(loader, tests, none):

3656

import doctest

3657

tests.addTests(doctest.DocTestSuite())

3658

return tests

3659

3660

2866

if __name__ == '__main__':

3661

try:

3662

if should_only_run_tests():

3663

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

3664

unittest.main()

3665

else:

3666

main()

3667

finally:

3668

logging.shutdown()

2867

main()