/mandos/release : revision 237.7.787

1

#!/usr/bin/python

2

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

3

#

1

#!/usr/bin/python3 -bI

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

80

import unittest

81

import random

82

import shlex

72

83

73

84

import dbus

74

85

import dbus.service

75

import gobject

76

import avahi

86

import gi

87

from gi.repository import GLib

77

88

from dbus.mainloop.glib import DBusGMainLoop

78

89

import ctypes

79

90

import ctypes.util

80

91

import xml.dom.minidom

81

92

import inspect

82

93

83

try:

94

if sys.version_info.major == 2:

95

__metaclass__ = type

96

str = unicode

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

84

122

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

123

except AttributeError:

86

124

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

87

127

from IN import SO_BINDTODEVICE

88

128

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.1"

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.14"

92

147

stored_state_file = "clients.pickle"

93

148

94

149

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

150

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

151

syslogger = None

98

152

99

153

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

103

156

except (OSError, AttributeError):

157

104

158

def if_nametoindex(interface):

105

159

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

106

160

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

107

161

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

108

162

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

163

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

164

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

113

165

return interface_index

114

166

115

167

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

116

184

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

117

185

"""init logger and add loglevel"""

118

186

187

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

119

191

syslogger.setFormatter(logging.Formatter

120

192

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

121

193

' %(message)s'))

122

194

logger.addHandler(syslogger)

123

195

124

196

if debug:

125

197

console = logging.StreamHandler()

126

198

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

136

208

pass

137

209

138

210

139

class PGPEngine(object):

211

class PGPEngine:

140

212

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

213

141

214

def __init__(self):

142

215

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

143

227

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

228

'--homedir', self.tempdir,

145

229

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

148

230

'--quiet']

231

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

232

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

233

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

234

149

235

def __enter__(self):

150

236

return self

151

237

152

238

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

153

239

self._cleanup()

154

240

return False

155

241

156

242

def __del__(self):

157

243

self._cleanup()

158

244

159

245

def _cleanup(self):

160

246

if self.tempdir is not None:

161

247

# Delete contents of tempdir

162

248

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

163

topdown = False):

249

topdown=False):

164

250

for filename in files:

165

251

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

166

252

for dirname in dirs:

168

254

# Remove tempdir

169

255

os.rmdir(self.tempdir)

170

256

self.tempdir = None

171

257

172

258

def password_encode(self, password):

173

259

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

174

260

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

179

265

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

180

266

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

181

267

return encoded

182

268

183

269

def encrypt(self, data, password):

184

270

passphrase = self.password_encode(password)

185

with tempfile.NamedTemporaryFile(dir=self.tempdir

186

) as passfile:

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

187

273

passfile.write(passphrase)

188

274

passfile.flush()

189

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

275

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

190

276

'--passphrase-file',

191

277

passfile.name]

192

278

+ self.gnupgargs,

193

stdin = subprocess.PIPE,

194

stdout = subprocess.PIPE,

195

stderr = subprocess.PIPE)

196

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

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

197

283

if proc.returncode != 0:

198

284

raise PGPError(err)

199

285

return ciphertext

200

286

201

287

def decrypt(self, data, password):

202

288

passphrase = self.password_encode(password)

203

with tempfile.NamedTemporaryFile(dir = self.tempdir

204

) as passfile:

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

205

291

passfile.write(passphrase)

206

292

passfile.flush()

207

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

293

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

208

294

'--passphrase-file',

209

295

passfile.name]

210

296

+ self.gnupgargs,

211

stdin = subprocess.PIPE,

212

stdout = subprocess.PIPE,

213

stderr = subprocess.PIPE)

214

decrypted_plaintext, err = proc.communicate(input

215

= data)

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

216

301

if proc.returncode != 0:

217

302

raise PGPError(err)

218

303

return decrypted_plaintext

219

304

220

305

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

221

332

class AvahiError(Exception):

222

333

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

223

334

self.value = value

224

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

225

def __unicode__(self):

226

return unicode(repr(self.value))

335

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

336

**kwargs)

337

227

338

228

339

class AvahiServiceError(AvahiError):

229

340

pass

230

341

342

231

343

class AvahiGroupError(AvahiError):

232

344

pass

233

345

234

346

235

class AvahiService(object):

347

class AvahiService:

236

348

"""An Avahi (Zeroconf) service.

237

349

238

350

Attributes:

239

351

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

240

352

Used to optionally bind to the specified interface.

252

364

server: D-Bus Server

253

365

bus: dbus.SystemBus()

254

366

"""

255

256

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

257

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

258

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

259

protocol = avahi.PROTO_UNSPEC, bus = None):

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

260

379

self.interface = interface

261

380

self.name = name

262

381

self.type = servicetype

271

390

self.server = None

272

391

self.bus = bus

273

392

self.entry_group_state_changed_match = None

274

275

def rename(self):

393

394

def rename(self, remove=True):

276

395

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

277

396

if self.rename_count >= self.max_renames:

278

397

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

279

398

" after %i retries, exiting.",

280

399

self.rename_count)

281

400

raise AvahiServiceError("Too many renames")

282

self.name = unicode(self.server

283

.GetAlternativeServiceName(self.name))

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

284

404

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

285

405

self.name)

286

self.remove()

406

if remove:

407

self.remove()

287

408

try:

288

409

self.add()

289

410

except dbus.exceptions.DBusException as error:

290

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

291

self.cleanup()

292

os._exit(1)

293

self.rename_count += 1

294

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

295

420

def remove(self):

296

421

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

297

422

if self.entry_group_state_changed_match is not None:

299

424

self.entry_group_state_changed_match = None

300

425

if self.group is not None:

301

426

self.group.Reset()

302

427

303

428

def add(self):

304

429

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

305

430

self.remove()

322

447

dbus.UInt16(self.port),

323

448

avahi.string_array_to_txt_array(self.TXT))

324

449

self.group.Commit()

325

450

326

451

def entry_group_state_changed(self, state, error):

327

452

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

328

453

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

329

454

330

455

if state == avahi.ENTRY_GROUP_ESTABLISHED:

331

456

logger.debug("Zeroconf service established.")

332

457

elif state == avahi.ENTRY_GROUP_COLLISION:

334

459

self.rename()

335

460

elif state == avahi.ENTRY_GROUP_FAILURE:

336

461

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

337

unicode(error))

338

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

339

.format(error))

340

462

str(error))

463

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

464

341

465

def cleanup(self):

342

466

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

343

467

if self.group is not None:

348

472

pass

349

473

self.group = None

350

474

self.remove()

351

475

352

476

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

353

477

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

354

478

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

355

bad_states = { avahi.SERVER_INVALID:

356

"Zeroconf server invalid",

357

avahi.SERVER_REGISTERING: None,

358

avahi.SERVER_COLLISION:

359

"Zeroconf server name collision",

360

avahi.SERVER_FAILURE:

361

"Zeroconf server failure" }

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

}

362

485

if state in bad_states:

363

486

if bad_states[state] is not None:

364

487

if error is None:

367

490

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

368

491

self.cleanup()

369

492

elif state == avahi.SERVER_RUNNING:

370

self.add()

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

logger.info("Local Zeroconf service name"

499

" collision.")

500

return self.rename(remove=False)

501

else:

502

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

503

self.cleanup()

504

os._exit(1)

371

505

else:

372

506

if error is None:

373

507

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

374

508

else:

375

509

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

376

510

377

511

def activate(self):

378

512

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

379

513

if self.server is None:

383

517

follow_name_owner_changes=True),

384

518

avahi.DBUS_INTERFACE_SERVER)

385

519

self.server.connect_to_signal("StateChanged",

386

self.server_state_changed)

520

self.server_state_changed)

387

521

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

388

522

389

523

390

524

class AvahiServiceToSyslog(AvahiService):

391

def rename(self):

525

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

392

526

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

393

ret = AvahiService.rename(self)

394

syslogger.setFormatter(logging.Formatter

395

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

396

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

397

.format(self.name)))

527

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

528

**kwargs)

529

syslogger.setFormatter(logging.Formatter(

530

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

531

.format(self.name)))

398

532

return ret

399

533

400

534

401

def timedelta_to_milliseconds(td):

402

"Convert a datetime.timedelta() to milliseconds"

403

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

404

+ (td.seconds * 1000)

405

+ (td.microseconds // 1000))

406

407

408

class Client(object):

535

# Pretend that we have a GnuTLS module

536

class gnutls:

537

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

538

539

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

540

if library is None:

541

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

542

_library = ctypes.cdll.LoadLibrary(library)

543

del library

544

545

# Unless otherwise indicated, the constants and types below are

546

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

547

548

# Constants

549

E_SUCCESS = 0

550

E_INTERRUPTED = -52

551

E_AGAIN = -28

552

CRT_OPENPGP = 2

553

CRT_RAWPK = 3

554

CLIENT = 2

555

SHUT_RDWR = 0

556

CRD_CERTIFICATE = 1

557

E_NO_CERTIFICATE_FOUND = -49

558

X509_FMT_DER = 0

559

NO_TICKETS = 1<<10

560

ENABLE_RAWPK = 1<<18

561

CTYPE_PEERS = 3

562

KEYID_USE_SHA256 = 1 # gnutls/x509.h

563

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

564

565

# Types

566

class session_int(ctypes.Structure):

567

_fields_ = []

568

session_t = ctypes.POINTER(session_int)

569

570

class certificate_credentials_st(ctypes.Structure):

571

_fields_ = []

572

certificate_credentials_t = ctypes.POINTER(

573

certificate_credentials_st)

574

certificate_type_t = ctypes.c_int

575

576

class datum_t(ctypes.Structure):

577

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

578

('size', ctypes.c_uint)]

579

580

class openpgp_crt_int(ctypes.Structure):

581

_fields_ = []

582

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

583

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

584

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

585

credentials_type_t = ctypes.c_int

586

transport_ptr_t = ctypes.c_void_p

587

close_request_t = ctypes.c_int

588

589

# Exceptions

590

class Error(Exception):

591

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

592

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

593

# code is passed, convert it to a string with

594

# gnutls.strerror()

595

self.code = code

596

if message is None and code is not None:

597

message = gnutls.strerror(code)

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

# Classes

605

class Credentials:

606

def __init__(self):

607

self._c_object = gnutls.certificate_credentials_t()

608

gnutls.certificate_allocate_credentials(

609

ctypes.byref(self._c_object))

610

self.type = gnutls.CRD_CERTIFICATE

611

612

def __del__(self):

613

gnutls.certificate_free_credentials(self._c_object)

614

615

class ClientSession:

616

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

617

self._c_object = gnutls.session_t()

618

gnutls_flags = gnutls.CLIENT

619

if gnutls.check_version(b"3.5.6"):

620

gnutls_flags |= gnutls.NO_TICKETS

621

if gnutls.has_rawpk:

622

gnutls_flags |= gnutls.ENABLE_RAWPK

623

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

624

del gnutls_flags

625

gnutls.set_default_priority(self._c_object)

626

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

627

gnutls.handshake_set_private_extensions(self._c_object,

628

True)

629

self.socket = socket

630

if credentials is None:

631

credentials = gnutls.Credentials()

632

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

633

ctypes.cast(credentials._c_object,

634

ctypes.c_void_p))

635

self.credentials = credentials

636

637

def __del__(self):

638

gnutls.deinit(self._c_object)

639

640

def handshake(self):

641

return gnutls.handshake(self._c_object)

642

643

def send(self, data):

644

data = bytes(data)

645

data_len = len(data)

646

while data_len > 0:

647

data_len -= gnutls.record_send(self._c_object,

648

data[-data_len:],

649

data_len)

650

651

def bye(self):

652

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

653

654

# Error handling functions

655

def _error_code(result):

656

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

657

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

658

if result >= 0:

659

return result

660

if result == gnutls.E_NO_CERTIFICATE_FOUND:

661

raise gnutls.CertificateSecurityError(code=result)

662

raise gnutls.Error(code=result)

663

664

def _retry_on_error(result, func, arguments):

665

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

666

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

667

while result < 0:

668

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

669

return _error_code(result)

670

result = func(*arguments)

671

return result

672

673

# Unless otherwise indicated, the function declarations below are

674

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

675

676

# Functions

677

priority_set_direct = _library.gnutls_priority_set_direct

678

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

679

ctypes.POINTER(ctypes.c_char_p)]

680

priority_set_direct.restype = _error_code

681

682

init = _library.gnutls_init

683

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

684

init.restype = _error_code

685

686

set_default_priority = _library.gnutls_set_default_priority

687

set_default_priority.argtypes = [session_t]

688

set_default_priority.restype = _error_code

689

690

record_send = _library.gnutls_record_send

691

record_send.argtypes = [session_t, ctypes.c_void_p,

692

ctypes.c_size_t]

693

record_send.restype = ctypes.c_ssize_t

694

record_send.errcheck = _retry_on_error

695

696

certificate_allocate_credentials = (

697

_library.gnutls_certificate_allocate_credentials)

698

certificate_allocate_credentials.argtypes = [

699

ctypes.POINTER(certificate_credentials_t)]

700

certificate_allocate_credentials.restype = _error_code

701

702

certificate_free_credentials = (

703

_library.gnutls_certificate_free_credentials)

704

certificate_free_credentials.argtypes = [

705

certificate_credentials_t]

706

certificate_free_credentials.restype = None

707

708

handshake_set_private_extensions = (

709

_library.gnutls_handshake_set_private_extensions)

710

handshake_set_private_extensions.argtypes = [session_t,

711

ctypes.c_int]

712

handshake_set_private_extensions.restype = None

713

714

credentials_set = _library.gnutls_credentials_set

715

credentials_set.argtypes = [session_t, credentials_type_t,

716

ctypes.c_void_p]

717

credentials_set.restype = _error_code

718

719

strerror = _library.gnutls_strerror

720

strerror.argtypes = [ctypes.c_int]

721

strerror.restype = ctypes.c_char_p

722

723

certificate_type_get = _library.gnutls_certificate_type_get

724

certificate_type_get.argtypes = [session_t]

725

certificate_type_get.restype = _error_code

726

727

certificate_get_peers = _library.gnutls_certificate_get_peers

728

certificate_get_peers.argtypes = [session_t,

729

ctypes.POINTER(ctypes.c_uint)]

730

certificate_get_peers.restype = ctypes.POINTER(datum_t)

731

732

global_set_log_level = _library.gnutls_global_set_log_level

733

global_set_log_level.argtypes = [ctypes.c_int]

734

global_set_log_level.restype = None

735

736

global_set_log_function = _library.gnutls_global_set_log_function

737

global_set_log_function.argtypes = [log_func]

738

global_set_log_function.restype = None

739

740

deinit = _library.gnutls_deinit

741

deinit.argtypes = [session_t]

742

deinit.restype = None

743

744

handshake = _library.gnutls_handshake

745

handshake.argtypes = [session_t]

746

handshake.restype = _error_code

747

handshake.errcheck = _retry_on_error

748

749

transport_set_ptr = _library.gnutls_transport_set_ptr

750

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

751

transport_set_ptr.restype = None

752

753

bye = _library.gnutls_bye

754

bye.argtypes = [session_t, close_request_t]

755

bye.restype = _error_code

756

bye.errcheck = _retry_on_error

757

758

check_version = _library.gnutls_check_version

759

check_version.argtypes = [ctypes.c_char_p]

760

check_version.restype = ctypes.c_char_p

761

762

_need_version = b"3.3.0"

763

if check_version(_need_version) is None:

764

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

765

.format(_need_version))

766

767

_tls_rawpk_version = b"3.6.6"

768

has_rawpk = bool(check_version(_tls_rawpk_version))

769

770

if has_rawpk:

771

# Types

772

class pubkey_st(ctypes.Structure):

773

_fields = []

774

pubkey_t = ctypes.POINTER(pubkey_st)

775

776

x509_crt_fmt_t = ctypes.c_int

777

778

# All the function declarations below are from

779

# gnutls/abstract.h

780

pubkey_init = _library.gnutls_pubkey_init

781

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

782

pubkey_init.restype = _error_code

783

784

pubkey_import = _library.gnutls_pubkey_import

785

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

786

x509_crt_fmt_t]

787

pubkey_import.restype = _error_code

788

789

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

790

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

791

ctypes.POINTER(ctypes.c_ubyte),

792

ctypes.POINTER(ctypes.c_size_t)]

793

pubkey_get_key_id.restype = _error_code

794

795

pubkey_deinit = _library.gnutls_pubkey_deinit

796

pubkey_deinit.argtypes = [pubkey_t]

797

pubkey_deinit.restype = None

798

else:

799

# All the function declarations below are from

800

# gnutls/openpgp.h

801

802

openpgp_crt_init = _library.gnutls_openpgp_crt_init

803

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

804

openpgp_crt_init.restype = _error_code

805

806

openpgp_crt_import = _library.gnutls_openpgp_crt_import

807

openpgp_crt_import.argtypes = [openpgp_crt_t,

808

ctypes.POINTER(datum_t),

809

openpgp_crt_fmt_t]

810

openpgp_crt_import.restype = _error_code

811

812

openpgp_crt_verify_self = \

813

_library.gnutls_openpgp_crt_verify_self

814

openpgp_crt_verify_self.argtypes = [

815

openpgp_crt_t,

816

ctypes.c_uint,

817

ctypes.POINTER(ctypes.c_uint),

818

]

819

openpgp_crt_verify_self.restype = _error_code

820

821

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

822

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

823

openpgp_crt_deinit.restype = None

824

825

openpgp_crt_get_fingerprint = (

826

_library.gnutls_openpgp_crt_get_fingerprint)

827

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

828

ctypes.c_void_p,

829

ctypes.POINTER(

830

ctypes.c_size_t)]

831

openpgp_crt_get_fingerprint.restype = _error_code

832

833

if check_version(b"3.6.4"):

834

certificate_type_get2 = _library.gnutls_certificate_type_get2

835

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

836

certificate_type_get2.restype = _error_code

837

838

# Remove non-public functions

839

del _error_code, _retry_on_error

840

841

842

def call_pipe(connection, # : multiprocessing.Connection

843

func, *args, **kwargs):

844

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

845

846

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

847

return value on the provided multiprocessing.Connection.

848

"""

849

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

850

connection.close()

851

852

853

class Client:

409

854

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

410

855

411

856

Attributes:

412

857

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

413

858

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

414

859

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

415

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

416

to see if the client lives.

417

'None' if no process is running.

418

checker_callback_tag: a gobject event source tag, or None

860

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

861

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

862

running.

863

checker_callback_tag: a GLib event source tag, or None

419

864

checker_command: string; External command which is run to check

420

865

if client lives. %() expansions are done at

421

866

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

422

867

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

423

checker_initiator_tag: a gobject event source tag, or None

868

checker_initiator_tag: a GLib event source tag, or None

424

869

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

425

870

client_structure: Object describing what attributes a client has

426

871

and is used for storing the client at exit

427

872

current_checker_command: string; current running checker_command

428

disable_initiator_tag: a gobject event source tag, or None

873

disable_initiator_tag: a GLib event source tag, or None

429

874

enabled: bool()

430

875

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

431

uniquely identify the client

876

uniquely identify an OpenPGP client

877

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

878

a client using raw public keys

432

879

host: string; available for use by the checker command

433

880

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

434

881

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

436

883

last_checker_status: integer between 0 and 255 reflecting exit

437

884

status of last checker. -1 reflects crashed

438

885

checker, -2 means no checker completed yet.

886

last_checker_signal: The signal which killed the last checker, if

887

last_checker_status is -1

439

888

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

440

889

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

441

890

D-Bus identifiers

448

897

disabled, or None

449

898

server_settings: The server_settings dict from main()

450

899

"""

451

900

452

901

runtime_expansions = ("approval_delay", "approval_duration",

453

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

902

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

454

903

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

455

904

"last_approval_request", "last_checked_ok",

456

905

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

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

460

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

461

"host": "",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

464

"approved_by_default": "True",

465

"enabled": "True",

466

}

467

468

def timeout_milliseconds(self):

469

"Return the 'timeout' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.timeout)

471

472

def extended_timeout_milliseconds(self):

473

"Return the 'extended_timeout' attribute in milliseconds"

474

return timedelta_to_milliseconds(self.extended_timeout)

475

476

def interval_milliseconds(self):

477

"Return the 'interval' attribute in milliseconds"

478

return timedelta_to_milliseconds(self.interval)

479

480

def approval_delay_milliseconds(self):

481

return timedelta_to_milliseconds(self.approval_delay)

482

906

client_defaults = {

907

"timeout": "PT5M",

908

"extended_timeout": "PT15M",

909

"interval": "PT2M",

910

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

911

"host": "",

912

"approval_delay": "PT0S",

913

"approval_duration": "PT1S",

914

"approved_by_default": "True",

915

"enabled": "True",

916

}

917

483

918

@staticmethod

484

919

def config_parser(config):

485

920

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

492

927

for client_name in config.sections():

493

928

section = dict(config.items(client_name))

494

929

client = settings[client_name] = {}

495

930

496

931

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

497

932

# Reformat values from string types to Python types

498

933

client["approved_by_default"] = config.getboolean(

499

934

client_name, "approved_by_default")

500

935

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

501

936

"enabled")

502

937

938

# Uppercase and remove spaces from key_id and fingerprint

939

# for later comparison purposes with return value from the

940

# key_id() and fingerprint() functions

941

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

942

.replace(" ", ""))

503

943

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

504

944

.replace(" ", ""))

505

945

if "secret" in section:

506

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

946

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

947

.encode("utf-8"),

948

"base64")

507

949

elif "secfile" in section:

508

950

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

509

951

(section["secfile"])),

510

952

"rb") as secfile:

511

953

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

512

954

else:

513

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

955

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

514

956

.format(section))

515

957

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

516

958

client["extended_timeout"] = string_to_delta(

524

966

client["last_approval_request"] = None

525

967

client["last_checked_ok"] = None

526

968

client["last_checker_status"] = -2

527

969

528

970

return settings

529

530

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

971

972

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

531

973

self.name = name

532

974

if server_settings is None:

533

975

server_settings = {}

534

976

self.server_settings = server_settings

535

977

# adding all client settings

536

for setting, value in settings.iteritems():

978

for setting, value in settings.items():

537

979

setattr(self, setting, value)

538

980

539

981

if self.enabled:

540

982

if not hasattr(self, "last_enabled"):

541

983

self.last_enabled = datetime.datetime.utcnow()

545

987

else:

546

988

self.last_enabled = None

547

989

self.expires = None

548

990

549

991

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

550

# Uppercase and remove spaces from fingerprint for later

551

# comparison purposes with return value from the fingerprint()

552

# function

992

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

553

993

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

554

994

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

555

995

datetime.datetime.utcnow())

556

996

557

997

# attributes specific for this server instance

558

998

self.checker = None

559

999

self.checker_initiator_tag = None

562

1002

self.current_checker_command = None

563

1003

self.approved = None

564

1004

self.approvals_pending = 0

565

self.changedstate = (multiprocessing_manager

566

.Condition(multiprocessing_manager

567

.Lock()))

568

self.client_structure = [attr for attr in

569

self.__dict__.iterkeys()

1005

self.changedstate = multiprocessing_manager.Condition(

1006

multiprocessing_manager.Lock())

1007

self.client_structure = [attr

1008

for attr in self.__dict__.keys()

570

1009

if not attr.startswith("_")]

571

1010

self.client_structure.append("client_structure")

572

573

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

574

lambda obj:

575

isinstance(obj,

576

property)):

1011

1012

for name, t in inspect.getmembers(

1013

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

577

1014

if not name.startswith("_"):

578

1015

self.client_structure.append(name)

579

1016

580

1017

# Send notice to process children that client state has changed

581

1018

def send_changedstate(self):

582

1019

with self.changedstate:

583

1020

self.changedstate.notify_all()

584

1021

585

1022

def enable(self):

586

1023

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

587

1024

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

592

1029

self.last_enabled = datetime.datetime.utcnow()

593

1030

self.init_checker()

594

1031

self.send_changedstate()

595

1032

596

1033

def disable(self, quiet=True):

597

1034

"""Disable this client."""

598

1035

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

600

1037

if not quiet:

601

1038

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

602

1039

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

603

gobject.source_remove(self.disable_initiator_tag)

1040

GLib.source_remove(self.disable_initiator_tag)

604

1041

self.disable_initiator_tag = None

605

1042

self.expires = None

606

1043

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

607

gobject.source_remove(self.checker_initiator_tag)

1044

GLib.source_remove(self.checker_initiator_tag)

608

1045

self.checker_initiator_tag = None

609

1046

self.stop_checker()

610

1047

self.enabled = False

611

1048

if not quiet:

612

1049

self.send_changedstate()

613

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

1050

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

614

1051

return False

615

1052

616

1053

def __del__(self):

617

1054

self.disable()

618

1055

619

1056

def init_checker(self):

620

1057

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

621

1058

# and every interval from then on.

622

1059

if self.checker_initiator_tag is not None:

623

gobject.source_remove(self.checker_initiator_tag)

624

self.checker_initiator_tag = (gobject.timeout_add

625

(self.interval_milliseconds(),

626

self.start_checker))

1060

GLib.source_remove(self.checker_initiator_tag)

1061

self.checker_initiator_tag = GLib.timeout_add(

1062

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

1063

+ 1)),

1064

self.start_checker)

627

1065

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

628

1066

if self.disable_initiator_tag is not None:

629

gobject.source_remove(self.disable_initiator_tag)

630

self.disable_initiator_tag = (gobject.timeout_add

631

(self.timeout_milliseconds(),

632

self.disable))

1067

GLib.source_remove(self.disable_initiator_tag)

1068

self.disable_initiator_tag = GLib.timeout_add(

1069

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

633

1070

# Also start a new checker *right now*.

634

1071

self.start_checker()

635

636

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

1072

1073

def checker_callback(self, source, condition, connection,

1074

command):

637

1075

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

1076

# Read return code from connection (see call_pipe)

1077

returncode = connection.recv()

1078

connection.close()

1079

if self.checker is not None:

1080

self.checker.join()

638

1081

self.checker_callback_tag = None

639

1082

self.checker = None

640

if os.WIFEXITED(condition):

641

self.last_checker_status = os.WEXITSTATUS(condition)

1083

1084

if returncode >= 0:

1085

self.last_checker_status = returncode

1086

self.last_checker_signal = None

642

1087

if self.last_checker_status == 0:

643

1088

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

644

1089

vars(self))

645

1090

self.checked_ok()

646

1091

else:

647

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

648

vars(self))

1092

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

649

1093

else:

650

1094

self.last_checker_status = -1

1095

self.last_checker_signal = -returncode

651

1096

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

652

1097

vars(self))

653

1098

return False

1099

654

1100

def checked_ok(self):

655

1101

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

656

1102

self.last_checked_ok = datetime.datetime.utcnow()

657

1103

self.last_checker_status = 0

1104

self.last_checker_signal = None

658

1105

self.bump_timeout()

659

1106

660

1107

def bump_timeout(self, timeout=None):

661

1108

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

662

1109

if timeout is None:

663

1110

timeout = self.timeout

664

1111

if self.disable_initiator_tag is not None:

665

gobject.source_remove(self.disable_initiator_tag)

1112

GLib.source_remove(self.disable_initiator_tag)

666

1113

self.disable_initiator_tag = None

667

1114

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

668

self.disable_initiator_tag = (gobject.timeout_add

669

(timedelta_to_milliseconds

670

(timeout), self.disable))

1115

self.disable_initiator_tag = GLib.timeout_add(

1116

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

671

1117

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

672

1118

673

1119

def need_approval(self):

674

1120

self.last_approval_request = datetime.datetime.utcnow()

675

1121

676

1122

def start_checker(self):

677

1123

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

678

1124

679

1125

If a checker already exists, leave it running and do

680

1126

nothing."""

681

1127

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

686

1132

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

687

1133

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

688

1134

# should be.

689

690

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

691

try:

692

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

693

except (AttributeError, OSError) as error:

694

if (isinstance(error, OSError)

695

and error.errno != errno.ECHILD):

696

raise error

697

else:

698

if pid:

699

logger.warning("Checker was a zombie")

700

gobject.source_remove(self.checker_callback_tag)

701

self.checker_callback(pid, status,

702

self.current_checker_command)

1135

1136

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

1137

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

1138

self.checker.join()

1139

self.checker = None

703

1140

# Start a new checker if needed

704

1141

if self.checker is None:

705

1142

# Escape attributes for the shell

706

escaped_attrs = dict(

707

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

708

for attr in

709

self.runtime_expansions)

1143

escaped_attrs = {

1144

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

1145

for attr in self.runtime_expansions}

710

1146

try:

711

1147

command = self.checker_command % escaped_attrs

712

1148

except TypeError as error:

713

1149

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

714

self.checker_command, exc_info=error)

715

return True # Try again later

1150

self.checker_command,

1151

exc_info=error)

1152

return True # Try again later

716

1153

self.current_checker_command = command

717

try:

718

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

719

command, self.name)

720

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

721

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

722

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

723

# always replaced by /dev/null.)

724

# The exception is when not debugging but nevertheless

725

# running in the foreground; use the previously

726

# created wnull.

727

popen_args = {}

728

if (not self.server_settings["debug"]

729

and self.server_settings["foreground"]):

730

popen_args.update({"stdout": wnull,

731

"stderr": wnull })

732

self.checker = subprocess.Popen(command,

733

close_fds=True,

734

shell=True, cwd="/",

735

**popen_args)

736

except OSError as error:

737

logger.error("Failed to start subprocess",

738

exc_info=error)

739

return True

740

self.checker_callback_tag = (gobject.child_watch_add

741

(self.checker.pid,

742

self.checker_callback,

743

data=command))

744

# The checker may have completed before the gobject

745

# watch was added. Check for this.

746

try:

747

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

748

except OSError as error:

749

if error.errno == errno.ECHILD:

750

# This should never happen

751

logger.error("Child process vanished",

752

exc_info=error)

753

return True

754

raise

755

if pid:

756

gobject.source_remove(self.checker_callback_tag)

757

self.checker_callback(pid, status, command)

758

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

1154

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

1155

self.name)

1156

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

1157

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

1158

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

1159

# always replaced by /dev/null.)

1160

# The exception is when not debugging but nevertheless

1161

# running in the foreground; use the previously

1162

# created wnull.

1163

popen_args = {"close_fds": True,

1164

"shell": True,

1165

"cwd": "/"}

1166

if (not self.server_settings["debug"]

1167

and self.server_settings["foreground"]):

1168

popen_args.update({"stdout": wnull,

1169

"stderr": wnull})

1170

pipe = multiprocessing.Pipe(duplex=False)

1171

self.checker = multiprocessing.Process(

1172

target=call_pipe,

1173

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

1174

kwargs=popen_args)

1175

self.checker.start()

1176

self.checker_callback_tag = GLib.io_add_watch(

1177

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

1178

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1179

self.checker_callback, pipe[0], command)

1180

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

759

1181

return True

760

1182

761

1183

def stop_checker(self):

762

1184

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

763

1185

if self.checker_callback_tag:

764

gobject.source_remove(self.checker_callback_tag)

1186

GLib.source_remove(self.checker_callback_tag)

765

1187

self.checker_callback_tag = None

766

1188

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

767

1189

return

768

1190

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

769

try:

770

self.checker.terminate()

771

#time.sleep(0.5)

772

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

773

# self.checker.kill()

774

except OSError as error:

775

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

776

raise

1191

self.checker.terminate()

777

1192

self.checker = None

778

1193

779

1194

780

def dbus_service_property(dbus_interface, signature="v",

781

access="readwrite", byte_arrays=False):

1195

def dbus_service_property(dbus_interface,

1196

signature="v",

1197

access="readwrite",

1198

byte_arrays=False):

782

1199

"""Decorators for marking methods of a DBusObjectWithProperties to

783

1200

become properties on the D-Bus.

784

1201

785

1202

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

786

1203

and with one argument by "Set".

787

1204

788

1205

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

789

1206

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

790

1207

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

793

1210

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

794

1211

if byte_arrays and signature != "ay":

795

1212

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

796

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

1213

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

1214

797

1215

def decorator(func):

798

1216

func._dbus_is_property = True

799

1217

func._dbus_interface = dbus_interface

802

1220

func._dbus_name = func.__name__

803

1221

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

804

1222

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

805

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1223

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

806

1224

return func

1225

807

1226

return decorator

808

1227

809

1228

810

1229

def dbus_interface_annotations(dbus_interface):

811

1230

"""Decorator for marking functions returning interface annotations

812

1231

813

1232

Usage:

814

1233

815

1234

@dbus_interface_annotations("org.example.Interface")

816

1235

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

817

1236

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

818

1237

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

819

1238

"false"}

820

1239

"""

1240

821

1241

def decorator(func):

822

1242

func._dbus_is_interface = True

823

1243

func._dbus_interface = dbus_interface

824

1244

func._dbus_name = dbus_interface

825

1245

return func

1246

826

1247

return decorator

827

1248

828

1249

829

1250

def dbus_annotations(annotations):

830

1251

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

831

1252

Usage:

832

1253

1254

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

1255

"org.freedesktop.DBus.Property."

1256

"EmitsChangedSignal": "false"})

833

1257

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

834

1258

access="r")

835

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

836

"org.freedesktop.DBus.Property."

837

"EmitsChangedSignal": "false"})

838

1259

def Property_dbus_property(self):

839

1260

return dbus.Boolean(False)

1261

1262

See also the DBusObjectWithAnnotations class.

840

1263

"""

1264

841

1265

def decorator(func):

842

1266

func._dbus_annotations = annotations

843

1267

return func

1268

844

1269

return decorator

845

1270

846

1271

847

1272

class DBusPropertyException(dbus.exceptions.DBusException):

848

1273

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

849

1274

"""

850

def __unicode__(self):

851

return unicode(str(self))

1275

pass

852

1276

853

1277

854

1278

class DBusPropertyAccessException(DBusPropertyException):

863

1287

pass

864

1288

865

1289

866

class DBusObjectWithProperties(dbus.service.Object):

867

"""A D-Bus object with properties.

868

869

Classes inheriting from this can use the dbus_service_property

870

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

871

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

1290

class DBusObjectWithAnnotations(dbus.service.Object):

1291

"""A D-Bus object with annotations.

1292

1293

Classes inheriting from this can use the dbus_annotations

1294

decorator to add annotations to methods or signals.

872

1295

"""

873

1296

874

1297

@staticmethod

875

1298

def _is_dbus_thing(thing):

876

1299

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

877

1300

878

1301

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

879

1302

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

880

1303

"""

881

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

1304

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

882

1305

False)

883

1306

884

1307

def _get_all_dbus_things(self, thing):

885

1308

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

886

1309

"""

887

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

888

name),

1310

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

889

1311

athing.__get__(self))

890

1312

for cls in self.__class__.__mro__

891

1313

for name, athing in

892

inspect.getmembers(cls,

893

self._is_dbus_thing(thing)))

894

1314

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

1315

1316

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1317

out_signature="s",

1318

path_keyword='object_path',

1319

connection_keyword='connection')

1320

def Introspect(self, object_path, connection):

1321

"""Overloading of standard D-Bus method.

1322

1323

Inserts annotation tags on methods and signals.

1324

"""

1325

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

1326

connection)

1327

try:

1328

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

1329

1330

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

1331

# Add annotation tags

1332

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

1333

for tag in if_tag.getElementsByTagName(typ):

1334

annots = dict()

1335

for name, prop in (self.

1336

_get_all_dbus_things(typ)):

1337

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

1338

and prop._dbus_interface

1339

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

1340

annots.update(getattr(

1341

prop, "_dbus_annotations", {}))

1342

for name, value in annots.items():

1343

ann_tag = document.createElement(

1344

"annotation")

1345

ann_tag.setAttribute("name", name)

1346

ann_tag.setAttribute("value", value)

1347

tag.appendChild(ann_tag)

1348

# Add interface annotation tags

1349

for annotation, value in dict(

1350

itertools.chain.from_iterable(

1351

annotations().items()

1352

for name, annotations

1353

in self._get_all_dbus_things("interface")

1354

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

1355

)).items():

1356

ann_tag = document.createElement("annotation")

1357

ann_tag.setAttribute("name", annotation)

1358

ann_tag.setAttribute("value", value)

1359

if_tag.appendChild(ann_tag)

1360

# Fix argument name for the Introspect method itself

1361

if (if_tag.getAttribute("name")

1362

== dbus.INTROSPECTABLE_IFACE):

1363

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

1364

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

1365

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

1366

if (arg.getAttribute("direction")

1367

== "out"):

1368

arg.setAttribute("name",

1369

"xml_data")

1370

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

1371

document.unlink()

1372

except (AttributeError, xml.dom.DOMException,

1373

xml.parsers.expat.ExpatError) as error:

1374

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

1375

exc_info=error)

1376

return xmlstring

1377

1378

1379

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1380

"""A D-Bus object with properties.

1381

1382

Classes inheriting from this can use the dbus_service_property

1383

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

1384

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

1385

"""

1386

895

1387

def _get_dbus_property(self, interface_name, property_name):

896

1388

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

897

1389

property with the specified name and interface.

898

1390

"""

899

for cls in self.__class__.__mro__:

900

for name, value in (inspect.getmembers

901

(cls,

902

self._is_dbus_thing("property"))):

1391

for cls in self.__class__.__mro__:

1392

for name, value in inspect.getmembers(

1393

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

903

1394

if (value._dbus_name == property_name

904

1395

and value._dbus_interface == interface_name):

905

1396

return value.__get__(self)

906

1397

907

1398

# No such property

908

raise DBusPropertyNotFound(self.dbus_object_path + ":"

909

+ interface_name + "."

910

+ property_name)

911

912

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

1399

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

1400

self.dbus_object_path, interface_name, property_name))

1401

1402

@classmethod

1403

def _get_all_interface_names(cls):

1404

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

1405

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

1406

"_dbus_interface", None)

1407

for x in (inspect.getmro(cls))

1408

for attr in dir(x))

1409

if name is not None)

1410

1411

@dbus.service.method(dbus.PROPERTIES_IFACE,

1412

in_signature="ss",

913

1413

out_signature="v")

914

1414

def Get(self, interface_name, property_name):

915

1415

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

921

1421

if not hasattr(value, "variant_level"):

922

1422

return value

923

1423

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

924

1424

925

1425

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

926

1426

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

927

1427

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

933

1433

# The byte_arrays option is not supported yet on

934

1434

# signatures other than "ay".

935

1435

if prop._dbus_signature != "ay":

936

raise ValueError

937

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

938

for byte in value))

1436

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

1437

"'ay' signature {!r}"

1438

.format(prop._dbus_signature))

1439

value = dbus.ByteArray(bytes(value))

939

1440

prop(value)

940

941

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

1441

1442

@dbus.service.method(dbus.PROPERTIES_IFACE,

1443

in_signature="s",

942

1444

out_signature="a{sv}")

943

1445

def GetAll(self, interface_name):

944

1446

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

945

1447

standard.

946

1448

947

1449

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

948

1450

"""

949

1451

properties = {}

959

1461

if not hasattr(value, "variant_level"):

960

1462

properties[name] = value

961

1463

continue

962

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

963

value.variant_level+1)

1464

properties[name] = type(value)(

1465

value, variant_level=value.variant_level + 1)

964

1466

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

965

1467

1468

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

1469

def PropertiesChanged(self, interface_name, changed_properties,

1470

invalidated_properties):

1471

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

1472

standard.

1473

"""

1474

pass

1475

966

1476

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

967

1477

out_signature="s",

968

1478

path_keyword='object_path',

969

1479

connection_keyword='connection')

970

1480

def Introspect(self, object_path, connection):

971

1481

"""Overloading of standard D-Bus method.

972

1482

973

1483

Inserts property tags and interface annotation tags.

974

1484

"""

975

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

976

connection)

1485

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1486

object_path,

1487

connection)

977

1488

try:

978

1489

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

1490

979

1491

def make_tag(document, name, prop):

980

1492

e = document.createElement("property")

981

1493

e.setAttribute("name", name)

982

1494

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

983

1495

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

984

1496

return e

1497

985

1498

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

986

1499

# Add property tags

987

1500

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

990

1503

if prop._dbus_interface

991

1504

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

992

1505

if_tag.appendChild(tag)

993

# Add annotation tags

994

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

995

for tag in if_tag.getElementsByTagName(typ):

996

annots = dict()

997

for name, prop in (self.

998

_get_all_dbus_things(typ)):

999

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

1000

and prop._dbus_interface

1001

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

1002

annots.update(getattr

1003

(prop,

1004

"_dbus_annotations",

1005

{}))

1006

for name, value in annots.iteritems():

1007

ann_tag = document.createElement(

1008

"annotation")

1009

ann_tag.setAttribute("name", name)

1010

ann_tag.setAttribute("value", value)

1011

tag.appendChild(ann_tag)

1012

# Add interface annotation tags

1013

for annotation, value in dict(

1014

itertools.chain.from_iterable(

1015

annotations().iteritems()

1016

for name, annotations in

1017

self._get_all_dbus_things("interface")

1018

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

1019

)).iteritems():

1020

ann_tag = document.createElement("annotation")

1021

ann_tag.setAttribute("name", annotation)

1022

ann_tag.setAttribute("value", value)

1023

if_tag.appendChild(ann_tag)

1506

# Add annotation tags for properties

1507

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

1508

annots = dict()

1509

for name, prop in self._get_all_dbus_things(

1510

"property"):

1511

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

1512

and prop._dbus_interface

1513

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

1514

annots.update(getattr(

1515

prop, "_dbus_annotations", {}))

1516

for name, value in annots.items():

1517

ann_tag = document.createElement(

1518

"annotation")

1519

ann_tag.setAttribute("name", name)

1520

ann_tag.setAttribute("value", value)

1521

tag.appendChild(ann_tag)

1024

1522

# Add the names to the return values for the

1025

1523

# "org.freedesktop.DBus.Properties" methods

1026

1524

if (if_tag.getAttribute("name")

1045

1543

return xmlstring

1046

1544

1047

1545

1546

try:

1547

dbus.OBJECT_MANAGER_IFACE

1548

except AttributeError:

1549

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

1550

1551

1552

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1553

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

1554

1555

Classes inheriting from this exposes the standard

1556

GetManagedObjects call and the InterfacesAdded and

1557

InterfacesRemoved signals on the standard

1558

"org.freedesktop.DBus.ObjectManager" interface.

1559

1560

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

1561

manually.

1562

"""

1563

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1564

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

1565

def GetManagedObjects(self):

1566

"""This function must be overridden"""

1567

raise NotImplementedError()

1568

1569

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1570

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

1571

def InterfacesAdded(self, object_path, interfaces_and_properties):

1572

pass

1573

1574

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

1575

def InterfacesRemoved(self, object_path, interfaces):

1576

pass

1577

1578

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1579

out_signature="s",

1580

path_keyword='object_path',

1581

connection_keyword='connection')

1582

def Introspect(self, object_path, connection):

1583

"""Overloading of standard D-Bus method.

1584

1585

Override return argument name of GetManagedObjects to be

1586

"objpath_interfaces_and_properties"

1587

"""

1588

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1589

object_path,

1590

connection)

1591

try:

1592

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

1593

1594

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

1595

# Fix argument name for the GetManagedObjects method

1596

if (if_tag.getAttribute("name")

1597

== dbus.OBJECT_MANAGER_IFACE):

1598

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

1599

if (cn.getAttribute("name")

1600

== "GetManagedObjects"):

1601

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

1602

if (arg.getAttribute("direction")

1603

== "out"):

1604

arg.setAttribute(

1605

"name",

1606

"objpath_interfaces"

1607

"_and_properties")

1608

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

1609

document.unlink()

1610

except (AttributeError, xml.dom.DOMException,

1611

xml.parsers.expat.ExpatError) as error:

1612

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

1613

exc_info=error)

1614

return xmlstring

1615

1616

1048

1617

def datetime_to_dbus(dt, variant_level=0):

1049

1618

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

1050

1619

if dt is None:

1051

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

1052

return dbus.String(dt.isoformat(),

1053

variant_level=variant_level)

1620

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

1621

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

1054

1622

1055

1623

1056

1624

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1058

1626

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

1059

1627

interface names according to the "alt_interface_names" mapping.

1060

1628

Usage:

1061

1629

1062

1630

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

1063

1631

"net.example.AlternateInterface"})

1064

1632

class SampleDBusObject(dbus.service.Object):

1065

1633

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

1066

1634

def SampleDBusMethod():

1067

1635

pass

1068

1636

1069

1637

The above "SampleDBusMethod" on "SampleDBusObject" will be

1070

1638

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

1071

1639

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

1072

1640

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

1073

1641

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

1074

1642

1075

1643

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

1076

1644

(from DBusObjectWithProperties) and interfaces (from the

1077

1645

dbus_interface_annotations decorator).

1078

1646

"""

1647

1079

1648

def wrapper(cls):

1080

1649

for orig_interface_name, alt_interface_name in (

1081

alt_interface_names.iteritems()):

1650

alt_interface_names.items()):

1082

1651

attr = {}

1083

1652

interface_names = set()

1084

1653

# Go though all attributes of the class

1086

1655

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

1087

1656

# with the wrong interface name

1088

1657

if (not hasattr(attribute, "_dbus_interface")

1089

or not attribute._dbus_interface

1090

.startswith(orig_interface_name)):

1658

or not attribute._dbus_interface.startswith(

1659

orig_interface_name)):

1091

1660

continue

1092

1661

# Create an alternate D-Bus interface name based on

1093

1662

# the current name

1094

alt_interface = (attribute._dbus_interface

1095

.replace(orig_interface_name,

1096

alt_interface_name))

1663

alt_interface = attribute._dbus_interface.replace(

1664

orig_interface_name, alt_interface_name)

1097

1665

interface_names.add(alt_interface)

1098

1666

# Is this a D-Bus signal?

1099

1667

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

1100

1668

# Extract the original non-method undecorated

1101

1669

# function by black magic

1102

nonmethod_func = (dict(

1670

if sys.version_info.major == 2:

1671

nonmethod_func = (dict(

1103

1672

zip(attribute.func_code.co_freevars,

1104

attribute.__closure__))["func"]

1105

.cell_contents)

1673

attribute.__closure__))

1674

["func"].cell_contents)

1675

else:

1676

nonmethod_func = (dict(

1677

zip(attribute.__code__.co_freevars,

1678

attribute.__closure__))

1679

["func"].cell_contents)

1106

1680

# Create a new, but exactly alike, function

1107

1681

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

1108

1682

# with the alternate D-Bus interface name

1109

new_function = (dbus.service.signal

1110

(alt_interface,

1111

attribute._dbus_signature)

1112

(types.FunctionType(

1113

nonmethod_func.func_code,

1114

nonmethod_func.func_globals,

1115

nonmethod_func.func_name,

1116

nonmethod_func.func_defaults,

1117

nonmethod_func.func_closure)))

1683

new_function = copy_function(nonmethod_func)

1684

new_function = (dbus.service.signal(

1685

alt_interface,

1686

attribute._dbus_signature)(new_function))

1118

1687

# Copy annotations, if any

1119

1688

try:

1120

new_function._dbus_annotations = (

1121

dict(attribute._dbus_annotations))

1689

new_function._dbus_annotations = dict(

1690

attribute._dbus_annotations)

1122

1691

except AttributeError:

1123

1692

pass

1693

1124

1694

# Define a creator of a function to call both the

1125

1695

# original and alternate functions, so both the

1126

1696

# original and alternate signals gets sent when

1129

1699

"""This function is a scope container to pass

1130

1700

func1 and func2 to the "call_both" function

1131

1701

outside of its arguments"""

1702

1703

@functools.wraps(func2)

1132

1704

def call_both(*args, **kwargs):

1133

1705

"""This function will emit two D-Bus

1134

1706

signals by calling func1 and func2"""

1135

1707

func1(*args, **kwargs)

1136

1708

func2(*args, **kwargs)

1709

# Make wrapper function look like a D-Bus

1710

# signal

1711

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

1712

if name.startswith("_dbus_"):

1713

setattr(call_both, name, attr)

1714

1137

1715

return call_both

1138

1716

# Create the "call_both" function and add it to

1139

1717

# the class

1144

1722

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

1145

1723

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

1146

1724

# to the class.

1147

attr[attrname] = (dbus.service.method

1148

(alt_interface,

1149

attribute._dbus_in_signature,

1150

attribute._dbus_out_signature)

1151

(types.FunctionType

1152

(attribute.func_code,

1153

attribute.func_globals,

1154

attribute.func_name,

1155

attribute.func_defaults,

1156

attribute.func_closure)))

1725

attr[attrname] = (

1726

dbus.service.method(

1727

alt_interface,

1728

attribute._dbus_in_signature,

1729

attribute._dbus_out_signature)

1730

(copy_function(attribute)))

1157

1731

# Copy annotations, if any

1158

1732

try:

1159

attr[attrname]._dbus_annotations = (

1160

dict(attribute._dbus_annotations))

1733

attr[attrname]._dbus_annotations = dict(

1734

attribute._dbus_annotations)

1161

1735

except AttributeError:

1162

1736

pass

1163

1737

# Is this a D-Bus property?

1166

1740

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

1167

1741

# property with the alternate D-Bus interface

1168

1742

# name. Add it to the class.

1169

attr[attrname] = (dbus_service_property

1170

(alt_interface,

1171

attribute._dbus_signature,

1172

attribute._dbus_access,

1173

attribute

1174

._dbus_get_args_options

1175

["byte_arrays"])

1176

(types.FunctionType

1177

(attribute.func_code,

1178

attribute.func_globals,

1179

attribute.func_name,

1180

attribute.func_defaults,

1181

attribute.func_closure)))

1743

attr[attrname] = (dbus_service_property(

1744

alt_interface, attribute._dbus_signature,

1745

attribute._dbus_access,

1746

attribute._dbus_get_args_options

1747

["byte_arrays"])

1748

(copy_function(attribute)))

1182

1749

# Copy annotations, if any

1183

1750

try:

1184

attr[attrname]._dbus_annotations = (

1185

dict(attribute._dbus_annotations))

1751

attr[attrname]._dbus_annotations = dict(

1752

attribute._dbus_annotations)

1186

1753

except AttributeError:

1187

1754

pass

1188

1755

# Is this a D-Bus interface?

1191

1758

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

1192

1759

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

1193

1760

# to the class.

1194

attr[attrname] = (dbus_interface_annotations

1195

(alt_interface)

1196

(types.FunctionType

1197

(attribute.func_code,

1198

attribute.func_globals,

1199

attribute.func_name,

1200

attribute.func_defaults,

1201

attribute.func_closure)))

1761

attr[attrname] = (

1762

dbus_interface_annotations(alt_interface)

1763

(copy_function(attribute)))

1202

1764

if deprecate:

1203

1765

# Deprecate all alternate interfaces

1204

iname="_AlternateDBusNames_interface_annotation{0}"

1766

iname = "_AlternateDBusNames_interface_annotation{}"

1205

1767

for interface_name in interface_names:

1768

1206

1769

@dbus_interface_annotations(interface_name)

1207

1770

def func(self):

1208

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

1209

"true" }

1771

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

1772

"true"}

1210

1773

# Find an unused name

1211

1774

for aname in (iname.format(i)

1212

1775

for i in itertools.count()):

1216

1779

if interface_names:

1217

1780

# Replace the class with a new subclass of it with

1218

1781

# methods, signals, etc. as created above.

1219

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

1220

(cls,), attr)

1782

if sys.version_info.major == 2:

1783

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

1784

(cls, ), attr)

1785

else:

1786

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

1787

(cls, ), attr)

1221

1788

return cls

1789

1222

1790

return wrapper

1223

1791

1224

1792

1225

1793

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

1226

"se.bsnet.fukt.Mandos"})

1794

"se.bsnet.fukt.Mandos"})

1227

1795

class ClientDBus(Client, DBusObjectWithProperties):

1228

1796

"""A Client class using D-Bus

1229

1797

1230

1798

Attributes:

1231

1799

dbus_object_path: dbus.ObjectPath

1232

1800

bus: dbus.SystemBus()

1233

1801

"""

1234

1802

1235

1803

runtime_expansions = (Client.runtime_expansions

1236

+ ("dbus_object_path",))

1237

1804

+ ("dbus_object_path", ))

1805

1806

_interface = "se.recompile.Mandos.Client"

1807

1238

1808

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

1239

1240

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

1809

1810

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

1241

1811

self.bus = bus

1242

1812

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

1243

1813

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

1244

1814

# the D-Bus

1245

client_object_name = unicode(self.name).translate(

1815

client_object_name = str(self.name).translate(

1246

1816

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

1247

1817

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

1248

self.dbus_object_path = (dbus.ObjectPath

1249

("/clients/" + client_object_name))

1818

self.dbus_object_path = dbus.ObjectPath(

1819

"/clients/" + client_object_name)

1250

1820

DBusObjectWithProperties.__init__(self, self.bus,

1251

1821

self.dbus_object_path)

1252

1253

def notifychangeproperty(transform_func,

1254

dbus_name, type_func=lambda x: x,

1255

variant_level=1):

1822

1823

def notifychangeproperty(transform_func, dbus_name,

1824

type_func=lambda x: x,

1825

variant_level=1,

1826

invalidate_only=False,

1827

_interface=_interface):

1256

1828

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

1257

1829

its changes to DBus.

1258

1830

1259

1831

transform_fun: Function that takes a value and a variant_level

1260

1832

and transforms it to a D-Bus type.

1261

1833

dbus_name: D-Bus name of the variable

1263

1835

to the D-Bus. Default: no transform

1264

1836

variant_level: D-Bus variant level. Default: 1

1265

1837

"""

1266

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

1838

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

1839

1267

1840

def setter(self, value):

1268

1841

if hasattr(self, "dbus_object_path"):

1269

1842

if (not hasattr(self, attrname) or

1270

1843

type_func(getattr(self, attrname, None))

1271

1844

!= type_func(value)):

1272

dbus_value = transform_func(type_func(value),

1273

variant_level

1274

=variant_level)

1275

self.PropertyChanged(dbus.String(dbus_name),

1276

dbus_value)

1845

if invalidate_only:

1846

self.PropertiesChanged(

1847

_interface, dbus.Dictionary(),

1848

dbus.Array((dbus_name, )))

1849

else:

1850

dbus_value = transform_func(

1851

type_func(value),

1852

variant_level=variant_level)

1853

self.PropertyChanged(dbus.String(dbus_name),

1854

dbus_value)

1855

self.PropertiesChanged(

1856

_interface,

1857

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

1858

dbus_value}),

1859

dbus.Array())

1277

1860

setattr(self, attrname, value)

1278

1861

1279

1862

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

1280

1863

1281

1864

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1282

1865

approvals_pending = notifychangeproperty(dbus.Boolean,

1283

1866

"ApprovalPending",

1284

type_func = bool)

1867

type_func=bool)

1285

1868

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

1286

1869

last_enabled = notifychangeproperty(datetime_to_dbus,

1287

1870

"LastEnabled")

1288

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

1289

type_func = lambda checker:

1290

checker is not None)

1871

checker = notifychangeproperty(

1872

dbus.Boolean, "CheckerRunning",

1873

type_func=lambda checker: checker is not None)

1291

1874

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1292

1875

"LastCheckedOK")

1293

1876

last_checker_status = notifychangeproperty(dbus.Int16,

1296

1879

datetime_to_dbus, "LastApprovalRequest")

1297

1880

approved_by_default = notifychangeproperty(dbus.Boolean,

1298

1881

"ApprovedByDefault")

1299

approval_delay = notifychangeproperty(dbus.UInt64,

1300

"ApprovalDelay",

1301

type_func =

1302

timedelta_to_milliseconds)

1882

approval_delay = notifychangeproperty(

1883

dbus.UInt64, "ApprovalDelay",

1884

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

1303

1885

approval_duration = notifychangeproperty(

1304

1886

dbus.UInt64, "ApprovalDuration",

1305

type_func = timedelta_to_milliseconds)

1887

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

1306

1888

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

1307

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

1308

type_func =

1309

timedelta_to_milliseconds)

1889

timeout = notifychangeproperty(

1890

dbus.UInt64, "Timeout",

1891

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

1310

1892

extended_timeout = notifychangeproperty(

1311

1893

dbus.UInt64, "ExtendedTimeout",

1312

type_func = timedelta_to_milliseconds)

1313

interval = notifychangeproperty(dbus.UInt64,

1314

"Interval",

1315

type_func =

1316

timedelta_to_milliseconds)

1894

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

1895

interval = notifychangeproperty(

1896

dbus.UInt64, "Interval",

1897

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

1317

1898

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

1318

1899

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

1900

invalidate_only=True)

1901

1319

1902

del notifychangeproperty

1320

1903

1321

1904

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

1322

1905

try:

1323

1906

self.remove_from_connection()

1326

1909

if hasattr(DBusObjectWithProperties, "__del__"):

1327

1910

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

1328

1911

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

1329

1330

def checker_callback(self, pid, condition, command,

1331

*args, **kwargs):

1332

self.checker_callback_tag = None

1333

self.checker = None

1334

if os.WIFEXITED(condition):

1335

exitstatus = os.WEXITSTATUS(condition)

1912

1913

def checker_callback(self, source, condition,

1914

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

1915

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

1916

connection, command, *args,

1917

**kwargs)

1918

exitstatus = self.last_checker_status

1919

if exitstatus >= 0:

1336

1920

# Emit D-Bus signal

1337

1921

self.CheckerCompleted(dbus.Int16(exitstatus),

1338

dbus.Int64(condition),

1922

# This is specific to GNU libC

1923

dbus.Int64(exitstatus << 8),

1339

1924

dbus.String(command))

1340

1925

else:

1341

1926

# Emit D-Bus signal

1342

1927

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

1343

dbus.Int64(condition),

1928

dbus.Int64(

1929

# This is specific to GNU libC

1930

(exitstatus << 8)

1931

| self.last_checker_signal),

1344

1932

dbus.String(command))

1345

1346

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

1347

*args, **kwargs)

1348

1933

return ret

1934

1349

1935

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

1350

old_checker = self.checker

1351

if self.checker is not None:

1352

old_checker_pid = self.checker.pid

1353

else:

1354

old_checker_pid = None

1936

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

1355

1937

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

1356

1938

# Only if new checker process was started

1357

1939

if (self.checker is not None

1359

1941

# Emit D-Bus signal

1360

1942

self.CheckerStarted(self.current_checker_command)

1361

1943

return r

1362

1944

1363

1945

def _reset_approved(self):

1364

1946

self.approved = None

1365

1947

return False

1366

1948

1367

1949

def approve(self, value=True):

1368

1950

self.approved = value

1369

gobject.timeout_add(timedelta_to_milliseconds

1370

(self.approval_duration),

1371

self._reset_approved)

1951

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

1952

* 1000), self._reset_approved)

1372

1953

self.send_changedstate()

1373

1374

## D-Bus methods, signals & properties

1375

_interface = "se.recompile.Mandos.Client"

1376

1377

## Interfaces

1378

1379

@dbus_interface_annotations(_interface)

1380

def _foo(self):

1381

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

1382

"false"}

1383

1384

## Signals

1385

1954

1955

# D-Bus methods, signals & properties

1956

1957

# Interfaces

1958

1959

# Signals

1960

1386

1961

# CheckerCompleted - signal

1387

1962

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

1388

1963

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

1389

1964

"D-Bus signal"

1390

1965

pass

1391

1966

1392

1967

# CheckerStarted - signal

1393

1968

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

1394

1969

def CheckerStarted(self, command):

1395

1970

"D-Bus signal"

1396

1971

pass

1397

1972

1398

1973

# PropertyChanged - signal

1974

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

1399

1975

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

1400

1976

def PropertyChanged(self, property, value):

1401

1977

"D-Bus signal"

1402

1978

pass

1403

1979

1404

1980

# GotSecret - signal

1405

1981

@dbus.service.signal(_interface)

1406

1982

def GotSecret(self):

1409

1985

server to mandos-client

1410

1986

"""

1411

1987

pass

1412

1988

1413

1989

# Rejected - signal

1414

1990

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

1415

1991

def Rejected(self, reason):

1416

1992

"D-Bus signal"

1417

1993

pass

1418

1994

1419

1995

# NeedApproval - signal

1420

1996

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

1421

1997

def NeedApproval(self, timeout, default):

1422

1998

"D-Bus signal"

1423

1999

return self.need_approval()

1424

1425

## Methods

1426

2000

2001

# Methods

2002

1427

2003

# Approve - method

1428

2004

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

1429

2005

def Approve(self, value):

1430

2006

self.approve(value)

1431

2007

1432

2008

# CheckedOK - method

1433

2009

@dbus.service.method(_interface)

1434

2010

def CheckedOK(self):

1435

2011

self.checked_ok()

1436

2012

1437

2013

# Enable - method

2014

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

1438

2015

@dbus.service.method(_interface)

1439

2016

def Enable(self):

1440

2017

"D-Bus method"

1441

2018

self.enable()

1442

2019

1443

2020

# StartChecker - method

2021

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

1444

2022

@dbus.service.method(_interface)

1445

2023

def StartChecker(self):

1446

2024

"D-Bus method"

1447

2025

self.start_checker()

1448

2026

1449

2027

# Disable - method

2028

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

1450

2029

@dbus.service.method(_interface)

1451

2030

def Disable(self):

1452

2031

"D-Bus method"

1453

2032

self.disable()

1454

2033

1455

2034

# StopChecker - method

2035

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

1456

2036

@dbus.service.method(_interface)

1457

2037

def StopChecker(self):

1458

2038

self.stop_checker()

1459

1460

## Properties

1461

2039

2040

# Properties

2041

1462

2042

# ApprovalPending - property

1463

2043

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

1464

2044

def ApprovalPending_dbus_property(self):

1465

2045

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

1466

2046

1467

2047

# ApprovedByDefault - property

1468

@dbus_service_property(_interface, signature="b",

2048

@dbus_service_property(_interface,

2049

signature="b",

1469

2050

access="readwrite")

1470

2051

def ApprovedByDefault_dbus_property(self, value=None):

1471

2052

if value is None: # get

1472

2053

return dbus.Boolean(self.approved_by_default)

1473

2054

self.approved_by_default = bool(value)

1474

2055

1475

2056

# ApprovalDelay - property

1476

@dbus_service_property(_interface, signature="t",

2057

@dbus_service_property(_interface,

2058

signature="t",

1477

2059

access="readwrite")

1478

2060

def ApprovalDelay_dbus_property(self, value=None):

1479

2061

if value is None: # get

1480

return dbus.UInt64(self.approval_delay_milliseconds())

2062

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

2063

* 1000)

1481

2064

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

1482

2065

1483

2066

# ApprovalDuration - property

1484

@dbus_service_property(_interface, signature="t",

2067

@dbus_service_property(_interface,

2068

signature="t",

1485

2069

access="readwrite")

1486

2070

def ApprovalDuration_dbus_property(self, value=None):

1487

2071

if value is None: # get

1488

return dbus.UInt64(timedelta_to_milliseconds(

1489

self.approval_duration))

2072

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

2073

* 1000)

1490

2074

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

1491

2075

1492

2076

# Name - property

2077

@dbus_annotations(

2078

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

1493

2079

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

1494

2080

def Name_dbus_property(self):

1495

2081

return dbus.String(self.name)

1496

2082

2083

# KeyID - property

2084

@dbus_annotations(

2085

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

2086

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

2087

def KeyID_dbus_property(self):

2088

return dbus.String(self.key_id)

2089

1497

2090

# Fingerprint - property

2091

@dbus_annotations(

2092

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

1498

2093

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

1499

2094

def Fingerprint_dbus_property(self):

1500

2095

return dbus.String(self.fingerprint)

1501

2096

1502

2097

# Host - property

1503

@dbus_service_property(_interface, signature="s",

2098

@dbus_service_property(_interface,

2099

signature="s",

1504

2100

access="readwrite")

1505

2101

def Host_dbus_property(self, value=None):

1506

2102

if value is None: # get

1507

2103

return dbus.String(self.host)

1508

self.host = unicode(value)

1509

2104

self.host = str(value)

2105

1510

2106

# Created - property

2107

@dbus_annotations(

2108

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

1511

2109

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

1512

2110

def Created_dbus_property(self):

1513

2111

return datetime_to_dbus(self.created)

1514

2112

1515

2113

# LastEnabled - property

1516

2114

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

1517

2115

def LastEnabled_dbus_property(self):

1518

2116

return datetime_to_dbus(self.last_enabled)

1519

2117

1520

2118

# Enabled - property

1521

@dbus_service_property(_interface, signature="b",

2119

@dbus_service_property(_interface,

2120

signature="b",

1522

2121

access="readwrite")

1523

2122

def Enabled_dbus_property(self, value=None):

1524

2123

if value is None: # get

1527

2126

self.enable()

1528

2127

else:

1529

2128

self.disable()

1530

2129

1531

2130

# LastCheckedOK - property

1532

@dbus_service_property(_interface, signature="s",

2131

@dbus_service_property(_interface,

2132

signature="s",

1533

2133

access="readwrite")

1534

2134

def LastCheckedOK_dbus_property(self, value=None):

1535

2135

if value is not None:

1536

2136

self.checked_ok()

1537

2137

return

1538

2138

return datetime_to_dbus(self.last_checked_ok)

1539

2139

1540

2140

# LastCheckerStatus - property

1541

@dbus_service_property(_interface, signature="n",

1542

access="read")

2141

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

1543

2142

def LastCheckerStatus_dbus_property(self):

1544

2143

return dbus.Int16(self.last_checker_status)

1545

2144

1546

2145

# Expires - property

1547

2146

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

1548

2147

def Expires_dbus_property(self):

1549

2148

return datetime_to_dbus(self.expires)

1550

2149

1551

2150

# LastApprovalRequest - property

1552

2151

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

1553

2152

def LastApprovalRequest_dbus_property(self):

1554

2153

return datetime_to_dbus(self.last_approval_request)

1555

2154

1556

2155

# Timeout - property

1557

@dbus_service_property(_interface, signature="t",

2156

@dbus_service_property(_interface,

2157

signature="t",

1558

2158

access="readwrite")

1559

2159

def Timeout_dbus_property(self, value=None):

1560

2160

if value is None: # get

1561

return dbus.UInt64(self.timeout_milliseconds())

2161

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

1562

2162

old_timeout = self.timeout

1563

2163

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

1564

2164

# Reschedule disabling

1572

2172

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

1573

2173

is None):

1574

2174

return

1575

gobject.source_remove(self.disable_initiator_tag)

1576

self.disable_initiator_tag = (

1577

gobject.timeout_add(

1578

timedelta_to_milliseconds(self.expires - now),

1579

self.disable))

1580

2175

GLib.source_remove(self.disable_initiator_tag)

2176

self.disable_initiator_tag = GLib.timeout_add(

2177

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

2178

self.disable)

2179

1581

2180

# ExtendedTimeout - property

1582

@dbus_service_property(_interface, signature="t",

2181

@dbus_service_property(_interface,

2182

signature="t",

1583

2183

access="readwrite")

1584

2184

def ExtendedTimeout_dbus_property(self, value=None):

1585

2185

if value is None: # get

1586

return dbus.UInt64(self.extended_timeout_milliseconds())

2186

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

2187

* 1000)

1587

2188

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

1588

2189

1589

2190

# Interval - property

1590

@dbus_service_property(_interface, signature="t",

2191

@dbus_service_property(_interface,

2192

signature="t",

1591

2193

access="readwrite")

1592

2194

def Interval_dbus_property(self, value=None):

1593

2195

if value is None: # get

1594

return dbus.UInt64(self.interval_milliseconds())

2196

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

1595

2197

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

1596

2198

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

1597

2199

return

1598

2200

if self.enabled:

1599

2201

# Reschedule checker run

1600

gobject.source_remove(self.checker_initiator_tag)

1601

self.checker_initiator_tag = (gobject.timeout_add

1602

(value, self.start_checker))

1603

self.start_checker() # Start one now, too

1604

2202

GLib.source_remove(self.checker_initiator_tag)

2203

self.checker_initiator_tag = GLib.timeout_add(

2204

value, self.start_checker)

2205

self.start_checker() # Start one now, too

2206

1605

2207

# Checker - property

1606

@dbus_service_property(_interface, signature="s",

2208

@dbus_service_property(_interface,

2209

signature="s",

1607

2210

access="readwrite")

1608

2211

def Checker_dbus_property(self, value=None):

1609

2212

if value is None: # get

1610

2213

return dbus.String(self.checker_command)

1611

self.checker_command = unicode(value)

1612

2214

self.checker_command = str(value)

2215

1613

2216

# CheckerRunning - property

1614

@dbus_service_property(_interface, signature="b",

2217

@dbus_service_property(_interface,

2218

signature="b",

1615

2219

access="readwrite")

1616

2220

def CheckerRunning_dbus_property(self, value=None):

1617

2221

if value is None: # get

1620

2224

self.start_checker()

1621

2225

else:

1622

2226

self.stop_checker()

1623

2227

1624

2228

# ObjectPath - property

2229

@dbus_annotations(

2230

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

2231

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

1625

2232

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

1626

2233

def ObjectPath_dbus_property(self):

1627

return self.dbus_object_path # is already a dbus.ObjectPath

1628

2234

return self.dbus_object_path # is already a dbus.ObjectPath

2235

1629

2236

# Secret = property

1630

@dbus_service_property(_interface, signature="ay",

1631

access="write", byte_arrays=True)

2237

@dbus_annotations(

2238

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

2239

"invalidates"})

2240

@dbus_service_property(_interface,

2241

signature="ay",

2242

access="write",

2243

byte_arrays=True)

1632

2244

def Secret_dbus_property(self, value):

1633

self.secret = str(value)

1634

2245

self.secret = bytes(value)

2246

1635

2247

del _interface

1636

2248

1637

2249

1638

class ProxyClient(object):

1639

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

2250

class ProxyClient:

2251

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

1640

2252

self._pipe = child_pipe

1641

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

2253

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

1642

2254

if not self._pipe.recv():

1643

raise KeyError()

1644

2255

raise KeyError(key_id or fpr)

2256

1645

2257

def __getattribute__(self, name):

1646

2258

if name == '_pipe':

1647

2259

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

1650

2262

if data[0] == 'data':

1651

2263

return data[1]

1652

2264

if data[0] == 'function':

2265

1653

2266

def func(*args, **kwargs):

1654

2267

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

1655

2268

return self._pipe.recv()[1]

2269

1656

2270

return func

1657

2271

1658

2272

def __setattr__(self, name, value):

1659

2273

if name == '_pipe':

1660

2274

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

1663

2277

1664

2278

class ClientHandler(socketserver.BaseRequestHandler, object):

1665

2279

"""A class to handle client connections.

1666

2280

1667

2281

Instantiated once for each connection to handle it.

1668

2282

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

1669

2283

1670

2284

def handle(self):

1671

2285

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

1672

2286

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

1673

unicode(self.client_address))

2287

str(self.client_address))

1674

2288

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

1675

2289

self.server.child_pipe.fileno())

1676

1677

session = (gnutls.connection

1678

.ClientSession(self.request,

1679

gnutls.connection

1680

.X509Credentials()))

1681

1682

# Note: gnutls.connection.X509Credentials is really a

1683

# generic GnuTLS certificate credentials object so long as

1684

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

1685

# here despite using OpenPGP certificates.

1686

1687

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

1688

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

1689

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

1690

# "+DHE-DSS"))

2290

2291

session = gnutls.ClientSession(self.request)

2292

2293

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

2294

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

2295

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

2296

# "+DHE-DSS"))

1691

2297

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

1692

2298

priority = self.server.gnutls_priority

1693

2299

if priority is None:

1694

2300

priority = "NORMAL"

1695

(gnutls.library.functions

1696

.gnutls_priority_set_direct(session._c_object,

1697

priority, None))

1698

2301

gnutls.priority_set_direct(session._c_object,

2302

priority.encode("utf-8"),

2303

None)

2304

1699

2305

# Start communication using the Mandos protocol

1700

2306

# Get protocol number

1701

2307

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

1702

2308

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

1703

2309

try:

1704

2310

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

1705

raise RuntimeError

2311

raise RuntimeError(line)

1706

2312

except (ValueError, IndexError, RuntimeError) as error:

1707

2313

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

1708

2314

return

1709

2315

1710

2316

# Start GnuTLS connection

1711

2317

try:

1712

2318

session.handshake()

1713

except gnutls.errors.GNUTLSError as error:

2319

except gnutls.Error as error:

1714

2320

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

1715

2321

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

1716

2322

# established. Just abandon the request.

1717

2323

return

1718

2324

logger.debug("Handshake succeeded")

1719

2325

1720

2326

approval_required = False

1721

2327

try:

1722

try:

1723

fpr = self.fingerprint(self.peer_certificate

1724

(session))

1725

except (TypeError,

1726

gnutls.errors.GNUTLSError) as error:

1727

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

1728

return

1729

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

1730

1731

try:

1732

client = ProxyClient(child_pipe, fpr,

2328

if gnutls.has_rawpk:

2329

fpr = b""

2330

try:

2331

key_id = self.key_id(

2332

self.peer_certificate(session))

2333

except (TypeError, gnutls.Error) as error:

2334

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

2335

return

2336

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

2337

2338

else:

2339

key_id = b""

2340

try:

2341

fpr = self.fingerprint(

2342

self.peer_certificate(session))

2343

except (TypeError, gnutls.Error) as error:

2344

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

2345

return

2346

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

2347

2348

try:

2349

client = ProxyClient(child_pipe, key_id, fpr,

1733

2350

self.client_address)

1734

2351

except KeyError:

1735

2352

return

1736

2353

1737

2354

if client.approval_delay:

1738

2355

delay = client.approval_delay

1739

2356

client.approvals_pending += 1

1740

2357

approval_required = True

1741

2358

1742

2359

while True:

1743

2360

if not client.enabled:

1744

2361

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

1745

client.name)

2362

client.name)

1746

2363

if self.server.use_dbus:

1747

2364

# Emit D-Bus signal

1748

2365

client.Rejected("Disabled")

1749

2366

return

1750

2367

1751

2368

if client.approved or not client.approval_delay:

1752

#We are approved or approval is disabled

2369

# We are approved or approval is disabled

1753

2370

break

1754

2371

elif client.approved is None:

1755

2372

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

1757

2374

if self.server.use_dbus:

1758

2375

# Emit D-Bus signal

1759

2376

client.NeedApproval(

1760

client.approval_delay_milliseconds(),

1761

client.approved_by_default)

2377

client.approval_delay.total_seconds()

2378

* 1000, client.approved_by_default)

1762

2379

else:

1763

2380

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

1764

2381

client.name)

1766

2383

# Emit D-Bus signal

1767

2384

client.Rejected("Denied")

1768

2385

return

1769

1770

#wait until timeout or approved

2386

2387

# wait until timeout or approved

1771

2388

time = datetime.datetime.now()

1772

2389

client.changedstate.acquire()

1773

client.changedstate.wait(

1774

float(timedelta_to_milliseconds(delay)

1775

/ 1000))

2390

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

1776

2391

client.changedstate.release()

1777

2392

time2 = datetime.datetime.now()

1778

2393

if (time2 - time) >= delay:

1788

2403

break

1789

2404

else:

1790

2405

delay -= time2 - time

1791

1792

sent_size = 0

1793

while sent_size < len(client.secret):

1794

try:

1795

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

1796

except gnutls.errors.GNUTLSError as error:

1797

logger.warning("gnutls send failed",

1798

exc_info=error)

1799

return

1800

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

1801

sent, len(client.secret)

1802

- (sent_size + sent))

1803

sent_size += sent

1804

2406

2407

try:

2408

session.send(client.secret)

2409

except gnutls.Error as error:

2410

logger.warning("gnutls send failed",

2411

exc_info=error)

2412

return

2413

1805

2414

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

1806

2415

# bump the timeout using extended_timeout

1807

2416

client.bump_timeout(client.extended_timeout)

1808

2417

if self.server.use_dbus:

1809

2418

# Emit D-Bus signal

1810

2419

client.GotSecret()

1811

2420

1812

2421

finally:

1813

2422

if approval_required:

1814

2423

client.approvals_pending -= 1

1815

2424

try:

1816

2425

session.bye()

1817

except gnutls.errors.GNUTLSError as error:

2426

except gnutls.Error as error:

1818

2427

logger.warning("GnuTLS bye failed",

1819

2428

exc_info=error)

1820

2429

1821

2430

@staticmethod

1822

2431

def peer_certificate(session):

1823

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

1824

# If not an OpenPGP certificate...

1825

if (gnutls.library.functions

1826

.gnutls_certificate_type_get(session._c_object)

1827

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1828

# ...do the normal thing

1829

return session.peer_certificate

2432

"Return the peer's certificate as a bytestring"

2433

try:

2434

cert_type = gnutls.certificate_type_get2(session._c_object,

2435

gnutls.CTYPE_PEERS)

2436

except AttributeError:

2437

cert_type = gnutls.certificate_type_get(session._c_object)

2438

if gnutls.has_rawpk:

2439

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2440

else:

2441

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2442

# If not a valid certificate type...

2443

if cert_type not in valid_cert_types:

2444

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

2445

valid_cert_types)

2446

# ...return invalid data

2447

return b""

1830

2448

list_size = ctypes.c_uint(1)

1831

cert_list = (gnutls.library.functions

1832

.gnutls_certificate_get_peers

2449

cert_list = (gnutls.certificate_get_peers

1833

2450

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

1834

2451

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

1835

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

1836

" certificate")

2452

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

1837

2453

if list_size.value == 0:

1838

2454

return None

1839

2455

cert = cert_list[0]

1840

2456

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

1841

2457

2458

@staticmethod

2459

def key_id(certificate):

2460

"Convert a certificate bytestring to a hexdigit key ID"

2461

# New GnuTLS "datum" with the public key

2462

datum = gnutls.datum_t(

2463

ctypes.cast(ctypes.c_char_p(certificate),

2464

ctypes.POINTER(ctypes.c_ubyte)),

2465

ctypes.c_uint(len(certificate)))

2466

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

2467

# New empty GnuTLS certificate

2468

pubkey = gnutls.pubkey_t()

2469

gnutls.pubkey_init(ctypes.byref(pubkey))

2470

# Import the raw public key into the certificate

2471

gnutls.pubkey_import(pubkey,

2472

ctypes.byref(datum),

2473

gnutls.X509_FMT_DER)

2474

# New buffer for the key ID

2475

buf = ctypes.create_string_buffer(32)

2476

buf_len = ctypes.c_size_t(len(buf))

2477

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

2478

gnutls.pubkey_get_key_id(

2479

pubkey,

2480

gnutls.KEYID_USE_SHA256,

2481

ctypes.cast(ctypes.byref(buf),

2482

ctypes.POINTER(ctypes.c_ubyte)),

2483

ctypes.byref(buf_len))

2484

# Deinit the certificate

2485

gnutls.pubkey_deinit(pubkey)

2486

2487

# Convert the buffer to a Python bytestring

2488

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

2489

# Convert the bytestring to hexadecimal notation

2490

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

2491

return hex_key_id

2492

1842

2493

@staticmethod

1843

2494

def fingerprint(openpgp):

1844

2495

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1845

2496

# New GnuTLS "datum" with the OpenPGP public key

1846

datum = (gnutls.library.types

1847

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

1848

ctypes.POINTER

1849

(ctypes.c_ubyte)),

1850

ctypes.c_uint(len(openpgp))))

2497

datum = gnutls.datum_t(

2498

ctypes.cast(ctypes.c_char_p(openpgp),

2499

ctypes.POINTER(ctypes.c_ubyte)),

2500

ctypes.c_uint(len(openpgp)))

1851

2501

# New empty GnuTLS certificate

1852

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1853

(gnutls.library.functions

1854

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2502

crt = gnutls.openpgp_crt_t()

2503

gnutls.openpgp_crt_init(ctypes.byref(crt))

1855

2504

# Import the OpenPGP public key into the certificate

1856

(gnutls.library.functions

1857

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

1858

gnutls.library.constants

1859

.GNUTLS_OPENPGP_FMT_RAW))

2505

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

2506

gnutls.OPENPGP_FMT_RAW)

1860

2507

# Verify the self signature in the key

1861

2508

crtverify = ctypes.c_uint()

1862

(gnutls.library.functions

1863

.gnutls_openpgp_crt_verify_self(crt, 0,

1864

ctypes.byref(crtverify)))

2509

gnutls.openpgp_crt_verify_self(crt, 0,

2510

ctypes.byref(crtverify))

1865

2511

if crtverify.value != 0:

1866

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1867

raise (gnutls.errors.CertificateSecurityError

1868

("Verify failed"))

2512

gnutls.openpgp_crt_deinit(crt)

2513

raise gnutls.CertificateSecurityError(code

2514

=crtverify.value)

1869

2515

# New buffer for the fingerprint

1870

2516

buf = ctypes.create_string_buffer(20)

1871

2517

buf_len = ctypes.c_size_t()

1872

2518

# Get the fingerprint from the certificate into the buffer

1873

(gnutls.library.functions

1874

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

1875

ctypes.byref(buf_len)))

2519

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

2520

ctypes.byref(buf_len))

1876

2521

# Deinit the certificate

1877

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2522

gnutls.openpgp_crt_deinit(crt)

1878

2523

# Convert the buffer to a Python bytestring

1879

2524

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

1880

2525

# Convert the bytestring to hexadecimal notation

1882

2527

return hex_fpr

1883

2528

1884

2529

1885

class MultiprocessingMixIn(object):

2530

class MultiprocessingMixIn:

1886

2531

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

2532

1887

2533

def sub_process_main(self, request, address):

1888

2534

try:

1889

2535

self.finish_request(request, address)

1890

2536

except Exception:

1891

2537

self.handle_error(request, address)

1892

2538

self.close_request(request)

1893

2539

1894

2540

def process_request(self, request, address):

1895

2541

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

1896

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

1897

args = (request, address))

2542

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

2543

args=(request, address))

1898

2544

proc.start()

1899

2545

return proc

1900

2546

1901

2547

1902

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2548

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1903

2549

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

2550

1904

2551

def process_request(self, request, client_address):

1905

2552

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

1906

2553

1907

2554

This function creates a new pipe in self.pipe

1908

2555

"""

1909

2556

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1910

2557

1911

2558

proc = MultiprocessingMixIn.process_request(self, request,

1912

2559

client_address)

1913

2560

self.child_pipe.close()

1914

2561

self.add_pipe(parent_pipe, proc)

1915

2562

1916

2563

def add_pipe(self, parent_pipe, proc):

1917

2564

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

1918

raise NotImplementedError

2565

raise NotImplementedError()

1919

2566

1920

2567

1921

2568

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1922

socketserver.TCPServer, object):

2569

socketserver.TCPServer):

1923

2570

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

1924

2571

1925

2572

Attributes:

1926

2573

enabled: Boolean; whether this server is activated yet

1927

2574

interface: None or a network interface name (string)

1928

2575

use_ipv6: Boolean; to use IPv6 or not

1929

2576

"""

2577

1930

2578

def __init__(self, server_address, RequestHandlerClass,

1931

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

2579

interface=None,

2580

use_ipv6=True,

2581

socketfd=None):

1932

2582

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

1933

2583

creating a new one with socket.socket().

1934

2584

"""

1940

2590

self.socketfd = socketfd

1941

2591

# Save the original socket.socket() function

1942

2592

self.socket_socket = socket.socket

2593

1943

2594

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

1944

#

2595

#

1945

2596

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

1946

2597

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

1947

2598

# patching socket.socket.)

1948

#

2599

#

1949

2600

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

1950

2601

@functools.wraps(socket.socket)

1951

2602

def socket_wrapper(*args, **kwargs):

1963

2614

# socket_wrapper(), if socketfd was set.

1964

2615

socketserver.TCPServer.__init__(self, server_address,

1965

2616

RequestHandlerClass)

1966

2617

1967

2618

def server_bind(self):

1968

2619

"""This overrides the normal server_bind() function

1969

2620

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

1970

2621

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

2622

global SO_BINDTODEVICE

1971

2623

if self.interface is not None:

1972

2624

if SO_BINDTODEVICE is None:

1973

logger.error("SO_BINDTODEVICE does not exist;"

1974

" cannot bind to interface %s",

1975

self.interface)

1976

else:

1977

try:

1978

self.socket.setsockopt(socket.SOL_SOCKET,

1979

SO_BINDTODEVICE,

1980

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

1981

except socket.error as error:

1982

if error.errno == errno.EPERM:

1983

logger.error("No permission to bind to"

1984

" interface %s", self.interface)

1985

elif error.errno == errno.ENOPROTOOPT:

1986

logger.error("SO_BINDTODEVICE not available;"

1987

" cannot bind to interface %s",

1988

self.interface)

1989

elif error.errno == errno.ENODEV:

1990

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

1991

" cannot bind", self.interface)

1992

else:

1993

raise

2625

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

2626

# common enough.

2627

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

2628

SO_BINDTODEVICE = 25

2629

try:

2630

self.socket.setsockopt(

2631

socket.SOL_SOCKET, SO_BINDTODEVICE,

2632

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

2633

except socket.error as error:

2634

if error.errno == errno.EPERM:

2635

logger.error("No permission to bind to"

2636

" interface %s", self.interface)

2637

elif error.errno == errno.ENOPROTOOPT:

2638

logger.error("SO_BINDTODEVICE not available;"

2639

" cannot bind to interface %s",

2640

self.interface)

2641

elif error.errno == errno.ENODEV:

2642

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

2643

" cannot bind", self.interface)

2644

else:

2645

raise

1994

2646

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

1995

2647

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

2648

if self.server_address[1]:

2649

self.allow_reuse_address = True

1996

2650

if not self.server_address[0]:

1997

2651

if self.address_family == socket.AF_INET6:

1998

any_address = "::" # in6addr_any

2652

any_address = "::" # in6addr_any

1999

2653

else:

2000

any_address = "0.0.0.0" # INADDR_ANY

2654

any_address = "0.0.0.0" # INADDR_ANY

2001

2655

self.server_address = (any_address,

2002

2656

self.server_address[1])

2003

2657

elif not self.server_address[1]:

2004

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

2005

0)

2658

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

2006

2659

# if self.interface:

2007

2660

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

2008

2661

# 0, # port

2014

2667

2015

2668

class MandosServer(IPv6_TCPServer):

2016

2669

"""Mandos server.

2017

2670

2018

2671

Attributes:

2019

2672

clients: set of Client objects

2020

2673

gnutls_priority GnuTLS priority string

2021

2674

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

2022

2023

Assumes a gobject.MainLoop event loop.

2675

2676

Assumes a GLib.MainLoop event loop.

2024

2677

"""

2678

2025

2679

def __init__(self, server_address, RequestHandlerClass,

2026

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

2027

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

2680

interface=None,

2681

use_ipv6=True,

2682

clients=None,

2683

gnutls_priority=None,

2684

use_dbus=True,

2685

socketfd=None):

2028

2686

self.enabled = False

2029

2687

self.clients = clients

2030

2688

if self.clients is None:

2033

2691

self.gnutls_priority = gnutls_priority

2034

2692

IPv6_TCPServer.__init__(self, server_address,

2035

2693

RequestHandlerClass,

2036

interface = interface,

2037

use_ipv6 = use_ipv6,

2038

socketfd = socketfd)

2694

interface=interface,

2695

use_ipv6=use_ipv6,

2696

socketfd=socketfd)

2697

2039

2698

def server_activate(self):

2040

2699

if self.enabled:

2041

2700

return socketserver.TCPServer.server_activate(self)

2042

2701

2043

2702

def enable(self):

2044

2703

self.enabled = True

2045

2704

2046

2705

def add_pipe(self, parent_pipe, proc):

2047

2706

# Call "handle_ipc" for both data and EOF events

2048

gobject.io_add_watch(parent_pipe.fileno(),

2049

gobject.IO_IN | gobject.IO_HUP,

2050

functools.partial(self.handle_ipc,

2051

parent_pipe =

2052

parent_pipe,

2053

proc = proc))

2054

2055

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

2056

proc = None, client_object=None):

2707

GLib.io_add_watch(

2708

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

2709

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

2710

functools.partial(self.handle_ipc,

2711

parent_pipe=parent_pipe,

2712

proc=proc))

2713

2714

def handle_ipc(self, source, condition,

2715

parent_pipe=None,

2716

proc=None,

2717

client_object=None):

2057

2718

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

2058

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

2719

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

2059

2720

# Wait for other process to exit

2060

2721

proc.join()

2061

2722

return False

2062

2723

2063

2724

# Read a request from the child

2064

2725

request = parent_pipe.recv()

2065

2726

command = request[0]

2066

2727

2067

2728

if command == 'init':

2068

fpr = request[1]

2069

address = request[2]

2070

2071

for c in self.clients.itervalues():

2072

if c.fingerprint == fpr:

2729

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

2730

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

2731

address = request[3]

2732

2733

for c in self.clients.values():

2734

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2735

"27AE41E4649B934CA495991B7852B855"):

2736

continue

2737

if key_id and c.key_id == key_id:

2738

client = c

2739

break

2740

if fpr and c.fingerprint == fpr:

2073

2741

client = c

2074

2742

break

2075

2743

else:

2076

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

2077

"dress: %s", fpr, address)

2744

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

2745

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

2078

2746

if self.use_dbus:

2079

2747

# Emit D-Bus signal

2080

mandos_dbus_service.ClientNotFound(fpr,

2748

mandos_dbus_service.ClientNotFound(key_id or fpr,

2081

2749

address[0])

2082

2750

parent_pipe.send(False)

2083

2751

return False

2084

2085

gobject.io_add_watch(parent_pipe.fileno(),

2086

gobject.IO_IN | gobject.IO_HUP,

2087

functools.partial(self.handle_ipc,

2088

parent_pipe =

2089

parent_pipe,

2090

proc = proc,

2091

client_object =

2092

client))

2752

2753

GLib.io_add_watch(

2754

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

2755

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

2756

functools.partial(self.handle_ipc,

2757

parent_pipe=parent_pipe,

2758

proc=proc,

2759

client_object=client))

2093

2760

parent_pipe.send(True)

2094

2761

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

2095

2762

# same fileno

2098

2765

funcname = request[1]

2099

2766

args = request[2]

2100

2767

kwargs = request[3]

2101

2768

2102

2769

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

2103

2770

funcname)(*args,

2104

**kwargs)))

2105

2771

**kwargs)))

2772

2106

2773

if command == 'getattr':

2107

2774

attrname = request[1]

2108

if callable(client_object.__getattribute__(attrname)):

2109

parent_pipe.send(('function',))

2775

if isinstance(client_object.__getattribute__(attrname),

2776

collections.abc.Callable):

2777

parent_pipe.send(('function', ))

2110

2778

else:

2111

parent_pipe.send(('data', client_object

2112

.__getattribute__(attrname)))

2113

2779

parent_pipe.send((

2780

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

2781

2114

2782

if command == 'setattr':

2115

2783

attrname = request[1]

2116

2784

value = request[2]

2117

2785

setattr(client_object, attrname, value)

2118

2786

2119

2787

return True

2120

2788

2121

2789

2122

2790

def rfc3339_duration_to_delta(duration):

2123

2791

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

2124

2125

>>> rfc3339_duration_to_delta("P7D")

2126

datetime.timedelta(7)

2127

>>> rfc3339_duration_to_delta("PT60S")

2128

datetime.timedelta(0, 60)

2129

>>> rfc3339_duration_to_delta("PT60M")

2130

datetime.timedelta(0, 3600)

2131

>>> rfc3339_duration_to_delta("PT24H")

2132

datetime.timedelta(1)

2133

>>> rfc3339_duration_to_delta("P1W")

2134

datetime.timedelta(7)

2135

>>> rfc3339_duration_to_delta("PT5M30S")

2136

datetime.timedelta(0, 330)

2137

>>> rfc3339_duration_to_delta("P1DT3M20S")

2138

datetime.timedelta(1, 200)

2792

2793

>>> timedelta = datetime.timedelta

2794

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

2795

True

2796

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

2797

True

2798

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

2799

True

2800

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

2801

True

2802

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

2803

True

2804

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

2805

True

2806

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

2807

True

2808

>>> del timedelta

2139

2809

"""

2140

2810

2141

2811

# Parsing an RFC 3339 duration with regular expressions is not

2142

2812

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

2143

2813

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

2144

2814

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

2145

2815

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

2146

2816

# avoid excessive use of external libraries.

2147

2817

2148

2818

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

2149

Token = collections.namedtuple("Token",

2150

("regexp", # To match token; if

2151

# "value" is not None,

2152

# must have a "group"

2153

# containing digits

2154

"value", # datetime.timedelta or

2155

# None

2156

"followers")) # Tokens valid after

2157

# this token

2819

Token = collections.namedtuple("Token", (

2820

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

2821

# a "group" containing digits

2822

"value", # datetime.timedelta or None

2823

"followers")) # Tokens valid after this token

2158

2824

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

2159

2825

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

2160

2826

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

2161

2827

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

2162

2828

datetime.timedelta(seconds=1),

2163

frozenset((token_end,)))

2829

frozenset((token_end, )))

2164

2830

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

2165

2831

datetime.timedelta(minutes=1),

2166

2832

frozenset((token_second, token_end)))

2182

2848

frozenset((token_month, token_end)))

2183

2849

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

2184

2850

datetime.timedelta(weeks=1),

2185

frozenset((token_end,)))

2851

frozenset((token_end, )))

2186

2852

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

2187

2853

frozenset((token_year, token_month,

2188

2854

token_day, token_time,

2189

token_week))),

2190

# Define starting values

2191

value = datetime.timedelta() # Value so far

2855

token_week)))

2856

# Define starting values:

2857

# Value so far

2858

value = datetime.timedelta()

2192

2859

found_token = None

2193

followers = frozenset(token_duration,) # Following valid tokens

2194

s = duration # String left to parse

2860

# Following valid tokens

2861

followers = frozenset((token_duration, ))

2862

# String left to parse

2863

s = duration

2195

2864

# Loop until end token is found

2196

2865

while found_token is not token_end:

2197

2866

# Search for any currently valid tokens

2213

2882

break

2214

2883

else:

2215

2884

# No currently valid tokens were found

2216

raise ValueError("Invalid RFC 3339 duration")

2885

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

2886

.format(duration))

2217

2887

# End token found

2218

2888

return value

2219

2889

2220

2890

2221

2891

def string_to_delta(interval):

2222

2892

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

2223

2224

>>> string_to_delta('7d')

2225

datetime.timedelta(7)

2226

>>> string_to_delta('60s')

2227

datetime.timedelta(0, 60)

2228

>>> string_to_delta('60m')

2229

datetime.timedelta(0, 3600)

2230

>>> string_to_delta('24h')

2231

datetime.timedelta(1)

2232

>>> string_to_delta('1w')

2233

datetime.timedelta(7)

2234

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

2235

datetime.timedelta(0, 330)

2893

2894

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

2895

True

2896

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

2897

True

2898

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

2899

True

2900

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

2901

True

2902

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

2903

True

2904

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

2905

True

2236

2906

"""

2237

2907

2238

2908

try:

2239

2909

return rfc3339_duration_to_delta(interval)

2240

2910

except ValueError:

2241

2911

pass

2242

2912

2243

2913

timevalue = datetime.timedelta(0)

2244

2914

for s in interval.split():

2245

2915

try:

2246

suffix = unicode(s[-1])

2916

suffix = s[-1]

2247

2917

value = int(s[:-1])

2248

2918

if suffix == "d":

2249

2919

delta = datetime.timedelta(value)

2256

2926

elif suffix == "w":

2257

2927

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

2258

2928

else:

2259

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

2260

.format(suffix))

2261

except (ValueError, IndexError) as e:

2929

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

2930

except IndexError as e:

2262

2931

raise ValueError(*(e.args))

2263

2932

timevalue += delta

2264

2933

return timevalue

2265

2934

2266

2935

2267

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

2936

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

2268

2937

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

2269

2938

2270

2939

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

2271

2940

if os.fork():

2272

2941

sys.exit()

2280

2949

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

2281

2950

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

2282

2951

raise OSError(errno.ENODEV,

2283

"{0} not a character device"

2952

"{} not a character device"

2284

2953

.format(os.devnull))

2285

2954

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

2286

2955

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

2290

2959

2291

2960

2292

2961

def main():

2293

2962

2294

2963

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

2295

2964

# Parsing of options, both command line and config file

2296

2965

2297

2966

parser = argparse.ArgumentParser()

2298

2967

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

2299

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

2968

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

2300

2969

help="show version number and exit")

2301

2970

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

2302

2971

help="Bind to interface IF")

2335

3004

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

2336

3005

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

2337

3006

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

2338

3007

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

3008

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

3009

default=None)

3010

2339

3011

options = parser.parse_args()

2340

2341

if options.check:

2342

import doctest

2343

doctest.testmod()

2344

sys.exit()

2345

3012

2346

3013

# Default values for config file for server-global settings

2347

server_defaults = { "interface": "",

2348

"address": "",

2349

"port": "",

2350

"debug": "False",

2351

"priority":

2352

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

2353

"servicename": "Mandos",

2354

"use_dbus": "True",

2355

"use_ipv6": "True",

2356

"debuglevel": "",

2357

"restore": "True",

2358

"socket": "",

2359

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

2360

"foreground": "False",

2361

}

2362

3014

if gnutls.has_rawpk:

3015

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

3016

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

3017

else:

3018

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

3019

":+SIGN-DSA-SHA256")

3020

server_defaults = {"interface": "",

3021

"address": "",

3022

"port": "",

3023

"debug": "False",

3024

"priority": priority,

3025

"servicename": "Mandos",

3026

"use_dbus": "True",

3027

"use_ipv6": "True",

3028

"debuglevel": "",

3029

"restore": "True",

3030

"socket": "",

3031

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

3032

"foreground": "False",

3033

"zeroconf": "True",

3034

}

3035

del priority

3036

2363

3037

# Parse config file for server-global settings

2364

server_config = configparser.SafeConfigParser(server_defaults)

3038

server_config = configparser.ConfigParser(server_defaults)

2365

3039

del server_defaults

2366

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

2367

"mandos.conf"))

2368

# Convert the SafeConfigParser object to a dict

3040

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

3041

# Convert the ConfigParser object to a dict

2369

3042

server_settings = server_config.defaults()

2370

3043

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

2371

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

3044

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

3045

"foreground", "zeroconf"):

2372

3046

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

2373

3047

option)

2374

3048

if server_settings["port"]:

2384

3058

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

2385

3059

["socket"])

2386

3060

del server_config

2387

3061

2388

3062

# Override the settings from the config file with command line

2389

3063

# options, if set.

2390

3064

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

2391

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

2392

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

2393

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

3065

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

3066

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

3067

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

2394

3068

value = getattr(options, option)

2395

3069

if value is not None:

2396

3070

server_settings[option] = value

2397

3071

del options

2398

3072

# Force all strings to be unicode

2399

3073

for option in server_settings.keys():

2400

if type(server_settings[option]) is str:

2401

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

3074

if isinstance(server_settings[option], bytes):

3075

server_settings[option] = (server_settings[option]

3076

.decode("utf-8"))

2402

3077

# Force all boolean options to be boolean

2403

3078

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

2404

"foreground"):

3079

"foreground", "zeroconf"):

2405

3080

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

2406

3081

# Debug implies foreground

2407

3082

if server_settings["debug"]:

2408

3083

server_settings["foreground"] = True

2409

3084

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

2410

3085

2411

3086

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

2412

3087

3088

if (not server_settings["zeroconf"]

3089

and not (server_settings["port"]

3090

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

3091

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

3092

2413

3093

# For convenience

2414

3094

debug = server_settings["debug"]

2415

3095

debuglevel = server_settings["debuglevel"]

2418

3098

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

2419

3099

stored_state_file)

2420

3100

foreground = server_settings["foreground"]

2421

3101

zeroconf = server_settings["zeroconf"]

3102

2422

3103

if debug:

2423

3104

initlogger(debug, logging.DEBUG)

2424

3105

else:

2427

3108

else:

2428

3109

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

2429

3110

initlogger(debug, level)

2430

3111

2431

3112

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

2432

syslogger.setFormatter(logging.Formatter

2433

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

2434

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

2435

.format(server_settings

2436

["servicename"])))

2437

3113

syslogger.setFormatter(

3114

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

3115

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

3116

server_settings["servicename"])))

3117

2438

3118

# Parse config file with clients

2439

client_config = configparser.SafeConfigParser(Client

2440

.client_defaults)

3119

client_config = configparser.ConfigParser(Client.client_defaults)

2441

3120

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

2442

3121

"clients.conf"))

2443

3122

2444

3123

global mandos_dbus_service

2445

3124

mandos_dbus_service = None

2446

2447

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

2448

server_settings["port"]),

2449

ClientHandler,

2450

interface=(server_settings["interface"]

2451

or None),

2452

use_ipv6=use_ipv6,

2453

gnutls_priority=

2454

server_settings["priority"],

2455

use_dbus=use_dbus,

2456

socketfd=(server_settings["socket"]

2457

or None))

3125

3126

socketfd = None

3127

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

3128

socketfd = server_settings["socket"]

3129

tcp_server = MandosServer(

3130

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

3131

ClientHandler,

3132

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

3133

use_ipv6=use_ipv6,

3134

gnutls_priority=server_settings["priority"],

3135

use_dbus=use_dbus,

3136

socketfd=socketfd)

2458

3137

if not foreground:

2459

3138

pidfilename = "/run/mandos.pid"

3139

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

3140

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

2460

3141

pidfile = None

2461

3142

try:

2462

pidfile = open(pidfilename, "w")

3143

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

2463

3144

except IOError as e:

2464

3145

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

2465

3146

exc_info=e)

2466

2467

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

3147

3148

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

3149

("mandos", "mandos"),

3150

("nobody", "nogroup")):

2468

3151

try:

2469

3152

uid = pwd.getpwnam(name).pw_uid

2470

gid = pwd.getpwnam(name).pw_gid

3153

gid = pwd.getpwnam(group).pw_gid

2471

3154

break

2472

3155

except KeyError:

2473

3156

continue

2477

3160

try:

2478

3161

os.setgid(gid)

2479

3162

os.setuid(uid)

3163

if debug:

3164

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

3165

gid))

2480

3166

except OSError as error:

3167

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

3168

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

2481

3169

if error.errno != errno.EPERM:

2482

raise error

2483

3170

raise

3171

2484

3172

if debug:

2485

3173

# Enable all possible GnuTLS debugging

2486

3174

2487

3175

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

2488

3176

# - GnuTLS manual

2489

gnutls.library.functions.gnutls_global_set_log_level(11)

2490

2491

@gnutls.library.types.gnutls_log_func

3177

gnutls.global_set_log_level(11)

3178

3179

@gnutls.log_func

2492

3180

def debug_gnutls(level, string):

2493

3181

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

2494

2495

(gnutls.library.functions

2496

.gnutls_global_set_log_function(debug_gnutls))

2497

3182

3183

gnutls.global_set_log_function(debug_gnutls)

3184

2498

3185

# Redirect stdin so all checkers get /dev/null

2499

3186

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

2500

3187

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

2501

3188

if null > 2:

2502

3189

os.close(null)

2503

3190

2504

3191

# Need to fork before connecting to D-Bus

2505

3192

if not foreground:

2506

3193

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

2507

3194

daemon()

2508

2509

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

2510

# need to inform gobject that threads will be used.

2511

gobject.threads_init()

2512

3195

3196

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

3197

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

3198

# need to inform GLib that threads will be used.

3199

GLib.threads_init()

3200

2513

3201

global main_loop

2514

3202

# From the Avahi example code

2515

3203

DBusGMainLoop(set_as_default=True)

2516

main_loop = gobject.MainLoop()

3204

main_loop = GLib.MainLoop()

2517

3205

bus = dbus.SystemBus()

2518

3206

# End of Avahi example code

2519

3207

if use_dbus:

2520

3208

try:

2521

3209

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

2522

bus, do_not_queue=True)

2523

old_bus_name = (dbus.service.BusName

2524

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

2525

do_not_queue=True))

2526

except dbus.exceptions.NameExistsException as e:

3210

bus,

3211

do_not_queue=True)

3212

old_bus_name = dbus.service.BusName(

3213

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

3214

do_not_queue=True)

3215

except dbus.exceptions.DBusException as e:

2527

3216

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

2528

3217

use_dbus = False

2529

3218

server_settings["use_dbus"] = False

2530

3219

tcp_server.use_dbus = False

2531

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2532

service = AvahiServiceToSyslog(name =

2533

server_settings["servicename"],

2534

servicetype = "_mandos._tcp",

2535

protocol = protocol, bus = bus)

2536

if server_settings["interface"]:

2537

service.interface = (if_nametoindex

2538

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

2539

3220

if zeroconf:

3221

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3222

service = AvahiServiceToSyslog(

3223

name=server_settings["servicename"],

3224

servicetype="_mandos._tcp",

3225

protocol=protocol,

3226

bus=bus)

3227

if server_settings["interface"]:

3228

service.interface = if_nametoindex(

3229

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

3230

2540

3231

global multiprocessing_manager

2541

3232

multiprocessing_manager = multiprocessing.Manager()

2542

3233

2543

3234

client_class = Client

2544

3235

if use_dbus:

2545

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

2546

3236

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

3237

2547

3238

client_settings = Client.config_parser(client_config)

2548

3239

old_client_settings = {}

2549

3240

clients_data = {}

2550

3241

2551

3242

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

2552

3243

global wnull

2553

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

3244

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

2554

3245

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

2555

3246

# mode

2556

3247

if debug or not foreground:

2557

3248

wnull.close()

2558

3249

2559

3250

# Get client data and settings from last running state.

2560

3251

if server_settings["restore"]:

2561

3252

try:

2562

3253

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

2563

clients_data, old_client_settings = (pickle.load

2564

(stored_state))

3254

if sys.version_info.major == 2:

3255

clients_data, old_client_settings = pickle.load(

3256

stored_state)

3257

else:

3258

bytes_clients_data, bytes_old_client_settings = (

3259

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

3260

# Fix bytes to strings

3261

# clients_data

3262

# .keys()

3263

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

3264

if isinstance(key, bytes)

3265

else key): value

3266

for key, value in

3267

bytes_clients_data.items()}

3268

del bytes_clients_data

3269

for key in clients_data:

3270

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

3271

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

3272

for k, v in

3273

clients_data[key].items()}

3274

clients_data[key] = value

3275

# .client_structure

3276

value["client_structure"] = [

3277

(s.decode("utf-8")

3278

if isinstance(s, bytes)

3279

else s) for s in

3280

value["client_structure"]]

3281

# .name, .host, and .checker_command

3282

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

3283

if isinstance(value[k], bytes):

3284

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

3285

if "key_id" not in value:

3286

value["key_id"] = ""

3287

elif "fingerprint" not in value:

3288

value["fingerprint"] = ""

3289

# old_client_settings

3290

# .keys()

3291

old_client_settings = {

3292

(key.decode("utf-8")

3293

if isinstance(key, bytes)

3294

else key): value

3295

for key, value in

3296

bytes_old_client_settings.items()}

3297

del bytes_old_client_settings

3298

# .host and .checker_command

3299

for value in old_client_settings.values():

3300

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

3301

if isinstance(value[attribute], bytes):

3302

value[attribute] = (value[attribute]

3303

.decode("utf-8"))

2565

3304

os.remove(stored_state_path)

2566

3305

except IOError as e:

2567

3306

if e.errno == errno.ENOENT:

2568

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

2569

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

3307

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

3308

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

2570

3309

else:

2571

3310

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

2572

3311

exc_info=e)

2573

3312

raise

2574

3313

except EOFError as e:

2575

3314

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

2576

"EOFError:", exc_info=e)

2577

3315

"EOFError:",

3316

exc_info=e)

3317

2578

3318

with PGPEngine() as pgp:

2579

for client_name, client in clients_data.iteritems():

3319

for client_name, client in clients_data.items():

2580

3320

# Skip removed clients

2581

3321

if client_name not in client_settings:

2582

3322

continue

2583

3323

2584

3324

# Decide which value to use after restoring saved state.

2585

3325

# We have three different values: Old config file,

2586

3326

# new config file, and saved state.

2591

3331

# For each value in new config, check if it

2592

3332

# differs from the old config value (Except for

2593

3333

# the "secret" attribute)

2594

if (name != "secret" and

2595

value != old_client_settings[client_name]

2596

[name]):

3334

if (name != "secret"

3335

and (value !=

3336

old_client_settings[client_name][name])):

2597

3337

client[name] = value

2598

3338

except KeyError:

2599

3339

pass

2600

3340

2601

3341

# Clients who has passed its expire date can still be

2602

# enabled if its last checker was successful. Clients

3342

# enabled if its last checker was successful. A Client

2603

3343

# whose checker succeeded before we stored its state is

2604

3344

# assumed to have successfully run all checkers during

2605

3345

# downtime.

2607

3347

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

2608

3348

if not client["last_checked_ok"]:

2609

3349

logger.warning(

2610

"disabling client {0} - Client never "

2611

"performed a successful checker"

2612

.format(client_name))

3350

"disabling client {} - Client never "

3351

"performed a successful checker".format(

3352

client_name))

2613

3353

client["enabled"] = False

2614

3354

elif client["last_checker_status"] != 0:

2615

3355

logger.warning(

2616

"disabling client {0} - Client "

2617

"last checker failed with error code {1}"

2618

.format(client_name,

2619

client["last_checker_status"]))

3356

"disabling client {} - Client last"

3357

" checker failed with error code"

3358

" {}".format(

3359

client_name,

3360

client["last_checker_status"]))

2620

3361

client["enabled"] = False

2621

3362

else:

2622

client["expires"] = (datetime.datetime

2623

.utcnow()

2624

+ client["timeout"])

3363

client["expires"] = (

3364

datetime.datetime.utcnow()

3365

+ client["timeout"])

2625

3366

logger.debug("Last checker succeeded,"

2626

" keeping {0} enabled"

2627

.format(client_name))

3367

" keeping {} enabled".format(

3368

client_name))

2628

3369

try:

2629

client["secret"] = (

2630

pgp.decrypt(client["encrypted_secret"],

2631

client_settings[client_name]

2632

["secret"]))

3370

client["secret"] = pgp.decrypt(

3371

client["encrypted_secret"],

3372

client_settings[client_name]["secret"])

2633

3373

except PGPError:

2634

3374

# If decryption fails, we use secret from new settings

2635

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

2636

.format(client_name))

2637

client["secret"] = (

2638

client_settings[client_name]["secret"])

2639

3375

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

3376

client_name))

3377

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

3378

["secret"])

3379

2640

3380

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

2641

3381

for client_name in (set(old_client_settings)

2642

3382

- set(client_settings)):

2644

3384

for client_name in (set(client_settings)

2645

3385

- set(old_client_settings)):

2646

3386

clients_data[client_name] = client_settings[client_name]

2647

3387

2648

3388

# Create all client objects

2649

for client_name, client in clients_data.iteritems():

3389

for client_name, client in clients_data.items():

2650

3390

tcp_server.clients[client_name] = client_class(

2651

name = client_name, settings = client,

2652

server_settings = server_settings)

2653

3391

name=client_name,

3392

settings=client,

3393

server_settings=server_settings)

3394

2654

3395

if not tcp_server.clients:

2655

3396

logger.warning("No clients defined")

2656

3397

2657

3398

if not foreground:

2658

3399

if pidfile is not None:

3400

pid = os.getpid()

2659

3401

try:

2660

3402

with pidfile:

2661

pid = os.getpid()

2662

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

3403

print(pid, file=pidfile)

2663

3404

except IOError:

2664

3405

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

2665

3406

pidfilename, pid)

2666

3407

del pidfile

2667

3408

del pidfilename

2668

2669

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

2670

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

2671

3409

3410

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

3411

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3412

lambda: main_loop.quit() and False)

3413

2672

3414

if use_dbus:

2673

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

2674

"se.bsnet.fukt.Mandos"})

2675

class MandosDBusService(DBusObjectWithProperties):

3415

3416

@alternate_dbus_interfaces(

3417

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

3418

class MandosDBusService(DBusObjectWithObjectManager):

2676

3419

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

3420

2677

3421

def __init__(self):

2678

3422

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

3423

2679

3424

_interface = "se.recompile.Mandos"

2680

2681

@dbus_interface_annotations(_interface)

2682

def _foo(self):

2683

return { "org.freedesktop.DBus.Property"

2684

".EmitsChangedSignal":

2685

"false"}

2686

3425

2687

3426

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

2688

3427

def ClientAdded(self, objpath):

2689

3428

"D-Bus signal"

2690

3429

pass

2691

3430

2692

3431

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

2693

def ClientNotFound(self, fingerprint, address):

3432

def ClientNotFound(self, key_id, address):

2694

3433

"D-Bus signal"

2695

3434

pass

2696

3435

3436

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

3437

"true"})

2697

3438

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

2698

3439

def ClientRemoved(self, objpath, name):

2699

3440

"D-Bus signal"

2700

3441

pass

2701

3442

3443

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

3444

"true"})

2702

3445

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

2703

3446

def GetAllClients(self):

2704

3447

"D-Bus method"

2705

return dbus.Array(c.dbus_object_path

2706

for c in

2707

tcp_server.clients.itervalues())

2708

3448

return dbus.Array(c.dbus_object_path for c in

3449

tcp_server.clients.values())

3450

3451

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

3452

"true"})

2709

3453

@dbus.service.method(_interface,

2710

3454

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

2711

3455

def GetAllClientsWithProperties(self):

2712

3456

"D-Bus method"

2713

3457

return dbus.Dictionary(

2714

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

2715

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

3458

{c.dbus_object_path: c.GetAll(

3459

"se.recompile.Mandos.Client")

3460

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

2716

3461

signature="oa{sv}")

2717

3462

2718

3463

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

2719

3464

def RemoveClient(self, object_path):

2720

3465

"D-Bus method"

2721

for c in tcp_server.clients.itervalues():

3466

for c in tcp_server.clients.values():

2722

3467

if c.dbus_object_path == object_path:

2723

3468

del tcp_server.clients[c.name]

2724

3469

c.remove_from_connection()

2725

# Don't signal anything except ClientRemoved

3470

# Don't signal the disabling

2726

3471

c.disable(quiet=True)

2727

# Emit D-Bus signal

2728

self.ClientRemoved(object_path, c.name)

3472

# Emit D-Bus signal for removal

3473

self.client_removed_signal(c)

2729

3474

return

2730

3475

raise KeyError(object_path)

2731

3476

2732

3477

del _interface

2733

3478

3479

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3480

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

3481

def GetManagedObjects(self):

3482

"""D-Bus method"""

3483

return dbus.Dictionary(

3484

{client.dbus_object_path:

3485

dbus.Dictionary(

3486

{interface: client.GetAll(interface)

3487

for interface in

3488

client._get_all_interface_names()})

3489

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

3490

3491

def client_added_signal(self, client):

3492

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

3493

if use_dbus:

3494

# New standard signal

3495

self.InterfacesAdded(

3496

client.dbus_object_path,

3497

dbus.Dictionary(

3498

{interface: client.GetAll(interface)

3499

for interface in

3500

client._get_all_interface_names()}))

3501

# Old signal

3502

self.ClientAdded(client.dbus_object_path)

3503

3504

def client_removed_signal(self, client):

3505

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

3506

if use_dbus:

3507

# New standard signal

3508

self.InterfacesRemoved(

3509

client.dbus_object_path,

3510

client._get_all_interface_names())

3511

# Old signal

3512

self.ClientRemoved(client.dbus_object_path,

3513

client.name)

3514

2734

3515

mandos_dbus_service = MandosDBusService()

2735

3516

3517

# Save modules to variables to exempt the modules from being

3518

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

3519

mp = multiprocessing

3520

wn = wnull

3521

2736

3522

def cleanup():

2737

3523

"Cleanup function; run on exit"

2738

service.cleanup()

2739

2740

multiprocessing.active_children()

2741

wnull.close()

3524

if zeroconf:

3525

service.cleanup()

3526

3527

mp.active_children()

3528

wn.close()

2742

3529

if not (tcp_server.clients or client_settings):

2743

3530

return

2744

3531

2745

3532

# Store client before exiting. Secrets are encrypted with key

2746

3533

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

2747

3534

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

2748

3535

clients = {}

2749

3536

with PGPEngine() as pgp:

2750

for client in tcp_server.clients.itervalues():

3537

for client in tcp_server.clients.values():

2751

3538

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

2752

3539

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

2753

3540

key)

2754

3541

client_dict = {}

2755

3542

2756

3543

# A list of attributes that can not be pickled

2757

3544

# + secret.

2758

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

2759

"checker", "server_settings"))

2760

for name, typ in (inspect.getmembers

2761

(dbus.service.Object)):

3545

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

3546

"checker", "server_settings"}

3547

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

3548

.Object):

2762

3549

exclude.add(name)

2763

3550

2764

3551

client_dict["encrypted_secret"] = (client

2765

3552

.encrypted_secret)

2766

3553

for attr in client.client_structure:

2767

3554

if attr not in exclude:

2768

3555

client_dict[attr] = getattr(client, attr)

2769

3556

2770

3557

clients[client.name] = client_dict

2771

3558

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

2772

3559

2773

3560

try:

2774

with (tempfile.NamedTemporaryFile

2775

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

2776

dir=os.path.dirname(stored_state_path),

2777

delete=False)) as stored_state:

2778

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

2779

tempname=stored_state.name

3561

with tempfile.NamedTemporaryFile(

3562

mode='wb',

3563

suffix=".pickle",

3564

prefix='clients-',

3565

dir=os.path.dirname(stored_state_path),

3566

delete=False) as stored_state:

3567

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

3568

protocol=2)

3569

tempname = stored_state.name

2780

3570

os.rename(tempname, stored_state_path)

2781

3571

except (IOError, OSError) as e:

2782

3572

if not debug:

2785

3575

except NameError:

2786

3576

pass

2787

3577

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

2788

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

3578

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

2789

3579

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

2790

3580

else:

2791

3581

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

2792

3582

exc_info=e)

2793

raise e

2794

3583

raise

3584

2795

3585

# Delete all clients, and settings from config

2796

3586

while tcp_server.clients:

2797

3587

name, client = tcp_server.clients.popitem()

2798

3588

if use_dbus:

2799

3589

client.remove_from_connection()

2800

# Don't signal anything except ClientRemoved

3590

# Don't signal the disabling

2801

3591

client.disable(quiet=True)

3592

# Emit D-Bus signal for removal

2802

3593

if use_dbus:

2803

# Emit D-Bus signal

2804

mandos_dbus_service.ClientRemoved(client

2805

.dbus_object_path,

2806

client.name)

3594

mandos_dbus_service.client_removed_signal(client)

2807

3595

client_settings.clear()

2808

3596

2809

3597

atexit.register(cleanup)

2810

2811

for client in tcp_server.clients.itervalues():

3598

3599

for client in tcp_server.clients.values():

2812

3600

if use_dbus:

2813

# Emit D-Bus signal

2814

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3601

# Emit D-Bus signal for adding

3602

mandos_dbus_service.client_added_signal(client)

2815

3603

# Need to initiate checking of clients

2816

3604

if client.enabled:

2817

3605

client.init_checker()

2818

3606

2819

3607

tcp_server.enable()

2820

3608

tcp_server.server_activate()

2821

3609

2822

3610

# Find out what port we got

2823

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

3611

if zeroconf:

3612

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

2824

3613

if use_ipv6:

2825

3614

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

2826

3615

" flowinfo %d, scope_id %d",

2828

3617

else: # IPv4

2829

3618

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

2830

3619

*tcp_server.socket.getsockname())

2831

2832

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

2833

3620

3621

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

3622

2834

3623

try:

2835

# From the Avahi example code

2836

try:

2837

service.activate()

2838

except dbus.exceptions.DBusException as error:

2839

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

2840

cleanup()

2841

sys.exit(1)

2842

# End of Avahi example code

2843

2844

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

2845

lambda *args, **kwargs:

2846

(tcp_server.handle_request

2847

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

2848

3624

if zeroconf:

3625

# From the Avahi example code

3626

try:

3627

service.activate()

3628

except dbus.exceptions.DBusException as error:

3629

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

3630

cleanup()

3631

sys.exit(1)

3632

# End of Avahi example code

3633

3634

GLib.io_add_watch(

3635

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

3636

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3637

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

3638

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

3639

2849

3640

logger.debug("Starting main loop")

2850

3641

main_loop.run()

2851

3642

except AvahiError as error:

2860

3651

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

2861

3652

cleanup()

2862

3653

3654

3655

def should_only_run_tests():

3656

parser = argparse.ArgumentParser(add_help=False)

3657

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

3658

args, unknown_args = parser.parse_known_args()

3659

run_tests = args.check

3660

if run_tests:

3661

# Remove --check argument from sys.argv

3662

sys.argv[1:] = unknown_args

3663

return run_tests

3664

3665

# Add all tests from doctest strings

3666

def load_tests(loader, tests, none):

3667

import doctest

3668

tests.addTests(doctest.DocTestSuite())

3669

return tests

3670

2863

3671

if __name__ == '__main__':

2864

main()

3672

try:

3673

if should_only_run_tests():

3674

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

3675

unittest.main()

3676

else:

3677

main()

3678

finally:

3679

logging.shutdown()