/mandos/trunk : revision 594

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

import collections

79

import codecs

80

import unittest

81

import random

82

import shlex

83

71

84

72

import dbus

85

73

import dbus.service

86

import gi

87

from gi.repository import GLib

74

import gobject

75

import avahi

88

76

from dbus.mainloop.glib import DBusGMainLoop

89

77

import ctypes

90

78

import ctypes.util

91

79

import xml.dom.minidom

92

80

import inspect

93

94

if sys.version_info.major == 2:

95

__metaclass__ = type

96

str = unicode

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

81

import GnuPGInterface

82

83

try:

122

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

85

except AttributeError:

124

86

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

87

from IN import SO_BINDTODEVICE

128

88

except ImportError:

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.14"

89

SO_BINDTODEVICE = None

90

91

version = "1.5.5"

147

92

stored_state_file = "clients.pickle"

148

93

149

94

logger = logging.getLogger()

150

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

151

syslogger = None

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

152

98

153

99

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

156

103

except (OSError, AttributeError):

157

158

104

def if_nametoindex(interface):

159

105

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

160

106

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

161

107

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

162

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

163

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

164

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

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

165

113

return interface_index

166

114

167

115

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

184

116

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

185

117

"""init logger and add loglevel"""

186

187

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

118

191

119

syslogger.setFormatter(logging.Formatter

192

120

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

193

121

' %(message)s'))

194

122

logger.addHandler(syslogger)

195

123

196

124

if debug:

197

125

console = logging.StreamHandler()

198

126

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

208

136

pass

209

137

210

138

211

class PGPEngine:

139

class PGPEngine(object):

212

140

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

213

214

141

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

215

143

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

self.gnupgargs = ['--batch',

228

'--homedir', self.tempdir,

229

'--force-mdc',

230

'--quiet']

231

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

232

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

233

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

234

144

self.gnupg = GnuPGInterface.GnuPG()

145

self.gnupg.options.meta_interactive = False

146

self.gnupg.options.homedir = self.tempdir

147

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

148

'--quiet',

149

'--no-use-agent'])

150

235

151

def __enter__(self):

236

152

return self

237

153

238

154

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

239

155

self._cleanup()

240

156

return False

241

157

242

158

def __del__(self):

243

159

self._cleanup()

244

160

245

161

def _cleanup(self):

246

162

if self.tempdir is not None:

247

163

# Delete contents of tempdir

248

164

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

249

topdown=False):

165

topdown = False):

250

166

for filename in files:

251

167

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

252

168

for dirname in dirs:

254

170

# Remove tempdir

255

171

os.rmdir(self.tempdir)

256

172

self.tempdir = None

257

173

258

174

def password_encode(self, password):

259

175

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

260

176

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

261

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

262

if len(encoded) > 2048:

263

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

264

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

265

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

266

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

267

return encoded

268

177

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

178

269

179

def encrypt(self, data, password):

270

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

273

passfile.write(passphrase)

274

passfile.flush()

275

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

276

'--passphrase-file',

277

passfile.name]

278

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

283

if proc.returncode != 0:

284

raise PGPError(err)

180

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

181

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

182

try:

183

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

184

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

185

attach_fhs={'stderr': devnull})

186

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

187

f.write(data)

188

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

189

ciphertext = f.read()

190

proc.wait()

191

except IOError as e:

192

raise PGPError(e)

193

self.gnupg.passphrase = None

285

194

return ciphertext

286

195

287

196

def decrypt(self, data, password):

288

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

291

passfile.write(passphrase)

292

passfile.flush()

293

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

294

'--passphrase-file',

295

passfile.name]

296

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

301

if proc.returncode != 0:

302

raise PGPError(err)

197

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

198

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

199

try:

200

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

201

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

202

attach_fhs={'stderr': devnull})

203

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

204

f.write(data)

205

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

206

decrypted_plaintext = f.read()

207

proc.wait()

208

except IOError as e:

209

raise PGPError(e)

210

self.gnupg.passphrase = None

303

211

return decrypted_plaintext

304

212

305

213

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

332

214

class AvahiError(Exception):

333

215

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

334

216

self.value = value

335

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

336

**kwargs)

337

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

338

220

339

221

class AvahiServiceError(AvahiError):

340

222

pass

341

223

342

343

224

class AvahiGroupError(AvahiError):

344

225

pass

345

226

346

227

347

class AvahiService:

228

class AvahiService(object):

348

229

"""An Avahi (Zeroconf) service.

349

230

350

231

Attributes:

351

232

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

352

233

Used to optionally bind to the specified interface.

353

234

name: string; Example: 'Mandos'

354

235

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

355

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

236

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

356

237

port: integer; what port to announce

357

238

TXT: list of strings; TXT record for the service

358

239

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

364

245

server: D-Bus Server

365

246

bus: dbus.SystemBus()

366

247

"""

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

248

249

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

250

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

251

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

252

protocol = avahi.PROTO_UNSPEC, bus = None):

379

253

self.interface = interface

380

254

self.name = name

381

255

self.type = servicetype

390

264

self.server = None

391

265

self.bus = bus

392

266

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

267

268

def rename(self):

395

269

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

396

270

if self.rename_count >= self.max_renames:

397

271

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

398

272

" after %i retries, exiting.",

399

273

self.rename_count)

400

274

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

404

277

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

405

278

self.name)

406

if remove:

407

self.remove()

279

self.remove()

408

280

try:

409

281

self.add()

410

282

except dbus.exceptions.DBusException as error:

411

if (error.get_dbus_name()

412

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

413

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

414

return self.rename(remove=False)

415

else:

416

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

417

self.cleanup()

418

os._exit(1)

419

283

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

284

self.cleanup()

285

os._exit(1)

286

self.rename_count += 1

287

420

288

def remove(self):

421

289

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

422

290

if self.entry_group_state_changed_match is not None:

424

292

self.entry_group_state_changed_match = None

425

293

if self.group is not None:

426

294

self.group.Reset()

427

295

428

296

def add(self):

429

297

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

430

298

self.remove()

447

315

dbus.UInt16(self.port),

448

316

avahi.string_array_to_txt_array(self.TXT))

449

317

self.group.Commit()

450

318

451

319

def entry_group_state_changed(self, state, error):

452

320

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

453

321

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

454

322

455

323

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

324

logger.debug("Zeroconf service established.")

457

325

elif state == avahi.ENTRY_GROUP_COLLISION:

459

327

self.rename()

460

328

elif state == avahi.ENTRY_GROUP_FAILURE:

461

329

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

462

str(error))

463

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

464

330

unicode(error))

331

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

332

.format(error))

333

465

334

def cleanup(self):

466

335

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

467

336

if self.group is not None:

472

341

pass

473

342

self.group = None

474

343

self.remove()

475

344

476

345

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

477

346

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

478

347

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

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

348

bad_states = { avahi.SERVER_INVALID:

349

"Zeroconf server invalid",

350

avahi.SERVER_REGISTERING: None,

351

avahi.SERVER_COLLISION:

352

"Zeroconf server name collision",

353

avahi.SERVER_FAILURE:

354

"Zeroconf server failure" }

485

355

if state in bad_states:

486

356

if bad_states[state] is not None:

487

357

if error is None:

490

360

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

491

361

self.cleanup()

492

362

elif state == avahi.SERVER_RUNNING:

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

logger.info("Local Zeroconf service name"

499

" collision.")

500

return self.rename(remove=False)

501

else:

502

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

503

self.cleanup()

504

os._exit(1)

363

self.add()

505

364

else:

506

365

if error is None:

507

366

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

508

367

else:

509

368

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

510

369

511

370

def activate(self):

512

371

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

513

372

if self.server is None:

517

376

follow_name_owner_changes=True),

518

377

avahi.DBUS_INTERFACE_SERVER)

519

378

self.server.connect_to_signal("StateChanged",

520

self.server_state_changed)

379

self.server_state_changed)

521

380

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

522

381

523

382

524

383

class AvahiServiceToSyslog(AvahiService):

525

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

384

def rename(self):

526

385

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

527

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

528

**kwargs)

529

syslogger.setFormatter(logging.Formatter(

530

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

531

.format(self.name)))

386

ret = AvahiService.rename(self)

387

syslogger.setFormatter(logging.Formatter

388

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

389

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

390

.format(self.name)))

532

391

return ret

533

392

534

393

535

# Pretend that we have a GnuTLS module

536

class gnutls:

537

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

538

539

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

540

if library is None:

541

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

542

_library = ctypes.cdll.LoadLibrary(library)

543

del library

544

545

# Unless otherwise indicated, the constants and types below are

546

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

547

548

# Constants

549

E_SUCCESS = 0

550

E_INTERRUPTED = -52

551

E_AGAIN = -28

552

CRT_OPENPGP = 2

553

CRT_RAWPK = 3

554

CLIENT = 2

555

SHUT_RDWR = 0

556

CRD_CERTIFICATE = 1

557

E_NO_CERTIFICATE_FOUND = -49

558

X509_FMT_DER = 0

559

NO_TICKETS = 1<<10

560

ENABLE_RAWPK = 1<<18

561

CTYPE_PEERS = 3

562

KEYID_USE_SHA256 = 1 # gnutls/x509.h

563

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

564

565

# Types

566

class _session_int(ctypes.Structure):

567

_fields_ = []

568

session_t = ctypes.POINTER(_session_int)

569

570

class certificate_credentials_st(ctypes.Structure):

571

_fields_ = []

572

certificate_credentials_t = ctypes.POINTER(

573

certificate_credentials_st)

574

certificate_type_t = ctypes.c_int

575

576

class datum_t(ctypes.Structure):

577

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

578

('size', ctypes.c_uint)]

579

580

class _openpgp_crt_int(ctypes.Structure):

581

_fields_ = []

582

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

583

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

584

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

585

credentials_type_t = ctypes.c_int

586

transport_ptr_t = ctypes.c_void_p

587

close_request_t = ctypes.c_int

588

589

# Exceptions

590

class Error(Exception):

591

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

592

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

593

# code is passed, convert it to a string with

594

# gnutls.strerror()

595

self.code = code

596

if message is None and code is not None:

597

message = gnutls.strerror(code).decode(

598

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

599

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

600

message, *args)

601

602

class CertificateSecurityError(Error):

603

pass

604

605

class PointerTo:

606

def __init__(self, cls):

607

self.cls = cls

608

609

def from_param(self, obj):

610

if not isinstance(obj, self.cls):

611

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

612

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

613

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

614

615

class CastToVoidPointer:

616

def __init__(self, cls):

617

self.cls = cls

618

619

def from_param(self, obj):

620

if not isinstance(obj, self.cls):

621

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

622

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

623

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

624

625

class With_from_param:

626

@classmethod

627

def from_param(cls, obj):

628

return obj._as_parameter_

629

630

# Classes

631

class Credentials(With_from_param):

632

def __init__(self):

633

self._as_parameter_ = gnutls.certificate_credentials_t()

634

gnutls.certificate_allocate_credentials(self)

635

self.type = gnutls.CRD_CERTIFICATE

636

637

def __del__(self):

638

gnutls.certificate_free_credentials(self)

639

640

class ClientSession(With_from_param):

641

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

642

self._as_parameter_ = gnutls.session_t()

643

gnutls_flags = gnutls.CLIENT

644

if gnutls.check_version(b"3.5.6"):

645

gnutls_flags |= gnutls.NO_TICKETS

646

if gnutls.has_rawpk:

647

gnutls_flags |= gnutls.ENABLE_RAWPK

648

gnutls.init(self, gnutls_flags)

649

del gnutls_flags

650

gnutls.set_default_priority(self)

651

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

652

gnutls.handshake_set_private_extensions(self, True)

653

self.socket = socket

654

if credentials is None:

655

credentials = gnutls.Credentials()

656

gnutls.credentials_set(self, credentials.type,

657

credentials)

658

self.credentials = credentials

659

660

def __del__(self):

661

gnutls.deinit(self)

662

663

def handshake(self):

664

return gnutls.handshake(self)

665

666

def send(self, data):

667

data = bytes(data)

668

data_len = len(data)

669

while data_len > 0:

670

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

671

data_len)

672

673

def bye(self):

674

return gnutls.bye(self, gnutls.SHUT_RDWR)

675

676

# Error handling functions

677

def _error_code(result):

678

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

679

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

680

if result >= gnutls.E_SUCCESS:

681

return result

682

if result == gnutls.E_NO_CERTIFICATE_FOUND:

683

raise gnutls.CertificateSecurityError(code=result)

684

raise gnutls.Error(code=result)

685

686

def _retry_on_error(result, func, arguments,

687

_error_code=_error_code):

688

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

689

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

690

while result < gnutls.E_SUCCESS:

691

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

692

return _error_code(result)

693

result = func(*arguments)

694

return result

695

696

# Unless otherwise indicated, the function declarations below are

697

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

698

699

# Functions

700

priority_set_direct = _library.gnutls_priority_set_direct

701

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

702

ctypes.POINTER(ctypes.c_char_p)]

703

priority_set_direct.restype = _error_code

704

705

init = _library.gnutls_init

706

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

707

init.restype = _error_code

708

709

set_default_priority = _library.gnutls_set_default_priority

710

set_default_priority.argtypes = [ClientSession]

711

set_default_priority.restype = _error_code

712

713

record_send = _library.gnutls_record_send

714

record_send.argtypes = [ClientSession, ctypes.c_void_p,

715

ctypes.c_size_t]

716

record_send.restype = ctypes.c_ssize_t

717

record_send.errcheck = _retry_on_error

718

719

certificate_allocate_credentials = (

720

_library.gnutls_certificate_allocate_credentials)

721

certificate_allocate_credentials.argtypes = [

722

PointerTo(Credentials)]

723

certificate_allocate_credentials.restype = _error_code

724

725

certificate_free_credentials = (

726

_library.gnutls_certificate_free_credentials)

727

certificate_free_credentials.argtypes = [Credentials]

728

certificate_free_credentials.restype = None

729

730

handshake_set_private_extensions = (

731

_library.gnutls_handshake_set_private_extensions)

732

handshake_set_private_extensions.argtypes = [ClientSession,

733

ctypes.c_int]

734

handshake_set_private_extensions.restype = None

735

736

credentials_set = _library.gnutls_credentials_set

737

credentials_set.argtypes = [ClientSession, credentials_type_t,

738

CastToVoidPointer(Credentials)]

739

credentials_set.restype = _error_code

740

741

strerror = _library.gnutls_strerror

742

strerror.argtypes = [ctypes.c_int]

743

strerror.restype = ctypes.c_char_p

744

745

certificate_type_get = _library.gnutls_certificate_type_get

746

certificate_type_get.argtypes = [ClientSession]

747

certificate_type_get.restype = _error_code

748

749

certificate_get_peers = _library.gnutls_certificate_get_peers

750

certificate_get_peers.argtypes = [ClientSession,

751

ctypes.POINTER(ctypes.c_uint)]

752

certificate_get_peers.restype = ctypes.POINTER(datum_t)

753

754

global_set_log_level = _library.gnutls_global_set_log_level

755

global_set_log_level.argtypes = [ctypes.c_int]

756

global_set_log_level.restype = None

757

758

global_set_log_function = _library.gnutls_global_set_log_function

759

global_set_log_function.argtypes = [log_func]

760

global_set_log_function.restype = None

761

762

deinit = _library.gnutls_deinit

763

deinit.argtypes = [ClientSession]

764

deinit.restype = None

765

766

handshake = _library.gnutls_handshake

767

handshake.argtypes = [ClientSession]

768

handshake.restype = ctypes.c_int

769

handshake.errcheck = _retry_on_error

770

771

transport_set_ptr = _library.gnutls_transport_set_ptr

772

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

773

transport_set_ptr.restype = None

774

775

bye = _library.gnutls_bye

776

bye.argtypes = [ClientSession, close_request_t]

777

bye.restype = ctypes.c_int

778

bye.errcheck = _retry_on_error

779

780

check_version = _library.gnutls_check_version

781

check_version.argtypes = [ctypes.c_char_p]

782

check_version.restype = ctypes.c_char_p

783

784

_need_version = b"3.3.0"

785

if check_version(_need_version) is None:

786

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

787

.format(_need_version))

788

789

_tls_rawpk_version = b"3.6.6"

790

has_rawpk = bool(check_version(_tls_rawpk_version))

791

792

if has_rawpk:

793

# Types

794

class pubkey_st(ctypes.Structure):

795

_fields = []

796

pubkey_t = ctypes.POINTER(pubkey_st)

797

798

x509_crt_fmt_t = ctypes.c_int

799

800

# All the function declarations below are from

801

# gnutls/abstract.h

802

pubkey_init = _library.gnutls_pubkey_init

803

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

804

pubkey_init.restype = _error_code

805

806

pubkey_import = _library.gnutls_pubkey_import

807

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

808

x509_crt_fmt_t]

809

pubkey_import.restype = _error_code

810

811

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

812

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

813

ctypes.POINTER(ctypes.c_ubyte),

814

ctypes.POINTER(ctypes.c_size_t)]

815

pubkey_get_key_id.restype = _error_code

816

817

pubkey_deinit = _library.gnutls_pubkey_deinit

818

pubkey_deinit.argtypes = [pubkey_t]

819

pubkey_deinit.restype = None

820

else:

821

# All the function declarations below are from

822

# gnutls/openpgp.h

823

824

openpgp_crt_init = _library.gnutls_openpgp_crt_init

825

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

826

openpgp_crt_init.restype = _error_code

827

828

openpgp_crt_import = _library.gnutls_openpgp_crt_import

829

openpgp_crt_import.argtypes = [openpgp_crt_t,

830

ctypes.POINTER(datum_t),

831

openpgp_crt_fmt_t]

832

openpgp_crt_import.restype = _error_code

833

834

openpgp_crt_verify_self = \

835

_library.gnutls_openpgp_crt_verify_self

836

openpgp_crt_verify_self.argtypes = [

837

openpgp_crt_t,

838

ctypes.c_uint,

839

ctypes.POINTER(ctypes.c_uint),

840

]

841

openpgp_crt_verify_self.restype = _error_code

842

843

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

844

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

845

openpgp_crt_deinit.restype = None

846

847

openpgp_crt_get_fingerprint = (

848

_library.gnutls_openpgp_crt_get_fingerprint)

849

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

850

ctypes.c_void_p,

851

ctypes.POINTER(

852

ctypes.c_size_t)]

853

openpgp_crt_get_fingerprint.restype = _error_code

854

855

if check_version(b"3.6.4"):

856

certificate_type_get2 = _library.gnutls_certificate_type_get2

857

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

858

certificate_type_get2.restype = _error_code

859

860

# Remove non-public functions

861

del _error_code, _retry_on_error

862

863

864

def call_pipe(connection, # : multiprocessing.Connection

865

func, *args, **kwargs):

866

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

867

868

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

869

return value on the provided multiprocessing.Connection.

870

"""

871

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

872

connection.close()

873

874

875

class Client:

394

def timedelta_to_milliseconds(td):

395

"Convert a datetime.timedelta() to milliseconds"

396

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

397

+ (td.seconds * 1000)

398

+ (td.microseconds // 1000))

399

400

401

class Client(object):

876

402

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

877

403

878

404

Attributes:

879

405

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

880

406

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

881

407

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

882

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

883

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

884

running.

885

checker_callback_tag: a GLib event source tag, or None

408

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

409

to see if the client lives.

410

'None' if no process is running.

411

checker_callback_tag: a gobject event source tag, or None

886

412

checker_command: string; External command which is run to check

887

413

if client lives. %() expansions are done at

888

414

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

889

415

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

890

checker_initiator_tag: a GLib event source tag, or None

416

checker_initiator_tag: a gobject event source tag, or None

891

417

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

892

418

client_structure: Object describing what attributes a client has

893

419

and is used for storing the client at exit

894

420

current_checker_command: string; current running checker_command

895

disable_initiator_tag: a GLib event source tag, or None

421

disable_initiator_tag: a gobject event source tag, or None

896

422

enabled: bool()

897

423

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

898

uniquely identify an OpenPGP client

899

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

900

a client using raw public keys

424

uniquely identify the client

901

425

host: string; available for use by the checker command

902

426

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

903

427

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

905

429

last_checker_status: integer between 0 and 255 reflecting exit

906

430

status of last checker. -1 reflects crashed

907

431

checker, -2 means no checker completed yet.

908

last_checker_signal: The signal which killed the last checker, if

909

last_checker_status is -1

910

432

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

911

433

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

912

434

D-Bus identifiers

917

439

runtime_expansions: Allowed attributes for runtime expansion.

918

440

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

919

441

disabled, or None

920

server_settings: The server_settings dict from main()

921

442

"""

922

443

923

444

runtime_expansions = ("approval_delay", "approval_duration",

924

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

445

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

925

446

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

926

447

"last_approval_request", "last_checked_ok",

927

448

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

928

client_defaults = {

929

"timeout": "PT5M",

930

"extended_timeout": "PT15M",

931

"interval": "PT2M",

932

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

933

"host": "",

934

"approval_delay": "PT0S",

935

"approval_duration": "PT1S",

936

"approved_by_default": "True",

937

"enabled": "True",

938

}

939

449

client_defaults = { "timeout": "5m",

450

"extended_timeout": "15m",

451

"interval": "2m",

452

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

453

"host": "",

454

"approval_delay": "0s",

455

"approval_duration": "1s",

456

"approved_by_default": "True",

457

"enabled": "True",

458

}

459

460

def timeout_milliseconds(self):

461

"Return the 'timeout' attribute in milliseconds"

462

return timedelta_to_milliseconds(self.timeout)

463

464

def extended_timeout_milliseconds(self):

465

"Return the 'extended_timeout' attribute in milliseconds"

466

return timedelta_to_milliseconds(self.extended_timeout)

467

468

def interval_milliseconds(self):

469

"Return the 'interval' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.interval)

471

472

def approval_delay_milliseconds(self):

473

return timedelta_to_milliseconds(self.approval_delay)

474

940

475

@staticmethod

941

476

def config_parser(config):

942

477

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

949

484

for client_name in config.sections():

950

485

section = dict(config.items(client_name))

951

486

client = settings[client_name] = {}

952

487

953

488

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

954

489

# Reformat values from string types to Python types

955

490

client["approved_by_default"] = config.getboolean(

956

491

client_name, "approved_by_default")

957

492

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

958

493

"enabled")

959

960

# Uppercase and remove spaces from key_id and fingerprint

961

# for later comparison purposes with return value from the

962

# key_id() and fingerprint() functions

963

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

964

.replace(" ", ""))

494

965

495

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

966

496

.replace(" ", ""))

967

497

if "secret" in section:

968

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

969

.encode("utf-8"),

970

"base64")

498

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

971

499

elif "secfile" in section:

972

500

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

973

501

(section["secfile"])),

974

502

"rb") as secfile:

975

503

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

976

504

else:

977

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

505

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

978

506

.format(section))

979

507

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

980

508

client["extended_timeout"] = string_to_delta(

988

516

client["last_approval_request"] = None

989

517

client["last_checked_ok"] = None

990

518

client["last_checker_status"] = -2

991

519

992

520

return settings

993

994

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

521

522

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

995

523

self.name = name

996

if server_settings is None:

997

server_settings = {}

998

self.server_settings = server_settings

999

524

# adding all client settings

1000

for setting, value in settings.items():

525

for setting, value in settings.iteritems():

1001

526

setattr(self, setting, value)

1002

527

1003

528

if self.enabled:

1004

529

if not hasattr(self, "last_enabled"):

1005

530

self.last_enabled = datetime.datetime.utcnow()

1009

534

else:

1010

535

self.last_enabled = None

1011

536

self.expires = None

1012

537

1013

538

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

1014

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

539

# Uppercase and remove spaces from fingerprint for later

540

# comparison purposes with return value from the fingerprint()

541

# function

1015

542

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

1016

543

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

1017

544

datetime.datetime.utcnow())

1018

545

1019

546

# attributes specific for this server instance

1020

547

self.checker = None

1021

548

self.checker_initiator_tag = None

1024

551

self.current_checker_command = None

1025

552

self.approved = None

1026

553

self.approvals_pending = 0

1027

self.changedstate = multiprocessing_manager.Condition(

1028

multiprocessing_manager.Lock())

1029

self.client_structure = [attr

1030

for attr in self.__dict__.keys()

554

self.changedstate = (multiprocessing_manager

555

.Condition(multiprocessing_manager

556

.Lock()))

557

self.client_structure = [attr for attr in

558

self.__dict__.iterkeys()

1031

559

if not attr.startswith("_")]

1032

560

self.client_structure.append("client_structure")

1033

1034

for name, t in inspect.getmembers(

1035

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

561

562

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

563

lambda obj:

564

isinstance(obj,

565

property)):

1036

566

if not name.startswith("_"):

1037

567

self.client_structure.append(name)

1038

568

1039

569

# Send notice to process children that client state has changed

1040

570

def send_changedstate(self):

1041

571

with self.changedstate:

1042

572

self.changedstate.notify_all()

1043

573

1044

574

def enable(self):

1045

575

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

1046

576

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

1051

581

self.last_enabled = datetime.datetime.utcnow()

1052

582

self.init_checker()

1053

583

self.send_changedstate()

1054

584

1055

585

def disable(self, quiet=True):

1056

586

"""Disable this client."""

1057

587

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

1059

589

if not quiet:

1060

590

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

1061

591

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

1062

GLib.source_remove(self.disable_initiator_tag)

592

gobject.source_remove(self.disable_initiator_tag)

1063

593

self.disable_initiator_tag = None

1064

594

self.expires = None

1065

595

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

1066

GLib.source_remove(self.checker_initiator_tag)

596

gobject.source_remove(self.checker_initiator_tag)

1067

597

self.checker_initiator_tag = None

1068

598

self.stop_checker()

1069

599

self.enabled = False

1070

600

if not quiet:

1071

601

self.send_changedstate()

1072

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

602

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

1073

603

return False

1074

604

1075

605

def __del__(self):

1076

606

self.disable()

1077

607

1078

608

def init_checker(self):

1079

609

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

1080

610

# and every interval from then on.

1081

611

if self.checker_initiator_tag is not None:

1082

GLib.source_remove(self.checker_initiator_tag)

1083

self.checker_initiator_tag = GLib.timeout_add(

1084

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

1085

+ 1)),

1086

self.start_checker)

612

gobject.source_remove(self.checker_initiator_tag)

613

self.checker_initiator_tag = (gobject.timeout_add

614

(self.interval_milliseconds(),

615

self.start_checker))

1087

616

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

1088

617

if self.disable_initiator_tag is not None:

1089

GLib.source_remove(self.disable_initiator_tag)

1090

self.disable_initiator_tag = GLib.timeout_add(

1091

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

618

gobject.source_remove(self.disable_initiator_tag)

619

self.disable_initiator_tag = (gobject.timeout_add

620

(self.timeout_milliseconds(),

621

self.disable))

1092

622

# Also start a new checker *right now*.

1093

623

self.start_checker()

1094

1095

def checker_callback(self, source, condition, connection,

1096

command):

624

625

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

1097

626

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

1098

# Read return code from connection (see call_pipe)

1099

returncode = connection.recv()

1100

connection.close()

1101

if self.checker is not None:

1102

self.checker.join()

1103

627

self.checker_callback_tag = None

1104

628

self.checker = None

1105

1106

if returncode >= 0:

1107

self.last_checker_status = returncode

1108

self.last_checker_signal = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1109

631

if self.last_checker_status == 0:

1110

632

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

1111

633

vars(self))

1112

634

self.checked_ok()

1113

635

else:

1114

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

636

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

637

vars(self))

1115

638

else:

1116

639

self.last_checker_status = -1

1117

self.last_checker_signal = -returncode

1118

640

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

1119

641

vars(self))

1120

return False

1121

642

1122

643

def checked_ok(self):

1123

644

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

1124

645

self.last_checked_ok = datetime.datetime.utcnow()

1125

646

self.last_checker_status = 0

1126

self.last_checker_signal = None

1127

647

self.bump_timeout()

1128

648

1129

649

def bump_timeout(self, timeout=None):

1130

650

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

1131

651

if timeout is None:

1132

652

timeout = self.timeout

1133

653

if self.disable_initiator_tag is not None:

1134

GLib.source_remove(self.disable_initiator_tag)

654

gobject.source_remove(self.disable_initiator_tag)

1135

655

self.disable_initiator_tag = None

1136

656

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

1137

self.disable_initiator_tag = GLib.timeout_add(

1138

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(timedelta_to_milliseconds

659

(timeout), self.disable))

1139

660

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

1140

661

1141

662

def need_approval(self):

1142

663

self.last_approval_request = datetime.datetime.utcnow()

1143

664

1144

665

def start_checker(self):

1145

666

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

1146

667

1147

668

If a checker already exists, leave it running and do

1148

669

nothing."""

1149

670

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

1154

675

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

1155

676

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

1156

677

# should be.

1157

1158

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

1159

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

1160

self.checker.join()

1161

self.checker = None

678

679

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

680

try:

681

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

682

except (AttributeError, OSError) as error:

683

if (isinstance(error, OSError)

684

and error.errno != errno.ECHILD):

685

raise error

686

else:

687

if pid:

688

logger.warning("Checker was a zombie")

689

gobject.source_remove(self.checker_callback_tag)

690

self.checker_callback(pid, status,

691

self.current_checker_command)

1162

692

# Start a new checker if needed

1163

693

if self.checker is None:

1164

694

# Escape attributes for the shell

1165

escaped_attrs = {

1166

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

1167

for attr in self.runtime_expansions}

695

escaped_attrs = dict(

696

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

697

for attr in

698

self.runtime_expansions)

1168

699

try:

1169

700

command = self.checker_command % escaped_attrs

1170

701

except TypeError as error:

1171

702

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

1172

self.checker_command,

703

self.checker_command, exc_info=error)

704

return True # Try again later

705

self.current_checker_command = command

706

try:

707

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

708

command, self.name)

709

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

710

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

711

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

712

# always replaced by /dev/null.)

713

self.checker = subprocess.Popen(command,

714

close_fds=True,

715

shell=True, cwd="/")

716

except OSError as error:

717

logger.error("Failed to start subprocess",

1173

718

exc_info=error)

1174

return True # Try again later

1175

self.current_checker_command = command

1176

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

1177

self.name)

1178

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

1179

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

1180

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

1181

# always replaced by /dev/null.)

1182

# The exception is when not debugging but nevertheless

1183

# running in the foreground; use the previously

1184

# created wnull.

1185

popen_args = {"close_fds": True,

1186

"shell": True,

1187

"cwd": "/"}

1188

if (not self.server_settings["debug"]

1189

and self.server_settings["foreground"]):

1190

popen_args.update({"stdout": wnull,

1191

"stderr": wnull})

1192

pipe = multiprocessing.Pipe(duplex=False)

1193

self.checker = multiprocessing.Process(

1194

target=call_pipe,

1195

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

1196

kwargs=popen_args)

1197

self.checker.start()

1198

self.checker_callback_tag = GLib.io_add_watch(

1199

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

1200

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1201

self.checker_callback, pipe[0], command)

1202

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

719

self.checker_callback_tag = (gobject.child_watch_add

720

(self.checker.pid,

721

self.checker_callback,

722

data=command))

723

# The checker may have completed before the gobject

724

# watch was added. Check for this.

725

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

726

if pid:

727

gobject.source_remove(self.checker_callback_tag)

728

self.checker_callback(pid, status, command)

729

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

1203

730

return True

1204

731

1205

732

def stop_checker(self):

1206

733

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

1207

734

if self.checker_callback_tag:

1208

GLib.source_remove(self.checker_callback_tag)

735

gobject.source_remove(self.checker_callback_tag)

1209

736

self.checker_callback_tag = None

1210

737

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

1211

738

return

1212

739

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

1213

self.checker.terminate()

740

try:

741

self.checker.terminate()

742

#time.sleep(0.5)

743

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

744

# self.checker.kill()

745

except OSError as error:

746

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

747

raise

1214

748

self.checker = None

1215

749

1216

750

1217

def dbus_service_property(dbus_interface,

1218

signature="v",

1219

access="readwrite",

1220

byte_arrays=False):

751

def dbus_service_property(dbus_interface, signature="v",

752

access="readwrite", byte_arrays=False):

1221

753

"""Decorators for marking methods of a DBusObjectWithProperties to

1222

754

become properties on the D-Bus.

1223

755

1224

756

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

1225

757

and with one argument by "Set".

1226

758

1227

759

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

1228

760

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

1229

761

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

1232

764

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

1233

765

if byte_arrays and signature != "ay":

1234

766

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

1235

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

1236

767

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

1237

768

def decorator(func):

1238

769

func._dbus_is_property = True

1239

770

func._dbus_interface = dbus_interface

1242

773

func._dbus_name = func.__name__

1243

774

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

1244

775

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

1245

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

776

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1246

777

return func

1247

1248

778

return decorator

1249

779

1250

780

1251

781

def dbus_interface_annotations(dbus_interface):

1252

782

"""Decorator for marking functions returning interface annotations

1253

783

1254

784

Usage:

1255

785

1256

786

@dbus_interface_annotations("org.example.Interface")

1257

787

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

1258

788

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

1259

789

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

1260

790

"false"}

1261

791

"""

1262

1263

792

def decorator(func):

1264

793

func._dbus_is_interface = True

1265

794

func._dbus_interface = dbus_interface

1266

795

func._dbus_name = dbus_interface

1267

796

return func

1268

1269

797

return decorator

1270

798

1271

799

1272

800

def dbus_annotations(annotations):

1273

801

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

1274

802

Usage:

1275

1276

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

1277

"org.freedesktop.DBus.Property."

1278

"EmitsChangedSignal": "false"})

803

1279

804

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

1280

805

access="r")

806

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

807

"org.freedesktop.DBus.Property."

808

"EmitsChangedSignal": "false"})

1281

809

def Property_dbus_property(self):

1282

810

return dbus.Boolean(False)

1283

1284

See also the DBusObjectWithAnnotations class.

1285

811

"""

1286

1287

812

def decorator(func):

1288

813

func._dbus_annotations = annotations

1289

814

return func

1290

1291

815

return decorator

1292

816

1293

817

1294

818

class DBusPropertyException(dbus.exceptions.DBusException):

1295

819

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

1296

820

"""

1297

pass

821

def __unicode__(self):

822

return unicode(str(self))

1298

823

1299

824

1300

825

class DBusPropertyAccessException(DBusPropertyException):

1309

834

pass

1310

835

1311

836

1312

class DBusObjectWithAnnotations(dbus.service.Object):

1313

"""A D-Bus object with annotations.

1314

1315

Classes inheriting from this can use the dbus_annotations

1316

decorator to add annotations to methods or signals.

837

class DBusObjectWithProperties(dbus.service.Object):

838

"""A D-Bus object with properties.

839

840

Classes inheriting from this can use the dbus_service_property

841

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

842

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

1317

843

"""

1318

844

1319

845

@staticmethod

1320

846

def _is_dbus_thing(thing):

1321

847

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

1322

848

1323

849

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

1324

850

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

1325

851

"""

1326

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

852

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

1327

853

False)

1328

854

1329

855

def _get_all_dbus_things(self, thing):

1330

856

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

1331

857

"""

1332

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

858

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

859

name),

1333

860

athing.__get__(self))

1334

861

for cls in self.__class__.__mro__

1335

862

for name, athing in

1336

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

1337

1338

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1339

out_signature="s",

1340

path_keyword='object_path',

1341

connection_keyword='connection')

1342

def Introspect(self, object_path, connection):

1343

"""Overloading of standard D-Bus method.

1344

1345

Inserts annotation tags on methods and signals.

1346

"""

1347

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

1348

connection)

1349

try:

1350

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

1351

1352

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

1353

# Add annotation tags

1354

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

1355

for tag in if_tag.getElementsByTagName(typ):

1356

annots = dict()

1357

for name, prop in (self.

1358

_get_all_dbus_things(typ)):

1359

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

1360

and prop._dbus_interface

1361

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

1362

annots.update(getattr(

1363

prop, "_dbus_annotations", {}))

1364

for name, value in annots.items():

1365

ann_tag = document.createElement(

1366

"annotation")

1367

ann_tag.setAttribute("name", name)

1368

ann_tag.setAttribute("value", value)

1369

tag.appendChild(ann_tag)

1370

# Add interface annotation tags

1371

for annotation, value in dict(

1372

itertools.chain.from_iterable(

1373

annotations().items()

1374

for name, annotations

1375

in self._get_all_dbus_things("interface")

1376

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

1377

)).items():

1378

ann_tag = document.createElement("annotation")

1379

ann_tag.setAttribute("name", annotation)

1380

ann_tag.setAttribute("value", value)

1381

if_tag.appendChild(ann_tag)

1382

# Fix argument name for the Introspect method itself

1383

if (if_tag.getAttribute("name")

1384

== dbus.INTROSPECTABLE_IFACE):

1385

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

1386

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

1387

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

1388

if (arg.getAttribute("direction")

1389

== "out"):

1390

arg.setAttribute("name",

1391

"xml_data")

1392

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

1393

document.unlink()

1394

except (AttributeError, xml.dom.DOMException,

1395

xml.parsers.expat.ExpatError) as error:

1396

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

1397

exc_info=error)

1398

return xmlstring

1399

1400

1401

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1402

"""A D-Bus object with properties.

1403

1404

Classes inheriting from this can use the dbus_service_property

1405

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

1406

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

1407

"""

1408

863

inspect.getmembers(cls,

864

self._is_dbus_thing(thing)))

865

1409

866

def _get_dbus_property(self, interface_name, property_name):

1410

867

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

1411

868

property with the specified name and interface.

1412

869

"""

1413

for cls in self.__class__.__mro__:

1414

for name, value in inspect.getmembers(

1415

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

870

for cls in self.__class__.__mro__:

871

for name, value in (inspect.getmembers

872

(cls,

873

self._is_dbus_thing("property"))):

1416

874

if (value._dbus_name == property_name

1417

875

and value._dbus_interface == interface_name):

1418

876

return value.__get__(self)

1419

877

1420

878

# No such property

1421

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

1422

self.dbus_object_path, interface_name, property_name))

1423

1424

@classmethod

1425

def _get_all_interface_names(cls):

1426

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

1427

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

1428

"_dbus_interface", None)

1429

for x in (inspect.getmro(cls))

1430

for attr in dir(x))

1431

if name is not None)

1432

1433

@dbus.service.method(dbus.PROPERTIES_IFACE,

1434

in_signature="ss",

879

raise DBusPropertyNotFound(self.dbus_object_path + ":"

880

+ interface_name + "."

881

+ property_name)

882

883

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

1435

884

out_signature="v")

1436

885

def Get(self, interface_name, property_name):

1437

886

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

1443

892

if not hasattr(value, "variant_level"):

1444

893

return value

1445

894

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

1446

895

1447

896

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

1448

897

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

1449

898

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

1455

904

# The byte_arrays option is not supported yet on

1456

905

# signatures other than "ay".

1457

906

if prop._dbus_signature != "ay":

1458

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

1459

"'ay' signature {!r}"

1460

.format(prop._dbus_signature))

1461

value = dbus.ByteArray(bytes(value))

907

raise ValueError

908

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

909

for byte in value))

1462

910

prop(value)

1463

1464

@dbus.service.method(dbus.PROPERTIES_IFACE,

1465

in_signature="s",

911

912

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

1466

913

out_signature="a{sv}")

1467

914

def GetAll(self, interface_name):

1468

915

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

1469

916

standard.

1470

917

1471

918

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

1472

919

"""

1473

920

properties = {}

1483

930

if not hasattr(value, "variant_level"):

1484

931

properties[name] = value

1485

932

continue

1486

properties[name] = type(value)(

1487

value, variant_level=value.variant_level + 1)

933

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

934

value.variant_level+1)

1488

935

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

1489

1490

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

1491

def PropertiesChanged(self, interface_name, changed_properties,

1492

invalidated_properties):

1493

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

1494

standard.

1495

"""

1496

pass

1497

936

1498

937

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1499

938

out_signature="s",

1500

939

path_keyword='object_path',

1501

940

connection_keyword='connection')

1502

941

def Introspect(self, object_path, connection):

1503

942

"""Overloading of standard D-Bus method.

1504

943

1505

944

Inserts property tags and interface annotation tags.

1506

945

"""

1507

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1508

object_path,

1509

connection)

946

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

947

connection)

1510

948

try:

1511

949

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

1512

1513

950

def make_tag(document, name, prop):

1514

951

e = document.createElement("property")

1515

952

e.setAttribute("name", name)

1516

953

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

1517

954

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

1518

955

return e

1519

1520

956

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

1521

957

# Add property tags

1522

958

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

1525

961

if prop._dbus_interface

1526

962

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

1527

963

if_tag.appendChild(tag)

1528

# Add annotation tags for properties

1529

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

1530

annots = dict()

1531

for name, prop in self._get_all_dbus_things(

1532

"property"):

1533

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

1534

and prop._dbus_interface

1535

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

1536

annots.update(getattr(

1537

prop, "_dbus_annotations", {}))

1538

for name, value in annots.items():

1539

ann_tag = document.createElement(

1540

"annotation")

1541

ann_tag.setAttribute("name", name)

1542

ann_tag.setAttribute("value", value)

1543

tag.appendChild(ann_tag)

964

# Add annotation tags

965

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

966

for tag in if_tag.getElementsByTagName(typ):

967

annots = dict()

968

for name, prop in (self.

969

_get_all_dbus_things(typ)):

970

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

971

and prop._dbus_interface

972

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

973

annots.update(getattr

974

(prop,

975

"_dbus_annotations",

976

{}))

977

for name, value in annots.iteritems():

978

ann_tag = document.createElement(

979

"annotation")

980

ann_tag.setAttribute("name", name)

981

ann_tag.setAttribute("value", value)

982

tag.appendChild(ann_tag)

983

# Add interface annotation tags

984

for annotation, value in dict(

985

itertools.chain.from_iterable(

986

annotations().iteritems()

987

for name, annotations in

988

self._get_all_dbus_things("interface")

989

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

990

)).iteritems():

991

ann_tag = document.createElement("annotation")

992

ann_tag.setAttribute("name", annotation)

993

ann_tag.setAttribute("value", value)

994

if_tag.appendChild(ann_tag)

1544

995

# Add the names to the return values for the

1545

996

# "org.freedesktop.DBus.Properties" methods

1546

997

if (if_tag.getAttribute("name")

1565

1016

return xmlstring

1566

1017

1567

1018

1568

try:

1569

dbus.OBJECT_MANAGER_IFACE

1570

except AttributeError:

1571

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

1572

1573

1574

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1575

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

1576

1577

Classes inheriting from this exposes the standard

1578

GetManagedObjects call and the InterfacesAdded and

1579

InterfacesRemoved signals on the standard

1580

"org.freedesktop.DBus.ObjectManager" interface.

1581

1582

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

1583

manually.

1584

"""

1585

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1586

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

1587

def GetManagedObjects(self):

1588

"""This function must be overridden"""

1589

raise NotImplementedError()

1590

1591

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1592

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

1593

def InterfacesAdded(self, object_path, interfaces_and_properties):

1594

pass

1595

1596

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

1597

def InterfacesRemoved(self, object_path, interfaces):

1598

pass

1599

1600

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1601

out_signature="s",

1602

path_keyword='object_path',

1603

connection_keyword='connection')

1604

def Introspect(self, object_path, connection):

1605

"""Overloading of standard D-Bus method.

1606

1607

Override return argument name of GetManagedObjects to be

1608

"objpath_interfaces_and_properties"

1609

"""

1610

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1611

object_path,

1612

connection)

1613

try:

1614

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

1615

1616

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

1617

# Fix argument name for the GetManagedObjects method

1618

if (if_tag.getAttribute("name")

1619

== dbus.OBJECT_MANAGER_IFACE):

1620

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

1621

if (cn.getAttribute("name")

1622

== "GetManagedObjects"):

1623

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

1624

if (arg.getAttribute("direction")

1625

== "out"):

1626

arg.setAttribute(

1627

"name",

1628

"objpath_interfaces"

1629

"_and_properties")

1630

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

1631

document.unlink()

1632

except (AttributeError, xml.dom.DOMException,

1633

xml.parsers.expat.ExpatError) as error:

1634

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

1635

exc_info=error)

1636

return xmlstring

1637

1638

1639

1019

def datetime_to_dbus(dt, variant_level=0):

1640

1020

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

1641

1021

if dt is None:

1642

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

1643

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

1022

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

1023

return dbus.String(dt.isoformat(),

1024

variant_level=variant_level)

1644

1025

1645

1026

1646

1027

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1648

1029

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

1649

1030

interface names according to the "alt_interface_names" mapping.

1650

1031

Usage:

1651

1032

1652

1033

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

1653

1034

"net.example.AlternateInterface"})

1654

1035

class SampleDBusObject(dbus.service.Object):

1655

1036

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

1656

1037

def SampleDBusMethod():

1657

1038

pass

1658

1039

1659

1040

The above "SampleDBusMethod" on "SampleDBusObject" will be

1660

1041

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

1661

1042

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

1662

1043

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

1663

1044

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

1664

1045

1665

1046

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

1666

1047

(from DBusObjectWithProperties) and interfaces (from the

1667

1048

dbus_interface_annotations decorator).

1668

1049

"""

1669

1670

1050

def wrapper(cls):

1671

1051

for orig_interface_name, alt_interface_name in (

1672

alt_interface_names.items()):

1052

alt_interface_names.iteritems()):

1673

1053

attr = {}

1674

1054

interface_names = set()

1675

1055

# Go though all attributes of the class

1677

1057

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

1678

1058

# with the wrong interface name

1679

1059

if (not hasattr(attribute, "_dbus_interface")

1680

or not attribute._dbus_interface.startswith(

1681

orig_interface_name)):

1060

or not attribute._dbus_interface

1061

.startswith(orig_interface_name)):

1682

1062

continue

1683

1063

# Create an alternate D-Bus interface name based on

1684

1064

# the current name

1685

alt_interface = attribute._dbus_interface.replace(

1686

orig_interface_name, alt_interface_name)

1065

alt_interface = (attribute._dbus_interface

1066

.replace(orig_interface_name,

1067

alt_interface_name))

1687

1068

interface_names.add(alt_interface)

1688

1069

# Is this a D-Bus signal?

1689

1070

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

1690

# Extract the original non-method undecorated

1691

# function by black magic

1692

if sys.version_info.major == 2:

1693

nonmethod_func = (dict(

1071

# Extract the original non-method function by

1072

# black magic

1073

nonmethod_func = (dict(

1694

1074

zip(attribute.func_code.co_freevars,

1695

attribute.__closure__))

1696

["func"].cell_contents)

1697

else:

1698

nonmethod_func = (dict(

1699

zip(attribute.__code__.co_freevars,

1700

attribute.__closure__))

1701

["func"].cell_contents)

1075

attribute.__closure__))["func"]

1076

.cell_contents)

1702

1077

# Create a new, but exactly alike, function

1703

1078

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

1704

1079

# with the alternate D-Bus interface name

1705

new_function = copy_function(nonmethod_func)

1706

new_function = (dbus.service.signal(

1707

alt_interface,

1708

attribute._dbus_signature)(new_function))

1080

new_function = (dbus.service.signal

1081

(alt_interface,

1082

attribute._dbus_signature)

1083

(types.FunctionType(

1084

nonmethod_func.func_code,

1085

nonmethod_func.func_globals,

1086

nonmethod_func.func_name,

1087

nonmethod_func.func_defaults,

1088

nonmethod_func.func_closure)))

1709

1089

# Copy annotations, if any

1710

1090

try:

1711

new_function._dbus_annotations = dict(

1712

attribute._dbus_annotations)

1091

new_function._dbus_annotations = (

1092

dict(attribute._dbus_annotations))

1713

1093

except AttributeError:

1714

1094

pass

1715

1716

1095

# Define a creator of a function to call both the

1717

1096

# original and alternate functions, so both the

1718

1097

# original and alternate signals gets sent when

1721

1100

"""This function is a scope container to pass

1722

1101

func1 and func2 to the "call_both" function

1723

1102

outside of its arguments"""

1724

1725

@functools.wraps(func2)

1726

1103

def call_both(*args, **kwargs):

1727

1104

"""This function will emit two D-Bus

1728

1105

signals by calling func1 and func2"""

1729

1106

func1(*args, **kwargs)

1730

1107

func2(*args, **kwargs)

1731

# Make wrapper function look like a D-Bus

1732

# signal

1733

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

1734

if name.startswith("_dbus_"):

1735

setattr(call_both, name, attr)

1736

1737

1108

return call_both

1738

1109

# Create the "call_both" function and add it to

1739

1110

# the class

1744

1115

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

1745

1116

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

1746

1117

# to the class.

1747

attr[attrname] = (

1748

dbus.service.method(

1749

alt_interface,

1750

attribute._dbus_in_signature,

1751

attribute._dbus_out_signature)

1752

(copy_function(attribute)))

1118

attr[attrname] = (dbus.service.method

1119

(alt_interface,

1120

attribute._dbus_in_signature,

1121

attribute._dbus_out_signature)

1122

(types.FunctionType

1123

(attribute.func_code,

1124

attribute.func_globals,

1125

attribute.func_name,

1126

attribute.func_defaults,

1127

attribute.func_closure)))

1753

1128

# Copy annotations, if any

1754

1129

try:

1755

attr[attrname]._dbus_annotations = dict(

1756

attribute._dbus_annotations)

1130

attr[attrname]._dbus_annotations = (

1131

dict(attribute._dbus_annotations))

1757

1132

except AttributeError:

1758

1133

pass

1759

1134

# Is this a D-Bus property?

1762

1137

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

1763

1138

# property with the alternate D-Bus interface

1764

1139

# name. Add it to the class.

1765

attr[attrname] = (dbus_service_property(

1766

alt_interface, attribute._dbus_signature,

1767

attribute._dbus_access,

1768

attribute._dbus_get_args_options

1769

["byte_arrays"])

1770

(copy_function(attribute)))

1140

attr[attrname] = (dbus_service_property

1141

(alt_interface,

1142

attribute._dbus_signature,

1143

attribute._dbus_access,

1144

attribute

1145

._dbus_get_args_options

1146

["byte_arrays"])

1147

(types.FunctionType

1148

(attribute.func_code,

1149

attribute.func_globals,

1150

attribute.func_name,

1151

attribute.func_defaults,

1152

attribute.func_closure)))

1771

1153

# Copy annotations, if any

1772

1154

try:

1773

attr[attrname]._dbus_annotations = dict(

1774

attribute._dbus_annotations)

1155

attr[attrname]._dbus_annotations = (

1156

dict(attribute._dbus_annotations))

1775

1157

except AttributeError:

1776

1158

pass

1777

1159

# Is this a D-Bus interface?

1780

1162

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

1781

1163

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

1782

1164

# to the class.

1783

attr[attrname] = (

1784

dbus_interface_annotations(alt_interface)

1785

(copy_function(attribute)))

1165

attr[attrname] = (dbus_interface_annotations

1166

(alt_interface)

1167

(types.FunctionType

1168

(attribute.func_code,

1169

attribute.func_globals,

1170

attribute.func_name,

1171

attribute.func_defaults,

1172

attribute.func_closure)))

1786

1173

if deprecate:

1787

1174

# Deprecate all alternate interfaces

1788

iname = "_AlternateDBusNames_interface_annotation{}"

1175

iname="_AlternateDBusNames_interface_annotation{0}"

1789

1176

for interface_name in interface_names:

1790

1791

1177

@dbus_interface_annotations(interface_name)

1792

1178

def func(self):

1793

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

1794

"true"}

1179

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

1180

"true" }

1795

1181

# Find an unused name

1796

1182

for aname in (iname.format(i)

1797

1183

for i in itertools.count()):

1801

1187

if interface_names:

1802

1188

# Replace the class with a new subclass of it with

1803

1189

# methods, signals, etc. as created above.

1804

if sys.version_info.major == 2:

1805

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

1806

(cls, ), attr)

1807

else:

1808

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

1809

(cls, ), attr)

1190

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

1191

(cls,), attr)

1810

1192

return cls

1811

1812

1193

return wrapper

1813

1194

1814

1195

1815

1196

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

1816

"se.bsnet.fukt.Mandos"})

1197

"se.bsnet.fukt.Mandos"})

1817

1198

class ClientDBus(Client, DBusObjectWithProperties):

1818

1199

"""A Client class using D-Bus

1819

1200

1820

1201

Attributes:

1821

1202

dbus_object_path: dbus.ObjectPath

1822

1203

bus: dbus.SystemBus()

1823

1204

"""

1824

1205

1825

1206

runtime_expansions = (Client.runtime_expansions

1826

+ ("dbus_object_path", ))

1827

1828

_interface = "se.recompile.Mandos.Client"

1829

1207

+ ("dbus_object_path",))

1208

1830

1209

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

1831

1832

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

1210

1211

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

1833

1212

self.bus = bus

1834

1213

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

1835

1214

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

1836

1215

# the D-Bus

1837

client_object_name = str(self.name).translate(

1216

client_object_name = unicode(self.name).translate(

1838

1217

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

1839

1218

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

1840

self.dbus_object_path = dbus.ObjectPath(

1841

"/clients/" + client_object_name)

1219

self.dbus_object_path = (dbus.ObjectPath

1220

("/clients/" + client_object_name))

1842

1221

DBusObjectWithProperties.__init__(self, self.bus,

1843

1222

self.dbus_object_path)

1844

1845

def notifychangeproperty(transform_func, dbus_name,

1846

type_func=lambda x: x,

1847

variant_level=1,

1848

invalidate_only=False,

1849

_interface=_interface):

1223

1224

def notifychangeproperty(transform_func,

1225

dbus_name, type_func=lambda x: x,

1226

variant_level=1):

1850

1227

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

1851

1228

its changes to DBus.

1852

1229

1853

1230

transform_fun: Function that takes a value and a variant_level

1854

1231

and transforms it to a D-Bus type.

1855

1232

dbus_name: D-Bus name of the variable

1857

1234

to the D-Bus. Default: no transform

1858

1235

variant_level: D-Bus variant level. Default: 1

1859

1236

"""

1860

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

1861

1237

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

1862

1238

def setter(self, value):

1863

1239

if hasattr(self, "dbus_object_path"):

1864

1240

if (not hasattr(self, attrname) or

1865

1241

type_func(getattr(self, attrname, None))

1866

1242

!= type_func(value)):

1867

if invalidate_only:

1868

self.PropertiesChanged(

1869

_interface, dbus.Dictionary(),

1870

dbus.Array((dbus_name, )))

1871

else:

1872

dbus_value = transform_func(

1873

type_func(value),

1874

variant_level=variant_level)

1875

self.PropertyChanged(dbus.String(dbus_name),

1876

dbus_value)

1877

self.PropertiesChanged(

1878

_interface,

1879

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

1880

dbus_value}),

1881

dbus.Array())

1243

dbus_value = transform_func(type_func(value),

1244

variant_level

1245

=variant_level)

1246

self.PropertyChanged(dbus.String(dbus_name),

1247

dbus_value)

1882

1248

setattr(self, attrname, value)

1883

1249

1884

1250

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

1885

1251

1886

1252

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1887

1253

approvals_pending = notifychangeproperty(dbus.Boolean,

1888

1254

"ApprovalPending",

1889

type_func=bool)

1255

type_func = bool)

1890

1256

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

1891

1257

last_enabled = notifychangeproperty(datetime_to_dbus,

1892

1258

"LastEnabled")

1893

checker = notifychangeproperty(

1894

dbus.Boolean, "CheckerRunning",

1895

type_func=lambda checker: checker is not None)

1259

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

1260

type_func = lambda checker:

1261

checker is not None)

1896

1262

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1897

1263

"LastCheckedOK")

1898

1264

last_checker_status = notifychangeproperty(dbus.Int16,

1901

1267

datetime_to_dbus, "LastApprovalRequest")

1902

1268

approved_by_default = notifychangeproperty(dbus.Boolean,

1903

1269

"ApprovedByDefault")

1904

approval_delay = notifychangeproperty(

1905

dbus.UInt64, "ApprovalDelay",

1906

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

1270

approval_delay = notifychangeproperty(dbus.UInt64,

1271

"ApprovalDelay",

1272

type_func =

1273

timedelta_to_milliseconds)

1907

1274

approval_duration = notifychangeproperty(

1908

1275

dbus.UInt64, "ApprovalDuration",

1909

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

1276

type_func = timedelta_to_milliseconds)

1910

1277

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

1911

timeout = notifychangeproperty(

1912

dbus.UInt64, "Timeout",

1913

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

1278

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

1279

type_func =

1280

timedelta_to_milliseconds)

1914

1281

extended_timeout = notifychangeproperty(

1915

1282

dbus.UInt64, "ExtendedTimeout",

1916

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

1917

interval = notifychangeproperty(

1918

dbus.UInt64, "Interval",

1919

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

1283

type_func = timedelta_to_milliseconds)

1284

interval = notifychangeproperty(dbus.UInt64,

1285

"Interval",

1286

type_func =

1287

timedelta_to_milliseconds)

1920

1288

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

1921

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

1922

invalidate_only=True)

1923

1289

1924

1290

del notifychangeproperty

1925

1291

1926

1292

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

1927

1293

try:

1928

1294

self.remove_from_connection()

1931

1297

if hasattr(DBusObjectWithProperties, "__del__"):

1932

1298

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

1933

1299

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

1934

1935

def checker_callback(self, source, condition,

1936

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

1937

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

1938

connection, command, *args,

1939

**kwargs)

1940

exitstatus = self.last_checker_status

1941

if exitstatus >= 0:

1300

1301

def checker_callback(self, pid, condition, command,

1302

*args, **kwargs):

1303

self.checker_callback_tag = None

1304

self.checker = None

1305

if os.WIFEXITED(condition):

1306

exitstatus = os.WEXITSTATUS(condition)

1942

1307

# Emit D-Bus signal

1943

1308

self.CheckerCompleted(dbus.Int16(exitstatus),

1944

# This is specific to GNU libC

1945

dbus.Int64(exitstatus << 8),

1309

dbus.Int64(condition),

1946

1310

dbus.String(command))

1947

1311

else:

1948

1312

# Emit D-Bus signal

1949

1313

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

1950

dbus.Int64(

1951

# This is specific to GNU libC

1952

(exitstatus << 8)

1953

| self.last_checker_signal),

1314

dbus.Int64(condition),

1954

1315

dbus.String(command))

1955

return ret

1956

1316

1317

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

1318

*args, **kwargs)

1319

1957

1320

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

1958

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

1321

old_checker = self.checker

1322

if self.checker is not None:

1323

old_checker_pid = self.checker.pid

1324

else:

1325

old_checker_pid = None

1959

1326

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

1960

1327

# Only if new checker process was started

1961

1328

if (self.checker is not None

1963

1330

# Emit D-Bus signal

1964

1331

self.CheckerStarted(self.current_checker_command)

1965

1332

return r

1966

1333

1967

1334

def _reset_approved(self):

1968

1335

self.approved = None

1969

1336

return False

1970

1337

1971

1338

def approve(self, value=True):

1972

1339

self.approved = value

1973

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

1974

* 1000), self._reset_approved)

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1975

1343

self.send_changedstate()

1976

1977

# D-Bus methods, signals & properties

1978

1979

# Interfaces

1980

1981

# Signals

1982

1344

1345

## D-Bus methods, signals & properties

1346

_interface = "se.recompile.Mandos.Client"

1347

1348

## Interfaces

1349

1350

@dbus_interface_annotations(_interface)

1351

def _foo(self):

1352

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

1353

"false"}

1354

1355

## Signals

1356

1983

1357

# CheckerCompleted - signal

1984

1358

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

1985

1359

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

1986

1360

"D-Bus signal"

1987

1361

pass

1988

1362

1989

1363

# CheckerStarted - signal

1990

1364

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

1991

1365

def CheckerStarted(self, command):

1992

1366

"D-Bus signal"

1993

1367

pass

1994

1368

1995

1369

# PropertyChanged - signal

1996

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

1997

1370

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

1998

1371

def PropertyChanged(self, property, value):

1999

1372

"D-Bus signal"

2000

1373

pass

2001

1374

2002

1375

# GotSecret - signal

2003

1376

@dbus.service.signal(_interface)

2004

1377

def GotSecret(self):

2007

1380

server to mandos-client

2008

1381

"""

2009

1382

pass

2010

1383

2011

1384

# Rejected - signal

2012

1385

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

2013

1386

def Rejected(self, reason):

2014

1387

"D-Bus signal"

2015

1388

pass

2016

1389

2017

1390

# NeedApproval - signal

2018

1391

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

2019

1392

def NeedApproval(self, timeout, default):

2020

1393

"D-Bus signal"

2021

1394

return self.need_approval()

2022

2023

# Methods

2024

1395

1396

## Methods

1397

2025

1398

# Approve - method

2026

1399

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

2027

1400

def Approve(self, value):

2028

1401

self.approve(value)

2029

1402

2030

1403

# CheckedOK - method

2031

1404

@dbus.service.method(_interface)

2032

1405

def CheckedOK(self):

2033

1406

self.checked_ok()

2034

1407

2035

1408

# Enable - method

2036

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

2037

1409

@dbus.service.method(_interface)

2038

1410

def Enable(self):

2039

1411

"D-Bus method"

2040

1412

self.enable()

2041

1413

2042

1414

# StartChecker - method

2043

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

2044

1415

@dbus.service.method(_interface)

2045

1416

def StartChecker(self):

2046

1417

"D-Bus method"

2047

1418

self.start_checker()

2048

1419

2049

1420

# Disable - method

2050

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

2051

1421

@dbus.service.method(_interface)

2052

1422

def Disable(self):

2053

1423

"D-Bus method"

2054

1424

self.disable()

2055

1425

2056

1426

# StopChecker - method

2057

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

2058

1427

@dbus.service.method(_interface)

2059

1428

def StopChecker(self):

2060

1429

self.stop_checker()

2061

2062

# Properties

2063

1430

1431

## Properties

1432

2064

1433

# ApprovalPending - property

2065

1434

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

2066

1435

def ApprovalPending_dbus_property(self):

2067

1436

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

2068

1437

2069

1438

# ApprovedByDefault - property

2070

@dbus_service_property(_interface,

2071

signature="b",

1439

@dbus_service_property(_interface, signature="b",

2072

1440

access="readwrite")

2073

1441

def ApprovedByDefault_dbus_property(self, value=None):

2074

1442

if value is None: # get

2075

1443

return dbus.Boolean(self.approved_by_default)

2076

1444

self.approved_by_default = bool(value)

2077

1445

2078

1446

# ApprovalDelay - property

2079

@dbus_service_property(_interface,

2080

signature="t",

1447

@dbus_service_property(_interface, signature="t",

2081

1448

access="readwrite")

2082

1449

def ApprovalDelay_dbus_property(self, value=None):

2083

1450

if value is None: # get

2084

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

2085

* 1000)

1451

return dbus.UInt64(self.approval_delay_milliseconds())

2086

1452

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

2087

1453

2088

1454

# ApprovalDuration - property

2089

@dbus_service_property(_interface,

2090

signature="t",

1455

@dbus_service_property(_interface, signature="t",

2091

1456

access="readwrite")

2092

1457

def ApprovalDuration_dbus_property(self, value=None):

2093

1458

if value is None: # get

2094

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

2095

* 1000)

1459

return dbus.UInt64(timedelta_to_milliseconds(

1460

self.approval_duration))

2096

1461

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

2097

1462

2098

1463

# Name - property

2099

@dbus_annotations(

2100

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

2101

1464

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

2102

1465

def Name_dbus_property(self):

2103

1466

return dbus.String(self.name)

2104

2105

# KeyID - property

2106

@dbus_annotations(

2107

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

2108

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

2109

def KeyID_dbus_property(self):

2110

return dbus.String(self.key_id)

2111

1467

2112

1468

# Fingerprint - property

2113

@dbus_annotations(

2114

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

2115

1469

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

2116

1470

def Fingerprint_dbus_property(self):

2117

1471

return dbus.String(self.fingerprint)

2118

1472

2119

1473

# Host - property

2120

@dbus_service_property(_interface,

2121

signature="s",

1474

@dbus_service_property(_interface, signature="s",

2122

1475

access="readwrite")

2123

1476

def Host_dbus_property(self, value=None):

2124

1477

if value is None: # get

2125

1478

return dbus.String(self.host)

2126

self.host = str(value)

2127

1479

self.host = unicode(value)

1480

2128

1481

# Created - property

2129

@dbus_annotations(

2130

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

2131

1482

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

2132

1483

def Created_dbus_property(self):

2133

1484

return datetime_to_dbus(self.created)

2134

1485

2135

1486

# LastEnabled - property

2136

1487

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

2137

1488

def LastEnabled_dbus_property(self):

2138

1489

return datetime_to_dbus(self.last_enabled)

2139

1490

2140

1491

# Enabled - property

2141

@dbus_service_property(_interface,

2142

signature="b",

1492

@dbus_service_property(_interface, signature="b",

2143

1493

access="readwrite")

2144

1494

def Enabled_dbus_property(self, value=None):

2145

1495

if value is None: # get

2148

1498

self.enable()

2149

1499

else:

2150

1500

self.disable()

2151

1501

2152

1502

# LastCheckedOK - property

2153

@dbus_service_property(_interface,

2154

signature="s",

1503

@dbus_service_property(_interface, signature="s",

2155

1504

access="readwrite")

2156

1505

def LastCheckedOK_dbus_property(self, value=None):

2157

1506

if value is not None:

2158

1507

self.checked_ok()

2159

1508

return

2160

1509

return datetime_to_dbus(self.last_checked_ok)

2161

1510

2162

1511

# LastCheckerStatus - property

2163

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

1512

@dbus_service_property(_interface, signature="n",

1513

access="read")

2164

1514

def LastCheckerStatus_dbus_property(self):

2165

1515

return dbus.Int16(self.last_checker_status)

2166

1516

2167

1517

# Expires - property

2168

1518

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

2169

1519

def Expires_dbus_property(self):

2170

1520

return datetime_to_dbus(self.expires)

2171

1521

2172

1522

# LastApprovalRequest - property

2173

1523

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

2174

1524

def LastApprovalRequest_dbus_property(self):

2175

1525

return datetime_to_dbus(self.last_approval_request)

2176

1526

2177

1527

# Timeout - property

2178

@dbus_service_property(_interface,

2179

signature="t",

1528

@dbus_service_property(_interface, signature="t",

2180

1529

access="readwrite")

2181

1530

def Timeout_dbus_property(self, value=None):

2182

1531

if value is None: # get

2183

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

1532

return dbus.UInt64(self.timeout_milliseconds())

2184

1533

old_timeout = self.timeout

2185

1534

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

2186

1535

# Reschedule disabling

2194

1543

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

2195

1544

is None):

2196

1545

return

2197

GLib.source_remove(self.disable_initiator_tag)

2198

self.disable_initiator_tag = GLib.timeout_add(

2199

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

2200

self.disable)

2201

1546

gobject.source_remove(self.disable_initiator_tag)

1547

self.disable_initiator_tag = (

1548

gobject.timeout_add(

1549

timedelta_to_milliseconds(self.expires - now),

1550

self.disable))

1551

2202

1552

# ExtendedTimeout - property

2203

@dbus_service_property(_interface,

2204

signature="t",

1553

@dbus_service_property(_interface, signature="t",

2205

1554

access="readwrite")

2206

1555

def ExtendedTimeout_dbus_property(self, value=None):

2207

1556

if value is None: # get

2208

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

2209

* 1000)

1557

return dbus.UInt64(self.extended_timeout_milliseconds())

2210

1558

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

2211

1559

2212

1560

# Interval - property

2213

@dbus_service_property(_interface,

2214

signature="t",

1561

@dbus_service_property(_interface, signature="t",

2215

1562

access="readwrite")

2216

1563

def Interval_dbus_property(self, value=None):

2217

1564

if value is None: # get

2218

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

1565

return dbus.UInt64(self.interval_milliseconds())

2219

1566

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

2220

1567

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

2221

1568

return

2222

1569

if self.enabled:

2223

1570

# Reschedule checker run

2224

GLib.source_remove(self.checker_initiator_tag)

2225

self.checker_initiator_tag = GLib.timeout_add(

2226

value, self.start_checker)

2227

self.start_checker() # Start one now, too

2228

1571

gobject.source_remove(self.checker_initiator_tag)

1572

self.checker_initiator_tag = (gobject.timeout_add

1573

(value, self.start_checker))

1574

self.start_checker() # Start one now, too

1575

2229

1576

# Checker - property

2230

@dbus_service_property(_interface,

2231

signature="s",

1577

@dbus_service_property(_interface, signature="s",

2232

1578

access="readwrite")

2233

1579

def Checker_dbus_property(self, value=None):

2234

1580

if value is None: # get

2235

1581

return dbus.String(self.checker_command)

2236

self.checker_command = str(value)

2237

1582

self.checker_command = unicode(value)

1583

2238

1584

# CheckerRunning - property

2239

@dbus_service_property(_interface,

2240

signature="b",

1585

@dbus_service_property(_interface, signature="b",

2241

1586

access="readwrite")

2242

1587

def CheckerRunning_dbus_property(self, value=None):

2243

1588

if value is None: # get

2246

1591

self.start_checker()

2247

1592

else:

2248

1593

self.stop_checker()

2249

1594

2250

1595

# ObjectPath - property

2251

@dbus_annotations(

2252

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

2253

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

2254

1596

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

2255

1597

def ObjectPath_dbus_property(self):

2256

return self.dbus_object_path # is already a dbus.ObjectPath

2257

1598

return self.dbus_object_path # is already a dbus.ObjectPath

1599

2258

1600

# Secret = property

2259

@dbus_annotations(

2260

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

2261

"invalidates"})

2262

@dbus_service_property(_interface,

2263

signature="ay",

2264

access="write",

2265

byte_arrays=True)

1601

@dbus_service_property(_interface, signature="ay",

1602

access="write", byte_arrays=True)

2266

1603

def Secret_dbus_property(self, value):

2267

self.secret = bytes(value)

2268

1604

self.secret = str(value)

1605

2269

1606

del _interface

2270

1607

2271

1608

2272

class ProxyClient:

2273

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

1609

class ProxyClient(object):

1610

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

2274

1611

self._pipe = child_pipe

2275

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

1612

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

2276

1613

if not self._pipe.recv():

2277

raise KeyError(key_id or fpr)

2278

1614

raise KeyError()

1615

2279

1616

def __getattribute__(self, name):

2280

1617

if name == '_pipe':

2281

1618

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

2284

1621

if data[0] == 'data':

2285

1622

return data[1]

2286

1623

if data[0] == 'function':

2287

2288

1624

def func(*args, **kwargs):

2289

1625

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

2290

1626

return self._pipe.recv()[1]

2291

2292

1627

return func

2293

1628

2294

1629

def __setattr__(self, name, value):

2295

1630

if name == '_pipe':

2296

1631

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

2299

1634

2300

1635

class ClientHandler(socketserver.BaseRequestHandler, object):

2301

1636

"""A class to handle client connections.

2302

1637

2303

1638

Instantiated once for each connection to handle it.

2304

1639

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

2305

1640

2306

1641

def handle(self):

2307

1642

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

2308

1643

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

2309

str(self.client_address))

1644

unicode(self.client_address))

2310

1645

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

2311

1646

self.server.child_pipe.fileno())

2312

2313

session = gnutls.ClientSession(self.request)

2314

2315

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

2316

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

2317

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

2318

# "+DHE-DSS"))

1647

1648

session = (gnutls.connection

1649

.ClientSession(self.request,

1650

gnutls.connection

1651

.X509Credentials()))

1652

1653

# Note: gnutls.connection.X509Credentials is really a

1654

# generic GnuTLS certificate credentials object so long as

1655

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

1656

# here despite using OpenPGP certificates.

1657

1658

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

1659

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

1660

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

1661

# "+DHE-DSS"))

2319

1662

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

2320

1663

priority = self.server.gnutls_priority

2321

1664

if priority is None:

2322

1665

priority = "NORMAL"

2323

gnutls.priority_set_direct(session,

2324

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

2325

1666

(gnutls.library.functions

1667

.gnutls_priority_set_direct(session._c_object,

1668

priority, None))

1669

2326

1670

# Start communication using the Mandos protocol

2327

1671

# Get protocol number

2328

1672

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

2329

1673

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

2330

1674

try:

2331

1675

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

2332

raise RuntimeError(line)

1676

raise RuntimeError

2333

1677

except (ValueError, IndexError, RuntimeError) as error:

2334

1678

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

2335

1679

return

2336

1680

2337

1681

# Start GnuTLS connection

2338

1682

try:

2339

1683

session.handshake()

2340

except gnutls.Error as error:

1684

except gnutls.errors.GNUTLSError as error:

2341

1685

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

2342

1686

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

2343

1687

# established. Just abandon the request.

2344

1688

return

2345

1689

logger.debug("Handshake succeeded")

2346

1690

2347

1691

approval_required = False

2348

1692

try:

2349

if gnutls.has_rawpk:

2350

fpr = b""

2351

try:

2352

key_id = self.key_id(

2353

self.peer_certificate(session))

2354

except (TypeError, gnutls.Error) as error:

2355

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

2356

return

2357

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

2358

key_id.decode("utf-8",

2359

errors="replace"))

2360

2361

else:

2362

key_id = b""

2363

try:

2364

fpr = self.fingerprint(

2365

self.peer_certificate(session))

2366

except (TypeError, gnutls.Error) as error:

2367

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

2368

return

2369

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

2370

2371

try:

2372

client = ProxyClient(child_pipe, key_id, fpr,

1693

try:

1694

fpr = self.fingerprint(self.peer_certificate

1695

(session))

1696

except (TypeError,

1697

gnutls.errors.GNUTLSError) as error:

1698

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

1699

return

1700

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

1701

1702

try:

1703

client = ProxyClient(child_pipe, fpr,

2373

1704

self.client_address)

2374

1705

except KeyError:

2375

1706

return

2376

1707

2377

1708

if client.approval_delay:

2378

1709

delay = client.approval_delay

2379

1710

client.approvals_pending += 1

2380

1711

approval_required = True

2381

1712

2382

1713

while True:

2383

1714

if not client.enabled:

2384

1715

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

2385

client.name)

1716

client.name)

2386

1717

if self.server.use_dbus:

2387

1718

# Emit D-Bus signal

2388

1719

client.Rejected("Disabled")

2389

1720

return

2390

1721

2391

1722

if client.approved or not client.approval_delay:

2392

# We are approved or approval is disabled

1723

#We are approved or approval is disabled

2393

1724

break

2394

1725

elif client.approved is None:

2395

1726

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

2397

1728

if self.server.use_dbus:

2398

1729

# Emit D-Bus signal

2399

1730

client.NeedApproval(

2400

client.approval_delay.total_seconds()

2401

* 1000, client.approved_by_default)

1731

client.approval_delay_milliseconds(),

1732

client.approved_by_default)

2402

1733

else:

2403

1734

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

2404

1735

client.name)

2406

1737

# Emit D-Bus signal

2407

1738

client.Rejected("Denied")

2408

1739

return

2409

2410

# wait until timeout or approved

1740

1741

#wait until timeout or approved

2411

1742

time = datetime.datetime.now()

2412

1743

client.changedstate.acquire()

2413

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

1744

client.changedstate.wait(

1745

float(timedelta_to_milliseconds(delay)

1746

/ 1000))

2414

1747

client.changedstate.release()

2415

1748

time2 = datetime.datetime.now()

2416

1749

if (time2 - time) >= delay:

2426

1759

break

2427

1760

else:

2428

1761

delay -= time2 - time

2429

2430

try:

2431

session.send(client.secret)

2432

except gnutls.Error as error:

2433

logger.warning("gnutls send failed",

2434

exc_info=error)

2435

return

2436

1762

1763

sent_size = 0

1764

while sent_size < len(client.secret):

1765

try:

1766

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

1767

except gnutls.errors.GNUTLSError as error:

1768

logger.warning("gnutls send failed",

1769

exc_info=error)

1770

return

1771

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

1772

sent, len(client.secret)

1773

- (sent_size + sent))

1774

sent_size += sent

1775

2437

1776

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

2438

1777

# bump the timeout using extended_timeout

2439

1778

client.bump_timeout(client.extended_timeout)

2440

1779

if self.server.use_dbus:

2441

1780

# Emit D-Bus signal

2442

1781

client.GotSecret()

2443

1782

2444

1783

finally:

2445

1784

if approval_required:

2446

1785

client.approvals_pending -= 1

2447

1786

try:

2448

1787

session.bye()

2449

except gnutls.Error as error:

1788

except gnutls.errors.GNUTLSError as error:

2450

1789

logger.warning("GnuTLS bye failed",

2451

1790

exc_info=error)

2452

1791

2453

1792

@staticmethod

2454

1793

def peer_certificate(session):

2455

"Return the peer's certificate as a bytestring"

2456

try:

2457

cert_type = gnutls.certificate_type_get2(

2458

session, gnutls.CTYPE_PEERS)

2459

except AttributeError:

2460

cert_type = gnutls.certificate_type_get(session)

2461

if gnutls.has_rawpk:

2462

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2463

else:

2464

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2465

# If not a valid certificate type...

2466

if cert_type not in valid_cert_types:

2467

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

2468

valid_cert_types)

2469

# ...return invalid data

2470

return b""

1794

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

1795

# If not an OpenPGP certificate...

1796

if (gnutls.library.functions

1797

.gnutls_certificate_type_get(session._c_object)

1798

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1799

# ...do the normal thing

1800

return session.peer_certificate

2471

1801

list_size = ctypes.c_uint(1)

2472

cert_list = (gnutls.certificate_get_peers

2473

(session, ctypes.byref(list_size)))

1802

cert_list = (gnutls.library.functions

1803

.gnutls_certificate_get_peers

1804

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

2474

1805

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

2475

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

1806

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

1807

" certificate")

2476

1808

if list_size.value == 0:

2477

1809

return None

2478

1810

cert = cert_list[0]

2479

1811

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

2480

2481

@staticmethod

2482

def key_id(certificate):

2483

"Convert a certificate bytestring to a hexdigit key ID"

2484

# New GnuTLS "datum" with the public key

2485

datum = gnutls.datum_t(

2486

ctypes.cast(ctypes.c_char_p(certificate),

2487

ctypes.POINTER(ctypes.c_ubyte)),

2488

ctypes.c_uint(len(certificate)))

2489

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

2490

# New empty GnuTLS certificate

2491

pubkey = gnutls.pubkey_t()

2492

gnutls.pubkey_init(ctypes.byref(pubkey))

2493

# Import the raw public key into the certificate

2494

gnutls.pubkey_import(pubkey,

2495

ctypes.byref(datum),

2496

gnutls.X509_FMT_DER)

2497

# New buffer for the key ID

2498

buf = ctypes.create_string_buffer(32)

2499

buf_len = ctypes.c_size_t(len(buf))

2500

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

2501

gnutls.pubkey_get_key_id(

2502

pubkey,

2503

gnutls.KEYID_USE_SHA256,

2504

ctypes.cast(ctypes.byref(buf),

2505

ctypes.POINTER(ctypes.c_ubyte)),

2506

ctypes.byref(buf_len))

2507

# Deinit the certificate

2508

gnutls.pubkey_deinit(pubkey)

2509

2510

# Convert the buffer to a Python bytestring

2511

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

2512

# Convert the bytestring to hexadecimal notation

2513

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

2514

return hex_key_id

2515

1812

2516

1813

@staticmethod

2517

1814

def fingerprint(openpgp):

2518

1815

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2519

1816

# New GnuTLS "datum" with the OpenPGP public key

2520

datum = gnutls.datum_t(

2521

ctypes.cast(ctypes.c_char_p(openpgp),

2522

ctypes.POINTER(ctypes.c_ubyte)),

2523

ctypes.c_uint(len(openpgp)))

1817

datum = (gnutls.library.types

1818

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

1819

ctypes.POINTER

1820

(ctypes.c_ubyte)),

1821

ctypes.c_uint(len(openpgp))))

2524

1822

# New empty GnuTLS certificate

2525

crt = gnutls.openpgp_crt_t()

2526

gnutls.openpgp_crt_init(ctypes.byref(crt))

1823

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1824

(gnutls.library.functions

1825

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2527

1826

# Import the OpenPGP public key into the certificate

2528

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

2529

gnutls.OPENPGP_FMT_RAW)

1827

(gnutls.library.functions

1828

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

1829

gnutls.library.constants

1830

.GNUTLS_OPENPGP_FMT_RAW))

2530

1831

# Verify the self signature in the key

2531

1832

crtverify = ctypes.c_uint()

2532

gnutls.openpgp_crt_verify_self(crt, 0,

2533

ctypes.byref(crtverify))

1833

(gnutls.library.functions

1834

.gnutls_openpgp_crt_verify_self(crt, 0,

1835

ctypes.byref(crtverify)))

2534

1836

if crtverify.value != 0:

2535

gnutls.openpgp_crt_deinit(crt)

2536

raise gnutls.CertificateSecurityError(code

2537

=crtverify.value)

1837

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1838

raise (gnutls.errors.CertificateSecurityError

1839

("Verify failed"))

2538

1840

# New buffer for the fingerprint

2539

1841

buf = ctypes.create_string_buffer(20)

2540

1842

buf_len = ctypes.c_size_t()

2541

1843

# Get the fingerprint from the certificate into the buffer

2542

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

2543

ctypes.byref(buf_len))

1844

(gnutls.library.functions

1845

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

1846

ctypes.byref(buf_len)))

2544

1847

# Deinit the certificate

2545

gnutls.openpgp_crt_deinit(crt)

1848

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2546

1849

# Convert the buffer to a Python bytestring

2547

1850

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

2548

1851

# Convert the bytestring to hexadecimal notation

2550

1853

return hex_fpr

2551

1854

2552

1855

2553

class MultiprocessingMixIn:

1856

class MultiprocessingMixIn(object):

2554

1857

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

2555

2556

1858

def sub_process_main(self, request, address):

2557

1859

try:

2558

1860

self.finish_request(request, address)

2559

1861

except Exception:

2560

1862

self.handle_error(request, address)

2561

1863

self.close_request(request)

2562

1864

2563

1865

def process_request(self, request, address):

2564

1866

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

2565

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

2566

args=(request, address))

1867

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

1868

args = (request, address))

2567

1869

proc.start()

2568

1870

return proc

2569

1871

2570

1872

2571

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1873

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2572

1874

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

2573

2574

1875

def process_request(self, request, client_address):

2575

1876

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

2576

1877

2577

1878

This function creates a new pipe in self.pipe

2578

1879

"""

2579

1880

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2580

1881

2581

1882

proc = MultiprocessingMixIn.process_request(self, request,

2582

1883

client_address)

2583

1884

self.child_pipe.close()

2584

1885

self.add_pipe(parent_pipe, proc)

2585

1886

2586

1887

def add_pipe(self, parent_pipe, proc):

2587

1888

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

2588

raise NotImplementedError()

1889

raise NotImplementedError

2589

1890

2590

1891

2591

1892

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2592

socketserver.TCPServer):

1893

socketserver.TCPServer, object):

2593

1894

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

2594

1895

2595

1896

Attributes:

2596

1897

enabled: Boolean; whether this server is activated yet

2597

1898

interface: None or a network interface name (string)

2598

1899

use_ipv6: Boolean; to use IPv6 or not

2599

1900

"""

2600

2601

1901

def __init__(self, server_address, RequestHandlerClass,

2602

interface=None,

2603

use_ipv6=True,

2604

socketfd=None):

1902

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

2605

1903

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

2606

1904

creating a new one with socket.socket().

2607

1905

"""

2613

1911

self.socketfd = socketfd

2614

1912

# Save the original socket.socket() function

2615

1913

self.socket_socket = socket.socket

2616

2617

1914

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

2618

#

1915

#

2619

1916

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

2620

1917

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

2621

1918

# patching socket.socket.)

2622

#

1919

#

2623

1920

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

2624

1921

@functools.wraps(socket.socket)

2625

1922

def socket_wrapper(*args, **kwargs):

2637

1934

# socket_wrapper(), if socketfd was set.

2638

1935

socketserver.TCPServer.__init__(self, server_address,

2639

1936

RequestHandlerClass)

2640

1937

2641

1938

def server_bind(self):

2642

1939

"""This overrides the normal server_bind() function

2643

1940

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

2644

1941

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

2645

global SO_BINDTODEVICE

2646

1942

if self.interface is not None:

2647

1943

if SO_BINDTODEVICE is None:

2648

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

2649

# common enough.

2650

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

2651

SO_BINDTODEVICE = 25

2652

try:

2653

self.socket.setsockopt(

2654

socket.SOL_SOCKET, SO_BINDTODEVICE,

2655

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

2656

except socket.error as error:

2657

if error.errno == errno.EPERM:

2658

logger.error("No permission to bind to"

2659

" interface %s", self.interface)

2660

elif error.errno == errno.ENOPROTOOPT:

2661

logger.error("SO_BINDTODEVICE not available;"

2662

" cannot bind to interface %s",

2663

self.interface)

2664

elif error.errno == errno.ENODEV:

2665

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

2666

" cannot bind", self.interface)

2667

else:

2668

raise

1944

logger.error("SO_BINDTODEVICE does not exist;"

1945

" cannot bind to interface %s",

1946

self.interface)

1947

else:

1948

try:

1949

self.socket.setsockopt(socket.SOL_SOCKET,

1950

SO_BINDTODEVICE,

1951

str(self.interface

1952

+ '\0'))

1953

except socket.error as error:

1954

if error.errno == errno.EPERM:

1955

logger.error("No permission to"

1956

" bind to interface %s",

1957

self.interface)

1958

elif error.errno == errno.ENOPROTOOPT:

1959

logger.error("SO_BINDTODEVICE not available;"

1960

" cannot bind to interface %s",

1961

self.interface)

1962

elif error.errno == errno.ENODEV:

1963

logger.error("Interface %s does not"

1964

" exist, cannot bind",

1965

self.interface)

1966

else:

1967

raise

2669

1968

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

2670

1969

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

2671

if self.server_address[1]:

2672

self.allow_reuse_address = True

2673

1970

if not self.server_address[0]:

2674

1971

if self.address_family == socket.AF_INET6:

2675

any_address = "::" # in6addr_any

1972

any_address = "::" # in6addr_any

2676

1973

else:

2677

any_address = "0.0.0.0" # INADDR_ANY

1974

any_address = socket.INADDR_ANY

2678

1975

self.server_address = (any_address,

2679

1976

self.server_address[1])

2680

1977

elif not self.server_address[1]:

2681

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

1978

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

1979

0)

2682

1980

# if self.interface:

2683

1981

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

2684

1982

# 0, # port

2690

1988

2691

1989

class MandosServer(IPv6_TCPServer):

2692

1990

"""Mandos server.

2693

1991

2694

1992

Attributes:

2695

1993

clients: set of Client objects

2696

1994

gnutls_priority GnuTLS priority string

2697

1995

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

2698

2699

Assumes a GLib.MainLoop event loop.

1996

1997

Assumes a gobject.MainLoop event loop.

2700

1998

"""

2701

2702

1999

def __init__(self, server_address, RequestHandlerClass,

2703

interface=None,

2704

use_ipv6=True,

2705

clients=None,

2706

gnutls_priority=None,

2707

use_dbus=True,

2708

socketfd=None):

2000

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

2001

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

2709

2002

self.enabled = False

2710

2003

self.clients = clients

2711

2004

if self.clients is None:

2714

2007

self.gnutls_priority = gnutls_priority

2715

2008

IPv6_TCPServer.__init__(self, server_address,

2716

2009

RequestHandlerClass,

2717

interface=interface,

2718

use_ipv6=use_ipv6,

2719

socketfd=socketfd)

2720

2010

interface = interface,

2011

use_ipv6 = use_ipv6,

2012

socketfd = socketfd)

2721

2013

def server_activate(self):

2722

2014

if self.enabled:

2723

2015

return socketserver.TCPServer.server_activate(self)

2724

2016

2725

2017

def enable(self):

2726

2018

self.enabled = True

2727

2019

2728

2020

def add_pipe(self, parent_pipe, proc):

2729

2021

# Call "handle_ipc" for both data and EOF events

2730

GLib.io_add_watch(

2731

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

2732

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

2733

functools.partial(self.handle_ipc,

2734

parent_pipe=parent_pipe,

2735

proc=proc))

2736

2737

def handle_ipc(self, source, condition,

2738

parent_pipe=None,

2739

proc=None,

2740

client_object=None):

2022

gobject.io_add_watch(parent_pipe.fileno(),

2023

gobject.IO_IN | gobject.IO_HUP,

2024

functools.partial(self.handle_ipc,

2025

parent_pipe =

2026

parent_pipe,

2027

proc = proc))

2028

2029

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

2030

proc = None, client_object=None):

2741

2031

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

2742

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

2032

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

2743

2033

# Wait for other process to exit

2744

2034

proc.join()

2745

2035

return False

2746

2036

2747

2037

# Read a request from the child

2748

2038

request = parent_pipe.recv()

2749

2039

command = request[0]

2750

2040

2751

2041

if command == 'init':

2752

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

2753

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

2754

address = request[3]

2755

2756

for c in self.clients.values():

2757

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2758

"27AE41E4649B934CA495991B7852B855"):

2759

continue

2760

if key_id and c.key_id == key_id:

2761

client = c

2762

break

2763

if fpr and c.fingerprint == fpr:

2042

fpr = request[1]

2043

address = request[2]

2044

2045

for c in self.clients.itervalues():

2046

if c.fingerprint == fpr:

2764

2047

client = c

2765

2048

break

2766

2049

else:

2767

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

2768

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

2050

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

2051

"dress: %s", fpr, address)

2769

2052

if self.use_dbus:

2770

2053

# Emit D-Bus signal

2771

mandos_dbus_service.ClientNotFound(key_id or fpr,

2054

mandos_dbus_service.ClientNotFound(fpr,

2772

2055

address[0])

2773

2056

parent_pipe.send(False)

2774

2057

return False

2775

2776

GLib.io_add_watch(

2777

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

2778

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

2779

functools.partial(self.handle_ipc,

2780

parent_pipe=parent_pipe,

2781

proc=proc,

2782

client_object=client))

2058

2059

gobject.io_add_watch(parent_pipe.fileno(),

2060

gobject.IO_IN | gobject.IO_HUP,

2061

functools.partial(self.handle_ipc,

2062

parent_pipe =

2063

parent_pipe,

2064

proc = proc,

2065

client_object =

2066

client))

2783

2067

parent_pipe.send(True)

2784

2068

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

2785

2069

# same fileno

2788

2072

funcname = request[1]

2789

2073

args = request[2]

2790

2074

kwargs = request[3]

2791

2075

2792

2076

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

2793

2077

funcname)(*args,

2794

**kwargs)))

2795

2078

**kwargs)))

2079

2796

2080

if command == 'getattr':

2797

2081

attrname = request[1]

2798

if isinstance(client_object.__getattribute__(attrname),

2799

collections.abc.Callable):

2800

parent_pipe.send(('function', ))

2082

if callable(client_object.__getattribute__(attrname)):

2083

parent_pipe.send(('function',))

2801

2084

else:

2802

parent_pipe.send((

2803

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

2804

2085

parent_pipe.send(('data', client_object

2086

.__getattribute__(attrname)))

2087

2805

2088

if command == 'setattr':

2806

2089

attrname = request[1]

2807

2090

value = request[2]

2808

2091

setattr(client_object, attrname, value)

2809

2092

2810

2093

return True

2811

2094

2812

2095

2813

def rfc3339_duration_to_delta(duration):

2814

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

2815

2816

>>> timedelta = datetime.timedelta

2817

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

2818

True

2819

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

2820

True

2821

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

2822

True

2823

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

2824

True

2825

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

2826

True

2827

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

2828

True

2829

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

2830

True

2831

>>> del timedelta

2832

"""

2833

2834

# Parsing an RFC 3339 duration with regular expressions is not

2835

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

2836

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

2837

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

2838

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

2839

# avoid excessive use of external libraries.

2840

2841

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

2842

Token = collections.namedtuple("Token", (

2843

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

2844

# a "group" containing digits

2845

"value", # datetime.timedelta or None

2846

"followers")) # Tokens valid after this token

2847

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

2848

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

2849

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

2850

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

2851

datetime.timedelta(seconds=1),

2852

frozenset((token_end, )))

2853

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

2854

datetime.timedelta(minutes=1),

2855

frozenset((token_second, token_end)))

2856

token_hour = Token(re.compile(r"(\d+)H"),

2857

datetime.timedelta(hours=1),

2858

frozenset((token_minute, token_end)))

2859

token_time = Token(re.compile(r"T"),

2860

None,

2861

frozenset((token_hour, token_minute,

2862

token_second)))

2863

token_day = Token(re.compile(r"(\d+)D"),

2864

datetime.timedelta(days=1),

2865

frozenset((token_time, token_end)))

2866

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

2867

datetime.timedelta(weeks=4),

2868

frozenset((token_day, token_end)))

2869

token_year = Token(re.compile(r"(\d+)Y"),

2870

datetime.timedelta(weeks=52),

2871

frozenset((token_month, token_end)))

2872

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

2873

datetime.timedelta(weeks=1),

2874

frozenset((token_end, )))

2875

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

2876

frozenset((token_year, token_month,

2877

token_day, token_time,

2878

token_week)))

2879

# Define starting values:

2880

# Value so far

2881

value = datetime.timedelta()

2882

found_token = None

2883

# Following valid tokens

2884

followers = frozenset((token_duration, ))

2885

# String left to parse

2886

s = duration

2887

# Loop until end token is found

2888

while found_token is not token_end:

2889

# Search for any currently valid tokens

2890

for token in followers:

2891

match = token.regexp.match(s)

2892

if match is not None:

2893

# Token found

2894

if token.value is not None:

2895

# Value found, parse digits

2896

factor = int(match.group(1), 10)

2897

# Add to value so far

2898

value += factor * token.value

2899

# Strip token from string

2900

s = token.regexp.sub("", s, 1)

2901

# Go to found token

2902

found_token = token

2903

# Set valid next tokens

2904

followers = found_token.followers

2905

break

2906

else:

2907

# No currently valid tokens were found

2908

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

2909

.format(duration))

2910

# End token found

2911

return value

2912

2913

2914

2096

def string_to_delta(interval):

2915

2097

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

2916

2917

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

2918

True

2919

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

2920

True

2921

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

2922

True

2923

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

2924

True

2925

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

2926

True

2927

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

2928

True

2098

2099

>>> string_to_delta('7d')

2100

datetime.timedelta(7)

2101

>>> string_to_delta('60s')

2102

datetime.timedelta(0, 60)

2103

>>> string_to_delta('60m')

2104

datetime.timedelta(0, 3600)

2105

>>> string_to_delta('24h')

2106

datetime.timedelta(1)

2107

>>> string_to_delta('1w')

2108

datetime.timedelta(7)

2109

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

2110

datetime.timedelta(0, 330)

2929

2111

"""

2930

2931

try:

2932

return rfc3339_duration_to_delta(interval)

2933

except ValueError:

2934

pass

2935

2936

2112

timevalue = datetime.timedelta(0)

2937

2113

for s in interval.split():

2938

2114

try:

2939

suffix = s[-1]

2115

suffix = unicode(s[-1])

2940

2116

value = int(s[:-1])

2941

2117

if suffix == "d":

2942

2118

delta = datetime.timedelta(value)

2949

2125

elif suffix == "w":

2950

2126

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

2951

2127

else:

2952

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

2953

except IndexError as e:

2128

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

2129

.format(suffix))

2130

except (ValueError, IndexError) as e:

2954

2131

raise ValueError(*(e.args))

2955

2132

timevalue += delta

2956

2133

return timevalue

2957

2134

2958

2135

2959

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

2136

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

2960

2137

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

2961

2138

2962

2139

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

2963

2140

if os.fork():

2964

2141

sys.exit()

2972

2149

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

2973

2150

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

2974

2151

raise OSError(errno.ENODEV,

2975

"{} not a character device"

2152

"{0} not a character device"

2976

2153

.format(os.devnull))

2977

2154

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

2978

2155

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

2982

2159

2983

2160

2984

2161

def main():

2985

2162

2986

2163

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

2987

2164

# Parsing of options, both command line and config file

2988

2165

2989

2166

parser = argparse.ArgumentParser()

2990

2167

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

2991

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

2168

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

2992

2169

help="show version number and exit")

2993

2170

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

2994

2171

help="Bind to interface IF")

3000

2177

help="Run self-test")

3001

2178

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

3002

2179

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

3003

" to terminal", default=None)

2180

" to terminal")

3004

2181

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

3005

2182

help="Debug level for stdout output")

3006

2183

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

3013

2190

" files")

3014

2191

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

3015

2192

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

3016

" system bus interface", default=None)

2193

" system bus interface")

3017

2194

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

3018

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

3019

default=None)

2195

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

3020

2196

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

3021

2197

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

3022

" state", default=None)

2198

" state")

3023

2199

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

3024

2200

help="Specify a file descriptor to a network"

3025

2201

" socket to use instead of creating one")

3026

2202

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

3027

2203

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

3028

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

3029

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

3030

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

3031

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

3032

default=None)

3033

2204

3034

2205

options = parser.parse_args()

3035

2206

2207

if options.check:

2208

import doctest

2209

doctest.testmod()

2210

sys.exit()

2211

3036

2212

# Default values for config file for server-global settings

3037

if gnutls.has_rawpk:

3038

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

3039

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

3040

else:

3041

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

3042

":+SIGN-DSA-SHA256")

3043

server_defaults = {"interface": "",

3044

"address": "",

3045

"port": "",

3046

"debug": "False",

3047

"priority": priority,

3048

"servicename": "Mandos",

3049

"use_dbus": "True",

3050

"use_ipv6": "True",

3051

"debuglevel": "",

3052

"restore": "True",

3053

"socket": "",

3054

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

3055

"foreground": "False",

3056

"zeroconf": "True",

3057

}

3058

del priority

3059

2213

server_defaults = { "interface": "",

2214

"address": "",

2215

"port": "",

2216

"debug": "False",

2217

"priority":

2218

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

2219

"servicename": "Mandos",

2220

"use_dbus": "True",

2221

"use_ipv6": "True",

2222

"debuglevel": "",

2223

"restore": "True",

2224

"socket": "",

2225

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

2226

}

2227

3060

2228

# Parse config file for server-global settings

3061

server_config = configparser.ConfigParser(server_defaults)

2229

server_config = configparser.SafeConfigParser(server_defaults)

3062

2230

del server_defaults

3063

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

3064

# Convert the ConfigParser object to a dict

2231

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

2232

"mandos.conf"))

2233

# Convert the SafeConfigParser object to a dict

3065

2234

server_settings = server_config.defaults()

3066

2235

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

3067

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

3068

"foreground", "zeroconf"):

2236

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

3069

2237

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

3070

2238

option)

3071

2239

if server_settings["port"]:

3081

2249

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

3082

2250

["socket"])

3083

2251

del server_config

3084

2252

3085

2253

# Override the settings from the config file with command line

3086

2254

# options, if set.

3087

2255

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

3088

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

3089

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

3090

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

2256

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

2257

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

2258

"statedir", "socket"):

3091

2259

value = getattr(options, option)

3092

2260

if value is not None:

3093

2261

server_settings[option] = value

3094

2262

del options

3095

2263

# Force all strings to be unicode

3096

2264

for option in server_settings.keys():

3097

if isinstance(server_settings[option], bytes):

3098

server_settings[option] = (server_settings[option]

3099

.decode("utf-8"))

3100

# Force all boolean options to be boolean

3101

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

3102

"foreground", "zeroconf"):

3103

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

3104

# Debug implies foreground

3105

if server_settings["debug"]:

3106

server_settings["foreground"] = True

2265

if type(server_settings[option]) is str:

2266

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

3107

2267

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

3108

2268

3109

2269

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

3110

3111

if (not server_settings["zeroconf"]

3112

and not (server_settings["port"]

3113

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

3114

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

3115

2270

3116

2271

# For convenience

3117

2272

debug = server_settings["debug"]

3118

2273

debuglevel = server_settings["debuglevel"]

3120

2275

use_ipv6 = server_settings["use_ipv6"]

3121

2276

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

3122

2277

stored_state_file)

3123

foreground = server_settings["foreground"]

3124

zeroconf = server_settings["zeroconf"]

3125

2278

3126

2279

if debug:

3127

2280

initlogger(debug, logging.DEBUG)

3128

2281

else:

3131

2284

else:

3132

2285

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

3133

2286

initlogger(debug, level)

3134

2287

3135

2288

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

3136

syslogger.setFormatter(

3137

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

3138

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

3139

server_settings["servicename"])))

3140

2289

syslogger.setFormatter(logging.Formatter

2290

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

2291

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

2292

.format(server_settings

2293

["servicename"])))

2294

3141

2295

# Parse config file with clients

3142

client_config = configparser.ConfigParser(Client.client_defaults)

2296

client_config = configparser.SafeConfigParser(Client

2297

.client_defaults)

3143

2298

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

3144

2299

"clients.conf"))

3145

2300

3146

2301

global mandos_dbus_service

3147

2302

mandos_dbus_service = None

3148

3149

socketfd = None

3150

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

3151

socketfd = server_settings["socket"]

3152

tcp_server = MandosServer(

3153

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

3154

ClientHandler,

3155

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

3156

use_ipv6=use_ipv6,

3157

gnutls_priority=server_settings["priority"],

3158

use_dbus=use_dbus,

3159

socketfd=socketfd)

3160

if not foreground:

3161

pidfilename = "/run/mandos.pid"

3162

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

3163

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

3164

pidfile = None

2303

2304

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

2305

server_settings["port"]),

2306

ClientHandler,

2307

interface=(server_settings["interface"]

2308

or None),

2309

use_ipv6=use_ipv6,

2310

gnutls_priority=

2311

server_settings["priority"],

2312

use_dbus=use_dbus,

2313

socketfd=(server_settings["socket"]

2314

or None))

2315

if not debug:

2316

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

3165

2317

try:

3166

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

2318

pidfile = open(pidfilename, "w")

3167

2319

except IOError as e:

3168

2320

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

3169

2321

exc_info=e)

3170

3171

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

3172

("mandos", "mandos"),

3173

("nobody", "nogroup")):

2322

2323

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

3174

2324

try:

3175

2325

uid = pwd.getpwnam(name).pw_uid

3176

gid = pwd.getpwnam(group).pw_gid

2326

gid = pwd.getpwnam(name).pw_gid

3177

2327

break

3178

2328

except KeyError:

3179

2329

continue

3183

2333

try:

3184

2334

os.setgid(gid)

3185

2335

os.setuid(uid)

3186

if debug:

3187

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

3188

gid))

3189

2336

except OSError as error:

3190

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

3191

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

3192

2337

if error.errno != errno.EPERM:

3193

raise

3194

2338

raise error

2339

3195

2340

if debug:

3196

2341

# Enable all possible GnuTLS debugging

3197

2342

3198

2343

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

3199

2344

# - GnuTLS manual

3200

gnutls.global_set_log_level(11)

3201

3202

@gnutls.log_func

2345

gnutls.library.functions.gnutls_global_set_log_level(11)

2346

2347

@gnutls.library.types.gnutls_log_func

3203

2348

def debug_gnutls(level, string):

3204

logger.debug("GnuTLS: %s",

3205

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

3206

errors="replace"))

3207

3208

gnutls.global_set_log_function(debug_gnutls)

3209

2349

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

2350

2351

(gnutls.library.functions

2352

.gnutls_global_set_log_function(debug_gnutls))

2353

3210

2354

# Redirect stdin so all checkers get /dev/null

3211

2355

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

3212

2356

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

3213

2357

if null > 2:

3214

2358

os.close(null)

3215

2359

3216

2360

# Need to fork before connecting to D-Bus

3217

if not foreground:

2361

if not debug:

3218

2362

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

3219

2363

daemon()

3220

3221

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

3222

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

3223

# need to inform GLib that threads will be used.

3224

GLib.threads_init()

3225

2364

2365

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

2366

# need to inform gobject that threads will be used.

2367

gobject.threads_init()

2368

3226

2369

global main_loop

3227

2370

# From the Avahi example code

3228

2371

DBusGMainLoop(set_as_default=True)

3229

main_loop = GLib.MainLoop()

2372

main_loop = gobject.MainLoop()

3230

2373

bus = dbus.SystemBus()

3231

2374

# End of Avahi example code

3232

2375

if use_dbus:

3233

2376

try:

3234

2377

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

3235

bus,

3236

do_not_queue=True)

3237

old_bus_name = dbus.service.BusName(

3238

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

3239

do_not_queue=True)

3240

except dbus.exceptions.DBusException as e:

2378

bus, do_not_queue=True)

2379

old_bus_name = (dbus.service.BusName

2380

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

2381

do_not_queue=True))

2382

except dbus.exceptions.NameExistsException as e:

3241

2383

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

3242

2384

use_dbus = False

3243

2385

server_settings["use_dbus"] = False

3244

2386

tcp_server.use_dbus = False

3245

if zeroconf:

3246

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3247

service = AvahiServiceToSyslog(

3248

name=server_settings["servicename"],

3249

servicetype="_mandos._tcp",

3250

protocol=protocol,

3251

bus=bus)

3252

if server_settings["interface"]:

3253

service.interface = if_nametoindex(

3254

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

3255

2387

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2388

service = AvahiServiceToSyslog(name =

2389

server_settings["servicename"],

2390

servicetype = "_mandos._tcp",

2391

protocol = protocol, bus = bus)

2392

if server_settings["interface"]:

2393

service.interface = (if_nametoindex

2394

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

2395

3256

2396

global multiprocessing_manager

3257

2397

multiprocessing_manager = multiprocessing.Manager()

3258

2398

3259

2399

client_class = Client

3260

2400

if use_dbus:

3261

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

3262

2401

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

2402

3263

2403

client_settings = Client.config_parser(client_config)

3264

2404

old_client_settings = {}

3265

2405

clients_data = {}

3266

3267

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

3268

global wnull

3269

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

3270

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

3271

# mode

3272

if debug or not foreground:

3273

wnull.close()

3274

2406

3275

2407

# Get client data and settings from last running state.

3276

2408

if server_settings["restore"]:

3277

2409

try:

3278

2410

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

3279

if sys.version_info.major == 2:

3280

clients_data, old_client_settings = pickle.load(

3281

stored_state)

3282

else:

3283

bytes_clients_data, bytes_old_client_settings = (

3284

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

3285

# Fix bytes to strings

3286

# clients_data

3287

# .keys()

3288

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

3289

if isinstance(key, bytes)

3290

else key): value

3291

for key, value in

3292

bytes_clients_data.items()}

3293

del bytes_clients_data

3294

for key in clients_data:

3295

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

3296

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

3297

for k, v in

3298

clients_data[key].items()}

3299

clients_data[key] = value

3300

# .client_structure

3301

value["client_structure"] = [

3302

(s.decode("utf-8")

3303

if isinstance(s, bytes)

3304

else s) for s in

3305

value["client_structure"]]

3306

# .name, .host, and .checker_command

3307

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

3308

if isinstance(value[k], bytes):

3309

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

3310

if "key_id" not in value:

3311

value["key_id"] = ""

3312

elif "fingerprint" not in value:

3313

value["fingerprint"] = ""

3314

# old_client_settings

3315

# .keys()

3316

old_client_settings = {

3317

(key.decode("utf-8")

3318

if isinstance(key, bytes)

3319

else key): value

3320

for key, value in

3321

bytes_old_client_settings.items()}

3322

del bytes_old_client_settings

3323

# .host and .checker_command

3324

for value in old_client_settings.values():

3325

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

3326

if isinstance(value[attribute], bytes):

3327

value[attribute] = (value[attribute]

3328

.decode("utf-8"))

2411

clients_data, old_client_settings = (pickle.load

2412

(stored_state))

3329

2413

os.remove(stored_state_path)

3330

2414

except IOError as e:

3331

2415

if e.errno == errno.ENOENT:

3332

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

3333

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

2416

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

2417

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

3334

2418

else:

3335

2419

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

3336

2420

exc_info=e)

3337

2421

raise

3338

2422

except EOFError as e:

3339

2423

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

3340

"EOFError:",

3341

exc_info=e)

3342

2424

"EOFError:", exc_info=e)

2425

3343

2426

with PGPEngine() as pgp:

3344

for client_name, client in clients_data.items():

3345

# Skip removed clients

3346

if client_name not in client_settings:

3347

continue

3348

2427

for client_name, client in clients_data.iteritems():

3349

2428

# Decide which value to use after restoring saved state.

3350

2429

# We have three different values: Old config file,

3351

2430

# new config file, and saved state.

3356

2435

# For each value in new config, check if it

3357

2436

# differs from the old config value (Except for

3358

2437

# the "secret" attribute)

3359

if (name != "secret"

3360

and (value !=

3361

old_client_settings[client_name][name])):

2438

if (name != "secret" and

2439

value != old_client_settings[client_name]

2440

[name]):

3362

2441

client[name] = value

3363

2442

except KeyError:

3364

2443

pass

3365

2444

3366

2445

# Clients who has passed its expire date can still be

3367

# enabled if its last checker was successful. A Client

2446

# enabled if its last checker was successful. Clients

3368

2447

# whose checker succeeded before we stored its state is

3369

2448

# assumed to have successfully run all checkers during

3370

2449

# downtime.

3372

2451

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

3373

2452

if not client["last_checked_ok"]:

3374

2453

logger.warning(

3375

"disabling client {} - Client never "

3376

"performed a successful checker".format(

3377

client_name))

2454

"disabling client {0} - Client never "

2455

"performed a successful checker"

2456

.format(client_name))

3378

2457

client["enabled"] = False

3379

2458

elif client["last_checker_status"] != 0:

3380

2459

logger.warning(

3381

"disabling client {} - Client last"

3382

" checker failed with error code"

3383

" {}".format(

3384

client_name,

3385

client["last_checker_status"]))

2460

"disabling client {0} - Client "

2461

"last checker failed with error code {1}"

2462

.format(client_name,

2463

client["last_checker_status"]))

3386

2464

client["enabled"] = False

3387

2465

else:

3388

client["expires"] = (

3389

datetime.datetime.utcnow()

3390

+ client["timeout"])

2466

client["expires"] = (datetime.datetime

2467

.utcnow()

2468

+ client["timeout"])

3391

2469

logger.debug("Last checker succeeded,"

3392

" keeping {} enabled".format(

3393

client_name))

2470

" keeping {0} enabled"

2471

.format(client_name))

3394

2472

try:

3395

client["secret"] = pgp.decrypt(

3396

client["encrypted_secret"],

3397

client_settings[client_name]["secret"])

2473

client["secret"] = (

2474

pgp.decrypt(client["encrypted_secret"],

2475

client_settings[client_name]

2476

["secret"]))

3398

2477

except PGPError:

3399

2478

# If decryption fails, we use secret from new settings

3400

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

3401

client_name))

3402

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

3403

["secret"])

3404

2479

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

2480

.format(client_name))

2481

client["secret"] = (

2482

client_settings[client_name]["secret"])

2483

3405

2484

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

3406

2485

for client_name in (set(old_client_settings)

3407

2486

- set(client_settings)):

3409

2488

for client_name in (set(client_settings)

3410

2489

- set(old_client_settings)):

3411

2490

clients_data[client_name] = client_settings[client_name]

3412

2491

3413

2492

# Create all client objects

3414

for client_name, client in clients_data.items():

2493

for client_name, client in clients_data.iteritems():

3415

2494

tcp_server.clients[client_name] = client_class(

3416

name=client_name,

3417

settings=client,

3418

server_settings=server_settings)

3419

2495

name = client_name, settings = client)

2496

3420

2497

if not tcp_server.clients:

3421

2498

logger.warning("No clients defined")

3422

3423

if not foreground:

3424

if pidfile is not None:

3425

pid = os.getpid()

3426

try:

3427

with pidfile:

3428

print(pid, file=pidfile)

3429

except IOError:

3430

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

3431

pidfilename, pid)

3432

del pidfile

2499

2500

if not debug:

2501

try:

2502

with pidfile:

2503

pid = os.getpid()

2504

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

2505

del pidfile

2506

except IOError:

2507

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

2508

pidfilename, pid)

2509

except NameError:

2510

# "pidfile" was never created

2511

pass

3433

2512

del pidfilename

3434

3435

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

3436

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3437

lambda: main_loop.quit() and False)

3438

2513

2514

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

2515

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

2516

3439

2517

if use_dbus:

3440

3441

@alternate_dbus_interfaces(

3442

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

3443

class MandosDBusService(DBusObjectWithObjectManager):

2518

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

2519

"se.bsnet.fukt.Mandos"})

2520

class MandosDBusService(DBusObjectWithProperties):

3444

2521

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

3445

3446

2522

def __init__(self):

3447

2523

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

3448

3449

2524

_interface = "se.recompile.Mandos"

3450

2525

2526

@dbus_interface_annotations(_interface)

2527

def _foo(self):

2528

return { "org.freedesktop.DBus.Property"

2529

".EmitsChangedSignal":

2530

"false"}

2531

3451

2532

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

3452

2533

def ClientAdded(self, objpath):

3453

2534

"D-Bus signal"

3454

2535

pass

3455

2536

3456

2537

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

3457

def ClientNotFound(self, key_id, address):

2538

def ClientNotFound(self, fingerprint, address):

3458

2539

"D-Bus signal"

3459

2540

pass

3460

3461

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

3462

"true"})

2541

3463

2542

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

3464

2543

def ClientRemoved(self, objpath, name):

3465

2544

"D-Bus signal"

3466

2545

pass

3467

3468

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

3469

"true"})

2546

3470

2547

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

3471

2548

def GetAllClients(self):

3472

2549

"D-Bus method"

3473

return dbus.Array(c.dbus_object_path for c in

3474

tcp_server.clients.values())

3475

3476

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

3477

"true"})

2550

return dbus.Array(c.dbus_object_path

2551

for c in

2552

tcp_server.clients.itervalues())

2553

3478

2554

@dbus.service.method(_interface,

3479

2555

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

3480

2556

def GetAllClientsWithProperties(self):

3481

2557

"D-Bus method"

3482

2558

return dbus.Dictionary(

3483

{c.dbus_object_path: c.GetAll(

3484

"se.recompile.Mandos.Client")

3485

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

2559

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

2560

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

3486

2561

signature="oa{sv}")

3487

2562

3488

2563

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

3489

2564

def RemoveClient(self, object_path):

3490

2565

"D-Bus method"

3491

for c in tcp_server.clients.values():

2566

for c in tcp_server.clients.itervalues():

3492

2567

if c.dbus_object_path == object_path:

3493

2568

del tcp_server.clients[c.name]

3494

2569

c.remove_from_connection()

3495

# Don't signal the disabling

2570

# Don't signal anything except ClientRemoved

3496

2571

c.disable(quiet=True)

3497

# Emit D-Bus signal for removal

3498

self.client_removed_signal(c)

2572

# Emit D-Bus signal

2573

self.ClientRemoved(object_path, c.name)

3499

2574

return

3500

2575

raise KeyError(object_path)

3501

2576

3502

2577

del _interface

3503

3504

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3505

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

3506

def GetManagedObjects(self):

3507

"""D-Bus method"""

3508

return dbus.Dictionary(

3509

{client.dbus_object_path:

3510

dbus.Dictionary(

3511

{interface: client.GetAll(interface)

3512

for interface in

3513

client._get_all_interface_names()})

3514

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

3515

3516

def client_added_signal(self, client):

3517

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

3518

if use_dbus:

3519

# New standard signal

3520

self.InterfacesAdded(

3521

client.dbus_object_path,

3522

dbus.Dictionary(

3523

{interface: client.GetAll(interface)

3524

for interface in

3525

client._get_all_interface_names()}))

3526

# Old signal

3527

self.ClientAdded(client.dbus_object_path)

3528

3529

def client_removed_signal(self, client):

3530

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

3531

if use_dbus:

3532

# New standard signal

3533

self.InterfacesRemoved(

3534

client.dbus_object_path,

3535

client._get_all_interface_names())

3536

# Old signal

3537

self.ClientRemoved(client.dbus_object_path,

3538

client.name)

3539

2578

3540

2579

mandos_dbus_service = MandosDBusService()

3541

3542

# Save modules to variables to exempt the modules from being

3543

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

3544

mp = multiprocessing

3545

wn = wnull

3546

2580

3547

2581

def cleanup():

3548

2582

"Cleanup function; run on exit"

3549

if zeroconf:

3550

service.cleanup()

3551

3552

mp.active_children()

3553

wn.close()

2583

service.cleanup()

2584

2585

multiprocessing.active_children()

3554

2586

if not (tcp_server.clients or client_settings):

3555

2587

return

3556

2588

3557

2589

# Store client before exiting. Secrets are encrypted with key

3558

2590

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

3559

2591

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

3560

2592

clients = {}

3561

2593

with PGPEngine() as pgp:

3562

for client in tcp_server.clients.values():

2594

for client in tcp_server.clients.itervalues():

3563

2595

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

3564

2596

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

3565

2597

key)

3566

2598

client_dict = {}

3567

2599

3568

2600

# A list of attributes that can not be pickled

3569

2601

# + secret.

3570

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

3571

"checker", "server_settings"}

3572

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

3573

.Object):

2602

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

2603

"checker"))

2604

for name, typ in (inspect.getmembers

2605

(dbus.service.Object)):

3574

2606

exclude.add(name)

3575

2607

3576

2608

client_dict["encrypted_secret"] = (client

3577

2609

.encrypted_secret)

3578

2610

for attr in client.client_structure:

3579

2611

if attr not in exclude:

3580

2612

client_dict[attr] = getattr(client, attr)

3581

2613

3582

2614

clients[client.name] = client_dict

3583

2615

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

3584

2616

3585

2617

try:

3586

with tempfile.NamedTemporaryFile(

3587

mode='wb',

3588

suffix=".pickle",

3589

prefix='clients-',

3590

dir=os.path.dirname(stored_state_path),

3591

delete=False) as stored_state:

3592

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

3593

protocol=2)

3594

tempname = stored_state.name

2618

with (tempfile.NamedTemporaryFile

2619

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

2620

dir=os.path.dirname(stored_state_path),

2621

delete=False)) as stored_state:

2622

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

2623

tempname=stored_state.name

3595

2624

os.rename(tempname, stored_state_path)

3596

2625

except (IOError, OSError) as e:

3597

2626

if not debug:

3600

2629

except NameError:

3601

2630

pass

3602

2631

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

3603

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

2632

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

3604

2633

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

3605

2634

else:

3606

2635

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

3607

2636

exc_info=e)

3608

raise

3609

2637

raise e

2638

3610

2639

# Delete all clients, and settings from config

3611

2640

while tcp_server.clients:

3612

2641

name, client = tcp_server.clients.popitem()

3613

2642

if use_dbus:

3614

2643

client.remove_from_connection()

3615

# Don't signal the disabling

2644

# Don't signal anything except ClientRemoved

3616

2645

client.disable(quiet=True)

3617

# Emit D-Bus signal for removal

3618

2646

if use_dbus:

3619

mandos_dbus_service.client_removed_signal(client)

2647

# Emit D-Bus signal

2648

mandos_dbus_service.ClientRemoved(client

2649

.dbus_object_path,

2650

client.name)

3620

2651

client_settings.clear()

3621

2652

3622

2653

atexit.register(cleanup)

3623

3624

for client in tcp_server.clients.values():

2654

2655

for client in tcp_server.clients.itervalues():

3625

2656

if use_dbus:

3626

# Emit D-Bus signal for adding

3627

mandos_dbus_service.client_added_signal(client)

2657

# Emit D-Bus signal

2658

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3628

2659

# Need to initiate checking of clients

3629

2660

if client.enabled:

3630

2661

client.init_checker()

3631

2662

3632

2663

tcp_server.enable()

3633

2664

tcp_server.server_activate()

3634

2665

3635

2666

# Find out what port we got

3636

if zeroconf:

3637

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

2667

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

3638

2668

if use_ipv6:

3639

2669

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

3640

2670

" flowinfo %d, scope_id %d",

3642

2672

else: # IPv4

3643

2673

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

3644

2674

*tcp_server.socket.getsockname())

3645

3646

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

3647

2675

2676

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

2677

3648

2678

try:

3649

if zeroconf:

3650

# From the Avahi example code

3651

try:

3652

service.activate()

3653

except dbus.exceptions.DBusException as error:

3654

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

3655

cleanup()

3656

sys.exit(1)

3657

# End of Avahi example code

3658

3659

GLib.io_add_watch(

3660

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

3661

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3662

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

3663

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

3664

2679

# From the Avahi example code

2680

try:

2681

service.activate()

2682

except dbus.exceptions.DBusException as error:

2683

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

2684

cleanup()

2685

sys.exit(1)

2686

# End of Avahi example code

2687

2688

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

2689

lambda *args, **kwargs:

2690

(tcp_server.handle_request

2691

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

2692

3665

2693

logger.debug("Starting main loop")

3666

2694

main_loop.run()

3667

2695

except AvahiError as error:

3676

2704

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

3677

2705

cleanup()

3678

2706

3679

3680

def should_only_run_tests():

3681

parser = argparse.ArgumentParser(add_help=False)

3682

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

3683

args, unknown_args = parser.parse_known_args()

3684

run_tests = args.check

3685

if run_tests:

3686

# Remove --check argument from sys.argv

3687

sys.argv[1:] = unknown_args

3688

return run_tests

3689

3690

# Add all tests from doctest strings

3691

def load_tests(loader, tests, none):

3692

import doctest

3693

tests.addTests(doctest.DocTestSuite())

3694

return tests

3695

3696

2707

if __name__ == '__main__':

3697

try:

3698

if should_only_run_tests():

3699

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

3700

unittest.main()

3701

else:

3702

main()

3703

finally:

3704

logging.shutdown()

2708

main()