/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

import random

82

72

83

73

import dbus

84

74

import dbus.service

85

import gi

86

from gi.repository import GLib

75

import gobject

76

import avahi

87

77

from dbus.mainloop.glib import DBusGMainLoop

88

78

import ctypes

89

79

import ctypes.util

90

80

import xml.dom.minidom

91

81

import inspect

92

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

97

# Show warnings by default

98

if not sys.warnoptions:

99

import warnings

100

warnings.simplefilter("default")

101

102

# Try to find the value of SO_BINDTODEVICE:

82

import GnuPGInterface

83

103

84

try:

104

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

105

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

106

85

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

107

86

except AttributeError:

108

87

try:

109

# This is where SO_BINDTODEVICE was up to and including Python

110

# 2.6, and also 3.2:

111

88

from IN import SO_BINDTODEVICE

112

89

except ImportError:

113

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

114

# Try running the C preprocessor:

115

try:

116

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

117

"/dev/stdin"],

118

stdin=subprocess.PIPE,

119

stdout=subprocess.PIPE)

120

stdout = cc.communicate(

121

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

122

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

123

except (OSError, ValueError, IndexError):

124

# No value found

125

SO_BINDTODEVICE = None

126

127

if sys.version_info < (3, 2):

128

configparser.Configparser = configparser.SafeConfigParser

129

130

version = "1.8.9"

90

SO_BINDTODEVICE = None

91

92

version = "1.6.0"

131

93

stored_state_file = "clients.pickle"

132

94

133

95

logger = logging.getLogger()

134

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

135

syslogger = None

96

syslogger = (logging.handlers.SysLogHandler

97

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

98

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

136

99

137

100

try:

138

if_nametoindex = ctypes.cdll.LoadLibrary(

139

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

140

104

except (OSError, AttributeError):

141

142

105

def if_nametoindex(interface):

143

106

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

144

107

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

145

108

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

146

109

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

147

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

148

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]

149

114

return interface_index

150

115

151

116

152

def copy_function(func):

153

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

154

if sys.version_info.major == 2:

155

return types.FunctionType(func.func_code,

156

func.func_globals,

157

func.func_name,

158

func.func_defaults,

159

func.func_closure)

160

else:

161

return types.FunctionType(func.__code__,

162

func.__globals__,

163

func.__name__,

164

func.__defaults__,

165

func.__closure__)

166

167

168

117

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

169

118

"""init logger and add loglevel"""

170

171

global syslogger

172

syslogger = (logging.handlers.SysLogHandler(

173

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

174

address="/dev/log"))

119

175

120

syslogger.setFormatter(logging.Formatter

176

121

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

177

122

' %(message)s'))

178

123

logger.addHandler(syslogger)

179

124

180

125

if debug:

181

126

console = logging.StreamHandler()

182

127

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

192

137

pass

193

138

194

139

195

class PGPEngine:

140

class PGPEngine(object):

196

141

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

197

198

142

def __init__(self):

143

self.gnupg = GnuPGInterface.GnuPG()

199

144

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

200

self.gpg = "gpg"

201

try:

202

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

203

for line in output.splitlines():

204

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

205

if name == b"gpg":

206

self.gpg = path

207

break

208

except OSError as e:

209

if e.errno != errno.ENOENT:

210

raise

211

self.gnupgargs = ['--batch',

212

'--homedir', self.tempdir,

213

'--force-mdc',

214

'--quiet']

215

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

216

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

217

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

218

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

219

152

def __enter__(self):

220

153

return self

221

154

222

155

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

223

156

self._cleanup()

224

157

return False

225

158

226

159

def __del__(self):

227

160

self._cleanup()

228

161

229

162

def _cleanup(self):

230

163

if self.tempdir is not None:

231

164

# Delete contents of tempdir

232

165

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

233

topdown=False):

166

topdown = False):

234

167

for filename in files:

235

168

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

236

169

for dirname in dirs:

238

171

# Remove tempdir

239

172

os.rmdir(self.tempdir)

240

173

self.tempdir = None

241

174

242

175

def password_encode(self, password):

243

176

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

244

177

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

245

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

246

if len(encoded) > 2048:

247

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

248

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

249

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

250

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

251

return encoded

252

178

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

179

253

180

def encrypt(self, data, password):

254

passphrase = self.password_encode(password)

255

with tempfile.NamedTemporaryFile(

256

dir=self.tempdir) as passfile:

257

passfile.write(passphrase)

258

passfile.flush()

259

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

260

'--passphrase-file',

261

passfile.name]

262

+ self.gnupgargs,

263

stdin=subprocess.PIPE,

264

stdout=subprocess.PIPE,

265

stderr=subprocess.PIPE)

266

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

267

if proc.returncode != 0:

268

raise PGPError(err)

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

269

195

return ciphertext

270

196

271

197

def decrypt(self, data, password):

272

passphrase = self.password_encode(password)

273

with tempfile.NamedTemporaryFile(

274

dir=self.tempdir) as passfile:

275

passfile.write(passphrase)

276

passfile.flush()

277

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

278

'--passphrase-file',

279

passfile.name]

280

+ self.gnupgargs,

281

stdin=subprocess.PIPE,

282

stdout=subprocess.PIPE,

283

stderr=subprocess.PIPE)

284

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

285

if proc.returncode != 0:

286

raise PGPError(err)

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

287

212

return decrypted_plaintext

288

213

289

214

290

# Pretend that we have an Avahi module

291

class avahi:

292

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

293

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

294

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

295

PROTO_INET = 0 # avahi-common/address.h

296

PROTO_INET6 = 1 # avahi-common/address.h

297

DBUS_NAME = "org.freedesktop.Avahi"

298

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

299

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

300

DBUS_PATH_SERVER = "/"

301

302

@staticmethod

303

def string_array_to_txt_array(t):

304

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

305

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

306

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

307

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

308

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

309

SERVER_INVALID = 0 # avahi-common/defs.h

310

SERVER_REGISTERING = 1 # avahi-common/defs.h

311

SERVER_RUNNING = 2 # avahi-common/defs.h

312

SERVER_COLLISION = 3 # avahi-common/defs.h

313

SERVER_FAILURE = 4 # avahi-common/defs.h

314

315

316

215

class AvahiError(Exception):

317

216

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

318

217

self.value = value

319

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

320

**kwargs)

321

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

322

221

323

222

class AvahiServiceError(AvahiError):

324

223

pass

325

224

326

327

225

class AvahiGroupError(AvahiError):

328

226

pass

329

227

330

228

331

class AvahiService:

229

class AvahiService(object):

332

230

"""An Avahi (Zeroconf) service.

333

231

334

232

Attributes:

335

233

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

336

234

Used to optionally bind to the specified interface.

337

235

name: string; Example: 'Mandos'

338

236

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

339

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

237

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

340

238

port: integer; what port to announce

341

239

TXT: list of strings; TXT record for the service

342

240

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

348

246

server: D-Bus Server

349

247

bus: dbus.SystemBus()

350

248

"""

351

352

def __init__(self,

353

interface=avahi.IF_UNSPEC,

354

name=None,

355

servicetype=None,

356

port=None,

357

TXT=None,

358

domain="",

359

host="",

360

max_renames=32768,

361

protocol=avahi.PROTO_UNSPEC,

362

bus=None):

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

363

254

self.interface = interface

364

255

self.name = name

365

256

self.type = servicetype

374

265

self.server = None

375

266

self.bus = bus

376

267

self.entry_group_state_changed_match = None

377

378

def rename(self, remove=True):

268

269

def rename(self):

379

270

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

380

271

if self.rename_count >= self.max_renames:

381

272

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

382

273

" after %i retries, exiting.",

383

274

self.rename_count)

384

275

raise AvahiServiceError("Too many renames")

385

self.name = str(

386

self.server.GetAlternativeServiceName(self.name))

387

self.rename_count += 1

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

388

278

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

389

279

self.name)

390

if remove:

391

self.remove()

280

self.remove()

392

281

try:

393

282

self.add()

394

283

except dbus.exceptions.DBusException as error:

395

if (error.get_dbus_name()

396

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

397

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

398

return self.rename(remove=False)

399

else:

400

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

401

self.cleanup()

402

os._exit(1)

403

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

288

404

289

def remove(self):

405

290

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

406

291

if self.entry_group_state_changed_match is not None:

408

293

self.entry_group_state_changed_match = None

409

294

if self.group is not None:

410

295

self.group.Reset()

411

296

412

297

def add(self):

413

298

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

414

299

self.remove()

431

316

dbus.UInt16(self.port),

432

317

avahi.string_array_to_txt_array(self.TXT))

433

318

self.group.Commit()

434

319

435

320

def entry_group_state_changed(self, state, error):

436

321

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

437

322

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

438

323

439

324

if state == avahi.ENTRY_GROUP_ESTABLISHED:

440

325

logger.debug("Zeroconf service established.")

441

326

elif state == avahi.ENTRY_GROUP_COLLISION:

443

328

self.rename()

444

329

elif state == avahi.ENTRY_GROUP_FAILURE:

445

330

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

446

str(error))

447

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

448

331

unicode(error))

332

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

333

.format(error))

334

449

335

def cleanup(self):

450

336

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

451

337

if self.group is not None:

456

342

pass

457

343

self.group = None

458

344

self.remove()

459

345

460

346

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

461

347

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

462

348

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

463

bad_states = {

464

avahi.SERVER_INVALID: "Zeroconf server invalid",

465

avahi.SERVER_REGISTERING: None,

466

avahi.SERVER_COLLISION: "Zeroconf server name collision",

467

avahi.SERVER_FAILURE: "Zeroconf server failure",

468

}

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" }

469

356

if state in bad_states:

470

357

if bad_states[state] is not None:

471

358

if error is None:

474

361

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

475

362

self.cleanup()

476

363

elif state == avahi.SERVER_RUNNING:

477

try:

478

self.add()

479

except dbus.exceptions.DBusException as error:

480

if (error.get_dbus_name()

481

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

482

logger.info("Local Zeroconf service name"

483

" collision.")

484

return self.rename(remove=False)

485

else:

486

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

487

self.cleanup()

488

os._exit(1)

364

self.add()

489

365

else:

490

366

if error is None:

491

367

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

492

368

else:

493

369

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

494

370

495

371

def activate(self):

496

372

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

497

373

if self.server is None:

501

377

follow_name_owner_changes=True),

502

378

avahi.DBUS_INTERFACE_SERVER)

503

379

self.server.connect_to_signal("StateChanged",

504

self.server_state_changed)

380

self.server_state_changed)

505

381

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

506

382

507

383

508

384

class AvahiServiceToSyslog(AvahiService):

509

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

385

def rename(self):

510

386

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

511

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

512

syslogger.setFormatter(logging.Formatter(

513

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

514

.format(self.name)))

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

515

392

return ret

516

393

517

394

518

# Pretend that we have a GnuTLS module

519

class gnutls:

520

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

521

522

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

523

if library is None:

524

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

525

_library = ctypes.cdll.LoadLibrary(library)

526

del library

527

528

# Unless otherwise indicated, the constants and types below are

529

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

530

531

# Constants

532

E_SUCCESS = 0

533

E_INTERRUPTED = -52

534

E_AGAIN = -28

535

CRT_OPENPGP = 2

536

CRT_RAWPK = 3

537

CLIENT = 2

538

SHUT_RDWR = 0

539

CRD_CERTIFICATE = 1

540

E_NO_CERTIFICATE_FOUND = -49

541

X509_FMT_DER = 0

542

NO_TICKETS = 1<<10

543

ENABLE_RAWPK = 1<<18

544

CTYPE_PEERS = 3

545

KEYID_USE_SHA256 = 1 # gnutls/x509.h

546

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

547

548

# Types

549

class session_int(ctypes.Structure):

550

_fields_ = []

551

session_t = ctypes.POINTER(session_int)

552

553

class certificate_credentials_st(ctypes.Structure):

554

_fields_ = []

555

certificate_credentials_t = ctypes.POINTER(

556

certificate_credentials_st)

557

certificate_type_t = ctypes.c_int

558

559

class datum_t(ctypes.Structure):

560

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

561

('size', ctypes.c_uint)]

562

563

class openpgp_crt_int(ctypes.Structure):

564

_fields_ = []

565

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

566

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

567

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

568

credentials_type_t = ctypes.c_int

569

transport_ptr_t = ctypes.c_void_p

570

close_request_t = ctypes.c_int

571

572

# Exceptions

573

class Error(Exception):

574

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

575

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

576

# code is passed, convert it to a string with

577

# gnutls.strerror()

578

self.code = code

579

if message is None and code is not None:

580

message = gnutls.strerror(code)

581

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

582

message, *args)

583

584

class CertificateSecurityError(Error):

585

pass

586

587

# Classes

588

class Credentials:

589

def __init__(self):

590

self._c_object = gnutls.certificate_credentials_t()

591

gnutls.certificate_allocate_credentials(

592

ctypes.byref(self._c_object))

593

self.type = gnutls.CRD_CERTIFICATE

594

595

def __del__(self):

596

gnutls.certificate_free_credentials(self._c_object)

597

598

class ClientSession:

599

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

600

self._c_object = gnutls.session_t()

601

gnutls_flags = gnutls.CLIENT

602

if gnutls.check_version(b"3.5.6"):

603

gnutls_flags |= gnutls.NO_TICKETS

604

if gnutls.has_rawpk:

605

gnutls_flags |= gnutls.ENABLE_RAWPK

606

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

607

del gnutls_flags

608

gnutls.set_default_priority(self._c_object)

609

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

610

gnutls.handshake_set_private_extensions(self._c_object,

611

True)

612

self.socket = socket

613

if credentials is None:

614

credentials = gnutls.Credentials()

615

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

616

ctypes.cast(credentials._c_object,

617

ctypes.c_void_p))

618

self.credentials = credentials

619

620

def __del__(self):

621

gnutls.deinit(self._c_object)

622

623

def handshake(self):

624

return gnutls.handshake(self._c_object)

625

626

def send(self, data):

627

data = bytes(data)

628

data_len = len(data)

629

while data_len > 0:

630

data_len -= gnutls.record_send(self._c_object,

631

data[-data_len:],

632

data_len)

633

634

def bye(self):

635

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

636

637

# Error handling functions

638

def _error_code(result):

639

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

640

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

641

if result >= 0:

642

return result

643

if result == gnutls.E_NO_CERTIFICATE_FOUND:

644

raise gnutls.CertificateSecurityError(code=result)

645

raise gnutls.Error(code=result)

646

647

def _retry_on_error(result, func, arguments):

648

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

649

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

650

while result < 0:

651

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

652

return _error_code(result)

653

result = func(*arguments)

654

return result

655

656

# Unless otherwise indicated, the function declarations below are

657

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

658

659

# Functions

660

priority_set_direct = _library.gnutls_priority_set_direct

661

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

662

ctypes.POINTER(ctypes.c_char_p)]

663

priority_set_direct.restype = _error_code

664

665

init = _library.gnutls_init

666

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

667

init.restype = _error_code

668

669

set_default_priority = _library.gnutls_set_default_priority

670

set_default_priority.argtypes = [session_t]

671

set_default_priority.restype = _error_code

672

673

record_send = _library.gnutls_record_send

674

record_send.argtypes = [session_t, ctypes.c_void_p,

675

ctypes.c_size_t]

676

record_send.restype = ctypes.c_ssize_t

677

record_send.errcheck = _retry_on_error

678

679

certificate_allocate_credentials = (

680

_library.gnutls_certificate_allocate_credentials)

681

certificate_allocate_credentials.argtypes = [

682

ctypes.POINTER(certificate_credentials_t)]

683

certificate_allocate_credentials.restype = _error_code

684

685

certificate_free_credentials = (

686

_library.gnutls_certificate_free_credentials)

687

certificate_free_credentials.argtypes = [

688

certificate_credentials_t]

689

certificate_free_credentials.restype = None

690

691

handshake_set_private_extensions = (

692

_library.gnutls_handshake_set_private_extensions)

693

handshake_set_private_extensions.argtypes = [session_t,

694

ctypes.c_int]

695

handshake_set_private_extensions.restype = None

696

697

credentials_set = _library.gnutls_credentials_set

698

credentials_set.argtypes = [session_t, credentials_type_t,

699

ctypes.c_void_p]

700

credentials_set.restype = _error_code

701

702

strerror = _library.gnutls_strerror

703

strerror.argtypes = [ctypes.c_int]

704

strerror.restype = ctypes.c_char_p

705

706

certificate_type_get = _library.gnutls_certificate_type_get

707

certificate_type_get.argtypes = [session_t]

708

certificate_type_get.restype = _error_code

709

710

certificate_get_peers = _library.gnutls_certificate_get_peers

711

certificate_get_peers.argtypes = [session_t,

712

ctypes.POINTER(ctypes.c_uint)]

713

certificate_get_peers.restype = ctypes.POINTER(datum_t)

714

715

global_set_log_level = _library.gnutls_global_set_log_level

716

global_set_log_level.argtypes = [ctypes.c_int]

717

global_set_log_level.restype = None

718

719

global_set_log_function = _library.gnutls_global_set_log_function

720

global_set_log_function.argtypes = [log_func]

721

global_set_log_function.restype = None

722

723

deinit = _library.gnutls_deinit

724

deinit.argtypes = [session_t]

725

deinit.restype = None

726

727

handshake = _library.gnutls_handshake

728

handshake.argtypes = [session_t]

729

handshake.restype = _error_code

730

handshake.errcheck = _retry_on_error

731

732

transport_set_ptr = _library.gnutls_transport_set_ptr

733

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

734

transport_set_ptr.restype = None

735

736

bye = _library.gnutls_bye

737

bye.argtypes = [session_t, close_request_t]

738

bye.restype = _error_code

739

bye.errcheck = _retry_on_error

740

741

check_version = _library.gnutls_check_version

742

check_version.argtypes = [ctypes.c_char_p]

743

check_version.restype = ctypes.c_char_p

744

745

_need_version = b"3.3.0"

746

if check_version(_need_version) is None:

747

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

748

.format(_need_version))

749

750

_tls_rawpk_version = b"3.6.6"

751

has_rawpk = bool(check_version(_tls_rawpk_version))

752

753

if has_rawpk:

754

# Types

755

class pubkey_st(ctypes.Structure):

756

_fields = []

757

pubkey_t = ctypes.POINTER(pubkey_st)

758

759

x509_crt_fmt_t = ctypes.c_int

760

761

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

762

pubkey_init = _library.gnutls_pubkey_init

763

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

764

pubkey_init.restype = _error_code

765

766

pubkey_import = _library.gnutls_pubkey_import

767

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

768

x509_crt_fmt_t]

769

pubkey_import.restype = _error_code

770

771

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

772

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

773

ctypes.POINTER(ctypes.c_ubyte),

774

ctypes.POINTER(ctypes.c_size_t)]

775

pubkey_get_key_id.restype = _error_code

776

777

pubkey_deinit = _library.gnutls_pubkey_deinit

778

pubkey_deinit.argtypes = [pubkey_t]

779

pubkey_deinit.restype = None

780

else:

781

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

782

783

openpgp_crt_init = _library.gnutls_openpgp_crt_init

784

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

785

openpgp_crt_init.restype = _error_code

786

787

openpgp_crt_import = _library.gnutls_openpgp_crt_import

788

openpgp_crt_import.argtypes = [openpgp_crt_t,

789

ctypes.POINTER(datum_t),

790

openpgp_crt_fmt_t]

791

openpgp_crt_import.restype = _error_code

792

793

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

794

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

795

ctypes.POINTER(ctypes.c_uint)]

796

openpgp_crt_verify_self.restype = _error_code

797

798

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

799

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

800

openpgp_crt_deinit.restype = None

801

802

openpgp_crt_get_fingerprint = (

803

_library.gnutls_openpgp_crt_get_fingerprint)

804

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

805

ctypes.c_void_p,

806

ctypes.POINTER(

807

ctypes.c_size_t)]

808

openpgp_crt_get_fingerprint.restype = _error_code

809

810

if check_version(b"3.6.4"):

811

certificate_type_get2 = _library.gnutls_certificate_type_get2

812

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

813

certificate_type_get2.restype = _error_code

814

815

# Remove non-public functions

816

del _error_code, _retry_on_error

817

818

819

def call_pipe(connection, # : multiprocessing.Connection

820

func, *args, **kwargs):

821

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

822

823

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

824

return value on the provided multiprocessing.Connection.

825

"""

826

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

827

connection.close()

828

829

830

class Client:

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

831

403

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

832

404

833

405

Attributes:

834

406

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

835

407

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

836

408

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

837

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

838

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

839

running.

840

checker_callback_tag: a GLib event source tag, or None

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

841

413

checker_command: string; External command which is run to check

842

414

if client lives. %() expansions are done at

843

415

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

844

416

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

845

checker_initiator_tag: a GLib event source tag, or None

417

checker_initiator_tag: a gobject event source tag, or None

846

418

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

847

419

client_structure: Object describing what attributes a client has

848

420

and is used for storing the client at exit

849

421

current_checker_command: string; current running checker_command

850

disable_initiator_tag: a GLib event source tag, or None

422

disable_initiator_tag: a gobject event source tag, or None

851

423

enabled: bool()

852

424

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

853

uniquely identify an OpenPGP client

854

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

855

a client using raw public keys

425

uniquely identify the client

856

426

host: string; available for use by the checker command

857

427

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

858

428

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

860

430

last_checker_status: integer between 0 and 255 reflecting exit

861

431

status of last checker. -1 reflects crashed

862

432

checker, -2 means no checker completed yet.

863

last_checker_signal: The signal which killed the last checker, if

864

last_checker_status is -1

865

433

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

866

434

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

867

435

D-Bus identifiers

872

440

runtime_expansions: Allowed attributes for runtime expansion.

873

441

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

874

442

disabled, or None

875

server_settings: The server_settings dict from main()

876

443

"""

877

444

878

445

runtime_expansions = ("approval_delay", "approval_duration",

879

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

446

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

880

447

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

881

448

"last_approval_request", "last_checked_ok",

882

449

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

883

client_defaults = {

884

"timeout": "PT5M",

885

"extended_timeout": "PT15M",

886

"interval": "PT2M",

887

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

888

"host": "",

889

"approval_delay": "PT0S",

890

"approval_duration": "PT1S",

891

"approved_by_default": "True",

892

"enabled": "True",

893

}

894

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

895

476

@staticmethod

896

477

def config_parser(config):

897

478

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

904

485

for client_name in config.sections():

905

486

section = dict(config.items(client_name))

906

487

client = settings[client_name] = {}

907

488

908

489

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

909

490

# Reformat values from string types to Python types

910

491

client["approved_by_default"] = config.getboolean(

911

492

client_name, "approved_by_default")

912

493

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

913

494

"enabled")

914

915

# Uppercase and remove spaces from key_id and fingerprint

916

# for later comparison purposes with return value from the

917

# key_id() and fingerprint() functions

918

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

919

.replace(" ", ""))

495

920

496

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

921

497

.replace(" ", ""))

922

498

if "secret" in section:

923

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

924

.encode("utf-8"),

925

"base64")

499

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

926

500

elif "secfile" in section:

927

501

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

928

502

(section["secfile"])),

929

503

"rb") as secfile:

930

504

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

931

505

else:

932

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

506

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

933

507

.format(section))

934

508

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

935

509

client["extended_timeout"] = string_to_delta(

943

517

client["last_approval_request"] = None

944

518

client["last_checked_ok"] = None

945

519

client["last_checker_status"] = -2

946

520

947

521

return settings

948

949

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

522

523

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

950

524

self.name = name

951

if server_settings is None:

952

server_settings = {}

953

self.server_settings = server_settings

954

525

# adding all client settings

955

for setting, value in settings.items():

526

for setting, value in settings.iteritems():

956

527

setattr(self, setting, value)

957

528

958

529

if self.enabled:

959

530

if not hasattr(self, "last_enabled"):

960

531

self.last_enabled = datetime.datetime.utcnow()

964

535

else:

965

536

self.last_enabled = None

966

537

self.expires = None

967

538

968

539

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

969

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

970

543

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

971

544

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

972

545

datetime.datetime.utcnow())

973

546

974

547

# attributes specific for this server instance

975

548

self.checker = None

976

549

self.checker_initiator_tag = None

979

552

self.current_checker_command = None

980

553

self.approved = None

981

554

self.approvals_pending = 0

982

self.changedstate = multiprocessing_manager.Condition(

983

multiprocessing_manager.Lock())

984

self.client_structure = [attr

985

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

986

560

if not attr.startswith("_")]

987

561

self.client_structure.append("client_structure")

988

989

for name, t in inspect.getmembers(

990

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

991

567

if not name.startswith("_"):

992

568

self.client_structure.append(name)

993

569

994

570

# Send notice to process children that client state has changed

995

571

def send_changedstate(self):

996

572

with self.changedstate:

997

573

self.changedstate.notify_all()

998

574

999

575

def enable(self):

1000

576

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

1001

577

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

1006

582

self.last_enabled = datetime.datetime.utcnow()

1007

583

self.init_checker()

1008

584

self.send_changedstate()

1009

585

1010

586

def disable(self, quiet=True):

1011

587

"""Disable this client."""

1012

588

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

1014

590

if not quiet:

1015

591

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

1016

592

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

1017

GLib.source_remove(self.disable_initiator_tag)

593

gobject.source_remove(self.disable_initiator_tag)

1018

594

self.disable_initiator_tag = None

1019

595

self.expires = None

1020

596

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

1021

GLib.source_remove(self.checker_initiator_tag)

597

gobject.source_remove(self.checker_initiator_tag)

1022

598

self.checker_initiator_tag = None

1023

599

self.stop_checker()

1024

600

self.enabled = False

1025

601

if not quiet:

1026

602

self.send_changedstate()

1027

# 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

1028

604

return False

1029

605

1030

606

def __del__(self):

1031

607

self.disable()

1032

608

1033

609

def init_checker(self):

1034

610

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

1035

611

# and every interval from then on.

1036

612

if self.checker_initiator_tag is not None:

1037

GLib.source_remove(self.checker_initiator_tag)

1038

self.checker_initiator_tag = GLib.timeout_add(

1039

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

1040

+ 1)),

1041

self.start_checker)

613

gobject.source_remove(self.checker_initiator_tag)

614

self.checker_initiator_tag = (gobject.timeout_add

615

(self.interval_milliseconds(),

616

self.start_checker))

1042

617

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

1043

618

if self.disable_initiator_tag is not None:

1044

GLib.source_remove(self.disable_initiator_tag)

1045

self.disable_initiator_tag = GLib.timeout_add(

1046

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

619

gobject.source_remove(self.disable_initiator_tag)

620

self.disable_initiator_tag = (gobject.timeout_add

621

(self.timeout_milliseconds(),

622

self.disable))

1047

623

# Also start a new checker *right now*.

1048

624

self.start_checker()

1049

1050

def checker_callback(self, source, condition, connection,

1051

command):

625

626

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

1052

627

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

1053

# Read return code from connection (see call_pipe)

1054

returncode = connection.recv()

1055

connection.close()

1056

if self.checker is not None:

1057

self.checker.join()

1058

628

self.checker_callback_tag = None

1059

629

self.checker = None

1060

1061

if returncode >= 0:

1062

self.last_checker_status = returncode

1063

self.last_checker_signal = None

630

if os.WIFEXITED(condition):

631

self.last_checker_status = os.WEXITSTATUS(condition)

1064

632

if self.last_checker_status == 0:

1065

633

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

1066

634

vars(self))

1067

635

self.checked_ok()

1068

636

else:

1069

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

637

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

638

vars(self))

1070

639

else:

1071

640

self.last_checker_status = -1

1072

self.last_checker_signal = -returncode

1073

641

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

1074

642

vars(self))

1075

return False

1076

643

1077

644

def checked_ok(self):

1078

645

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

1079

646

self.last_checked_ok = datetime.datetime.utcnow()

1080

647

self.last_checker_status = 0

1081

self.last_checker_signal = None

1082

648

self.bump_timeout()

1083

649

1084

650

def bump_timeout(self, timeout=None):

1085

651

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

1086

652

if timeout is None:

1087

653

timeout = self.timeout

1088

654

if self.disable_initiator_tag is not None:

1089

GLib.source_remove(self.disable_initiator_tag)

655

gobject.source_remove(self.disable_initiator_tag)

1090

656

self.disable_initiator_tag = None

1091

657

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

1092

self.disable_initiator_tag = GLib.timeout_add(

1093

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

658

self.disable_initiator_tag = (gobject.timeout_add

659

(timedelta_to_milliseconds

660

(timeout), self.disable))

1094

661

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

1095

662

1096

663

def need_approval(self):

1097

664

self.last_approval_request = datetime.datetime.utcnow()

1098

665

1099

666

def start_checker(self):

1100

667

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

1101

668

1102

669

If a checker already exists, leave it running and do

1103

670

nothing."""

1104

671

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

1109

676

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

1110

677

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

1111

678

# should be.

1112

1113

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

1114

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

1115

self.checker.join()

1116

self.checker = None

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)

1117

693

# Start a new checker if needed

1118

694

if self.checker is None:

1119

695

# Escape attributes for the shell

1120

escaped_attrs = {

1121

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

1122

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)

1123

700

try:

1124

701

command = self.checker_command % escaped_attrs

1125

702

except TypeError as error:

1126

703

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

1127

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",

1128

719

exc_info=error)

1129

return True # Try again later

1130

self.current_checker_command = command

1131

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

1132

self.name)

1133

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

1134

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

1135

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

1136

# always replaced by /dev/null.)

1137

# The exception is when not debugging but nevertheless

1138

# running in the foreground; use the previously

1139

# created wnull.

1140

popen_args = {"close_fds": True,

1141

"shell": True,

1142

"cwd": "/"}

1143

if (not self.server_settings["debug"]

1144

and self.server_settings["foreground"]):

1145

popen_args.update({"stdout": wnull,

1146

"stderr": wnull})

1147

pipe = multiprocessing.Pipe(duplex=False)

1148

self.checker = multiprocessing.Process(

1149

target=call_pipe,

1150

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

1151

kwargs=popen_args)

1152

self.checker.start()

1153

self.checker_callback_tag = GLib.io_add_watch(

1154

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

1155

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1156

self.checker_callback, pipe[0], command)

1157

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

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

1158

731

return True

1159

732

1160

733

def stop_checker(self):

1161

734

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

1162

735

if self.checker_callback_tag:

1163

GLib.source_remove(self.checker_callback_tag)

736

gobject.source_remove(self.checker_callback_tag)

1164

737

self.checker_callback_tag = None

1165

738

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

1166

739

return

1167

740

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

1168

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

1169

749

self.checker = None

1170

750

1171

751

1172

def dbus_service_property(dbus_interface,

1173

signature="v",

1174

access="readwrite",

1175

byte_arrays=False):

752

def dbus_service_property(dbus_interface, signature="v",

753

access="readwrite", byte_arrays=False):

1176

754

"""Decorators for marking methods of a DBusObjectWithProperties to

1177

755

become properties on the D-Bus.

1178

756

1179

757

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

1180

758

and with one argument by "Set".

1181

759

1182

760

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

1183

761

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

1184

762

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

1187

765

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

1188

766

if byte_arrays and signature != "ay":

1189

767

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

1190

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

1191

768

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

1192

769

def decorator(func):

1193

770

func._dbus_is_property = True

1194

771

func._dbus_interface = dbus_interface

1197

774

func._dbus_name = func.__name__

1198

775

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

1199

776

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

1200

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

777

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1201

778

return func

1202

1203

779

return decorator

1204

780

1205

781

1206

782

def dbus_interface_annotations(dbus_interface):

1207

783

"""Decorator for marking functions returning interface annotations

1208

784

1209

785

Usage:

1210

786

1211

787

@dbus_interface_annotations("org.example.Interface")

1212

788

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

1213

789

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

1214

790

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

1215

791

"false"}

1216

792

"""

1217

1218

793

def decorator(func):

1219

794

func._dbus_is_interface = True

1220

795

func._dbus_interface = dbus_interface

1221

796

func._dbus_name = dbus_interface

1222

797

return func

1223

1224

798

return decorator

1225

799

1226

800

1227

801

def dbus_annotations(annotations):

1228

802

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

1229

803

Usage:

1230

1231

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

1232

"org.freedesktop.DBus.Property."

1233

"EmitsChangedSignal": "false"})

804

1234

805

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

1235

806

access="r")

807

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

808

"org.freedesktop.DBus.Property."

809

"EmitsChangedSignal": "false"})

1236

810

def Property_dbus_property(self):

1237

811

return dbus.Boolean(False)

1238

1239

See also the DBusObjectWithAnnotations class.

1240

812

"""

1241

1242

813

def decorator(func):

1243

814

func._dbus_annotations = annotations

1244

815

return func

1245

1246

816

return decorator

1247

817

1248

818

1249

819

class DBusPropertyException(dbus.exceptions.DBusException):

1250

820

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

1251

821

"""

1252

pass

822

def __unicode__(self):

823

return unicode(str(self))

1253

824

1254

825

1255

826

class DBusPropertyAccessException(DBusPropertyException):

1264

835

pass

1265

836

1266

837

1267

class DBusObjectWithAnnotations(dbus.service.Object):

1268

"""A D-Bus object with annotations.

1269

1270

Classes inheriting from this can use the dbus_annotations

1271

decorator to add annotations to methods or signals.

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.

1272

844

"""

1273

845

1274

846

@staticmethod

1275

847

def _is_dbus_thing(thing):

1276

848

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

1277

849

1278

850

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

1279

851

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

1280

852

"""

1281

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

853

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

1282

854

False)

1283

855

1284

856

def _get_all_dbus_things(self, thing):

1285

857

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

1286

858

"""

1287

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

859

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

860

name),

1288

861

athing.__get__(self))

1289

862

for cls in self.__class__.__mro__

1290

863

for name, athing in

1291

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

1292

1293

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1294

out_signature="s",

1295

path_keyword='object_path',

1296

connection_keyword='connection')

1297

def Introspect(self, object_path, connection):

1298

"""Overloading of standard D-Bus method.

1299

1300

Inserts annotation tags on methods and signals.

1301

"""

1302

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

1303

connection)

1304

try:

1305

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

1306

1307

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

1308

# Add annotation tags

1309

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

1310

for tag in if_tag.getElementsByTagName(typ):

1311

annots = dict()

1312

for name, prop in (self.

1313

_get_all_dbus_things(typ)):

1314

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

1315

and prop._dbus_interface

1316

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

1317

annots.update(getattr(

1318

prop, "_dbus_annotations", {}))

1319

for name, value in annots.items():

1320

ann_tag = document.createElement(

1321

"annotation")

1322

ann_tag.setAttribute("name", name)

1323

ann_tag.setAttribute("value", value)

1324

tag.appendChild(ann_tag)

1325

# Add interface annotation tags

1326

for annotation, value in dict(

1327

itertools.chain.from_iterable(

1328

annotations().items()

1329

for name, annotations

1330

in self._get_all_dbus_things("interface")

1331

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

1332

)).items():

1333

ann_tag = document.createElement("annotation")

1334

ann_tag.setAttribute("name", annotation)

1335

ann_tag.setAttribute("value", value)

1336

if_tag.appendChild(ann_tag)

1337

# Fix argument name for the Introspect method itself

1338

if (if_tag.getAttribute("name")

1339

== dbus.INTROSPECTABLE_IFACE):

1340

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

1341

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

1342

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

1343

if (arg.getAttribute("direction")

1344

== "out"):

1345

arg.setAttribute("name",

1346

"xml_data")

1347

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

1348

document.unlink()

1349

except (AttributeError, xml.dom.DOMException,

1350

xml.parsers.expat.ExpatError) as error:

1351

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

1352

exc_info=error)

1353

return xmlstring

1354

1355

1356

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1357

"""A D-Bus object with properties.

1358

1359

Classes inheriting from this can use the dbus_service_property

1360

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

1361

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

1362

"""

1363

864

inspect.getmembers(cls,

865

self._is_dbus_thing(thing)))

866

1364

867

def _get_dbus_property(self, interface_name, property_name):

1365

868

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

1366

869

property with the specified name and interface.

1367

870

"""

1368

for cls in self.__class__.__mro__:

1369

for name, value in inspect.getmembers(

1370

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

1371

875

if (value._dbus_name == property_name

1372

876

and value._dbus_interface == interface_name):

1373

877

return value.__get__(self)

1374

878

1375

879

# No such property

1376

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

1377

self.dbus_object_path, interface_name, property_name))

1378

1379

@classmethod

1380

def _get_all_interface_names(cls):

1381

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

1382

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

1383

"_dbus_interface", None)

1384

for x in (inspect.getmro(cls))

1385

for attr in dir(x))

1386

if name is not None)

1387

1388

@dbus.service.method(dbus.PROPERTIES_IFACE,

1389

in_signature="ss",

880

raise DBusPropertyNotFound(self.dbus_object_path + ":"

881

+ interface_name + "."

882

+ property_name)

883

884

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

1390

885

out_signature="v")

1391

886

def Get(self, interface_name, property_name):

1392

887

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

1398

893

if not hasattr(value, "variant_level"):

1399

894

return value

1400

895

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

1401

896

1402

897

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

1403

898

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

1404

899

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

1410

905

# The byte_arrays option is not supported yet on

1411

906

# signatures other than "ay".

1412

907

if prop._dbus_signature != "ay":

1413

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

1414

"'ay' signature {!r}"

1415

.format(prop._dbus_signature))

1416

value = dbus.ByteArray(bytes(value))

908

raise ValueError

909

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

910

for byte in value))

1417

911

prop(value)

1418

1419

@dbus.service.method(dbus.PROPERTIES_IFACE,

1420

in_signature="s",

912

913

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

1421

914

out_signature="a{sv}")

1422

915

def GetAll(self, interface_name):

1423

916

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

1424

917

standard.

1425

918

1426

919

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

1427

920

"""

1428

921

properties = {}

1438

931

if not hasattr(value, "variant_level"):

1439

932

properties[name] = value

1440

933

continue

1441

properties[name] = type(value)(

1442

value, variant_level=value.variant_level + 1)

934

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

935

value.variant_level+1)

1443

936

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

1444

1445

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

1446

def PropertiesChanged(self, interface_name, changed_properties,

1447

invalidated_properties):

1448

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

1449

standard.

1450

"""

1451

pass

1452

937

1453

938

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1454

939

out_signature="s",

1455

940

path_keyword='object_path',

1456

941

connection_keyword='connection')

1457

942

def Introspect(self, object_path, connection):

1458

943

"""Overloading of standard D-Bus method.

1459

944

1460

945

Inserts property tags and interface annotation tags.

1461

946

"""

1462

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1463

object_path,

1464

connection)

947

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

948

connection)

1465

949

try:

1466

950

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

1467

1468

951

def make_tag(document, name, prop):

1469

952

e = document.createElement("property")

1470

953

e.setAttribute("name", name)

1471

954

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

1472

955

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

1473

956

return e

1474

1475

957

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

1476

958

# Add property tags

1477

959

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

1480

962

if prop._dbus_interface

1481

963

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

1482

964

if_tag.appendChild(tag)

1483

# Add annotation tags for properties

1484

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

1485

annots = dict()

1486

for name, prop in self._get_all_dbus_things(

1487

"property"):

1488

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

1489

and prop._dbus_interface

1490

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

1491

annots.update(getattr(

1492

prop, "_dbus_annotations", {}))

1493

for name, value in annots.items():

1494

ann_tag = document.createElement(

1495

"annotation")

1496

ann_tag.setAttribute("name", name)

1497

ann_tag.setAttribute("value", value)

1498

tag.appendChild(ann_tag)

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)

1499

996

# Add the names to the return values for the

1500

997

# "org.freedesktop.DBus.Properties" methods

1501

998

if (if_tag.getAttribute("name")

1520

1017

return xmlstring

1521

1018

1522

1019

1523

try:

1524

dbus.OBJECT_MANAGER_IFACE

1525

except AttributeError:

1526

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

1527

1528

1529

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1530

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

1531

1532

Classes inheriting from this exposes the standard

1533

GetManagedObjects call and the InterfacesAdded and

1534

InterfacesRemoved signals on the standard

1535

"org.freedesktop.DBus.ObjectManager" interface.

1536

1537

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

1538

manually.

1539

"""

1540

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1541

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

1542

def GetManagedObjects(self):

1543

"""This function must be overridden"""

1544

raise NotImplementedError()

1545

1546

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1547

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

1548

def InterfacesAdded(self, object_path, interfaces_and_properties):

1549

pass

1550

1551

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

1552

def InterfacesRemoved(self, object_path, interfaces):

1553

pass

1554

1555

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1556

out_signature="s",

1557

path_keyword='object_path',

1558

connection_keyword='connection')

1559

def Introspect(self, object_path, connection):

1560

"""Overloading of standard D-Bus method.

1561

1562

Override return argument name of GetManagedObjects to be

1563

"objpath_interfaces_and_properties"

1564

"""

1565

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1566

object_path,

1567

connection)

1568

try:

1569

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

1570

1571

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

1572

# Fix argument name for the GetManagedObjects method

1573

if (if_tag.getAttribute("name")

1574

== dbus.OBJECT_MANAGER_IFACE):

1575

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

1576

if (cn.getAttribute("name")

1577

== "GetManagedObjects"):

1578

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

1579

if (arg.getAttribute("direction")

1580

== "out"):

1581

arg.setAttribute(

1582

"name",

1583

"objpath_interfaces"

1584

"_and_properties")

1585

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

1586

document.unlink()

1587

except (AttributeError, xml.dom.DOMException,

1588

xml.parsers.expat.ExpatError) as error:

1589

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

1590

exc_info=error)

1591

return xmlstring

1592

1593

1594

1020

def datetime_to_dbus(dt, variant_level=0):

1595

1021

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

1596

1022

if dt is None:

1597

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

1598

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)

1599

1026

1600

1027

1601

1028

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1603

1030

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

1604

1031

interface names according to the "alt_interface_names" mapping.

1605

1032

Usage:

1606

1033

1607

1034

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

1608

1035

"net.example.AlternateInterface"})

1609

1036

class SampleDBusObject(dbus.service.Object):

1610

1037

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

1611

1038

def SampleDBusMethod():

1612

1039

pass

1613

1040

1614

1041

The above "SampleDBusMethod" on "SampleDBusObject" will be

1615

1042

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

1616

1043

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

1617

1044

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

1618

1045

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

1619

1046

1620

1047

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

1621

1048

(from DBusObjectWithProperties) and interfaces (from the

1622

1049

dbus_interface_annotations decorator).

1623

1050

"""

1624

1625

1051

def wrapper(cls):

1626

1052

for orig_interface_name, alt_interface_name in (

1627

alt_interface_names.items()):

1053

alt_interface_names.iteritems()):

1628

1054

attr = {}

1629

1055

interface_names = set()

1630

1056

# Go though all attributes of the class

1632

1058

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

1633

1059

# with the wrong interface name

1634

1060

if (not hasattr(attribute, "_dbus_interface")

1635

or not attribute._dbus_interface.startswith(

1636

orig_interface_name)):

1061

or not attribute._dbus_interface

1062

.startswith(orig_interface_name)):

1637

1063

continue

1638

1064

# Create an alternate D-Bus interface name based on

1639

1065

# the current name

1640

alt_interface = attribute._dbus_interface.replace(

1641

orig_interface_name, alt_interface_name)

1066

alt_interface = (attribute._dbus_interface

1067

.replace(orig_interface_name,

1068

alt_interface_name))

1642

1069

interface_names.add(alt_interface)

1643

1070

# Is this a D-Bus signal?

1644

1071

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

1645

# Extract the original non-method undecorated

1646

# function by black magic

1647

if sys.version_info.major == 2:

1648

nonmethod_func = (dict(

1072

# Extract the original non-method function by

1073

# black magic

1074

nonmethod_func = (dict(

1649

1075

zip(attribute.func_code.co_freevars,

1650

attribute.__closure__))

1651

["func"].cell_contents)

1652

else:

1653

nonmethod_func = (dict(

1654

zip(attribute.__code__.co_freevars,

1655

attribute.__closure__))

1656

["func"].cell_contents)

1076

attribute.__closure__))["func"]

1077

.cell_contents)

1657

1078

# Create a new, but exactly alike, function

1658

1079

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

1659

1080

# with the alternate D-Bus interface name

1660

new_function = copy_function(nonmethod_func)

1661

new_function = (dbus.service.signal(

1662

alt_interface,

1663

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

1664

1090

# Copy annotations, if any

1665

1091

try:

1666

new_function._dbus_annotations = dict(

1667

attribute._dbus_annotations)

1092

new_function._dbus_annotations = (

1093

dict(attribute._dbus_annotations))

1668

1094

except AttributeError:

1669

1095

pass

1670

1671

1096

# Define a creator of a function to call both the

1672

1097

# original and alternate functions, so both the

1673

1098

# original and alternate signals gets sent when

1676

1101

"""This function is a scope container to pass

1677

1102

func1 and func2 to the "call_both" function

1678

1103

outside of its arguments"""

1679

1680

@functools.wraps(func2)

1681

1104

def call_both(*args, **kwargs):

1682

1105

"""This function will emit two D-Bus

1683

1106

signals by calling func1 and func2"""

1684

1107

func1(*args, **kwargs)

1685

1108

func2(*args, **kwargs)

1686

# Make wrapper function look like a D-Bus

1687

# signal

1688

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

1689

if name.startswith("_dbus_"):

1690

setattr(call_both, name, attr)

1691

1692

1109

return call_both

1693

1110

# Create the "call_both" function and add it to

1694

1111

# the class

1699

1116

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

1700

1117

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

1701

1118

# to the class.

1702

attr[attrname] = (

1703

dbus.service.method(

1704

alt_interface,

1705

attribute._dbus_in_signature,

1706

attribute._dbus_out_signature)

1707

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

1708

1129

# Copy annotations, if any

1709

1130

try:

1710

attr[attrname]._dbus_annotations = dict(

1711

attribute._dbus_annotations)

1131

attr[attrname]._dbus_annotations = (

1132

dict(attribute._dbus_annotations))

1712

1133

except AttributeError:

1713

1134

pass

1714

1135

# Is this a D-Bus property?

1717

1138

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

1718

1139

# property with the alternate D-Bus interface

1719

1140

# name. Add it to the class.

1720

attr[attrname] = (dbus_service_property(

1721

alt_interface, attribute._dbus_signature,

1722

attribute._dbus_access,

1723

attribute._dbus_get_args_options

1724

["byte_arrays"])

1725

(copy_function(attribute)))

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

1726

1154

# Copy annotations, if any

1727

1155

try:

1728

attr[attrname]._dbus_annotations = dict(

1729

attribute._dbus_annotations)

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1730

1158

except AttributeError:

1731

1159

pass

1732

1160

# Is this a D-Bus interface?

1735

1163

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

1736

1164

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

1737

1165

# to the class.

1738

attr[attrname] = (

1739

dbus_interface_annotations(alt_interface)

1740

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

1741

1174

if deprecate:

1742

1175

# Deprecate all alternate interfaces

1743

iname = "_AlternateDBusNames_interface_annotation{}"

1176

iname="_AlternateDBusNames_interface_annotation{0}"

1744

1177

for interface_name in interface_names:

1745

1746

1178

@dbus_interface_annotations(interface_name)

1747

1179

def func(self):

1748

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

1749

"true"}

1180

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

1181

"true" }

1750

1182

# Find an unused name

1751

1183

for aname in (iname.format(i)

1752

1184

for i in itertools.count()):

1756

1188

if interface_names:

1757

1189

# Replace the class with a new subclass of it with

1758

1190

# methods, signals, etc. as created above.

1759

if sys.version_info.major == 2:

1760

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

1761

(cls, ), attr)

1762

else:

1763

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

1764

(cls, ), attr)

1191

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

1192

(cls,), attr)

1765

1193

return cls

1766

1767

1194

return wrapper

1768

1195

1769

1196

1770

1197

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

1771

"se.bsnet.fukt.Mandos"})

1198

"se.bsnet.fukt.Mandos"})

1772

1199

class ClientDBus(Client, DBusObjectWithProperties):

1773

1200

"""A Client class using D-Bus

1774

1201

1775

1202

Attributes:

1776

1203

dbus_object_path: dbus.ObjectPath

1777

1204

bus: dbus.SystemBus()

1778

1205

"""

1779

1206

1780

1207

runtime_expansions = (Client.runtime_expansions

1781

+ ("dbus_object_path", ))

1782

1783

_interface = "se.recompile.Mandos.Client"

1784

1208

+ ("dbus_object_path",))

1209

1785

1210

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

1786

1787

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

1211

1212

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

1788

1213

self.bus = bus

1789

1214

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

1790

1215

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

1791

1216

# the D-Bus

1792

client_object_name = str(self.name).translate(

1217

client_object_name = unicode(self.name).translate(

1793

1218

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

1794

1219

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

1795

self.dbus_object_path = dbus.ObjectPath(

1796

"/clients/" + client_object_name)

1220

self.dbus_object_path = (dbus.ObjectPath

1221

("/clients/" + client_object_name))

1797

1222

DBusObjectWithProperties.__init__(self, self.bus,

1798

1223

self.dbus_object_path)

1799

1800

def notifychangeproperty(transform_func, dbus_name,

1801

type_func=lambda x: x,

1802

variant_level=1,

1803

invalidate_only=False,

1804

_interface=_interface):

1224

1225

def notifychangeproperty(transform_func,

1226

dbus_name, type_func=lambda x: x,

1227

variant_level=1):

1805

1228

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

1806

1229

its changes to DBus.

1807

1230

1808

1231

transform_fun: Function that takes a value and a variant_level

1809

1232

and transforms it to a D-Bus type.

1810

1233

dbus_name: D-Bus name of the variable

1812

1235

to the D-Bus. Default: no transform

1813

1236

variant_level: D-Bus variant level. Default: 1

1814

1237

"""

1815

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

1816

1238

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

1817

1239

def setter(self, value):

1818

1240

if hasattr(self, "dbus_object_path"):

1819

1241

if (not hasattr(self, attrname) or

1820

1242

type_func(getattr(self, attrname, None))

1821

1243

!= type_func(value)):

1822

if invalidate_only:

1823

self.PropertiesChanged(

1824

_interface, dbus.Dictionary(),

1825

dbus.Array((dbus_name, )))

1826

else:

1827

dbus_value = transform_func(

1828

type_func(value),

1829

variant_level=variant_level)

1830

self.PropertyChanged(dbus.String(dbus_name),

1831

dbus_value)

1832

self.PropertiesChanged(

1833

_interface,

1834

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

1835

dbus_value}),

1836

dbus.Array())

1244

dbus_value = transform_func(type_func(value),

1245

variant_level

1246

=variant_level)

1247

self.PropertyChanged(dbus.String(dbus_name),

1248

dbus_value)

1837

1249

setattr(self, attrname, value)

1838

1250

1839

1251

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

1840

1252

1841

1253

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1842

1254

approvals_pending = notifychangeproperty(dbus.Boolean,

1843

1255

"ApprovalPending",

1844

type_func=bool)

1256

type_func = bool)

1845

1257

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

1846

1258

last_enabled = notifychangeproperty(datetime_to_dbus,

1847

1259

"LastEnabled")

1848

checker = notifychangeproperty(

1849

dbus.Boolean, "CheckerRunning",

1850

type_func=lambda checker: checker is not None)

1260

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

1261

type_func = lambda checker:

1262

checker is not None)

1851

1263

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1852

1264

"LastCheckedOK")

1853

1265

last_checker_status = notifychangeproperty(dbus.Int16,

1856

1268

datetime_to_dbus, "LastApprovalRequest")

1857

1269

approved_by_default = notifychangeproperty(dbus.Boolean,

1858

1270

"ApprovedByDefault")

1859

approval_delay = notifychangeproperty(

1860

dbus.UInt64, "ApprovalDelay",

1861

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

1271

approval_delay = notifychangeproperty(dbus.UInt64,

1272

"ApprovalDelay",

1273

type_func =

1274

timedelta_to_milliseconds)

1862

1275

approval_duration = notifychangeproperty(

1863

1276

dbus.UInt64, "ApprovalDuration",

1864

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

1277

type_func = timedelta_to_milliseconds)

1865

1278

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

1866

timeout = notifychangeproperty(

1867

dbus.UInt64, "Timeout",

1868

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

1279

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

1280

type_func =

1281

timedelta_to_milliseconds)

1869

1282

extended_timeout = notifychangeproperty(

1870

1283

dbus.UInt64, "ExtendedTimeout",

1871

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

1872

interval = notifychangeproperty(

1873

dbus.UInt64, "Interval",

1874

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

1284

type_func = timedelta_to_milliseconds)

1285

interval = notifychangeproperty(dbus.UInt64,

1286

"Interval",

1287

type_func =

1288

timedelta_to_milliseconds)

1875

1289

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

1876

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

1877

invalidate_only=True)

1878

1290

1879

1291

del notifychangeproperty

1880

1292

1881

1293

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

1882

1294

try:

1883

1295

self.remove_from_connection()

1886

1298

if hasattr(DBusObjectWithProperties, "__del__"):

1887

1299

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

1888

1300

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

1889

1890

def checker_callback(self, source, condition,

1891

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

1892

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

1893

connection, command, *args,

1894

**kwargs)

1895

exitstatus = self.last_checker_status

1896

if exitstatus >= 0:

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)

1897

1308

# Emit D-Bus signal

1898

1309

self.CheckerCompleted(dbus.Int16(exitstatus),

1899

# This is specific to GNU libC

1900

dbus.Int64(exitstatus << 8),

1310

dbus.Int64(condition),

1901

1311

dbus.String(command))

1902

1312

else:

1903

1313

# Emit D-Bus signal

1904

1314

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

1905

dbus.Int64(

1906

# This is specific to GNU libC

1907

(exitstatus << 8)

1908

| self.last_checker_signal),

1315

dbus.Int64(condition),

1909

1316

dbus.String(command))

1910

return ret

1911

1317

1318

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

1319

*args, **kwargs)

1320

1912

1321

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

1913

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

1914

1327

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

1915

1328

# Only if new checker process was started

1916

1329

if (self.checker is not None

1918

1331

# Emit D-Bus signal

1919

1332

self.CheckerStarted(self.current_checker_command)

1920

1333

return r

1921

1334

1922

1335

def _reset_approved(self):

1923

1336

self.approved = None

1924

1337

return False

1925

1338

1926

1339

def approve(self, value=True):

1927

1340

self.approved = value

1928

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

1929

* 1000), self._reset_approved)

1341

gobject.timeout_add(timedelta_to_milliseconds

1342

(self.approval_duration),

1343

self._reset_approved)

1930

1344

self.send_changedstate()

1931

1932

# D-Bus methods, signals & properties

1933

1934

# Interfaces

1935

1936

# Signals

1937

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

1938

1358

# CheckerCompleted - signal

1939

1359

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

1940

1360

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

1941

1361

"D-Bus signal"

1942

1362

pass

1943

1363

1944

1364

# CheckerStarted - signal

1945

1365

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

1946

1366

def CheckerStarted(self, command):

1947

1367

"D-Bus signal"

1948

1368

pass

1949

1369

1950

1370

# PropertyChanged - signal

1951

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

1952

1371

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

1953

1372

def PropertyChanged(self, property, value):

1954

1373

"D-Bus signal"

1955

1374

pass

1956

1375

1957

1376

# GotSecret - signal

1958

1377

@dbus.service.signal(_interface)

1959

1378

def GotSecret(self):

1962

1381

server to mandos-client

1963

1382

"""

1964

1383

pass

1965

1384

1966

1385

# Rejected - signal

1967

1386

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

1968

1387

def Rejected(self, reason):

1969

1388

"D-Bus signal"

1970

1389

pass

1971

1390

1972

1391

# NeedApproval - signal

1973

1392

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

1974

1393

def NeedApproval(self, timeout, default):

1975

1394

"D-Bus signal"

1976

1395

return self.need_approval()

1977

1978

# Methods

1979

1396

1397

## Methods

1398

1980

1399

# Approve - method

1981

1400

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

1982

1401

def Approve(self, value):

1983

1402

self.approve(value)

1984

1403

1985

1404

# CheckedOK - method

1986

1405

@dbus.service.method(_interface)

1987

1406

def CheckedOK(self):

1988

1407

self.checked_ok()

1989

1408

1990

1409

# Enable - method

1991

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

1992

1410

@dbus.service.method(_interface)

1993

1411

def Enable(self):

1994

1412

"D-Bus method"

1995

1413

self.enable()

1996

1414

1997

1415

# StartChecker - method

1998

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

1999

1416

@dbus.service.method(_interface)

2000

1417

def StartChecker(self):

2001

1418

"D-Bus method"

2002

1419

self.start_checker()

2003

1420

2004

1421

# Disable - method

2005

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

2006

1422

@dbus.service.method(_interface)

2007

1423

def Disable(self):

2008

1424

"D-Bus method"

2009

1425

self.disable()

2010

1426

2011

1427

# StopChecker - method

2012

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

2013

1428

@dbus.service.method(_interface)

2014

1429

def StopChecker(self):

2015

1430

self.stop_checker()

2016

2017

# Properties

2018

1431

1432

## Properties

1433

2019

1434

# ApprovalPending - property

2020

1435

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

2021

1436

def ApprovalPending_dbus_property(self):

2022

1437

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

2023

1438

2024

1439

# ApprovedByDefault - property

2025

@dbus_service_property(_interface,

2026

signature="b",

1440

@dbus_service_property(_interface, signature="b",

2027

1441

access="readwrite")

2028

1442

def ApprovedByDefault_dbus_property(self, value=None):

2029

1443

if value is None: # get

2030

1444

return dbus.Boolean(self.approved_by_default)

2031

1445

self.approved_by_default = bool(value)

2032

1446

2033

1447

# ApprovalDelay - property

2034

@dbus_service_property(_interface,

2035

signature="t",

1448

@dbus_service_property(_interface, signature="t",

2036

1449

access="readwrite")

2037

1450

def ApprovalDelay_dbus_property(self, value=None):

2038

1451

if value is None: # get

2039

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

2040

* 1000)

1452

return dbus.UInt64(self.approval_delay_milliseconds())

2041

1453

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

2042

1454

2043

1455

# ApprovalDuration - property

2044

@dbus_service_property(_interface,

2045

signature="t",

1456

@dbus_service_property(_interface, signature="t",

2046

1457

access="readwrite")

2047

1458

def ApprovalDuration_dbus_property(self, value=None):

2048

1459

if value is None: # get

2049

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

2050

* 1000)

1460

return dbus.UInt64(timedelta_to_milliseconds(

1461

self.approval_duration))

2051

1462

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

2052

1463

2053

1464

# Name - property

2054

@dbus_annotations(

2055

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

2056

1465

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

2057

1466

def Name_dbus_property(self):

2058

1467

return dbus.String(self.name)

2059

2060

# KeyID - property

2061

@dbus_annotations(

2062

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

2063

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

2064

def KeyID_dbus_property(self):

2065

return dbus.String(self.key_id)

2066

1468

2067

1469

# Fingerprint - property

2068

@dbus_annotations(

2069

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

2070

1470

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

2071

1471

def Fingerprint_dbus_property(self):

2072

1472

return dbus.String(self.fingerprint)

2073

1473

2074

1474

# Host - property

2075

@dbus_service_property(_interface,

2076

signature="s",

1475

@dbus_service_property(_interface, signature="s",

2077

1476

access="readwrite")

2078

1477

def Host_dbus_property(self, value=None):

2079

1478

if value is None: # get

2080

1479

return dbus.String(self.host)

2081

self.host = str(value)

2082

1480

self.host = unicode(value)

1481

2083

1482

# Created - property

2084

@dbus_annotations(

2085

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

2086

1483

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

2087

1484

def Created_dbus_property(self):

2088

1485

return datetime_to_dbus(self.created)

2089

1486

2090

1487

# LastEnabled - property

2091

1488

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

2092

1489

def LastEnabled_dbus_property(self):

2093

1490

return datetime_to_dbus(self.last_enabled)

2094

1491

2095

1492

# Enabled - property

2096

@dbus_service_property(_interface,

2097

signature="b",

1493

@dbus_service_property(_interface, signature="b",

2098

1494

access="readwrite")

2099

1495

def Enabled_dbus_property(self, value=None):

2100

1496

if value is None: # get

2103

1499

self.enable()

2104

1500

else:

2105

1501

self.disable()

2106

1502

2107

1503

# LastCheckedOK - property

2108

@dbus_service_property(_interface,

2109

signature="s",

1504

@dbus_service_property(_interface, signature="s",

2110

1505

access="readwrite")

2111

1506

def LastCheckedOK_dbus_property(self, value=None):

2112

1507

if value is not None:

2113

1508

self.checked_ok()

2114

1509

return

2115

1510

return datetime_to_dbus(self.last_checked_ok)

2116

1511

2117

1512

# LastCheckerStatus - property

2118

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

1513

@dbus_service_property(_interface, signature="n",

1514

access="read")

2119

1515

def LastCheckerStatus_dbus_property(self):

2120

1516

return dbus.Int16(self.last_checker_status)

2121

1517

2122

1518

# Expires - property

2123

1519

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

2124

1520

def Expires_dbus_property(self):

2125

1521

return datetime_to_dbus(self.expires)

2126

1522

2127

1523

# LastApprovalRequest - property

2128

1524

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

2129

1525

def LastApprovalRequest_dbus_property(self):

2130

1526

return datetime_to_dbus(self.last_approval_request)

2131

1527

2132

1528

# Timeout - property

2133

@dbus_service_property(_interface,

2134

signature="t",

1529

@dbus_service_property(_interface, signature="t",

2135

1530

access="readwrite")

2136

1531

def Timeout_dbus_property(self, value=None):

2137

1532

if value is None: # get

2138

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

1533

return dbus.UInt64(self.timeout_milliseconds())

2139

1534

old_timeout = self.timeout

2140

1535

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

2141

1536

# Reschedule disabling

2149

1544

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

2150

1545

is None):

2151

1546

return

2152

GLib.source_remove(self.disable_initiator_tag)

2153

self.disable_initiator_tag = GLib.timeout_add(

2154

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

2155

self.disable)

2156

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

2157

1553

# ExtendedTimeout - property

2158

@dbus_service_property(_interface,

2159

signature="t",

1554

@dbus_service_property(_interface, signature="t",

2160

1555

access="readwrite")

2161

1556

def ExtendedTimeout_dbus_property(self, value=None):

2162

1557

if value is None: # get

2163

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

2164

* 1000)

1558

return dbus.UInt64(self.extended_timeout_milliseconds())

2165

1559

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

2166

1560

2167

1561

# Interval - property

2168

@dbus_service_property(_interface,

2169

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2170

1563

access="readwrite")

2171

1564

def Interval_dbus_property(self, value=None):

2172

1565

if value is None: # get

2173

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

1566

return dbus.UInt64(self.interval_milliseconds())

2174

1567

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

2175

1568

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

2176

1569

return

2177

1570

if self.enabled:

2178

1571

# Reschedule checker run

2179

GLib.source_remove(self.checker_initiator_tag)

2180

self.checker_initiator_tag = GLib.timeout_add(

2181

value, self.start_checker)

2182

self.start_checker() # Start one now, too

2183

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

2184

1577

# Checker - property

2185

@dbus_service_property(_interface,

2186

signature="s",

1578

@dbus_service_property(_interface, signature="s",

2187

1579

access="readwrite")

2188

1580

def Checker_dbus_property(self, value=None):

2189

1581

if value is None: # get

2190

1582

return dbus.String(self.checker_command)

2191

self.checker_command = str(value)

2192

1583

self.checker_command = unicode(value)

1584

2193

1585

# CheckerRunning - property

2194

@dbus_service_property(_interface,

2195

signature="b",

1586

@dbus_service_property(_interface, signature="b",

2196

1587

access="readwrite")

2197

1588

def CheckerRunning_dbus_property(self, value=None):

2198

1589

if value is None: # get

2201

1592

self.start_checker()

2202

1593

else:

2203

1594

self.stop_checker()

2204

1595

2205

1596

# ObjectPath - property

2206

@dbus_annotations(

2207

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

2208

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

2209

1597

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

2210

1598

def ObjectPath_dbus_property(self):

2211

return self.dbus_object_path # is already a dbus.ObjectPath

2212

1599

return self.dbus_object_path # is already a dbus.ObjectPath

1600

2213

1601

# Secret = property

2214

@dbus_annotations(

2215

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

2216

"invalidates"})

2217

@dbus_service_property(_interface,

2218

signature="ay",

2219

access="write",

2220

byte_arrays=True)

1602

@dbus_service_property(_interface, signature="ay",

1603

access="write", byte_arrays=True)

2221

1604

def Secret_dbus_property(self, value):

2222

self.secret = bytes(value)

2223

1605

self.secret = str(value)

1606

2224

1607

del _interface

2225

1608

2226

1609

2227

class ProxyClient:

2228

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

1610

class ProxyClient(object):

1611

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

2229

1612

self._pipe = child_pipe

2230

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

1613

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

2231

1614

if not self._pipe.recv():

2232

raise KeyError(key_id or fpr)

2233

1615

raise KeyError()

1616

2234

1617

def __getattribute__(self, name):

2235

1618

if name == '_pipe':

2236

1619

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

2239

1622

if data[0] == 'data':

2240

1623

return data[1]

2241

1624

if data[0] == 'function':

2242

2243

1625

def func(*args, **kwargs):

2244

1626

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

2245

1627

return self._pipe.recv()[1]

2246

2247

1628

return func

2248

1629

2249

1630

def __setattr__(self, name, value):

2250

1631

if name == '_pipe':

2251

1632

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

2254

1635

2255

1636

class ClientHandler(socketserver.BaseRequestHandler, object):

2256

1637

"""A class to handle client connections.

2257

1638

2258

1639

Instantiated once for each connection to handle it.

2259

1640

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

2260

1641

2261

1642

def handle(self):

2262

1643

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

2263

1644

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

2264

str(self.client_address))

1645

unicode(self.client_address))

2265

1646

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

2266

1647

self.server.child_pipe.fileno())

2267

2268

session = gnutls.ClientSession(self.request)

2269

2270

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

2271

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

2272

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

2273

# "+DHE-DSS"))

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

2274

1663

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

2275

1664

priority = self.server.gnutls_priority

2276

1665

if priority is None:

2277

1666

priority = "NORMAL"

2278

gnutls.priority_set_direct(session._c_object,

2279

priority.encode("utf-8"),

2280

None)

2281

1667

(gnutls.library.functions

1668

.gnutls_priority_set_direct(session._c_object,

1669

priority, None))

1670

2282

1671

# Start communication using the Mandos protocol

2283

1672

# Get protocol number

2284

1673

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

2285

1674

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

2286

1675

try:

2287

1676

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

2288

raise RuntimeError(line)

1677

raise RuntimeError

2289

1678

except (ValueError, IndexError, RuntimeError) as error:

2290

1679

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

2291

1680

return

2292

1681

2293

1682

# Start GnuTLS connection

2294

1683

try:

2295

1684

session.handshake()

2296

except gnutls.Error as error:

1685

except gnutls.errors.GNUTLSError as error:

2297

1686

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

2298

1687

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

2299

1688

# established. Just abandon the request.

2300

1689

return

2301

1690

logger.debug("Handshake succeeded")

2302

1691

2303

1692

approval_required = False

2304

1693

try:

2305

if gnutls.has_rawpk:

2306

fpr = b""

2307

try:

2308

key_id = self.key_id(

2309

self.peer_certificate(session))

2310

except (TypeError, gnutls.Error) as error:

2311

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

2312

return

2313

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

2314

2315

else:

2316

key_id = b""

2317

try:

2318

fpr = self.fingerprint(

2319

self.peer_certificate(session))

2320

except (TypeError, gnutls.Error) as error:

2321

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

2322

return

2323

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

2324

2325

try:

2326

client = ProxyClient(child_pipe, key_id, fpr,

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,

2327

1705

self.client_address)

2328

1706

except KeyError:

2329

1707

return

2330

1708

2331

1709

if client.approval_delay:

2332

1710

delay = client.approval_delay

2333

1711

client.approvals_pending += 1

2334

1712

approval_required = True

2335

1713

2336

1714

while True:

2337

1715

if not client.enabled:

2338

1716

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

2339

client.name)

1717

client.name)

2340

1718

if self.server.use_dbus:

2341

1719

# Emit D-Bus signal

2342

1720

client.Rejected("Disabled")

2343

1721

return

2344

1722

2345

1723

if client.approved or not client.approval_delay:

2346

# We are approved or approval is disabled

1724

#We are approved or approval is disabled

2347

1725

break

2348

1726

elif client.approved is None:

2349

1727

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

2351

1729

if self.server.use_dbus:

2352

1730

# Emit D-Bus signal

2353

1731

client.NeedApproval(

2354

client.approval_delay.total_seconds()

2355

* 1000, client.approved_by_default)

1732

client.approval_delay_milliseconds(),

1733

client.approved_by_default)

2356

1734

else:

2357

1735

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

2358

1736

client.name)

2360

1738

# Emit D-Bus signal

2361

1739

client.Rejected("Denied")

2362

1740

return

2363

2364

# wait until timeout or approved

1741

1742

#wait until timeout or approved

2365

1743

time = datetime.datetime.now()

2366

1744

client.changedstate.acquire()

2367

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

1745

client.changedstate.wait(

1746

float(timedelta_to_milliseconds(delay)

1747

/ 1000))

2368

1748

client.changedstate.release()

2369

1749

time2 = datetime.datetime.now()

2370

1750

if (time2 - time) >= delay:

2380

1760

break

2381

1761

else:

2382

1762

delay -= time2 - time

2383

2384

try:

2385

session.send(client.secret)

2386

except gnutls.Error as error:

2387

logger.warning("gnutls send failed",

2388

exc_info=error)

2389

return

2390

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

2391

1777

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

2392

1778

# bump the timeout using extended_timeout

2393

1779

client.bump_timeout(client.extended_timeout)

2394

1780

if self.server.use_dbus:

2395

1781

# Emit D-Bus signal

2396

1782

client.GotSecret()

2397

1783

2398

1784

finally:

2399

1785

if approval_required:

2400

1786

client.approvals_pending -= 1

2401

1787

try:

2402

1788

session.bye()

2403

except gnutls.Error as error:

1789

except gnutls.errors.GNUTLSError as error:

2404

1790

logger.warning("GnuTLS bye failed",

2405

1791

exc_info=error)

2406

1792

2407

1793

@staticmethod

2408

1794

def peer_certificate(session):

2409

"Return the peer's certificate as a bytestring"

2410

try:

2411

cert_type = gnutls.certificate_type_get2(session._c_object,

2412

gnutls.CTYPE_PEERS)

2413

except AttributeError:

2414

cert_type = gnutls.certificate_type_get(session._c_object)

2415

if gnutls.has_rawpk:

2416

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2417

else:

2418

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2419

# If not a valid certificate type...

2420

if cert_type not in valid_cert_types:

2421

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

2422

valid_cert_types)

2423

# ...return invalid data

2424

return b""

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

2425

1802

list_size = ctypes.c_uint(1)

2426

cert_list = (gnutls.certificate_get_peers

1803

cert_list = (gnutls.library.functions

1804

.gnutls_certificate_get_peers

2427

1805

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

2428

1806

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

2429

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

1807

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

1808

" certificate")

2430

1809

if list_size.value == 0:

2431

1810

return None

2432

1811

cert = cert_list[0]

2433

1812

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

2434

2435

@staticmethod

2436

def key_id(certificate):

2437

"Convert a certificate bytestring to a hexdigit key ID"

2438

# New GnuTLS "datum" with the public key

2439

datum = gnutls.datum_t(

2440

ctypes.cast(ctypes.c_char_p(certificate),

2441

ctypes.POINTER(ctypes.c_ubyte)),

2442

ctypes.c_uint(len(certificate)))

2443

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

2444

# New empty GnuTLS certificate

2445

pubkey = gnutls.pubkey_t()

2446

gnutls.pubkey_init(ctypes.byref(pubkey))

2447

# Import the raw public key into the certificate

2448

gnutls.pubkey_import(pubkey,

2449

ctypes.byref(datum),

2450

gnutls.X509_FMT_DER)

2451

# New buffer for the key ID

2452

buf = ctypes.create_string_buffer(32)

2453

buf_len = ctypes.c_size_t(len(buf))

2454

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

2455

gnutls.pubkey_get_key_id(pubkey,

2456

gnutls.KEYID_USE_SHA256,

2457

ctypes.cast(ctypes.byref(buf),

2458

ctypes.POINTER(ctypes.c_ubyte)),

2459

ctypes.byref(buf_len))

2460

# Deinit the certificate

2461

gnutls.pubkey_deinit(pubkey)

2462

2463

# Convert the buffer to a Python bytestring

2464

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

2465

# Convert the bytestring to hexadecimal notation

2466

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

2467

return hex_key_id

2468

1813

2469

1814

@staticmethod

2470

1815

def fingerprint(openpgp):

2471

1816

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2472

1817

# New GnuTLS "datum" with the OpenPGP public key

2473

datum = gnutls.datum_t(

2474

ctypes.cast(ctypes.c_char_p(openpgp),

2475

ctypes.POINTER(ctypes.c_ubyte)),

2476

ctypes.c_uint(len(openpgp)))

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

2477

1823

# New empty GnuTLS certificate

2478

crt = gnutls.openpgp_crt_t()

2479

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

2480

1827

# Import the OpenPGP public key into the certificate

2481

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

2482

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

2483

1832

# Verify the self signature in the key

2484

1833

crtverify = ctypes.c_uint()

2485

gnutls.openpgp_crt_verify_self(crt, 0,

2486

ctypes.byref(crtverify))

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_verify_self(crt, 0,

1836

ctypes.byref(crtverify)))

2487

1837

if crtverify.value != 0:

2488

gnutls.openpgp_crt_deinit(crt)

2489

raise gnutls.CertificateSecurityError(code

2490

=crtverify.value)

1838

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1839

raise (gnutls.errors.CertificateSecurityError

1840

("Verify failed"))

2491

1841

# New buffer for the fingerprint

2492

1842

buf = ctypes.create_string_buffer(20)

2493

1843

buf_len = ctypes.c_size_t()

2494

1844

# Get the fingerprint from the certificate into the buffer

2495

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

2496

ctypes.byref(buf_len))

1845

(gnutls.library.functions

1846

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

1847

ctypes.byref(buf_len)))

2497

1848

# Deinit the certificate

2498

gnutls.openpgp_crt_deinit(crt)

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2499

1850

# Convert the buffer to a Python bytestring

2500

1851

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

2501

1852

# Convert the bytestring to hexadecimal notation

2503

1854

return hex_fpr

2504

1855

2505

1856

2506

class MultiprocessingMixIn:

1857

class MultiprocessingMixIn(object):

2507

1858

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

2508

2509

1859

def sub_process_main(self, request, address):

2510

1860

try:

2511

1861

self.finish_request(request, address)

2512

1862

except Exception:

2513

1863

self.handle_error(request, address)

2514

1864

self.close_request(request)

2515

1865

2516

1866

def process_request(self, request, address):

2517

1867

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

2518

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

2519

args=(request, address))

1868

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

1869

args = (request, address))

2520

1870

proc.start()

2521

1871

return proc

2522

1872

2523

1873

2524

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1874

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2525

1875

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

2526

2527

1876

def process_request(self, request, client_address):

2528

1877

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

2529

1878

2530

1879

This function creates a new pipe in self.pipe

2531

1880

"""

2532

1881

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2533

1882

2534

1883

proc = MultiprocessingMixIn.process_request(self, request,

2535

1884

client_address)

2536

1885

self.child_pipe.close()

2537

1886

self.add_pipe(parent_pipe, proc)

2538

1887

2539

1888

def add_pipe(self, parent_pipe, proc):

2540

1889

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

2541

raise NotImplementedError()

1890

raise NotImplementedError

2542

1891

2543

1892

2544

1893

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2545

socketserver.TCPServer):

1894

socketserver.TCPServer, object):

2546

1895

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

2547

1896

2548

1897

Attributes:

2549

1898

enabled: Boolean; whether this server is activated yet

2550

1899

interface: None or a network interface name (string)

2551

1900

use_ipv6: Boolean; to use IPv6 or not

2552

1901

"""

2553

2554

1902

def __init__(self, server_address, RequestHandlerClass,

2555

interface=None,

2556

use_ipv6=True,

2557

socketfd=None):

1903

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

2558

1904

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

2559

1905

creating a new one with socket.socket().

2560

1906

"""

2566

1912

self.socketfd = socketfd

2567

1913

# Save the original socket.socket() function

2568

1914

self.socket_socket = socket.socket

2569

2570

1915

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

2571

#

1916

#

2572

1917

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

2573

1918

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

2574

1919

# patching socket.socket.)

2575

#

1920

#

2576

1921

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

2577

1922

@functools.wraps(socket.socket)

2578

1923

def socket_wrapper(*args, **kwargs):

2590

1935

# socket_wrapper(), if socketfd was set.

2591

1936

socketserver.TCPServer.__init__(self, server_address,

2592

1937

RequestHandlerClass)

2593

1938

2594

1939

def server_bind(self):

2595

1940

"""This overrides the normal server_bind() function

2596

1941

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

2597

1942

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

2598

global SO_BINDTODEVICE

2599

1943

if self.interface is not None:

2600

1944

if SO_BINDTODEVICE is None:

2601

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

2602

# common enough.

2603

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

2604

SO_BINDTODEVICE = 25

2605

try:

2606

self.socket.setsockopt(

2607

socket.SOL_SOCKET, SO_BINDTODEVICE,

2608

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

2609

except socket.error as error:

2610

if error.errno == errno.EPERM:

2611

logger.error("No permission to bind to"

2612

" interface %s", self.interface)

2613

elif error.errno == errno.ENOPROTOOPT:

2614

logger.error("SO_BINDTODEVICE not available;"

2615

" cannot bind to interface %s",

2616

self.interface)

2617

elif error.errno == errno.ENODEV:

2618

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

2619

" cannot bind", self.interface)

2620

else:

2621

raise

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

2622

1966

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

2623

1967

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

2624

if self.server_address[1]:

2625

self.allow_reuse_address = True

2626

1968

if not self.server_address[0]:

2627

1969

if self.address_family == socket.AF_INET6:

2628

any_address = "::" # in6addr_any

1970

any_address = "::" # in6addr_any

2629

1971

else:

2630

any_address = "0.0.0.0" # INADDR_ANY

1972

any_address = socket.INADDR_ANY

2631

1973

self.server_address = (any_address,

2632

1974

self.server_address[1])

2633

1975

elif not self.server_address[1]:

2634

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

1976

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

1977

0)

2635

1978

# if self.interface:

2636

1979

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

2637

1980

# 0, # port

2643

1986

2644

1987

class MandosServer(IPv6_TCPServer):

2645

1988

"""Mandos server.

2646

1989

2647

1990

Attributes:

2648

1991

clients: set of Client objects

2649

1992

gnutls_priority GnuTLS priority string

2650

1993

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

2651

2652

Assumes a GLib.MainLoop event loop.

1994

1995

Assumes a gobject.MainLoop event loop.

2653

1996

"""

2654

2655

1997

def __init__(self, server_address, RequestHandlerClass,

2656

interface=None,

2657

use_ipv6=True,

2658

clients=None,

2659

gnutls_priority=None,

2660

use_dbus=True,

2661

socketfd=None):

1998

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

1999

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

2662

2000

self.enabled = False

2663

2001

self.clients = clients

2664

2002

if self.clients is None:

2667

2005

self.gnutls_priority = gnutls_priority

2668

2006

IPv6_TCPServer.__init__(self, server_address,

2669

2007

RequestHandlerClass,

2670

interface=interface,

2671

use_ipv6=use_ipv6,

2672

socketfd=socketfd)

2673

2008

interface = interface,

2009

use_ipv6 = use_ipv6,

2010

socketfd = socketfd)

2674

2011

def server_activate(self):

2675

2012

if self.enabled:

2676

2013

return socketserver.TCPServer.server_activate(self)

2677

2014

2678

2015

def enable(self):

2679

2016

self.enabled = True

2680

2017

2681

2018

def add_pipe(self, parent_pipe, proc):

2682

2019

# Call "handle_ipc" for both data and EOF events

2683

GLib.io_add_watch(

2684

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

2685

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

2686

functools.partial(self.handle_ipc,

2687

parent_pipe=parent_pipe,

2688

proc=proc))

2689

2690

def handle_ipc(self, source, condition,

2691

parent_pipe=None,

2692

proc=None,

2693

client_object=None):

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

2694

2029

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

2695

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

2030

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

2696

2031

# Wait for other process to exit

2697

2032

proc.join()

2698

2033

return False

2699

2034

2700

2035

# Read a request from the child

2701

2036

request = parent_pipe.recv()

2702

2037

command = request[0]

2703

2038

2704

2039

if command == 'init':

2705

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

2706

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

2707

address = request[3]

2708

2709

for c in self.clients.values():

2710

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2711

continue

2712

if key_id and c.key_id == key_id:

2713

client = c

2714

break

2715

if fpr and c.fingerprint == fpr:

2040

fpr = request[1]

2041

address = request[2]

2042

2043

for c in self.clients.itervalues():

2044

if c.fingerprint == fpr:

2716

2045

client = c

2717

2046

break

2718

2047

else:

2719

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

2720

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

2048

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

2049

"dress: %s", fpr, address)

2721

2050

if self.use_dbus:

2722

2051

# Emit D-Bus signal

2723

mandos_dbus_service.ClientNotFound(key_id or fpr,

2052

mandos_dbus_service.ClientNotFound(fpr,

2724

2053

address[0])

2725

2054

parent_pipe.send(False)

2726

2055

return False

2727

2728

GLib.io_add_watch(

2729

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

2730

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

2731

functools.partial(self.handle_ipc,

2732

parent_pipe=parent_pipe,

2733

proc=proc,

2734

client_object=client))

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

2735

2065

parent_pipe.send(True)

2736

2066

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

2737

2067

# same fileno

2740

2070

funcname = request[1]

2741

2071

args = request[2]

2742

2072

kwargs = request[3]

2743

2073

2744

2074

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

2745

2075

funcname)(*args,

2746

**kwargs)))

2747

2076

**kwargs)))

2077

2748

2078

if command == 'getattr':

2749

2079

attrname = request[1]

2750

if isinstance(client_object.__getattribute__(attrname),

2751

collections.Callable):

2752

parent_pipe.send(('function', ))

2080

if callable(client_object.__getattribute__(attrname)):

2081

parent_pipe.send(('function',))

2753

2082

else:

2754

parent_pipe.send((

2755

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

2756

2083

parent_pipe.send(('data', client_object

2084

.__getattribute__(attrname)))

2085

2757

2086

if command == 'setattr':

2758

2087

attrname = request[1]

2759

2088

value = request[2]

2760

2089

setattr(client_object, attrname, value)

2761

2090

2762

2091

return True

2763

2092

2764

2093

2765

2094

def rfc3339_duration_to_delta(duration):

2766

2095

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

2767

2768

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

2769

True

2770

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

2771

True

2772

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

2773

True

2774

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

2775

True

2776

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

2777

True

2778

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

2779

True

2780

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

2781

True

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)

2782

2111

"""

2783

2112

2784

2113

# Parsing an RFC 3339 duration with regular expressions is not

2785

2114

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

2786

2115

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

2787

2116

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

2788

2117

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

2789

2118

# avoid excessive use of external libraries.

2790

2119

2791

2120

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

2792

Token = collections.namedtuple("Token", (

2793

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

2794

# a "group" containing digits

2795

"value", # datetime.timedelta or None

2796

"followers")) # Tokens valid after this token

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

2797

2130

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

2798

2131

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

2799

2132

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

2800

2133

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

2801

2134

datetime.timedelta(seconds=1),

2802

frozenset((token_end, )))

2135

frozenset((token_end,)))

2803

2136

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

2804

2137

datetime.timedelta(minutes=1),

2805

2138

frozenset((token_second, token_end)))

2821

2154

frozenset((token_month, token_end)))

2822

2155

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

2823

2156

datetime.timedelta(weeks=1),

2824

frozenset((token_end, )))

2157

frozenset((token_end,)))

2825

2158

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

2826

2159

frozenset((token_year, token_month,

2827

2160

token_day, token_time,

2828

token_week)))

2829

# Define starting values:

2830

# Value so far

2831

value = datetime.timedelta()

2161

token_week))),

2162

# Define starting values

2163

value = datetime.timedelta() # Value so far

2832

2164

found_token = None

2833

# Following valid tokens

2834

followers = frozenset((token_duration, ))

2835

# String left to parse

2836

s = duration

2165

followers = frozenset(token_duration,) # Following valid tokens

2166

s = duration # String left to parse

2837

2167

# Loop until end token is found

2838

2168

while found_token is not token_end:

2839

2169

# Search for any currently valid tokens

2855

2185

break

2856

2186

else:

2857

2187

# No currently valid tokens were found

2858

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

2859

.format(duration))

2188

raise ValueError("Invalid RFC 3339 duration")

2860

2189

# End token found

2861

2190

return value

2862

2191

2863

2192

2864

2193

def string_to_delta(interval):

2865

2194

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

2866

2867

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

2868

True

2869

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

2870

True

2871

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

2872

True

2873

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

2874

True

2875

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

2876

True

2877

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

2878

True

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)

2879

2208

"""

2880

2209

2881

2210

try:

2882

2211

return rfc3339_duration_to_delta(interval)

2883

2212

except ValueError:

2884

2213

pass

2885

2214

2886

2215

timevalue = datetime.timedelta(0)

2887

2216

for s in interval.split():

2888

2217

try:

2889

suffix = s[-1]

2218

suffix = unicode(s[-1])

2890

2219

value = int(s[:-1])

2891

2220

if suffix == "d":

2892

2221

delta = datetime.timedelta(value)

2899

2228

elif suffix == "w":

2900

2229

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

2901

2230

else:

2902

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

2903

except IndexError as e:

2231

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

2232

.format(suffix))

2233

except (ValueError, IndexError) as e:

2904

2234

raise ValueError(*(e.args))

2905

2235

timevalue += delta

2906

2236

return timevalue

2907

2237

2908

2238

2909

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

2239

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

2910

2240

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

2911

2241

2912

2242

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

2913

2243

if os.fork():

2914

2244

sys.exit()

2922

2252

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

2923

2253

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

2924

2254

raise OSError(errno.ENODEV,

2925

"{} not a character device"

2255

"{0} not a character device"

2926

2256

.format(os.devnull))

2927

2257

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

2928

2258

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

2932

2262

2933

2263

2934

2264

def main():

2935

2265

2936

2266

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

2937

2267

# Parsing of options, both command line and config file

2938

2268

2939

2269

parser = argparse.ArgumentParser()

2940

2270

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

2941

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

2271

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

2942

2272

help="show version number and exit")

2943

2273

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

2944

2274

help="Bind to interface IF")

2950

2280

help="Run self-test")

2951

2281

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

2952

2282

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

2953

" to terminal", default=None)

2283

" to terminal")

2954

2284

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

2955

2285

help="Debug level for stdout output")

2956

2286

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

2963

2293

" files")

2964

2294

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

2965

2295

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

2966

" system bus interface", default=None)

2296

" system bus interface")

2967

2297

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

2968

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

2969

default=None)

2298

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

2970

2299

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

2971

2300

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

2972

" state", default=None)

2301

" state")

2973

2302

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

2974

2303

help="Specify a file descriptor to a network"

2975

2304

" socket to use instead of creating one")

2976

2305

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

2977

2306

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

2978

2307

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

2979

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

2980

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

2981

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

2982

default=None)

2983

2308

help="Run in foreground")

2309

2984

2310

options = parser.parse_args()

2985

2311

2312

if options.check:

2313

import doctest

2314

doctest.testmod()

2315

sys.exit()

2316

2986

2317

# Default values for config file for server-global settings

2987

if gnutls.has_rawpk:

2988

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

2989

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

2990

else:

2991

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

2992

":+SIGN-DSA-SHA256")

2993

server_defaults = {"interface": "",

2994

"address": "",

2995

"port": "",

2996

"debug": "False",

2997

"priority": priority,

2998

"servicename": "Mandos",

2999

"use_dbus": "True",

3000

"use_ipv6": "True",

3001

"debuglevel": "",

3002

"restore": "True",

3003

"socket": "",

3004

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

3005

"foreground": "False",

3006

"zeroconf": "True",

3007

}

3008

del priority

3009

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

3010

2334

# Parse config file for server-global settings

3011

server_config = configparser.ConfigParser(server_defaults)

2335

server_config = configparser.SafeConfigParser(server_defaults)

3012

2336

del server_defaults

3013

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

3014

# 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

3015

2340

server_settings = server_config.defaults()

3016

2341

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

3017

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

3018

"foreground", "zeroconf"):

2342

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

3019

2343

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

3020

2344

option)

3021

2345

if server_settings["port"]:

3031

2355

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

3032

2356

["socket"])

3033

2357

del server_config

3034

2358

3035

2359

# Override the settings from the config file with command line

3036

2360

# options, if set.

3037

2361

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

3038

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

3039

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

3040

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

2362

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

2363

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

2364

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

3041

2365

value = getattr(options, option)

3042

2366

if value is not None:

3043

2367

server_settings[option] = value

3044

2368

del options

3045

2369

# Force all strings to be unicode

3046

2370

for option in server_settings.keys():

3047

if isinstance(server_settings[option], bytes):

3048

server_settings[option] = (server_settings[option]

3049

.decode("utf-8"))

3050

# Force all boolean options to be boolean

3051

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

3052

"foreground", "zeroconf"):

3053

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

2371

if type(server_settings[option]) is str:

2372

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

3054

2373

# Debug implies foreground

3055

2374

if server_settings["debug"]:

3056

2375

server_settings["foreground"] = True

3057

2376

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

3058

2377

3059

2378

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

3060

3061

if (not server_settings["zeroconf"]

3062

and not (server_settings["port"]

3063

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

3064

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

3065

2379

3066

2380

# For convenience

3067

2381

debug = server_settings["debug"]

3068

2382

debuglevel = server_settings["debuglevel"]

3071

2385

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

3072

2386

stored_state_file)

3073

2387

foreground = server_settings["foreground"]

3074

zeroconf = server_settings["zeroconf"]

3075

2388

3076

2389

if debug:

3077

2390

initlogger(debug, logging.DEBUG)

3078

2391

else:

3081

2394

else:

3082

2395

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

3083

2396

initlogger(debug, level)

3084

2397

3085

2398

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

3086

syslogger.setFormatter(

3087

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

3088

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

3089

server_settings["servicename"])))

3090

2399

syslogger.setFormatter(logging.Formatter

2400

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

2401

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

2402

.format(server_settings

2403

["servicename"])))

2404

3091

2405

# Parse config file with clients

3092

client_config = configparser.ConfigParser(Client.client_defaults)

2406

client_config = configparser.SafeConfigParser(Client

2407

.client_defaults)

3093

2408

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

3094

2409

"clients.conf"))

3095

2410

3096

2411

global mandos_dbus_service

3097

2412

mandos_dbus_service = None

3098

3099

socketfd = None

3100

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

3101

socketfd = server_settings["socket"]

3102

tcp_server = MandosServer(

3103

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

3104

ClientHandler,

3105

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

3106

use_ipv6=use_ipv6,

3107

gnutls_priority=server_settings["priority"],

3108

use_dbus=use_dbus,

3109

socketfd=socketfd)

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

3110

2425

if not foreground:

3111

pidfilename = "/run/mandos.pid"

3112

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

3113

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

2426

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

3114

2427

pidfile = None

3115

2428

try:

3116

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

2429

pidfile = open(pidfilename, "w")

3117

2430

except IOError as e:

3118

2431

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

3119

2432

exc_info=e)

3120

3121

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

3122

("mandos", "mandos"),

3123

("nobody", "nogroup")):

2433

2434

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

3124

2435

try:

3125

2436

uid = pwd.getpwnam(name).pw_uid

3126

gid = pwd.getpwnam(group).pw_gid

2437

gid = pwd.getpwnam(name).pw_gid

3127

2438

break

3128

2439

except KeyError:

3129

2440

continue

3133

2444

try:

3134

2445

os.setgid(gid)

3135

2446

os.setuid(uid)

3136

if debug:

3137

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

3138

gid))

3139

2447

except OSError as error:

3140

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

3141

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

3142

2448

if error.errno != errno.EPERM:

3143

raise

3144

2449

raise error

2450

3145

2451

if debug:

3146

2452

# Enable all possible GnuTLS debugging

3147

2453

3148

2454

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

3149

2455

# - GnuTLS manual

3150

gnutls.global_set_log_level(11)

3151

3152

@gnutls.log_func

2456

gnutls.library.functions.gnutls_global_set_log_level(11)

2457

2458

@gnutls.library.types.gnutls_log_func

3153

2459

def debug_gnutls(level, string):

3154

2460

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

3155

3156

gnutls.global_set_log_function(debug_gnutls)

3157

2461

2462

(gnutls.library.functions

2463

.gnutls_global_set_log_function(debug_gnutls))

2464

3158

2465

# Redirect stdin so all checkers get /dev/null

3159

2466

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

3160

2467

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

3161

2468

if null > 2:

3162

2469

os.close(null)

3163

2470

3164

2471

# Need to fork before connecting to D-Bus

3165

2472

if not foreground:

3166

2473

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

3167

2474

daemon()

3168

3169

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

3170

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

3171

# need to inform GLib that threads will be used.

3172

GLib.threads_init()

3173

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

3174

2480

global main_loop

3175

2481

# From the Avahi example code

3176

2482

DBusGMainLoop(set_as_default=True)

3177

main_loop = GLib.MainLoop()

2483

main_loop = gobject.MainLoop()

3178

2484

bus = dbus.SystemBus()

3179

2485

# End of Avahi example code

3180

2486

if use_dbus:

3181

2487

try:

3182

2488

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

3183

bus,

3184

do_not_queue=True)

3185

old_bus_name = dbus.service.BusName(

3186

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

3187

do_not_queue=True)

3188

except dbus.exceptions.DBusException as e:

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:

3189

2494

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

3190

2495

use_dbus = False

3191

2496

server_settings["use_dbus"] = False

3192

2497

tcp_server.use_dbus = False

3193

if zeroconf:

3194

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3195

service = AvahiServiceToSyslog(

3196

name=server_settings["servicename"],

3197

servicetype="_mandos._tcp",

3198

protocol=protocol,

3199

bus=bus)

3200

if server_settings["interface"]:

3201

service.interface = if_nametoindex(

3202

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

3203

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

3204

2507

global multiprocessing_manager

3205

2508

multiprocessing_manager = multiprocessing.Manager()

3206

2509

3207

2510

client_class = Client

3208

2511

if use_dbus:

3209

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

3210

2512

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

2513

3211

2514

client_settings = Client.config_parser(client_config)

3212

2515

old_client_settings = {}

3213

2516

clients_data = {}

3214

3215

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

3216

global wnull

3217

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

3218

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

3219

# mode

3220

if debug or not foreground:

3221

wnull.close()

3222

2517

3223

2518

# Get client data and settings from last running state.

3224

2519

if server_settings["restore"]:

3225

2520

try:

3226

2521

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

3227

if sys.version_info.major == 2:

3228

clients_data, old_client_settings = pickle.load(

3229

stored_state)

3230

else:

3231

bytes_clients_data, bytes_old_client_settings = (

3232

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

3233

# Fix bytes to strings

3234

# clients_data

3235

# .keys()

3236

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

3237

if isinstance(key, bytes)

3238

else key): value

3239

for key, value in

3240

bytes_clients_data.items()}

3241

del bytes_clients_data

3242

for key in clients_data:

3243

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

3244

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

3245

for k, v in

3246

clients_data[key].items()}

3247

clients_data[key] = value

3248

# .client_structure

3249

value["client_structure"] = [

3250

(s.decode("utf-8")

3251

if isinstance(s, bytes)

3252

else s) for s in

3253

value["client_structure"]]

3254

# .name, .host, and .checker_command

3255

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

3256

if isinstance(value[k], bytes):

3257

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

3258

if "key_id" not in value:

3259

value["key_id"] = ""

3260

elif "fingerprint" not in value:

3261

value["fingerprint"] = ""

3262

# old_client_settings

3263

# .keys()

3264

old_client_settings = {

3265

(key.decode("utf-8")

3266

if isinstance(key, bytes)

3267

else key): value

3268

for key, value in

3269

bytes_old_client_settings.items()}

3270

del bytes_old_client_settings

3271

# .host and .checker_command

3272

for value in old_client_settings.values():

3273

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

3274

if isinstance(value[attribute], bytes):

3275

value[attribute] = (value[attribute]

3276

.decode("utf-8"))

2522

clients_data, old_client_settings = (pickle.load

2523

(stored_state))

3277

2524

os.remove(stored_state_path)

3278

2525

except IOError as e:

3279

2526

if e.errno == errno.ENOENT:

3280

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

3281

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

2527

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

2528

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

3282

2529

else:

3283

2530

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

3284

2531

exc_info=e)

3285

2532

raise

3286

2533

except EOFError as e:

3287

2534

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

3288

"EOFError:",

3289

exc_info=e)

3290

2535

"EOFError:", exc_info=e)

2536

3291

2537

with PGPEngine() as pgp:

3292

for client_name, client in clients_data.items():

3293

# Skip removed clients

3294

if client_name not in client_settings:

3295

continue

3296

2538

for client_name, client in clients_data.iteritems():

3297

2539

# Decide which value to use after restoring saved state.

3298

2540

# We have three different values: Old config file,

3299

2541

# new config file, and saved state.

3304

2546

# For each value in new config, check if it

3305

2547

# differs from the old config value (Except for

3306

2548

# the "secret" attribute)

3307

if (name != "secret"

3308

and (value !=

3309

old_client_settings[client_name][name])):

2549

if (name != "secret" and

2550

value != old_client_settings[client_name]

2551

[name]):

3310

2552

client[name] = value

3311

2553

except KeyError:

3312

2554

pass

3313

2555

3314

2556

# Clients who has passed its expire date can still be

3315

# enabled if its last checker was successful. A Client

2557

# enabled if its last checker was successful. Clients

3316

2558

# whose checker succeeded before we stored its state is

3317

2559

# assumed to have successfully run all checkers during

3318

2560

# downtime.

3320

2562

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

3321

2563

if not client["last_checked_ok"]:

3322

2564

logger.warning(

3323

"disabling client {} - Client never "

3324

"performed a successful checker".format(

3325

client_name))

2565

"disabling client {0} - Client never "

2566

"performed a successful checker"

2567

.format(client_name))

3326

2568

client["enabled"] = False

3327

2569

elif client["last_checker_status"] != 0:

3328

2570

logger.warning(

3329

"disabling client {} - Client last"

3330

" checker failed with error code"

3331

" {}".format(

3332

client_name,

3333

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"]))

3334

2575

client["enabled"] = False

3335

2576

else:

3336

client["expires"] = (

3337

datetime.datetime.utcnow()

3338

+ client["timeout"])

2577

client["expires"] = (datetime.datetime

2578

.utcnow()

2579

+ client["timeout"])

3339

2580

logger.debug("Last checker succeeded,"

3340

" keeping {} enabled".format(

3341

client_name))

2581

" keeping {0} enabled"

2582

.format(client_name))

3342

2583

try:

3343

client["secret"] = pgp.decrypt(

3344

client["encrypted_secret"],

3345

client_settings[client_name]["secret"])

2584

client["secret"] = (

2585

pgp.decrypt(client["encrypted_secret"],

2586

client_settings[client_name]

2587

["secret"]))

3346

2588

except PGPError:

3347

2589

# If decryption fails, we use secret from new settings

3348

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

3349

client_name))

3350

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

3351

["secret"])

3352

2590

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

2591

.format(client_name))

2592

client["secret"] = (

2593

client_settings[client_name]["secret"])

2594

3353

2595

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

3354

2596

for client_name in (set(old_client_settings)

3355

2597

- set(client_settings)):

3357

2599

for client_name in (set(client_settings)

3358

2600

- set(old_client_settings)):

3359

2601

clients_data[client_name] = client_settings[client_name]

3360

2602

3361

2603

# Create all client objects

3362

for client_name, client in clients_data.items():

2604

for client_name, client in clients_data.iteritems():

3363

2605

tcp_server.clients[client_name] = client_class(

3364

name=client_name,

3365

settings=client,

3366

server_settings=server_settings)

3367

2606

name = client_name, settings = client)

2607

3368

2608

if not tcp_server.clients:

3369

2609

logger.warning("No clients defined")

3370

2610

3371

2611

if not foreground:

3372

2612

if pidfile is not None:

3373

pid = os.getpid()

3374

2613

try:

3375

2614

with pidfile:

3376

print(pid, file=pidfile)

2615

pid = os.getpid()

2616

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

3377

2617

except IOError:

3378

2618

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

3379

2619

pidfilename, pid)

3380

2620

del pidfile

3381

2621

del pidfilename

3382

3383

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

3384

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3385

lambda: main_loop.quit() and False)

3386

2622

2623

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

2624

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

2625

3387

2626

if use_dbus:

3388

3389

@alternate_dbus_interfaces(

3390

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

3391

class MandosDBusService(DBusObjectWithObjectManager):

2627

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

2628

"se.bsnet.fukt.Mandos"})

2629

class MandosDBusService(DBusObjectWithProperties):

3392

2630

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

3393

3394

2631

def __init__(self):

3395

2632

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

3396

3397

2633

_interface = "se.recompile.Mandos"

3398

2634

2635

@dbus_interface_annotations(_interface)

2636

def _foo(self):

2637

return { "org.freedesktop.DBus.Property"

2638

".EmitsChangedSignal":

2639

"false"}

2640

3399

2641

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

3400

2642

def ClientAdded(self, objpath):

3401

2643

"D-Bus signal"

3402

2644

pass

3403

2645

3404

2646

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

3405

def ClientNotFound(self, key_id, address):

2647

def ClientNotFound(self, fingerprint, address):

3406

2648

"D-Bus signal"

3407

2649

pass

3408

3409

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

3410

"true"})

2650

3411

2651

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

3412

2652

def ClientRemoved(self, objpath, name):

3413

2653

"D-Bus signal"

3414

2654

pass

3415

3416

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

3417

"true"})

2655

3418

2656

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

3419

2657

def GetAllClients(self):

3420

2658

"D-Bus method"

3421

return dbus.Array(c.dbus_object_path for c in

3422

tcp_server.clients.values())

3423

3424

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

3425

"true"})

2659

return dbus.Array(c.dbus_object_path

2660

for c in

2661

tcp_server.clients.itervalues())

2662

3426

2663

@dbus.service.method(_interface,

3427

2664

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

3428

2665

def GetAllClientsWithProperties(self):

3429

2666

"D-Bus method"

3430

2667

return dbus.Dictionary(

3431

{c.dbus_object_path: c.GetAll(

3432

"se.recompile.Mandos.Client")

3433

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

2668

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

2669

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

3434

2670

signature="oa{sv}")

3435

2671

3436

2672

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

3437

2673

def RemoveClient(self, object_path):

3438

2674

"D-Bus method"

3439

for c in tcp_server.clients.values():

2675

for c in tcp_server.clients.itervalues():

3440

2676

if c.dbus_object_path == object_path:

3441

2677

del tcp_server.clients[c.name]

3442

2678

c.remove_from_connection()

3443

# Don't signal the disabling

2679

# Don't signal anything except ClientRemoved

3444

2680

c.disable(quiet=True)

3445

# Emit D-Bus signal for removal

3446

self.client_removed_signal(c)

2681

# Emit D-Bus signal

2682

self.ClientRemoved(object_path, c.name)

3447

2683

return

3448

2684

raise KeyError(object_path)

3449

2685

3450

2686

del _interface

3451

3452

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3453

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

3454

def GetManagedObjects(self):

3455

"""D-Bus method"""

3456

return dbus.Dictionary(

3457

{client.dbus_object_path:

3458

dbus.Dictionary(

3459

{interface: client.GetAll(interface)

3460

for interface in

3461

client._get_all_interface_names()})

3462

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

3463

3464

def client_added_signal(self, client):

3465

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

3466

if use_dbus:

3467

# New standard signal

3468

self.InterfacesAdded(

3469

client.dbus_object_path,

3470

dbus.Dictionary(

3471

{interface: client.GetAll(interface)

3472

for interface in

3473

client._get_all_interface_names()}))

3474

# Old signal

3475

self.ClientAdded(client.dbus_object_path)

3476

3477

def client_removed_signal(self, client):

3478

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

3479

if use_dbus:

3480

# New standard signal

3481

self.InterfacesRemoved(

3482

client.dbus_object_path,

3483

client._get_all_interface_names())

3484

# Old signal

3485

self.ClientRemoved(client.dbus_object_path,

3486

client.name)

3487

2687

3488

2688

mandos_dbus_service = MandosDBusService()

3489

3490

# Save modules to variables to exempt the modules from being

3491

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

3492

mp = multiprocessing

3493

wn = wnull

3494

2689

3495

2690

def cleanup():

3496

2691

"Cleanup function; run on exit"

3497

if zeroconf:

3498

service.cleanup()

3499

3500

mp.active_children()

3501

wn.close()

2692

service.cleanup()

2693

2694

multiprocessing.active_children()

3502

2695

if not (tcp_server.clients or client_settings):

3503

2696

return

3504

2697

3505

2698

# Store client before exiting. Secrets are encrypted with key

3506

2699

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

3507

2700

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

3508

2701

clients = {}

3509

2702

with PGPEngine() as pgp:

3510

for client in tcp_server.clients.values():

2703

for client in tcp_server.clients.itervalues():

3511

2704

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

3512

2705

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

3513

2706

key)

3514

2707

client_dict = {}

3515

2708

3516

2709

# A list of attributes that can not be pickled

3517

2710

# + secret.

3518

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

3519

"checker", "server_settings"}

3520

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

3521

.Object):

2711

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

2712

"checker"))

2713

for name, typ in (inspect.getmembers

2714

(dbus.service.Object)):

3522

2715

exclude.add(name)

3523

2716

3524

2717

client_dict["encrypted_secret"] = (client

3525

2718

.encrypted_secret)

3526

2719

for attr in client.client_structure:

3527

2720

if attr not in exclude:

3528

2721

client_dict[attr] = getattr(client, attr)

3529

2722

3530

2723

clients[client.name] = client_dict

3531

2724

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

3532

2725

3533

2726

try:

3534

with tempfile.NamedTemporaryFile(

3535

mode='wb',

3536

suffix=".pickle",

3537

prefix='clients-',

3538

dir=os.path.dirname(stored_state_path),

3539

delete=False) as stored_state:

3540

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

3541

protocol=2)

3542

tempname = stored_state.name

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

3543

2733

os.rename(tempname, stored_state_path)

3544

2734

except (IOError, OSError) as e:

3545

2735

if not debug:

3548

2738

except NameError:

3549

2739

pass

3550

2740

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

3551

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

2741

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

3552

2742

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

3553

2743

else:

3554

2744

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

3555

2745

exc_info=e)

3556

raise

3557

2746

raise e

2747

3558

2748

# Delete all clients, and settings from config

3559

2749

while tcp_server.clients:

3560

2750

name, client = tcp_server.clients.popitem()

3561

2751

if use_dbus:

3562

2752

client.remove_from_connection()

3563

# Don't signal the disabling

2753

# Don't signal anything except ClientRemoved

3564

2754

client.disable(quiet=True)

3565

# Emit D-Bus signal for removal

3566

2755

if use_dbus:

3567

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)

3568

2760

client_settings.clear()

3569

2761

3570

2762

atexit.register(cleanup)

3571

3572

for client in tcp_server.clients.values():

2763

2764

for client in tcp_server.clients.itervalues():

3573

2765

if use_dbus:

3574

# Emit D-Bus signal for adding

3575

mandos_dbus_service.client_added_signal(client)

2766

# Emit D-Bus signal

2767

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3576

2768

# Need to initiate checking of clients

3577

2769

if client.enabled:

3578

2770

client.init_checker()

3579

2771

3580

2772

tcp_server.enable()

3581

2773

tcp_server.server_activate()

3582

2774

3583

2775

# Find out what port we got

3584

if zeroconf:

3585

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

2776

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

3586

2777

if use_ipv6:

3587

2778

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

3588

2779

" flowinfo %d, scope_id %d",

3590

2781

else: # IPv4

3591

2782

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

3592

2783

*tcp_server.socket.getsockname())

3593

3594

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

3595

2784

2785

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

2786

3596

2787

try:

3597

if zeroconf:

3598

# From the Avahi example code

3599

try:

3600

service.activate()

3601

except dbus.exceptions.DBusException as error:

3602

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

3603

cleanup()

3604

sys.exit(1)

3605

# End of Avahi example code

3606

3607

GLib.io_add_watch(

3608

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

3609

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3610

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

3611

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

3612

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

3613

2802

logger.debug("Starting main loop")

3614

2803

main_loop.run()

3615

2804

except AvahiError as error:

3624

2813

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

3625

2814

cleanup()

3626

2815

3627

3628

def should_only_run_tests():

3629

parser = argparse.ArgumentParser(add_help=False)

3630

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

3631

args, unknown_args = parser.parse_known_args()

3632

run_tests = args.check

3633

if run_tests:

3634

# Remove --check argument from sys.argv

3635

sys.argv[1:] = unknown_args

3636

return run_tests

3637

3638

# Add all tests from doctest strings

3639

def load_tests(loader, tests, none):

3640

import doctest

3641

tests.addTests(doctest.DocTestSuite())

3642

return tests

3643

3644

2816

if __name__ == '__main__':

3645

try:

3646

if should_only_run_tests():

3647

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

3648

unittest.main()

3649

else:

3650

main()

3651

finally:

3652

logging.shutdown()

2817

main()