/mandos/trunk : revision 609

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import unittest

81

72

82

73

import dbus

83

74

import dbus.service

84

import gi

85

from gi.repository import GLib

75

import gobject

76

import avahi

86

77

from dbus.mainloop.glib import DBusGMainLoop

87

78

import ctypes

88

79

import ctypes.util

89

80

import xml.dom.minidom

90

81

import inspect

91

92

if sys.version_info.major == 2:

93

__metaclass__ = type

94

str = unicode

95

96

# Show warnings by default

97

if not sys.warnoptions:

98

import warnings

99

warnings.simplefilter("default")

100

101

# Try to find the value of SO_BINDTODEVICE:

82

import GnuPGInterface

83

102

84

try:

103

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

104

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

105

85

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

106

86

except AttributeError:

107

87

try:

108

# This is where SO_BINDTODEVICE was up to and including Python

109

# 2.6, and also 3.2:

110

88

from IN import SO_BINDTODEVICE

111

89

except ImportError:

112

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

113

# Try running the C preprocessor:

114

try:

115

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

116

"/dev/stdin"],

117

stdin=subprocess.PIPE,

118

stdout=subprocess.PIPE)

119

stdout = cc.communicate(

120

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

121

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

122

except (OSError, ValueError, IndexError):

123

# No value found

124

SO_BINDTODEVICE = None

125

126

if sys.version_info < (3, 2):

127

configparser.Configparser = configparser.SafeConfigParser

128

129

version = "1.8.9"

90

SO_BINDTODEVICE = None

91

92

version = "1.6.0"

130

93

stored_state_file = "clients.pickle"

131

94

132

95

logger = logging.getLogger()

133

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

134

syslogger = None

96

syslogger = (logging.handlers.SysLogHandler

97

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

98

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

135

99

136

100

try:

137

if_nametoindex = ctypes.cdll.LoadLibrary(

138

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

139

104

except (OSError, AttributeError):

140

141

105

def if_nametoindex(interface):

142

106

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

143

107

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

144

108

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

145

109

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

146

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

147

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

110

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

111

interface))

112

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

113

ifreq[16:20])[0]

148

114

return interface_index

149

115

150

116

151

def copy_function(func):

152

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

153

if sys.version_info.major == 2:

154

return types.FunctionType(func.func_code,

155

func.func_globals,

156

func.func_name,

157

func.func_defaults,

158

func.func_closure)

159

else:

160

return types.FunctionType(func.__code__,

161

func.__globals__,

162

func.__name__,

163

func.__defaults__,

164

func.__closure__)

165

166

167

117

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

168

118

"""init logger and add loglevel"""

169

170

global syslogger

171

syslogger = (logging.handlers.SysLogHandler(

172

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

173

address="/dev/log"))

119

174

120

syslogger.setFormatter(logging.Formatter

175

121

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

176

122

' %(message)s'))

177

123

logger.addHandler(syslogger)

178

124

179

125

if debug:

180

126

console = logging.StreamHandler()

181

127

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

191

137

pass

192

138

193

139

194

class PGPEngine:

140

class PGPEngine(object):

195

141

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

196

197

142

def __init__(self):

143

self.gnupg = GnuPGInterface.GnuPG()

198

144

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

199

self.gpg = "gpg"

200

try:

201

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

202

for line in output.splitlines():

203

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

204

if name == b"gpg":

205

self.gpg = path

206

break

207

except OSError as e:

208

if e.errno != errno.ENOENT:

209

raise

210

self.gnupgargs = ['--batch',

211

'--homedir', self.tempdir,

212

'--force-mdc',

213

'--quiet']

214

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

215

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

216

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

217

145

self.gnupg = GnuPGInterface.GnuPG()

146

self.gnupg.options.meta_interactive = False

147

self.gnupg.options.homedir = self.tempdir

148

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

149

'--quiet',

150

'--no-use-agent'])

151

218

152

def __enter__(self):

219

153

return self

220

154

221

155

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

222

156

self._cleanup()

223

157

return False

224

158

225

159

def __del__(self):

226

160

self._cleanup()

227

161

228

162

def _cleanup(self):

229

163

if self.tempdir is not None:

230

164

# Delete contents of tempdir

231

165

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

232

topdown=False):

166

topdown = False):

233

167

for filename in files:

234

168

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

235

169

for dirname in dirs:

237

171

# Remove tempdir

238

172

os.rmdir(self.tempdir)

239

173

self.tempdir = None

240

174

241

175

def password_encode(self, password):

242

176

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

243

177

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

244

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

245

if len(encoded) > 2048:

246

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

247

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

248

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

249

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

250

return encoded

251

178

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

179

252

180

def encrypt(self, data, password):

253

passphrase = self.password_encode(password)

254

with tempfile.NamedTemporaryFile(

255

dir=self.tempdir) as passfile:

256

passfile.write(passphrase)

257

passfile.flush()

258

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

259

'--passphrase-file',

260

passfile.name]

261

+ self.gnupgargs,

262

stdin=subprocess.PIPE,

263

stdout=subprocess.PIPE,

264

stderr=subprocess.PIPE)

265

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

266

if proc.returncode != 0:

267

raise PGPError(err)

181

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

182

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

183

try:

184

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

185

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

186

attach_fhs={'stderr': devnull})

187

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

188

f.write(data)

189

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

190

ciphertext = f.read()

191

proc.wait()

192

except IOError as e:

193

raise PGPError(e)

194

self.gnupg.passphrase = None

268

195

return ciphertext

269

196

270

197

def decrypt(self, data, password):

271

passphrase = self.password_encode(password)

272

with tempfile.NamedTemporaryFile(

273

dir=self.tempdir) as passfile:

274

passfile.write(passphrase)

275

passfile.flush()

276

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

277

'--passphrase-file',

278

passfile.name]

279

+ self.gnupgargs,

280

stdin=subprocess.PIPE,

281

stdout=subprocess.PIPE,

282

stderr=subprocess.PIPE)

283

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

284

if proc.returncode != 0:

285

raise PGPError(err)

198

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

199

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

200

try:

201

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

202

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

203

attach_fhs={'stderr': devnull})

204

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

205

f.write(data)

206

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

207

decrypted_plaintext = f.read()

208

proc.wait()

209

except IOError as e:

210

raise PGPError(e)

211

self.gnupg.passphrase = None

286

212

return decrypted_plaintext

287

213

288

214

289

# Pretend that we have an Avahi module

290

class avahi:

291

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

292

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

293

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

294

PROTO_INET = 0 # avahi-common/address.h

295

PROTO_INET6 = 1 # avahi-common/address.h

296

DBUS_NAME = "org.freedesktop.Avahi"

297

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

298

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

299

DBUS_PATH_SERVER = "/"

300

301

@staticmethod

302

def string_array_to_txt_array(t):

303

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

304

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

305

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

306

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

307

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

308

SERVER_INVALID = 0 # avahi-common/defs.h

309

SERVER_REGISTERING = 1 # avahi-common/defs.h

310

SERVER_RUNNING = 2 # avahi-common/defs.h

311

SERVER_COLLISION = 3 # avahi-common/defs.h

312

SERVER_FAILURE = 4 # avahi-common/defs.h

313

314

315

215

class AvahiError(Exception):

316

216

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

317

217

self.value = value

318

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

319

**kwargs)

320

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

321

221

322

222

class AvahiServiceError(AvahiError):

323

223

pass

324

224

325

326

225

class AvahiGroupError(AvahiError):

327

226

pass

328

227

329

228

330

class AvahiService:

229

class AvahiService(object):

331

230

"""An Avahi (Zeroconf) service.

332

231

333

232

Attributes:

334

233

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

335

234

Used to optionally bind to the specified interface.

336

235

name: string; Example: 'Mandos'

337

236

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

338

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

237

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

339

238

port: integer; what port to announce

340

239

TXT: list of strings; TXT record for the service

341

240

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

347

246

server: D-Bus Server

348

247

bus: dbus.SystemBus()

349

248

"""

350

351

def __init__(self,

352

interface=avahi.IF_UNSPEC,

353

name=None,

354

servicetype=None,

355

port=None,

356

TXT=None,

357

domain="",

358

host="",

359

max_renames=32768,

360

protocol=avahi.PROTO_UNSPEC,

361

bus=None):

249

250

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

251

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

252

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

253

protocol = avahi.PROTO_UNSPEC, bus = None):

362

254

self.interface = interface

363

255

self.name = name

364

256

self.type = servicetype

373

265

self.server = None

374

266

self.bus = bus

375

267

self.entry_group_state_changed_match = None

376

377

def rename(self, remove=True):

268

269

def rename(self):

378

270

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

379

271

if self.rename_count >= self.max_renames:

380

272

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

381

273

" after %i retries, exiting.",

382

274

self.rename_count)

383

275

raise AvahiServiceError("Too many renames")

384

self.name = str(

385

self.server.GetAlternativeServiceName(self.name))

386

self.rename_count += 1

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

387

278

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

388

279

self.name)

389

if remove:

390

self.remove()

280

self.remove()

391

281

try:

392

282

self.add()

393

283

except dbus.exceptions.DBusException as error:

394

if (error.get_dbus_name()

395

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

396

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

397

return self.rename(remove=False)

398

else:

399

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

400

self.cleanup()

401

os._exit(1)

402

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

288

403

289

def remove(self):

404

290

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

405

291

if self.entry_group_state_changed_match is not None:

407

293

self.entry_group_state_changed_match = None

408

294

if self.group is not None:

409

295

self.group.Reset()

410

296

411

297

def add(self):

412

298

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

413

299

self.remove()

430

316

dbus.UInt16(self.port),

431

317

avahi.string_array_to_txt_array(self.TXT))

432

318

self.group.Commit()

433

319

434

320

def entry_group_state_changed(self, state, error):

435

321

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

436

322

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

437

323

438

324

if state == avahi.ENTRY_GROUP_ESTABLISHED:

439

325

logger.debug("Zeroconf service established.")

440

326

elif state == avahi.ENTRY_GROUP_COLLISION:

442

328

self.rename()

443

329

elif state == avahi.ENTRY_GROUP_FAILURE:

444

330

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

445

str(error))

446

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

447

331

unicode(error))

332

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

333

.format(error))

334

448

335

def cleanup(self):

449

336

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

450

337

if self.group is not None:

455

342

pass

456

343

self.group = None

457

344

self.remove()

458

345

459

346

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

460

347

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

461

348

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

462

bad_states = {

463

avahi.SERVER_INVALID: "Zeroconf server invalid",

464

avahi.SERVER_REGISTERING: None,

465

avahi.SERVER_COLLISION: "Zeroconf server name collision",

466

avahi.SERVER_FAILURE: "Zeroconf server failure",

467

}

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

468

356

if state in bad_states:

469

357

if bad_states[state] is not None:

470

358

if error is None:

473

361

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

474

362

self.cleanup()

475

363

elif state == avahi.SERVER_RUNNING:

476

try:

477

self.add()

478

except dbus.exceptions.DBusException as error:

479

if (error.get_dbus_name()

480

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

481

logger.info("Local Zeroconf service name"

482

" collision.")

483

return self.rename(remove=False)

484

else:

485

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

486

self.cleanup()

487

os._exit(1)

364

self.add()

488

365

else:

489

366

if error is None:

490

367

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

491

368

else:

492

369

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

493

370

494

371

def activate(self):

495

372

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

496

373

if self.server is None:

500

377

follow_name_owner_changes=True),

501

378

avahi.DBUS_INTERFACE_SERVER)

502

379

self.server.connect_to_signal("StateChanged",

503

self.server_state_changed)

380

self.server_state_changed)

504

381

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

505

382

506

383

507

384

class AvahiServiceToSyslog(AvahiService):

508

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

385

def rename(self):

509

386

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

510

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

511

syslogger.setFormatter(logging.Formatter(

512

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

513

.format(self.name)))

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

514

392

return ret

515

393

516

394

517

# Pretend that we have a GnuTLS module

518

class gnutls:

519

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

520

521

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

522

if library is None:

523

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

524

_library = ctypes.cdll.LoadLibrary(library)

525

del library

526

527

# Unless otherwise indicated, the constants and types below are

528

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

529

530

# Constants

531

E_SUCCESS = 0

532

E_INTERRUPTED = -52

533

E_AGAIN = -28

534

CRT_OPENPGP = 2

535

CRT_RAWPK = 3

536

CLIENT = 2

537

SHUT_RDWR = 0

538

CRD_CERTIFICATE = 1

539

E_NO_CERTIFICATE_FOUND = -49

540

X509_FMT_DER = 0

541

NO_TICKETS = 1<<10

542

ENABLE_RAWPK = 1<<18

543

CTYPE_PEERS = 3

544

KEYID_USE_SHA256 = 1 # gnutls/x509.h

545

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

546

547

# Types

548

class session_int(ctypes.Structure):

549

_fields_ = []

550

session_t = ctypes.POINTER(session_int)

551

552

class certificate_credentials_st(ctypes.Structure):

553

_fields_ = []

554

certificate_credentials_t = ctypes.POINTER(

555

certificate_credentials_st)

556

certificate_type_t = ctypes.c_int

557

558

class datum_t(ctypes.Structure):

559

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

560

('size', ctypes.c_uint)]

561

562

class openpgp_crt_int(ctypes.Structure):

563

_fields_ = []

564

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

565

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

566

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

567

credentials_type_t = ctypes.c_int

568

transport_ptr_t = ctypes.c_void_p

569

close_request_t = ctypes.c_int

570

571

# Exceptions

572

class Error(Exception):

573

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

574

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

575

# code is passed, convert it to a string with

576

# gnutls.strerror()

577

self.code = code

578

if message is None and code is not None:

579

message = gnutls.strerror(code)

580

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

581

message, *args)

582

583

class CertificateSecurityError(Error):

584

pass

585

586

# Classes

587

class Credentials:

588

def __init__(self):

589

self._c_object = gnutls.certificate_credentials_t()

590

gnutls.certificate_allocate_credentials(

591

ctypes.byref(self._c_object))

592

self.type = gnutls.CRD_CERTIFICATE

593

594

def __del__(self):

595

gnutls.certificate_free_credentials(self._c_object)

596

597

class ClientSession:

598

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

599

self._c_object = gnutls.session_t()

600

gnutls_flags = gnutls.CLIENT

601

if gnutls.check_version(b"3.5.6"):

602

gnutls_flags |= gnutls.NO_TICKETS

603

if gnutls.has_rawpk:

604

gnutls_flags |= gnutls.ENABLE_RAWPK

605

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

606

del gnutls_flags

607

gnutls.set_default_priority(self._c_object)

608

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

609

gnutls.handshake_set_private_extensions(self._c_object,

610

True)

611

self.socket = socket

612

if credentials is None:

613

credentials = gnutls.Credentials()

614

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

615

ctypes.cast(credentials._c_object,

616

ctypes.c_void_p))

617

self.credentials = credentials

618

619

def __del__(self):

620

gnutls.deinit(self._c_object)

621

622

def handshake(self):

623

return gnutls.handshake(self._c_object)

624

625

def send(self, data):

626

data = bytes(data)

627

data_len = len(data)

628

while data_len > 0:

629

data_len -= gnutls.record_send(self._c_object,

630

data[-data_len:],

631

data_len)

632

633

def bye(self):

634

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

635

636

# Error handling functions

637

def _error_code(result):

638

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

639

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

640

if result >= 0:

641

return result

642

if result == gnutls.E_NO_CERTIFICATE_FOUND:

643

raise gnutls.CertificateSecurityError(code=result)

644

raise gnutls.Error(code=result)

645

646

def _retry_on_error(result, func, arguments):

647

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

648

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

649

while result < 0:

650

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

651

return _error_code(result)

652

result = func(*arguments)

653

return result

654

655

# Unless otherwise indicated, the function declarations below are

656

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

657

658

# Functions

659

priority_set_direct = _library.gnutls_priority_set_direct

660

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

661

ctypes.POINTER(ctypes.c_char_p)]

662

priority_set_direct.restype = _error_code

663

664

init = _library.gnutls_init

665

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

666

init.restype = _error_code

667

668

set_default_priority = _library.gnutls_set_default_priority

669

set_default_priority.argtypes = [session_t]

670

set_default_priority.restype = _error_code

671

672

record_send = _library.gnutls_record_send

673

record_send.argtypes = [session_t, ctypes.c_void_p,

674

ctypes.c_size_t]

675

record_send.restype = ctypes.c_ssize_t

676

record_send.errcheck = _retry_on_error

677

678

certificate_allocate_credentials = (

679

_library.gnutls_certificate_allocate_credentials)

680

certificate_allocate_credentials.argtypes = [

681

ctypes.POINTER(certificate_credentials_t)]

682

certificate_allocate_credentials.restype = _error_code

683

684

certificate_free_credentials = (

685

_library.gnutls_certificate_free_credentials)

686

certificate_free_credentials.argtypes = [

687

certificate_credentials_t]

688

certificate_free_credentials.restype = None

689

690

handshake_set_private_extensions = (

691

_library.gnutls_handshake_set_private_extensions)

692

handshake_set_private_extensions.argtypes = [session_t,

693

ctypes.c_int]

694

handshake_set_private_extensions.restype = None

695

696

credentials_set = _library.gnutls_credentials_set

697

credentials_set.argtypes = [session_t, credentials_type_t,

698

ctypes.c_void_p]

699

credentials_set.restype = _error_code

700

701

strerror = _library.gnutls_strerror

702

strerror.argtypes = [ctypes.c_int]

703

strerror.restype = ctypes.c_char_p

704

705

certificate_type_get = _library.gnutls_certificate_type_get

706

certificate_type_get.argtypes = [session_t]

707

certificate_type_get.restype = _error_code

708

709

certificate_get_peers = _library.gnutls_certificate_get_peers

710

certificate_get_peers.argtypes = [session_t,

711

ctypes.POINTER(ctypes.c_uint)]

712

certificate_get_peers.restype = ctypes.POINTER(datum_t)

713

714

global_set_log_level = _library.gnutls_global_set_log_level

715

global_set_log_level.argtypes = [ctypes.c_int]

716

global_set_log_level.restype = None

717

718

global_set_log_function = _library.gnutls_global_set_log_function

719

global_set_log_function.argtypes = [log_func]

720

global_set_log_function.restype = None

721

722

deinit = _library.gnutls_deinit

723

deinit.argtypes = [session_t]

724

deinit.restype = None

725

726

handshake = _library.gnutls_handshake

727

handshake.argtypes = [session_t]

728

handshake.restype = _error_code

729

handshake.errcheck = _retry_on_error

730

731

transport_set_ptr = _library.gnutls_transport_set_ptr

732

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

733

transport_set_ptr.restype = None

734

735

bye = _library.gnutls_bye

736

bye.argtypes = [session_t, close_request_t]

737

bye.restype = _error_code

738

bye.errcheck = _retry_on_error

739

740

check_version = _library.gnutls_check_version

741

check_version.argtypes = [ctypes.c_char_p]

742

check_version.restype = ctypes.c_char_p

743

744

_need_version = b"3.3.0"

745

if check_version(_need_version) is None:

746

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

747

.format(_need_version))

748

749

_tls_rawpk_version = b"3.6.6"

750

has_rawpk = bool(check_version(_tls_rawpk_version))

751

752

if has_rawpk:

753

# Types

754

class pubkey_st(ctypes.Structure):

755

_fields = []

756

pubkey_t = ctypes.POINTER(pubkey_st)

757

758

x509_crt_fmt_t = ctypes.c_int

759

760

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

761

pubkey_init = _library.gnutls_pubkey_init

762

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

763

pubkey_init.restype = _error_code

764

765

pubkey_import = _library.gnutls_pubkey_import

766

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

767

x509_crt_fmt_t]

768

pubkey_import.restype = _error_code

769

770

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

771

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

772

ctypes.POINTER(ctypes.c_ubyte),

773

ctypes.POINTER(ctypes.c_size_t)]

774

pubkey_get_key_id.restype = _error_code

775

776

pubkey_deinit = _library.gnutls_pubkey_deinit

777

pubkey_deinit.argtypes = [pubkey_t]

778

pubkey_deinit.restype = None

779

else:

780

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

781

782

openpgp_crt_init = _library.gnutls_openpgp_crt_init

783

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

784

openpgp_crt_init.restype = _error_code

785

786

openpgp_crt_import = _library.gnutls_openpgp_crt_import

787

openpgp_crt_import.argtypes = [openpgp_crt_t,

788

ctypes.POINTER(datum_t),

789

openpgp_crt_fmt_t]

790

openpgp_crt_import.restype = _error_code

791

792

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

793

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

794

ctypes.POINTER(ctypes.c_uint)]

795

openpgp_crt_verify_self.restype = _error_code

796

797

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

798

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

799

openpgp_crt_deinit.restype = None

800

801

openpgp_crt_get_fingerprint = (

802

_library.gnutls_openpgp_crt_get_fingerprint)

803

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

804

ctypes.c_void_p,

805

ctypes.POINTER(

806

ctypes.c_size_t)]

807

openpgp_crt_get_fingerprint.restype = _error_code

808

809

if check_version(b"3.6.4"):

810

certificate_type_get2 = _library.gnutls_certificate_type_get2

811

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

812

certificate_type_get2.restype = _error_code

813

814

# Remove non-public functions

815

del _error_code, _retry_on_error

816

817

818

def call_pipe(connection, # : multiprocessing.Connection

819

func, *args, **kwargs):

820

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

821

822

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

823

return value on the provided multiprocessing.Connection.

824

"""

825

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

826

connection.close()

827

828

829

class Client:

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

400

401

402

class Client(object):

830

403

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

831

404

832

405

Attributes:

833

406

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

834

407

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

835

408

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

836

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

837

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

838

running.

839

checker_callback_tag: a GLib event source tag, or None

409

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

410

to see if the client lives.

411

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

840

413

checker_command: string; External command which is run to check

841

414

if client lives. %() expansions are done at

842

415

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

843

416

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

844

checker_initiator_tag: a GLib event source tag, or None

417

checker_initiator_tag: a gobject event source tag, or None

845

418

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

846

419

client_structure: Object describing what attributes a client has

847

420

and is used for storing the client at exit

848

421

current_checker_command: string; current running checker_command

849

disable_initiator_tag: a GLib event source tag, or None

422

disable_initiator_tag: a gobject event source tag, or None

850

423

enabled: bool()

851

424

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

852

uniquely identify an OpenPGP client

853

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

854

a client using raw public keys

425

uniquely identify the client

855

426

host: string; available for use by the checker command

856

427

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

857

428

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

859

430

last_checker_status: integer between 0 and 255 reflecting exit

860

431

status of last checker. -1 reflects crashed

861

432

checker, -2 means no checker completed yet.

862

last_checker_signal: The signal which killed the last checker, if

863

last_checker_status is -1

864

433

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

865

434

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

866

435

D-Bus identifiers

871

440

runtime_expansions: Allowed attributes for runtime expansion.

872

441

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

873

442

disabled, or None

874

server_settings: The server_settings dict from main()

875

443

"""

876

444

877

445

runtime_expansions = ("approval_delay", "approval_duration",

878

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

446

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

879

447

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

880

448

"last_approval_request", "last_checked_ok",

881

449

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

882

client_defaults = {

883

"timeout": "PT5M",

884

"extended_timeout": "PT15M",

885

"interval": "PT2M",

886

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

887

"host": "",

888

"approval_delay": "PT0S",

889

"approval_duration": "PT1S",

890

"approved_by_default": "True",

891

"enabled": "True",

892

}

893

450

client_defaults = { "timeout": "PT5M",

451

"extended_timeout": "PT15M",

452

"interval": "PT2M",

453

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

454

"host": "",

455

"approval_delay": "PT0S",

456

"approval_duration": "PT1S",

457

"approved_by_default": "True",

458

"enabled": "True",

459

}

460

461

def timeout_milliseconds(self):

462

"Return the 'timeout' attribute in milliseconds"

463

return timedelta_to_milliseconds(self.timeout)

464

465

def extended_timeout_milliseconds(self):

466

"Return the 'extended_timeout' attribute in milliseconds"

467

return timedelta_to_milliseconds(self.extended_timeout)

468

469

def interval_milliseconds(self):

470

"Return the 'interval' attribute in milliseconds"

471

return timedelta_to_milliseconds(self.interval)

472

473

def approval_delay_milliseconds(self):

474

return timedelta_to_milliseconds(self.approval_delay)

475

894

476

@staticmethod

895

477

def config_parser(config):

896

478

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

903

485

for client_name in config.sections():

904

486

section = dict(config.items(client_name))

905

487

client = settings[client_name] = {}

906

488

907

489

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

908

490

# Reformat values from string types to Python types

909

491

client["approved_by_default"] = config.getboolean(

910

492

client_name, "approved_by_default")

911

493

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

912

494

"enabled")

913

914

# Uppercase and remove spaces from key_id and fingerprint

915

# for later comparison purposes with return value from the

916

# key_id() and fingerprint() functions

917

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

918

.replace(" ", ""))

495

919

496

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

920

497

.replace(" ", ""))

921

498

if "secret" in section:

922

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

923

.encode("utf-8"),

924

"base64")

499

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

925

500

elif "secfile" in section:

926

501

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

927

502

(section["secfile"])),

928

503

"rb") as secfile:

929

504

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

930

505

else:

931

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

506

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

932

507

.format(section))

933

508

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

934

509

client["extended_timeout"] = string_to_delta(

942

517

client["last_approval_request"] = None

943

518

client["last_checked_ok"] = None

944

519

client["last_checker_status"] = -2

945

520

946

521

return settings

947

948

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

522

523

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

949

524

self.name = name

950

if server_settings is None:

951

server_settings = {}

952

self.server_settings = server_settings

953

525

# adding all client settings

954

for setting, value in settings.items():

526

for setting, value in settings.iteritems():

955

527

setattr(self, setting, value)

956

528

957

529

if self.enabled:

958

530

if not hasattr(self, "last_enabled"):

959

531

self.last_enabled = datetime.datetime.utcnow()

963

535

else:

964

536

self.last_enabled = None

965

537

self.expires = None

966

538

967

539

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

968

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

540

# Uppercase and remove spaces from fingerprint for later

541

# comparison purposes with return value from the fingerprint()

542

# function

969

543

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

970

544

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

971

545

datetime.datetime.utcnow())

972

546

973

547

# attributes specific for this server instance

974

548

self.checker = None

975

549

self.checker_initiator_tag = None

978

552

self.current_checker_command = None

979

553

self.approved = None

980

554

self.approvals_pending = 0

981

self.changedstate = multiprocessing_manager.Condition(

982

multiprocessing_manager.Lock())

983

self.client_structure = [attr

984

for attr in self.__dict__.keys()

555

self.changedstate = (multiprocessing_manager

556

.Condition(multiprocessing_manager

557

.Lock()))

558

self.client_structure = [attr for attr in

559

self.__dict__.iterkeys()

985

560

if not attr.startswith("_")]

986

561

self.client_structure.append("client_structure")

987

988

for name, t in inspect.getmembers(

989

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

562

563

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

564

lambda obj:

565

isinstance(obj,

566

property)):

990

567

if not name.startswith("_"):

991

568

self.client_structure.append(name)

992

569

993

570

# Send notice to process children that client state has changed

994

571

def send_changedstate(self):

995

572

with self.changedstate:

996

573

self.changedstate.notify_all()

997

574

998

575

def enable(self):

999

576

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

1000

577

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

1005

582

self.last_enabled = datetime.datetime.utcnow()

1006

583

self.init_checker()

1007

584

self.send_changedstate()

1008

585

1009

586

def disable(self, quiet=True):

1010

587

"""Disable this client."""

1011

588

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

1013

590

if not quiet:

1014

591

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

1015

592

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

1016

GLib.source_remove(self.disable_initiator_tag)

593

gobject.source_remove(self.disable_initiator_tag)

1017

594

self.disable_initiator_tag = None

1018

595

self.expires = None

1019

596

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

1020

GLib.source_remove(self.checker_initiator_tag)

597

gobject.source_remove(self.checker_initiator_tag)

1021

598

self.checker_initiator_tag = None

1022

599

self.stop_checker()

1023

600

self.enabled = False

1024

601

if not quiet:

1025

602

self.send_changedstate()

1026

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

603

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

1027

604

return False

1028

605

1029

606

def __del__(self):

1030

607

self.disable()

1031

608

1032

609

def init_checker(self):

1033

610

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

1034

611

# and every interval from then on.

1035

612

if self.checker_initiator_tag is not None:

1036

GLib.source_remove(self.checker_initiator_tag)

1037

self.checker_initiator_tag = GLib.timeout_add(

1038

int(self.interval.total_seconds() * 1000),

1039

self.start_checker)

613

gobject.source_remove(self.checker_initiator_tag)

614

self.checker_initiator_tag = (gobject.timeout_add

615

(self.interval_milliseconds(),

616

self.start_checker))

1040

617

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

1041

618

if self.disable_initiator_tag is not None:

1042

GLib.source_remove(self.disable_initiator_tag)

1043

self.disable_initiator_tag = GLib.timeout_add(

1044

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

619

gobject.source_remove(self.disable_initiator_tag)

620

self.disable_initiator_tag = (gobject.timeout_add

621

(self.timeout_milliseconds(),

622

self.disable))

1045

623

# Also start a new checker *right now*.

1046

624

self.start_checker()

1047

1048

def checker_callback(self, source, condition, connection,

1049

command):

625

626

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

1050

627

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

1051

# Read return code from connection (see call_pipe)

1052

returncode = connection.recv()

1053

connection.close()

1054

if self.checker is not None:

1055

self.checker.join()

1056

628

self.checker_callback_tag = None

1057

629

self.checker = None

1058

1059

if returncode >= 0:

1060

self.last_checker_status = returncode

1061

self.last_checker_signal = None

630

if os.WIFEXITED(condition):

631

self.last_checker_status = os.WEXITSTATUS(condition)

1062

632

if self.last_checker_status == 0:

1063

633

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

1064

634

vars(self))

1065

635

self.checked_ok()

1066

636

else:

1067

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

637

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

638

vars(self))

1068

639

else:

1069

640

self.last_checker_status = -1

1070

self.last_checker_signal = -returncode

1071

641

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

1072

642

vars(self))

1073

return False

1074

643

1075

644

def checked_ok(self):

1076

645

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

1077

646

self.last_checked_ok = datetime.datetime.utcnow()

1078

647

self.last_checker_status = 0

1079

self.last_checker_signal = None

1080

648

self.bump_timeout()

1081

649

1082

650

def bump_timeout(self, timeout=None):

1083

651

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

1084

652

if timeout is None:

1085

653

timeout = self.timeout

1086

654

if self.disable_initiator_tag is not None:

1087

GLib.source_remove(self.disable_initiator_tag)

655

gobject.source_remove(self.disable_initiator_tag)

1088

656

self.disable_initiator_tag = None

1089

657

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

1090

self.disable_initiator_tag = GLib.timeout_add(

1091

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

658

self.disable_initiator_tag = (gobject.timeout_add

659

(timedelta_to_milliseconds

660

(timeout), self.disable))

1092

661

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

1093

662

1094

663

def need_approval(self):

1095

664

self.last_approval_request = datetime.datetime.utcnow()

1096

665

1097

666

def start_checker(self):

1098

667

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

1099

668

1100

669

If a checker already exists, leave it running and do

1101

670

nothing."""

1102

671

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

1107

676

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

1108

677

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

1109

678

# should be.

1110

1111

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

1112

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

1113

self.checker.join()

1114

self.checker = None

679

680

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

681

try:

682

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

683

except (AttributeError, OSError) as error:

684

if (isinstance(error, OSError)

685

and error.errno != errno.ECHILD):

686

raise error

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

1115

693

# Start a new checker if needed

1116

694

if self.checker is None:

1117

695

# Escape attributes for the shell

1118

escaped_attrs = {

1119

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

1120

for attr in self.runtime_expansions}

696

escaped_attrs = dict(

697

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

698

for attr in

699

self.runtime_expansions)

1121

700

try:

1122

701

command = self.checker_command % escaped_attrs

1123

702

except TypeError as error:

1124

703

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

1125

self.checker_command,

704

self.checker_command, exc_info=error)

705

return True # Try again later

706

self.current_checker_command = command

707

try:

708

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

709

command, self.name)

710

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

711

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

712

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

713

# always replaced by /dev/null.)

714

self.checker = subprocess.Popen(command,

715

close_fds=True,

716

shell=True, cwd="/")

717

except OSError as error:

718

logger.error("Failed to start subprocess",

1126

719

exc_info=error)

1127

return True # Try again later

1128

self.current_checker_command = command

1129

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

1130

self.name)

1131

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

1132

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

1133

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

1134

# always replaced by /dev/null.)

1135

# The exception is when not debugging but nevertheless

1136

# running in the foreground; use the previously

1137

# created wnull.

1138

popen_args = {"close_fds": True,

1139

"shell": True,

1140

"cwd": "/"}

1141

if (not self.server_settings["debug"]

1142

and self.server_settings["foreground"]):

1143

popen_args.update({"stdout": wnull,

1144

"stderr": wnull})

1145

pipe = multiprocessing.Pipe(duplex=False)

1146

self.checker = multiprocessing.Process(

1147

target=call_pipe,

1148

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

1149

kwargs=popen_args)

1150

self.checker.start()

1151

self.checker_callback_tag = GLib.io_add_watch(

1152

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

1153

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1154

self.checker_callback, pipe[0], command)

1155

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

720

self.checker_callback_tag = (gobject.child_watch_add

721

(self.checker.pid,

722

self.checker_callback,

723

data=command))

724

# The checker may have completed before the gobject

725

# watch was added. Check for this.

726

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

727

if pid:

728

gobject.source_remove(self.checker_callback_tag)

729

self.checker_callback(pid, status, command)

730

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

1156

731

return True

1157

732

1158

733

def stop_checker(self):

1159

734

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

1160

735

if self.checker_callback_tag:

1161

GLib.source_remove(self.checker_callback_tag)

736

gobject.source_remove(self.checker_callback_tag)

1162

737

self.checker_callback_tag = None

1163

738

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

1164

739

return

1165

740

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

1166

self.checker.terminate()

741

try:

742

self.checker.terminate()

743

#time.sleep(0.5)

744

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

745

# self.checker.kill()

746

except OSError as error:

747

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

748

raise

1167

749

self.checker = None

1168

750

1169

751

1170

def dbus_service_property(dbus_interface,

1171

signature="v",

1172

access="readwrite",

1173

byte_arrays=False):

752

def dbus_service_property(dbus_interface, signature="v",

753

access="readwrite", byte_arrays=False):

1174

754

"""Decorators for marking methods of a DBusObjectWithProperties to

1175

755

become properties on the D-Bus.

1176

756

1177

757

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

1178

758

and with one argument by "Set".

1179

759

1180

760

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

1181

761

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

1182

762

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

1185

765

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

1186

766

if byte_arrays and signature != "ay":

1187

767

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

1188

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

1189

768

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

1190

769

def decorator(func):

1191

770

func._dbus_is_property = True

1192

771

func._dbus_interface = dbus_interface

1195

774

func._dbus_name = func.__name__

1196

775

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

1197

776

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

1198

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

777

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1199

778

return func

1200

1201

779

return decorator

1202

780

1203

781

1204

782

def dbus_interface_annotations(dbus_interface):

1205

783

"""Decorator for marking functions returning interface annotations

1206

784

1207

785

Usage:

1208

786

1209

787

@dbus_interface_annotations("org.example.Interface")

1210

788

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

1211

789

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

1212

790

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

1213

791

"false"}

1214

792

"""

1215

1216

793

def decorator(func):

1217

794

func._dbus_is_interface = True

1218

795

func._dbus_interface = dbus_interface

1219

796

func._dbus_name = dbus_interface

1220

797

return func

1221

1222

798

return decorator

1223

799

1224

800

1225

801

def dbus_annotations(annotations):

1226

802

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

1227

803

Usage:

1228

1229

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

1230

"org.freedesktop.DBus.Property."

1231

"EmitsChangedSignal": "false"})

804

1232

805

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

1233

806

access="r")

807

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

808

"org.freedesktop.DBus.Property."

809

"EmitsChangedSignal": "false"})

1234

810

def Property_dbus_property(self):

1235

811

return dbus.Boolean(False)

1236

1237

See also the DBusObjectWithAnnotations class.

1238

812

"""

1239

1240

813

def decorator(func):

1241

814

func._dbus_annotations = annotations

1242

815

return func

1243

1244

816

return decorator

1245

817

1246

818

1247

819

class DBusPropertyException(dbus.exceptions.DBusException):

1248

820

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

1249

821

"""

1250

pass

822

def __unicode__(self):

823

return unicode(str(self))

1251

824

1252

825

1253

826

class DBusPropertyAccessException(DBusPropertyException):

1262

835

pass

1263

836

1264

837

1265

class DBusObjectWithAnnotations(dbus.service.Object):

1266

"""A D-Bus object with annotations.

1267

1268

Classes inheriting from this can use the dbus_annotations

1269

decorator to add annotations to methods or signals.

838

class DBusObjectWithProperties(dbus.service.Object):

839

"""A D-Bus object with properties.

840

841

Classes inheriting from this can use the dbus_service_property

842

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

843

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

1270

844

"""

1271

845

1272

846

@staticmethod

1273

847

def _is_dbus_thing(thing):

1274

848

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

1275

849

1276

850

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

1277

851

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

1278

852

"""

1279

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

853

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

1280

854

False)

1281

855

1282

856

def _get_all_dbus_things(self, thing):

1283

857

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

1284

858

"""

1285

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

859

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

860

name),

1286

861

athing.__get__(self))

1287

862

for cls in self.__class__.__mro__

1288

863

for name, athing in

1289

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

1290

1291

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1292

out_signature="s",

1293

path_keyword='object_path',

1294

connection_keyword='connection')

1295

def Introspect(self, object_path, connection):

1296

"""Overloading of standard D-Bus method.

1297

1298

Inserts annotation tags on methods and signals.

1299

"""

1300

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

1301

connection)

1302

try:

1303

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

1304

1305

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

1306

# Add annotation tags

1307

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

1308

for tag in if_tag.getElementsByTagName(typ):

1309

annots = dict()

1310

for name, prop in (self.

1311

_get_all_dbus_things(typ)):

1312

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

1313

and prop._dbus_interface

1314

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

1315

annots.update(getattr(

1316

prop, "_dbus_annotations", {}))

1317

for name, value in annots.items():

1318

ann_tag = document.createElement(

1319

"annotation")

1320

ann_tag.setAttribute("name", name)

1321

ann_tag.setAttribute("value", value)

1322

tag.appendChild(ann_tag)

1323

# Add interface annotation tags

1324

for annotation, value in dict(

1325

itertools.chain.from_iterable(

1326

annotations().items()

1327

for name, annotations

1328

in self._get_all_dbus_things("interface")

1329

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

1330

)).items():

1331

ann_tag = document.createElement("annotation")

1332

ann_tag.setAttribute("name", annotation)

1333

ann_tag.setAttribute("value", value)

1334

if_tag.appendChild(ann_tag)

1335

# Fix argument name for the Introspect method itself

1336

if (if_tag.getAttribute("name")

1337

== dbus.INTROSPECTABLE_IFACE):

1338

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

1339

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

1340

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

1341

if (arg.getAttribute("direction")

1342

== "out"):

1343

arg.setAttribute("name",

1344

"xml_data")

1345

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

1346

document.unlink()

1347

except (AttributeError, xml.dom.DOMException,

1348

xml.parsers.expat.ExpatError) as error:

1349

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

1350

exc_info=error)

1351

return xmlstring

1352

1353

1354

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1355

"""A D-Bus object with properties.

1356

1357

Classes inheriting from this can use the dbus_service_property

1358

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

1359

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

1360

"""

1361

864

inspect.getmembers(cls,

865

self._is_dbus_thing(thing)))

866

1362

867

def _get_dbus_property(self, interface_name, property_name):

1363

868

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

1364

869

property with the specified name and interface.

1365

870

"""

1366

for cls in self.__class__.__mro__:

1367

for name, value in inspect.getmembers(

1368

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

871

for cls in self.__class__.__mro__:

872

for name, value in (inspect.getmembers

873

(cls,

874

self._is_dbus_thing("property"))):

1369

875

if (value._dbus_name == property_name

1370

876

and value._dbus_interface == interface_name):

1371

877

return value.__get__(self)

1372

878

1373

879

# No such property

1374

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

1375

self.dbus_object_path, interface_name, property_name))

1376

1377

@classmethod

1378

def _get_all_interface_names(cls):

1379

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

1380

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

1381

"_dbus_interface", None)

1382

for x in (inspect.getmro(cls))

1383

for attr in dir(x))

1384

if name is not None)

1385

1386

@dbus.service.method(dbus.PROPERTIES_IFACE,

1387

in_signature="ss",

880

raise DBusPropertyNotFound(self.dbus_object_path + ":"

881

+ interface_name + "."

882

+ property_name)

883

884

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

1388

885

out_signature="v")

1389

886

def Get(self, interface_name, property_name):

1390

887

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

1396

893

if not hasattr(value, "variant_level"):

1397

894

return value

1398

895

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

1399

896

1400

897

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

1401

898

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

1402

899

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

1408

905

# The byte_arrays option is not supported yet on

1409

906

# signatures other than "ay".

1410

907

if prop._dbus_signature != "ay":

1411

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

1412

"'ay' signature {!r}"

1413

.format(prop._dbus_signature))

1414

value = dbus.ByteArray(bytes(value))

908

raise ValueError

909

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

910

for byte in value))

1415

911

prop(value)

1416

1417

@dbus.service.method(dbus.PROPERTIES_IFACE,

1418

in_signature="s",

912

913

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

1419

914

out_signature="a{sv}")

1420

915

def GetAll(self, interface_name):

1421

916

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

1422

917

standard.

1423

918

1424

919

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

1425

920

"""

1426

921

properties = {}

1436

931

if not hasattr(value, "variant_level"):

1437

932

properties[name] = value

1438

933

continue

1439

properties[name] = type(value)(

1440

value, variant_level=value.variant_level + 1)

934

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

935

value.variant_level+1)

1441

936

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

1442

1443

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

1444

def PropertiesChanged(self, interface_name, changed_properties,

1445

invalidated_properties):

1446

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

1447

standard.

1448

"""

1449

pass

1450

937

1451

938

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1452

939

out_signature="s",

1453

940

path_keyword='object_path',

1454

941

connection_keyword='connection')

1455

942

def Introspect(self, object_path, connection):

1456

943

"""Overloading of standard D-Bus method.

1457

944

1458

945

Inserts property tags and interface annotation tags.

1459

946

"""

1460

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1461

object_path,

1462

connection)

947

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

948

connection)

1463

949

try:

1464

950

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

1465

1466

951

def make_tag(document, name, prop):

1467

952

e = document.createElement("property")

1468

953

e.setAttribute("name", name)

1469

954

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

1470

955

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

1471

956

return e

1472

1473

957

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

1474

958

# Add property tags

1475

959

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

1478

962

if prop._dbus_interface

1479

963

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

1480

964

if_tag.appendChild(tag)

1481

# Add annotation tags for properties

1482

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

1483

annots = dict()

1484

for name, prop in self._get_all_dbus_things(

1485

"property"):

1486

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

1487

and prop._dbus_interface

1488

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

1489

annots.update(getattr(

1490

prop, "_dbus_annotations", {}))

1491

for name, value in annots.items():

1492

ann_tag = document.createElement(

1493

"annotation")

1494

ann_tag.setAttribute("name", name)

1495

ann_tag.setAttribute("value", value)

1496

tag.appendChild(ann_tag)

965

# Add annotation tags

966

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

967

for tag in if_tag.getElementsByTagName(typ):

968

annots = dict()

969

for name, prop in (self.

970

_get_all_dbus_things(typ)):

971

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

972

and prop._dbus_interface

973

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

974

annots.update(getattr

975

(prop,

976

"_dbus_annotations",

977

{}))

978

for name, value in annots.iteritems():

979

ann_tag = document.createElement(

980

"annotation")

981

ann_tag.setAttribute("name", name)

982

ann_tag.setAttribute("value", value)

983

tag.appendChild(ann_tag)

984

# Add interface annotation tags

985

for annotation, value in dict(

986

itertools.chain.from_iterable(

987

annotations().iteritems()

988

for name, annotations in

989

self._get_all_dbus_things("interface")

990

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

991

)).iteritems():

992

ann_tag = document.createElement("annotation")

993

ann_tag.setAttribute("name", annotation)

994

ann_tag.setAttribute("value", value)

995

if_tag.appendChild(ann_tag)

1497

996

# Add the names to the return values for the

1498

997

# "org.freedesktop.DBus.Properties" methods

1499

998

if (if_tag.getAttribute("name")

1518

1017

return xmlstring

1519

1018

1520

1019

1521

try:

1522

dbus.OBJECT_MANAGER_IFACE

1523

except AttributeError:

1524

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

1525

1526

1527

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1528

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

1529

1530

Classes inheriting from this exposes the standard

1531

GetManagedObjects call and the InterfacesAdded and

1532

InterfacesRemoved signals on the standard

1533

"org.freedesktop.DBus.ObjectManager" interface.

1534

1535

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

1536

manually.

1537

"""

1538

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1539

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

1540

def GetManagedObjects(self):

1541

"""This function must be overridden"""

1542

raise NotImplementedError()

1543

1544

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1545

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

1546

def InterfacesAdded(self, object_path, interfaces_and_properties):

1547

pass

1548

1549

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

1550

def InterfacesRemoved(self, object_path, interfaces):

1551

pass

1552

1553

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1554

out_signature="s",

1555

path_keyword='object_path',

1556

connection_keyword='connection')

1557

def Introspect(self, object_path, connection):

1558

"""Overloading of standard D-Bus method.

1559

1560

Override return argument name of GetManagedObjects to be

1561

"objpath_interfaces_and_properties"

1562

"""

1563

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1564

object_path,

1565

connection)

1566

try:

1567

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

1568

1569

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

1570

# Fix argument name for the GetManagedObjects method

1571

if (if_tag.getAttribute("name")

1572

== dbus.OBJECT_MANAGER_IFACE):

1573

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

1574

if (cn.getAttribute("name")

1575

== "GetManagedObjects"):

1576

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

1577

if (arg.getAttribute("direction")

1578

== "out"):

1579

arg.setAttribute(

1580

"name",

1581

"objpath_interfaces"

1582

"_and_properties")

1583

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

1584

document.unlink()

1585

except (AttributeError, xml.dom.DOMException,

1586

xml.parsers.expat.ExpatError) as error:

1587

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

1588

exc_info=error)

1589

return xmlstring

1590

1591

1592

1020

def datetime_to_dbus(dt, variant_level=0):

1593

1021

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

1594

1022

if dt is None:

1595

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

1596

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

1023

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

1024

return dbus.String(dt.isoformat(),

1025

variant_level=variant_level)

1597

1026

1598

1027

1599

1028

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1601

1030

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

1602

1031

interface names according to the "alt_interface_names" mapping.

1603

1032

Usage:

1604

1033

1605

1034

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

1606

1035

"net.example.AlternateInterface"})

1607

1036

class SampleDBusObject(dbus.service.Object):

1608

1037

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

1609

1038

def SampleDBusMethod():

1610

1039

pass

1611

1040

1612

1041

The above "SampleDBusMethod" on "SampleDBusObject" will be

1613

1042

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

1614

1043

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

1615

1044

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

1616

1045

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

1617

1046

1618

1047

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

1619

1048

(from DBusObjectWithProperties) and interfaces (from the

1620

1049

dbus_interface_annotations decorator).

1621

1050

"""

1622

1623

1051

def wrapper(cls):

1624

1052

for orig_interface_name, alt_interface_name in (

1625

alt_interface_names.items()):

1053

alt_interface_names.iteritems()):

1626

1054

attr = {}

1627

1055

interface_names = set()

1628

1056

# Go though all attributes of the class

1630

1058

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

1631

1059

# with the wrong interface name

1632

1060

if (not hasattr(attribute, "_dbus_interface")

1633

or not attribute._dbus_interface.startswith(

1634

orig_interface_name)):

1061

or not attribute._dbus_interface

1062

.startswith(orig_interface_name)):

1635

1063

continue

1636

1064

# Create an alternate D-Bus interface name based on

1637

1065

# the current name

1638

alt_interface = attribute._dbus_interface.replace(

1639

orig_interface_name, alt_interface_name)

1066

alt_interface = (attribute._dbus_interface

1067

.replace(orig_interface_name,

1068

alt_interface_name))

1640

1069

interface_names.add(alt_interface)

1641

1070

# Is this a D-Bus signal?

1642

1071

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

1643

# Extract the original non-method undecorated

1644

# function by black magic

1645

if sys.version_info.major == 2:

1646

nonmethod_func = (dict(

1072

# Extract the original non-method function by

1073

# black magic

1074

nonmethod_func = (dict(

1647

1075

zip(attribute.func_code.co_freevars,

1648

attribute.__closure__))

1649

["func"].cell_contents)

1650

else:

1651

nonmethod_func = (dict(

1652

zip(attribute.__code__.co_freevars,

1653

attribute.__closure__))

1654

["func"].cell_contents)

1076

attribute.__closure__))["func"]

1077

.cell_contents)

1655

1078

# Create a new, but exactly alike, function

1656

1079

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

1657

1080

# with the alternate D-Bus interface name

1658

new_function = copy_function(nonmethod_func)

1659

new_function = (dbus.service.signal(

1660

alt_interface,

1661

attribute._dbus_signature)(new_function))

1081

new_function = (dbus.service.signal

1082

(alt_interface,

1083

attribute._dbus_signature)

1084

(types.FunctionType(

1085

nonmethod_func.func_code,

1086

nonmethod_func.func_globals,

1087

nonmethod_func.func_name,

1088

nonmethod_func.func_defaults,

1089

nonmethod_func.func_closure)))

1662

1090

# Copy annotations, if any

1663

1091

try:

1664

new_function._dbus_annotations = dict(

1665

attribute._dbus_annotations)

1092

new_function._dbus_annotations = (

1093

dict(attribute._dbus_annotations))

1666

1094

except AttributeError:

1667

1095

pass

1668

1669

1096

# Define a creator of a function to call both the

1670

1097

# original and alternate functions, so both the

1671

1098

# original and alternate signals gets sent when

1674

1101

"""This function is a scope container to pass

1675

1102

func1 and func2 to the "call_both" function

1676

1103

outside of its arguments"""

1677

1678

@functools.wraps(func2)

1679

1104

def call_both(*args, **kwargs):

1680

1105

"""This function will emit two D-Bus

1681

1106

signals by calling func1 and func2"""

1682

1107

func1(*args, **kwargs)

1683

1108

func2(*args, **kwargs)

1684

# Make wrapper function look like a D-Bus

1685

# signal

1686

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

1687

if name.startswith("_dbus_"):

1688

setattr(call_both, name, attr)

1689

1690

1109

return call_both

1691

1110

# Create the "call_both" function and add it to

1692

1111

# the class

1697

1116

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

1698

1117

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

1699

1118

# to the class.

1700

attr[attrname] = (

1701

dbus.service.method(

1702

alt_interface,

1703

attribute._dbus_in_signature,

1704

attribute._dbus_out_signature)

1705

(copy_function(attribute)))

1119

attr[attrname] = (dbus.service.method

1120

(alt_interface,

1121

attribute._dbus_in_signature,

1122

attribute._dbus_out_signature)

1123

(types.FunctionType

1124

(attribute.func_code,

1125

attribute.func_globals,

1126

attribute.func_name,

1127

attribute.func_defaults,

1128

attribute.func_closure)))

1706

1129

# Copy annotations, if any

1707

1130

try:

1708

attr[attrname]._dbus_annotations = dict(

1709

attribute._dbus_annotations)

1131

attr[attrname]._dbus_annotations = (

1132

dict(attribute._dbus_annotations))

1710

1133

except AttributeError:

1711

1134

pass

1712

1135

# Is this a D-Bus property?

1715

1138

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

1716

1139

# property with the alternate D-Bus interface

1717

1140

# name. Add it to the class.

1718

attr[attrname] = (dbus_service_property(

1719

alt_interface, attribute._dbus_signature,

1720

attribute._dbus_access,

1721

attribute._dbus_get_args_options

1722

["byte_arrays"])

1723

(copy_function(attribute)))

1141

attr[attrname] = (dbus_service_property

1142

(alt_interface,

1143

attribute._dbus_signature,

1144

attribute._dbus_access,

1145

attribute

1146

._dbus_get_args_options

1147

["byte_arrays"])

1148

(types.FunctionType

1149

(attribute.func_code,

1150

attribute.func_globals,

1151

attribute.func_name,

1152

attribute.func_defaults,

1153

attribute.func_closure)))

1724

1154

# Copy annotations, if any

1725

1155

try:

1726

attr[attrname]._dbus_annotations = dict(

1727

attribute._dbus_annotations)

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1728

1158

except AttributeError:

1729

1159

pass

1730

1160

# Is this a D-Bus interface?

1733

1163

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

1734

1164

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

1735

1165

# to the class.

1736

attr[attrname] = (

1737

dbus_interface_annotations(alt_interface)

1738

(copy_function(attribute)))

1166

attr[attrname] = (dbus_interface_annotations

1167

(alt_interface)

1168

(types.FunctionType

1169

(attribute.func_code,

1170

attribute.func_globals,

1171

attribute.func_name,

1172

attribute.func_defaults,

1173

attribute.func_closure)))

1739

1174

if deprecate:

1740

1175

# Deprecate all alternate interfaces

1741

iname = "_AlternateDBusNames_interface_annotation{}"

1176

iname="_AlternateDBusNames_interface_annotation{0}"

1742

1177

for interface_name in interface_names:

1743

1744

1178

@dbus_interface_annotations(interface_name)

1745

1179

def func(self):

1746

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

1747

"true"}

1180

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

1181

"true" }

1748

1182

# Find an unused name

1749

1183

for aname in (iname.format(i)

1750

1184

for i in itertools.count()):

1754

1188

if interface_names:

1755

1189

# Replace the class with a new subclass of it with

1756

1190

# methods, signals, etc. as created above.

1757

if sys.version_info.major == 2:

1758

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

1759

(cls, ), attr)

1760

else:

1761

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

1762

(cls, ), attr)

1191

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

1192

(cls,), attr)

1763

1193

return cls

1764

1765

1194

return wrapper

1766

1195

1767

1196

1768

1197

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

1769

"se.bsnet.fukt.Mandos"})

1198

"se.bsnet.fukt.Mandos"})

1770

1199

class ClientDBus(Client, DBusObjectWithProperties):

1771

1200

"""A Client class using D-Bus

1772

1201

1773

1202

Attributes:

1774

1203

dbus_object_path: dbus.ObjectPath

1775

1204

bus: dbus.SystemBus()

1776

1205

"""

1777

1206

1778

1207

runtime_expansions = (Client.runtime_expansions

1779

+ ("dbus_object_path", ))

1780

1781

_interface = "se.recompile.Mandos.Client"

1782

1208

+ ("dbus_object_path",))

1209

1783

1210

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

1784

1785

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

1211

1212

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

1786

1213

self.bus = bus

1787

1214

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

1788

1215

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

1789

1216

# the D-Bus

1790

client_object_name = str(self.name).translate(

1217

client_object_name = unicode(self.name).translate(

1791

1218

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

1792

1219

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

1793

self.dbus_object_path = dbus.ObjectPath(

1794

"/clients/" + client_object_name)

1220

self.dbus_object_path = (dbus.ObjectPath

1221

("/clients/" + client_object_name))

1795

1222

DBusObjectWithProperties.__init__(self, self.bus,

1796

1223

self.dbus_object_path)

1797

1798

def notifychangeproperty(transform_func, dbus_name,

1799

type_func=lambda x: x,

1800

variant_level=1,

1801

invalidate_only=False,

1802

_interface=_interface):

1224

1225

def notifychangeproperty(transform_func,

1226

dbus_name, type_func=lambda x: x,

1227

variant_level=1):

1803

1228

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

1804

1229

its changes to DBus.

1805

1230

1806

1231

transform_fun: Function that takes a value and a variant_level

1807

1232

and transforms it to a D-Bus type.

1808

1233

dbus_name: D-Bus name of the variable

1810

1235

to the D-Bus. Default: no transform

1811

1236

variant_level: D-Bus variant level. Default: 1

1812

1237

"""

1813

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

1814

1238

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

1815

1239

def setter(self, value):

1816

1240

if hasattr(self, "dbus_object_path"):

1817

1241

if (not hasattr(self, attrname) or

1818

1242

type_func(getattr(self, attrname, None))

1819

1243

!= type_func(value)):

1820

if invalidate_only:

1821

self.PropertiesChanged(

1822

_interface, dbus.Dictionary(),

1823

dbus.Array((dbus_name, )))

1824

else:

1825

dbus_value = transform_func(

1826

type_func(value),

1827

variant_level=variant_level)

1828

self.PropertyChanged(dbus.String(dbus_name),

1829

dbus_value)

1830

self.PropertiesChanged(

1831

_interface,

1832

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

1833

dbus_value}),

1834

dbus.Array())

1244

dbus_value = transform_func(type_func(value),

1245

variant_level

1246

=variant_level)

1247

self.PropertyChanged(dbus.String(dbus_name),

1248

dbus_value)

1835

1249

setattr(self, attrname, value)

1836

1250

1837

1251

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

1838

1252

1839

1253

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1840

1254

approvals_pending = notifychangeproperty(dbus.Boolean,

1841

1255

"ApprovalPending",

1842

type_func=bool)

1256

type_func = bool)

1843

1257

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

1844

1258

last_enabled = notifychangeproperty(datetime_to_dbus,

1845

1259

"LastEnabled")

1846

checker = notifychangeproperty(

1847

dbus.Boolean, "CheckerRunning",

1848

type_func=lambda checker: checker is not None)

1260

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

1261

type_func = lambda checker:

1262

checker is not None)

1849

1263

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1850

1264

"LastCheckedOK")

1851

1265

last_checker_status = notifychangeproperty(dbus.Int16,

1854

1268

datetime_to_dbus, "LastApprovalRequest")

1855

1269

approved_by_default = notifychangeproperty(dbus.Boolean,

1856

1270

"ApprovedByDefault")

1857

approval_delay = notifychangeproperty(

1858

dbus.UInt64, "ApprovalDelay",

1859

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

1271

approval_delay = notifychangeproperty(dbus.UInt64,

1272

"ApprovalDelay",

1273

type_func =

1274

timedelta_to_milliseconds)

1860

1275

approval_duration = notifychangeproperty(

1861

1276

dbus.UInt64, "ApprovalDuration",

1862

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

1277

type_func = timedelta_to_milliseconds)

1863

1278

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

1864

timeout = notifychangeproperty(

1865

dbus.UInt64, "Timeout",

1866

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

1279

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

1280

type_func =

1281

timedelta_to_milliseconds)

1867

1282

extended_timeout = notifychangeproperty(

1868

1283

dbus.UInt64, "ExtendedTimeout",

1869

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

1870

interval = notifychangeproperty(

1871

dbus.UInt64, "Interval",

1872

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

1284

type_func = timedelta_to_milliseconds)

1285

interval = notifychangeproperty(dbus.UInt64,

1286

"Interval",

1287

type_func =

1288

timedelta_to_milliseconds)

1873

1289

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

1874

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

1875

invalidate_only=True)

1876

1290

1877

1291

del notifychangeproperty

1878

1292

1879

1293

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

1880

1294

try:

1881

1295

self.remove_from_connection()

1884

1298

if hasattr(DBusObjectWithProperties, "__del__"):

1885

1299

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

1886

1300

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

1887

1888

def checker_callback(self, source, condition,

1889

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

1890

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

1891

connection, command, *args,

1892

**kwargs)

1893

exitstatus = self.last_checker_status

1894

if exitstatus >= 0:

1301

1302

def checker_callback(self, pid, condition, command,

1303

*args, **kwargs):

1304

self.checker_callback_tag = None

1305

self.checker = None

1306

if os.WIFEXITED(condition):

1307

exitstatus = os.WEXITSTATUS(condition)

1895

1308

# Emit D-Bus signal

1896

1309

self.CheckerCompleted(dbus.Int16(exitstatus),

1897

# This is specific to GNU libC

1898

dbus.Int64(exitstatus << 8),

1310

dbus.Int64(condition),

1899

1311

dbus.String(command))

1900

1312

else:

1901

1313

# Emit D-Bus signal

1902

1314

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

1903

dbus.Int64(

1904

# This is specific to GNU libC

1905

(exitstatus << 8)

1906

| self.last_checker_signal),

1315

dbus.Int64(condition),

1907

1316

dbus.String(command))

1908

return ret

1909

1317

1318

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

1319

*args, **kwargs)

1320

1910

1321

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

1911

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

1322

old_checker = self.checker

1323

if self.checker is not None:

1324

old_checker_pid = self.checker.pid

1325

else:

1326

old_checker_pid = None

1912

1327

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

1913

1328

# Only if new checker process was started

1914

1329

if (self.checker is not None

1916

1331

# Emit D-Bus signal

1917

1332

self.CheckerStarted(self.current_checker_command)

1918

1333

return r

1919

1334

1920

1335

def _reset_approved(self):

1921

1336

self.approved = None

1922

1337

return False

1923

1338

1924

1339

def approve(self, value=True):

1925

1340

self.approved = value

1926

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

1927

* 1000), self._reset_approved)

1341

gobject.timeout_add(timedelta_to_milliseconds

1342

(self.approval_duration),

1343

self._reset_approved)

1928

1344

self.send_changedstate()

1929

1930

# D-Bus methods, signals & properties

1931

1932

# Interfaces

1933

1934

# Signals

1935

1345

1346

## D-Bus methods, signals & properties

1347

_interface = "se.recompile.Mandos.Client"

1348

1349

## Interfaces

1350

1351

@dbus_interface_annotations(_interface)

1352

def _foo(self):

1353

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

1354

"false"}

1355

1356

## Signals

1357

1936

1358

# CheckerCompleted - signal

1937

1359

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

1938

1360

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

1939

1361

"D-Bus signal"

1940

1362

pass

1941

1363

1942

1364

# CheckerStarted - signal

1943

1365

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

1944

1366

def CheckerStarted(self, command):

1945

1367

"D-Bus signal"

1946

1368

pass

1947

1369

1948

1370

# PropertyChanged - signal

1949

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

1950

1371

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

1951

1372

def PropertyChanged(self, property, value):

1952

1373

"D-Bus signal"

1953

1374

pass

1954

1375

1955

1376

# GotSecret - signal

1956

1377

@dbus.service.signal(_interface)

1957

1378

def GotSecret(self):

1960

1381

server to mandos-client

1961

1382

"""

1962

1383

pass

1963

1384

1964

1385

# Rejected - signal

1965

1386

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

1966

1387

def Rejected(self, reason):

1967

1388

"D-Bus signal"

1968

1389

pass

1969

1390

1970

1391

# NeedApproval - signal

1971

1392

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

1972

1393

def NeedApproval(self, timeout, default):

1973

1394

"D-Bus signal"

1974

1395

return self.need_approval()

1975

1976

# Methods

1977

1396

1397

## Methods

1398

1978

1399

# Approve - method

1979

1400

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

1980

1401

def Approve(self, value):

1981

1402

self.approve(value)

1982

1403

1983

1404

# CheckedOK - method

1984

1405

@dbus.service.method(_interface)

1985

1406

def CheckedOK(self):

1986

1407

self.checked_ok()

1987

1408

1988

1409

# Enable - method

1989

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

1990

1410

@dbus.service.method(_interface)

1991

1411

def Enable(self):

1992

1412

"D-Bus method"

1993

1413

self.enable()

1994

1414

1995

1415

# StartChecker - method

1996

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

1997

1416

@dbus.service.method(_interface)

1998

1417

def StartChecker(self):

1999

1418

"D-Bus method"

2000

1419

self.start_checker()

2001

1420

2002

1421

# Disable - method

2003

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

2004

1422

@dbus.service.method(_interface)

2005

1423

def Disable(self):

2006

1424

"D-Bus method"

2007

1425

self.disable()

2008

1426

2009

1427

# StopChecker - method

2010

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

2011

1428

@dbus.service.method(_interface)

2012

1429

def StopChecker(self):

2013

1430

self.stop_checker()

2014

2015

# Properties

2016

1431

1432

## Properties

1433

2017

1434

# ApprovalPending - property

2018

1435

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

2019

1436

def ApprovalPending_dbus_property(self):

2020

1437

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

2021

1438

2022

1439

# ApprovedByDefault - property

2023

@dbus_service_property(_interface,

2024

signature="b",

1440

@dbus_service_property(_interface, signature="b",

2025

1441

access="readwrite")

2026

1442

def ApprovedByDefault_dbus_property(self, value=None):

2027

1443

if value is None: # get

2028

1444

return dbus.Boolean(self.approved_by_default)

2029

1445

self.approved_by_default = bool(value)

2030

1446

2031

1447

# ApprovalDelay - property

2032

@dbus_service_property(_interface,

2033

signature="t",

1448

@dbus_service_property(_interface, signature="t",

2034

1449

access="readwrite")

2035

1450

def ApprovalDelay_dbus_property(self, value=None):

2036

1451

if value is None: # get

2037

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

2038

* 1000)

1452

return dbus.UInt64(self.approval_delay_milliseconds())

2039

1453

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

2040

1454

2041

1455

# ApprovalDuration - property

2042

@dbus_service_property(_interface,

2043

signature="t",

1456

@dbus_service_property(_interface, signature="t",

2044

1457

access="readwrite")

2045

1458

def ApprovalDuration_dbus_property(self, value=None):

2046

1459

if value is None: # get

2047

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

2048

* 1000)

1460

return dbus.UInt64(timedelta_to_milliseconds(

1461

self.approval_duration))

2049

1462

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

2050

1463

2051

1464

# Name - property

2052

@dbus_annotations(

2053

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

2054

1465

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

2055

1466

def Name_dbus_property(self):

2056

1467

return dbus.String(self.name)

2057

2058

# KeyID - property

2059

@dbus_annotations(

2060

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

2061

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

2062

def KeyID_dbus_property(self):

2063

return dbus.String(self.key_id)

2064

1468

2065

1469

# Fingerprint - property

2066

@dbus_annotations(

2067

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

2068

1470

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

2069

1471

def Fingerprint_dbus_property(self):

2070

1472

return dbus.String(self.fingerprint)

2071

1473

2072

1474

# Host - property

2073

@dbus_service_property(_interface,

2074

signature="s",

1475

@dbus_service_property(_interface, signature="s",

2075

1476

access="readwrite")

2076

1477

def Host_dbus_property(self, value=None):

2077

1478

if value is None: # get

2078

1479

return dbus.String(self.host)

2079

self.host = str(value)

2080

1480

self.host = unicode(value)

1481

2081

1482

# Created - property

2082

@dbus_annotations(

2083

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

2084

1483

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

2085

1484

def Created_dbus_property(self):

2086

1485

return datetime_to_dbus(self.created)

2087

1486

2088

1487

# LastEnabled - property

2089

1488

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

2090

1489

def LastEnabled_dbus_property(self):

2091

1490

return datetime_to_dbus(self.last_enabled)

2092

1491

2093

1492

# Enabled - property

2094

@dbus_service_property(_interface,

2095

signature="b",

1493

@dbus_service_property(_interface, signature="b",

2096

1494

access="readwrite")

2097

1495

def Enabled_dbus_property(self, value=None):

2098

1496

if value is None: # get

2101

1499

self.enable()

2102

1500

else:

2103

1501

self.disable()

2104

1502

2105

1503

# LastCheckedOK - property

2106

@dbus_service_property(_interface,

2107

signature="s",

1504

@dbus_service_property(_interface, signature="s",

2108

1505

access="readwrite")

2109

1506

def LastCheckedOK_dbus_property(self, value=None):

2110

1507

if value is not None:

2111

1508

self.checked_ok()

2112

1509

return

2113

1510

return datetime_to_dbus(self.last_checked_ok)

2114

1511

2115

1512

# LastCheckerStatus - property

2116

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

1513

@dbus_service_property(_interface, signature="n",

1514

access="read")

2117

1515

def LastCheckerStatus_dbus_property(self):

2118

1516

return dbus.Int16(self.last_checker_status)

2119

1517

2120

1518

# Expires - property

2121

1519

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

2122

1520

def Expires_dbus_property(self):

2123

1521

return datetime_to_dbus(self.expires)

2124

1522

2125

1523

# LastApprovalRequest - property

2126

1524

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

2127

1525

def LastApprovalRequest_dbus_property(self):

2128

1526

return datetime_to_dbus(self.last_approval_request)

2129

1527

2130

1528

# Timeout - property

2131

@dbus_service_property(_interface,

2132

signature="t",

1529

@dbus_service_property(_interface, signature="t",

2133

1530

access="readwrite")

2134

1531

def Timeout_dbus_property(self, value=None):

2135

1532

if value is None: # get

2136

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

1533

return dbus.UInt64(self.timeout_milliseconds())

2137

1534

old_timeout = self.timeout

2138

1535

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

2139

1536

# Reschedule disabling

2147

1544

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

2148

1545

is None):

2149

1546

return

2150

GLib.source_remove(self.disable_initiator_tag)

2151

self.disable_initiator_tag = GLib.timeout_add(

2152

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

2153

self.disable)

2154

1547

gobject.source_remove(self.disable_initiator_tag)

1548

self.disable_initiator_tag = (

1549

gobject.timeout_add(

1550

timedelta_to_milliseconds(self.expires - now),

1551

self.disable))

1552

2155

1553

# ExtendedTimeout - property

2156

@dbus_service_property(_interface,

2157

signature="t",

1554

@dbus_service_property(_interface, signature="t",

2158

1555

access="readwrite")

2159

1556

def ExtendedTimeout_dbus_property(self, value=None):

2160

1557

if value is None: # get

2161

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

2162

* 1000)

1558

return dbus.UInt64(self.extended_timeout_milliseconds())

2163

1559

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

2164

1560

2165

1561

# Interval - property

2166

@dbus_service_property(_interface,

2167

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2168

1563

access="readwrite")

2169

1564

def Interval_dbus_property(self, value=None):

2170

1565

if value is None: # get

2171

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

1566

return dbus.UInt64(self.interval_milliseconds())

2172

1567

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

2173

1568

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

2174

1569

return

2175

1570

if self.enabled:

2176

1571

# Reschedule checker run

2177

GLib.source_remove(self.checker_initiator_tag)

2178

self.checker_initiator_tag = GLib.timeout_add(

2179

value, self.start_checker)

2180

self.start_checker() # Start one now, too

2181

1572

gobject.source_remove(self.checker_initiator_tag)

1573

self.checker_initiator_tag = (gobject.timeout_add

1574

(value, self.start_checker))

1575

self.start_checker() # Start one now, too

1576

2182

1577

# Checker - property

2183

@dbus_service_property(_interface,

2184

signature="s",

1578

@dbus_service_property(_interface, signature="s",

2185

1579

access="readwrite")

2186

1580

def Checker_dbus_property(self, value=None):

2187

1581

if value is None: # get

2188

1582

return dbus.String(self.checker_command)

2189

self.checker_command = str(value)

2190

1583

self.checker_command = unicode(value)

1584

2191

1585

# CheckerRunning - property

2192

@dbus_service_property(_interface,

2193

signature="b",

1586

@dbus_service_property(_interface, signature="b",

2194

1587

access="readwrite")

2195

1588

def CheckerRunning_dbus_property(self, value=None):

2196

1589

if value is None: # get

2199

1592

self.start_checker()

2200

1593

else:

2201

1594

self.stop_checker()

2202

1595

2203

1596

# ObjectPath - property

2204

@dbus_annotations(

2205

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

2206

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

2207

1597

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

2208

1598

def ObjectPath_dbus_property(self):

2209

return self.dbus_object_path # is already a dbus.ObjectPath

2210

1599

return self.dbus_object_path # is already a dbus.ObjectPath

1600

2211

1601

# Secret = property

2212

@dbus_annotations(

2213

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

2214

"invalidates"})

2215

@dbus_service_property(_interface,

2216

signature="ay",

2217

access="write",

2218

byte_arrays=True)

1602

@dbus_service_property(_interface, signature="ay",

1603

access="write", byte_arrays=True)

2219

1604

def Secret_dbus_property(self, value):

2220

self.secret = bytes(value)

2221

1605

self.secret = str(value)

1606

2222

1607

del _interface

2223

1608

2224

1609

2225

class ProxyClient:

2226

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

1610

class ProxyClient(object):

1611

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

2227

1612

self._pipe = child_pipe

2228

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

1613

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

2229

1614

if not self._pipe.recv():

2230

raise KeyError(key_id or fpr)

2231

1615

raise KeyError()

1616

2232

1617

def __getattribute__(self, name):

2233

1618

if name == '_pipe':

2234

1619

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

2237

1622

if data[0] == 'data':

2238

1623

return data[1]

2239

1624

if data[0] == 'function':

2240

2241

1625

def func(*args, **kwargs):

2242

1626

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

2243

1627

return self._pipe.recv()[1]

2244

2245

1628

return func

2246

1629

2247

1630

def __setattr__(self, name, value):

2248

1631

if name == '_pipe':

2249

1632

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

2252

1635

2253

1636

class ClientHandler(socketserver.BaseRequestHandler, object):

2254

1637

"""A class to handle client connections.

2255

1638

2256

1639

Instantiated once for each connection to handle it.

2257

1640

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

2258

1641

2259

1642

def handle(self):

2260

1643

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

2261

1644

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

2262

str(self.client_address))

1645

unicode(self.client_address))

2263

1646

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

2264

1647

self.server.child_pipe.fileno())

2265

2266

session = gnutls.ClientSession(self.request)

2267

2268

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

2269

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

2270

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

2271

# "+DHE-DSS"))

1648

1649

session = (gnutls.connection

1650

.ClientSession(self.request,

1651

gnutls.connection

1652

.X509Credentials()))

1653

1654

# Note: gnutls.connection.X509Credentials is really a

1655

# generic GnuTLS certificate credentials object so long as

1656

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

1657

# here despite using OpenPGP certificates.

1658

1659

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

1660

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

1661

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

1662

# "+DHE-DSS"))

2272

1663

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

2273

1664

priority = self.server.gnutls_priority

2274

1665

if priority is None:

2275

1666

priority = "NORMAL"

2276

gnutls.priority_set_direct(session._c_object,

2277

priority.encode("utf-8"),

2278

None)

2279

1667

(gnutls.library.functions

1668

.gnutls_priority_set_direct(session._c_object,

1669

priority, None))

1670

2280

1671

# Start communication using the Mandos protocol

2281

1672

# Get protocol number

2282

1673

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

2283

1674

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

2284

1675

try:

2285

1676

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

2286

raise RuntimeError(line)

1677

raise RuntimeError

2287

1678

except (ValueError, IndexError, RuntimeError) as error:

2288

1679

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

2289

1680

return

2290

1681

2291

1682

# Start GnuTLS connection

2292

1683

try:

2293

1684

session.handshake()

2294

except gnutls.Error as error:

1685

except gnutls.errors.GNUTLSError as error:

2295

1686

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

2296

1687

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

2297

1688

# established. Just abandon the request.

2298

1689

return

2299

1690

logger.debug("Handshake succeeded")

2300

1691

2301

1692

approval_required = False

2302

1693

try:

2303

if gnutls.has_rawpk:

2304

fpr = b""

2305

try:

2306

key_id = self.key_id(

2307

self.peer_certificate(session))

2308

except (TypeError, gnutls.Error) as error:

2309

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

2310

return

2311

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

2312

2313

else:

2314

key_id = b""

2315

try:

2316

fpr = self.fingerprint(

2317

self.peer_certificate(session))

2318

except (TypeError, gnutls.Error) as error:

2319

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

2320

return

2321

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

2322

2323

try:

2324

client = ProxyClient(child_pipe, key_id, fpr,

1694

try:

1695

fpr = self.fingerprint(self.peer_certificate

1696

(session))

1697

except (TypeError,

1698

gnutls.errors.GNUTLSError) as error:

1699

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

1700

return

1701

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

1702

1703

try:

1704

client = ProxyClient(child_pipe, fpr,

2325

1705

self.client_address)

2326

1706

except KeyError:

2327

1707

return

2328

1708

2329

1709

if client.approval_delay:

2330

1710

delay = client.approval_delay

2331

1711

client.approvals_pending += 1

2332

1712

approval_required = True

2333

1713

2334

1714

while True:

2335

1715

if not client.enabled:

2336

1716

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

2337

client.name)

1717

client.name)

2338

1718

if self.server.use_dbus:

2339

1719

# Emit D-Bus signal

2340

1720

client.Rejected("Disabled")

2341

1721

return

2342

1722

2343

1723

if client.approved or not client.approval_delay:

2344

# We are approved or approval is disabled

1724

#We are approved or approval is disabled

2345

1725

break

2346

1726

elif client.approved is None:

2347

1727

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

2349

1729

if self.server.use_dbus:

2350

1730

# Emit D-Bus signal

2351

1731

client.NeedApproval(

2352

client.approval_delay.total_seconds()

2353

* 1000, client.approved_by_default)

1732

client.approval_delay_milliseconds(),

1733

client.approved_by_default)

2354

1734

else:

2355

1735

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

2356

1736

client.name)

2358

1738

# Emit D-Bus signal

2359

1739

client.Rejected("Denied")

2360

1740

return

2361

2362

# wait until timeout or approved

1741

1742

#wait until timeout or approved

2363

1743

time = datetime.datetime.now()

2364

1744

client.changedstate.acquire()

2365

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

1745

client.changedstate.wait(

1746

float(timedelta_to_milliseconds(delay)

1747

/ 1000))

2366

1748

client.changedstate.release()

2367

1749

time2 = datetime.datetime.now()

2368

1750

if (time2 - time) >= delay:

2378

1760

break

2379

1761

else:

2380

1762

delay -= time2 - time

2381

2382

try:

2383

session.send(client.secret)

2384

except gnutls.Error as error:

2385

logger.warning("gnutls send failed",

2386

exc_info=error)

2387

return

2388

1763

1764

sent_size = 0

1765

while sent_size < len(client.secret):

1766

try:

1767

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

1768

except gnutls.errors.GNUTLSError as error:

1769

logger.warning("gnutls send failed",

1770

exc_info=error)

1771

return

1772

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

1773

sent, len(client.secret)

1774

- (sent_size + sent))

1775

sent_size += sent

1776

2389

1777

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

2390

1778

# bump the timeout using extended_timeout

2391

1779

client.bump_timeout(client.extended_timeout)

2392

1780

if self.server.use_dbus:

2393

1781

# Emit D-Bus signal

2394

1782

client.GotSecret()

2395

1783

2396

1784

finally:

2397

1785

if approval_required:

2398

1786

client.approvals_pending -= 1

2399

1787

try:

2400

1788

session.bye()

2401

except gnutls.Error as error:

1789

except gnutls.errors.GNUTLSError as error:

2402

1790

logger.warning("GnuTLS bye failed",

2403

1791

exc_info=error)

2404

1792

2405

1793

@staticmethod

2406

1794

def peer_certificate(session):

2407

"Return the peer's certificate as a bytestring"

2408

try:

2409

cert_type = gnutls.certificate_type_get2(session._c_object,

2410

gnutls.CTYPE_PEERS)

2411

except AttributeError:

2412

cert_type = gnutls.certificate_type_get(session._c_object)

2413

if gnutls.has_rawpk:

2414

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2415

else:

2416

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2417

# If not a valid certificate type...

2418

if cert_type not in valid_cert_types:

2419

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

2420

valid_cert_types)

2421

# ...return invalid data

2422

return b""

1795

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

1796

# If not an OpenPGP certificate...

1797

if (gnutls.library.functions

1798

.gnutls_certificate_type_get(session._c_object)

1799

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1800

# ...do the normal thing

1801

return session.peer_certificate

2423

1802

list_size = ctypes.c_uint(1)

2424

cert_list = (gnutls.certificate_get_peers

1803

cert_list = (gnutls.library.functions

1804

.gnutls_certificate_get_peers

2425

1805

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

2426

1806

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

2427

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

1807

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

1808

" certificate")

2428

1809

if list_size.value == 0:

2429

1810

return None

2430

1811

cert = cert_list[0]

2431

1812

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

2432

2433

@staticmethod

2434

def key_id(certificate):

2435

"Convert a certificate bytestring to a hexdigit key ID"

2436

# New GnuTLS "datum" with the public key

2437

datum = gnutls.datum_t(

2438

ctypes.cast(ctypes.c_char_p(certificate),

2439

ctypes.POINTER(ctypes.c_ubyte)),

2440

ctypes.c_uint(len(certificate)))

2441

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

2442

# New empty GnuTLS certificate

2443

pubkey = gnutls.pubkey_t()

2444

gnutls.pubkey_init(ctypes.byref(pubkey))

2445

# Import the raw public key into the certificate

2446

gnutls.pubkey_import(pubkey,

2447

ctypes.byref(datum),

2448

gnutls.X509_FMT_DER)

2449

# New buffer for the key ID

2450

buf = ctypes.create_string_buffer(32)

2451

buf_len = ctypes.c_size_t(len(buf))

2452

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

2453

gnutls.pubkey_get_key_id(pubkey,

2454

gnutls.KEYID_USE_SHA256,

2455

ctypes.cast(ctypes.byref(buf),

2456

ctypes.POINTER(ctypes.c_ubyte)),

2457

ctypes.byref(buf_len))

2458

# Deinit the certificate

2459

gnutls.pubkey_deinit(pubkey)

2460

2461

# Convert the buffer to a Python bytestring

2462

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

2463

# Convert the bytestring to hexadecimal notation

2464

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

2465

return hex_key_id

2466

1813

2467

1814

@staticmethod

2468

1815

def fingerprint(openpgp):

2469

1816

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2470

1817

# New GnuTLS "datum" with the OpenPGP public key

2471

datum = gnutls.datum_t(

2472

ctypes.cast(ctypes.c_char_p(openpgp),

2473

ctypes.POINTER(ctypes.c_ubyte)),

2474

ctypes.c_uint(len(openpgp)))

1818

datum = (gnutls.library.types

1819

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

1820

ctypes.POINTER

1821

(ctypes.c_ubyte)),

1822

ctypes.c_uint(len(openpgp))))

2475

1823

# New empty GnuTLS certificate

2476

crt = gnutls.openpgp_crt_t()

2477

gnutls.openpgp_crt_init(ctypes.byref(crt))

1824

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1825

(gnutls.library.functions

1826

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2478

1827

# Import the OpenPGP public key into the certificate

2479

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

2480

gnutls.OPENPGP_FMT_RAW)

1828

(gnutls.library.functions

1829

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

1830

gnutls.library.constants

1831

.GNUTLS_OPENPGP_FMT_RAW))

2481

1832

# Verify the self signature in the key

2482

1833

crtverify = ctypes.c_uint()

2483

gnutls.openpgp_crt_verify_self(crt, 0,

2484

ctypes.byref(crtverify))

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_verify_self(crt, 0,

1836

ctypes.byref(crtverify)))

2485

1837

if crtverify.value != 0:

2486

gnutls.openpgp_crt_deinit(crt)

2487

raise gnutls.CertificateSecurityError(code

2488

=crtverify.value)

1838

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1839

raise (gnutls.errors.CertificateSecurityError

1840

("Verify failed"))

2489

1841

# New buffer for the fingerprint

2490

1842

buf = ctypes.create_string_buffer(20)

2491

1843

buf_len = ctypes.c_size_t()

2492

1844

# Get the fingerprint from the certificate into the buffer

2493

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

2494

ctypes.byref(buf_len))

1845

(gnutls.library.functions

1846

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

1847

ctypes.byref(buf_len)))

2495

1848

# Deinit the certificate

2496

gnutls.openpgp_crt_deinit(crt)

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2497

1850

# Convert the buffer to a Python bytestring

2498

1851

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

2499

1852

# Convert the bytestring to hexadecimal notation

2501

1854

return hex_fpr

2502

1855

2503

1856

2504

class MultiprocessingMixIn:

1857

class MultiprocessingMixIn(object):

2505

1858

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

2506

2507

1859

def sub_process_main(self, request, address):

2508

1860

try:

2509

1861

self.finish_request(request, address)

2510

1862

except Exception:

2511

1863

self.handle_error(request, address)

2512

1864

self.close_request(request)

2513

1865

2514

1866

def process_request(self, request, address):

2515

1867

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

2516

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

2517

args=(request, address))

1868

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

1869

args = (request, address))

2518

1870

proc.start()

2519

1871

return proc

2520

1872

2521

1873

2522

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1874

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2523

1875

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

2524

2525

1876

def process_request(self, request, client_address):

2526

1877

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

2527

1878

2528

1879

This function creates a new pipe in self.pipe

2529

1880

"""

2530

1881

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2531

1882

2532

1883

proc = MultiprocessingMixIn.process_request(self, request,

2533

1884

client_address)

2534

1885

self.child_pipe.close()

2535

1886

self.add_pipe(parent_pipe, proc)

2536

1887

2537

1888

def add_pipe(self, parent_pipe, proc):

2538

1889

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

2539

raise NotImplementedError()

1890

raise NotImplementedError

2540

1891

2541

1892

2542

1893

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2543

socketserver.TCPServer):

1894

socketserver.TCPServer, object):

2544

1895

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

2545

1896

2546

1897

Attributes:

2547

1898

enabled: Boolean; whether this server is activated yet

2548

1899

interface: None or a network interface name (string)

2549

1900

use_ipv6: Boolean; to use IPv6 or not

2550

1901

"""

2551

2552

1902

def __init__(self, server_address, RequestHandlerClass,

2553

interface=None,

2554

use_ipv6=True,

2555

socketfd=None):

1903

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

2556

1904

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

2557

1905

creating a new one with socket.socket().

2558

1906

"""

2564

1912

self.socketfd = socketfd

2565

1913

# Save the original socket.socket() function

2566

1914

self.socket_socket = socket.socket

2567

2568

1915

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

2569

#

1916

#

2570

1917

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

2571

1918

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

2572

1919

# patching socket.socket.)

2573

#

1920

#

2574

1921

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

2575

1922

@functools.wraps(socket.socket)

2576

1923

def socket_wrapper(*args, **kwargs):

2588

1935

# socket_wrapper(), if socketfd was set.

2589

1936

socketserver.TCPServer.__init__(self, server_address,

2590

1937

RequestHandlerClass)

2591

1938

2592

1939

def server_bind(self):

2593

1940

"""This overrides the normal server_bind() function

2594

1941

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

2595

1942

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

2596

global SO_BINDTODEVICE

2597

1943

if self.interface is not None:

2598

1944

if SO_BINDTODEVICE is None:

2599

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

2600

# common enough.

2601

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

2602

SO_BINDTODEVICE = 25

2603

try:

2604

self.socket.setsockopt(

2605

socket.SOL_SOCKET, SO_BINDTODEVICE,

2606

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

2607

except socket.error as error:

2608

if error.errno == errno.EPERM:

2609

logger.error("No permission to bind to"

2610

" interface %s", self.interface)

2611

elif error.errno == errno.ENOPROTOOPT:

2612

logger.error("SO_BINDTODEVICE not available;"

2613

" cannot bind to interface %s",

2614

self.interface)

2615

elif error.errno == errno.ENODEV:

2616

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

2617

" cannot bind", self.interface)

2618

else:

2619

raise

1945

logger.error("SO_BINDTODEVICE does not exist;"

1946

" cannot bind to interface %s",

1947

self.interface)

1948

else:

1949

try:

1950

self.socket.setsockopt(socket.SOL_SOCKET,

1951

SO_BINDTODEVICE,

1952

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

1953

except socket.error as error:

1954

if error.errno == errno.EPERM:

1955

logger.error("No permission to bind to"

1956

" interface %s", self.interface)

1957

elif error.errno == errno.ENOPROTOOPT:

1958

logger.error("SO_BINDTODEVICE not available;"

1959

" cannot bind to interface %s",

1960

self.interface)

1961

elif error.errno == errno.ENODEV:

1962

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

1963

" cannot bind", self.interface)

1964

else:

1965

raise

2620

1966

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

2621

1967

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

2622

if self.server_address[1]:

2623

self.allow_reuse_address = True

2624

1968

if not self.server_address[0]:

2625

1969

if self.address_family == socket.AF_INET6:

2626

any_address = "::" # in6addr_any

1970

any_address = "::" # in6addr_any

2627

1971

else:

2628

any_address = "0.0.0.0" # INADDR_ANY

1972

any_address = socket.INADDR_ANY

2629

1973

self.server_address = (any_address,

2630

1974

self.server_address[1])

2631

1975

elif not self.server_address[1]:

2632

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

1976

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

1977

0)

2633

1978

# if self.interface:

2634

1979

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

2635

1980

# 0, # port

2641

1986

2642

1987

class MandosServer(IPv6_TCPServer):

2643

1988

"""Mandos server.

2644

1989

2645

1990

Attributes:

2646

1991

clients: set of Client objects

2647

1992

gnutls_priority GnuTLS priority string

2648

1993

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

2649

2650

Assumes a GLib.MainLoop event loop.

1994

1995

Assumes a gobject.MainLoop event loop.

2651

1996

"""

2652

2653

1997

def __init__(self, server_address, RequestHandlerClass,

2654

interface=None,

2655

use_ipv6=True,

2656

clients=None,

2657

gnutls_priority=None,

2658

use_dbus=True,

2659

socketfd=None):

1998

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

1999

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

2660

2000

self.enabled = False

2661

2001

self.clients = clients

2662

2002

if self.clients is None:

2665

2005

self.gnutls_priority = gnutls_priority

2666

2006

IPv6_TCPServer.__init__(self, server_address,

2667

2007

RequestHandlerClass,

2668

interface=interface,

2669

use_ipv6=use_ipv6,

2670

socketfd=socketfd)

2671

2008

interface = interface,

2009

use_ipv6 = use_ipv6,

2010

socketfd = socketfd)

2672

2011

def server_activate(self):

2673

2012

if self.enabled:

2674

2013

return socketserver.TCPServer.server_activate(self)

2675

2014

2676

2015

def enable(self):

2677

2016

self.enabled = True

2678

2017

2679

2018

def add_pipe(self, parent_pipe, proc):

2680

2019

# Call "handle_ipc" for both data and EOF events

2681

GLib.io_add_watch(

2682

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

2683

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

2684

functools.partial(self.handle_ipc,

2685

parent_pipe=parent_pipe,

2686

proc=proc))

2687

2688

def handle_ipc(self, source, condition,

2689

parent_pipe=None,

2690

proc=None,

2691

client_object=None):

2020

gobject.io_add_watch(parent_pipe.fileno(),

2021

gobject.IO_IN | gobject.IO_HUP,

2022

functools.partial(self.handle_ipc,

2023

parent_pipe =

2024

parent_pipe,

2025

proc = proc))

2026

2027

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

2028

proc = None, client_object=None):

2692

2029

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

2693

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

2030

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

2694

2031

# Wait for other process to exit

2695

2032

proc.join()

2696

2033

return False

2697

2034

2698

2035

# Read a request from the child

2699

2036

request = parent_pipe.recv()

2700

2037

command = request[0]

2701

2038

2702

2039

if command == 'init':

2703

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

2704

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

2705

address = request[3]

2706

2707

for c in self.clients.values():

2708

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2709

continue

2710

if key_id and c.key_id == key_id:

2711

client = c

2712

break

2713

if fpr and c.fingerprint == fpr:

2040

fpr = request[1]

2041

address = request[2]

2042

2043

for c in self.clients.itervalues():

2044

if c.fingerprint == fpr:

2714

2045

client = c

2715

2046

break

2716

2047

else:

2717

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

2718

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

2048

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

2049

"dress: %s", fpr, address)

2719

2050

if self.use_dbus:

2720

2051

# Emit D-Bus signal

2721

mandos_dbus_service.ClientNotFound(key_id or fpr,

2052

mandos_dbus_service.ClientNotFound(fpr,

2722

2053

address[0])

2723

2054

parent_pipe.send(False)

2724

2055

return False

2725

2726

GLib.io_add_watch(

2727

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

2728

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

2729

functools.partial(self.handle_ipc,

2730

parent_pipe=parent_pipe,

2731

proc=proc,

2732

client_object=client))

2056

2057

gobject.io_add_watch(parent_pipe.fileno(),

2058

gobject.IO_IN | gobject.IO_HUP,

2059

functools.partial(self.handle_ipc,

2060

parent_pipe =

2061

parent_pipe,

2062

proc = proc,

2063

client_object =

2064

client))

2733

2065

parent_pipe.send(True)

2734

2066

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

2735

2067

# same fileno

2738

2070

funcname = request[1]

2739

2071

args = request[2]

2740

2072

kwargs = request[3]

2741

2073

2742

2074

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

2743

2075

funcname)(*args,

2744

**kwargs)))

2745

2076

**kwargs)))

2077

2746

2078

if command == 'getattr':

2747

2079

attrname = request[1]

2748

if isinstance(client_object.__getattribute__(attrname),

2749

collections.Callable):

2750

parent_pipe.send(('function', ))

2080

if callable(client_object.__getattribute__(attrname)):

2081

parent_pipe.send(('function',))

2751

2082

else:

2752

parent_pipe.send((

2753

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

2754

2083

parent_pipe.send(('data', client_object

2084

.__getattribute__(attrname)))

2085

2755

2086

if command == 'setattr':

2756

2087

attrname = request[1]

2757

2088

value = request[2]

2758

2089

setattr(client_object, attrname, value)

2759

2090

2760

2091

return True

2761

2092

2762

2093

2763

2094

def rfc3339_duration_to_delta(duration):

2764

2095

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

2765

2766

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

2767

True

2768

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

2769

True

2770

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

2771

True

2772

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

2773

True

2774

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

2775

True

2776

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

2777

True

2778

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

2779

True

2096

2097

>>> rfc3339_duration_to_delta("P7D")

2098

datetime.timedelta(7)

2099

>>> rfc3339_duration_to_delta("PT60S")

2100

datetime.timedelta(0, 60)

2101

>>> rfc3339_duration_to_delta("PT60M")

2102

datetime.timedelta(0, 3600)

2103

>>> rfc3339_duration_to_delta("PT24H")

2104

datetime.timedelta(1)

2105

>>> rfc3339_duration_to_delta("P1W")

2106

datetime.timedelta(7)

2107

>>> rfc3339_duration_to_delta("PT5M30S")

2108

datetime.timedelta(0, 330)

2109

>>> rfc3339_duration_to_delta("P1DT3M20S")

2110

datetime.timedelta(1, 200)

2780

2111

"""

2781

2112

2782

2113

# Parsing an RFC 3339 duration with regular expressions is not

2783

2114

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

2784

2115

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

2785

2116

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

2786

2117

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

2787

2118

# avoid excessive use of external libraries.

2788

2119

2789

2120

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

2790

Token = collections.namedtuple("Token", (

2791

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

2792

# a "group" containing digits

2793

"value", # datetime.timedelta or None

2794

"followers")) # Tokens valid after this token

2121

Token = collections.namedtuple("Token",

2122

("regexp", # To match token; if

2123

# "value" is not None,

2124

# must have a "group"

2125

# containing digits

2126

"value", # datetime.timedelta or

2127

# None

2128

"followers")) # Tokens valid after

2129

# this token

2795

2130

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

2796

2131

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

2797

2132

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

2798

2133

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

2799

2134

datetime.timedelta(seconds=1),

2800

frozenset((token_end, )))

2135

frozenset((token_end,)))

2801

2136

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

2802

2137

datetime.timedelta(minutes=1),

2803

2138

frozenset((token_second, token_end)))

2819

2154

frozenset((token_month, token_end)))

2820

2155

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

2821

2156

datetime.timedelta(weeks=1),

2822

frozenset((token_end, )))

2157

frozenset((token_end,)))

2823

2158

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

2824

2159

frozenset((token_year, token_month,

2825

2160

token_day, token_time,

2826

token_week)))

2827

# Define starting values:

2828

# Value so far

2829

value = datetime.timedelta()

2161

token_week))),

2162

# Define starting values

2163

value = datetime.timedelta() # Value so far

2830

2164

found_token = None

2831

# Following valid tokens

2832

followers = frozenset((token_duration, ))

2833

# String left to parse

2834

s = duration

2165

followers = frozenset(token_duration,) # Following valid tokens

2166

s = duration # String left to parse

2835

2167

# Loop until end token is found

2836

2168

while found_token is not token_end:

2837

2169

# Search for any currently valid tokens

2853

2185

break

2854

2186

else:

2855

2187

# No currently valid tokens were found

2856

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

2857

.format(duration))

2188

raise ValueError("Invalid RFC 3339 duration")

2858

2189

# End token found

2859

2190

return value

2860

2191

2861

2192

2862

2193

def string_to_delta(interval):

2863

2194

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

2864

2865

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

2866

True

2867

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

2868

True

2869

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

2870

True

2871

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

2872

True

2873

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

2874

True

2875

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

2876

True

2195

2196

>>> string_to_delta('7d')

2197

datetime.timedelta(7)

2198

>>> string_to_delta('60s')

2199

datetime.timedelta(0, 60)

2200

>>> string_to_delta('60m')

2201

datetime.timedelta(0, 3600)

2202

>>> string_to_delta('24h')

2203

datetime.timedelta(1)

2204

>>> string_to_delta('1w')

2205

datetime.timedelta(7)

2206

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

2207

datetime.timedelta(0, 330)

2877

2208

"""

2878

2209

2879

2210

try:

2880

2211

return rfc3339_duration_to_delta(interval)

2881

2212

except ValueError:

2882

2213

pass

2883

2214

2884

2215

timevalue = datetime.timedelta(0)

2885

2216

for s in interval.split():

2886

2217

try:

2887

suffix = s[-1]

2218

suffix = unicode(s[-1])

2888

2219

value = int(s[:-1])

2889

2220

if suffix == "d":

2890

2221

delta = datetime.timedelta(value)

2897

2228

elif suffix == "w":

2898

2229

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

2899

2230

else:

2900

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

2901

except IndexError as e:

2231

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

2232

.format(suffix))

2233

except (ValueError, IndexError) as e:

2902

2234

raise ValueError(*(e.args))

2903

2235

timevalue += delta

2904

2236

return timevalue

2905

2237

2906

2238

2907

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

2239

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

2908

2240

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

2909

2241

2910

2242

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

2911

2243

if os.fork():

2912

2244

sys.exit()

2920

2252

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

2921

2253

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

2922

2254

raise OSError(errno.ENODEV,

2923

"{} not a character device"

2255

"{0} not a character device"

2924

2256

.format(os.devnull))

2925

2257

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

2926

2258

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

2930

2262

2931

2263

2932

2264

def main():

2933

2265

2934

2266

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

2935

2267

# Parsing of options, both command line and config file

2936

2268

2937

2269

parser = argparse.ArgumentParser()

2938

2270

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

2939

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

2271

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

2940

2272

help="show version number and exit")

2941

2273

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

2942

2274

help="Bind to interface IF")

2948

2280

help="Run self-test")

2949

2281

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

2950

2282

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

2951

" to terminal", default=None)

2283

" to terminal")

2952

2284

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

2953

2285

help="Debug level for stdout output")

2954

2286

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

2961

2293

" files")

2962

2294

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

2963

2295

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

2964

" system bus interface", default=None)

2296

" system bus interface")

2965

2297

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

2966

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

2967

default=None)

2298

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

2968

2299

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

2969

2300

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

2970

" state", default=None)

2301

" state")

2971

2302

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

2972

2303

help="Specify a file descriptor to a network"

2973

2304

" socket to use instead of creating one")

2974

2305

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

2975

2306

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

2976

2307

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

2977

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

2978

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

2979

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

2980

default=None)

2981

2308

help="Run in foreground")

2309

2982

2310

options = parser.parse_args()

2983

2311

2312

if options.check:

2313

import doctest

2314

doctest.testmod()

2315

sys.exit()

2316

2984

2317

# Default values for config file for server-global settings

2985

if gnutls.has_rawpk:

2986

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

2987

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

2988

else:

2989

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

2990

":+SIGN-DSA-SHA256")

2991

server_defaults = {"interface": "",

2992

"address": "",

2993

"port": "",

2994

"debug": "False",

2995

"priority": priority,

2996

"servicename": "Mandos",

2997

"use_dbus": "True",

2998

"use_ipv6": "True",

2999

"debuglevel": "",

3000

"restore": "True",

3001

"socket": "",

3002

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

3003

"foreground": "False",

3004

"zeroconf": "True",

3005

}

3006

del priority

3007

2318

server_defaults = { "interface": "",

2319

"address": "",

2320

"port": "",

2321

"debug": "False",

2322

"priority":

2323

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

2324

"servicename": "Mandos",

2325

"use_dbus": "True",

2326

"use_ipv6": "True",

2327

"debuglevel": "",

2328

"restore": "True",

2329

"socket": "",

2330

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

2331

"foreground": "False",

2332

}

2333

3008

2334

# Parse config file for server-global settings

3009

server_config = configparser.ConfigParser(server_defaults)

2335

server_config = configparser.SafeConfigParser(server_defaults)

3010

2336

del server_defaults

3011

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

3012

# Convert the ConfigParser object to a dict

2337

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

2338

"mandos.conf"))

2339

# Convert the SafeConfigParser object to a dict

3013

2340

server_settings = server_config.defaults()

3014

2341

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

3015

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

3016

"foreground", "zeroconf"):

2342

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

3017

2343

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

3018

2344

option)

3019

2345

if server_settings["port"]:

3029

2355

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

3030

2356

["socket"])

3031

2357

del server_config

3032

2358

3033

2359

# Override the settings from the config file with command line

3034

2360

# options, if set.

3035

2361

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

3036

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

3037

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

3038

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

2362

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

2363

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

2364

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

3039

2365

value = getattr(options, option)

3040

2366

if value is not None:

3041

2367

server_settings[option] = value

3042

2368

del options

3043

2369

# Force all strings to be unicode

3044

2370

for option in server_settings.keys():

3045

if isinstance(server_settings[option], bytes):

3046

server_settings[option] = (server_settings[option]

3047

.decode("utf-8"))

3048

# Force all boolean options to be boolean

3049

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

3050

"foreground", "zeroconf"):

3051

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

2371

if type(server_settings[option]) is str:

2372

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

3052

2373

# Debug implies foreground

3053

2374

if server_settings["debug"]:

3054

2375

server_settings["foreground"] = True

3055

2376

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

3056

2377

3057

2378

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

3058

3059

if (not server_settings["zeroconf"]

3060

and not (server_settings["port"]

3061

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

3062

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

3063

2379

3064

2380

# For convenience

3065

2381

debug = server_settings["debug"]

3066

2382

debuglevel = server_settings["debuglevel"]

3069

2385

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

3070

2386

stored_state_file)

3071

2387

foreground = server_settings["foreground"]

3072

zeroconf = server_settings["zeroconf"]

3073

2388

3074

2389

if debug:

3075

2390

initlogger(debug, logging.DEBUG)

3076

2391

else:

3079

2394

else:

3080

2395

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

3081

2396

initlogger(debug, level)

3082

2397

3083

2398

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

3084

syslogger.setFormatter(

3085

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

3086

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

3087

server_settings["servicename"])))

3088

2399

syslogger.setFormatter(logging.Formatter

2400

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

2401

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

2402

.format(server_settings

2403

["servicename"])))

2404

3089

2405

# Parse config file with clients

3090

client_config = configparser.ConfigParser(Client.client_defaults)

2406

client_config = configparser.SafeConfigParser(Client

2407

.client_defaults)

3091

2408

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

3092

2409

"clients.conf"))

3093

2410

3094

2411

global mandos_dbus_service

3095

2412

mandos_dbus_service = None

3096

3097

socketfd = None

3098

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

3099

socketfd = server_settings["socket"]

3100

tcp_server = MandosServer(

3101

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

3102

ClientHandler,

3103

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

3104

use_ipv6=use_ipv6,

3105

gnutls_priority=server_settings["priority"],

3106

use_dbus=use_dbus,

3107

socketfd=socketfd)

2413

2414

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

2415

server_settings["port"]),

2416

ClientHandler,

2417

interface=(server_settings["interface"]

2418

or None),

2419

use_ipv6=use_ipv6,

2420

gnutls_priority=

2421

server_settings["priority"],

2422

use_dbus=use_dbus,

2423

socketfd=(server_settings["socket"]

2424

or None))

3108

2425

if not foreground:

3109

pidfilename = "/run/mandos.pid"

3110

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

3111

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

2426

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

3112

2427

pidfile = None

3113

2428

try:

3114

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

2429

pidfile = open(pidfilename, "w")

3115

2430

except IOError as e:

3116

2431

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

3117

2432

exc_info=e)

3118

3119

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

3120

("mandos", "mandos"),

3121

("nobody", "nogroup")):

2433

2434

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

3122

2435

try:

3123

2436

uid = pwd.getpwnam(name).pw_uid

3124

gid = pwd.getpwnam(group).pw_gid

2437

gid = pwd.getpwnam(name).pw_gid

3125

2438

break

3126

2439

except KeyError:

3127

2440

continue

3131

2444

try:

3132

2445

os.setgid(gid)

3133

2446

os.setuid(uid)

3134

if debug:

3135

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

3136

gid))

3137

2447

except OSError as error:

3138

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

3139

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

3140

2448

if error.errno != errno.EPERM:

3141

raise

3142

2449

raise error

2450

3143

2451

if debug:

3144

2452

# Enable all possible GnuTLS debugging

3145

2453

3146

2454

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

3147

2455

# - GnuTLS manual

3148

gnutls.global_set_log_level(11)

3149

3150

@gnutls.log_func

2456

gnutls.library.functions.gnutls_global_set_log_level(11)

2457

2458

@gnutls.library.types.gnutls_log_func

3151

2459

def debug_gnutls(level, string):

3152

2460

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

3153

3154

gnutls.global_set_log_function(debug_gnutls)

3155

2461

2462

(gnutls.library.functions

2463

.gnutls_global_set_log_function(debug_gnutls))

2464

3156

2465

# Redirect stdin so all checkers get /dev/null

3157

2466

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

3158

2467

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

3159

2468

if null > 2:

3160

2469

os.close(null)

3161

2470

3162

2471

# Need to fork before connecting to D-Bus

3163

2472

if not foreground:

3164

2473

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

3165

2474

daemon()

3166

3167

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

3168

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

3169

# need to inform GLib that threads will be used.

3170

GLib.threads_init()

3171

2475

2476

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

2477

# need to inform gobject that threads will be used.

2478

gobject.threads_init()

2479

3172

2480

global main_loop

3173

2481

# From the Avahi example code

3174

2482

DBusGMainLoop(set_as_default=True)

3175

main_loop = GLib.MainLoop()

2483

main_loop = gobject.MainLoop()

3176

2484

bus = dbus.SystemBus()

3177

2485

# End of Avahi example code

3178

2486

if use_dbus:

3179

2487

try:

3180

2488

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

3181

bus,

3182

do_not_queue=True)

3183

old_bus_name = dbus.service.BusName(

3184

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

3185

do_not_queue=True)

3186

except dbus.exceptions.DBusException as e:

2489

bus, do_not_queue=True)

2490

old_bus_name = (dbus.service.BusName

2491

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

2492

do_not_queue=True))

2493

except dbus.exceptions.NameExistsException as e:

3187

2494

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

3188

2495

use_dbus = False

3189

2496

server_settings["use_dbus"] = False

3190

2497

tcp_server.use_dbus = False

3191

if zeroconf:

3192

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3193

service = AvahiServiceToSyslog(

3194

name=server_settings["servicename"],

3195

servicetype="_mandos._tcp",

3196

protocol=protocol,

3197

bus=bus)

3198

if server_settings["interface"]:

3199

service.interface = if_nametoindex(

3200

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

3201

2498

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2499

service = AvahiServiceToSyslog(name =

2500

server_settings["servicename"],

2501

servicetype = "_mandos._tcp",

2502

protocol = protocol, bus = bus)

2503

if server_settings["interface"]:

2504

service.interface = (if_nametoindex

2505

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

2506

3202

2507

global multiprocessing_manager

3203

2508

multiprocessing_manager = multiprocessing.Manager()

3204

2509

3205

2510

client_class = Client

3206

2511

if use_dbus:

3207

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

3208

2512

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

2513

3209

2514

client_settings = Client.config_parser(client_config)

3210

2515

old_client_settings = {}

3211

2516

clients_data = {}

3212

3213

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

3214

global wnull

3215

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

3216

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

3217

# mode

3218

if debug or not foreground:

3219

wnull.close()

3220

2517

3221

2518

# Get client data and settings from last running state.

3222

2519

if server_settings["restore"]:

3223

2520

try:

3224

2521

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

3225

if sys.version_info.major == 2:

3226

clients_data, old_client_settings = pickle.load(

3227

stored_state)

3228

else:

3229

bytes_clients_data, bytes_old_client_settings = (

3230

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

3231

# Fix bytes to strings

3232

# clients_data

3233

# .keys()

3234

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

3235

if isinstance(key, bytes)

3236

else key): value

3237

for key, value in

3238

bytes_clients_data.items()}

3239

del bytes_clients_data

3240

for key in clients_data:

3241

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

3242

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

3243

for k, v in

3244

clients_data[key].items()}

3245

clients_data[key] = value

3246

# .client_structure

3247

value["client_structure"] = [

3248

(s.decode("utf-8")

3249

if isinstance(s, bytes)

3250

else s) for s in

3251

value["client_structure"]]

3252

# .name, .host, and .checker_command

3253

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

3254

if isinstance(value[k], bytes):

3255

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

3256

if "key_id" not in value:

3257

value["key_id"] = ""

3258

elif "fingerprint" not in value:

3259

value["fingerprint"] = ""

3260

# old_client_settings

3261

# .keys()

3262

old_client_settings = {

3263

(key.decode("utf-8")

3264

if isinstance(key, bytes)

3265

else key): value

3266

for key, value in

3267

bytes_old_client_settings.items()}

3268

del bytes_old_client_settings

3269

# .host and .checker_command

3270

for value in old_client_settings.values():

3271

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

3272

if isinstance(value[attribute], bytes):

3273

value[attribute] = (value[attribute]

3274

.decode("utf-8"))

2522

clients_data, old_client_settings = (pickle.load

2523

(stored_state))

3275

2524

os.remove(stored_state_path)

3276

2525

except IOError as e:

3277

2526

if e.errno == errno.ENOENT:

3278

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

3279

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

2527

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

2528

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

3280

2529

else:

3281

2530

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

3282

2531

exc_info=e)

3283

2532

raise

3284

2533

except EOFError as e:

3285

2534

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

3286

"EOFError:",

3287

exc_info=e)

3288

2535

"EOFError:", exc_info=e)

2536

3289

2537

with PGPEngine() as pgp:

3290

for client_name, client in clients_data.items():

3291

# Skip removed clients

3292

if client_name not in client_settings:

3293

continue

3294

2538

for client_name, client in clients_data.iteritems():

3295

2539

# Decide which value to use after restoring saved state.

3296

2540

# We have three different values: Old config file,

3297

2541

# new config file, and saved state.

3302

2546

# For each value in new config, check if it

3303

2547

# differs from the old config value (Except for

3304

2548

# the "secret" attribute)

3305

if (name != "secret"

3306

and (value !=

3307

old_client_settings[client_name][name])):

2549

if (name != "secret" and

2550

value != old_client_settings[client_name]

2551

[name]):

3308

2552

client[name] = value

3309

2553

except KeyError:

3310

2554

pass

3311

2555

3312

2556

# Clients who has passed its expire date can still be

3313

# enabled if its last checker was successful. A Client

2557

# enabled if its last checker was successful. Clients

3314

2558

# whose checker succeeded before we stored its state is

3315

2559

# assumed to have successfully run all checkers during

3316

2560

# downtime.

3318

2562

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

3319

2563

if not client["last_checked_ok"]:

3320

2564

logger.warning(

3321

"disabling client {} - Client never "

3322

"performed a successful checker".format(

3323

client_name))

2565

"disabling client {0} - Client never "

2566

"performed a successful checker"

2567

.format(client_name))

3324

2568

client["enabled"] = False

3325

2569

elif client["last_checker_status"] != 0:

3326

2570

logger.warning(

3327

"disabling client {} - Client last"

3328

" checker failed with error code"

3329

" {}".format(

3330

client_name,

3331

client["last_checker_status"]))

2571

"disabling client {0} - Client "

2572

"last checker failed with error code {1}"

2573

.format(client_name,

2574

client["last_checker_status"]))

3332

2575

client["enabled"] = False

3333

2576

else:

3334

client["expires"] = (

3335

datetime.datetime.utcnow()

3336

+ client["timeout"])

2577

client["expires"] = (datetime.datetime

2578

.utcnow()

2579

+ client["timeout"])

3337

2580

logger.debug("Last checker succeeded,"

3338

" keeping {} enabled".format(

3339

client_name))

2581

" keeping {0} enabled"

2582

.format(client_name))

3340

2583

try:

3341

client["secret"] = pgp.decrypt(

3342

client["encrypted_secret"],

3343

client_settings[client_name]["secret"])

2584

client["secret"] = (

2585

pgp.decrypt(client["encrypted_secret"],

2586

client_settings[client_name]

2587

["secret"]))

3344

2588

except PGPError:

3345

2589

# If decryption fails, we use secret from new settings

3346

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

3347

client_name))

3348

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

3349

["secret"])

3350

2590

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

2591

.format(client_name))

2592

client["secret"] = (

2593

client_settings[client_name]["secret"])

2594

3351

2595

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

3352

2596

for client_name in (set(old_client_settings)

3353

2597

- set(client_settings)):

3355

2599

for client_name in (set(client_settings)

3356

2600

- set(old_client_settings)):

3357

2601

clients_data[client_name] = client_settings[client_name]

3358

2602

3359

2603

# Create all client objects

3360

for client_name, client in clients_data.items():

2604

for client_name, client in clients_data.iteritems():

3361

2605

tcp_server.clients[client_name] = client_class(

3362

name=client_name,

3363

settings=client,

3364

server_settings=server_settings)

3365

2606

name = client_name, settings = client)

2607

3366

2608

if not tcp_server.clients:

3367

2609

logger.warning("No clients defined")

3368

2610

3369

2611

if not foreground:

3370

2612

if pidfile is not None:

3371

pid = os.getpid()

3372

2613

try:

3373

2614

with pidfile:

3374

print(pid, file=pidfile)

2615

pid = os.getpid()

2616

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

3375

2617

except IOError:

3376

2618

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

3377

2619

pidfilename, pid)

3378

2620

del pidfile

3379

2621

del pidfilename

3380

3381

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

3382

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3383

lambda: main_loop.quit() and False)

3384

2622

2623

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

2624

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

2625

3385

2626

if use_dbus:

3386

3387

@alternate_dbus_interfaces(

3388

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

3389

class MandosDBusService(DBusObjectWithObjectManager):

2627

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

2628

"se.bsnet.fukt.Mandos"})

2629

class MandosDBusService(DBusObjectWithProperties):

3390

2630

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

3391

3392

2631

def __init__(self):

3393

2632

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

3394

3395

2633

_interface = "se.recompile.Mandos"

3396

2634

2635

@dbus_interface_annotations(_interface)

2636

def _foo(self):

2637

return { "org.freedesktop.DBus.Property"

2638

".EmitsChangedSignal":

2639

"false"}

2640

3397

2641

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

3398

2642

def ClientAdded(self, objpath):

3399

2643

"D-Bus signal"

3400

2644

pass

3401

2645

3402

2646

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

3403

def ClientNotFound(self, key_id, address):

2647

def ClientNotFound(self, fingerprint, address):

3404

2648

"D-Bus signal"

3405

2649

pass

3406

3407

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

3408

"true"})

2650

3409

2651

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

3410

2652

def ClientRemoved(self, objpath, name):

3411

2653

"D-Bus signal"

3412

2654

pass

3413

3414

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

3415

"true"})

2655

3416

2656

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

3417

2657

def GetAllClients(self):

3418

2658

"D-Bus method"

3419

return dbus.Array(c.dbus_object_path for c in

3420

tcp_server.clients.values())

3421

3422

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

3423

"true"})

2659

return dbus.Array(c.dbus_object_path

2660

for c in

2661

tcp_server.clients.itervalues())

2662

3424

2663

@dbus.service.method(_interface,

3425

2664

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

3426

2665

def GetAllClientsWithProperties(self):

3427

2666

"D-Bus method"

3428

2667

return dbus.Dictionary(

3429

{c.dbus_object_path: c.GetAll(

3430

"se.recompile.Mandos.Client")

3431

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

2668

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

2669

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

3432

2670

signature="oa{sv}")

3433

2671

3434

2672

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

3435

2673

def RemoveClient(self, object_path):

3436

2674

"D-Bus method"

3437

for c in tcp_server.clients.values():

2675

for c in tcp_server.clients.itervalues():

3438

2676

if c.dbus_object_path == object_path:

3439

2677

del tcp_server.clients[c.name]

3440

2678

c.remove_from_connection()

3441

# Don't signal the disabling

2679

# Don't signal anything except ClientRemoved

3442

2680

c.disable(quiet=True)

3443

# Emit D-Bus signal for removal

3444

self.client_removed_signal(c)

2681

# Emit D-Bus signal

2682

self.ClientRemoved(object_path, c.name)

3445

2683

return

3446

2684

raise KeyError(object_path)

3447

2685

3448

2686

del _interface

3449

3450

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3451

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

3452

def GetManagedObjects(self):

3453

"""D-Bus method"""

3454

return dbus.Dictionary(

3455

{client.dbus_object_path:

3456

dbus.Dictionary(

3457

{interface: client.GetAll(interface)

3458

for interface in

3459

client._get_all_interface_names()})

3460

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

3461

3462

def client_added_signal(self, client):

3463

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

3464

if use_dbus:

3465

# New standard signal

3466

self.InterfacesAdded(

3467

client.dbus_object_path,

3468

dbus.Dictionary(

3469

{interface: client.GetAll(interface)

3470

for interface in

3471

client._get_all_interface_names()}))

3472

# Old signal

3473

self.ClientAdded(client.dbus_object_path)

3474

3475

def client_removed_signal(self, client):

3476

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

3477

if use_dbus:

3478

# New standard signal

3479

self.InterfacesRemoved(

3480

client.dbus_object_path,

3481

client._get_all_interface_names())

3482

# Old signal

3483

self.ClientRemoved(client.dbus_object_path,

3484

client.name)

3485

2687

3486

2688

mandos_dbus_service = MandosDBusService()

3487

3488

# Save modules to variables to exempt the modules from being

3489

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

3490

mp = multiprocessing

3491

wn = wnull

3492

2689

3493

2690

def cleanup():

3494

2691

"Cleanup function; run on exit"

3495

if zeroconf:

3496

service.cleanup()

3497

3498

mp.active_children()

3499

wn.close()

2692

service.cleanup()

2693

2694

multiprocessing.active_children()

3500

2695

if not (tcp_server.clients or client_settings):

3501

2696

return

3502

2697

3503

2698

# Store client before exiting. Secrets are encrypted with key

3504

2699

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

3505

2700

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

3506

2701

clients = {}

3507

2702

with PGPEngine() as pgp:

3508

for client in tcp_server.clients.values():

2703

for client in tcp_server.clients.itervalues():

3509

2704

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

3510

2705

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

3511

2706

key)

3512

2707

client_dict = {}

3513

2708

3514

2709

# A list of attributes that can not be pickled

3515

2710

# + secret.

3516

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

3517

"checker", "server_settings"}

3518

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

3519

.Object):

2711

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

2712

"checker"))

2713

for name, typ in (inspect.getmembers

2714

(dbus.service.Object)):

3520

2715

exclude.add(name)

3521

2716

3522

2717

client_dict["encrypted_secret"] = (client

3523

2718

.encrypted_secret)

3524

2719

for attr in client.client_structure:

3525

2720

if attr not in exclude:

3526

2721

client_dict[attr] = getattr(client, attr)

3527

2722

3528

2723

clients[client.name] = client_dict

3529

2724

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

3530

2725

3531

2726

try:

3532

with tempfile.NamedTemporaryFile(

3533

mode='wb',

3534

suffix=".pickle",

3535

prefix='clients-',

3536

dir=os.path.dirname(stored_state_path),

3537

delete=False) as stored_state:

3538

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

3539

protocol=2)

3540

tempname = stored_state.name

2727

with (tempfile.NamedTemporaryFile

2728

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

2729

dir=os.path.dirname(stored_state_path),

2730

delete=False)) as stored_state:

2731

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

2732

tempname=stored_state.name

3541

2733

os.rename(tempname, stored_state_path)

3542

2734

except (IOError, OSError) as e:

3543

2735

if not debug:

3546

2738

except NameError:

3547

2739

pass

3548

2740

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

3549

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

2741

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

3550

2742

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

3551

2743

else:

3552

2744

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

3553

2745

exc_info=e)

3554

raise

3555

2746

raise e

2747

3556

2748

# Delete all clients, and settings from config

3557

2749

while tcp_server.clients:

3558

2750

name, client = tcp_server.clients.popitem()

3559

2751

if use_dbus:

3560

2752

client.remove_from_connection()

3561

# Don't signal the disabling

2753

# Don't signal anything except ClientRemoved

3562

2754

client.disable(quiet=True)

3563

# Emit D-Bus signal for removal

3564

2755

if use_dbus:

3565

mandos_dbus_service.client_removed_signal(client)

2756

# Emit D-Bus signal

2757

mandos_dbus_service.ClientRemoved(client

2758

.dbus_object_path,

2759

client.name)

3566

2760

client_settings.clear()

3567

2761

3568

2762

atexit.register(cleanup)

3569

3570

for client in tcp_server.clients.values():

2763

2764

for client in tcp_server.clients.itervalues():

3571

2765

if use_dbus:

3572

# Emit D-Bus signal for adding

3573

mandos_dbus_service.client_added_signal(client)

2766

# Emit D-Bus signal

2767

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3574

2768

# Need to initiate checking of clients

3575

2769

if client.enabled:

3576

2770

client.init_checker()

3577

2771

3578

2772

tcp_server.enable()

3579

2773

tcp_server.server_activate()

3580

2774

3581

2775

# Find out what port we got

3582

if zeroconf:

3583

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

2776

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

3584

2777

if use_ipv6:

3585

2778

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

3586

2779

" flowinfo %d, scope_id %d",

3588

2781

else: # IPv4

3589

2782

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

3590

2783

*tcp_server.socket.getsockname())

3591

3592

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

3593

2784

2785

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

2786

3594

2787

try:

3595

if zeroconf:

3596

# From the Avahi example code

3597

try:

3598

service.activate()

3599

except dbus.exceptions.DBusException as error:

3600

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

3601

cleanup()

3602

sys.exit(1)

3603

# End of Avahi example code

3604

3605

GLib.io_add_watch(

3606

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

3607

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3608

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

3609

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

3610

2788

# From the Avahi example code

2789

try:

2790

service.activate()

2791

except dbus.exceptions.DBusException as error:

2792

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

2793

cleanup()

2794

sys.exit(1)

2795

# End of Avahi example code

2796

2797

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

2798

lambda *args, **kwargs:

2799

(tcp_server.handle_request

2800

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

2801

3611

2802

logger.debug("Starting main loop")

3612

2803

main_loop.run()

3613

2804

except AvahiError as error:

3622

2813

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

3623

2814

cleanup()

3624

2815

3625

3626

def should_only_run_tests():

3627

parser = argparse.ArgumentParser(add_help=False)

3628

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

3629

args, unknown_args = parser.parse_known_args()

3630

run_tests = args.check

3631

if run_tests:

3632

# Remove --check argument from sys.argv

3633

sys.argv[1:] = unknown_args

3634

return run_tests

3635

3636

# Add all tests from doctest strings

3637

def load_tests(loader, tests, none):

3638

import doctest

3639

tests.addTests(doctest.DocTestSuite())

3640

return tests

3641

3642

2816

if __name__ == '__main__':

3643

try:

3644

if should_only_run_tests():

3645

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

3646

unittest.main()

3647

else:

3648

main()

3649

finally:

3650

logging.shutdown()

2817

main()