/mandos/release : revision 237.7.748

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

72

82

73

83

import dbus

74

84

import dbus.service

75

import gobject

76

import avahi

85

import gi

86

from gi.repository import GLib

77

87

from dbus.mainloop.glib import DBusGMainLoop

78

88

import ctypes

79

89

import ctypes.util

80

90

import xml.dom.minidom

81

91

import inspect

82

import GnuPGInterface

83

92

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

97

# Show warnings by default

98

if not sys.warnoptions:

99

import warnings

100

warnings.simplefilter("default")

101

102

# Try to find the value of SO_BINDTODEVICE:

84

103

try:

104

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

105

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

85

106

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

86

107

except AttributeError:

87

108

try:

109

# This is where SO_BINDTODEVICE was up to and including Python

110

# 2.6, and also 3.2:

88

111

from IN import SO_BINDTODEVICE

89

112

except ImportError:

90

SO_BINDTODEVICE = None

91

92

version = "1.6.0"

113

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

114

# Try running the C preprocessor:

115

try:

116

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

117

"/dev/stdin"],

118

stdin=subprocess.PIPE,

119

stdout=subprocess.PIPE)

120

stdout = cc.communicate(

121

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

122

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

123

except (OSError, ValueError, IndexError):

124

# No value found

125

SO_BINDTODEVICE = None

126

127

if sys.version_info < (3, 2):

128

configparser.Configparser = configparser.SafeConfigParser

129

130

version = "1.8.9"

93

131

stored_state_file = "clients.pickle"

94

132

95

133

logger = logging.getLogger()

96

syslogger = (logging.handlers.SysLogHandler

97

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

98

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

134

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

135

syslogger = None

99

136

100

137

try:

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

138

if_nametoindex = ctypes.cdll.LoadLibrary(

139

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

104

140

except (OSError, AttributeError):

141

105

142

def if_nametoindex(interface):

106

143

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

107

144

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

108

145

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

109

146

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

110

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

111

interface))

112

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

113

ifreq[16:20])[0]

147

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

148

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

114

149

return interface_index

115

150

116

151

152

def copy_function(func):

153

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

154

if sys.version_info.major == 2:

155

return types.FunctionType(func.func_code,

156

func.func_globals,

157

func.func_name,

158

func.func_defaults,

159

func.func_closure)

160

else:

161

return types.FunctionType(func.__code__,

162

func.__globals__,

163

func.__name__,

164

func.__defaults__,

165

func.__closure__)

166

167

117

168

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

118

169

"""init logger and add loglevel"""

119

170

171

global syslogger

172

syslogger = (logging.handlers.SysLogHandler(

173

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

174

address="/dev/log"))

120

175

syslogger.setFormatter(logging.Formatter

121

176

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

122

177

' %(message)s'))

123

178

logger.addHandler(syslogger)

124

179

125

180

if debug:

126

181

console = logging.StreamHandler()

127

182

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

137

192

pass

138

193

139

194

140

class PGPEngine(object):

195

class PGPEngine:

141

196

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

197

142

198

def __init__(self):

143

self.gnupg = GnuPGInterface.GnuPG()

144

199

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

145

self.gnupg = GnuPGInterface.GnuPG()

146

self.gnupg.options.meta_interactive = False

147

self.gnupg.options.homedir = self.tempdir

148

self.gnupg.options.extra_args.extend(['--force-mdc',

149

'--quiet',

150

'--no-use-agent'])

151

200

self.gpg = "gpg"

201

try:

202

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

203

for line in output.splitlines():

204

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

205

if name == b"gpg":

206

self.gpg = path

207

break

208

except OSError as e:

209

if e.errno != errno.ENOENT:

210

raise

211

self.gnupgargs = ['--batch',

212

'--homedir', self.tempdir,

213

'--force-mdc',

214

'--quiet']

215

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

216

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

217

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

218

152

219

def __enter__(self):

153

220

return self

154

221

155

222

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

156

223

self._cleanup()

157

224

return False

158

225

159

226

def __del__(self):

160

227

self._cleanup()

161

228

162

229

def _cleanup(self):

163

230

if self.tempdir is not None:

164

231

# Delete contents of tempdir

165

232

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

166

topdown = False):

233

topdown=False):

167

234

for filename in files:

168

235

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

169

236

for dirname in dirs:

171

238

# Remove tempdir

172

239

os.rmdir(self.tempdir)

173

240

self.tempdir = None

174

241

175

242

def password_encode(self, password):

176

243

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

177

244

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

178

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

179

245

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

246

if len(encoded) > 2048:

247

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

248

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

249

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

250

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

251

return encoded

252

180

253

def encrypt(self, data, password):

181

self.gnupg.passphrase = self.password_encode(password)

182

with open(os.devnull, "w") as devnull:

183

try:

184

proc = self.gnupg.run(['--symmetric'],

185

create_fhs=['stdin', 'stdout'],

186

attach_fhs={'stderr': devnull})

187

with contextlib.closing(proc.handles['stdin']) as f:

188

f.write(data)

189

with contextlib.closing(proc.handles['stdout']) as f:

190

ciphertext = f.read()

191

proc.wait()

192

except IOError as e:

193

raise PGPError(e)

194

self.gnupg.passphrase = None

254

passphrase = self.password_encode(password)

255

with tempfile.NamedTemporaryFile(

256

dir=self.tempdir) as passfile:

257

passfile.write(passphrase)

258

passfile.flush()

259

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

260

'--passphrase-file',

261

passfile.name]

262

+ self.gnupgargs,

263

stdin=subprocess.PIPE,

264

stdout=subprocess.PIPE,

265

stderr=subprocess.PIPE)

266

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

267

if proc.returncode != 0:

268

raise PGPError(err)

195

269

return ciphertext

196

270

197

271

def decrypt(self, data, password):

198

self.gnupg.passphrase = self.password_encode(password)

199

with open(os.devnull, "w") as devnull:

200

try:

201

proc = self.gnupg.run(['--decrypt'],

202

create_fhs=['stdin', 'stdout'],

203

attach_fhs={'stderr': devnull})

204

with contextlib.closing(proc.handles['stdin']) as f:

205

f.write(data)

206

with contextlib.closing(proc.handles['stdout']) as f:

207

decrypted_plaintext = f.read()

208

proc.wait()

209

except IOError as e:

210

raise PGPError(e)

211

self.gnupg.passphrase = None

272

passphrase = self.password_encode(password)

273

with tempfile.NamedTemporaryFile(

274

dir=self.tempdir) as passfile:

275

passfile.write(passphrase)

276

passfile.flush()

277

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

278

'--passphrase-file',

279

passfile.name]

280

+ self.gnupgargs,

281

stdin=subprocess.PIPE,

282

stdout=subprocess.PIPE,

283

stderr=subprocess.PIPE)

284

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

285

if proc.returncode != 0:

286

raise PGPError(err)

212

287

return decrypted_plaintext

213

288

214

289

290

# Pretend that we have an Avahi module

291

class avahi:

292

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

293

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

294

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

295

PROTO_INET = 0 # avahi-common/address.h

296

PROTO_INET6 = 1 # avahi-common/address.h

297

DBUS_NAME = "org.freedesktop.Avahi"

298

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

299

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

300

DBUS_PATH_SERVER = "/"

301

302

@staticmethod

303

def string_array_to_txt_array(t):

304

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

305

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

306

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

307

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

308

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

309

SERVER_INVALID = 0 # avahi-common/defs.h

310

SERVER_REGISTERING = 1 # avahi-common/defs.h

311

SERVER_RUNNING = 2 # avahi-common/defs.h

312

SERVER_COLLISION = 3 # avahi-common/defs.h

313

SERVER_FAILURE = 4 # avahi-common/defs.h

314

315

215

316

class AvahiError(Exception):

216

317

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

217

318

self.value = value

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

319

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

320

**kwargs)

321

221

322

222

323

class AvahiServiceError(AvahiError):

223

324

pass

224

325

326

225

327

class AvahiGroupError(AvahiError):

226

328

pass

227

329

228

330

229

class AvahiService(object):

331

class AvahiService:

230

332

"""An Avahi (Zeroconf) service.

231

333

232

334

Attributes:

233

335

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

234

336

Used to optionally bind to the specified interface.

235

337

name: string; Example: 'Mandos'

236

338

type: string; Example: '_mandos._tcp'.

237

See <http://www.dns-sd.org/ServiceTypes.html>

339

See <https://www.iana.org/assignments/service-names-port-numbers>

238

340

port: integer; what port to announce

239

341

TXT: list of strings; TXT record for the service

240

342

domain: string; Domain to publish on, default to .local if empty.

246

348

server: D-Bus Server

247

349

bus: dbus.SystemBus()

248

350

"""

249

250

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

251

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

252

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

253

protocol = avahi.PROTO_UNSPEC, bus = None):

351

352

def __init__(self,

353

interface=avahi.IF_UNSPEC,

354

name=None,

355

servicetype=None,

356

port=None,

357

TXT=None,

358

domain="",

359

host="",

360

max_renames=32768,

361

protocol=avahi.PROTO_UNSPEC,

362

bus=None):

254

363

self.interface = interface

255

364

self.name = name

256

365

self.type = servicetype

265

374

self.server = None

266

375

self.bus = bus

267

376

self.entry_group_state_changed_match = None

268

269

def rename(self):

377

378

def rename(self, remove=True):

270

379

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

271

380

if self.rename_count >= self.max_renames:

272

381

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

273

382

" after %i retries, exiting.",

274

383

self.rename_count)

275

384

raise AvahiServiceError("Too many renames")

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

385

self.name = str(

386

self.server.GetAlternativeServiceName(self.name))

387

self.rename_count += 1

278

388

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

279

389

self.name)

280

self.remove()

390

if remove:

391

self.remove()

281

392

try:

282

393

self.add()

283

394

except dbus.exceptions.DBusException as error:

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

288

395

if (error.get_dbus_name()

396

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

397

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

398

return self.rename(remove=False)

399

else:

400

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

401

self.cleanup()

402

os._exit(1)

403

289

404

def remove(self):

290

405

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

291

406

if self.entry_group_state_changed_match is not None:

293

408

self.entry_group_state_changed_match = None

294

409

if self.group is not None:

295

410

self.group.Reset()

296

411

297

412

def add(self):

298

413

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

299

414

self.remove()

316

431

dbus.UInt16(self.port),

317

432

avahi.string_array_to_txt_array(self.TXT))

318

433

self.group.Commit()

319

434

320

435

def entry_group_state_changed(self, state, error):

321

436

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

322

437

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

323

438

324

439

if state == avahi.ENTRY_GROUP_ESTABLISHED:

325

440

logger.debug("Zeroconf service established.")

326

441

elif state == avahi.ENTRY_GROUP_COLLISION:

328

443

self.rename()

329

444

elif state == avahi.ENTRY_GROUP_FAILURE:

330

445

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

331

unicode(error))

332

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

333

.format(error))

334

446

str(error))

447

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

448

335

449

def cleanup(self):

336

450

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

337

451

if self.group is not None:

342

456

pass

343

457

self.group = None

344

458

self.remove()

345

459

346

460

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

347

461

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

348

462

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

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

463

bad_states = {

464

avahi.SERVER_INVALID: "Zeroconf server invalid",

465

avahi.SERVER_REGISTERING: None,

466

avahi.SERVER_COLLISION: "Zeroconf server name collision",

467

avahi.SERVER_FAILURE: "Zeroconf server failure",

468

}

356

469

if state in bad_states:

357

470

if bad_states[state] is not None:

358

471

if error is None:

361

474

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

362

475

self.cleanup()

363

476

elif state == avahi.SERVER_RUNNING:

364

self.add()

477

try:

478

self.add()

479

except dbus.exceptions.DBusException as error:

480

if (error.get_dbus_name()

481

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

482

logger.info("Local Zeroconf service name"

483

" collision.")

484

return self.rename(remove=False)

485

else:

486

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

487

self.cleanup()

488

os._exit(1)

365

489

else:

366

490

if error is None:

367

491

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

368

492

else:

369

493

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

370

494

371

495

def activate(self):

372

496

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

373

497

if self.server is None:

377

501

follow_name_owner_changes=True),

378

502

avahi.DBUS_INTERFACE_SERVER)

379

503

self.server.connect_to_signal("StateChanged",

380

self.server_state_changed)

504

self.server_state_changed)

381

505

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

382

506

383

507

384

508

class AvahiServiceToSyslog(AvahiService):

385

def rename(self):

509

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

386

510

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

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

511

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

512

syslogger.setFormatter(logging.Formatter(

513

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

514

.format(self.name)))

392

515

return ret

393

516

394

517

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

400

401

402

class Client(object):

518

# Pretend that we have a GnuTLS module

519

class gnutls:

520

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

521

522

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

523

if library is None:

524

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

525

_library = ctypes.cdll.LoadLibrary(library)

526

del library

527

528

# Unless otherwise indicated, the constants and types below are

529

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

530

531

# Constants

532

E_SUCCESS = 0

533

E_INTERRUPTED = -52

534

E_AGAIN = -28

535

CRT_OPENPGP = 2

536

CRT_RAWPK = 3

537

CLIENT = 2

538

SHUT_RDWR = 0

539

CRD_CERTIFICATE = 1

540

E_NO_CERTIFICATE_FOUND = -49

541

X509_FMT_DER = 0

542

NO_TICKETS = 1<<10

543

ENABLE_RAWPK = 1<<18

544

CTYPE_PEERS = 3

545

KEYID_USE_SHA256 = 1 # gnutls/x509.h

546

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

547

548

# Types

549

class session_int(ctypes.Structure):

550

_fields_ = []

551

session_t = ctypes.POINTER(session_int)

552

553

class certificate_credentials_st(ctypes.Structure):

554

_fields_ = []

555

certificate_credentials_t = ctypes.POINTER(

556

certificate_credentials_st)

557

certificate_type_t = ctypes.c_int

558

559

class datum_t(ctypes.Structure):

560

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

561

('size', ctypes.c_uint)]

562

563

class openpgp_crt_int(ctypes.Structure):

564

_fields_ = []

565

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

566

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

567

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

568

credentials_type_t = ctypes.c_int

569

transport_ptr_t = ctypes.c_void_p

570

close_request_t = ctypes.c_int

571

572

# Exceptions

573

class Error(Exception):

574

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

575

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

576

# code is passed, convert it to a string with

577

# gnutls.strerror()

578

self.code = code

579

if message is None and code is not None:

580

message = gnutls.strerror(code)

581

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

582

message, *args)

583

584

class CertificateSecurityError(Error):

585

pass

586

587

# Classes

588

class Credentials:

589

def __init__(self):

590

self._c_object = gnutls.certificate_credentials_t()

591

gnutls.certificate_allocate_credentials(

592

ctypes.byref(self._c_object))

593

self.type = gnutls.CRD_CERTIFICATE

594

595

def __del__(self):

596

gnutls.certificate_free_credentials(self._c_object)

597

598

class ClientSession:

599

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

600

self._c_object = gnutls.session_t()

601

gnutls_flags = gnutls.CLIENT

602

if gnutls.check_version(b"3.5.6"):

603

gnutls_flags |= gnutls.NO_TICKETS

604

if gnutls.has_rawpk:

605

gnutls_flags |= gnutls.ENABLE_RAWPK

606

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

607

del gnutls_flags

608

gnutls.set_default_priority(self._c_object)

609

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

610

gnutls.handshake_set_private_extensions(self._c_object,

611

True)

612

self.socket = socket

613

if credentials is None:

614

credentials = gnutls.Credentials()

615

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

616

ctypes.cast(credentials._c_object,

617

ctypes.c_void_p))

618

self.credentials = credentials

619

620

def __del__(self):

621

gnutls.deinit(self._c_object)

622

623

def handshake(self):

624

return gnutls.handshake(self._c_object)

625

626

def send(self, data):

627

data = bytes(data)

628

data_len = len(data)

629

while data_len > 0:

630

data_len -= gnutls.record_send(self._c_object,

631

data[-data_len:],

632

data_len)

633

634

def bye(self):

635

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

636

637

# Error handling functions

638

def _error_code(result):

639

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

640

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

641

if result >= 0:

642

return result

643

if result == gnutls.E_NO_CERTIFICATE_FOUND:

644

raise gnutls.CertificateSecurityError(code=result)

645

raise gnutls.Error(code=result)

646

647

def _retry_on_error(result, func, arguments):

648

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

649

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

650

while result < 0:

651

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

652

return _error_code(result)

653

result = func(*arguments)

654

return result

655

656

# Unless otherwise indicated, the function declarations below are

657

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

658

659

# Functions

660

priority_set_direct = _library.gnutls_priority_set_direct

661

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

662

ctypes.POINTER(ctypes.c_char_p)]

663

priority_set_direct.restype = _error_code

664

665

init = _library.gnutls_init

666

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

667

init.restype = _error_code

668

669

set_default_priority = _library.gnutls_set_default_priority

670

set_default_priority.argtypes = [session_t]

671

set_default_priority.restype = _error_code

672

673

record_send = _library.gnutls_record_send

674

record_send.argtypes = [session_t, ctypes.c_void_p,

675

ctypes.c_size_t]

676

record_send.restype = ctypes.c_ssize_t

677

record_send.errcheck = _retry_on_error

678

679

certificate_allocate_credentials = (

680

_library.gnutls_certificate_allocate_credentials)

681

certificate_allocate_credentials.argtypes = [

682

ctypes.POINTER(certificate_credentials_t)]

683

certificate_allocate_credentials.restype = _error_code

684

685

certificate_free_credentials = (

686

_library.gnutls_certificate_free_credentials)

687

certificate_free_credentials.argtypes = [

688

certificate_credentials_t]

689

certificate_free_credentials.restype = None

690

691

handshake_set_private_extensions = (

692

_library.gnutls_handshake_set_private_extensions)

693

handshake_set_private_extensions.argtypes = [session_t,

694

ctypes.c_int]

695

handshake_set_private_extensions.restype = None

696

697

credentials_set = _library.gnutls_credentials_set

698

credentials_set.argtypes = [session_t, credentials_type_t,

699

ctypes.c_void_p]

700

credentials_set.restype = _error_code

701

702

strerror = _library.gnutls_strerror

703

strerror.argtypes = [ctypes.c_int]

704

strerror.restype = ctypes.c_char_p

705

706

certificate_type_get = _library.gnutls_certificate_type_get

707

certificate_type_get.argtypes = [session_t]

708

certificate_type_get.restype = _error_code

709

710

certificate_get_peers = _library.gnutls_certificate_get_peers

711

certificate_get_peers.argtypes = [session_t,

712

ctypes.POINTER(ctypes.c_uint)]

713

certificate_get_peers.restype = ctypes.POINTER(datum_t)

714

715

global_set_log_level = _library.gnutls_global_set_log_level

716

global_set_log_level.argtypes = [ctypes.c_int]

717

global_set_log_level.restype = None

718

719

global_set_log_function = _library.gnutls_global_set_log_function

720

global_set_log_function.argtypes = [log_func]

721

global_set_log_function.restype = None

722

723

deinit = _library.gnutls_deinit

724

deinit.argtypes = [session_t]

725

deinit.restype = None

726

727

handshake = _library.gnutls_handshake

728

handshake.argtypes = [session_t]

729

handshake.restype = _error_code

730

handshake.errcheck = _retry_on_error

731

732

transport_set_ptr = _library.gnutls_transport_set_ptr

733

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

734

transport_set_ptr.restype = None

735

736

bye = _library.gnutls_bye

737

bye.argtypes = [session_t, close_request_t]

738

bye.restype = _error_code

739

bye.errcheck = _retry_on_error

740

741

check_version = _library.gnutls_check_version

742

check_version.argtypes = [ctypes.c_char_p]

743

check_version.restype = ctypes.c_char_p

744

745

_need_version = b"3.3.0"

746

if check_version(_need_version) is None:

747

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

748

.format(_need_version))

749

750

_tls_rawpk_version = b"3.6.6"

751

has_rawpk = bool(check_version(_tls_rawpk_version))

752

753

if has_rawpk:

754

# Types

755

class pubkey_st(ctypes.Structure):

756

_fields = []

757

pubkey_t = ctypes.POINTER(pubkey_st)

758

759

x509_crt_fmt_t = ctypes.c_int

760

761

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

762

pubkey_init = _library.gnutls_pubkey_init

763

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

764

pubkey_init.restype = _error_code

765

766

pubkey_import = _library.gnutls_pubkey_import

767

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

768

x509_crt_fmt_t]

769

pubkey_import.restype = _error_code

770

771

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

772

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

773

ctypes.POINTER(ctypes.c_ubyte),

774

ctypes.POINTER(ctypes.c_size_t)]

775

pubkey_get_key_id.restype = _error_code

776

777

pubkey_deinit = _library.gnutls_pubkey_deinit

778

pubkey_deinit.argtypes = [pubkey_t]

779

pubkey_deinit.restype = None

780

else:

781

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

782

783

openpgp_crt_init = _library.gnutls_openpgp_crt_init

784

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

785

openpgp_crt_init.restype = _error_code

786

787

openpgp_crt_import = _library.gnutls_openpgp_crt_import

788

openpgp_crt_import.argtypes = [openpgp_crt_t,

789

ctypes.POINTER(datum_t),

790

openpgp_crt_fmt_t]

791

openpgp_crt_import.restype = _error_code

792

793

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

794

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

795

ctypes.POINTER(ctypes.c_uint)]

796

openpgp_crt_verify_self.restype = _error_code

797

798

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

799

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

800

openpgp_crt_deinit.restype = None

801

802

openpgp_crt_get_fingerprint = (

803

_library.gnutls_openpgp_crt_get_fingerprint)

804

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

805

ctypes.c_void_p,

806

ctypes.POINTER(

807

ctypes.c_size_t)]

808

openpgp_crt_get_fingerprint.restype = _error_code

809

810

if check_version(b"3.6.4"):

811

certificate_type_get2 = _library.gnutls_certificate_type_get2

812

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

813

certificate_type_get2.restype = _error_code

814

815

# Remove non-public functions

816

del _error_code, _retry_on_error

817

818

819

def call_pipe(connection, # : multiprocessing.Connection

820

func, *args, **kwargs):

821

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

822

823

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

824

return value on the provided multiprocessing.Connection.

825

"""

826

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

827

connection.close()

828

829

830

class Client:

403

831

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

404

832

405

833

Attributes:

406

834

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

407

835

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

408

836

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

409

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

410

to see if the client lives.

411

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

837

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

838

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

839

running.

840

checker_callback_tag: a GLib event source tag, or None

413

841

checker_command: string; External command which is run to check

414

842

if client lives. %() expansions are done at

415

843

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

416

844

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

417

checker_initiator_tag: a gobject event source tag, or None

845

checker_initiator_tag: a GLib event source tag, or None

418

846

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

419

847

client_structure: Object describing what attributes a client has

420

848

and is used for storing the client at exit

421

849

current_checker_command: string; current running checker_command

422

disable_initiator_tag: a gobject event source tag, or None

850

disable_initiator_tag: a GLib event source tag, or None

423

851

enabled: bool()

424

852

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

425

uniquely identify the client

853

uniquely identify an OpenPGP client

854

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

855

a client using raw public keys

426

856

host: string; available for use by the checker command

427

857

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

428

858

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

430

860

last_checker_status: integer between 0 and 255 reflecting exit

431

861

status of last checker. -1 reflects crashed

432

862

checker, -2 means no checker completed yet.

863

last_checker_signal: The signal which killed the last checker, if

864

last_checker_status is -1

433

865

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

434

866

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

435

867

D-Bus identifiers

440

872

runtime_expansions: Allowed attributes for runtime expansion.

441

873

expires: datetime.datetime(); time (UTC) when a client will be

442

874

disabled, or None

875

server_settings: The server_settings dict from main()

443

876

"""

444

877

445

878

runtime_expansions = ("approval_delay", "approval_duration",

446

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

879

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

447

880

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

448

881

"last_approval_request", "last_checked_ok",

449

882

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

450

client_defaults = { "timeout": "PT5M",

451

"extended_timeout": "PT15M",

452

"interval": "PT2M",

453

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

454

"host": "",

455

"approval_delay": "PT0S",

456

"approval_duration": "PT1S",

457

"approved_by_default": "True",

458

"enabled": "True",

459

}

460

461

def timeout_milliseconds(self):

462

"Return the 'timeout' attribute in milliseconds"

463

return timedelta_to_milliseconds(self.timeout)

464

465

def extended_timeout_milliseconds(self):

466

"Return the 'extended_timeout' attribute in milliseconds"

467

return timedelta_to_milliseconds(self.extended_timeout)

468

469

def interval_milliseconds(self):

470

"Return the 'interval' attribute in milliseconds"

471

return timedelta_to_milliseconds(self.interval)

472

473

def approval_delay_milliseconds(self):

474

return timedelta_to_milliseconds(self.approval_delay)

475

883

client_defaults = {

884

"timeout": "PT5M",

885

"extended_timeout": "PT15M",

886

"interval": "PT2M",

887

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

888

"host": "",

889

"approval_delay": "PT0S",

890

"approval_duration": "PT1S",

891

"approved_by_default": "True",

892

"enabled": "True",

893

}

894

476

895

@staticmethod

477

896

def config_parser(config):

478

897

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

485

904

for client_name in config.sections():

486

905

section = dict(config.items(client_name))

487

906

client = settings[client_name] = {}

488

907

489

908

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

490

909

# Reformat values from string types to Python types

491

910

client["approved_by_default"] = config.getboolean(

492

911

client_name, "approved_by_default")

493

912

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

494

913

"enabled")

495

914

915

# Uppercase and remove spaces from key_id and fingerprint

916

# for later comparison purposes with return value from the

917

# key_id() and fingerprint() functions

918

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

919

.replace(" ", ""))

496

920

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

497

921

.replace(" ", ""))

498

922

if "secret" in section:

499

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

923

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

924

.encode("utf-8"),

925

"base64")

500

926

elif "secfile" in section:

501

927

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

502

928

(section["secfile"])),

503

929

"rb") as secfile:

504

930

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

505

931

else:

506

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

932

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

507

933

.format(section))

508

934

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

509

935

client["extended_timeout"] = string_to_delta(

517

943

client["last_approval_request"] = None

518

944

client["last_checked_ok"] = None

519

945

client["last_checker_status"] = -2

520

946

521

947

return settings

522

523

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

948

949

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

524

950

self.name = name

951

if server_settings is None:

952

server_settings = {}

953

self.server_settings = server_settings

525

954

# adding all client settings

526

for setting, value in settings.iteritems():

955

for setting, value in settings.items():

527

956

setattr(self, setting, value)

528

957

529

958

if self.enabled:

530

959

if not hasattr(self, "last_enabled"):

531

960

self.last_enabled = datetime.datetime.utcnow()

535

964

else:

536

965

self.last_enabled = None

537

966

self.expires = None

538

967

539

968

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

540

# Uppercase and remove spaces from fingerprint for later

541

# comparison purposes with return value from the fingerprint()

542

# function

969

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

543

970

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

544

971

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

545

972

datetime.datetime.utcnow())

546

973

547

974

# attributes specific for this server instance

548

975

self.checker = None

549

976

self.checker_initiator_tag = None

552

979

self.current_checker_command = None

553

980

self.approved = None

554

981

self.approvals_pending = 0

555

self.changedstate = (multiprocessing_manager

556

.Condition(multiprocessing_manager

557

.Lock()))

558

self.client_structure = [attr for attr in

559

self.__dict__.iterkeys()

982

self.changedstate = multiprocessing_manager.Condition(

983

multiprocessing_manager.Lock())

984

self.client_structure = [attr

985

for attr in self.__dict__.keys()

560

986

if not attr.startswith("_")]

561

987

self.client_structure.append("client_structure")

562

563

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

564

lambda obj:

565

isinstance(obj,

566

property)):

988

989

for name, t in inspect.getmembers(

990

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

567

991

if not name.startswith("_"):

568

992

self.client_structure.append(name)

569

993

570

994

# Send notice to process children that client state has changed

571

995

def send_changedstate(self):

572

996

with self.changedstate:

573

997

self.changedstate.notify_all()

574

998

575

999

def enable(self):

576

1000

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

577

1001

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

582

1006

self.last_enabled = datetime.datetime.utcnow()

583

1007

self.init_checker()

584

1008

self.send_changedstate()

585

1009

586

1010

def disable(self, quiet=True):

587

1011

"""Disable this client."""

588

1012

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

590

1014

if not quiet:

591

1015

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

592

1016

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

593

gobject.source_remove(self.disable_initiator_tag)

1017

GLib.source_remove(self.disable_initiator_tag)

594

1018

self.disable_initiator_tag = None

595

1019

self.expires = None

596

1020

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

597

gobject.source_remove(self.checker_initiator_tag)

1021

GLib.source_remove(self.checker_initiator_tag)

598

1022

self.checker_initiator_tag = None

599

1023

self.stop_checker()

600

1024

self.enabled = False

601

1025

if not quiet:

602

1026

self.send_changedstate()

603

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

1027

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

604

1028

return False

605

1029

606

1030

def __del__(self):

607

1031

self.disable()

608

1032

609

1033

def init_checker(self):

610

1034

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

611

1035

# and every interval from then on.

612

1036

if self.checker_initiator_tag is not None:

613

gobject.source_remove(self.checker_initiator_tag)

614

self.checker_initiator_tag = (gobject.timeout_add

615

(self.interval_milliseconds(),

616

self.start_checker))

1037

GLib.source_remove(self.checker_initiator_tag)

1038

self.checker_initiator_tag = GLib.timeout_add(

1039

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

1040

+ 1)),

1041

self.start_checker)

617

1042

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

618

1043

if self.disable_initiator_tag is not None:

619

gobject.source_remove(self.disable_initiator_tag)

620

self.disable_initiator_tag = (gobject.timeout_add

621

(self.timeout_milliseconds(),

622

self.disable))

1044

GLib.source_remove(self.disable_initiator_tag)

1045

self.disable_initiator_tag = GLib.timeout_add(

1046

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

623

1047

# Also start a new checker *right now*.

624

1048

self.start_checker()

625

626

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

1049

1050

def checker_callback(self, source, condition, connection,

1051

command):

627

1052

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

1053

# Read return code from connection (see call_pipe)

1054

returncode = connection.recv()

1055

connection.close()

1056

if self.checker is not None:

1057

self.checker.join()

628

1058

self.checker_callback_tag = None

629

1059

self.checker = None

630

if os.WIFEXITED(condition):

631

self.last_checker_status = os.WEXITSTATUS(condition)

1060

1061

if returncode >= 0:

1062

self.last_checker_status = returncode

1063

self.last_checker_signal = None

632

1064

if self.last_checker_status == 0:

633

1065

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

634

1066

vars(self))

635

1067

self.checked_ok()

636

1068

else:

637

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

638

vars(self))

1069

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

639

1070

else:

640

1071

self.last_checker_status = -1

1072

self.last_checker_signal = -returncode

641

1073

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

642

1074

vars(self))

643

1075

return False

1076

644

1077

def checked_ok(self):

645

1078

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

646

1079

self.last_checked_ok = datetime.datetime.utcnow()

647

1080

self.last_checker_status = 0

1081

self.last_checker_signal = None

648

1082

self.bump_timeout()

649

1083

650

1084

def bump_timeout(self, timeout=None):

651

1085

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

652

1086

if timeout is None:

653

1087

timeout = self.timeout

654

1088

if self.disable_initiator_tag is not None:

655

gobject.source_remove(self.disable_initiator_tag)

1089

GLib.source_remove(self.disable_initiator_tag)

656

1090

self.disable_initiator_tag = None

657

1091

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

658

self.disable_initiator_tag = (gobject.timeout_add

659

(timedelta_to_milliseconds

660

(timeout), self.disable))

1092

self.disable_initiator_tag = GLib.timeout_add(

1093

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

661

1094

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

662

1095

663

1096

def need_approval(self):

664

1097

self.last_approval_request = datetime.datetime.utcnow()

665

1098

666

1099

def start_checker(self):

667

1100

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

668

1101

669

1102

If a checker already exists, leave it running and do

670

1103

nothing."""

671

1104

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

676

1109

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

677

1110

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

678

1111

# should be.

679

680

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

681

try:

682

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

683

except (AttributeError, OSError) as error:

684

if (isinstance(error, OSError)

685

and error.errno != errno.ECHILD):

686

raise error

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

1112

1113

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

1114

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

1115

self.checker.join()

1116

self.checker = None

693

1117

# Start a new checker if needed

694

1118

if self.checker is None:

695

1119

# Escape attributes for the shell

696

escaped_attrs = dict(

697

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

698

for attr in

699

self.runtime_expansions)

1120

escaped_attrs = {

1121

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

1122

for attr in self.runtime_expansions}

700

1123

try:

701

1124

command = self.checker_command % escaped_attrs

702

1125

except TypeError as error:

703

1126

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

704

self.checker_command, exc_info=error)

705

return True # Try again later

1127

self.checker_command,

1128

exc_info=error)

1129

return True # Try again later

706

1130

self.current_checker_command = command

707

try:

708

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

709

command, self.name)

710

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

711

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

712

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

713

# always replaced by /dev/null.)

714

self.checker = subprocess.Popen(command,

715

close_fds=True,

716

shell=True, cwd="/")

717

except OSError as error:

718

logger.error("Failed to start subprocess",

719

exc_info=error)

720

self.checker_callback_tag = (gobject.child_watch_add

721

(self.checker.pid,

722

self.checker_callback,

723

data=command))

724

# The checker may have completed before the gobject

725

# watch was added. Check for this.

726

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

727

if pid:

728

gobject.source_remove(self.checker_callback_tag)

729

self.checker_callback(pid, status, command)

730

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

1131

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

1132

self.name)

1133

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

1134

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

1135

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

1136

# always replaced by /dev/null.)

1137

# The exception is when not debugging but nevertheless

1138

# running in the foreground; use the previously

1139

# created wnull.

1140

popen_args = {"close_fds": True,

1141

"shell": True,

1142

"cwd": "/"}

1143

if (not self.server_settings["debug"]

1144

and self.server_settings["foreground"]):

1145

popen_args.update({"stdout": wnull,

1146

"stderr": wnull})

1147

pipe = multiprocessing.Pipe(duplex=False)

1148

self.checker = multiprocessing.Process(

1149

target=call_pipe,

1150

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

1151

kwargs=popen_args)

1152

self.checker.start()

1153

self.checker_callback_tag = GLib.io_add_watch(

1154

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

1155

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1156

self.checker_callback, pipe[0], command)

1157

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

731

1158

return True

732

1159

733

1160

def stop_checker(self):

734

1161

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

735

1162

if self.checker_callback_tag:

736

gobject.source_remove(self.checker_callback_tag)

1163

GLib.source_remove(self.checker_callback_tag)

737

1164

self.checker_callback_tag = None

738

1165

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

739

1166

return

740

1167

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

741

try:

742

self.checker.terminate()

743

#time.sleep(0.5)

744

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

745

# self.checker.kill()

746

except OSError as error:

747

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

748

raise

1168

self.checker.terminate()

749

1169

self.checker = None

750

1170

751

1171

752

def dbus_service_property(dbus_interface, signature="v",

753

access="readwrite", byte_arrays=False):

1172

def dbus_service_property(dbus_interface,

1173

signature="v",

1174

access="readwrite",

1175

byte_arrays=False):

754

1176

"""Decorators for marking methods of a DBusObjectWithProperties to

755

1177

become properties on the D-Bus.

756

1178

757

1179

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

758

1180

and with one argument by "Set".

759

1181

760

1182

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

761

1183

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

762

1184

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

765

1187

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

766

1188

if byte_arrays and signature != "ay":

767

1189

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

768

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

1190

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

1191

769

1192

def decorator(func):

770

1193

func._dbus_is_property = True

771

1194

func._dbus_interface = dbus_interface

774

1197

func._dbus_name = func.__name__

775

1198

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

776

1199

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

777

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1200

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

778

1201

return func

1202

779

1203

return decorator

780

1204

781

1205

782

1206

def dbus_interface_annotations(dbus_interface):

783

1207

"""Decorator for marking functions returning interface annotations

784

1208

785

1209

Usage:

786

1210

787

1211

@dbus_interface_annotations("org.example.Interface")

788

1212

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

789

1213

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

790

1214

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

791

1215

"false"}

792

1216

"""

1217

793

1218

def decorator(func):

794

1219

func._dbus_is_interface = True

795

1220

func._dbus_interface = dbus_interface

796

1221

func._dbus_name = dbus_interface

797

1222

return func

1223

798

1224

return decorator

799

1225

800

1226

801

1227

def dbus_annotations(annotations):

802

1228

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

803

1229

Usage:

804

1230

1231

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

1232

"org.freedesktop.DBus.Property."

1233

"EmitsChangedSignal": "false"})

805

1234

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

806

1235

access="r")

807

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

808

"org.freedesktop.DBus.Property."

809

"EmitsChangedSignal": "false"})

810

1236

def Property_dbus_property(self):

811

1237

return dbus.Boolean(False)

1238

1239

See also the DBusObjectWithAnnotations class.

812

1240

"""

1241

813

1242

def decorator(func):

814

1243

func._dbus_annotations = annotations

815

1244

return func

1245

816

1246

return decorator

817

1247

818

1248

819

1249

class DBusPropertyException(dbus.exceptions.DBusException):

820

1250

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

821

1251

"""

822

def __unicode__(self):

823

return unicode(str(self))

1252

pass

824

1253

825

1254

826

1255

class DBusPropertyAccessException(DBusPropertyException):

835

1264

pass

836

1265

837

1266

838

class DBusObjectWithProperties(dbus.service.Object):

839

"""A D-Bus object with properties.

840

841

Classes inheriting from this can use the dbus_service_property

842

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

843

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

1267

class DBusObjectWithAnnotations(dbus.service.Object):

1268

"""A D-Bus object with annotations.

1269

1270

Classes inheriting from this can use the dbus_annotations

1271

decorator to add annotations to methods or signals.

844

1272

"""

845

1273

846

1274

@staticmethod

847

1275

def _is_dbus_thing(thing):

848

1276

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

849

1277

850

1278

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

851

1279

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

852

1280

"""

853

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

1281

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

854

1282

False)

855

1283

856

1284

def _get_all_dbus_things(self, thing):

857

1285

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

858

1286

"""

859

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

860

name),

1287

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

861

1288

athing.__get__(self))

862

1289

for cls in self.__class__.__mro__

863

1290

for name, athing in

864

inspect.getmembers(cls,

865

self._is_dbus_thing(thing)))

866

1291

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

1292

1293

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1294

out_signature="s",

1295

path_keyword='object_path',

1296

connection_keyword='connection')

1297

def Introspect(self, object_path, connection):

1298

"""Overloading of standard D-Bus method.

1299

1300

Inserts annotation tags on methods and signals.

1301

"""

1302

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

1303

connection)

1304

try:

1305

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

1306

1307

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

1308

# Add annotation tags

1309

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

1310

for tag in if_tag.getElementsByTagName(typ):

1311

annots = dict()

1312

for name, prop in (self.

1313

_get_all_dbus_things(typ)):

1314

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

1315

and prop._dbus_interface

1316

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

1317

annots.update(getattr(

1318

prop, "_dbus_annotations", {}))

1319

for name, value in annots.items():

1320

ann_tag = document.createElement(

1321

"annotation")

1322

ann_tag.setAttribute("name", name)

1323

ann_tag.setAttribute("value", value)

1324

tag.appendChild(ann_tag)

1325

# Add interface annotation tags

1326

for annotation, value in dict(

1327

itertools.chain.from_iterable(

1328

annotations().items()

1329

for name, annotations

1330

in self._get_all_dbus_things("interface")

1331

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

1332

)).items():

1333

ann_tag = document.createElement("annotation")

1334

ann_tag.setAttribute("name", annotation)

1335

ann_tag.setAttribute("value", value)

1336

if_tag.appendChild(ann_tag)

1337

# Fix argument name for the Introspect method itself

1338

if (if_tag.getAttribute("name")

1339

== dbus.INTROSPECTABLE_IFACE):

1340

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

1341

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

1342

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

1343

if (arg.getAttribute("direction")

1344

== "out"):

1345

arg.setAttribute("name",

1346

"xml_data")

1347

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

1348

document.unlink()

1349

except (AttributeError, xml.dom.DOMException,

1350

xml.parsers.expat.ExpatError) as error:

1351

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

1352

exc_info=error)

1353

return xmlstring

1354

1355

1356

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1357

"""A D-Bus object with properties.

1358

1359

Classes inheriting from this can use the dbus_service_property

1360

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

1361

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

1362

"""

1363

867

1364

def _get_dbus_property(self, interface_name, property_name):

868

1365

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

869

1366

property with the specified name and interface.

870

1367

"""

871

for cls in self.__class__.__mro__:

872

for name, value in (inspect.getmembers

873

(cls,

874

self._is_dbus_thing("property"))):

1368

for cls in self.__class__.__mro__:

1369

for name, value in inspect.getmembers(

1370

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

875

1371

if (value._dbus_name == property_name

876

1372

and value._dbus_interface == interface_name):

877

1373

return value.__get__(self)

878

1374

879

1375

# No such property

880

raise DBusPropertyNotFound(self.dbus_object_path + ":"

881

+ interface_name + "."

882

+ property_name)

883

884

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

1376

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

1377

self.dbus_object_path, interface_name, property_name))

1378

1379

@classmethod

1380

def _get_all_interface_names(cls):

1381

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

1382

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

1383

"_dbus_interface", None)

1384

for x in (inspect.getmro(cls))

1385

for attr in dir(x))

1386

if name is not None)

1387

1388

@dbus.service.method(dbus.PROPERTIES_IFACE,

1389

in_signature="ss",

885

1390

out_signature="v")

886

1391

def Get(self, interface_name, property_name):

887

1392

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

893

1398

if not hasattr(value, "variant_level"):

894

1399

return value

895

1400

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

896

1401

897

1402

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

898

1403

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

899

1404

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

905

1410

# The byte_arrays option is not supported yet on

906

1411

# signatures other than "ay".

907

1412

if prop._dbus_signature != "ay":

908

raise ValueError

909

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

910

for byte in value))

1413

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

1414

"'ay' signature {!r}"

1415

.format(prop._dbus_signature))

1416

value = dbus.ByteArray(bytes(value))

911

1417

prop(value)

912

913

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

1418

1419

@dbus.service.method(dbus.PROPERTIES_IFACE,

1420

in_signature="s",

914

1421

out_signature="a{sv}")

915

1422

def GetAll(self, interface_name):

916

1423

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

917

1424

standard.

918

1425

919

1426

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

920

1427

"""

921

1428

properties = {}

931

1438

if not hasattr(value, "variant_level"):

932

1439

properties[name] = value

933

1440

continue

934

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

935

value.variant_level+1)

1441

properties[name] = type(value)(

1442

value, variant_level=value.variant_level + 1)

936

1443

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

937

1444

1445

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

1446

def PropertiesChanged(self, interface_name, changed_properties,

1447

invalidated_properties):

1448

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

1449

standard.

1450

"""

1451

pass

1452

938

1453

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

939

1454

out_signature="s",

940

1455

path_keyword='object_path',

941

1456

connection_keyword='connection')

942

1457

def Introspect(self, object_path, connection):

943

1458

"""Overloading of standard D-Bus method.

944

1459

945

1460

Inserts property tags and interface annotation tags.

946

1461

"""

947

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

948

connection)

1462

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1463

object_path,

1464

connection)

949

1465

try:

950

1466

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

1467

951

1468

def make_tag(document, name, prop):

952

1469

e = document.createElement("property")

953

1470

e.setAttribute("name", name)

954

1471

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

955

1472

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

956

1473

return e

1474

957

1475

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

958

1476

# Add property tags

959

1477

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

962

1480

if prop._dbus_interface

963

1481

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

964

1482

if_tag.appendChild(tag)

965

# Add annotation tags

966

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

967

for tag in if_tag.getElementsByTagName(typ):

968

annots = dict()

969

for name, prop in (self.

970

_get_all_dbus_things(typ)):

971

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

972

and prop._dbus_interface

973

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

974

annots.update(getattr

975

(prop,

976

"_dbus_annotations",

977

{}))

978

for name, value in annots.iteritems():

979

ann_tag = document.createElement(

980

"annotation")

981

ann_tag.setAttribute("name", name)

982

ann_tag.setAttribute("value", value)

983

tag.appendChild(ann_tag)

984

# Add interface annotation tags

985

for annotation, value in dict(

986

itertools.chain.from_iterable(

987

annotations().iteritems()

988

for name, annotations in

989

self._get_all_dbus_things("interface")

990

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

991

)).iteritems():

992

ann_tag = document.createElement("annotation")

993

ann_tag.setAttribute("name", annotation)

994

ann_tag.setAttribute("value", value)

995

if_tag.appendChild(ann_tag)

1483

# Add annotation tags for properties

1484

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

1485

annots = dict()

1486

for name, prop in self._get_all_dbus_things(

1487

"property"):

1488

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

1489

and prop._dbus_interface

1490

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

1491

annots.update(getattr(

1492

prop, "_dbus_annotations", {}))

1493

for name, value in annots.items():

1494

ann_tag = document.createElement(

1495

"annotation")

1496

ann_tag.setAttribute("name", name)

1497

ann_tag.setAttribute("value", value)

1498

tag.appendChild(ann_tag)

996

1499

# Add the names to the return values for the

997

1500

# "org.freedesktop.DBus.Properties" methods

998

1501

if (if_tag.getAttribute("name")

1017

1520

return xmlstring

1018

1521

1019

1522

1523

try:

1524

dbus.OBJECT_MANAGER_IFACE

1525

except AttributeError:

1526

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

1527

1528

1529

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1530

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

1531

1532

Classes inheriting from this exposes the standard

1533

GetManagedObjects call and the InterfacesAdded and

1534

InterfacesRemoved signals on the standard

1535

"org.freedesktop.DBus.ObjectManager" interface.

1536

1537

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

1538

manually.

1539

"""

1540

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1541

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

1542

def GetManagedObjects(self):

1543

"""This function must be overridden"""

1544

raise NotImplementedError()

1545

1546

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1547

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

1548

def InterfacesAdded(self, object_path, interfaces_and_properties):

1549

pass

1550

1551

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

1552

def InterfacesRemoved(self, object_path, interfaces):

1553

pass

1554

1555

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1556

out_signature="s",

1557

path_keyword='object_path',

1558

connection_keyword='connection')

1559

def Introspect(self, object_path, connection):

1560

"""Overloading of standard D-Bus method.

1561

1562

Override return argument name of GetManagedObjects to be

1563

"objpath_interfaces_and_properties"

1564

"""

1565

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1566

object_path,

1567

connection)

1568

try:

1569

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

1570

1571

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

1572

# Fix argument name for the GetManagedObjects method

1573

if (if_tag.getAttribute("name")

1574

== dbus.OBJECT_MANAGER_IFACE):

1575

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

1576

if (cn.getAttribute("name")

1577

== "GetManagedObjects"):

1578

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

1579

if (arg.getAttribute("direction")

1580

== "out"):

1581

arg.setAttribute(

1582

"name",

1583

"objpath_interfaces"

1584

"_and_properties")

1585

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

1586

document.unlink()

1587

except (AttributeError, xml.dom.DOMException,

1588

xml.parsers.expat.ExpatError) as error:

1589

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

1590

exc_info=error)

1591

return xmlstring

1592

1593

1020

1594

def datetime_to_dbus(dt, variant_level=0):

1021

1595

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

1022

1596

if dt is None:

1023

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

1024

return dbus.String(dt.isoformat(),

1025

variant_level=variant_level)

1597

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

1598

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

1026

1599

1027

1600

1028

1601

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1030

1603

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

1031

1604

interface names according to the "alt_interface_names" mapping.

1032

1605

Usage:

1033

1606

1034

1607

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

1035

1608

"net.example.AlternateInterface"})

1036

1609

class SampleDBusObject(dbus.service.Object):

1037

1610

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

1038

1611

def SampleDBusMethod():

1039

1612

pass

1040

1613

1041

1614

The above "SampleDBusMethod" on "SampleDBusObject" will be

1042

1615

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

1043

1616

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

1044

1617

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

1045

1618

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

1046

1619

1047

1620

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

1048

1621

(from DBusObjectWithProperties) and interfaces (from the

1049

1622

dbus_interface_annotations decorator).

1050

1623

"""

1624

1051

1625

def wrapper(cls):

1052

1626

for orig_interface_name, alt_interface_name in (

1053

alt_interface_names.iteritems()):

1627

alt_interface_names.items()):

1054

1628

attr = {}

1055

1629

interface_names = set()

1056

1630

# Go though all attributes of the class

1058

1632

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

1059

1633

# with the wrong interface name

1060

1634

if (not hasattr(attribute, "_dbus_interface")

1061

or not attribute._dbus_interface

1062

.startswith(orig_interface_name)):

1635

or not attribute._dbus_interface.startswith(

1636

orig_interface_name)):

1063

1637

continue

1064

1638

# Create an alternate D-Bus interface name based on

1065

1639

# the current name

1066

alt_interface = (attribute._dbus_interface

1067

.replace(orig_interface_name,

1068

alt_interface_name))

1640

alt_interface = attribute._dbus_interface.replace(

1641

orig_interface_name, alt_interface_name)

1069

1642

interface_names.add(alt_interface)

1070

1643

# Is this a D-Bus signal?

1071

1644

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

1072

# Extract the original non-method function by

1073

# black magic

1074

nonmethod_func = (dict(

1645

# Extract the original non-method undecorated

1646

# function by black magic

1647

if sys.version_info.major == 2:

1648

nonmethod_func = (dict(

1075

1649

zip(attribute.func_code.co_freevars,

1076

attribute.__closure__))["func"]

1077

.cell_contents)

1650

attribute.__closure__))

1651

["func"].cell_contents)

1652

else:

1653

nonmethod_func = (dict(

1654

zip(attribute.__code__.co_freevars,

1655

attribute.__closure__))

1656

["func"].cell_contents)

1078

1657

# Create a new, but exactly alike, function

1079

1658

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

1080

1659

# with the alternate D-Bus interface name

1081

new_function = (dbus.service.signal

1082

(alt_interface,

1083

attribute._dbus_signature)

1084

(types.FunctionType(

1085

nonmethod_func.func_code,

1086

nonmethod_func.func_globals,

1087

nonmethod_func.func_name,

1088

nonmethod_func.func_defaults,

1089

nonmethod_func.func_closure)))

1660

new_function = copy_function(nonmethod_func)

1661

new_function = (dbus.service.signal(

1662

alt_interface,

1663

attribute._dbus_signature)(new_function))

1090

1664

# Copy annotations, if any

1091

1665

try:

1092

new_function._dbus_annotations = (

1093

dict(attribute._dbus_annotations))

1666

new_function._dbus_annotations = dict(

1667

attribute._dbus_annotations)

1094

1668

except AttributeError:

1095

1669

pass

1670

1096

1671

# Define a creator of a function to call both the

1097

1672

# original and alternate functions, so both the

1098

1673

# original and alternate signals gets sent when

1101

1676

"""This function is a scope container to pass

1102

1677

func1 and func2 to the "call_both" function

1103

1678

outside of its arguments"""

1679

1680

@functools.wraps(func2)

1104

1681

def call_both(*args, **kwargs):

1105

1682

"""This function will emit two D-Bus

1106

1683

signals by calling func1 and func2"""

1107

1684

func1(*args, **kwargs)

1108

1685

func2(*args, **kwargs)

1686

# Make wrapper function look like a D-Bus

1687

# signal

1688

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

1689

if name.startswith("_dbus_"):

1690

setattr(call_both, name, attr)

1691

1109

1692

return call_both

1110

1693

# Create the "call_both" function and add it to

1111

1694

# the class

1116

1699

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

1117

1700

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

1118

1701

# to the class.

1119

attr[attrname] = (dbus.service.method

1120

(alt_interface,

1121

attribute._dbus_in_signature,

1122

attribute._dbus_out_signature)

1123

(types.FunctionType

1124

(attribute.func_code,

1125

attribute.func_globals,

1126

attribute.func_name,

1127

attribute.func_defaults,

1128

attribute.func_closure)))

1702

attr[attrname] = (

1703

dbus.service.method(

1704

alt_interface,

1705

attribute._dbus_in_signature,

1706

attribute._dbus_out_signature)

1707

(copy_function(attribute)))

1129

1708

# Copy annotations, if any

1130

1709

try:

1131

attr[attrname]._dbus_annotations = (

1132

dict(attribute._dbus_annotations))

1710

attr[attrname]._dbus_annotations = dict(

1711

attribute._dbus_annotations)

1133

1712

except AttributeError:

1134

1713

pass

1135

1714

# Is this a D-Bus property?

1138

1717

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

1139

1718

# property with the alternate D-Bus interface

1140

1719

# name. Add it to the class.

1141

attr[attrname] = (dbus_service_property

1142

(alt_interface,

1143

attribute._dbus_signature,

1144

attribute._dbus_access,

1145

attribute

1146

._dbus_get_args_options

1147

["byte_arrays"])

1148

(types.FunctionType

1149

(attribute.func_code,

1150

attribute.func_globals,

1151

attribute.func_name,

1152

attribute.func_defaults,

1153

attribute.func_closure)))

1720

attr[attrname] = (dbus_service_property(

1721

alt_interface, attribute._dbus_signature,

1722

attribute._dbus_access,

1723

attribute._dbus_get_args_options

1724

["byte_arrays"])

1725

(copy_function(attribute)))

1154

1726

# Copy annotations, if any

1155

1727

try:

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1728

attr[attrname]._dbus_annotations = dict(

1729

attribute._dbus_annotations)

1158

1730

except AttributeError:

1159

1731

pass

1160

1732

# Is this a D-Bus interface?

1163

1735

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

1164

1736

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

1165

1737

# to the class.

1166

attr[attrname] = (dbus_interface_annotations

1167

(alt_interface)

1168

(types.FunctionType

1169

(attribute.func_code,

1170

attribute.func_globals,

1171

attribute.func_name,

1172

attribute.func_defaults,

1173

attribute.func_closure)))

1738

attr[attrname] = (

1739

dbus_interface_annotations(alt_interface)

1740

(copy_function(attribute)))

1174

1741

if deprecate:

1175

1742

# Deprecate all alternate interfaces

1176

iname="_AlternateDBusNames_interface_annotation{0}"

1743

iname = "_AlternateDBusNames_interface_annotation{}"

1177

1744

for interface_name in interface_names:

1745

1178

1746

@dbus_interface_annotations(interface_name)

1179

1747

def func(self):

1180

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

1181

"true" }

1748

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

1749

"true"}

1182

1750

# Find an unused name

1183

1751

for aname in (iname.format(i)

1184

1752

for i in itertools.count()):

1188

1756

if interface_names:

1189

1757

# Replace the class with a new subclass of it with

1190

1758

# methods, signals, etc. as created above.

1191

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

1192

(cls,), attr)

1759

if sys.version_info.major == 2:

1760

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

1761

(cls, ), attr)

1762

else:

1763

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

1764

(cls, ), attr)

1193

1765

return cls

1766

1194

1767

return wrapper

1195

1768

1196

1769

1197

1770

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

1198

"se.bsnet.fukt.Mandos"})

1771

"se.bsnet.fukt.Mandos"})

1199

1772

class ClientDBus(Client, DBusObjectWithProperties):

1200

1773

"""A Client class using D-Bus

1201

1774

1202

1775

Attributes:

1203

1776

dbus_object_path: dbus.ObjectPath

1204

1777

bus: dbus.SystemBus()

1205

1778

"""

1206

1779

1207

1780

runtime_expansions = (Client.runtime_expansions

1208

+ ("dbus_object_path",))

1209

1781

+ ("dbus_object_path", ))

1782

1783

_interface = "se.recompile.Mandos.Client"

1784

1210

1785

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

1211

1212

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

1786

1787

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

1213

1788

self.bus = bus

1214

1789

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

1215

1790

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

1216

1791

# the D-Bus

1217

client_object_name = unicode(self.name).translate(

1792

client_object_name = str(self.name).translate(

1218

1793

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

1219

1794

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

1220

self.dbus_object_path = (dbus.ObjectPath

1221

("/clients/" + client_object_name))

1795

self.dbus_object_path = dbus.ObjectPath(

1796

"/clients/" + client_object_name)

1222

1797

DBusObjectWithProperties.__init__(self, self.bus,

1223

1798

self.dbus_object_path)

1224

1225

def notifychangeproperty(transform_func,

1226

dbus_name, type_func=lambda x: x,

1227

variant_level=1):

1799

1800

def notifychangeproperty(transform_func, dbus_name,

1801

type_func=lambda x: x,

1802

variant_level=1,

1803

invalidate_only=False,

1804

_interface=_interface):

1228

1805

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

1229

1806

its changes to DBus.

1230

1807

1231

1808

transform_fun: Function that takes a value and a variant_level

1232

1809

and transforms it to a D-Bus type.

1233

1810

dbus_name: D-Bus name of the variable

1235

1812

to the D-Bus. Default: no transform

1236

1813

variant_level: D-Bus variant level. Default: 1

1237

1814

"""

1238

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

1815

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

1816

1239

1817

def setter(self, value):

1240

1818

if hasattr(self, "dbus_object_path"):

1241

1819

if (not hasattr(self, attrname) or

1242

1820

type_func(getattr(self, attrname, None))

1243

1821

!= type_func(value)):

1244

dbus_value = transform_func(type_func(value),

1245

variant_level

1246

=variant_level)

1247

self.PropertyChanged(dbus.String(dbus_name),

1248

dbus_value)

1822

if invalidate_only:

1823

self.PropertiesChanged(

1824

_interface, dbus.Dictionary(),

1825

dbus.Array((dbus_name, )))

1826

else:

1827

dbus_value = transform_func(

1828

type_func(value),

1829

variant_level=variant_level)

1830

self.PropertyChanged(dbus.String(dbus_name),

1831

dbus_value)

1832

self.PropertiesChanged(

1833

_interface,

1834

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

1835

dbus_value}),

1836

dbus.Array())

1249

1837

setattr(self, attrname, value)

1250

1838

1251

1839

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

1252

1840

1253

1841

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1254

1842

approvals_pending = notifychangeproperty(dbus.Boolean,

1255

1843

"ApprovalPending",

1256

type_func = bool)

1844

type_func=bool)

1257

1845

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

1258

1846

last_enabled = notifychangeproperty(datetime_to_dbus,

1259

1847

"LastEnabled")

1260

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

1261

type_func = lambda checker:

1262

checker is not None)

1848

checker = notifychangeproperty(

1849

dbus.Boolean, "CheckerRunning",

1850

type_func=lambda checker: checker is not None)

1263

1851

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1264

1852

"LastCheckedOK")

1265

1853

last_checker_status = notifychangeproperty(dbus.Int16,

1268

1856

datetime_to_dbus, "LastApprovalRequest")

1269

1857

approved_by_default = notifychangeproperty(dbus.Boolean,

1270

1858

"ApprovedByDefault")

1271

approval_delay = notifychangeproperty(dbus.UInt64,

1272

"ApprovalDelay",

1273

type_func =

1274

timedelta_to_milliseconds)

1859

approval_delay = notifychangeproperty(

1860

dbus.UInt64, "ApprovalDelay",

1861

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

1275

1862

approval_duration = notifychangeproperty(

1276

1863

dbus.UInt64, "ApprovalDuration",

1277

type_func = timedelta_to_milliseconds)

1864

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

1278

1865

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

1279

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

1280

type_func =

1281

timedelta_to_milliseconds)

1866

timeout = notifychangeproperty(

1867

dbus.UInt64, "Timeout",

1868

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

1282

1869

extended_timeout = notifychangeproperty(

1283

1870

dbus.UInt64, "ExtendedTimeout",

1284

type_func = timedelta_to_milliseconds)

1285

interval = notifychangeproperty(dbus.UInt64,

1286

"Interval",

1287

type_func =

1288

timedelta_to_milliseconds)

1871

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

1872

interval = notifychangeproperty(

1873

dbus.UInt64, "Interval",

1874

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

1289

1875

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

1290

1876

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

1877

invalidate_only=True)

1878

1291

1879

del notifychangeproperty

1292

1880

1293

1881

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

1294

1882

try:

1295

1883

self.remove_from_connection()

1298

1886

if hasattr(DBusObjectWithProperties, "__del__"):

1299

1887

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

1300

1888

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

1301

1302

def checker_callback(self, pid, condition, command,

1303

*args, **kwargs):

1304

self.checker_callback_tag = None

1305

self.checker = None

1306

if os.WIFEXITED(condition):

1307

exitstatus = os.WEXITSTATUS(condition)

1889

1890

def checker_callback(self, source, condition,

1891

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

1892

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

1893

connection, command, *args,

1894

**kwargs)

1895

exitstatus = self.last_checker_status

1896

if exitstatus >= 0:

1308

1897

# Emit D-Bus signal

1309

1898

self.CheckerCompleted(dbus.Int16(exitstatus),

1310

dbus.Int64(condition),

1899

# This is specific to GNU libC

1900

dbus.Int64(exitstatus << 8),

1311

1901

dbus.String(command))

1312

1902

else:

1313

1903

# Emit D-Bus signal

1314

1904

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

1315

dbus.Int64(condition),

1905

dbus.Int64(

1906

# This is specific to GNU libC

1907

(exitstatus << 8)

1908

| self.last_checker_signal),

1316

1909

dbus.String(command))

1317

1318

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

1319

*args, **kwargs)

1320

1910

return ret

1911

1321

1912

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

1322

old_checker = self.checker

1323

if self.checker is not None:

1324

old_checker_pid = self.checker.pid

1325

else:

1326

old_checker_pid = None

1913

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

1327

1914

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

1328

1915

# Only if new checker process was started

1329

1916

if (self.checker is not None

1331

1918

# Emit D-Bus signal

1332

1919

self.CheckerStarted(self.current_checker_command)

1333

1920

return r

1334

1921

1335

1922

def _reset_approved(self):

1336

1923

self.approved = None

1337

1924

return False

1338

1925

1339

1926

def approve(self, value=True):

1340

1927

self.approved = value

1341

gobject.timeout_add(timedelta_to_milliseconds

1342

(self.approval_duration),

1343

self._reset_approved)

1928

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

1929

* 1000), self._reset_approved)

1344

1930

self.send_changedstate()

1345

1346

## D-Bus methods, signals & properties

1347

_interface = "se.recompile.Mandos.Client"

1348

1349

## Interfaces

1350

1351

@dbus_interface_annotations(_interface)

1352

def _foo(self):

1353

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

1354

"false"}

1355

1356

## Signals

1357

1931

1932

# D-Bus methods, signals & properties

1933

1934

# Interfaces

1935

1936

# Signals

1937

1358

1938

# CheckerCompleted - signal

1359

1939

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

1360

1940

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

1361

1941

"D-Bus signal"

1362

1942

pass

1363

1943

1364

1944

# CheckerStarted - signal

1365

1945

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

1366

1946

def CheckerStarted(self, command):

1367

1947

"D-Bus signal"

1368

1948

pass

1369

1949

1370

1950

# PropertyChanged - signal

1951

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

1371

1952

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

1372

1953

def PropertyChanged(self, property, value):

1373

1954

"D-Bus signal"

1374

1955

pass

1375

1956

1376

1957

# GotSecret - signal

1377

1958

@dbus.service.signal(_interface)

1378

1959

def GotSecret(self):

1381

1962

server to mandos-client

1382

1963

"""

1383

1964

pass

1384

1965

1385

1966

# Rejected - signal

1386

1967

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

1387

1968

def Rejected(self, reason):

1388

1969

"D-Bus signal"

1389

1970

pass

1390

1971

1391

1972

# NeedApproval - signal

1392

1973

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

1393

1974

def NeedApproval(self, timeout, default):

1394

1975

"D-Bus signal"

1395

1976

return self.need_approval()

1396

1397

## Methods

1398

1977

1978

# Methods

1979

1399

1980

# Approve - method

1400

1981

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

1401

1982

def Approve(self, value):

1402

1983

self.approve(value)

1403

1984

1404

1985

# CheckedOK - method

1405

1986

@dbus.service.method(_interface)

1406

1987

def CheckedOK(self):

1407

1988

self.checked_ok()

1408

1989

1409

1990

# Enable - method

1991

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

1410

1992

@dbus.service.method(_interface)

1411

1993

def Enable(self):

1412

1994

"D-Bus method"

1413

1995

self.enable()

1414

1996

1415

1997

# StartChecker - method

1998

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

1416

1999

@dbus.service.method(_interface)

1417

2000

def StartChecker(self):

1418

2001

"D-Bus method"

1419

2002

self.start_checker()

1420

2003

1421

2004

# Disable - method

2005

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

1422

2006

@dbus.service.method(_interface)

1423

2007

def Disable(self):

1424

2008

"D-Bus method"

1425

2009

self.disable()

1426

2010

1427

2011

# StopChecker - method

2012

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

1428

2013

@dbus.service.method(_interface)

1429

2014

def StopChecker(self):

1430

2015

self.stop_checker()

1431

1432

## Properties

1433

2016

2017

# Properties

2018

1434

2019

# ApprovalPending - property

1435

2020

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

1436

2021

def ApprovalPending_dbus_property(self):

1437

2022

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

1438

2023

1439

2024

# ApprovedByDefault - property

1440

@dbus_service_property(_interface, signature="b",

2025

@dbus_service_property(_interface,

2026

signature="b",

1441

2027

access="readwrite")

1442

2028

def ApprovedByDefault_dbus_property(self, value=None):

1443

2029

if value is None: # get

1444

2030

return dbus.Boolean(self.approved_by_default)

1445

2031

self.approved_by_default = bool(value)

1446

2032

1447

2033

# ApprovalDelay - property

1448

@dbus_service_property(_interface, signature="t",

2034

@dbus_service_property(_interface,

2035

signature="t",

1449

2036

access="readwrite")

1450

2037

def ApprovalDelay_dbus_property(self, value=None):

1451

2038

if value is None: # get

1452

return dbus.UInt64(self.approval_delay_milliseconds())

2039

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

2040

* 1000)

1453

2041

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

1454

2042

1455

2043

# ApprovalDuration - property

1456

@dbus_service_property(_interface, signature="t",

2044

@dbus_service_property(_interface,

2045

signature="t",

1457

2046

access="readwrite")

1458

2047

def ApprovalDuration_dbus_property(self, value=None):

1459

2048

if value is None: # get

1460

return dbus.UInt64(timedelta_to_milliseconds(

1461

self.approval_duration))

2049

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

2050

* 1000)

1462

2051

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

1463

2052

1464

2053

# Name - property

2054

@dbus_annotations(

2055

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

1465

2056

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

1466

2057

def Name_dbus_property(self):

1467

2058

return dbus.String(self.name)

1468

2059

2060

# KeyID - property

2061

@dbus_annotations(

2062

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

2063

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

2064

def KeyID_dbus_property(self):

2065

return dbus.String(self.key_id)

2066

1469

2067

# Fingerprint - property

2068

@dbus_annotations(

2069

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

1470

2070

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

1471

2071

def Fingerprint_dbus_property(self):

1472

2072

return dbus.String(self.fingerprint)

1473

2073

1474

2074

# Host - property

1475

@dbus_service_property(_interface, signature="s",

2075

@dbus_service_property(_interface,

2076

signature="s",

1476

2077

access="readwrite")

1477

2078

def Host_dbus_property(self, value=None):

1478

2079

if value is None: # get

1479

2080

return dbus.String(self.host)

1480

self.host = unicode(value)

1481

2081

self.host = str(value)

2082

1482

2083

# Created - property

2084

@dbus_annotations(

2085

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

1483

2086

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

1484

2087

def Created_dbus_property(self):

1485

2088

return datetime_to_dbus(self.created)

1486

2089

1487

2090

# LastEnabled - property

1488

2091

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

1489

2092

def LastEnabled_dbus_property(self):

1490

2093

return datetime_to_dbus(self.last_enabled)

1491

2094

1492

2095

# Enabled - property

1493

@dbus_service_property(_interface, signature="b",

2096

@dbus_service_property(_interface,

2097

signature="b",

1494

2098

access="readwrite")

1495

2099

def Enabled_dbus_property(self, value=None):

1496

2100

if value is None: # get

1499

2103

self.enable()

1500

2104

else:

1501

2105

self.disable()

1502

2106

1503

2107

# LastCheckedOK - property

1504

@dbus_service_property(_interface, signature="s",

2108

@dbus_service_property(_interface,

2109

signature="s",

1505

2110

access="readwrite")

1506

2111

def LastCheckedOK_dbus_property(self, value=None):

1507

2112

if value is not None:

1508

2113

self.checked_ok()

1509

2114

return

1510

2115

return datetime_to_dbus(self.last_checked_ok)

1511

2116

1512

2117

# LastCheckerStatus - property

1513

@dbus_service_property(_interface, signature="n",

1514

access="read")

2118

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

1515

2119

def LastCheckerStatus_dbus_property(self):

1516

2120

return dbus.Int16(self.last_checker_status)

1517

2121

1518

2122

# Expires - property

1519

2123

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

1520

2124

def Expires_dbus_property(self):

1521

2125

return datetime_to_dbus(self.expires)

1522

2126

1523

2127

# LastApprovalRequest - property

1524

2128

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

1525

2129

def LastApprovalRequest_dbus_property(self):

1526

2130

return datetime_to_dbus(self.last_approval_request)

1527

2131

1528

2132

# Timeout - property

1529

@dbus_service_property(_interface, signature="t",

2133

@dbus_service_property(_interface,

2134

signature="t",

1530

2135

access="readwrite")

1531

2136

def Timeout_dbus_property(self, value=None):

1532

2137

if value is None: # get

1533

return dbus.UInt64(self.timeout_milliseconds())

2138

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

1534

2139

old_timeout = self.timeout

1535

2140

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

1536

2141

# Reschedule disabling

1544

2149

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

1545

2150

is None):

1546

2151

return

1547

gobject.source_remove(self.disable_initiator_tag)

1548

self.disable_initiator_tag = (

1549

gobject.timeout_add(

1550

timedelta_to_milliseconds(self.expires - now),

1551

self.disable))

1552

2152

GLib.source_remove(self.disable_initiator_tag)

2153

self.disable_initiator_tag = GLib.timeout_add(

2154

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

2155

self.disable)

2156

1553

2157

# ExtendedTimeout - property

1554

@dbus_service_property(_interface, signature="t",

2158

@dbus_service_property(_interface,

2159

signature="t",

1555

2160

access="readwrite")

1556

2161

def ExtendedTimeout_dbus_property(self, value=None):

1557

2162

if value is None: # get

1558

return dbus.UInt64(self.extended_timeout_milliseconds())

2163

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

2164

* 1000)

1559

2165

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

1560

2166

1561

2167

# Interval - property

1562

@dbus_service_property(_interface, signature="t",

2168

@dbus_service_property(_interface,

2169

signature="t",

1563

2170

access="readwrite")

1564

2171

def Interval_dbus_property(self, value=None):

1565

2172

if value is None: # get

1566

return dbus.UInt64(self.interval_milliseconds())

2173

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

1567

2174

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

1568

2175

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

1569

2176

return

1570

2177

if self.enabled:

1571

2178

# Reschedule checker run

1572

gobject.source_remove(self.checker_initiator_tag)

1573

self.checker_initiator_tag = (gobject.timeout_add

1574

(value, self.start_checker))

1575

self.start_checker() # Start one now, too

1576

2179

GLib.source_remove(self.checker_initiator_tag)

2180

self.checker_initiator_tag = GLib.timeout_add(

2181

value, self.start_checker)

2182

self.start_checker() # Start one now, too

2183

1577

2184

# Checker - property

1578

@dbus_service_property(_interface, signature="s",

2185

@dbus_service_property(_interface,

2186

signature="s",

1579

2187

access="readwrite")

1580

2188

def Checker_dbus_property(self, value=None):

1581

2189

if value is None: # get

1582

2190

return dbus.String(self.checker_command)

1583

self.checker_command = unicode(value)

1584

2191

self.checker_command = str(value)

2192

1585

2193

# CheckerRunning - property

1586

@dbus_service_property(_interface, signature="b",

2194

@dbus_service_property(_interface,

2195

signature="b",

1587

2196

access="readwrite")

1588

2197

def CheckerRunning_dbus_property(self, value=None):

1589

2198

if value is None: # get

1592

2201

self.start_checker()

1593

2202

else:

1594

2203

self.stop_checker()

1595

2204

1596

2205

# ObjectPath - property

2206

@dbus_annotations(

2207

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

2208

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

1597

2209

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

1598

2210

def ObjectPath_dbus_property(self):

1599

return self.dbus_object_path # is already a dbus.ObjectPath

1600

2211

return self.dbus_object_path # is already a dbus.ObjectPath

2212

1601

2213

# Secret = property

1602

@dbus_service_property(_interface, signature="ay",

1603

access="write", byte_arrays=True)

2214

@dbus_annotations(

2215

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

2216

"invalidates"})

2217

@dbus_service_property(_interface,

2218

signature="ay",

2219

access="write",

2220

byte_arrays=True)

1604

2221

def Secret_dbus_property(self, value):

1605

self.secret = str(value)

1606

2222

self.secret = bytes(value)

2223

1607

2224

del _interface

1608

2225

1609

2226

1610

class ProxyClient(object):

1611

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

2227

class ProxyClient:

2228

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

1612

2229

self._pipe = child_pipe

1613

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

2230

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

1614

2231

if not self._pipe.recv():

1615

raise KeyError()

1616

2232

raise KeyError(key_id or fpr)

2233

1617

2234

def __getattribute__(self, name):

1618

2235

if name == '_pipe':

1619

2236

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

1622

2239

if data[0] == 'data':

1623

2240

return data[1]

1624

2241

if data[0] == 'function':

2242

1625

2243

def func(*args, **kwargs):

1626

2244

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

1627

2245

return self._pipe.recv()[1]

2246

1628

2247

return func

1629

2248

1630

2249

def __setattr__(self, name, value):

1631

2250

if name == '_pipe':

1632

2251

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

1635

2254

1636

2255

class ClientHandler(socketserver.BaseRequestHandler, object):

1637

2256

"""A class to handle client connections.

1638

2257

1639

2258

Instantiated once for each connection to handle it.

1640

2259

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

1641

2260

1642

2261

def handle(self):

1643

2262

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

1644

2263

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

1645

unicode(self.client_address))

2264

str(self.client_address))

1646

2265

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

1647

2266

self.server.child_pipe.fileno())

1648

1649

session = (gnutls.connection

1650

.ClientSession(self.request,

1651

gnutls.connection

1652

.X509Credentials()))

1653

1654

# Note: gnutls.connection.X509Credentials is really a

1655

# generic GnuTLS certificate credentials object so long as

1656

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

1657

# here despite using OpenPGP certificates.

1658

1659

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

1660

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

1661

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

1662

# "+DHE-DSS"))

2267

2268

session = gnutls.ClientSession(self.request)

2269

2270

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

2271

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

2272

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

2273

# "+DHE-DSS"))

1663

2274

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

1664

2275

priority = self.server.gnutls_priority

1665

2276

if priority is None:

1666

2277

priority = "NORMAL"

1667

(gnutls.library.functions

1668

.gnutls_priority_set_direct(session._c_object,

1669

priority, None))

1670

2278

gnutls.priority_set_direct(session._c_object,

2279

priority.encode("utf-8"),

2280

None)

2281

1671

2282

# Start communication using the Mandos protocol

1672

2283

# Get protocol number

1673

2284

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

1674

2285

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

1675

2286

try:

1676

2287

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

1677

raise RuntimeError

2288

raise RuntimeError(line)

1678

2289

except (ValueError, IndexError, RuntimeError) as error:

1679

2290

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

1680

2291

return

1681

2292

1682

2293

# Start GnuTLS connection

1683

2294

try:

1684

2295

session.handshake()

1685

except gnutls.errors.GNUTLSError as error:

2296

except gnutls.Error as error:

1686

2297

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

1687

2298

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

1688

2299

# established. Just abandon the request.

1689

2300

return

1690

2301

logger.debug("Handshake succeeded")

1691

2302

1692

2303

approval_required = False

1693

2304

try:

1694

try:

1695

fpr = self.fingerprint(self.peer_certificate

1696

(session))

1697

except (TypeError,

1698

gnutls.errors.GNUTLSError) as error:

1699

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

1700

return

1701

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

1702

1703

try:

1704

client = ProxyClient(child_pipe, fpr,

2305

if gnutls.has_rawpk:

2306

fpr = b""

2307

try:

2308

key_id = self.key_id(

2309

self.peer_certificate(session))

2310

except (TypeError, gnutls.Error) as error:

2311

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

2312

return

2313

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

2314

2315

else:

2316

key_id = b""

2317

try:

2318

fpr = self.fingerprint(

2319

self.peer_certificate(session))

2320

except (TypeError, gnutls.Error) as error:

2321

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

2322

return

2323

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

2324

2325

try:

2326

client = ProxyClient(child_pipe, key_id, fpr,

1705

2327

self.client_address)

1706

2328

except KeyError:

1707

2329

return

1708

2330

1709

2331

if client.approval_delay:

1710

2332

delay = client.approval_delay

1711

2333

client.approvals_pending += 1

1712

2334

approval_required = True

1713

2335

1714

2336

while True:

1715

2337

if not client.enabled:

1716

2338

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

1717

client.name)

2339

client.name)

1718

2340

if self.server.use_dbus:

1719

2341

# Emit D-Bus signal

1720

2342

client.Rejected("Disabled")

1721

2343

return

1722

2344

1723

2345

if client.approved or not client.approval_delay:

1724

#We are approved or approval is disabled

2346

# We are approved or approval is disabled

1725

2347

break

1726

2348

elif client.approved is None:

1727

2349

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

1729

2351

if self.server.use_dbus:

1730

2352

# Emit D-Bus signal

1731

2353

client.NeedApproval(

1732

client.approval_delay_milliseconds(),

1733

client.approved_by_default)

2354

client.approval_delay.total_seconds()

2355

* 1000, client.approved_by_default)

1734

2356

else:

1735

2357

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

1736

2358

client.name)

1738

2360

# Emit D-Bus signal

1739

2361

client.Rejected("Denied")

1740

2362

return

1741

1742

#wait until timeout or approved

2363

2364

# wait until timeout or approved

1743

2365

time = datetime.datetime.now()

1744

2366

client.changedstate.acquire()

1745

client.changedstate.wait(

1746

float(timedelta_to_milliseconds(delay)

1747

/ 1000))

2367

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

1748

2368

client.changedstate.release()

1749

2369

time2 = datetime.datetime.now()

1750

2370

if (time2 - time) >= delay:

1760

2380

break

1761

2381

else:

1762

2382

delay -= time2 - time

1763

1764

sent_size = 0

1765

while sent_size < len(client.secret):

1766

try:

1767

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

1768

except gnutls.errors.GNUTLSError as error:

1769

logger.warning("gnutls send failed",

1770

exc_info=error)

1771

return

1772

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

1773

sent, len(client.secret)

1774

- (sent_size + sent))

1775

sent_size += sent

1776

2383

2384

try:

2385

session.send(client.secret)

2386

except gnutls.Error as error:

2387

logger.warning("gnutls send failed",

2388

exc_info=error)

2389

return

2390

1777

2391

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

1778

2392

# bump the timeout using extended_timeout

1779

2393

client.bump_timeout(client.extended_timeout)

1780

2394

if self.server.use_dbus:

1781

2395

# Emit D-Bus signal

1782

2396

client.GotSecret()

1783

2397

1784

2398

finally:

1785

2399

if approval_required:

1786

2400

client.approvals_pending -= 1

1787

2401

try:

1788

2402

session.bye()

1789

except gnutls.errors.GNUTLSError as error:

2403

except gnutls.Error as error:

1790

2404

logger.warning("GnuTLS bye failed",

1791

2405

exc_info=error)

1792

2406

1793

2407

@staticmethod

1794

2408

def peer_certificate(session):

1795

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

1796

# If not an OpenPGP certificate...

1797

if (gnutls.library.functions

1798

.gnutls_certificate_type_get(session._c_object)

1799

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1800

# ...do the normal thing

1801

return session.peer_certificate

2409

"Return the peer's certificate as a bytestring"

2410

try:

2411

cert_type = gnutls.certificate_type_get2(session._c_object,

2412

gnutls.CTYPE_PEERS)

2413

except AttributeError:

2414

cert_type = gnutls.certificate_type_get(session._c_object)

2415

if gnutls.has_rawpk:

2416

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2417

else:

2418

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2419

# If not a valid certificate type...

2420

if cert_type not in valid_cert_types:

2421

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

2422

valid_cert_types)

2423

# ...return invalid data

2424

return b""

1802

2425

list_size = ctypes.c_uint(1)

1803

cert_list = (gnutls.library.functions

1804

.gnutls_certificate_get_peers

2426

cert_list = (gnutls.certificate_get_peers

1805

2427

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

1806

2428

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

1807

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

1808

" certificate")

2429

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

1809

2430

if list_size.value == 0:

1810

2431

return None

1811

2432

cert = cert_list[0]

1812

2433

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

1813

2434

2435

@staticmethod

2436

def key_id(certificate):

2437

"Convert a certificate bytestring to a hexdigit key ID"

2438

# New GnuTLS "datum" with the public key

2439

datum = gnutls.datum_t(

2440

ctypes.cast(ctypes.c_char_p(certificate),

2441

ctypes.POINTER(ctypes.c_ubyte)),

2442

ctypes.c_uint(len(certificate)))

2443

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

2444

# New empty GnuTLS certificate

2445

pubkey = gnutls.pubkey_t()

2446

gnutls.pubkey_init(ctypes.byref(pubkey))

2447

# Import the raw public key into the certificate

2448

gnutls.pubkey_import(pubkey,

2449

ctypes.byref(datum),

2450

gnutls.X509_FMT_DER)

2451

# New buffer for the key ID

2452

buf = ctypes.create_string_buffer(32)

2453

buf_len = ctypes.c_size_t(len(buf))

2454

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

2455

gnutls.pubkey_get_key_id(pubkey,

2456

gnutls.KEYID_USE_SHA256,

2457

ctypes.cast(ctypes.byref(buf),

2458

ctypes.POINTER(ctypes.c_ubyte)),

2459

ctypes.byref(buf_len))

2460

# Deinit the certificate

2461

gnutls.pubkey_deinit(pubkey)

2462

2463

# Convert the buffer to a Python bytestring

2464

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

2465

# Convert the bytestring to hexadecimal notation

2466

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

2467

return hex_key_id

2468

1814

2469

@staticmethod

1815

2470

def fingerprint(openpgp):

1816

2471

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1817

2472

# New GnuTLS "datum" with the OpenPGP public key

1818

datum = (gnutls.library.types

1819

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

1820

ctypes.POINTER

1821

(ctypes.c_ubyte)),

1822

ctypes.c_uint(len(openpgp))))

2473

datum = gnutls.datum_t(

2474

ctypes.cast(ctypes.c_char_p(openpgp),

2475

ctypes.POINTER(ctypes.c_ubyte)),

2476

ctypes.c_uint(len(openpgp)))

1823

2477

# New empty GnuTLS certificate

1824

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1825

(gnutls.library.functions

1826

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2478

crt = gnutls.openpgp_crt_t()

2479

gnutls.openpgp_crt_init(ctypes.byref(crt))

1827

2480

# Import the OpenPGP public key into the certificate

1828

(gnutls.library.functions

1829

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

1830

gnutls.library.constants

1831

.GNUTLS_OPENPGP_FMT_RAW))

2481

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

2482

gnutls.OPENPGP_FMT_RAW)

1832

2483

# Verify the self signature in the key

1833

2484

crtverify = ctypes.c_uint()

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_verify_self(crt, 0,

1836

ctypes.byref(crtverify)))

2485

gnutls.openpgp_crt_verify_self(crt, 0,

2486

ctypes.byref(crtverify))

1837

2487

if crtverify.value != 0:

1838

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1839

raise (gnutls.errors.CertificateSecurityError

1840

("Verify failed"))

2488

gnutls.openpgp_crt_deinit(crt)

2489

raise gnutls.CertificateSecurityError(code

2490

=crtverify.value)

1841

2491

# New buffer for the fingerprint

1842

2492

buf = ctypes.create_string_buffer(20)

1843

2493

buf_len = ctypes.c_size_t()

1844

2494

# Get the fingerprint from the certificate into the buffer

1845

(gnutls.library.functions

1846

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

1847

ctypes.byref(buf_len)))

2495

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

2496

ctypes.byref(buf_len))

1848

2497

# Deinit the certificate

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2498

gnutls.openpgp_crt_deinit(crt)

1850

2499

# Convert the buffer to a Python bytestring

1851

2500

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

1852

2501

# Convert the bytestring to hexadecimal notation

1854

2503

return hex_fpr

1855

2504

1856

2505

1857

class MultiprocessingMixIn(object):

2506

class MultiprocessingMixIn:

1858

2507

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

2508

1859

2509

def sub_process_main(self, request, address):

1860

2510

try:

1861

2511

self.finish_request(request, address)

1862

2512

except Exception:

1863

2513

self.handle_error(request, address)

1864

2514

self.close_request(request)

1865

2515

1866

2516

def process_request(self, request, address):

1867

2517

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

1868

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

1869

args = (request, address))

2518

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

2519

args=(request, address))

1870

2520

proc.start()

1871

2521

return proc

1872

2522

1873

2523

1874

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2524

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1875

2525

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

2526

1876

2527

def process_request(self, request, client_address):

1877

2528

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

1878

2529

1879

2530

This function creates a new pipe in self.pipe

1880

2531

"""

1881

2532

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1882

2533

1883

2534

proc = MultiprocessingMixIn.process_request(self, request,

1884

2535

client_address)

1885

2536

self.child_pipe.close()

1886

2537

self.add_pipe(parent_pipe, proc)

1887

2538

1888

2539

def add_pipe(self, parent_pipe, proc):

1889

2540

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

1890

raise NotImplementedError

2541

raise NotImplementedError()

1891

2542

1892

2543

1893

2544

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1894

socketserver.TCPServer, object):

2545

socketserver.TCPServer):

1895

2546

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

1896

2547

1897

2548

Attributes:

1898

2549

enabled: Boolean; whether this server is activated yet

1899

2550

interface: None or a network interface name (string)

1900

2551

use_ipv6: Boolean; to use IPv6 or not

1901

2552

"""

2553

1902

2554

def __init__(self, server_address, RequestHandlerClass,

1903

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

2555

interface=None,

2556

use_ipv6=True,

2557

socketfd=None):

1904

2558

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

1905

2559

creating a new one with socket.socket().

1906

2560

"""

1912

2566

self.socketfd = socketfd

1913

2567

# Save the original socket.socket() function

1914

2568

self.socket_socket = socket.socket

2569

1915

2570

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

1916

#

2571

#

1917

2572

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

1918

2573

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

1919

2574

# patching socket.socket.)

1920

#

2575

#

1921

2576

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

1922

2577

@functools.wraps(socket.socket)

1923

2578

def socket_wrapper(*args, **kwargs):

1935

2590

# socket_wrapper(), if socketfd was set.

1936

2591

socketserver.TCPServer.__init__(self, server_address,

1937

2592

RequestHandlerClass)

1938

2593

1939

2594

def server_bind(self):

1940

2595

"""This overrides the normal server_bind() function

1941

2596

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

1942

2597

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

2598

global SO_BINDTODEVICE

1943

2599

if self.interface is not None:

1944

2600

if SO_BINDTODEVICE is None:

1945

logger.error("SO_BINDTODEVICE does not exist;"

1946

" cannot bind to interface %s",

1947

self.interface)

1948

else:

1949

try:

1950

self.socket.setsockopt(socket.SOL_SOCKET,

1951

SO_BINDTODEVICE,

1952

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

1953

except socket.error as error:

1954

if error.errno == errno.EPERM:

1955

logger.error("No permission to bind to"

1956

" interface %s", self.interface)

1957

elif error.errno == errno.ENOPROTOOPT:

1958

logger.error("SO_BINDTODEVICE not available;"

1959

" cannot bind to interface %s",

1960

self.interface)

1961

elif error.errno == errno.ENODEV:

1962

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

1963

" cannot bind", self.interface)

1964

else:

1965

raise

2601

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

2602

# common enough.

2603

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

2604

SO_BINDTODEVICE = 25

2605

try:

2606

self.socket.setsockopt(

2607

socket.SOL_SOCKET, SO_BINDTODEVICE,

2608

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

2609

except socket.error as error:

2610

if error.errno == errno.EPERM:

2611

logger.error("No permission to bind to"

2612

" interface %s", self.interface)

2613

elif error.errno == errno.ENOPROTOOPT:

2614

logger.error("SO_BINDTODEVICE not available;"

2615

" cannot bind to interface %s",

2616

self.interface)

2617

elif error.errno == errno.ENODEV:

2618

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

2619

" cannot bind", self.interface)

2620

else:

2621

raise

1966

2622

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

1967

2623

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

2624

if self.server_address[1]:

2625

self.allow_reuse_address = True

1968

2626

if not self.server_address[0]:

1969

2627

if self.address_family == socket.AF_INET6:

1970

any_address = "::" # in6addr_any

2628

any_address = "::" # in6addr_any

1971

2629

else:

1972

any_address = socket.INADDR_ANY

2630

any_address = "0.0.0.0" # INADDR_ANY

1973

2631

self.server_address = (any_address,

1974

2632

self.server_address[1])

1975

2633

elif not self.server_address[1]:

1976

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

1977

0)

2634

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

1978

2635

# if self.interface:

1979

2636

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

1980

2637

# 0, # port

1986

2643

1987

2644

class MandosServer(IPv6_TCPServer):

1988

2645

"""Mandos server.

1989

2646

1990

2647

Attributes:

1991

2648

clients: set of Client objects

1992

2649

gnutls_priority GnuTLS priority string

1993

2650

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

1994

1995

Assumes a gobject.MainLoop event loop.

2651

2652

Assumes a GLib.MainLoop event loop.

1996

2653

"""

2654

1997

2655

def __init__(self, server_address, RequestHandlerClass,

1998

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

1999

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

2656

interface=None,

2657

use_ipv6=True,

2658

clients=None,

2659

gnutls_priority=None,

2660

use_dbus=True,

2661

socketfd=None):

2000

2662

self.enabled = False

2001

2663

self.clients = clients

2002

2664

if self.clients is None:

2005

2667

self.gnutls_priority = gnutls_priority

2006

2668

IPv6_TCPServer.__init__(self, server_address,

2007

2669

RequestHandlerClass,

2008

interface = interface,

2009

use_ipv6 = use_ipv6,

2010

socketfd = socketfd)

2670

interface=interface,

2671

use_ipv6=use_ipv6,

2672

socketfd=socketfd)

2673

2011

2674

def server_activate(self):

2012

2675

if self.enabled:

2013

2676

return socketserver.TCPServer.server_activate(self)

2014

2677

2015

2678

def enable(self):

2016

2679

self.enabled = True

2017

2680

2018

2681

def add_pipe(self, parent_pipe, proc):

2019

2682

# Call "handle_ipc" for both data and EOF events

2020

gobject.io_add_watch(parent_pipe.fileno(),

2021

gobject.IO_IN | gobject.IO_HUP,

2022

functools.partial(self.handle_ipc,

2023

parent_pipe =

2024

parent_pipe,

2025

proc = proc))

2026

2027

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

2028

proc = None, client_object=None):

2683

GLib.io_add_watch(

2684

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

2685

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

2686

functools.partial(self.handle_ipc,

2687

parent_pipe=parent_pipe,

2688

proc=proc))

2689

2690

def handle_ipc(self, source, condition,

2691

parent_pipe=None,

2692

proc=None,

2693

client_object=None):

2029

2694

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

2030

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

2695

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

2031

2696

# Wait for other process to exit

2032

2697

proc.join()

2033

2698

return False

2034

2699

2035

2700

# Read a request from the child

2036

2701

request = parent_pipe.recv()

2037

2702

command = request[0]

2038

2703

2039

2704

if command == 'init':

2040

fpr = request[1]

2041

address = request[2]

2042

2043

for c in self.clients.itervalues():

2044

if c.fingerprint == fpr:

2705

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

2706

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

2707

address = request[3]

2708

2709

for c in self.clients.values():

2710

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2711

continue

2712

if key_id and c.key_id == key_id:

2713

client = c

2714

break

2715

if fpr and c.fingerprint == fpr:

2045

2716

client = c

2046

2717

break

2047

2718

else:

2048

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

2049

"dress: %s", fpr, address)

2719

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

2720

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

2050

2721

if self.use_dbus:

2051

2722

# Emit D-Bus signal

2052

mandos_dbus_service.ClientNotFound(fpr,

2723

mandos_dbus_service.ClientNotFound(key_id or fpr,

2053

2724

address[0])

2054

2725

parent_pipe.send(False)

2055

2726

return False

2056

2057

gobject.io_add_watch(parent_pipe.fileno(),

2058

gobject.IO_IN | gobject.IO_HUP,

2059

functools.partial(self.handle_ipc,

2060

parent_pipe =

2061

parent_pipe,

2062

proc = proc,

2063

client_object =

2064

client))

2727

2728

GLib.io_add_watch(

2729

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

2730

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

2731

functools.partial(self.handle_ipc,

2732

parent_pipe=parent_pipe,

2733

proc=proc,

2734

client_object=client))

2065

2735

parent_pipe.send(True)

2066

2736

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

2067

2737

# same fileno

2070

2740

funcname = request[1]

2071

2741

args = request[2]

2072

2742

kwargs = request[3]

2073

2743

2074

2744

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

2075

2745

funcname)(*args,

2076

**kwargs)))

2077

2746

**kwargs)))

2747

2078

2748

if command == 'getattr':

2079

2749

attrname = request[1]

2080

if callable(client_object.__getattribute__(attrname)):

2081

parent_pipe.send(('function',))

2750

if isinstance(client_object.__getattribute__(attrname),

2751

collections.Callable):

2752

parent_pipe.send(('function', ))

2082

2753

else:

2083

parent_pipe.send(('data', client_object

2084

.__getattribute__(attrname)))

2085

2754

parent_pipe.send((

2755

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

2756

2086

2757

if command == 'setattr':

2087

2758

attrname = request[1]

2088

2759

value = request[2]

2089

2760

setattr(client_object, attrname, value)

2090

2761

2091

2762

return True

2092

2763

2093

2764

2094

2765

def rfc3339_duration_to_delta(duration):

2095

2766

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

2096

2097

>>> rfc3339_duration_to_delta("P7D")

2098

datetime.timedelta(7)

2099

>>> rfc3339_duration_to_delta("PT60S")

2100

datetime.timedelta(0, 60)

2101

>>> rfc3339_duration_to_delta("PT60M")

2102

datetime.timedelta(0, 3600)

2103

>>> rfc3339_duration_to_delta("PT24H")

2104

datetime.timedelta(1)

2105

>>> rfc3339_duration_to_delta("P1W")

2106

datetime.timedelta(7)

2107

>>> rfc3339_duration_to_delta("PT5M30S")

2108

datetime.timedelta(0, 330)

2109

>>> rfc3339_duration_to_delta("P1DT3M20S")

2110

datetime.timedelta(1, 200)

2767

2768

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

2769

True

2770

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

2771

True

2772

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

2773

True

2774

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

2775

True

2776

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

2777

True

2778

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

2779

True

2780

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

2781

True

2111

2782

"""

2112

2783

2113

2784

# Parsing an RFC 3339 duration with regular expressions is not

2114

2785

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

2115

2786

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

2116

2787

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

2117

2788

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

2118

2789

# avoid excessive use of external libraries.

2119

2790

2120

2791

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

2121

Token = collections.namedtuple("Token",

2122

("regexp", # To match token; if

2123

# "value" is not None,

2124

# must have a "group"

2125

# containing digits

2126

"value", # datetime.timedelta or

2127

# None

2128

"followers")) # Tokens valid after

2129

# this token

2792

Token = collections.namedtuple("Token", (

2793

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

2794

# a "group" containing digits

2795

"value", # datetime.timedelta or None

2796

"followers")) # Tokens valid after this token

2130

2797

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

2131

2798

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

2132

2799

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

2133

2800

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

2134

2801

datetime.timedelta(seconds=1),

2135

frozenset((token_end,)))

2802

frozenset((token_end, )))

2136

2803

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

2137

2804

datetime.timedelta(minutes=1),

2138

2805

frozenset((token_second, token_end)))

2154

2821

frozenset((token_month, token_end)))

2155

2822

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

2156

2823

datetime.timedelta(weeks=1),

2157

frozenset((token_end,)))

2824

frozenset((token_end, )))

2158

2825

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

2159

2826

frozenset((token_year, token_month,

2160

2827

token_day, token_time,

2161

token_week))),

2162

# Define starting values

2163

value = datetime.timedelta() # Value so far

2828

token_week)))

2829

# Define starting values:

2830

# Value so far

2831

value = datetime.timedelta()

2164

2832

found_token = None

2165

followers = frozenset(token_duration,) # Following valid tokens

2166

s = duration # String left to parse

2833

# Following valid tokens

2834

followers = frozenset((token_duration, ))

2835

# String left to parse

2836

s = duration

2167

2837

# Loop until end token is found

2168

2838

while found_token is not token_end:

2169

2839

# Search for any currently valid tokens

2185

2855

break

2186

2856

else:

2187

2857

# No currently valid tokens were found

2188

raise ValueError("Invalid RFC 3339 duration")

2858

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

2859

.format(duration))

2189

2860

# End token found

2190

2861

return value

2191

2862

2192

2863

2193

2864

def string_to_delta(interval):

2194

2865

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

2195

2196

>>> string_to_delta('7d')

2197

datetime.timedelta(7)

2198

>>> string_to_delta('60s')

2199

datetime.timedelta(0, 60)

2200

>>> string_to_delta('60m')

2201

datetime.timedelta(0, 3600)

2202

>>> string_to_delta('24h')

2203

datetime.timedelta(1)

2204

>>> string_to_delta('1w')

2205

datetime.timedelta(7)

2206

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

2207

datetime.timedelta(0, 330)

2866

2867

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

2868

True

2869

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

2870

True

2871

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

2872

True

2873

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

2874

True

2875

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

2876

True

2877

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

2878

True

2208

2879

"""

2209

2880

2210

2881

try:

2211

2882

return rfc3339_duration_to_delta(interval)

2212

2883

except ValueError:

2213

2884

pass

2214

2885

2215

2886

timevalue = datetime.timedelta(0)

2216

2887

for s in interval.split():

2217

2888

try:

2218

suffix = unicode(s[-1])

2889

suffix = s[-1]

2219

2890

value = int(s[:-1])

2220

2891

if suffix == "d":

2221

2892

delta = datetime.timedelta(value)

2228

2899

elif suffix == "w":

2229

2900

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

2230

2901

else:

2231

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

2232

.format(suffix))

2233

except (ValueError, IndexError) as e:

2902

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

2903

except IndexError as e:

2234

2904

raise ValueError(*(e.args))

2235

2905

timevalue += delta

2236

2906

return timevalue

2237

2907

2238

2908

2239

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

2909

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

2240

2910

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

2241

2911

2242

2912

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

2243

2913

if os.fork():

2244

2914

sys.exit()

2252

2922

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

2253

2923

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

2254

2924

raise OSError(errno.ENODEV,

2255

"{0} not a character device"

2925

"{} not a character device"

2256

2926

.format(os.devnull))

2257

2927

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

2258

2928

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

2262

2932

2263

2933

2264

2934

def main():

2265

2935

2266

2936

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

2267

2937

# Parsing of options, both command line and config file

2268

2938

2269

2939

parser = argparse.ArgumentParser()

2270

2940

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

2271

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

2941

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

2272

2942

help="show version number and exit")

2273

2943

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

2274

2944

help="Bind to interface IF")

2280

2950

help="Run self-test")

2281

2951

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

2282

2952

help="Debug mode; run in foreground and log"

2283

" to terminal")

2953

" to terminal", default=None)

2284

2954

parser.add_argument("--debuglevel", metavar="LEVEL",

2285

2955

help="Debug level for stdout output")

2286

2956

parser.add_argument("--priority", help="GnuTLS"

2293

2963

" files")

2294

2964

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

2295

2965

dest="use_dbus", help="Do not provide D-Bus"

2296

" system bus interface")

2966

" system bus interface", default=None)

2297

2967

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

2298

dest="use_ipv6", help="Do not use IPv6")

2968

dest="use_ipv6", help="Do not use IPv6",

2969

default=None)

2299

2970

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

2300

2971

dest="restore", help="Do not restore stored"

2301

" state")

2972

" state", default=None)

2302

2973

parser.add_argument("--socket", type=int,

2303

2974

help="Specify a file descriptor to a network"

2304

2975

" socket to use instead of creating one")

2305

2976

parser.add_argument("--statedir", metavar="DIR",

2306

2977

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

2307

2978

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

2308

help="Run in foreground")

2309

2979

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

2980

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

2981

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

2982

default=None)

2983

2310

2984

options = parser.parse_args()

2311

2312

if options.check:

2313

import doctest

2314

doctest.testmod()

2315

sys.exit()

2316

2985

2317

2986

# Default values for config file for server-global settings

2318

server_defaults = { "interface": "",

2319

"address": "",

2320

"port": "",

2321

"debug": "False",

2322

"priority":

2323

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

2324

"servicename": "Mandos",

2325

"use_dbus": "True",

2326

"use_ipv6": "True",

2327

"debuglevel": "",

2328

"restore": "True",

2329

"socket": "",

2330

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

2331

"foreground": "False",

2332

}

2333

2987

if gnutls.has_rawpk:

2988

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

2989

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

2990

else:

2991

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

2992

":+SIGN-DSA-SHA256")

2993

server_defaults = {"interface": "",

2994

"address": "",

2995

"port": "",

2996

"debug": "False",

2997

"priority": priority,

2998

"servicename": "Mandos",

2999

"use_dbus": "True",

3000

"use_ipv6": "True",

3001

"debuglevel": "",

3002

"restore": "True",

3003

"socket": "",

3004

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

3005

"foreground": "False",

3006

"zeroconf": "True",

3007

}

3008

del priority

3009

2334

3010

# Parse config file for server-global settings

2335

server_config = configparser.SafeConfigParser(server_defaults)

3011

server_config = configparser.ConfigParser(server_defaults)

2336

3012

del server_defaults

2337

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

2338

"mandos.conf"))

2339

# Convert the SafeConfigParser object to a dict

3013

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

3014

# Convert the ConfigParser object to a dict

2340

3015

server_settings = server_config.defaults()

2341

3016

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

2342

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

3017

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

3018

"foreground", "zeroconf"):

2343

3019

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

2344

3020

option)

2345

3021

if server_settings["port"]:

2355

3031

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

2356

3032

["socket"])

2357

3033

del server_config

2358

3034

2359

3035

# Override the settings from the config file with command line

2360

3036

# options, if set.

2361

3037

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

2362

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

2363

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

2364

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

3038

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

3039

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

3040

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

2365

3041

value = getattr(options, option)

2366

3042

if value is not None:

2367

3043

server_settings[option] = value

2368

3044

del options

2369

3045

# Force all strings to be unicode

2370

3046

for option in server_settings.keys():

2371

if type(server_settings[option]) is str:

2372

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

3047

if isinstance(server_settings[option], bytes):

3048

server_settings[option] = (server_settings[option]

3049

.decode("utf-8"))

3050

# Force all boolean options to be boolean

3051

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

3052

"foreground", "zeroconf"):

3053

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

2373

3054

# Debug implies foreground

2374

3055

if server_settings["debug"]:

2375

3056

server_settings["foreground"] = True

2376

3057

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

2377

3058

2378

3059

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

2379

3060

3061

if (not server_settings["zeroconf"]

3062

and not (server_settings["port"]

3063

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

3064

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

3065

2380

3066

# For convenience

2381

3067

debug = server_settings["debug"]

2382

3068

debuglevel = server_settings["debuglevel"]

2385

3071

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

2386

3072

stored_state_file)

2387

3073

foreground = server_settings["foreground"]

2388

3074

zeroconf = server_settings["zeroconf"]

3075

2389

3076

if debug:

2390

3077

initlogger(debug, logging.DEBUG)

2391

3078

else:

2394

3081

else:

2395

3082

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

2396

3083

initlogger(debug, level)

2397

3084

2398

3085

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

2399

syslogger.setFormatter(logging.Formatter

2400

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

2401

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

2402

.format(server_settings

2403

["servicename"])))

2404

3086

syslogger.setFormatter(

3087

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

3088

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

3089

server_settings["servicename"])))

3090

2405

3091

# Parse config file with clients

2406

client_config = configparser.SafeConfigParser(Client

2407

.client_defaults)

3092

client_config = configparser.ConfigParser(Client.client_defaults)

2408

3093

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

2409

3094

"clients.conf"))

2410

3095

2411

3096

global mandos_dbus_service

2412

3097

mandos_dbus_service = None

2413

2414

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

2415

server_settings["port"]),

2416

ClientHandler,

2417

interface=(server_settings["interface"]

2418

or None),

2419

use_ipv6=use_ipv6,

2420

gnutls_priority=

2421

server_settings["priority"],

2422

use_dbus=use_dbus,

2423

socketfd=(server_settings["socket"]

2424

or None))

3098

3099

socketfd = None

3100

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

3101

socketfd = server_settings["socket"]

3102

tcp_server = MandosServer(

3103

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

3104

ClientHandler,

3105

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

3106

use_ipv6=use_ipv6,

3107

gnutls_priority=server_settings["priority"],

3108

use_dbus=use_dbus,

3109

socketfd=socketfd)

2425

3110

if not foreground:

2426

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

3111

pidfilename = "/run/mandos.pid"

3112

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

3113

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

2427

3114

pidfile = None

2428

3115

try:

2429

pidfile = open(pidfilename, "w")

3116

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

2430

3117

except IOError as e:

2431

3118

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

2432

3119

exc_info=e)

2433

2434

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

3120

3121

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

3122

("mandos", "mandos"),

3123

("nobody", "nogroup")):

2435

3124

try:

2436

3125

uid = pwd.getpwnam(name).pw_uid

2437

gid = pwd.getpwnam(name).pw_gid

3126

gid = pwd.getpwnam(group).pw_gid

2438

3127

break

2439

3128

except KeyError:

2440

3129

continue

2444

3133

try:

2445

3134

os.setgid(gid)

2446

3135

os.setuid(uid)

3136

if debug:

3137

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

3138

gid))

2447

3139

except OSError as error:

3140

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

3141

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

2448

3142

if error.errno != errno.EPERM:

2449

raise error

2450

3143

raise

3144

2451

3145

if debug:

2452

3146

# Enable all possible GnuTLS debugging

2453

3147

2454

3148

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

2455

3149

# - GnuTLS manual

2456

gnutls.library.functions.gnutls_global_set_log_level(11)

2457

2458

@gnutls.library.types.gnutls_log_func

3150

gnutls.global_set_log_level(11)

3151

3152

@gnutls.log_func

2459

3153

def debug_gnutls(level, string):

2460

3154

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

2461

2462

(gnutls.library.functions

2463

.gnutls_global_set_log_function(debug_gnutls))

2464

3155

3156

gnutls.global_set_log_function(debug_gnutls)

3157

2465

3158

# Redirect stdin so all checkers get /dev/null

2466

3159

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

2467

3160

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

2468

3161

if null > 2:

2469

3162

os.close(null)

2470

3163

2471

3164

# Need to fork before connecting to D-Bus

2472

3165

if not foreground:

2473

3166

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

2474

3167

daemon()

2475

2476

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

2477

# need to inform gobject that threads will be used.

2478

gobject.threads_init()

2479

3168

3169

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

3170

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

3171

# need to inform GLib that threads will be used.

3172

GLib.threads_init()

3173

2480

3174

global main_loop

2481

3175

# From the Avahi example code

2482

3176

DBusGMainLoop(set_as_default=True)

2483

main_loop = gobject.MainLoop()

3177

main_loop = GLib.MainLoop()

2484

3178

bus = dbus.SystemBus()

2485

3179

# End of Avahi example code

2486

3180

if use_dbus:

2487

3181

try:

2488

3182

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

2489

bus, do_not_queue=True)

2490

old_bus_name = (dbus.service.BusName

2491

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

2492

do_not_queue=True))

2493

except dbus.exceptions.NameExistsException as e:

3183

bus,

3184

do_not_queue=True)

3185

old_bus_name = dbus.service.BusName(

3186

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

3187

do_not_queue=True)

3188

except dbus.exceptions.DBusException as e:

2494

3189

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

2495

3190

use_dbus = False

2496

3191

server_settings["use_dbus"] = False

2497

3192

tcp_server.use_dbus = False

2498

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2499

service = AvahiServiceToSyslog(name =

2500

server_settings["servicename"],

2501

servicetype = "_mandos._tcp",

2502

protocol = protocol, bus = bus)

2503

if server_settings["interface"]:

2504

service.interface = (if_nametoindex

2505

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

2506

3193

if zeroconf:

3194

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3195

service = AvahiServiceToSyslog(

3196

name=server_settings["servicename"],

3197

servicetype="_mandos._tcp",

3198

protocol=protocol,

3199

bus=bus)

3200

if server_settings["interface"]:

3201

service.interface = if_nametoindex(

3202

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

3203

2507

3204

global multiprocessing_manager

2508

3205

multiprocessing_manager = multiprocessing.Manager()

2509

3206

2510

3207

client_class = Client

2511

3208

if use_dbus:

2512

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

2513

3209

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

3210

2514

3211

client_settings = Client.config_parser(client_config)

2515

3212

old_client_settings = {}

2516

3213

clients_data = {}

2517

3214

3215

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

3216

global wnull

3217

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

3218

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

3219

# mode

3220

if debug or not foreground:

3221

wnull.close()

3222

2518

3223

# Get client data and settings from last running state.

2519

3224

if server_settings["restore"]:

2520

3225

try:

2521

3226

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

2522

clients_data, old_client_settings = (pickle.load

2523

(stored_state))

3227

if sys.version_info.major == 2:

3228

clients_data, old_client_settings = pickle.load(

3229

stored_state)

3230

else:

3231

bytes_clients_data, bytes_old_client_settings = (

3232

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

3233

# Fix bytes to strings

3234

# clients_data

3235

# .keys()

3236

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

3237

if isinstance(key, bytes)

3238

else key): value

3239

for key, value in

3240

bytes_clients_data.items()}

3241

del bytes_clients_data

3242

for key in clients_data:

3243

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

3244

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

3245

for k, v in

3246

clients_data[key].items()}

3247

clients_data[key] = value

3248

# .client_structure

3249

value["client_structure"] = [

3250

(s.decode("utf-8")

3251

if isinstance(s, bytes)

3252

else s) for s in

3253

value["client_structure"]]

3254

# .name, .host, and .checker_command

3255

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

3256

if isinstance(value[k], bytes):

3257

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

3258

if "key_id" not in value:

3259

value["key_id"] = ""

3260

elif "fingerprint" not in value:

3261

value["fingerprint"] = ""

3262

# old_client_settings

3263

# .keys()

3264

old_client_settings = {

3265

(key.decode("utf-8")

3266

if isinstance(key, bytes)

3267

else key): value

3268

for key, value in

3269

bytes_old_client_settings.items()}

3270

del bytes_old_client_settings

3271

# .host and .checker_command

3272

for value in old_client_settings.values():

3273

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

3274

if isinstance(value[attribute], bytes):

3275

value[attribute] = (value[attribute]

3276

.decode("utf-8"))

2524

3277

os.remove(stored_state_path)

2525

3278

except IOError as e:

2526

3279

if e.errno == errno.ENOENT:

2527

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

2528

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

3280

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

3281

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

2529

3282

else:

2530

3283

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

2531

3284

exc_info=e)

2532

3285

raise

2533

3286

except EOFError as e:

2534

3287

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

2535

"EOFError:", exc_info=e)

2536

3288

"EOFError:",

3289

exc_info=e)

3290

2537

3291

with PGPEngine() as pgp:

2538

for client_name, client in clients_data.iteritems():

3292

for client_name, client in clients_data.items():

3293

# Skip removed clients

3294

if client_name not in client_settings:

3295

continue

3296

2539

3297

# Decide which value to use after restoring saved state.

2540

3298

# We have three different values: Old config file,

2541

3299

# new config file, and saved state.

2546

3304

# For each value in new config, check if it

2547

3305

# differs from the old config value (Except for

2548

3306

# the "secret" attribute)

2549

if (name != "secret" and

2550

value != old_client_settings[client_name]

2551

[name]):

3307

if (name != "secret"

3308

and (value !=

3309

old_client_settings[client_name][name])):

2552

3310

client[name] = value

2553

3311

except KeyError:

2554

3312

pass

2555

3313

2556

3314

# Clients who has passed its expire date can still be

2557

# enabled if its last checker was successful. Clients

3315

# enabled if its last checker was successful. A Client

2558

3316

# whose checker succeeded before we stored its state is

2559

3317

# assumed to have successfully run all checkers during

2560

3318

# downtime.

2562

3320

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

2563

3321

if not client["last_checked_ok"]:

2564

3322

logger.warning(

2565

"disabling client {0} - Client never "

2566

"performed a successful checker"

2567

.format(client_name))

3323

"disabling client {} - Client never "

3324

"performed a successful checker".format(

3325

client_name))

2568

3326

client["enabled"] = False

2569

3327

elif client["last_checker_status"] != 0:

2570

3328

logger.warning(

2571

"disabling client {0} - Client "

2572

"last checker failed with error code {1}"

2573

.format(client_name,

2574

client["last_checker_status"]))

3329

"disabling client {} - Client last"

3330

" checker failed with error code"

3331

" {}".format(

3332

client_name,

3333

client["last_checker_status"]))

2575

3334

client["enabled"] = False

2576

3335

else:

2577

client["expires"] = (datetime.datetime

2578

.utcnow()

2579

+ client["timeout"])

3336

client["expires"] = (

3337

datetime.datetime.utcnow()

3338

+ client["timeout"])

2580

3339

logger.debug("Last checker succeeded,"

2581

" keeping {0} enabled"

2582

.format(client_name))

3340

" keeping {} enabled".format(

3341

client_name))

2583

3342

try:

2584

client["secret"] = (

2585

pgp.decrypt(client["encrypted_secret"],

2586

client_settings[client_name]

2587

["secret"]))

3343

client["secret"] = pgp.decrypt(

3344

client["encrypted_secret"],

3345

client_settings[client_name]["secret"])

2588

3346

except PGPError:

2589

3347

# If decryption fails, we use secret from new settings

2590

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

2591

.format(client_name))

2592

client["secret"] = (

2593

client_settings[client_name]["secret"])

2594

3348

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

3349

client_name))

3350

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

3351

["secret"])

3352

2595

3353

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

2596

3354

for client_name in (set(old_client_settings)

2597

3355

- set(client_settings)):

2599

3357

for client_name in (set(client_settings)

2600

3358

- set(old_client_settings)):

2601

3359

clients_data[client_name] = client_settings[client_name]

2602

3360

2603

3361

# Create all client objects

2604

for client_name, client in clients_data.iteritems():

3362

for client_name, client in clients_data.items():

2605

3363

tcp_server.clients[client_name] = client_class(

2606

name = client_name, settings = client)

2607

3364

name=client_name,

3365

settings=client,

3366

server_settings=server_settings)

3367

2608

3368

if not tcp_server.clients:

2609

3369

logger.warning("No clients defined")

2610

3370

2611

3371

if not foreground:

2612

3372

if pidfile is not None:

3373

pid = os.getpid()

2613

3374

try:

2614

3375

with pidfile:

2615

pid = os.getpid()

2616

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

3376

print(pid, file=pidfile)

2617

3377

except IOError:

2618

3378

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

2619

3379

pidfilename, pid)

2620

3380

del pidfile

2621

3381

del pidfilename

2622

2623

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

2624

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

2625

3382

3383

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

3384

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3385

lambda: main_loop.quit() and False)

3386

2626

3387

if use_dbus:

2627

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

2628

"se.bsnet.fukt.Mandos"})

2629

class MandosDBusService(DBusObjectWithProperties):

3388

3389

@alternate_dbus_interfaces(

3390

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

3391

class MandosDBusService(DBusObjectWithObjectManager):

2630

3392

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

3393

2631

3394

def __init__(self):

2632

3395

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

3396

2633

3397

_interface = "se.recompile.Mandos"

2634

2635

@dbus_interface_annotations(_interface)

2636

def _foo(self):

2637

return { "org.freedesktop.DBus.Property"

2638

".EmitsChangedSignal":

2639

"false"}

2640

3398

2641

3399

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

2642

3400

def ClientAdded(self, objpath):

2643

3401

"D-Bus signal"

2644

3402

pass

2645

3403

2646

3404

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

2647

def ClientNotFound(self, fingerprint, address):

3405

def ClientNotFound(self, key_id, address):

2648

3406

"D-Bus signal"

2649

3407

pass

2650

3408

3409

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

3410

"true"})

2651

3411

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

2652

3412

def ClientRemoved(self, objpath, name):

2653

3413

"D-Bus signal"

2654

3414

pass

2655

3415

3416

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

3417

"true"})

2656

3418

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

2657

3419

def GetAllClients(self):

2658

3420

"D-Bus method"

2659

return dbus.Array(c.dbus_object_path

2660

for c in

2661

tcp_server.clients.itervalues())

2662

3421

return dbus.Array(c.dbus_object_path for c in

3422

tcp_server.clients.values())

3423

3424

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

3425

"true"})

2663

3426

@dbus.service.method(_interface,

2664

3427

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

2665

3428

def GetAllClientsWithProperties(self):

2666

3429

"D-Bus method"

2667

3430

return dbus.Dictionary(

2668

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

2669

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

3431

{c.dbus_object_path: c.GetAll(

3432

"se.recompile.Mandos.Client")

3433

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

2670

3434

signature="oa{sv}")

2671

3435

2672

3436

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

2673

3437

def RemoveClient(self, object_path):

2674

3438

"D-Bus method"

2675

for c in tcp_server.clients.itervalues():

3439

for c in tcp_server.clients.values():

2676

3440

if c.dbus_object_path == object_path:

2677

3441

del tcp_server.clients[c.name]

2678

3442

c.remove_from_connection()

2679

# Don't signal anything except ClientRemoved

3443

# Don't signal the disabling

2680

3444

c.disable(quiet=True)

2681

# Emit D-Bus signal

2682

self.ClientRemoved(object_path, c.name)

3445

# Emit D-Bus signal for removal

3446

self.client_removed_signal(c)

2683

3447

return

2684

3448

raise KeyError(object_path)

2685

3449

2686

3450

del _interface

2687

3451

3452

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3453

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

3454

def GetManagedObjects(self):

3455

"""D-Bus method"""

3456

return dbus.Dictionary(

3457

{client.dbus_object_path:

3458

dbus.Dictionary(

3459

{interface: client.GetAll(interface)

3460

for interface in

3461

client._get_all_interface_names()})

3462

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

3463

3464

def client_added_signal(self, client):

3465

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

3466

if use_dbus:

3467

# New standard signal

3468

self.InterfacesAdded(

3469

client.dbus_object_path,

3470

dbus.Dictionary(

3471

{interface: client.GetAll(interface)

3472

for interface in

3473

client._get_all_interface_names()}))

3474

# Old signal

3475

self.ClientAdded(client.dbus_object_path)

3476

3477

def client_removed_signal(self, client):

3478

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

3479

if use_dbus:

3480

# New standard signal

3481

self.InterfacesRemoved(

3482

client.dbus_object_path,

3483

client._get_all_interface_names())

3484

# Old signal

3485

self.ClientRemoved(client.dbus_object_path,

3486

client.name)

3487

2688

3488

mandos_dbus_service = MandosDBusService()

2689

3489

3490

# Save modules to variables to exempt the modules from being

3491

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

3492

mp = multiprocessing

3493

wn = wnull

3494

2690

3495

def cleanup():

2691

3496

"Cleanup function; run on exit"

2692

service.cleanup()

2693

2694

multiprocessing.active_children()

3497

if zeroconf:

3498

service.cleanup()

3499

3500

mp.active_children()

3501

wn.close()

2695

3502

if not (tcp_server.clients or client_settings):

2696

3503

return

2697

3504

2698

3505

# Store client before exiting. Secrets are encrypted with key

2699

3506

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

2700

3507

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

2701

3508

clients = {}

2702

3509

with PGPEngine() as pgp:

2703

for client in tcp_server.clients.itervalues():

3510

for client in tcp_server.clients.values():

2704

3511

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

2705

3512

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

2706

3513

key)

2707

3514

client_dict = {}

2708

3515

2709

3516

# A list of attributes that can not be pickled

2710

3517

# + secret.

2711

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

2712

"checker"))

2713

for name, typ in (inspect.getmembers

2714

(dbus.service.Object)):

3518

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

3519

"checker", "server_settings"}

3520

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

3521

.Object):

2715

3522

exclude.add(name)

2716

3523

2717

3524

client_dict["encrypted_secret"] = (client

2718

3525

.encrypted_secret)

2719

3526

for attr in client.client_structure:

2720

3527

if attr not in exclude:

2721

3528

client_dict[attr] = getattr(client, attr)

2722

3529

2723

3530

clients[client.name] = client_dict

2724

3531

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

2725

3532

2726

3533

try:

2727

with (tempfile.NamedTemporaryFile

2728

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

2729

dir=os.path.dirname(stored_state_path),

2730

delete=False)) as stored_state:

2731

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

2732

tempname=stored_state.name

3534

with tempfile.NamedTemporaryFile(

3535

mode='wb',

3536

suffix=".pickle",

3537

prefix='clients-',

3538

dir=os.path.dirname(stored_state_path),

3539

delete=False) as stored_state:

3540

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

3541

protocol=2)

3542

tempname = stored_state.name

2733

3543

os.rename(tempname, stored_state_path)

2734

3544

except (IOError, OSError) as e:

2735

3545

if not debug:

2738

3548

except NameError:

2739

3549

pass

2740

3550

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

2741

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

3551

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

2742

3552

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

2743

3553

else:

2744

3554

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

2745

3555

exc_info=e)

2746

raise e

2747

3556

raise

3557

2748

3558

# Delete all clients, and settings from config

2749

3559

while tcp_server.clients:

2750

3560

name, client = tcp_server.clients.popitem()

2751

3561

if use_dbus:

2752

3562

client.remove_from_connection()

2753

# Don't signal anything except ClientRemoved

3563

# Don't signal the disabling

2754

3564

client.disable(quiet=True)

3565

# Emit D-Bus signal for removal

2755

3566

if use_dbus:

2756

# Emit D-Bus signal

2757

mandos_dbus_service.ClientRemoved(client

2758

.dbus_object_path,

2759

client.name)

3567

mandos_dbus_service.client_removed_signal(client)

2760

3568

client_settings.clear()

2761

3569

2762

3570

atexit.register(cleanup)

2763

2764

for client in tcp_server.clients.itervalues():

3571

3572

for client in tcp_server.clients.values():

2765

3573

if use_dbus:

2766

# Emit D-Bus signal

2767

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3574

# Emit D-Bus signal for adding

3575

mandos_dbus_service.client_added_signal(client)

2768

3576

# Need to initiate checking of clients

2769

3577

if client.enabled:

2770

3578

client.init_checker()

2771

3579

2772

3580

tcp_server.enable()

2773

3581

tcp_server.server_activate()

2774

3582

2775

3583

# Find out what port we got

2776

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

3584

if zeroconf:

3585

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

2777

3586

if use_ipv6:

2778

3587

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

2779

3588

" flowinfo %d, scope_id %d",

2781

3590

else: # IPv4

2782

3591

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

2783

3592

*tcp_server.socket.getsockname())

2784

2785

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

2786

3593

3594

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

3595

2787

3596

try:

2788

# From the Avahi example code

2789

try:

2790

service.activate()

2791

except dbus.exceptions.DBusException as error:

2792

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

2793

cleanup()

2794

sys.exit(1)

2795

# End of Avahi example code

2796

2797

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

2798

lambda *args, **kwargs:

2799

(tcp_server.handle_request

2800

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

2801

3597

if zeroconf:

3598

# From the Avahi example code

3599

try:

3600

service.activate()

3601

except dbus.exceptions.DBusException as error:

3602

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

3603

cleanup()

3604

sys.exit(1)

3605

# End of Avahi example code

3606

3607

GLib.io_add_watch(

3608

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

3609

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3610

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

3611

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

3612

2802

3613

logger.debug("Starting main loop")

2803

3614

main_loop.run()

2804

3615

except AvahiError as error:

2813

3624

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

2814

3625

cleanup()

2815

3626

3627

3628

def should_only_run_tests():

3629

parser = argparse.ArgumentParser(add_help=False)

3630

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

3631

args, unknown_args = parser.parse_known_args()

3632

run_tests = args.check

3633

if run_tests:

3634

# Remove --check argument from sys.argv

3635

sys.argv[1:] = unknown_args

3636

return run_tests

3637

3638

# Add all tests from doctest strings

3639

def load_tests(loader, tests, none):

3640

import doctest

3641

tests.addTests(doctest.DocTestSuite())

3642

return tests

3643

2816

3644

if __name__ == '__main__':

2817

main()

3645

try:

3646

if should_only_run_tests():

3647

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

3648

unittest.main()

3649

else:

3650

main()

3651

finally:

3652

logging.shutdown()