/mandos/trunk : revision 1221

1

#!/usr/bin/python

2

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

3

#

1

#!/usr/bin/python3 -bI

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

80

import unittest

81

import random

82

import shlex

72

83

73

84

import dbus

74

85

import dbus.service

75

import gobject

76

import avahi

86

import gi

87

from gi.repository import GLib

77

88

from dbus.mainloop.glib import DBusGMainLoop

78

89

import ctypes

79

90

import ctypes.util

80

91

import xml.dom.minidom

81

92

import inspect

82

import GnuPGInterface

83

84

try:

93

94

if sys.version_info.major == 2:

95

__metaclass__ = type

96

str = unicode

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

85

122

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

86

123

except AttributeError:

87

124

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

88

127

from IN import SO_BINDTODEVICE

89

128

except ImportError:

90

SO_BINDTODEVICE = None

91

92

version = "1.6.0"

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.12"

93

147

stored_state_file = "clients.pickle"

94

148

95

149

logger = logging.getLogger()

96

syslogger = (logging.handlers.SysLogHandler

97

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

98

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

150

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

151

syslogger = None

99

152

100

153

try:

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

104

156

except (OSError, AttributeError):

157

105

158

def if_nametoindex(interface):

106

159

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

107

160

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

108

161

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

109

162

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

110

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

111

interface))

112

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

113

ifreq[16:20])[0]

163

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

164

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

114

165

return interface_index

115

166

116

167

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

117

184

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

118

185

"""init logger and add loglevel"""

119

186

187

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

120

191

syslogger.setFormatter(logging.Formatter

121

192

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

122

193

' %(message)s'))

123

194

logger.addHandler(syslogger)

124

195

125

196

if debug:

126

197

console = logging.StreamHandler()

127

198

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

137

208

pass

138

209

139

210

140

class PGPEngine(object):

211

class PGPEngine:

141

212

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

213

142

214

def __init__(self):

143

self.gnupg = GnuPGInterface.GnuPG()

144

215

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

145

self.gnupg = GnuPGInterface.GnuPG()

146

self.gnupg.options.meta_interactive = False

147

self.gnupg.options.homedir = self.tempdir

148

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

149

'--quiet',

150

'--no-use-agent'])

151

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

self.gnupgargs = ['--batch',

228

'--homedir', self.tempdir,

229

'--force-mdc',

230

'--quiet']

231

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

232

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

233

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

234

152

235

def __enter__(self):

153

236

return self

154

237

155

238

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

156

239

self._cleanup()

157

240

return False

158

241

159

242

def __del__(self):

160

243

self._cleanup()

161

244

162

245

def _cleanup(self):

163

246

if self.tempdir is not None:

164

247

# Delete contents of tempdir

165

248

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

166

topdown = False):

249

topdown=False):

167

250

for filename in files:

168

251

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

169

252

for dirname in dirs:

171

254

# Remove tempdir

172

255

os.rmdir(self.tempdir)

173

256

self.tempdir = None

174

257

175

258

def password_encode(self, password):

176

259

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

177

260

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

178

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

179

261

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

262

if len(encoded) > 2048:

263

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

264

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

265

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

266

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

267

return encoded

268

180

269

def encrypt(self, data, password):

181

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

182

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

183

try:

184

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

185

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

186

attach_fhs={'stderr': devnull})

187

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

188

f.write(data)

189

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

190

ciphertext = f.read()

191

proc.wait()

192

except IOError as e:

193

raise PGPError(e)

194

self.gnupg.passphrase = None

270

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

273

passfile.write(passphrase)

274

passfile.flush()

275

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

276

'--passphrase-file',

277

passfile.name]

278

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

283

if proc.returncode != 0:

284

raise PGPError(err)

195

285

return ciphertext

196

286

197

287

def decrypt(self, data, password):

198

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

199

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

200

try:

201

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

202

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

203

attach_fhs={'stderr': devnull})

204

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

205

f.write(data)

206

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

207

decrypted_plaintext = f.read()

208

proc.wait()

209

except IOError as e:

210

raise PGPError(e)

211

self.gnupg.passphrase = None

288

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

291

passfile.write(passphrase)

292

passfile.flush()

293

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

294

'--passphrase-file',

295

passfile.name]

296

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

301

if proc.returncode != 0:

302

raise PGPError(err)

212

303

return decrypted_plaintext

213

304

214

305

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

215

332

class AvahiError(Exception):

216

333

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

217

334

self.value = value

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

335

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

336

**kwargs)

337

221

338

222

339

class AvahiServiceError(AvahiError):

223

340

pass

224

341

342

225

343

class AvahiGroupError(AvahiError):

226

344

pass

227

345

228

346

229

class AvahiService(object):

347

class AvahiService:

230

348

"""An Avahi (Zeroconf) service.

231

349

232

350

Attributes:

233

351

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

234

352

Used to optionally bind to the specified interface.

235

353

name: string; Example: 'Mandos'

236

354

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

237

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

355

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

238

356

port: integer; what port to announce

239

357

TXT: list of strings; TXT record for the service

240

358

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

246

364

server: D-Bus Server

247

365

bus: dbus.SystemBus()

248

366

"""

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

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

254

379

self.interface = interface

255

380

self.name = name

256

381

self.type = servicetype

265

390

self.server = None

266

391

self.bus = bus

267

392

self.entry_group_state_changed_match = None

268

269

def rename(self):

393

394

def rename(self, remove=True):

270

395

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

271

396

if self.rename_count >= self.max_renames:

272

397

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

273

398

" after %i retries, exiting.",

274

399

self.rename_count)

275

400

raise AvahiServiceError("Too many renames")

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

278

404

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

279

405

self.name)

280

self.remove()

406

if remove:

407

self.remove()

281

408

try:

282

409

self.add()

283

410

except dbus.exceptions.DBusException as error:

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

288

411

if (error.get_dbus_name()

412

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

413

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

414

return self.rename(remove=False)

415

else:

416

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

417

self.cleanup()

418

os._exit(1)

419

289

420

def remove(self):

290

421

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

291

422

if self.entry_group_state_changed_match is not None:

293

424

self.entry_group_state_changed_match = None

294

425

if self.group is not None:

295

426

self.group.Reset()

296

427

297

428

def add(self):

298

429

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

299

430

self.remove()

316

447

dbus.UInt16(self.port),

317

448

avahi.string_array_to_txt_array(self.TXT))

318

449

self.group.Commit()

319

450

320

451

def entry_group_state_changed(self, state, error):

321

452

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

322

453

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

323

454

324

455

if state == avahi.ENTRY_GROUP_ESTABLISHED:

325

456

logger.debug("Zeroconf service established.")

326

457

elif state == avahi.ENTRY_GROUP_COLLISION:

328

459

self.rename()

329

460

elif state == avahi.ENTRY_GROUP_FAILURE:

330

461

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

331

unicode(error))

332

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

333

.format(error))

334

462

str(error))

463

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

464

335

465

def cleanup(self):

336

466

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

337

467

if self.group is not None:

342

472

pass

343

473

self.group = None

344

474

self.remove()

345

475

346

476

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

347

477

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

348

478

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

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

356

485

if state in bad_states:

357

486

if bad_states[state] is not None:

358

487

if error is None:

361

490

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

362

491

self.cleanup()

363

492

elif state == avahi.SERVER_RUNNING:

364

self.add()

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

logger.info("Local Zeroconf service name"

499

" collision.")

500

return self.rename(remove=False)

501

else:

502

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

503

self.cleanup()

504

os._exit(1)

365

505

else:

366

506

if error is None:

367

507

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

368

508

else:

369

509

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

370

510

371

511

def activate(self):

372

512

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

373

513

if self.server is None:

377

517

follow_name_owner_changes=True),

378

518

avahi.DBUS_INTERFACE_SERVER)

379

519

self.server.connect_to_signal("StateChanged",

380

self.server_state_changed)

520

self.server_state_changed)

381

521

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

382

522

383

523

384

524

class AvahiServiceToSyslog(AvahiService):

385

def rename(self):

525

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

386

526

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

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

527

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

528

**kwargs)

529

syslogger.setFormatter(logging.Formatter(

530

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

531

.format(self.name)))

392

532

return ret

393

533

394

534

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

535

# Pretend that we have a GnuTLS module

536

class gnutls:

537

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

538

539

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

540

if library is None:

541

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

542

_library = ctypes.cdll.LoadLibrary(library)

543

del library

544

545

# Unless otherwise indicated, the constants and types below are

546

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

547

548

# Constants

549

E_SUCCESS = 0

550

E_INTERRUPTED = -52

551

E_AGAIN = -28

552

CRT_OPENPGP = 2

553

CRT_RAWPK = 3

554

CLIENT = 2

555

SHUT_RDWR = 0

556

CRD_CERTIFICATE = 1

557

E_NO_CERTIFICATE_FOUND = -49

558

X509_FMT_DER = 0

559

NO_TICKETS = 1<<10

560

ENABLE_RAWPK = 1<<18

561

CTYPE_PEERS = 3

562

KEYID_USE_SHA256 = 1 # gnutls/x509.h

563

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

564

565

# Types

566

class session_int(ctypes.Structure):

567

_fields_ = []

568

session_t = ctypes.POINTER(session_int)

569

570

class certificate_credentials_st(ctypes.Structure):

571

_fields_ = []

572

certificate_credentials_t = ctypes.POINTER(

573

certificate_credentials_st)

574

certificate_type_t = ctypes.c_int

575

576

class datum_t(ctypes.Structure):

577

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

578

('size', ctypes.c_uint)]

579

580

class openpgp_crt_int(ctypes.Structure):

581

_fields_ = []

582

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

583

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

584

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

585

credentials_type_t = ctypes.c_int

586

transport_ptr_t = ctypes.c_void_p

587

close_request_t = ctypes.c_int

588

589

# Exceptions

590

class Error(Exception):

591

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

592

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

593

# code is passed, convert it to a string with

594

# gnutls.strerror()

595

self.code = code

596

if message is None and code is not None:

597

message = gnutls.strerror(code)

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

# Classes

605

class Credentials:

606

def __init__(self):

607

self._c_object = gnutls.certificate_credentials_t()

608

gnutls.certificate_allocate_credentials(

609

ctypes.byref(self._c_object))

610

self.type = gnutls.CRD_CERTIFICATE

611

612

def __del__(self):

613

gnutls.certificate_free_credentials(self._c_object)

614

615

class ClientSession:

616

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

617

self._c_object = gnutls.session_t()

618

gnutls_flags = gnutls.CLIENT

619

if gnutls.check_version(b"3.5.6"):

620

gnutls_flags |= gnutls.NO_TICKETS

621

if gnutls.has_rawpk:

622

gnutls_flags |= gnutls.ENABLE_RAWPK

623

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

624

del gnutls_flags

625

gnutls.set_default_priority(self._c_object)

626

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

627

gnutls.handshake_set_private_extensions(self._c_object,

628

True)

629

self.socket = socket

630

if credentials is None:

631

credentials = gnutls.Credentials()

632

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

633

ctypes.cast(credentials._c_object,

634

ctypes.c_void_p))

635

self.credentials = credentials

636

637

def __del__(self):

638

gnutls.deinit(self._c_object)

639

640

def handshake(self):

641

return gnutls.handshake(self._c_object)

642

643

def send(self, data):

644

data = bytes(data)

645

data_len = len(data)

646

while data_len > 0:

647

data_len -= gnutls.record_send(self._c_object,

648

data[-data_len:],

649

data_len)

650

651

def bye(self):

652

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

653

654

# Error handling functions

655

def _error_code(result):

656

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

657

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

658

if result >= 0:

659

return result

660

if result == gnutls.E_NO_CERTIFICATE_FOUND:

661

raise gnutls.CertificateSecurityError(code=result)

662

raise gnutls.Error(code=result)

663

664

def _retry_on_error(result, func, arguments):

665

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

666

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

667

while result < 0:

668

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

669

return _error_code(result)

670

result = func(*arguments)

671

return result

672

673

# Unless otherwise indicated, the function declarations below are

674

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

675

676

# Functions

677

priority_set_direct = _library.gnutls_priority_set_direct

678

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

679

ctypes.POINTER(ctypes.c_char_p)]

680

priority_set_direct.restype = _error_code

681

682

init = _library.gnutls_init

683

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

684

init.restype = _error_code

685

686

set_default_priority = _library.gnutls_set_default_priority

687

set_default_priority.argtypes = [session_t]

688

set_default_priority.restype = _error_code

689

690

record_send = _library.gnutls_record_send

691

record_send.argtypes = [session_t, ctypes.c_void_p,

692

ctypes.c_size_t]

693

record_send.restype = ctypes.c_ssize_t

694

record_send.errcheck = _retry_on_error

695

696

certificate_allocate_credentials = (

697

_library.gnutls_certificate_allocate_credentials)

698

certificate_allocate_credentials.argtypes = [

699

ctypes.POINTER(certificate_credentials_t)]

700

certificate_allocate_credentials.restype = _error_code

701

702

certificate_free_credentials = (

703

_library.gnutls_certificate_free_credentials)

704

certificate_free_credentials.argtypes = [

705

certificate_credentials_t]

706

certificate_free_credentials.restype = None

707

708

handshake_set_private_extensions = (

709

_library.gnutls_handshake_set_private_extensions)

710

handshake_set_private_extensions.argtypes = [session_t,

711

ctypes.c_int]

712

handshake_set_private_extensions.restype = None

713

714

credentials_set = _library.gnutls_credentials_set

715

credentials_set.argtypes = [session_t, credentials_type_t,

716

ctypes.c_void_p]

717

credentials_set.restype = _error_code

718

719

strerror = _library.gnutls_strerror

720

strerror.argtypes = [ctypes.c_int]

721

strerror.restype = ctypes.c_char_p

722

723

certificate_type_get = _library.gnutls_certificate_type_get

724

certificate_type_get.argtypes = [session_t]

725

certificate_type_get.restype = _error_code

726

727

certificate_get_peers = _library.gnutls_certificate_get_peers

728

certificate_get_peers.argtypes = [session_t,

729

ctypes.POINTER(ctypes.c_uint)]

730

certificate_get_peers.restype = ctypes.POINTER(datum_t)

731

732

global_set_log_level = _library.gnutls_global_set_log_level

733

global_set_log_level.argtypes = [ctypes.c_int]

734

global_set_log_level.restype = None

735

736

global_set_log_function = _library.gnutls_global_set_log_function

737

global_set_log_function.argtypes = [log_func]

738

global_set_log_function.restype = None

739

740

deinit = _library.gnutls_deinit

741

deinit.argtypes = [session_t]

742

deinit.restype = None

743

744

handshake = _library.gnutls_handshake

745

handshake.argtypes = [session_t]

746

handshake.restype = _error_code

747

handshake.errcheck = _retry_on_error

748

749

transport_set_ptr = _library.gnutls_transport_set_ptr

750

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

751

transport_set_ptr.restype = None

752

753

bye = _library.gnutls_bye

754

bye.argtypes = [session_t, close_request_t]

755

bye.restype = _error_code

756

bye.errcheck = _retry_on_error

757

758

check_version = _library.gnutls_check_version

759

check_version.argtypes = [ctypes.c_char_p]

760

check_version.restype = ctypes.c_char_p

761

762

_need_version = b"3.3.0"

763

if check_version(_need_version) is None:

764

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

765

.format(_need_version))

766

767

_tls_rawpk_version = b"3.6.6"

768

has_rawpk = bool(check_version(_tls_rawpk_version))

769

770

if has_rawpk:

771

# Types

772

class pubkey_st(ctypes.Structure):

773

_fields = []

774

pubkey_t = ctypes.POINTER(pubkey_st)

775

776

x509_crt_fmt_t = ctypes.c_int

777

778

# All the function declarations below are from

779

# gnutls/abstract.h

780

pubkey_init = _library.gnutls_pubkey_init

781

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

782

pubkey_init.restype = _error_code

783

784

pubkey_import = _library.gnutls_pubkey_import

785

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

786

x509_crt_fmt_t]

787

pubkey_import.restype = _error_code

788

789

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

790

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

791

ctypes.POINTER(ctypes.c_ubyte),

792

ctypes.POINTER(ctypes.c_size_t)]

793

pubkey_get_key_id.restype = _error_code

794

795

pubkey_deinit = _library.gnutls_pubkey_deinit

796

pubkey_deinit.argtypes = [pubkey_t]

797

pubkey_deinit.restype = None

798

else:

799

# All the function declarations below are from

800

# gnutls/openpgp.h

801

802

openpgp_crt_init = _library.gnutls_openpgp_crt_init

803

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

804

openpgp_crt_init.restype = _error_code

805

806

openpgp_crt_import = _library.gnutls_openpgp_crt_import

807

openpgp_crt_import.argtypes = [openpgp_crt_t,

808

ctypes.POINTER(datum_t),

809

openpgp_crt_fmt_t]

810

openpgp_crt_import.restype = _error_code

811

812

openpgp_crt_verify_self = \

813

_library.gnutls_openpgp_crt_verify_self

814

openpgp_crt_verify_self.argtypes = [

815

openpgp_crt_t,

816

ctypes.c_uint,

817

ctypes.POINTER(ctypes.c_uint),

818

]

819

openpgp_crt_verify_self.restype = _error_code

820

821

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

822

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

823

openpgp_crt_deinit.restype = None

824

825

openpgp_crt_get_fingerprint = (

826

_library.gnutls_openpgp_crt_get_fingerprint)

827

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

828

ctypes.c_void_p,

829

ctypes.POINTER(

830

ctypes.c_size_t)]

831

openpgp_crt_get_fingerprint.restype = _error_code

832

833

if check_version(b"3.6.4"):

834

certificate_type_get2 = _library.gnutls_certificate_type_get2

835

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

836

certificate_type_get2.restype = _error_code

837

838

# Remove non-public functions

839

del _error_code, _retry_on_error

840

841

842

def call_pipe(connection, # : multiprocessing.Connection

843

func, *args, **kwargs):

844

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

845

846

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

847

return value on the provided multiprocessing.Connection.

848

"""

849

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

850

connection.close()

851

852

853

class Client:

403

854

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

404

855

405

856

Attributes:

406

857

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

407

858

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

408

859

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

409

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

410

to see if the client lives.

411

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

860

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

861

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

862

running.

863

checker_callback_tag: a GLib event source tag, or None

413

864

checker_command: string; External command which is run to check

414

865

if client lives. %() expansions are done at

415

866

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

416

867

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

417

checker_initiator_tag: a gobject event source tag, or None

868

checker_initiator_tag: a GLib event source tag, or None

418

869

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

419

870

client_structure: Object describing what attributes a client has

420

871

and is used for storing the client at exit

421

872

current_checker_command: string; current running checker_command

422

disable_initiator_tag: a gobject event source tag, or None

873

disable_initiator_tag: a GLib event source tag, or None

423

874

enabled: bool()

424

875

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

425

uniquely identify the client

876

uniquely identify an OpenPGP client

877

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

878

a client using raw public keys

426

879

host: string; available for use by the checker command

427

880

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

428

881

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

430

883

last_checker_status: integer between 0 and 255 reflecting exit

431

884

status of last checker. -1 reflects crashed

432

885

checker, -2 means no checker completed yet.

886

last_checker_signal: The signal which killed the last checker, if

887

last_checker_status is -1

433

888

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

434

889

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

435

890

D-Bus identifiers

440

895

runtime_expansions: Allowed attributes for runtime expansion.

441

896

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

442

897

disabled, or None

898

server_settings: The server_settings dict from main()

443

899

"""

444

900

445

901

runtime_expansions = ("approval_delay", "approval_duration",

446

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

902

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

447

903

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

448

904

"last_approval_request", "last_checked_ok",

449

905

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

450

client_defaults = { "timeout": "PT5M",

451

"extended_timeout": "PT15M",

452

"interval": "PT2M",

453

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

454

"host": "",

455

"approval_delay": "PT0S",

456

"approval_duration": "PT1S",

457

"approved_by_default": "True",

458

"enabled": "True",

459

}

460

461

def timeout_milliseconds(self):

462

"Return the 'timeout' attribute in milliseconds"

463

return timedelta_to_milliseconds(self.timeout)

464

465

def extended_timeout_milliseconds(self):

466

"Return the 'extended_timeout' attribute in milliseconds"

467

return timedelta_to_milliseconds(self.extended_timeout)

468

469

def interval_milliseconds(self):

470

"Return the 'interval' attribute in milliseconds"

471

return timedelta_to_milliseconds(self.interval)

472

473

def approval_delay_milliseconds(self):

474

return timedelta_to_milliseconds(self.approval_delay)

475

906

client_defaults = {

907

"timeout": "PT5M",

908

"extended_timeout": "PT15M",

909

"interval": "PT2M",

910

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

911

"host": "",

912

"approval_delay": "PT0S",

913

"approval_duration": "PT1S",

914

"approved_by_default": "True",

915

"enabled": "True",

916

}

917

476

918

@staticmethod

477

919

def config_parser(config):

478

920

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

485

927

for client_name in config.sections():

486

928

section = dict(config.items(client_name))

487

929

client = settings[client_name] = {}

488

930

489

931

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

490

932

# Reformat values from string types to Python types

491

933

client["approved_by_default"] = config.getboolean(

492

934

client_name, "approved_by_default")

493

935

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

494

936

"enabled")

495

937

938

# Uppercase and remove spaces from key_id and fingerprint

939

# for later comparison purposes with return value from the

940

# key_id() and fingerprint() functions

941

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

942

.replace(" ", ""))

496

943

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

497

944

.replace(" ", ""))

498

945

if "secret" in section:

499

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

946

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

947

.encode("utf-8"),

948

"base64")

500

949

elif "secfile" in section:

501

950

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

502

951

(section["secfile"])),

503

952

"rb") as secfile:

504

953

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

505

954

else:

506

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

955

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

507

956

.format(section))

508

957

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

509

958

client["extended_timeout"] = string_to_delta(

517

966

client["last_approval_request"] = None

518

967

client["last_checked_ok"] = None

519

968

client["last_checker_status"] = -2

520

969

521

970

return settings

522

523

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

971

972

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

524

973

self.name = name

974

if server_settings is None:

975

server_settings = {}

976

self.server_settings = server_settings

525

977

# adding all client settings

526

for setting, value in settings.iteritems():

978

for setting, value in settings.items():

527

979

setattr(self, setting, value)

528

980

529

981

if self.enabled:

530

982

if not hasattr(self, "last_enabled"):

531

983

self.last_enabled = datetime.datetime.utcnow()

535

987

else:

536

988

self.last_enabled = None

537

989

self.expires = None

538

990

539

991

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

540

# Uppercase and remove spaces from fingerprint for later

541

# comparison purposes with return value from the fingerprint()

542

# function

992

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

543

993

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

544

994

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

545

995

datetime.datetime.utcnow())

546

996

547

997

# attributes specific for this server instance

548

998

self.checker = None

549

999

self.checker_initiator_tag = None

552

1002

self.current_checker_command = None

553

1003

self.approved = None

554

1004

self.approvals_pending = 0

555

self.changedstate = (multiprocessing_manager

556

.Condition(multiprocessing_manager

557

.Lock()))

558

self.client_structure = [attr for attr in

559

self.__dict__.iterkeys()

1005

self.changedstate = multiprocessing_manager.Condition(

1006

multiprocessing_manager.Lock())

1007

self.client_structure = [attr

1008

for attr in self.__dict__.keys()

560

1009

if not attr.startswith("_")]

561

1010

self.client_structure.append("client_structure")

562

563

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

564

lambda obj:

565

isinstance(obj,

566

property)):

1011

1012

for name, t in inspect.getmembers(

1013

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

567

1014

if not name.startswith("_"):

568

1015

self.client_structure.append(name)

569

1016

570

1017

# Send notice to process children that client state has changed

571

1018

def send_changedstate(self):

572

1019

with self.changedstate:

573

1020

self.changedstate.notify_all()

574

1021

575

1022

def enable(self):

576

1023

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

577

1024

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

582

1029

self.last_enabled = datetime.datetime.utcnow()

583

1030

self.init_checker()

584

1031

self.send_changedstate()

585

1032

586

1033

def disable(self, quiet=True):

587

1034

"""Disable this client."""

588

1035

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

590

1037

if not quiet:

591

1038

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

592

1039

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

593

gobject.source_remove(self.disable_initiator_tag)

1040

GLib.source_remove(self.disable_initiator_tag)

594

1041

self.disable_initiator_tag = None

595

1042

self.expires = None

596

1043

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

597

gobject.source_remove(self.checker_initiator_tag)

1044

GLib.source_remove(self.checker_initiator_tag)

598

1045

self.checker_initiator_tag = None

599

1046

self.stop_checker()

600

1047

self.enabled = False

601

1048

if not quiet:

602

1049

self.send_changedstate()

603

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

1050

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

604

1051

return False

605

1052

606

1053

def __del__(self):

607

1054

self.disable()

608

1055

609

1056

def init_checker(self):

610

1057

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

611

1058

# and every interval from then on.

612

1059

if self.checker_initiator_tag is not None:

613

gobject.source_remove(self.checker_initiator_tag)

614

self.checker_initiator_tag = (gobject.timeout_add

615

(self.interval_milliseconds(),

616

self.start_checker))

1060

GLib.source_remove(self.checker_initiator_tag)

1061

self.checker_initiator_tag = GLib.timeout_add(

1062

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

1063

+ 1)),

1064

self.start_checker)

617

1065

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

618

1066

if self.disable_initiator_tag is not None:

619

gobject.source_remove(self.disable_initiator_tag)

620

self.disable_initiator_tag = (gobject.timeout_add

621

(self.timeout_milliseconds(),

622

self.disable))

1067

GLib.source_remove(self.disable_initiator_tag)

1068

self.disable_initiator_tag = GLib.timeout_add(

1069

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

623

1070

# Also start a new checker *right now*.

624

1071

self.start_checker()

625

626

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

1072

1073

def checker_callback(self, source, condition, connection,

1074

command):

627

1075

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

1076

# Read return code from connection (see call_pipe)

1077

returncode = connection.recv()

1078

connection.close()

1079

if self.checker is not None:

1080

self.checker.join()

628

1081

self.checker_callback_tag = None

629

1082

self.checker = None

630

if os.WIFEXITED(condition):

631

self.last_checker_status = os.WEXITSTATUS(condition)

1083

1084

if returncode >= 0:

1085

self.last_checker_status = returncode

1086

self.last_checker_signal = None

632

1087

if self.last_checker_status == 0:

633

1088

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

634

1089

vars(self))

635

1090

self.checked_ok()

636

1091

else:

637

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

638

vars(self))

1092

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

639

1093

else:

640

1094

self.last_checker_status = -1

1095

self.last_checker_signal = -returncode

641

1096

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

642

1097

vars(self))

643

1098

return False

1099

644

1100

def checked_ok(self):

645

1101

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

646

1102

self.last_checked_ok = datetime.datetime.utcnow()

647

1103

self.last_checker_status = 0

1104

self.last_checker_signal = None

648

1105

self.bump_timeout()

649

1106

650

1107

def bump_timeout(self, timeout=None):

651

1108

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

652

1109

if timeout is None:

653

1110

timeout = self.timeout

654

1111

if self.disable_initiator_tag is not None:

655

gobject.source_remove(self.disable_initiator_tag)

1112

GLib.source_remove(self.disable_initiator_tag)

656

1113

self.disable_initiator_tag = None

657

1114

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

658

self.disable_initiator_tag = (gobject.timeout_add

659

(timedelta_to_milliseconds

660

(timeout), self.disable))

1115

self.disable_initiator_tag = GLib.timeout_add(

1116

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

661

1117

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

662

1118

663

1119

def need_approval(self):

664

1120

self.last_approval_request = datetime.datetime.utcnow()

665

1121

666

1122

def start_checker(self):

667

1123

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

668

1124

669

1125

If a checker already exists, leave it running and do

670

1126

nothing."""

671

1127

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

676

1132

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

677

1133

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

678

1134

# should be.

679

680

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

681

try:

682

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

683

except (AttributeError, OSError) as error:

684

if (isinstance(error, OSError)

685

and error.errno != errno.ECHILD):

686

raise error

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

1135

1136

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

1137

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

1138

self.checker.join()

1139

self.checker = None

693

1140

# Start a new checker if needed

694

1141

if self.checker is None:

695

1142

# Escape attributes for the shell

696

escaped_attrs = dict(

697

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

698

for attr in

699

self.runtime_expansions)

1143

escaped_attrs = {

1144

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

1145

for attr in self.runtime_expansions}

700

1146

try:

701

1147

command = self.checker_command % escaped_attrs

702

1148

except TypeError as error:

703

1149

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

704

self.checker_command, exc_info=error)

705

return True # Try again later

1150

self.checker_command,

1151

exc_info=error)

1152

return True # Try again later

706

1153

self.current_checker_command = command

707

try:

708

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

709

command, self.name)

710

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

711

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

712

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

713

# always replaced by /dev/null.)

714

self.checker = subprocess.Popen(command,

715

close_fds=True,

716

shell=True, cwd="/")

717

except OSError as error:

718

logger.error("Failed to start subprocess",

719

exc_info=error)

720

return True

721

self.checker_callback_tag = (gobject.child_watch_add

722

(self.checker.pid,

723

self.checker_callback,

724

data=command))

725

# The checker may have completed before the gobject

726

# watch was added. Check for this.

727

try:

728

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

729

except OSError as error:

730

if error.errno == errno.ECHILD:

731

# This should never happen

732

logger.error("Child process vanished",

733

exc_info=error)

734

return True

735

raise

736

if pid:

737

gobject.source_remove(self.checker_callback_tag)

738

self.checker_callback(pid, status, command)

739

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

1154

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

1155

self.name)

1156

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

1157

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

1158

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

1159

# always replaced by /dev/null.)

1160

# The exception is when not debugging but nevertheless

1161

# running in the foreground; use the previously

1162

# created wnull.

1163

popen_args = {"close_fds": True,

1164

"shell": True,

1165

"cwd": "/"}

1166

if (not self.server_settings["debug"]

1167

and self.server_settings["foreground"]):

1168

popen_args.update({"stdout": wnull,

1169

"stderr": wnull})

1170

pipe = multiprocessing.Pipe(duplex=False)

1171

self.checker = multiprocessing.Process(

1172

target=call_pipe,

1173

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

1174

kwargs=popen_args)

1175

self.checker.start()

1176

self.checker_callback_tag = GLib.io_add_watch(

1177

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

1178

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1179

self.checker_callback, pipe[0], command)

1180

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

740

1181

return True

741

1182

742

1183

def stop_checker(self):

743

1184

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

744

1185

if self.checker_callback_tag:

745

gobject.source_remove(self.checker_callback_tag)

1186

GLib.source_remove(self.checker_callback_tag)

746

1187

self.checker_callback_tag = None

747

1188

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

748

1189

return

749

1190

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

750

try:

751

self.checker.terminate()

752

#time.sleep(0.5)

753

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

754

# self.checker.kill()

755

except OSError as error:

756

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

757

raise

1191

self.checker.terminate()

758

1192

self.checker = None

759

1193

760

1194

761

def dbus_service_property(dbus_interface, signature="v",

762

access="readwrite", byte_arrays=False):

1195

def dbus_service_property(dbus_interface,

1196

signature="v",

1197

access="readwrite",

1198

byte_arrays=False):

763

1199

"""Decorators for marking methods of a DBusObjectWithProperties to

764

1200

become properties on the D-Bus.

765

1201

766

1202

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

767

1203

and with one argument by "Set".

768

1204

769

1205

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

770

1206

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

771

1207

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

774

1210

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

775

1211

if byte_arrays and signature != "ay":

776

1212

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

777

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

1213

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

1214

778

1215

def decorator(func):

779

1216

func._dbus_is_property = True

780

1217

func._dbus_interface = dbus_interface

783

1220

func._dbus_name = func.__name__

784

1221

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

785

1222

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

786

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1223

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

787

1224

return func

1225

788

1226

return decorator

789

1227

790

1228

791

1229

def dbus_interface_annotations(dbus_interface):

792

1230

"""Decorator for marking functions returning interface annotations

793

1231

794

1232

Usage:

795

1233

796

1234

@dbus_interface_annotations("org.example.Interface")

797

1235

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

798

1236

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

799

1237

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

800

1238

"false"}

801

1239

"""

1240

802

1241

def decorator(func):

803

1242

func._dbus_is_interface = True

804

1243

func._dbus_interface = dbus_interface

805

1244

func._dbus_name = dbus_interface

806

1245

return func

1246

807

1247

return decorator

808

1248

809

1249

810

1250

def dbus_annotations(annotations):

811

1251

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

812

1252

Usage:

813

1253

1254

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

1255

"org.freedesktop.DBus.Property."

1256

"EmitsChangedSignal": "false"})

814

1257

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

815

1258

access="r")

816

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

817

"org.freedesktop.DBus.Property."

818

"EmitsChangedSignal": "false"})

819

1259

def Property_dbus_property(self):

820

1260

return dbus.Boolean(False)

1261

1262

See also the DBusObjectWithAnnotations class.

821

1263

"""

1264

822

1265

def decorator(func):

823

1266

func._dbus_annotations = annotations

824

1267

return func

1268

825

1269

return decorator

826

1270

827

1271

828

1272

class DBusPropertyException(dbus.exceptions.DBusException):

829

1273

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

830

1274

"""

831

def __unicode__(self):

832

return unicode(str(self))

1275

pass

833

1276

834

1277

835

1278

class DBusPropertyAccessException(DBusPropertyException):

844

1287

pass

845

1288

846

1289

847

class DBusObjectWithProperties(dbus.service.Object):

848

"""A D-Bus object with properties.

849

850

Classes inheriting from this can use the dbus_service_property

851

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

852

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

1290

class DBusObjectWithAnnotations(dbus.service.Object):

1291

"""A D-Bus object with annotations.

1292

1293

Classes inheriting from this can use the dbus_annotations

1294

decorator to add annotations to methods or signals.

853

1295

"""

854

1296

855

1297

@staticmethod

856

1298

def _is_dbus_thing(thing):

857

1299

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

858

1300

859

1301

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

860

1302

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

861

1303

"""

862

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

1304

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

863

1305

False)

864

1306

865

1307

def _get_all_dbus_things(self, thing):

866

1308

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

867

1309

"""

868

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

869

name),

1310

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

870

1311

athing.__get__(self))

871

1312

for cls in self.__class__.__mro__

872

1313

for name, athing in

873

inspect.getmembers(cls,

874

self._is_dbus_thing(thing)))

875

1314

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

1315

1316

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1317

out_signature="s",

1318

path_keyword='object_path',

1319

connection_keyword='connection')

1320

def Introspect(self, object_path, connection):

1321

"""Overloading of standard D-Bus method.

1322

1323

Inserts annotation tags on methods and signals.

1324

"""

1325

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

1326

connection)

1327

try:

1328

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

1329

1330

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

1331

# Add annotation tags

1332

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

1333

for tag in if_tag.getElementsByTagName(typ):

1334

annots = dict()

1335

for name, prop in (self.

1336

_get_all_dbus_things(typ)):

1337

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

1338

and prop._dbus_interface

1339

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

1340

annots.update(getattr(

1341

prop, "_dbus_annotations", {}))

1342

for name, value in annots.items():

1343

ann_tag = document.createElement(

1344

"annotation")

1345

ann_tag.setAttribute("name", name)

1346

ann_tag.setAttribute("value", value)

1347

tag.appendChild(ann_tag)

1348

# Add interface annotation tags

1349

for annotation, value in dict(

1350

itertools.chain.from_iterable(

1351

annotations().items()

1352

for name, annotations

1353

in self._get_all_dbus_things("interface")

1354

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

1355

)).items():

1356

ann_tag = document.createElement("annotation")

1357

ann_tag.setAttribute("name", annotation)

1358

ann_tag.setAttribute("value", value)

1359

if_tag.appendChild(ann_tag)

1360

# Fix argument name for the Introspect method itself

1361

if (if_tag.getAttribute("name")

1362

== dbus.INTROSPECTABLE_IFACE):

1363

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

1364

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

1365

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

1366

if (arg.getAttribute("direction")

1367

== "out"):

1368

arg.setAttribute("name",

1369

"xml_data")

1370

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

1371

document.unlink()

1372

except (AttributeError, xml.dom.DOMException,

1373

xml.parsers.expat.ExpatError) as error:

1374

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

1375

exc_info=error)

1376

return xmlstring

1377

1378

1379

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1380

"""A D-Bus object with properties.

1381

1382

Classes inheriting from this can use the dbus_service_property

1383

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

1384

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

1385

"""

1386

876

1387

def _get_dbus_property(self, interface_name, property_name):

877

1388

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

878

1389

property with the specified name and interface.

879

1390

"""

880

for cls in self.__class__.__mro__:

881

for name, value in (inspect.getmembers

882

(cls,

883

self._is_dbus_thing("property"))):

1391

for cls in self.__class__.__mro__:

1392

for name, value in inspect.getmembers(

1393

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

884

1394

if (value._dbus_name == property_name

885

1395

and value._dbus_interface == interface_name):

886

1396

return value.__get__(self)

887

1397

888

1398

# No such property

889

raise DBusPropertyNotFound(self.dbus_object_path + ":"

890

+ interface_name + "."

891

+ property_name)

892

893

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

1399

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

1400

self.dbus_object_path, interface_name, property_name))

1401

1402

@classmethod

1403

def _get_all_interface_names(cls):

1404

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

1405

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

1406

"_dbus_interface", None)

1407

for x in (inspect.getmro(cls))

1408

for attr in dir(x))

1409

if name is not None)

1410

1411

@dbus.service.method(dbus.PROPERTIES_IFACE,

1412

in_signature="ss",

894

1413

out_signature="v")

895

1414

def Get(self, interface_name, property_name):

896

1415

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

902

1421

if not hasattr(value, "variant_level"):

903

1422

return value

904

1423

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

905

1424

906

1425

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

907

1426

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

908

1427

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

914

1433

# The byte_arrays option is not supported yet on

915

1434

# signatures other than "ay".

916

1435

if prop._dbus_signature != "ay":

917

raise ValueError

918

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

919

for byte in value))

1436

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

1437

"'ay' signature {!r}"

1438

.format(prop._dbus_signature))

1439

value = dbus.ByteArray(bytes(value))

920

1440

prop(value)

921

922

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

1441

1442

@dbus.service.method(dbus.PROPERTIES_IFACE,

1443

in_signature="s",

923

1444

out_signature="a{sv}")

924

1445

def GetAll(self, interface_name):

925

1446

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

926

1447

standard.

927

1448

928

1449

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

929

1450

"""

930

1451

properties = {}

940

1461

if not hasattr(value, "variant_level"):

941

1462

properties[name] = value

942

1463

continue

943

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

944

value.variant_level+1)

1464

properties[name] = type(value)(

1465

value, variant_level=value.variant_level + 1)

945

1466

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

946

1467

1468

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

1469

def PropertiesChanged(self, interface_name, changed_properties,

1470

invalidated_properties):

1471

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

1472

standard.

1473

"""

1474

pass

1475

947

1476

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

948

1477

out_signature="s",

949

1478

path_keyword='object_path',

950

1479

connection_keyword='connection')

951

1480

def Introspect(self, object_path, connection):

952

1481

"""Overloading of standard D-Bus method.

953

1482

954

1483

Inserts property tags and interface annotation tags.

955

1484

"""

956

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

957

connection)

1485

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1486

object_path,

1487

connection)

958

1488

try:

959

1489

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

1490

960

1491

def make_tag(document, name, prop):

961

1492

e = document.createElement("property")

962

1493

e.setAttribute("name", name)

963

1494

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

964

1495

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

965

1496

return e

1497

966

1498

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

967

1499

# Add property tags

968

1500

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

971

1503

if prop._dbus_interface

972

1504

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

973

1505

if_tag.appendChild(tag)

974

# Add annotation tags

975

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

976

for tag in if_tag.getElementsByTagName(typ):

977

annots = dict()

978

for name, prop in (self.

979

_get_all_dbus_things(typ)):

980

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

981

and prop._dbus_interface

982

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

983

annots.update(getattr

984

(prop,

985

"_dbus_annotations",

986

{}))

987

for name, value in annots.iteritems():

988

ann_tag = document.createElement(

989

"annotation")

990

ann_tag.setAttribute("name", name)

991

ann_tag.setAttribute("value", value)

992

tag.appendChild(ann_tag)

993

# Add interface annotation tags

994

for annotation, value in dict(

995

itertools.chain.from_iterable(

996

annotations().iteritems()

997

for name, annotations in

998

self._get_all_dbus_things("interface")

999

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

1000

)).iteritems():

1001

ann_tag = document.createElement("annotation")

1002

ann_tag.setAttribute("name", annotation)

1003

ann_tag.setAttribute("value", value)

1004

if_tag.appendChild(ann_tag)

1506

# Add annotation tags for properties

1507

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

1508

annots = dict()

1509

for name, prop in self._get_all_dbus_things(

1510

"property"):

1511

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

1512

and prop._dbus_interface

1513

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

1514

annots.update(getattr(

1515

prop, "_dbus_annotations", {}))

1516

for name, value in annots.items():

1517

ann_tag = document.createElement(

1518

"annotation")

1519

ann_tag.setAttribute("name", name)

1520

ann_tag.setAttribute("value", value)

1521

tag.appendChild(ann_tag)

1005

1522

# Add the names to the return values for the

1006

1523

# "org.freedesktop.DBus.Properties" methods

1007

1524

if (if_tag.getAttribute("name")

1026

1543

return xmlstring

1027

1544

1028

1545

1546

try:

1547

dbus.OBJECT_MANAGER_IFACE

1548

except AttributeError:

1549

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

1550

1551

1552

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1553

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

1554

1555

Classes inheriting from this exposes the standard

1556

GetManagedObjects call and the InterfacesAdded and

1557

InterfacesRemoved signals on the standard

1558

"org.freedesktop.DBus.ObjectManager" interface.

1559

1560

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

1561

manually.

1562

"""

1563

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1564

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

1565

def GetManagedObjects(self):

1566

"""This function must be overridden"""

1567

raise NotImplementedError()

1568

1569

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1570

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

1571

def InterfacesAdded(self, object_path, interfaces_and_properties):

1572

pass

1573

1574

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

1575

def InterfacesRemoved(self, object_path, interfaces):

1576

pass

1577

1578

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1579

out_signature="s",

1580

path_keyword='object_path',

1581

connection_keyword='connection')

1582

def Introspect(self, object_path, connection):

1583

"""Overloading of standard D-Bus method.

1584

1585

Override return argument name of GetManagedObjects to be

1586

"objpath_interfaces_and_properties"

1587

"""

1588

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1589

object_path,

1590

connection)

1591

try:

1592

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

1593

1594

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

1595

# Fix argument name for the GetManagedObjects method

1596

if (if_tag.getAttribute("name")

1597

== dbus.OBJECT_MANAGER_IFACE):

1598

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

1599

if (cn.getAttribute("name")

1600

== "GetManagedObjects"):

1601

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

1602

if (arg.getAttribute("direction")

1603

== "out"):

1604

arg.setAttribute(

1605

"name",

1606

"objpath_interfaces"

1607

"_and_properties")

1608

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

1609

document.unlink()

1610

except (AttributeError, xml.dom.DOMException,

1611

xml.parsers.expat.ExpatError) as error:

1612

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

1613

exc_info=error)

1614

return xmlstring

1615

1616

1029

1617

def datetime_to_dbus(dt, variant_level=0):

1030

1618

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

1031

1619

if dt is None:

1032

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

1033

return dbus.String(dt.isoformat(),

1034

variant_level=variant_level)

1620

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

1621

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

1035

1622

1036

1623

1037

1624

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1039

1626

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

1040

1627

interface names according to the "alt_interface_names" mapping.

1041

1628

Usage:

1042

1629

1043

1630

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

1044

1631

"net.example.AlternateInterface"})

1045

1632

class SampleDBusObject(dbus.service.Object):

1046

1633

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

1047

1634

def SampleDBusMethod():

1048

1635

pass

1049

1636

1050

1637

The above "SampleDBusMethod" on "SampleDBusObject" will be

1051

1638

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

1052

1639

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

1053

1640

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

1054

1641

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

1055

1642

1056

1643

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

1057

1644

(from DBusObjectWithProperties) and interfaces (from the

1058

1645

dbus_interface_annotations decorator).

1059

1646

"""

1647

1060

1648

def wrapper(cls):

1061

1649

for orig_interface_name, alt_interface_name in (

1062

alt_interface_names.iteritems()):

1650

alt_interface_names.items()):

1063

1651

attr = {}

1064

1652

interface_names = set()

1065

1653

# Go though all attributes of the class

1067

1655

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

1068

1656

# with the wrong interface name

1069

1657

if (not hasattr(attribute, "_dbus_interface")

1070

or not attribute._dbus_interface

1071

.startswith(orig_interface_name)):

1658

or not attribute._dbus_interface.startswith(

1659

orig_interface_name)):

1072

1660

continue

1073

1661

# Create an alternate D-Bus interface name based on

1074

1662

# the current name

1075

alt_interface = (attribute._dbus_interface

1076

.replace(orig_interface_name,

1077

alt_interface_name))

1663

alt_interface = attribute._dbus_interface.replace(

1664

orig_interface_name, alt_interface_name)

1078

1665

interface_names.add(alt_interface)

1079

1666

# Is this a D-Bus signal?

1080

1667

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

1081

# Extract the original non-method function by

1082

# black magic

1083

nonmethod_func = (dict(

1668

# Extract the original non-method undecorated

1669

# function by black magic

1670

if sys.version_info.major == 2:

1671

nonmethod_func = (dict(

1084

1672

zip(attribute.func_code.co_freevars,

1085

attribute.__closure__))["func"]

1086

.cell_contents)

1673

attribute.__closure__))

1674

["func"].cell_contents)

1675

else:

1676

nonmethod_func = (dict(

1677

zip(attribute.__code__.co_freevars,

1678

attribute.__closure__))

1679

["func"].cell_contents)

1087

1680

# Create a new, but exactly alike, function

1088

1681

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

1089

1682

# with the alternate D-Bus interface name

1090

new_function = (dbus.service.signal

1091

(alt_interface,

1092

attribute._dbus_signature)

1093

(types.FunctionType(

1094

nonmethod_func.func_code,

1095

nonmethod_func.func_globals,

1096

nonmethod_func.func_name,

1097

nonmethod_func.func_defaults,

1098

nonmethod_func.func_closure)))

1683

new_function = copy_function(nonmethod_func)

1684

new_function = (dbus.service.signal(

1685

alt_interface,

1686

attribute._dbus_signature)(new_function))

1099

1687

# Copy annotations, if any

1100

1688

try:

1101

new_function._dbus_annotations = (

1102

dict(attribute._dbus_annotations))

1689

new_function._dbus_annotations = dict(

1690

attribute._dbus_annotations)

1103

1691

except AttributeError:

1104

1692

pass

1693

1105

1694

# Define a creator of a function to call both the

1106

1695

# original and alternate functions, so both the

1107

1696

# original and alternate signals gets sent when

1110

1699

"""This function is a scope container to pass

1111

1700

func1 and func2 to the "call_both" function

1112

1701

outside of its arguments"""

1702

1703

@functools.wraps(func2)

1113

1704

def call_both(*args, **kwargs):

1114

1705

"""This function will emit two D-Bus

1115

1706

signals by calling func1 and func2"""

1116

1707

func1(*args, **kwargs)

1117

1708

func2(*args, **kwargs)

1709

# Make wrapper function look like a D-Bus

1710

# signal

1711

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

1712

if name.startswith("_dbus_"):

1713

setattr(call_both, name, attr)

1714

1118

1715

return call_both

1119

1716

# Create the "call_both" function and add it to

1120

1717

# the class

1125

1722

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

1126

1723

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

1127

1724

# to the class.

1128

attr[attrname] = (dbus.service.method

1129

(alt_interface,

1130

attribute._dbus_in_signature,

1131

attribute._dbus_out_signature)

1132

(types.FunctionType

1133

(attribute.func_code,

1134

attribute.func_globals,

1135

attribute.func_name,

1136

attribute.func_defaults,

1137

attribute.func_closure)))

1725

attr[attrname] = (

1726

dbus.service.method(

1727

alt_interface,

1728

attribute._dbus_in_signature,

1729

attribute._dbus_out_signature)

1730

(copy_function(attribute)))

1138

1731

# Copy annotations, if any

1139

1732

try:

1140

attr[attrname]._dbus_annotations = (

1141

dict(attribute._dbus_annotations))

1733

attr[attrname]._dbus_annotations = dict(

1734

attribute._dbus_annotations)

1142

1735

except AttributeError:

1143

1736

pass

1144

1737

# Is this a D-Bus property?

1147

1740

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

1148

1741

# property with the alternate D-Bus interface

1149

1742

# name. Add it to the class.

1150

attr[attrname] = (dbus_service_property

1151

(alt_interface,

1152

attribute._dbus_signature,

1153

attribute._dbus_access,

1154

attribute

1155

._dbus_get_args_options

1156

["byte_arrays"])

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1743

attr[attrname] = (dbus_service_property(

1744

alt_interface, attribute._dbus_signature,

1745

attribute._dbus_access,

1746

attribute._dbus_get_args_options

1747

["byte_arrays"])

1748

(copy_function(attribute)))

1163

1749

# Copy annotations, if any

1164

1750

try:

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1751

attr[attrname]._dbus_annotations = dict(

1752

attribute._dbus_annotations)

1167

1753

except AttributeError:

1168

1754

pass

1169

1755

# Is this a D-Bus interface?

1172

1758

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

1173

1759

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

1174

1760

# to the class.

1175

attr[attrname] = (dbus_interface_annotations

1176

(alt_interface)

1177

(types.FunctionType

1178

(attribute.func_code,

1179

attribute.func_globals,

1180

attribute.func_name,

1181

attribute.func_defaults,

1182

attribute.func_closure)))

1761

attr[attrname] = (

1762

dbus_interface_annotations(alt_interface)

1763

(copy_function(attribute)))

1183

1764

if deprecate:

1184

1765

# Deprecate all alternate interfaces

1185

iname="_AlternateDBusNames_interface_annotation{0}"

1766

iname = "_AlternateDBusNames_interface_annotation{}"

1186

1767

for interface_name in interface_names:

1768

1187

1769

@dbus_interface_annotations(interface_name)

1188

1770

def func(self):

1189

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

1190

"true" }

1771

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

1772

"true"}

1191

1773

# Find an unused name

1192

1774

for aname in (iname.format(i)

1193

1775

for i in itertools.count()):

1197

1779

if interface_names:

1198

1780

# Replace the class with a new subclass of it with

1199

1781

# methods, signals, etc. as created above.

1200

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

1201

(cls,), attr)

1782

if sys.version_info.major == 2:

1783

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

1784

(cls, ), attr)

1785

else:

1786

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

1787

(cls, ), attr)

1202

1788

return cls

1789

1203

1790

return wrapper

1204

1791

1205

1792

1206

1793

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

1207

"se.bsnet.fukt.Mandos"})

1794

"se.bsnet.fukt.Mandos"})

1208

1795

class ClientDBus(Client, DBusObjectWithProperties):

1209

1796

"""A Client class using D-Bus

1210

1797

1211

1798

Attributes:

1212

1799

dbus_object_path: dbus.ObjectPath

1213

1800

bus: dbus.SystemBus()

1214

1801

"""

1215

1802

1216

1803

runtime_expansions = (Client.runtime_expansions

1217

+ ("dbus_object_path",))

1218

1804

+ ("dbus_object_path", ))

1805

1806

_interface = "se.recompile.Mandos.Client"

1807

1219

1808

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

1220

1221

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

1809

1810

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

1222

1811

self.bus = bus

1223

1812

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

1224

1813

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

1225

1814

# the D-Bus

1226

client_object_name = unicode(self.name).translate(

1815

client_object_name = str(self.name).translate(

1227

1816

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

1228

1817

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

1229

self.dbus_object_path = (dbus.ObjectPath

1230

("/clients/" + client_object_name))

1818

self.dbus_object_path = dbus.ObjectPath(

1819

"/clients/" + client_object_name)

1231

1820

DBusObjectWithProperties.__init__(self, self.bus,

1232

1821

self.dbus_object_path)

1233

1234

def notifychangeproperty(transform_func,

1235

dbus_name, type_func=lambda x: x,

1236

variant_level=1):

1822

1823

def notifychangeproperty(transform_func, dbus_name,

1824

type_func=lambda x: x,

1825

variant_level=1,

1826

invalidate_only=False,

1827

_interface=_interface):

1237

1828

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

1238

1829

its changes to DBus.

1239

1830

1240

1831

transform_fun: Function that takes a value and a variant_level

1241

1832

and transforms it to a D-Bus type.

1242

1833

dbus_name: D-Bus name of the variable

1244

1835

to the D-Bus. Default: no transform

1245

1836

variant_level: D-Bus variant level. Default: 1

1246

1837

"""

1247

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

1838

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

1839

1248

1840

def setter(self, value):

1249

1841

if hasattr(self, "dbus_object_path"):

1250

1842

if (not hasattr(self, attrname) or

1251

1843

type_func(getattr(self, attrname, None))

1252

1844

!= type_func(value)):

1253

dbus_value = transform_func(type_func(value),

1254

variant_level

1255

=variant_level)

1256

self.PropertyChanged(dbus.String(dbus_name),

1257

dbus_value)

1845

if invalidate_only:

1846

self.PropertiesChanged(

1847

_interface, dbus.Dictionary(),

1848

dbus.Array((dbus_name, )))

1849

else:

1850

dbus_value = transform_func(

1851

type_func(value),

1852

variant_level=variant_level)

1853

self.PropertyChanged(dbus.String(dbus_name),

1854

dbus_value)

1855

self.PropertiesChanged(

1856

_interface,

1857

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

1858

dbus_value}),

1859

dbus.Array())

1258

1860

setattr(self, attrname, value)

1259

1861

1260

1862

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

1261

1863

1262

1864

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1263

1865

approvals_pending = notifychangeproperty(dbus.Boolean,

1264

1866

"ApprovalPending",

1265

type_func = bool)

1867

type_func=bool)

1266

1868

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

1267

1869

last_enabled = notifychangeproperty(datetime_to_dbus,

1268

1870

"LastEnabled")

1269

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

1270

type_func = lambda checker:

1271

checker is not None)

1871

checker = notifychangeproperty(

1872

dbus.Boolean, "CheckerRunning",

1873

type_func=lambda checker: checker is not None)

1272

1874

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1273

1875

"LastCheckedOK")

1274

1876

last_checker_status = notifychangeproperty(dbus.Int16,

1277

1879

datetime_to_dbus, "LastApprovalRequest")

1278

1880

approved_by_default = notifychangeproperty(dbus.Boolean,

1279

1881

"ApprovedByDefault")

1280

approval_delay = notifychangeproperty(dbus.UInt64,

1281

"ApprovalDelay",

1282

type_func =

1283

timedelta_to_milliseconds)

1882

approval_delay = notifychangeproperty(

1883

dbus.UInt64, "ApprovalDelay",

1884

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

1284

1885

approval_duration = notifychangeproperty(

1285

1886

dbus.UInt64, "ApprovalDuration",

1286

type_func = timedelta_to_milliseconds)

1887

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

1287

1888

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

1288

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

1289

type_func =

1290

timedelta_to_milliseconds)

1889

timeout = notifychangeproperty(

1890

dbus.UInt64, "Timeout",

1891

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

1291

1892

extended_timeout = notifychangeproperty(

1292

1893

dbus.UInt64, "ExtendedTimeout",

1293

type_func = timedelta_to_milliseconds)

1294

interval = notifychangeproperty(dbus.UInt64,

1295

"Interval",

1296

type_func =

1297

timedelta_to_milliseconds)

1894

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

1895

interval = notifychangeproperty(

1896

dbus.UInt64, "Interval",

1897

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

1298

1898

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

1299

1899

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

1900

invalidate_only=True)

1901

1300

1902

del notifychangeproperty

1301

1903

1302

1904

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

1303

1905

try:

1304

1906

self.remove_from_connection()

1307

1909

if hasattr(DBusObjectWithProperties, "__del__"):

1308

1910

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

1309

1911

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

1310

1311

def checker_callback(self, pid, condition, command,

1312

*args, **kwargs):

1313

self.checker_callback_tag = None

1314

self.checker = None

1315

if os.WIFEXITED(condition):

1316

exitstatus = os.WEXITSTATUS(condition)

1912

1913

def checker_callback(self, source, condition,

1914

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

1915

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

1916

connection, command, *args,

1917

**kwargs)

1918

exitstatus = self.last_checker_status

1919

if exitstatus >= 0:

1317

1920

# Emit D-Bus signal

1318

1921

self.CheckerCompleted(dbus.Int16(exitstatus),

1319

dbus.Int64(condition),

1922

# This is specific to GNU libC

1923

dbus.Int64(exitstatus << 8),

1320

1924

dbus.String(command))

1321

1925

else:

1322

1926

# Emit D-Bus signal

1323

1927

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

1324

dbus.Int64(condition),

1928

dbus.Int64(

1929

# This is specific to GNU libC

1930

(exitstatus << 8)

1931

| self.last_checker_signal),

1325

1932

dbus.String(command))

1326

1327

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

1328

*args, **kwargs)

1329

1933

return ret

1934

1330

1935

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

1331

old_checker = self.checker

1332

if self.checker is not None:

1333

old_checker_pid = self.checker.pid

1334

else:

1335

old_checker_pid = None

1936

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

1336

1937

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

1337

1938

# Only if new checker process was started

1338

1939

if (self.checker is not None

1340

1941

# Emit D-Bus signal

1341

1942

self.CheckerStarted(self.current_checker_command)

1342

1943

return r

1343

1944

1344

1945

def _reset_approved(self):

1345

1946

self.approved = None

1346

1947

return False

1347

1948

1348

1949

def approve(self, value=True):

1349

1950

self.approved = value

1350

gobject.timeout_add(timedelta_to_milliseconds

1351

(self.approval_duration),

1352

self._reset_approved)

1951

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

1952

* 1000), self._reset_approved)

1353

1953

self.send_changedstate()

1354

1355

## D-Bus methods, signals & properties

1356

_interface = "se.recompile.Mandos.Client"

1357

1358

## Interfaces

1359

1360

@dbus_interface_annotations(_interface)

1361

def _foo(self):

1362

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

1363

"false"}

1364

1365

## Signals

1366

1954

1955

# D-Bus methods, signals & properties

1956

1957

# Interfaces

1958

1959

# Signals

1960

1367

1961

# CheckerCompleted - signal

1368

1962

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

1369

1963

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

1370

1964

"D-Bus signal"

1371

1965

pass

1372

1966

1373

1967

# CheckerStarted - signal

1374

1968

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

1375

1969

def CheckerStarted(self, command):

1376

1970

"D-Bus signal"

1377

1971

pass

1378

1972

1379

1973

# PropertyChanged - signal

1974

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

1380

1975

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

1381

1976

def PropertyChanged(self, property, value):

1382

1977

"D-Bus signal"

1383

1978

pass

1384

1979

1385

1980

# GotSecret - signal

1386

1981

@dbus.service.signal(_interface)

1387

1982

def GotSecret(self):

1390

1985

server to mandos-client

1391

1986

"""

1392

1987

pass

1393

1988

1394

1989

# Rejected - signal

1395

1990

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

1396

1991

def Rejected(self, reason):

1397

1992

"D-Bus signal"

1398

1993

pass

1399

1994

1400

1995

# NeedApproval - signal

1401

1996

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

1402

1997

def NeedApproval(self, timeout, default):

1403

1998

"D-Bus signal"

1404

1999

return self.need_approval()

1405

1406

## Methods

1407

2000

2001

# Methods

2002

1408

2003

# Approve - method

1409

2004

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

1410

2005

def Approve(self, value):

1411

2006

self.approve(value)

1412

2007

1413

2008

# CheckedOK - method

1414

2009

@dbus.service.method(_interface)

1415

2010

def CheckedOK(self):

1416

2011

self.checked_ok()

1417

2012

1418

2013

# Enable - method

2014

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

1419

2015

@dbus.service.method(_interface)

1420

2016

def Enable(self):

1421

2017

"D-Bus method"

1422

2018

self.enable()

1423

2019

1424

2020

# StartChecker - method

2021

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

1425

2022

@dbus.service.method(_interface)

1426

2023

def StartChecker(self):

1427

2024

"D-Bus method"

1428

2025

self.start_checker()

1429

2026

1430

2027

# Disable - method

2028

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

1431

2029

@dbus.service.method(_interface)

1432

2030

def Disable(self):

1433

2031

"D-Bus method"

1434

2032

self.disable()

1435

2033

1436

2034

# StopChecker - method

2035

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

1437

2036

@dbus.service.method(_interface)

1438

2037

def StopChecker(self):

1439

2038

self.stop_checker()

1440

1441

## Properties

1442

2039

2040

# Properties

2041

1443

2042

# ApprovalPending - property

1444

2043

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

1445

2044

def ApprovalPending_dbus_property(self):

1446

2045

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

1447

2046

1448

2047

# ApprovedByDefault - property

1449

@dbus_service_property(_interface, signature="b",

2048

@dbus_service_property(_interface,

2049

signature="b",

1450

2050

access="readwrite")

1451

2051

def ApprovedByDefault_dbus_property(self, value=None):

1452

2052

if value is None: # get

1453

2053

return dbus.Boolean(self.approved_by_default)

1454

2054

self.approved_by_default = bool(value)

1455

2055

1456

2056

# ApprovalDelay - property

1457

@dbus_service_property(_interface, signature="t",

2057

@dbus_service_property(_interface,

2058

signature="t",

1458

2059

access="readwrite")

1459

2060

def ApprovalDelay_dbus_property(self, value=None):

1460

2061

if value is None: # get

1461

return dbus.UInt64(self.approval_delay_milliseconds())

2062

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

2063

* 1000)

1462

2064

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

1463

2065

1464

2066

# ApprovalDuration - property

1465

@dbus_service_property(_interface, signature="t",

2067

@dbus_service_property(_interface,

2068

signature="t",

1466

2069

access="readwrite")

1467

2070

def ApprovalDuration_dbus_property(self, value=None):

1468

2071

if value is None: # get

1469

return dbus.UInt64(timedelta_to_milliseconds(

1470

self.approval_duration))

2072

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

2073

* 1000)

1471

2074

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

1472

2075

1473

2076

# Name - property

2077

@dbus_annotations(

2078

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

1474

2079

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

1475

2080

def Name_dbus_property(self):

1476

2081

return dbus.String(self.name)

1477

2082

2083

# KeyID - property

2084

@dbus_annotations(

2085

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

2086

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

2087

def KeyID_dbus_property(self):

2088

return dbus.String(self.key_id)

2089

1478

2090

# Fingerprint - property

2091

@dbus_annotations(

2092

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

1479

2093

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

1480

2094

def Fingerprint_dbus_property(self):

1481

2095

return dbus.String(self.fingerprint)

1482

2096

1483

2097

# Host - property

1484

@dbus_service_property(_interface, signature="s",

2098

@dbus_service_property(_interface,

2099

signature="s",

1485

2100

access="readwrite")

1486

2101

def Host_dbus_property(self, value=None):

1487

2102

if value is None: # get

1488

2103

return dbus.String(self.host)

1489

self.host = unicode(value)

1490

2104

self.host = str(value)

2105

1491

2106

# Created - property

2107

@dbus_annotations(

2108

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

1492

2109

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

1493

2110

def Created_dbus_property(self):

1494

2111

return datetime_to_dbus(self.created)

1495

2112

1496

2113

# LastEnabled - property

1497

2114

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

1498

2115

def LastEnabled_dbus_property(self):

1499

2116

return datetime_to_dbus(self.last_enabled)

1500

2117

1501

2118

# Enabled - property

1502

@dbus_service_property(_interface, signature="b",

2119

@dbus_service_property(_interface,

2120

signature="b",

1503

2121

access="readwrite")

1504

2122

def Enabled_dbus_property(self, value=None):

1505

2123

if value is None: # get

1508

2126

self.enable()

1509

2127

else:

1510

2128

self.disable()

1511

2129

1512

2130

# LastCheckedOK - property

1513

@dbus_service_property(_interface, signature="s",

2131

@dbus_service_property(_interface,

2132

signature="s",

1514

2133

access="readwrite")

1515

2134

def LastCheckedOK_dbus_property(self, value=None):

1516

2135

if value is not None:

1517

2136

self.checked_ok()

1518

2137

return

1519

2138

return datetime_to_dbus(self.last_checked_ok)

1520

2139

1521

2140

# LastCheckerStatus - property

1522

@dbus_service_property(_interface, signature="n",

1523

access="read")

2141

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

1524

2142

def LastCheckerStatus_dbus_property(self):

1525

2143

return dbus.Int16(self.last_checker_status)

1526

2144

1527

2145

# Expires - property

1528

2146

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

1529

2147

def Expires_dbus_property(self):

1530

2148

return datetime_to_dbus(self.expires)

1531

2149

1532

2150

# LastApprovalRequest - property

1533

2151

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

1534

2152

def LastApprovalRequest_dbus_property(self):

1535

2153

return datetime_to_dbus(self.last_approval_request)

1536

2154

1537

2155

# Timeout - property

1538

@dbus_service_property(_interface, signature="t",

2156

@dbus_service_property(_interface,

2157

signature="t",

1539

2158

access="readwrite")

1540

2159

def Timeout_dbus_property(self, value=None):

1541

2160

if value is None: # get

1542

return dbus.UInt64(self.timeout_milliseconds())

2161

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

1543

2162

old_timeout = self.timeout

1544

2163

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

1545

2164

# Reschedule disabling

1553

2172

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

1554

2173

is None):

1555

2174

return

1556

gobject.source_remove(self.disable_initiator_tag)

1557

self.disable_initiator_tag = (

1558

gobject.timeout_add(

1559

timedelta_to_milliseconds(self.expires - now),

1560

self.disable))

1561

2175

GLib.source_remove(self.disable_initiator_tag)

2176

self.disable_initiator_tag = GLib.timeout_add(

2177

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

2178

self.disable)

2179

1562

2180

# ExtendedTimeout - property

1563

@dbus_service_property(_interface, signature="t",

2181

@dbus_service_property(_interface,

2182

signature="t",

1564

2183

access="readwrite")

1565

2184

def ExtendedTimeout_dbus_property(self, value=None):

1566

2185

if value is None: # get

1567

return dbus.UInt64(self.extended_timeout_milliseconds())

2186

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

2187

* 1000)

1568

2188

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

1569

2189

1570

2190

# Interval - property

1571

@dbus_service_property(_interface, signature="t",

2191

@dbus_service_property(_interface,

2192

signature="t",

1572

2193

access="readwrite")

1573

2194

def Interval_dbus_property(self, value=None):

1574

2195

if value is None: # get

1575

return dbus.UInt64(self.interval_milliseconds())

2196

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

1576

2197

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

1577

2198

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

1578

2199

return

1579

2200

if self.enabled:

1580

2201

# Reschedule checker run

1581

gobject.source_remove(self.checker_initiator_tag)

1582

self.checker_initiator_tag = (gobject.timeout_add

1583

(value, self.start_checker))

1584

self.start_checker() # Start one now, too

1585

2202

GLib.source_remove(self.checker_initiator_tag)

2203

self.checker_initiator_tag = GLib.timeout_add(

2204

value, self.start_checker)

2205

self.start_checker() # Start one now, too

2206

1586

2207

# Checker - property

1587

@dbus_service_property(_interface, signature="s",

2208

@dbus_service_property(_interface,

2209

signature="s",

1588

2210

access="readwrite")

1589

2211

def Checker_dbus_property(self, value=None):

1590

2212

if value is None: # get

1591

2213

return dbus.String(self.checker_command)

1592

self.checker_command = unicode(value)

1593

2214

self.checker_command = str(value)

2215

1594

2216

# CheckerRunning - property

1595

@dbus_service_property(_interface, signature="b",

2217

@dbus_service_property(_interface,

2218

signature="b",

1596

2219

access="readwrite")

1597

2220

def CheckerRunning_dbus_property(self, value=None):

1598

2221

if value is None: # get

1601

2224

self.start_checker()

1602

2225

else:

1603

2226

self.stop_checker()

1604

2227

1605

2228

# ObjectPath - property

2229

@dbus_annotations(

2230

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

2231

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

1606

2232

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

1607

2233

def ObjectPath_dbus_property(self):

1608

return self.dbus_object_path # is already a dbus.ObjectPath

1609

2234

return self.dbus_object_path # is already a dbus.ObjectPath

2235

1610

2236

# Secret = property

1611

@dbus_service_property(_interface, signature="ay",

1612

access="write", byte_arrays=True)

2237

@dbus_annotations(

2238

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

2239

"invalidates"})

2240

@dbus_service_property(_interface,

2241

signature="ay",

2242

access="write",

2243

byte_arrays=True)

1613

2244

def Secret_dbus_property(self, value):

1614

self.secret = str(value)

1615

2245

self.secret = bytes(value)

2246

1616

2247

del _interface

1617

2248

1618

2249

1619

class ProxyClient(object):

1620

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

2250

class ProxyClient:

2251

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

1621

2252

self._pipe = child_pipe

1622

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

2253

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

1623

2254

if not self._pipe.recv():

1624

raise KeyError()

1625

2255

raise KeyError(key_id or fpr)

2256

1626

2257

def __getattribute__(self, name):

1627

2258

if name == '_pipe':

1628

2259

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

1631

2262

if data[0] == 'data':

1632

2263

return data[1]

1633

2264

if data[0] == 'function':

2265

1634

2266

def func(*args, **kwargs):

1635

2267

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

1636

2268

return self._pipe.recv()[1]

2269

1637

2270

return func

1638

2271

1639

2272

def __setattr__(self, name, value):

1640

2273

if name == '_pipe':

1641

2274

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

1644

2277

1645

2278

class ClientHandler(socketserver.BaseRequestHandler, object):

1646

2279

"""A class to handle client connections.

1647

2280

1648

2281

Instantiated once for each connection to handle it.

1649

2282

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

1650

2283

1651

2284

def handle(self):

1652

2285

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

1653

2286

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

1654

unicode(self.client_address))

2287

str(self.client_address))

1655

2288

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

1656

2289

self.server.child_pipe.fileno())

1657

1658

session = (gnutls.connection

1659

.ClientSession(self.request,

1660

gnutls.connection

1661

.X509Credentials()))

1662

1663

# Note: gnutls.connection.X509Credentials is really a

1664

# generic GnuTLS certificate credentials object so long as

1665

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

1666

# here despite using OpenPGP certificates.

1667

1668

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

1669

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

1670

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

1671

# "+DHE-DSS"))

2290

2291

session = gnutls.ClientSession(self.request)

2292

2293

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

2294

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

2295

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

2296

# "+DHE-DSS"))

1672

2297

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

1673

2298

priority = self.server.gnutls_priority

1674

2299

if priority is None:

1675

2300

priority = "NORMAL"

1676

(gnutls.library.functions

1677

.gnutls_priority_set_direct(session._c_object,

1678

priority, None))

1679

2301

gnutls.priority_set_direct(session._c_object,

2302

priority.encode("utf-8"),

2303

None)

2304

1680

2305

# Start communication using the Mandos protocol

1681

2306

# Get protocol number

1682

2307

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

1683

2308

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

1684

2309

try:

1685

2310

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

1686

raise RuntimeError

2311

raise RuntimeError(line)

1687

2312

except (ValueError, IndexError, RuntimeError) as error:

1688

2313

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

1689

2314

return

1690

2315

1691

2316

# Start GnuTLS connection

1692

2317

try:

1693

2318

session.handshake()

1694

except gnutls.errors.GNUTLSError as error:

2319

except gnutls.Error as error:

1695

2320

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

1696

2321

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

1697

2322

# established. Just abandon the request.

1698

2323

return

1699

2324

logger.debug("Handshake succeeded")

1700

2325

1701

2326

approval_required = False

1702

2327

try:

1703

try:

1704

fpr = self.fingerprint(self.peer_certificate

1705

(session))

1706

except (TypeError,

1707

gnutls.errors.GNUTLSError) as error:

1708

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

1709

return

1710

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

1711

1712

try:

1713

client = ProxyClient(child_pipe, fpr,

2328

if gnutls.has_rawpk:

2329

fpr = b""

2330

try:

2331

key_id = self.key_id(

2332

self.peer_certificate(session))

2333

except (TypeError, gnutls.Error) as error:

2334

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

2335

return

2336

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

2337

2338

else:

2339

key_id = b""

2340

try:

2341

fpr = self.fingerprint(

2342

self.peer_certificate(session))

2343

except (TypeError, gnutls.Error) as error:

2344

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

2345

return

2346

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

2347

2348

try:

2349

client = ProxyClient(child_pipe, key_id, fpr,

1714

2350

self.client_address)

1715

2351

except KeyError:

1716

2352

return

1717

2353

1718

2354

if client.approval_delay:

1719

2355

delay = client.approval_delay

1720

2356

client.approvals_pending += 1

1721

2357

approval_required = True

1722

2358

1723

2359

while True:

1724

2360

if not client.enabled:

1725

2361

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

1726

client.name)

2362

client.name)

1727

2363

if self.server.use_dbus:

1728

2364

# Emit D-Bus signal

1729

2365

client.Rejected("Disabled")

1730

2366

return

1731

2367

1732

2368

if client.approved or not client.approval_delay:

1733

#We are approved or approval is disabled

2369

# We are approved or approval is disabled

1734

2370

break

1735

2371

elif client.approved is None:

1736

2372

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

1738

2374

if self.server.use_dbus:

1739

2375

# Emit D-Bus signal

1740

2376

client.NeedApproval(

1741

client.approval_delay_milliseconds(),

1742

client.approved_by_default)

2377

client.approval_delay.total_seconds()

2378

* 1000, client.approved_by_default)

1743

2379

else:

1744

2380

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

1745

2381

client.name)

1747

2383

# Emit D-Bus signal

1748

2384

client.Rejected("Denied")

1749

2385

return

1750

1751

#wait until timeout or approved

2386

2387

# wait until timeout or approved

1752

2388

time = datetime.datetime.now()

1753

2389

client.changedstate.acquire()

1754

client.changedstate.wait(

1755

float(timedelta_to_milliseconds(delay)

1756

/ 1000))

2390

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

1757

2391

client.changedstate.release()

1758

2392

time2 = datetime.datetime.now()

1759

2393

if (time2 - time) >= delay:

1769

2403

break

1770

2404

else:

1771

2405

delay -= time2 - time

1772

1773

sent_size = 0

1774

while sent_size < len(client.secret):

1775

try:

1776

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

1777

except gnutls.errors.GNUTLSError as error:

1778

logger.warning("gnutls send failed",

1779

exc_info=error)

1780

return

1781

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

1782

sent, len(client.secret)

1783

- (sent_size + sent))

1784

sent_size += sent

1785

2406

2407

try:

2408

session.send(client.secret)

2409

except gnutls.Error as error:

2410

logger.warning("gnutls send failed",

2411

exc_info=error)

2412

return

2413

1786

2414

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

1787

2415

# bump the timeout using extended_timeout

1788

2416

client.bump_timeout(client.extended_timeout)

1789

2417

if self.server.use_dbus:

1790

2418

# Emit D-Bus signal

1791

2419

client.GotSecret()

1792

2420

1793

2421

finally:

1794

2422

if approval_required:

1795

2423

client.approvals_pending -= 1

1796

2424

try:

1797

2425

session.bye()

1798

except gnutls.errors.GNUTLSError as error:

2426

except gnutls.Error as error:

1799

2427

logger.warning("GnuTLS bye failed",

1800

2428

exc_info=error)

1801

2429

1802

2430

@staticmethod

1803

2431

def peer_certificate(session):

1804

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

1805

# If not an OpenPGP certificate...

1806

if (gnutls.library.functions

1807

.gnutls_certificate_type_get(session._c_object)

1808

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1809

# ...do the normal thing

1810

return session.peer_certificate

2432

"Return the peer's certificate as a bytestring"

2433

try:

2434

cert_type = gnutls.certificate_type_get2(session._c_object,

2435

gnutls.CTYPE_PEERS)

2436

except AttributeError:

2437

cert_type = gnutls.certificate_type_get(session._c_object)

2438

if gnutls.has_rawpk:

2439

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2440

else:

2441

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2442

# If not a valid certificate type...

2443

if cert_type not in valid_cert_types:

2444

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

2445

valid_cert_types)

2446

# ...return invalid data

2447

return b""

1811

2448

list_size = ctypes.c_uint(1)

1812

cert_list = (gnutls.library.functions

1813

.gnutls_certificate_get_peers

2449

cert_list = (gnutls.certificate_get_peers

1814

2450

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

1815

2451

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

1816

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

1817

" certificate")

2452

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

1818

2453

if list_size.value == 0:

1819

2454

return None

1820

2455

cert = cert_list[0]

1821

2456

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

1822

2457

2458

@staticmethod

2459

def key_id(certificate):

2460

"Convert a certificate bytestring to a hexdigit key ID"

2461

# New GnuTLS "datum" with the public key

2462

datum = gnutls.datum_t(

2463

ctypes.cast(ctypes.c_char_p(certificate),

2464

ctypes.POINTER(ctypes.c_ubyte)),

2465

ctypes.c_uint(len(certificate)))

2466

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

2467

# New empty GnuTLS certificate

2468

pubkey = gnutls.pubkey_t()

2469

gnutls.pubkey_init(ctypes.byref(pubkey))

2470

# Import the raw public key into the certificate

2471

gnutls.pubkey_import(pubkey,

2472

ctypes.byref(datum),

2473

gnutls.X509_FMT_DER)

2474

# New buffer for the key ID

2475

buf = ctypes.create_string_buffer(32)

2476

buf_len = ctypes.c_size_t(len(buf))

2477

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

2478

gnutls.pubkey_get_key_id(

2479

pubkey,

2480

gnutls.KEYID_USE_SHA256,

2481

ctypes.cast(ctypes.byref(buf),

2482

ctypes.POINTER(ctypes.c_ubyte)),

2483

ctypes.byref(buf_len))

2484

# Deinit the certificate

2485

gnutls.pubkey_deinit(pubkey)

2486

2487

# Convert the buffer to a Python bytestring

2488

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

2489

# Convert the bytestring to hexadecimal notation

2490

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

2491

return hex_key_id

2492

1823

2493

@staticmethod

1824

2494

def fingerprint(openpgp):

1825

2495

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1826

2496

# New GnuTLS "datum" with the OpenPGP public key

1827

datum = (gnutls.library.types

1828

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

1829

ctypes.POINTER

1830

(ctypes.c_ubyte)),

1831

ctypes.c_uint(len(openpgp))))

2497

datum = gnutls.datum_t(

2498

ctypes.cast(ctypes.c_char_p(openpgp),

2499

ctypes.POINTER(ctypes.c_ubyte)),

2500

ctypes.c_uint(len(openpgp)))

1832

2501

# New empty GnuTLS certificate

1833

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2502

crt = gnutls.openpgp_crt_t()

2503

gnutls.openpgp_crt_init(ctypes.byref(crt))

1836

2504

# Import the OpenPGP public key into the certificate

1837

(gnutls.library.functions

1838

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

1839

gnutls.library.constants

1840

.GNUTLS_OPENPGP_FMT_RAW))

2505

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

2506

gnutls.OPENPGP_FMT_RAW)

1841

2507

# Verify the self signature in the key

1842

2508

crtverify = ctypes.c_uint()

1843

(gnutls.library.functions

1844

.gnutls_openpgp_crt_verify_self(crt, 0,

1845

ctypes.byref(crtverify)))

2509

gnutls.openpgp_crt_verify_self(crt, 0,

2510

ctypes.byref(crtverify))

1846

2511

if crtverify.value != 0:

1847

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1848

raise (gnutls.errors.CertificateSecurityError

1849

("Verify failed"))

2512

gnutls.openpgp_crt_deinit(crt)

2513

raise gnutls.CertificateSecurityError(code

2514

=crtverify.value)

1850

2515

# New buffer for the fingerprint

1851

2516

buf = ctypes.create_string_buffer(20)

1852

2517

buf_len = ctypes.c_size_t()

1853

2518

# Get the fingerprint from the certificate into the buffer

1854

(gnutls.library.functions

1855

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

1856

ctypes.byref(buf_len)))

2519

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

2520

ctypes.byref(buf_len))

1857

2521

# Deinit the certificate

1858

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2522

gnutls.openpgp_crt_deinit(crt)

1859

2523

# Convert the buffer to a Python bytestring

1860

2524

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

1861

2525

# Convert the bytestring to hexadecimal notation

1863

2527

return hex_fpr

1864

2528

1865

2529

1866

class MultiprocessingMixIn(object):

2530

class MultiprocessingMixIn:

1867

2531

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

2532

1868

2533

def sub_process_main(self, request, address):

1869

2534

try:

1870

2535

self.finish_request(request, address)

1871

2536

except Exception:

1872

2537

self.handle_error(request, address)

1873

2538

self.close_request(request)

1874

2539

1875

2540

def process_request(self, request, address):

1876

2541

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

1877

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

1878

args = (request, address))

2542

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

2543

args=(request, address))

1879

2544

proc.start()

1880

2545

return proc

1881

2546

1882

2547

1883

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2548

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1884

2549

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

2550

1885

2551

def process_request(self, request, client_address):

1886

2552

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

1887

2553

1888

2554

This function creates a new pipe in self.pipe

1889

2555

"""

1890

2556

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1891

2557

1892

2558

proc = MultiprocessingMixIn.process_request(self, request,

1893

2559

client_address)

1894

2560

self.child_pipe.close()

1895

2561

self.add_pipe(parent_pipe, proc)

1896

2562

1897

2563

def add_pipe(self, parent_pipe, proc):

1898

2564

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

1899

raise NotImplementedError

2565

raise NotImplementedError()

1900

2566

1901

2567

1902

2568

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1903

socketserver.TCPServer, object):

2569

socketserver.TCPServer):

1904

2570

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

1905

2571

1906

2572

Attributes:

1907

2573

enabled: Boolean; whether this server is activated yet

1908

2574

interface: None or a network interface name (string)

1909

2575

use_ipv6: Boolean; to use IPv6 or not

1910

2576

"""

2577

1911

2578

def __init__(self, server_address, RequestHandlerClass,

1912

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

2579

interface=None,

2580

use_ipv6=True,

2581

socketfd=None):

1913

2582

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

1914

2583

creating a new one with socket.socket().

1915

2584

"""

1921

2590

self.socketfd = socketfd

1922

2591

# Save the original socket.socket() function

1923

2592

self.socket_socket = socket.socket

2593

1924

2594

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

1925

#

2595

#

1926

2596

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

1927

2597

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

1928

2598

# patching socket.socket.)

1929

#

2599

#

1930

2600

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

1931

2601

@functools.wraps(socket.socket)

1932

2602

def socket_wrapper(*args, **kwargs):

1944

2614

# socket_wrapper(), if socketfd was set.

1945

2615

socketserver.TCPServer.__init__(self, server_address,

1946

2616

RequestHandlerClass)

1947

2617

1948

2618

def server_bind(self):

1949

2619

"""This overrides the normal server_bind() function

1950

2620

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

1951

2621

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

2622

global SO_BINDTODEVICE

1952

2623

if self.interface is not None:

1953

2624

if SO_BINDTODEVICE is None:

1954

logger.error("SO_BINDTODEVICE does not exist;"

1955

" cannot bind to interface %s",

1956

self.interface)

1957

else:

1958

try:

1959

self.socket.setsockopt(socket.SOL_SOCKET,

1960

SO_BINDTODEVICE,

1961

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

1962

except socket.error as error:

1963

if error.errno == errno.EPERM:

1964

logger.error("No permission to bind to"

1965

" interface %s", self.interface)

1966

elif error.errno == errno.ENOPROTOOPT:

1967

logger.error("SO_BINDTODEVICE not available;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

elif error.errno == errno.ENODEV:

1971

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

1972

" cannot bind", self.interface)

1973

else:

1974

raise

2625

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

2626

# common enough.

2627

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

2628

SO_BINDTODEVICE = 25

2629

try:

2630

self.socket.setsockopt(

2631

socket.SOL_SOCKET, SO_BINDTODEVICE,

2632

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

2633

except socket.error as error:

2634

if error.errno == errno.EPERM:

2635

logger.error("No permission to bind to"

2636

" interface %s", self.interface)

2637

elif error.errno == errno.ENOPROTOOPT:

2638

logger.error("SO_BINDTODEVICE not available;"

2639

" cannot bind to interface %s",

2640

self.interface)

2641

elif error.errno == errno.ENODEV:

2642

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

2643

" cannot bind", self.interface)

2644

else:

2645

raise

1975

2646

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

1976

2647

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

2648

if self.server_address[1]:

2649

self.allow_reuse_address = True

1977

2650

if not self.server_address[0]:

1978

2651

if self.address_family == socket.AF_INET6:

1979

any_address = "::" # in6addr_any

2652

any_address = "::" # in6addr_any

1980

2653

else:

1981

any_address = socket.INADDR_ANY

2654

any_address = "0.0.0.0" # INADDR_ANY

1982

2655

self.server_address = (any_address,

1983

2656

self.server_address[1])

1984

2657

elif not self.server_address[1]:

1985

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

1986

0)

2658

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

1987

2659

# if self.interface:

1988

2660

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

1989

2661

# 0, # port

1995

2667

1996

2668

class MandosServer(IPv6_TCPServer):

1997

2669

"""Mandos server.

1998

2670

1999

2671

Attributes:

2000

2672

clients: set of Client objects

2001

2673

gnutls_priority GnuTLS priority string

2002

2674

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

2003

2004

Assumes a gobject.MainLoop event loop.

2675

2676

Assumes a GLib.MainLoop event loop.

2005

2677

"""

2678

2006

2679

def __init__(self, server_address, RequestHandlerClass,

2007

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

2008

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

2680

interface=None,

2681

use_ipv6=True,

2682

clients=None,

2683

gnutls_priority=None,

2684

use_dbus=True,

2685

socketfd=None):

2009

2686

self.enabled = False

2010

2687

self.clients = clients

2011

2688

if self.clients is None:

2014

2691

self.gnutls_priority = gnutls_priority

2015

2692

IPv6_TCPServer.__init__(self, server_address,

2016

2693

RequestHandlerClass,

2017

interface = interface,

2018

use_ipv6 = use_ipv6,

2019

socketfd = socketfd)

2694

interface=interface,

2695

use_ipv6=use_ipv6,

2696

socketfd=socketfd)

2697

2020

2698

def server_activate(self):

2021

2699

if self.enabled:

2022

2700

return socketserver.TCPServer.server_activate(self)

2023

2701

2024

2702

def enable(self):

2025

2703

self.enabled = True

2026

2704

2027

2705

def add_pipe(self, parent_pipe, proc):

2028

2706

# Call "handle_ipc" for both data and EOF events

2029

gobject.io_add_watch(parent_pipe.fileno(),

2030

gobject.IO_IN | gobject.IO_HUP,

2031

functools.partial(self.handle_ipc,

2032

parent_pipe =

2033

parent_pipe,

2034

proc = proc))

2035

2036

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

2037

proc = None, client_object=None):

2707

GLib.io_add_watch(

2708

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

2709

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

2710

functools.partial(self.handle_ipc,

2711

parent_pipe=parent_pipe,

2712

proc=proc))

2713

2714

def handle_ipc(self, source, condition,

2715

parent_pipe=None,

2716

proc=None,

2717

client_object=None):

2038

2718

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

2039

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

2719

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

2040

2720

# Wait for other process to exit

2041

2721

proc.join()

2042

2722

return False

2043

2723

2044

2724

# Read a request from the child

2045

2725

request = parent_pipe.recv()

2046

2726

command = request[0]

2047

2727

2048

2728

if command == 'init':

2049

fpr = request[1]

2050

address = request[2]

2051

2052

for c in self.clients.itervalues():

2053

if c.fingerprint == fpr:

2729

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

2730

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

2731

address = request[3]

2732

2733

for c in self.clients.values():

2734

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2735

"27AE41E4649B934CA495991B7852B855"):

2736

continue

2737

if key_id and c.key_id == key_id:

2738

client = c

2739

break

2740

if fpr and c.fingerprint == fpr:

2054

2741

client = c

2055

2742

break

2056

2743

else:

2057

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

2058

"dress: %s", fpr, address)

2744

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

2745

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

2059

2746

if self.use_dbus:

2060

2747

# Emit D-Bus signal

2061

mandos_dbus_service.ClientNotFound(fpr,

2748

mandos_dbus_service.ClientNotFound(key_id or fpr,

2062

2749

address[0])

2063

2750

parent_pipe.send(False)

2064

2751

return False

2065

2066

gobject.io_add_watch(parent_pipe.fileno(),

2067

gobject.IO_IN | gobject.IO_HUP,

2068

functools.partial(self.handle_ipc,

2069

parent_pipe =

2070

parent_pipe,

2071

proc = proc,

2072

client_object =

2073

client))

2752

2753

GLib.io_add_watch(

2754

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

2755

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

2756

functools.partial(self.handle_ipc,

2757

parent_pipe=parent_pipe,

2758

proc=proc,

2759

client_object=client))

2074

2760

parent_pipe.send(True)

2075

2761

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

2076

2762

# same fileno

2079

2765

funcname = request[1]

2080

2766

args = request[2]

2081

2767

kwargs = request[3]

2082

2768

2083

2769

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

2084

2770

funcname)(*args,

2085

**kwargs)))

2086

2771

**kwargs)))

2772

2087

2773

if command == 'getattr':

2088

2774

attrname = request[1]

2089

if callable(client_object.__getattribute__(attrname)):

2090

parent_pipe.send(('function',))

2775

if isinstance(client_object.__getattribute__(attrname),

2776

collections.abc.Callable):

2777

parent_pipe.send(('function', ))

2091

2778

else:

2092

parent_pipe.send(('data', client_object

2093

.__getattribute__(attrname)))

2094

2779

parent_pipe.send((

2780

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

2781

2095

2782

if command == 'setattr':

2096

2783

attrname = request[1]

2097

2784

value = request[2]

2098

2785

setattr(client_object, attrname, value)

2099

2786

2100

2787

return True

2101

2788

2102

2789

2103

2790

def rfc3339_duration_to_delta(duration):

2104

2791

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

2105

2106

>>> rfc3339_duration_to_delta("P7D")

2107

datetime.timedelta(7)

2108

>>> rfc3339_duration_to_delta("PT60S")

2109

datetime.timedelta(0, 60)

2110

>>> rfc3339_duration_to_delta("PT60M")

2111

datetime.timedelta(0, 3600)

2112

>>> rfc3339_duration_to_delta("PT24H")

2113

datetime.timedelta(1)

2114

>>> rfc3339_duration_to_delta("P1W")

2115

datetime.timedelta(7)

2116

>>> rfc3339_duration_to_delta("PT5M30S")

2117

datetime.timedelta(0, 330)

2118

>>> rfc3339_duration_to_delta("P1DT3M20S")

2119

datetime.timedelta(1, 200)

2792

2793

>>> timedelta = datetime.timedelta

2794

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

2795

True

2796

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

2797

True

2798

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

2799

True

2800

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

2801

True

2802

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

2803

True

2804

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

2805

True

2806

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

2807

True

2808

>>> del timedelta

2120

2809

"""

2121

2810

2122

2811

# Parsing an RFC 3339 duration with regular expressions is not

2123

2812

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

2124

2813

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

2125

2814

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

2126

2815

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

2127

2816

# avoid excessive use of external libraries.

2128

2817

2129

2818

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

2130

Token = collections.namedtuple("Token",

2131

("regexp", # To match token; if

2132

# "value" is not None,

2133

# must have a "group"

2134

# containing digits

2135

"value", # datetime.timedelta or

2136

# None

2137

"followers")) # Tokens valid after

2138

# this token

2819

Token = collections.namedtuple("Token", (

2820

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

2821

# a "group" containing digits

2822

"value", # datetime.timedelta or None

2823

"followers")) # Tokens valid after this token

2139

2824

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

2140

2825

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

2141

2826

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

2142

2827

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

2143

2828

datetime.timedelta(seconds=1),

2144

frozenset((token_end,)))

2829

frozenset((token_end, )))

2145

2830

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

2146

2831

datetime.timedelta(minutes=1),

2147

2832

frozenset((token_second, token_end)))

2163

2848

frozenset((token_month, token_end)))

2164

2849

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

2165

2850

datetime.timedelta(weeks=1),

2166

frozenset((token_end,)))

2851

frozenset((token_end, )))

2167

2852

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

2168

2853

frozenset((token_year, token_month,

2169

2854

token_day, token_time,

2170

token_week))),

2171

# Define starting values

2172

value = datetime.timedelta() # Value so far

2855

token_week)))

2856

# Define starting values:

2857

# Value so far

2858

value = datetime.timedelta()

2173

2859

found_token = None

2174

followers = frozenset(token_duration,) # Following valid tokens

2175

s = duration # String left to parse

2860

# Following valid tokens

2861

followers = frozenset((token_duration, ))

2862

# String left to parse

2863

s = duration

2176

2864

# Loop until end token is found

2177

2865

while found_token is not token_end:

2178

2866

# Search for any currently valid tokens

2194

2882

break

2195

2883

else:

2196

2884

# No currently valid tokens were found

2197

raise ValueError("Invalid RFC 3339 duration")

2885

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

2886

.format(duration))

2198

2887

# End token found

2199

2888

return value

2200

2889

2201

2890

2202

2891

def string_to_delta(interval):

2203

2892

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

2204

2205

>>> string_to_delta('7d')

2206

datetime.timedelta(7)

2207

>>> string_to_delta('60s')

2208

datetime.timedelta(0, 60)

2209

>>> string_to_delta('60m')

2210

datetime.timedelta(0, 3600)

2211

>>> string_to_delta('24h')

2212

datetime.timedelta(1)

2213

>>> string_to_delta('1w')

2214

datetime.timedelta(7)

2215

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

2216

datetime.timedelta(0, 330)

2893

2894

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

2895

True

2896

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

2897

True

2898

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

2899

True

2900

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

2901

True

2902

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

2903

True

2904

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

2905

True

2217

2906

"""

2218

2907

2219

2908

try:

2220

2909

return rfc3339_duration_to_delta(interval)

2221

2910

except ValueError:

2222

2911

pass

2223

2912

2224

2913

timevalue = datetime.timedelta(0)

2225

2914

for s in interval.split():

2226

2915

try:

2227

suffix = unicode(s[-1])

2916

suffix = s[-1]

2228

2917

value = int(s[:-1])

2229

2918

if suffix == "d":

2230

2919

delta = datetime.timedelta(value)

2237

2926

elif suffix == "w":

2238

2927

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

2239

2928

else:

2240

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

2241

.format(suffix))

2242

except (ValueError, IndexError) as e:

2929

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

2930

except IndexError as e:

2243

2931

raise ValueError(*(e.args))

2244

2932

timevalue += delta

2245

2933

return timevalue

2246

2934

2247

2935

2248

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

2936

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

2249

2937

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

2250

2938

2251

2939

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

2252

2940

if os.fork():

2253

2941

sys.exit()

2261

2949

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

2262

2950

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

2263

2951

raise OSError(errno.ENODEV,

2264

"{0} not a character device"

2952

"{} not a character device"

2265

2953

.format(os.devnull))

2266

2954

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

2267

2955

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

2271

2959

2272

2960

2273

2961

def main():

2274

2962

2275

2963

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

2276

2964

# Parsing of options, both command line and config file

2277

2965

2278

2966

parser = argparse.ArgumentParser()

2279

2967

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

2280

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

2968

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

2281

2969

help="show version number and exit")

2282

2970

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

2283

2971

help="Bind to interface IF")

2289

2977

help="Run self-test")

2290

2978

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

2291

2979

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

2292

" to terminal")

2980

" to terminal", default=None)

2293

2981

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

2294

2982

help="Debug level for stdout output")

2295

2983

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

2302

2990

" files")

2303

2991

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

2304

2992

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

2305

" system bus interface")

2993

" system bus interface", default=None)

2306

2994

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

2307

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

2995

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

2996

default=None)

2308

2997

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

2309

2998

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

2310

" state")

2999

" state", default=None)

2311

3000

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

2312

3001

help="Specify a file descriptor to a network"

2313

3002

" socket to use instead of creating one")

2314

3003

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

2315

3004

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

2316

3005

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

2317

help="Run in foreground")

2318

3006

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

3007

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

3008

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

3009

default=None)

3010

2319

3011

options = parser.parse_args()

2320

2321

if options.check:

2322

import doctest

2323

doctest.testmod()

2324

sys.exit()

2325

3012

2326

3013

# Default values for config file for server-global settings

2327

server_defaults = { "interface": "",

2328

"address": "",

2329

"port": "",

2330

"debug": "False",

2331

"priority":

2332

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

2333

"servicename": "Mandos",

2334

"use_dbus": "True",

2335

"use_ipv6": "True",

2336

"debuglevel": "",

2337

"restore": "True",

2338

"socket": "",

2339

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

2340

"foreground": "False",

2341

}

2342

3014

if gnutls.has_rawpk:

3015

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

3016

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

3017

else:

3018

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

3019

":+SIGN-DSA-SHA256")

3020

server_defaults = {"interface": "",

3021

"address": "",

3022

"port": "",

3023

"debug": "False",

3024

"priority": priority,

3025

"servicename": "Mandos",

3026

"use_dbus": "True",

3027

"use_ipv6": "True",

3028

"debuglevel": "",

3029

"restore": "True",

3030

"socket": "",

3031

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

3032

"foreground": "False",

3033

"zeroconf": "True",

3034

}

3035

del priority

3036

2343

3037

# Parse config file for server-global settings

2344

server_config = configparser.SafeConfigParser(server_defaults)

3038

server_config = configparser.ConfigParser(server_defaults)

2345

3039

del server_defaults

2346

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

2347

"mandos.conf"))

2348

# Convert the SafeConfigParser object to a dict

3040

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

3041

# Convert the ConfigParser object to a dict

2349

3042

server_settings = server_config.defaults()

2350

3043

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

2351

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

3044

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

3045

"foreground", "zeroconf"):

2352

3046

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

2353

3047

option)

2354

3048

if server_settings["port"]:

2364

3058

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

2365

3059

["socket"])

2366

3060

del server_config

2367

3061

2368

3062

# Override the settings from the config file with command line

2369

3063

# options, if set.

2370

3064

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

2371

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

2372

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

2373

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

3065

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

3066

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

3067

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

2374

3068

value = getattr(options, option)

2375

3069

if value is not None:

2376

3070

server_settings[option] = value

2377

3071

del options

2378

3072

# Force all strings to be unicode

2379

3073

for option in server_settings.keys():

2380

if type(server_settings[option]) is str:

2381

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

3074

if isinstance(server_settings[option], bytes):

3075

server_settings[option] = (server_settings[option]

3076

.decode("utf-8"))

3077

# Force all boolean options to be boolean

3078

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

3079

"foreground", "zeroconf"):

3080

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

2382

3081

# Debug implies foreground

2383

3082

if server_settings["debug"]:

2384

3083

server_settings["foreground"] = True

2385

3084

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

2386

3085

2387

3086

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

2388

3087

3088

if (not server_settings["zeroconf"]

3089

and not (server_settings["port"]

3090

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

3091

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

3092

2389

3093

# For convenience

2390

3094

debug = server_settings["debug"]

2391

3095

debuglevel = server_settings["debuglevel"]

2394

3098

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

2395

3099

stored_state_file)

2396

3100

foreground = server_settings["foreground"]

2397

3101

zeroconf = server_settings["zeroconf"]

3102

2398

3103

if debug:

2399

3104

initlogger(debug, logging.DEBUG)

2400

3105

else:

2403

3108

else:

2404

3109

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

2405

3110

initlogger(debug, level)

2406

3111

2407

3112

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

2408

syslogger.setFormatter(logging.Formatter

2409

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

2410

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

2411

.format(server_settings

2412

["servicename"])))

2413

3113

syslogger.setFormatter(

3114

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

3115

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

3116

server_settings["servicename"])))

3117

2414

3118

# Parse config file with clients

2415

client_config = configparser.SafeConfigParser(Client

2416

.client_defaults)

3119

client_config = configparser.ConfigParser(Client.client_defaults)

2417

3120

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

2418

3121

"clients.conf"))

2419

3122

2420

3123

global mandos_dbus_service

2421

3124

mandos_dbus_service = None

2422

2423

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

2424

server_settings["port"]),

2425

ClientHandler,

2426

interface=(server_settings["interface"]

2427

or None),

2428

use_ipv6=use_ipv6,

2429

gnutls_priority=

2430

server_settings["priority"],

2431

use_dbus=use_dbus,

2432

socketfd=(server_settings["socket"]

2433

or None))

3125

3126

socketfd = None

3127

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

3128

socketfd = server_settings["socket"]

3129

tcp_server = MandosServer(

3130

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

3131

ClientHandler,

3132

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

3133

use_ipv6=use_ipv6,

3134

gnutls_priority=server_settings["priority"],

3135

use_dbus=use_dbus,

3136

socketfd=socketfd)

2434

3137

if not foreground:

2435

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

3138

pidfilename = "/run/mandos.pid"

3139

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

3140

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

2436

3141

pidfile = None

2437

3142

try:

2438

pidfile = open(pidfilename, "w")

3143

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

2439

3144

except IOError as e:

2440

3145

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

2441

3146

exc_info=e)

2442

2443

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

3147

3148

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

3149

("mandos", "mandos"),

3150

("nobody", "nogroup")):

2444

3151

try:

2445

3152

uid = pwd.getpwnam(name).pw_uid

2446

gid = pwd.getpwnam(name).pw_gid

3153

gid = pwd.getpwnam(group).pw_gid

2447

3154

break

2448

3155

except KeyError:

2449

3156

continue

2453

3160

try:

2454

3161

os.setgid(gid)

2455

3162

os.setuid(uid)

3163

if debug:

3164

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

3165

gid))

2456

3166

except OSError as error:

3167

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

3168

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

2457

3169

if error.errno != errno.EPERM:

2458

raise error

2459

3170

raise

3171

2460

3172

if debug:

2461

3173

# Enable all possible GnuTLS debugging

2462

3174

2463

3175

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

2464

3176

# - GnuTLS manual

2465

gnutls.library.functions.gnutls_global_set_log_level(11)

2466

2467

@gnutls.library.types.gnutls_log_func

3177

gnutls.global_set_log_level(11)

3178

3179

@gnutls.log_func

2468

3180

def debug_gnutls(level, string):

2469

3181

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

2470

2471

(gnutls.library.functions

2472

.gnutls_global_set_log_function(debug_gnutls))

2473

3182

3183

gnutls.global_set_log_function(debug_gnutls)

3184

2474

3185

# Redirect stdin so all checkers get /dev/null

2475

3186

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

2476

3187

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

2477

3188

if null > 2:

2478

3189

os.close(null)

2479

3190

2480

3191

# Need to fork before connecting to D-Bus

2481

3192

if not foreground:

2482

3193

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

2483

3194

daemon()

2484

2485

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

2486

# need to inform gobject that threads will be used.

2487

gobject.threads_init()

2488

3195

3196

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

3197

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

3198

# need to inform GLib that threads will be used.

3199

GLib.threads_init()

3200

2489

3201

global main_loop

2490

3202

# From the Avahi example code

2491

3203

DBusGMainLoop(set_as_default=True)

2492

main_loop = gobject.MainLoop()

3204

main_loop = GLib.MainLoop()

2493

3205

bus = dbus.SystemBus()

2494

3206

# End of Avahi example code

2495

3207

if use_dbus:

2496

3208

try:

2497

3209

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

2498

bus, do_not_queue=True)

2499

old_bus_name = (dbus.service.BusName

2500

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

2501

do_not_queue=True))

2502

except dbus.exceptions.NameExistsException as e:

3210

bus,

3211

do_not_queue=True)

3212

old_bus_name = dbus.service.BusName(

3213

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

3214

do_not_queue=True)

3215

except dbus.exceptions.DBusException as e:

2503

3216

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

2504

3217

use_dbus = False

2505

3218

server_settings["use_dbus"] = False

2506

3219

tcp_server.use_dbus = False

2507

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2508

service = AvahiServiceToSyslog(name =

2509

server_settings["servicename"],

2510

servicetype = "_mandos._tcp",

2511

protocol = protocol, bus = bus)

2512

if server_settings["interface"]:

2513

service.interface = (if_nametoindex

2514

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

2515

3220

if zeroconf:

3221

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3222

service = AvahiServiceToSyslog(

3223

name=server_settings["servicename"],

3224

servicetype="_mandos._tcp",

3225

protocol=protocol,

3226

bus=bus)

3227

if server_settings["interface"]:

3228

service.interface = if_nametoindex(

3229

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

3230

2516

3231

global multiprocessing_manager

2517

3232

multiprocessing_manager = multiprocessing.Manager()

2518

3233

2519

3234

client_class = Client

2520

3235

if use_dbus:

2521

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

2522

3236

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

3237

2523

3238

client_settings = Client.config_parser(client_config)

2524

3239

old_client_settings = {}

2525

3240

clients_data = {}

2526

3241

3242

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

3243

global wnull

3244

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

3245

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

3246

# mode

3247

if debug or not foreground:

3248

wnull.close()

3249

2527

3250

# Get client data and settings from last running state.

2528

3251

if server_settings["restore"]:

2529

3252

try:

2530

3253

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

2531

clients_data, old_client_settings = (pickle.load

2532

(stored_state))

3254

if sys.version_info.major == 2:

3255

clients_data, old_client_settings = pickle.load(

3256

stored_state)

3257

else:

3258

bytes_clients_data, bytes_old_client_settings = (

3259

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

3260

# Fix bytes to strings

3261

# clients_data

3262

# .keys()

3263

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

3264

if isinstance(key, bytes)

3265

else key): value

3266

for key, value in

3267

bytes_clients_data.items()}

3268

del bytes_clients_data

3269

for key in clients_data:

3270

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

3271

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

3272

for k, v in

3273

clients_data[key].items()}

3274

clients_data[key] = value

3275

# .client_structure

3276

value["client_structure"] = [

3277

(s.decode("utf-8")

3278

if isinstance(s, bytes)

3279

else s) for s in

3280

value["client_structure"]]

3281

# .name, .host, and .checker_command

3282

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

3283

if isinstance(value[k], bytes):

3284

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

3285

if "key_id" not in value:

3286

value["key_id"] = ""

3287

elif "fingerprint" not in value:

3288

value["fingerprint"] = ""

3289

# old_client_settings

3290

# .keys()

3291

old_client_settings = {

3292

(key.decode("utf-8")

3293

if isinstance(key, bytes)

3294

else key): value

3295

for key, value in

3296

bytes_old_client_settings.items()}

3297

del bytes_old_client_settings

3298

# .host and .checker_command

3299

for value in old_client_settings.values():

3300

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

3301

if isinstance(value[attribute], bytes):

3302

value[attribute] = (value[attribute]

3303

.decode("utf-8"))

2533

3304

os.remove(stored_state_path)

2534

3305

except IOError as e:

2535

3306

if e.errno == errno.ENOENT:

2536

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

2537

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

3307

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

3308

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

2538

3309

else:

2539

3310

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

2540

3311

exc_info=e)

2541

3312

raise

2542

3313

except EOFError as e:

2543

3314

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

2544

"EOFError:", exc_info=e)

2545

3315

"EOFError:",

3316

exc_info=e)

3317

2546

3318

with PGPEngine() as pgp:

2547

for client_name, client in clients_data.iteritems():

3319

for client_name, client in clients_data.items():

3320

# Skip removed clients

3321

if client_name not in client_settings:

3322

continue

3323

2548

3324

# Decide which value to use after restoring saved state.

2549

3325

# We have three different values: Old config file,

2550

3326

# new config file, and saved state.

2555

3331

# For each value in new config, check if it

2556

3332

# differs from the old config value (Except for

2557

3333

# the "secret" attribute)

2558

if (name != "secret" and

2559

value != old_client_settings[client_name]

2560

[name]):

3334

if (name != "secret"

3335

and (value !=

3336

old_client_settings[client_name][name])):

2561

3337

client[name] = value

2562

3338

except KeyError:

2563

3339

pass

2564

3340

2565

3341

# Clients who has passed its expire date can still be

2566

# enabled if its last checker was successful. Clients

3342

# enabled if its last checker was successful. A Client

2567

3343

# whose checker succeeded before we stored its state is

2568

3344

# assumed to have successfully run all checkers during

2569

3345

# downtime.

2571

3347

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

2572

3348

if not client["last_checked_ok"]:

2573

3349

logger.warning(

2574

"disabling client {0} - Client never "

2575

"performed a successful checker"

2576

.format(client_name))

3350

"disabling client {} - Client never "

3351

"performed a successful checker".format(

3352

client_name))

2577

3353

client["enabled"] = False

2578

3354

elif client["last_checker_status"] != 0:

2579

3355

logger.warning(

2580

"disabling client {0} - Client "

2581

"last checker failed with error code {1}"

2582

.format(client_name,

2583

client["last_checker_status"]))

3356

"disabling client {} - Client last"

3357

" checker failed with error code"

3358

" {}".format(

3359

client_name,

3360

client["last_checker_status"]))

2584

3361

client["enabled"] = False

2585

3362

else:

2586

client["expires"] = (datetime.datetime

2587

.utcnow()

2588

+ client["timeout"])

3363

client["expires"] = (

3364

datetime.datetime.utcnow()

3365

+ client["timeout"])

2589

3366

logger.debug("Last checker succeeded,"

2590

" keeping {0} enabled"

2591

.format(client_name))

3367

" keeping {} enabled".format(

3368

client_name))

2592

3369

try:

2593

client["secret"] = (

2594

pgp.decrypt(client["encrypted_secret"],

2595

client_settings[client_name]

2596

["secret"]))

3370

client["secret"] = pgp.decrypt(

3371

client["encrypted_secret"],

3372

client_settings[client_name]["secret"])

2597

3373

except PGPError:

2598

3374

# If decryption fails, we use secret from new settings

2599

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

2600

.format(client_name))

2601

client["secret"] = (

2602

client_settings[client_name]["secret"])

2603

3375

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

3376

client_name))

3377

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

3378

["secret"])

3379

2604

3380

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

2605

3381

for client_name in (set(old_client_settings)

2606

3382

- set(client_settings)):

2608

3384

for client_name in (set(client_settings)

2609

3385

- set(old_client_settings)):

2610

3386

clients_data[client_name] = client_settings[client_name]

2611

3387

2612

3388

# Create all client objects

2613

for client_name, client in clients_data.iteritems():

3389

for client_name, client in clients_data.items():

2614

3390

tcp_server.clients[client_name] = client_class(

2615

name = client_name, settings = client)

2616

3391

name=client_name,

3392

settings=client,

3393

server_settings=server_settings)

3394

2617

3395

if not tcp_server.clients:

2618

3396

logger.warning("No clients defined")

2619

3397

2620

3398

if not foreground:

2621

3399

if pidfile is not None:

3400

pid = os.getpid()

2622

3401

try:

2623

3402

with pidfile:

2624

pid = os.getpid()

2625

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

3403

print(pid, file=pidfile)

2626

3404

except IOError:

2627

3405

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

2628

3406

pidfilename, pid)

2629

3407

del pidfile

2630

3408

del pidfilename

2631

2632

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

2633

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

2634

3409

3410

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

3411

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3412

lambda: main_loop.quit() and False)

3413

2635

3414

if use_dbus:

2636

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

2637

"se.bsnet.fukt.Mandos"})

2638

class MandosDBusService(DBusObjectWithProperties):

3415

3416

@alternate_dbus_interfaces(

3417

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

3418

class MandosDBusService(DBusObjectWithObjectManager):

2639

3419

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

3420

2640

3421

def __init__(self):

2641

3422

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

3423

2642

3424

_interface = "se.recompile.Mandos"

2643

2644

@dbus_interface_annotations(_interface)

2645

def _foo(self):

2646

return { "org.freedesktop.DBus.Property"

2647

".EmitsChangedSignal":

2648

"false"}

2649

3425

2650

3426

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

2651

3427

def ClientAdded(self, objpath):

2652

3428

"D-Bus signal"

2653

3429

pass

2654

3430

2655

3431

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

2656

def ClientNotFound(self, fingerprint, address):

3432

def ClientNotFound(self, key_id, address):

2657

3433

"D-Bus signal"

2658

3434

pass

2659

3435

3436

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

3437

"true"})

2660

3438

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

2661

3439

def ClientRemoved(self, objpath, name):

2662

3440

"D-Bus signal"

2663

3441

pass

2664

3442

3443

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

3444

"true"})

2665

3445

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

2666

3446

def GetAllClients(self):

2667

3447

"D-Bus method"

2668

return dbus.Array(c.dbus_object_path

2669

for c in

2670

tcp_server.clients.itervalues())

2671

3448

return dbus.Array(c.dbus_object_path for c in

3449

tcp_server.clients.values())

3450

3451

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

3452

"true"})

2672

3453

@dbus.service.method(_interface,

2673

3454

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

2674

3455

def GetAllClientsWithProperties(self):

2675

3456

"D-Bus method"

2676

3457

return dbus.Dictionary(

2677

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

2678

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

3458

{c.dbus_object_path: c.GetAll(

3459

"se.recompile.Mandos.Client")

3460

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

2679

3461

signature="oa{sv}")

2680

3462

2681

3463

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

2682

3464

def RemoveClient(self, object_path):

2683

3465

"D-Bus method"

2684

for c in tcp_server.clients.itervalues():

3466

for c in tcp_server.clients.values():

2685

3467

if c.dbus_object_path == object_path:

2686

3468

del tcp_server.clients[c.name]

2687

3469

c.remove_from_connection()

2688

# Don't signal anything except ClientRemoved

3470

# Don't signal the disabling

2689

3471

c.disable(quiet=True)

2690

# Emit D-Bus signal

2691

self.ClientRemoved(object_path, c.name)

3472

# Emit D-Bus signal for removal

3473

self.client_removed_signal(c)

2692

3474

return

2693

3475

raise KeyError(object_path)

2694

3476

2695

3477

del _interface

2696

3478

3479

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3480

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

3481

def GetManagedObjects(self):

3482

"""D-Bus method"""

3483

return dbus.Dictionary(

3484

{client.dbus_object_path:

3485

dbus.Dictionary(

3486

{interface: client.GetAll(interface)

3487

for interface in

3488

client._get_all_interface_names()})

3489

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

3490

3491

def client_added_signal(self, client):

3492

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

3493

if use_dbus:

3494

# New standard signal

3495

self.InterfacesAdded(

3496

client.dbus_object_path,

3497

dbus.Dictionary(

3498

{interface: client.GetAll(interface)

3499

for interface in

3500

client._get_all_interface_names()}))

3501

# Old signal

3502

self.ClientAdded(client.dbus_object_path)

3503

3504

def client_removed_signal(self, client):

3505

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

3506

if use_dbus:

3507

# New standard signal

3508

self.InterfacesRemoved(

3509

client.dbus_object_path,

3510

client._get_all_interface_names())

3511

# Old signal

3512

self.ClientRemoved(client.dbus_object_path,

3513

client.name)

3514

2697

3515

mandos_dbus_service = MandosDBusService()

2698

3516

3517

# Save modules to variables to exempt the modules from being

3518

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

3519

mp = multiprocessing

3520

wn = wnull

3521

2699

3522

def cleanup():

2700

3523

"Cleanup function; run on exit"

2701

service.cleanup()

2702

2703

multiprocessing.active_children()

3524

if zeroconf:

3525

service.cleanup()

3526

3527

mp.active_children()

3528

wn.close()

2704

3529

if not (tcp_server.clients or client_settings):

2705

3530

return

2706

3531

2707

3532

# Store client before exiting. Secrets are encrypted with key

2708

3533

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

2709

3534

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

2710

3535

clients = {}

2711

3536

with PGPEngine() as pgp:

2712

for client in tcp_server.clients.itervalues():

3537

for client in tcp_server.clients.values():

2713

3538

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

2714

3539

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

2715

3540

key)

2716

3541

client_dict = {}

2717

3542

2718

3543

# A list of attributes that can not be pickled

2719

3544

# + secret.

2720

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

2721

"checker"))

2722

for name, typ in (inspect.getmembers

2723

(dbus.service.Object)):

3545

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

3546

"checker", "server_settings"}

3547

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

3548

.Object):

2724

3549

exclude.add(name)

2725

3550

2726

3551

client_dict["encrypted_secret"] = (client

2727

3552

.encrypted_secret)

2728

3553

for attr in client.client_structure:

2729

3554

if attr not in exclude:

2730

3555

client_dict[attr] = getattr(client, attr)

2731

3556

2732

3557

clients[client.name] = client_dict

2733

3558

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

2734

3559

2735

3560

try:

2736

with (tempfile.NamedTemporaryFile

2737

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

2738

dir=os.path.dirname(stored_state_path),

2739

delete=False)) as stored_state:

2740

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

2741

tempname=stored_state.name

3561

with tempfile.NamedTemporaryFile(

3562

mode='wb',

3563

suffix=".pickle",

3564

prefix='clients-',

3565

dir=os.path.dirname(stored_state_path),

3566

delete=False) as stored_state:

3567

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

3568

protocol=2)

3569

tempname = stored_state.name

2742

3570

os.rename(tempname, stored_state_path)

2743

3571

except (IOError, OSError) as e:

2744

3572

if not debug:

2747

3575

except NameError:

2748

3576

pass

2749

3577

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

2750

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

3578

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

2751

3579

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

2752

3580

else:

2753

3581

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

2754

3582

exc_info=e)

2755

raise e

2756

3583

raise

3584

2757

3585

# Delete all clients, and settings from config

2758

3586

while tcp_server.clients:

2759

3587

name, client = tcp_server.clients.popitem()

2760

3588

if use_dbus:

2761

3589

client.remove_from_connection()

2762

# Don't signal anything except ClientRemoved

3590

# Don't signal the disabling

2763

3591

client.disable(quiet=True)

3592

# Emit D-Bus signal for removal

2764

3593

if use_dbus:

2765

# Emit D-Bus signal

2766

mandos_dbus_service.ClientRemoved(client

2767

.dbus_object_path,

2768

client.name)

3594

mandos_dbus_service.client_removed_signal(client)

2769

3595

client_settings.clear()

2770

3596

2771

3597

atexit.register(cleanup)

2772

2773

for client in tcp_server.clients.itervalues():

3598

3599

for client in tcp_server.clients.values():

2774

3600

if use_dbus:

2775

# Emit D-Bus signal

2776

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3601

# Emit D-Bus signal for adding

3602

mandos_dbus_service.client_added_signal(client)

2777

3603

# Need to initiate checking of clients

2778

3604

if client.enabled:

2779

3605

client.init_checker()

2780

3606

2781

3607

tcp_server.enable()

2782

3608

tcp_server.server_activate()

2783

3609

2784

3610

# Find out what port we got

2785

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

3611

if zeroconf:

3612

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

2786

3613

if use_ipv6:

2787

3614

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

2788

3615

" flowinfo %d, scope_id %d",

2790

3617

else: # IPv4

2791

3618

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

2792

3619

*tcp_server.socket.getsockname())

2793

2794

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

2795

3620

3621

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

3622

2796

3623

try:

2797

# From the Avahi example code

2798

try:

2799

service.activate()

2800

except dbus.exceptions.DBusException as error:

2801

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

2802

cleanup()

2803

sys.exit(1)

2804

# End of Avahi example code

2805

2806

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

2807

lambda *args, **kwargs:

2808

(tcp_server.handle_request

2809

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

2810

3624

if zeroconf:

3625

# From the Avahi example code

3626

try:

3627

service.activate()

3628

except dbus.exceptions.DBusException as error:

3629

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

3630

cleanup()

3631

sys.exit(1)

3632

# End of Avahi example code

3633

3634

GLib.io_add_watch(

3635

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

3636

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3637

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

3638

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

3639

2811

3640

logger.debug("Starting main loop")

2812

3641

main_loop.run()

2813

3642

except AvahiError as error:

2822

3651

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

2823

3652

cleanup()

2824

3653

3654

3655

def should_only_run_tests():

3656

parser = argparse.ArgumentParser(add_help=False)

3657

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

3658

args, unknown_args = parser.parse_known_args()

3659

run_tests = args.check

3660

if run_tests:

3661

# Remove --check argument from sys.argv

3662

sys.argv[1:] = unknown_args

3663

return run_tests

3664

3665

# Add all tests from doctest strings

3666

def load_tests(loader, tests, none):

3667

import doctest

3668

tests.addTests(doctest.DocTestSuite())

3669

return tests

3670

2825

3671

if __name__ == '__main__':

2826

main()

3672

try:

3673

if should_only_run_tests():

3674

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

3675

unittest.main()

3676

else:

3677

main()

3678

finally:

3679

logging.shutdown()