/mandos/trunk : revision 1242

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

78

import collections

79

import codecs

80

import unittest

81

import random

82

import shlex

71

83

72

84

import dbus

73

85

import dbus.service

74

import gobject

75

import avahi

86

import gi

87

from gi.repository import GLib

76

88

from dbus.mainloop.glib import DBusGMainLoop

77

89

import ctypes

78

90

import ctypes.util

79

91

import xml.dom.minidom

80

92

import inspect

81

import GnuPGInterface

82

83

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:

84

122

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

123

except AttributeError:

86

124

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

87

127

from IN import SO_BINDTODEVICE

88

128

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.5.3"

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.14"

92

147

stored_state_file = "clients.pickle"

93

148

94

149

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

150

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

151

syslogger = None

98

152

99

153

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

103

156

except (OSError, AttributeError):

157

104

158

def if_nametoindex(interface):

105

159

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

106

160

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

107

161

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

108

162

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

163

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

164

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

113

165

return interface_index

114

166

115

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

116

184

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

117

185

"""init logger and add loglevel"""

118

186

187

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

119

191

syslogger.setFormatter(logging.Formatter

120

192

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

121

193

' %(message)s'))

122

194

logger.addHandler(syslogger)

123

195

124

196

if debug:

125

197

console = logging.StreamHandler()

126

198

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

136

208

pass

137

209

138

210

139

class PGPEngine(object):

211

class PGPEngine:

140

212

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

213

141

214

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

143

215

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

144

self.gnupg = GnuPGInterface.GnuPG()

145

self.gnupg.options.meta_interactive = False

146

self.gnupg.options.homedir = self.tempdir

147

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

148

'--quiet',

149

'--no-use-agent'])

150

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

151

235

def __enter__(self):

152

236

return self

153

154

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

237

238

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

155

239

self._cleanup()

156

240

return False

157

241

158

242

def __del__(self):

159

243

self._cleanup()

160

244

161

245

def _cleanup(self):

162

246

if self.tempdir is not None:

163

247

# Delete contents of tempdir

164

248

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

165

topdown = False):

249

topdown=False):

166

250

for filename in files:

167

251

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

168

252

for dirname in dirs:

170

254

# Remove tempdir

171

255

os.rmdir(self.tempdir)

172

256

self.tempdir = None

173

257

174

258

def password_encode(self, password):

175

259

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

176

260

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

177

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

178

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

179

269

def encrypt(self, data, password):

180

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

181

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

182

try:

183

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

184

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

185

attach_fhs={'stderr': devnull})

186

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

187

f.write(data)

188

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

189

ciphertext = f.read()

190

proc.wait()

191

except IOError as e:

192

raise PGPError(e)

193

self.gnupg.passphrase = None

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)

194

285

return ciphertext

195

286

196

287

def decrypt(self, data, password):

197

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

198

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

199

try:

200

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

201

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

202

attach_fhs={'stderr': devnull})

203

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

204

f.write(data)

205

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

206

decrypted_plaintext = f.read()

207

proc.wait()

208

except IOError as e:

209

raise PGPError(e)

210

self.gnupg.passphrase = None

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)

211

303

return decrypted_plaintext

212

304

213

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

214

332

class AvahiError(Exception):

215

333

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

216

334

self.value = value

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

335

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

336

**kwargs)

337

220

338

221

339

class AvahiServiceError(AvahiError):

222

340

pass

223

341

342

224

343

class AvahiGroupError(AvahiError):

225

344

pass

226

345

227

346

228

class AvahiService(object):

347

class AvahiService:

229

348

"""An Avahi (Zeroconf) service.

230

349

231

350

Attributes:

232

351

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

233

352

Used to optionally bind to the specified interface.

234

353

name: string; Example: 'Mandos'

235

354

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

236

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

355

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

237

356

port: integer; what port to announce

238

357

TXT: list of strings; TXT record for the service

239

358

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

245

364

server: D-Bus Server

246

365

bus: dbus.SystemBus()

247

366

"""

248

249

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

250

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

251

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

252

protocol = avahi.PROTO_UNSPEC, bus = None):

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

253

379

self.interface = interface

254

380

self.name = name

255

381

self.type = servicetype

264

390

self.server = None

265

391

self.bus = bus

266

392

self.entry_group_state_changed_match = None

267

268

def rename(self):

393

394

def rename(self, remove=True):

269

395

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

270

396

if self.rename_count >= self.max_renames:

271

397

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

272

398

" after %i retries, exiting.",

273

399

self.rename_count)

274

400

raise AvahiServiceError("Too many renames")

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

277

404

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

278

405

self.name)

279

self.remove()

406

if remove:

407

self.remove()

280

408

try:

281

409

self.add()

282

410

except dbus.exceptions.DBusException as error:

283

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

284

self.cleanup()

285

os._exit(1)

286

self.rename_count += 1

287

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

288

420

def remove(self):

289

421

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

290

422

if self.entry_group_state_changed_match is not None:

292

424

self.entry_group_state_changed_match = None

293

425

if self.group is not None:

294

426

self.group.Reset()

295

427

296

428

def add(self):

297

429

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

298

430

self.remove()

315

447

dbus.UInt16(self.port),

316

448

avahi.string_array_to_txt_array(self.TXT))

317

449

self.group.Commit()

318

450

319

451

def entry_group_state_changed(self, state, error):

320

452

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

321

453

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

322

454

323

455

if state == avahi.ENTRY_GROUP_ESTABLISHED:

324

456

logger.debug("Zeroconf service established.")

325

457

elif state == avahi.ENTRY_GROUP_COLLISION:

327

459

self.rename()

328

460

elif state == avahi.ENTRY_GROUP_FAILURE:

329

461

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

330

unicode(error))

331

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

332

.format(error))

333

462

str(error))

463

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

464

334

465

def cleanup(self):

335

466

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

336

467

if self.group is not None:

341

472

pass

342

473

self.group = None

343

474

self.remove()

344

475

345

476

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

346

477

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

347

478

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

348

bad_states = { avahi.SERVER_INVALID:

349

"Zeroconf server invalid",

350

avahi.SERVER_REGISTERING: None,

351

avahi.SERVER_COLLISION:

352

"Zeroconf server name collision",

353

avahi.SERVER_FAILURE:

354

"Zeroconf server failure" }

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

}

355

485

if state in bad_states:

356

486

if bad_states[state] is not None:

357

487

if error is None:

360

490

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

361

491

self.cleanup()

362

492

elif state == avahi.SERVER_RUNNING:

363

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)

364

505

else:

365

506

if error is None:

366

507

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

367

508

else:

368

509

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

369

510

370

511

def activate(self):

371

512

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

372

513

if self.server is None:

376

517

follow_name_owner_changes=True),

377

518

avahi.DBUS_INTERFACE_SERVER)

378

519

self.server.connect_to_signal("StateChanged",

379

self.server_state_changed)

520

self.server_state_changed)

380

521

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

381

522

382

523

383

524

class AvahiServiceToSyslog(AvahiService):

384

def rename(self):

525

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

385

526

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

386

ret = AvahiService.rename(self)

387

syslogger.setFormatter(logging.Formatter

388

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

389

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

390

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

391

532

return ret

392

533

393

534

394

def timedelta_to_milliseconds(td):

395

"Convert a datetime.timedelta() to milliseconds"

396

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

397

+ (td.seconds * 1000)

398

+ (td.microseconds // 1000))

399

400

401

class Client(object):

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

_error_code=_error_code):

666

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

667

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

668

while result < 0:

669

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

670

return _error_code(result)

671

result = func(*arguments)

672

return result

673

674

# Unless otherwise indicated, the function declarations below are

675

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

676

677

# Functions

678

priority_set_direct = _library.gnutls_priority_set_direct

679

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

680

ctypes.POINTER(ctypes.c_char_p)]

681

priority_set_direct.restype = _error_code

682

683

init = _library.gnutls_init

684

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

685

init.restype = _error_code

686

687

set_default_priority = _library.gnutls_set_default_priority

688

set_default_priority.argtypes = [session_t]

689

set_default_priority.restype = _error_code

690

691

record_send = _library.gnutls_record_send

692

record_send.argtypes = [session_t, ctypes.c_void_p,

693

ctypes.c_size_t]

694

record_send.restype = ctypes.c_ssize_t

695

record_send.errcheck = _retry_on_error

696

697

certificate_allocate_credentials = (

698

_library.gnutls_certificate_allocate_credentials)

699

certificate_allocate_credentials.argtypes = [

700

ctypes.POINTER(certificate_credentials_t)]

701

certificate_allocate_credentials.restype = _error_code

702

703

certificate_free_credentials = (

704

_library.gnutls_certificate_free_credentials)

705

certificate_free_credentials.argtypes = [

706

certificate_credentials_t]

707

certificate_free_credentials.restype = None

708

709

handshake_set_private_extensions = (

710

_library.gnutls_handshake_set_private_extensions)

711

handshake_set_private_extensions.argtypes = [session_t,

712

ctypes.c_int]

713

handshake_set_private_extensions.restype = None

714

715

credentials_set = _library.gnutls_credentials_set

716

credentials_set.argtypes = [session_t, credentials_type_t,

717

ctypes.c_void_p]

718

credentials_set.restype = _error_code

719

720

strerror = _library.gnutls_strerror

721

strerror.argtypes = [ctypes.c_int]

722

strerror.restype = ctypes.c_char_p

723

724

certificate_type_get = _library.gnutls_certificate_type_get

725

certificate_type_get.argtypes = [session_t]

726

certificate_type_get.restype = _error_code

727

728

certificate_get_peers = _library.gnutls_certificate_get_peers

729

certificate_get_peers.argtypes = [session_t,

730

ctypes.POINTER(ctypes.c_uint)]

731

certificate_get_peers.restype = ctypes.POINTER(datum_t)

732

733

global_set_log_level = _library.gnutls_global_set_log_level

734

global_set_log_level.argtypes = [ctypes.c_int]

735

global_set_log_level.restype = None

736

737

global_set_log_function = _library.gnutls_global_set_log_function

738

global_set_log_function.argtypes = [log_func]

739

global_set_log_function.restype = None

740

741

deinit = _library.gnutls_deinit

742

deinit.argtypes = [session_t]

743

deinit.restype = None

744

745

handshake = _library.gnutls_handshake

746

handshake.argtypes = [session_t]

747

handshake.restype = _error_code

748

handshake.errcheck = _retry_on_error

749

750

transport_set_ptr = _library.gnutls_transport_set_ptr

751

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

752

transport_set_ptr.restype = None

753

754

bye = _library.gnutls_bye

755

bye.argtypes = [session_t, close_request_t]

756

bye.restype = _error_code

757

bye.errcheck = _retry_on_error

758

759

check_version = _library.gnutls_check_version

760

check_version.argtypes = [ctypes.c_char_p]

761

check_version.restype = ctypes.c_char_p

762

763

_need_version = b"3.3.0"

764

if check_version(_need_version) is None:

765

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

766

.format(_need_version))

767

768

_tls_rawpk_version = b"3.6.6"

769

has_rawpk = bool(check_version(_tls_rawpk_version))

770

771

if has_rawpk:

772

# Types

773

class pubkey_st(ctypes.Structure):

774

_fields = []

775

pubkey_t = ctypes.POINTER(pubkey_st)

776

777

x509_crt_fmt_t = ctypes.c_int

778

779

# All the function declarations below are from

780

# gnutls/abstract.h

781

pubkey_init = _library.gnutls_pubkey_init

782

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

783

pubkey_init.restype = _error_code

784

785

pubkey_import = _library.gnutls_pubkey_import

786

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

787

x509_crt_fmt_t]

788

pubkey_import.restype = _error_code

789

790

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

791

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

792

ctypes.POINTER(ctypes.c_ubyte),

793

ctypes.POINTER(ctypes.c_size_t)]

794

pubkey_get_key_id.restype = _error_code

795

796

pubkey_deinit = _library.gnutls_pubkey_deinit

797

pubkey_deinit.argtypes = [pubkey_t]

798

pubkey_deinit.restype = None

799

else:

800

# All the function declarations below are from

801

# gnutls/openpgp.h

802

803

openpgp_crt_init = _library.gnutls_openpgp_crt_init

804

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

805

openpgp_crt_init.restype = _error_code

806

807

openpgp_crt_import = _library.gnutls_openpgp_crt_import

808

openpgp_crt_import.argtypes = [openpgp_crt_t,

809

ctypes.POINTER(datum_t),

810

openpgp_crt_fmt_t]

811

openpgp_crt_import.restype = _error_code

812

813

openpgp_crt_verify_self = \

814

_library.gnutls_openpgp_crt_verify_self

815

openpgp_crt_verify_self.argtypes = [

816

openpgp_crt_t,

817

ctypes.c_uint,

818

ctypes.POINTER(ctypes.c_uint),

819

]

820

openpgp_crt_verify_self.restype = _error_code

821

822

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

823

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

824

openpgp_crt_deinit.restype = None

825

826

openpgp_crt_get_fingerprint = (

827

_library.gnutls_openpgp_crt_get_fingerprint)

828

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

829

ctypes.c_void_p,

830

ctypes.POINTER(

831

ctypes.c_size_t)]

832

openpgp_crt_get_fingerprint.restype = _error_code

833

834

if check_version(b"3.6.4"):

835

certificate_type_get2 = _library.gnutls_certificate_type_get2

836

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

837

certificate_type_get2.restype = _error_code

838

839

# Remove non-public functions

840

del _error_code, _retry_on_error

841

842

843

def call_pipe(connection, # : multiprocessing.Connection

844

func, *args, **kwargs):

845

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

846

847

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

848

return value on the provided multiprocessing.Connection.

849

"""

850

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

851

connection.close()

852

853

854

class Client:

402

855

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

403

856

404

857

Attributes:

405

858

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

406

859

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

407

860

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

408

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

409

to see if the client lives.

410

'None' if no process is running.

411

checker_callback_tag: a gobject event source tag, or None

861

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

862

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

863

running.

864

checker_callback_tag: a GLib event source tag, or None

412

865

checker_command: string; External command which is run to check

413

866

if client lives. %() expansions are done at

414

867

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

415

868

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

416

checker_initiator_tag: a gobject event source tag, or None

869

checker_initiator_tag: a GLib event source tag, or None

417

870

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

418

871

client_structure: Object describing what attributes a client has

419

872

and is used for storing the client at exit

420

873

current_checker_command: string; current running checker_command

421

disable_initiator_tag: a gobject event source tag, or None

874

disable_initiator_tag: a GLib event source tag, or None

422

875

enabled: bool()

423

876

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

424

uniquely identify the client

877

uniquely identify an OpenPGP client

878

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

879

a client using raw public keys

425

880

host: string; available for use by the checker command

426

881

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

427

882

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

429

884

last_checker_status: integer between 0 and 255 reflecting exit

430

885

status of last checker. -1 reflects crashed

431

886

checker, -2 means no checker completed yet.

887

last_checker_signal: The signal which killed the last checker, if

888

last_checker_status is -1

432

889

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

433

890

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

434

891

D-Bus identifiers

439

896

runtime_expansions: Allowed attributes for runtime expansion.

440

897

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

441

898

disabled, or None

899

server_settings: The server_settings dict from main()

442

900

"""

443

901

444

902

runtime_expansions = ("approval_delay", "approval_duration",

445

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

903

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

446

904

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

447

905

"last_approval_request", "last_checked_ok",

448

906

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

449

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

450

"extended_timeout": "15m",

451

"interval": "2m",

452

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

453

"host": "",

454

"approval_delay": "0s",

455

"approval_duration": "1s",

456

"approved_by_default": "True",

457

"enabled": "True",

458

}

459

460

def timeout_milliseconds(self):

461

"Return the 'timeout' attribute in milliseconds"

462

return timedelta_to_milliseconds(self.timeout)

463

464

def extended_timeout_milliseconds(self):

465

"Return the 'extended_timeout' attribute in milliseconds"

466

return timedelta_to_milliseconds(self.extended_timeout)

467

468

def interval_milliseconds(self):

469

"Return the 'interval' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.interval)

471

472

def approval_delay_milliseconds(self):

473

return timedelta_to_milliseconds(self.approval_delay)

474

907

client_defaults = {

908

"timeout": "PT5M",

909

"extended_timeout": "PT15M",

910

"interval": "PT2M",

911

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

912

"host": "",

913

"approval_delay": "PT0S",

914

"approval_duration": "PT1S",

915

"approved_by_default": "True",

916

"enabled": "True",

917

}

918

475

919

@staticmethod

476

920

def config_parser(config):

477

921

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

484

928

for client_name in config.sections():

485

929

section = dict(config.items(client_name))

486

930

client = settings[client_name] = {}

487

931

488

932

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

489

933

# Reformat values from string types to Python types

490

934

client["approved_by_default"] = config.getboolean(

491

935

client_name, "approved_by_default")

492

936

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

493

937

"enabled")

494

938

939

# Uppercase and remove spaces from key_id and fingerprint

940

# for later comparison purposes with return value from the

941

# key_id() and fingerprint() functions

942

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

943

.replace(" ", ""))

495

944

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

496

945

.replace(" ", ""))

497

946

if "secret" in section:

498

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

947

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

948

.encode("utf-8"),

949

"base64")

499

950

elif "secfile" in section:

500

951

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

501

952

(section["secfile"])),

502

953

"rb") as secfile:

503

954

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

504

955

else:

505

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

956

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

506

957

.format(section))

507

958

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

508

959

client["extended_timeout"] = string_to_delta(

516

967

client["last_approval_request"] = None

517

968

client["last_checked_ok"] = None

518

969

client["last_checker_status"] = -2

519

970

520

971

return settings

521

522

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

972

973

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

523

974

self.name = name

975

if server_settings is None:

976

server_settings = {}

977

self.server_settings = server_settings

524

978

# adding all client settings

525

for setting, value in settings.iteritems():

979

for setting, value in settings.items():

526

980

setattr(self, setting, value)

527

981

528

982

if self.enabled:

529

983

if not hasattr(self, "last_enabled"):

530

984

self.last_enabled = datetime.datetime.utcnow()

534

988

else:

535

989

self.last_enabled = None

536

990

self.expires = None

537

991

538

992

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

539

# Uppercase and remove spaces from fingerprint for later

540

# comparison purposes with return value from the fingerprint()

541

# function

993

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

542

994

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

543

995

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

544

996

datetime.datetime.utcnow())

545

997

546

998

# attributes specific for this server instance

547

999

self.checker = None

548

1000

self.checker_initiator_tag = None

551

1003

self.current_checker_command = None

552

1004

self.approved = None

553

1005

self.approvals_pending = 0

554

self.changedstate = (multiprocessing_manager

555

.Condition(multiprocessing_manager

556

.Lock()))

557

self.client_structure = [attr for attr in

558

self.__dict__.iterkeys()

1006

self.changedstate = multiprocessing_manager.Condition(

1007

multiprocessing_manager.Lock())

1008

self.client_structure = [attr

1009

for attr in self.__dict__.keys()

559

1010

if not attr.startswith("_")]

560

1011

self.client_structure.append("client_structure")

561

562

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

563

lambda obj:

564

isinstance(obj,

565

property)):

1012

1013

for name, t in inspect.getmembers(

1014

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

566

1015

if not name.startswith("_"):

567

1016

self.client_structure.append(name)

568

1017

569

1018

# Send notice to process children that client state has changed

570

1019

def send_changedstate(self):

571

1020

with self.changedstate:

572

1021

self.changedstate.notify_all()

573

1022

574

1023

def enable(self):

575

1024

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

576

1025

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

581

1030

self.last_enabled = datetime.datetime.utcnow()

582

1031

self.init_checker()

583

1032

self.send_changedstate()

584

1033

585

1034

def disable(self, quiet=True):

586

1035

"""Disable this client."""

587

1036

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

589

1038

if not quiet:

590

1039

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

591

1040

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

592

gobject.source_remove(self.disable_initiator_tag)

1041

GLib.source_remove(self.disable_initiator_tag)

593

1042

self.disable_initiator_tag = None

594

1043

self.expires = None

595

1044

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

596

gobject.source_remove(self.checker_initiator_tag)

1045

GLib.source_remove(self.checker_initiator_tag)

597

1046

self.checker_initiator_tag = None

598

1047

self.stop_checker()

599

1048

self.enabled = False

600

1049

if not quiet:

601

1050

self.send_changedstate()

602

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

1051

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

603

1052

return False

604

1053

605

1054

def __del__(self):

606

1055

self.disable()

607

1056

608

1057

def init_checker(self):

609

1058

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

610

1059

# and every interval from then on.

611

1060

if self.checker_initiator_tag is not None:

612

gobject.source_remove(self.checker_initiator_tag)

613

self.checker_initiator_tag = (gobject.timeout_add

614

(self.interval_milliseconds(),

615

self.start_checker))

1061

GLib.source_remove(self.checker_initiator_tag)

1062

self.checker_initiator_tag = GLib.timeout_add(

1063

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

1064

+ 1)),

1065

self.start_checker)

616

1066

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

617

1067

if self.disable_initiator_tag is not None:

618

gobject.source_remove(self.disable_initiator_tag)

619

self.disable_initiator_tag = (gobject.timeout_add

620

(self.timeout_milliseconds(),

621

self.disable))

1068

GLib.source_remove(self.disable_initiator_tag)

1069

self.disable_initiator_tag = GLib.timeout_add(

1070

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

622

1071

# Also start a new checker *right now*.

623

1072

self.start_checker()

624

625

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

1073

1074

def checker_callback(self, source, condition, connection,

1075

command):

626

1076

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

1077

# Read return code from connection (see call_pipe)

1078

returncode = connection.recv()

1079

connection.close()

1080

if self.checker is not None:

1081

self.checker.join()

627

1082

self.checker_callback_tag = None

628

1083

self.checker = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1084

1085

if returncode >= 0:

1086

self.last_checker_status = returncode

1087

self.last_checker_signal = None

631

1088

if self.last_checker_status == 0:

632

1089

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

633

1090

vars(self))

634

1091

self.checked_ok()

635

1092

else:

636

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

637

vars(self))

1093

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

638

1094

else:

639

1095

self.last_checker_status = -1

1096

self.last_checker_signal = -returncode

640

1097

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

641

1098

vars(self))

642

1099

return False

1100

643

1101

def checked_ok(self):

644

1102

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

645

1103

self.last_checked_ok = datetime.datetime.utcnow()

646

1104

self.last_checker_status = 0

1105

self.last_checker_signal = None

647

1106

self.bump_timeout()

648

1107

649

1108

def bump_timeout(self, timeout=None):

650

1109

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

651

1110

if timeout is None:

652

1111

timeout = self.timeout

653

1112

if self.disable_initiator_tag is not None:

654

gobject.source_remove(self.disable_initiator_tag)

1113

GLib.source_remove(self.disable_initiator_tag)

655

1114

self.disable_initiator_tag = None

656

1115

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(timedelta_to_milliseconds

659

(timeout), self.disable))

1116

self.disable_initiator_tag = GLib.timeout_add(

1117

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

660

1118

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

661

1119

662

1120

def need_approval(self):

663

1121

self.last_approval_request = datetime.datetime.utcnow()

664

1122

665

1123

def start_checker(self):

666

1124

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

667

1125

668

1126

If a checker already exists, leave it running and do

669

1127

nothing."""

670

1128

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

675

1133

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

676

1134

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

677

1135

# should be.

678

679

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

680

try:

681

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

682

except (AttributeError, OSError) as error:

683

if (isinstance(error, OSError)

684

and error.errno != errno.ECHILD):

685

raise error

686

else:

687

if pid:

688

logger.warning("Checker was a zombie")

689

gobject.source_remove(self.checker_callback_tag)

690

self.checker_callback(pid, status,

691

self.current_checker_command)

1136

1137

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

1138

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

1139

self.checker.join()

1140

self.checker = None

692

1141

# Start a new checker if needed

693

1142

if self.checker is None:

694

1143

# Escape attributes for the shell

695

escaped_attrs = dict(

696

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

697

for attr in

698

self.runtime_expansions)

1144

escaped_attrs = {

1145

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

1146

for attr in self.runtime_expansions}

699

1147

try:

700

1148

command = self.checker_command % escaped_attrs

701

1149

except TypeError as error:

702

1150

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

703

self.checker_command, exc_info=error)

704

return True # Try again later

1151

self.checker_command,

1152

exc_info=error)

1153

return True # Try again later

705

1154

self.current_checker_command = command

706

try:

707

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

708

command, self.name)

709

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

710

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

711

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

712

# always replaced by /dev/null.)

713

self.checker = subprocess.Popen(command,

714

close_fds=True,

715

shell=True, cwd="/")

716

except OSError as error:

717

logger.error("Failed to start subprocess",

718

exc_info=error)

719

self.checker_callback_tag = (gobject.child_watch_add

720

(self.checker.pid,

721

self.checker_callback,

722

data=command))

723

# The checker may have completed before the gobject

724

# watch was added. Check for this.

725

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

726

if pid:

727

gobject.source_remove(self.checker_callback_tag)

728

self.checker_callback(pid, status, command)

729

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

1155

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

1156

self.name)

1157

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

1158

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

1159

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

1160

# always replaced by /dev/null.)

1161

# The exception is when not debugging but nevertheless

1162

# running in the foreground; use the previously

1163

# created wnull.

1164

popen_args = {"close_fds": True,

1165

"shell": True,

1166

"cwd": "/"}

1167

if (not self.server_settings["debug"]

1168

and self.server_settings["foreground"]):

1169

popen_args.update({"stdout": wnull,

1170

"stderr": wnull})

1171

pipe = multiprocessing.Pipe(duplex=False)

1172

self.checker = multiprocessing.Process(

1173

target=call_pipe,

1174

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

1175

kwargs=popen_args)

1176

self.checker.start()

1177

self.checker_callback_tag = GLib.io_add_watch(

1178

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

1179

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1180

self.checker_callback, pipe[0], command)

1181

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

730

1182

return True

731

1183

732

1184

def stop_checker(self):

733

1185

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

734

1186

if self.checker_callback_tag:

735

gobject.source_remove(self.checker_callback_tag)

1187

GLib.source_remove(self.checker_callback_tag)

736

1188

self.checker_callback_tag = None

737

1189

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

738

1190

return

739

1191

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

740

try:

741

self.checker.terminate()

742

#time.sleep(0.5)

743

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

744

# self.checker.kill()

745

except OSError as error:

746

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

747

raise

1192

self.checker.terminate()

748

1193

self.checker = None

749

1194

750

1195

751

def dbus_service_property(dbus_interface, signature="v",

752

access="readwrite", byte_arrays=False):

1196

def dbus_service_property(dbus_interface,

1197

signature="v",

1198

access="readwrite",

1199

byte_arrays=False):

753

1200

"""Decorators for marking methods of a DBusObjectWithProperties to

754

1201

become properties on the D-Bus.

755

1202

756

1203

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

757

1204

and with one argument by "Set".

758

1205

759

1206

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

760

1207

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

761

1208

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

764

1211

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

765

1212

if byte_arrays and signature != "ay":

766

1213

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

767

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

1214

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

1215

768

1216

def decorator(func):

769

1217

func._dbus_is_property = True

770

1218

func._dbus_interface = dbus_interface

773

1221

func._dbus_name = func.__name__

774

1222

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

775

1223

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

776

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1224

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

777

1225

return func

1226

778

1227

return decorator

779

1228

780

1229

781

1230

def dbus_interface_annotations(dbus_interface):

782

1231

"""Decorator for marking functions returning interface annotations

783

1232

784

1233

Usage:

785

1234

786

1235

@dbus_interface_annotations("org.example.Interface")

787

1236

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

788

1237

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

789

1238

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

790

1239

"false"}

791

1240

"""

1241

792

1242

def decorator(func):

793

1243

func._dbus_is_interface = True

794

1244

func._dbus_interface = dbus_interface

795

1245

func._dbus_name = dbus_interface

796

1246

return func

1247

797

1248

return decorator

798

1249

799

1250

800

1251

def dbus_annotations(annotations):

801

1252

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

802

1253

Usage:

803

1254

1255

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

1256

"org.freedesktop.DBus.Property."

1257

"EmitsChangedSignal": "false"})

804

1258

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

805

1259

access="r")

806

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

807

"org.freedesktop.DBus.Property."

808

"EmitsChangedSignal": "false"})

809

1260

def Property_dbus_property(self):

810

1261

return dbus.Boolean(False)

1262

1263

See also the DBusObjectWithAnnotations class.

811

1264

"""

1265

812

1266

def decorator(func):

813

1267

func._dbus_annotations = annotations

814

1268

return func

1269

815

1270

return decorator

816

1271

817

1272

818

1273

class DBusPropertyException(dbus.exceptions.DBusException):

819

1274

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

820

1275

"""

821

def __unicode__(self):

822

return unicode(str(self))

1276

pass

823

1277

824

1278

825

1279

class DBusPropertyAccessException(DBusPropertyException):

834

1288

pass

835

1289

836

1290

837

class DBusObjectWithProperties(dbus.service.Object):

838

"""A D-Bus object with properties.

839

840

Classes inheriting from this can use the dbus_service_property

841

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

842

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

1291

class DBusObjectWithAnnotations(dbus.service.Object):

1292

"""A D-Bus object with annotations.

1293

1294

Classes inheriting from this can use the dbus_annotations

1295

decorator to add annotations to methods or signals.

843

1296

"""

844

1297

845

1298

@staticmethod

846

1299

def _is_dbus_thing(thing):

847

1300

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

848

1301

849

1302

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

850

1303

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

851

1304

"""

852

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

1305

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

853

1306

False)

854

1307

855

1308

def _get_all_dbus_things(self, thing):

856

1309

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

857

1310

"""

858

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

859

name),

1311

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

860

1312

athing.__get__(self))

861

1313

for cls in self.__class__.__mro__

862

1314

for name, athing in

863

inspect.getmembers(cls,

864

self._is_dbus_thing(thing)))

865

1315

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

1316

1317

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1318

out_signature="s",

1319

path_keyword='object_path',

1320

connection_keyword='connection')

1321

def Introspect(self, object_path, connection):

1322

"""Overloading of standard D-Bus method.

1323

1324

Inserts annotation tags on methods and signals.

1325

"""

1326

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

1327

connection)

1328

try:

1329

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

1330

1331

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

1332

# Add annotation tags

1333

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

1334

for tag in if_tag.getElementsByTagName(typ):

1335

annots = dict()

1336

for name, prop in (self.

1337

_get_all_dbus_things(typ)):

1338

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

1339

and prop._dbus_interface

1340

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

1341

annots.update(getattr(

1342

prop, "_dbus_annotations", {}))

1343

for name, value in annots.items():

1344

ann_tag = document.createElement(

1345

"annotation")

1346

ann_tag.setAttribute("name", name)

1347

ann_tag.setAttribute("value", value)

1348

tag.appendChild(ann_tag)

1349

# Add interface annotation tags

1350

for annotation, value in dict(

1351

itertools.chain.from_iterable(

1352

annotations().items()

1353

for name, annotations

1354

in self._get_all_dbus_things("interface")

1355

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

1356

)).items():

1357

ann_tag = document.createElement("annotation")

1358

ann_tag.setAttribute("name", annotation)

1359

ann_tag.setAttribute("value", value)

1360

if_tag.appendChild(ann_tag)

1361

# Fix argument name for the Introspect method itself

1362

if (if_tag.getAttribute("name")

1363

== dbus.INTROSPECTABLE_IFACE):

1364

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

1365

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

1366

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

1367

if (arg.getAttribute("direction")

1368

== "out"):

1369

arg.setAttribute("name",

1370

"xml_data")

1371

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

1372

document.unlink()

1373

except (AttributeError, xml.dom.DOMException,

1374

xml.parsers.expat.ExpatError) as error:

1375

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

1376

exc_info=error)

1377

return xmlstring

1378

1379

1380

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1381

"""A D-Bus object with properties.

1382

1383

Classes inheriting from this can use the dbus_service_property

1384

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

1385

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

1386

"""

1387

866

1388

def _get_dbus_property(self, interface_name, property_name):

867

1389

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

868

1390

property with the specified name and interface.

869

1391

"""

870

for cls in self.__class__.__mro__:

871

for name, value in (inspect.getmembers

872

(cls,

873

self._is_dbus_thing("property"))):

1392

for cls in self.__class__.__mro__:

1393

for name, value in inspect.getmembers(

1394

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

874

1395

if (value._dbus_name == property_name

875

1396

and value._dbus_interface == interface_name):

876

1397

return value.__get__(self)

877

1398

878

1399

# No such property

879

raise DBusPropertyNotFound(self.dbus_object_path + ":"

880

+ interface_name + "."

881

+ property_name)

882

883

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

1400

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

1401

self.dbus_object_path, interface_name, property_name))

1402

1403

@classmethod

1404

def _get_all_interface_names(cls):

1405

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

1406

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

1407

"_dbus_interface", None)

1408

for x in (inspect.getmro(cls))

1409

for attr in dir(x))

1410

if name is not None)

1411

1412

@dbus.service.method(dbus.PROPERTIES_IFACE,

1413

in_signature="ss",

884

1414

out_signature="v")

885

1415

def Get(self, interface_name, property_name):

886

1416

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

892

1422

if not hasattr(value, "variant_level"):

893

1423

return value

894

1424

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

895

1425

896

1426

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

897

1427

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

898

1428

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

904

1434

# The byte_arrays option is not supported yet on

905

1435

# signatures other than "ay".

906

1436

if prop._dbus_signature != "ay":

907

raise ValueError

908

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

909

for byte in value))

1437

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

1438

"'ay' signature {!r}"

1439

.format(prop._dbus_signature))

1440

value = dbus.ByteArray(bytes(value))

910

1441

prop(value)

911

912

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

1442

1443

@dbus.service.method(dbus.PROPERTIES_IFACE,

1444

in_signature="s",

913

1445

out_signature="a{sv}")

914

1446

def GetAll(self, interface_name):

915

1447

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

916

1448

standard.

917

1449

918

1450

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

919

1451

"""

920

1452

properties = {}

930

1462

if not hasattr(value, "variant_level"):

931

1463

properties[name] = value

932

1464

continue

933

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

934

value.variant_level+1)

1465

properties[name] = type(value)(

1466

value, variant_level=value.variant_level + 1)

935

1467

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

936

1468

1469

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

1470

def PropertiesChanged(self, interface_name, changed_properties,

1471

invalidated_properties):

1472

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

1473

standard.

1474

"""

1475

pass

1476

937

1477

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

938

1478

out_signature="s",

939

1479

path_keyword='object_path',

940

1480

connection_keyword='connection')

941

1481

def Introspect(self, object_path, connection):

942

1482

"""Overloading of standard D-Bus method.

943

1483

944

1484

Inserts property tags and interface annotation tags.

945

1485

"""

946

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

947

connection)

1486

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1487

object_path,

1488

connection)

948

1489

try:

949

1490

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

1491

950

1492

def make_tag(document, name, prop):

951

1493

e = document.createElement("property")

952

1494

e.setAttribute("name", name)

953

1495

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

954

1496

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

955

1497

return e

1498

956

1499

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

957

1500

# Add property tags

958

1501

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

961

1504

if prop._dbus_interface

962

1505

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

963

1506

if_tag.appendChild(tag)

964

# Add annotation tags

965

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

966

for tag in if_tag.getElementsByTagName(typ):

967

annots = dict()

968

for name, prop in (self.

969

_get_all_dbus_things(typ)):

970

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

971

and prop._dbus_interface

972

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

973

annots.update(getattr

974

(prop,

975

"_dbus_annotations",

976

{}))

977

for name, value in annots.iteritems():

978

ann_tag = document.createElement(

979

"annotation")

980

ann_tag.setAttribute("name", name)

981

ann_tag.setAttribute("value", value)

982

tag.appendChild(ann_tag)

983

# Add interface annotation tags

984

for annotation, value in dict(

985

itertools.chain.from_iterable(

986

annotations().iteritems()

987

for name, annotations in

988

self._get_all_dbus_things("interface")

989

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

990

)).iteritems():

991

ann_tag = document.createElement("annotation")

992

ann_tag.setAttribute("name", annotation)

993

ann_tag.setAttribute("value", value)

994

if_tag.appendChild(ann_tag)

1507

# Add annotation tags for properties

1508

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

1509

annots = dict()

1510

for name, prop in self._get_all_dbus_things(

1511

"property"):

1512

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

1513

and prop._dbus_interface

1514

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

1515

annots.update(getattr(

1516

prop, "_dbus_annotations", {}))

1517

for name, value in annots.items():

1518

ann_tag = document.createElement(

1519

"annotation")

1520

ann_tag.setAttribute("name", name)

1521

ann_tag.setAttribute("value", value)

1522

tag.appendChild(ann_tag)

995

1523

# Add the names to the return values for the

996

1524

# "org.freedesktop.DBus.Properties" methods

997

1525

if (if_tag.getAttribute("name")

1016

1544

return xmlstring

1017

1545

1018

1546

1019

def datetime_to_dbus (dt, variant_level=0):

1547

try:

1548

dbus.OBJECT_MANAGER_IFACE

1549

except AttributeError:

1550

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

1551

1552

1553

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1554

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

1555

1556

Classes inheriting from this exposes the standard

1557

GetManagedObjects call and the InterfacesAdded and

1558

InterfacesRemoved signals on the standard

1559

"org.freedesktop.DBus.ObjectManager" interface.

1560

1561

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

1562

manually.

1563

"""

1564

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1565

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

1566

def GetManagedObjects(self):

1567

"""This function must be overridden"""

1568

raise NotImplementedError()

1569

1570

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1571

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

1572

def InterfacesAdded(self, object_path, interfaces_and_properties):

1573

pass

1574

1575

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

1576

def InterfacesRemoved(self, object_path, interfaces):

1577

pass

1578

1579

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1580

out_signature="s",

1581

path_keyword='object_path',

1582

connection_keyword='connection')

1583

def Introspect(self, object_path, connection):

1584

"""Overloading of standard D-Bus method.

1585

1586

Override return argument name of GetManagedObjects to be

1587

"objpath_interfaces_and_properties"

1588

"""

1589

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1590

object_path,

1591

connection)

1592

try:

1593

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

1594

1595

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

1596

# Fix argument name for the GetManagedObjects method

1597

if (if_tag.getAttribute("name")

1598

== dbus.OBJECT_MANAGER_IFACE):

1599

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

1600

if (cn.getAttribute("name")

1601

== "GetManagedObjects"):

1602

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

1603

if (arg.getAttribute("direction")

1604

== "out"):

1605

arg.setAttribute(

1606

"name",

1607

"objpath_interfaces"

1608

"_and_properties")

1609

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

1610

document.unlink()

1611

except (AttributeError, xml.dom.DOMException,

1612

xml.parsers.expat.ExpatError) as error:

1613

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

1614

exc_info=error)

1615

return xmlstring

1616

1617

1618

def datetime_to_dbus(dt, variant_level=0):

1020

1619

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

1021

1620

if dt is None:

1022

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

1023

return dbus.String(dt.isoformat(),

1024

variant_level=variant_level)

1621

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

1622

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

1025

1623

1026

1624

1027

1625

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1029

1627

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

1030

1628

interface names according to the "alt_interface_names" mapping.

1031

1629

Usage:

1032

1033

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

1034

"net.example.AlternateInterface"})

1630

1631

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

1632

"net.example.AlternateInterface"})

1035

1633

class SampleDBusObject(dbus.service.Object):

1036

1634

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

1037

1635

def SampleDBusMethod():

1038

1636

pass

1039

1637

1040

1638

The above "SampleDBusMethod" on "SampleDBusObject" will be

1041

1639

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

1042

1640

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

1043

1641

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

1044

1642

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

1045

1643

1046

1644

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

1047

1645

(from DBusObjectWithProperties) and interfaces (from the

1048

1646

dbus_interface_annotations decorator).

1049

1647

"""

1648

1050

1649

def wrapper(cls):

1051

1650

for orig_interface_name, alt_interface_name in (

1052

alt_interface_names.iteritems()):

1651

alt_interface_names.items()):

1053

1652

attr = {}

1054

1653

interface_names = set()

1055

1654

# Go though all attributes of the class

1057

1656

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

1058

1657

# with the wrong interface name

1059

1658

if (not hasattr(attribute, "_dbus_interface")

1060

or not attribute._dbus_interface

1061

.startswith(orig_interface_name)):

1659

or not attribute._dbus_interface.startswith(

1660

orig_interface_name)):

1062

1661

continue

1063

1662

# Create an alternate D-Bus interface name based on

1064

1663

# the current name

1065

alt_interface = (attribute._dbus_interface

1066

.replace(orig_interface_name,

1067

alt_interface_name))

1664

alt_interface = attribute._dbus_interface.replace(

1665

orig_interface_name, alt_interface_name)

1068

1666

interface_names.add(alt_interface)

1069

1667

# Is this a D-Bus signal?

1070

1668

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

1071

# Extract the original non-method function by

1072

# black magic

1073

nonmethod_func = (dict(

1669

# Extract the original non-method undecorated

1670

# function by black magic

1671

if sys.version_info.major == 2:

1672

nonmethod_func = (dict(

1074

1673

zip(attribute.func_code.co_freevars,

1075

attribute.__closure__))["func"]

1076

.cell_contents)

1674

attribute.__closure__))

1675

["func"].cell_contents)

1676

else:

1677

nonmethod_func = (dict(

1678

zip(attribute.__code__.co_freevars,

1679

attribute.__closure__))

1680

["func"].cell_contents)

1077

1681

# Create a new, but exactly alike, function

1078

1682

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

1079

1683

# with the alternate D-Bus interface name

1080

new_function = (dbus.service.signal

1081

(alt_interface,

1082

attribute._dbus_signature)

1083

(types.FunctionType(

1084

nonmethod_func.func_code,

1085

nonmethod_func.func_globals,

1086

nonmethod_func.func_name,

1087

nonmethod_func.func_defaults,

1088

nonmethod_func.func_closure)))

1684

new_function = copy_function(nonmethod_func)

1685

new_function = (dbus.service.signal(

1686

alt_interface,

1687

attribute._dbus_signature)(new_function))

1089

1688

# Copy annotations, if any

1090

1689

try:

1091

new_function._dbus_annotations = (

1092

dict(attribute._dbus_annotations))

1690

new_function._dbus_annotations = dict(

1691

attribute._dbus_annotations)

1093

1692

except AttributeError:

1094

1693

pass

1694

1095

1695

# Define a creator of a function to call both the

1096

1696

# original and alternate functions, so both the

1097

1697

# original and alternate signals gets sent when

1100

1700

"""This function is a scope container to pass

1101

1701

func1 and func2 to the "call_both" function

1102

1702

outside of its arguments"""

1703

1704

@functools.wraps(func2)

1103

1705

def call_both(*args, **kwargs):

1104

1706

"""This function will emit two D-Bus

1105

1707

signals by calling func1 and func2"""

1106

1708

func1(*args, **kwargs)

1107

1709

func2(*args, **kwargs)

1710

# Make wrapper function look like a D-Bus

1711

# signal

1712

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

1713

if name.startswith("_dbus_"):

1714

setattr(call_both, name, attr)

1715

1108

1716

return call_both

1109

1717

# Create the "call_both" function and add it to

1110

1718

# the class

1115

1723

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

1116

1724

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

1117

1725

# to the class.

1118

attr[attrname] = (dbus.service.method

1119

(alt_interface,

1120

attribute._dbus_in_signature,

1121

attribute._dbus_out_signature)

1122

(types.FunctionType

1123

(attribute.func_code,

1124

attribute.func_globals,

1125

attribute.func_name,

1126

attribute.func_defaults,

1127

attribute.func_closure)))

1726

attr[attrname] = (

1727

dbus.service.method(

1728

alt_interface,

1729

attribute._dbus_in_signature,

1730

attribute._dbus_out_signature)

1731

(copy_function(attribute)))

1128

1732

# Copy annotations, if any

1129

1733

try:

1130

attr[attrname]._dbus_annotations = (

1131

dict(attribute._dbus_annotations))

1734

attr[attrname]._dbus_annotations = dict(

1735

attribute._dbus_annotations)

1132

1736

except AttributeError:

1133

1737

pass

1134

1738

# Is this a D-Bus property?

1137

1741

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

1138

1742

# property with the alternate D-Bus interface

1139

1743

# name. Add it to the class.

1140

attr[attrname] = (dbus_service_property

1141

(alt_interface,

1142

attribute._dbus_signature,

1143

attribute._dbus_access,

1144

attribute

1145

._dbus_get_args_options

1146

["byte_arrays"])

1147

(types.FunctionType

1148

(attribute.func_code,

1149

attribute.func_globals,

1150

attribute.func_name,

1151

attribute.func_defaults,

1152

attribute.func_closure)))

1744

attr[attrname] = (dbus_service_property(

1745

alt_interface, attribute._dbus_signature,

1746

attribute._dbus_access,

1747

attribute._dbus_get_args_options

1748

["byte_arrays"])

1749

(copy_function(attribute)))

1153

1750

# Copy annotations, if any

1154

1751

try:

1155

attr[attrname]._dbus_annotations = (

1156

dict(attribute._dbus_annotations))

1752

attr[attrname]._dbus_annotations = dict(

1753

attribute._dbus_annotations)

1157

1754

except AttributeError:

1158

1755

pass

1159

1756

# Is this a D-Bus interface?

1162

1759

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

1163

1760

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

1164

1761

# to the class.

1165

attr[attrname] = (dbus_interface_annotations

1166

(alt_interface)

1167

(types.FunctionType

1168

(attribute.func_code,

1169

attribute.func_globals,

1170

attribute.func_name,

1171

attribute.func_defaults,

1172

attribute.func_closure)))

1762

attr[attrname] = (

1763

dbus_interface_annotations(alt_interface)

1764

(copy_function(attribute)))

1173

1765

if deprecate:

1174

1766

# Deprecate all alternate interfaces

1175

iname="_AlternateDBusNames_interface_annotation{0}"

1767

iname = "_AlternateDBusNames_interface_annotation{}"

1176

1768

for interface_name in interface_names:

1769

1177

1770

@dbus_interface_annotations(interface_name)

1178

1771

def func(self):

1179

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

1180

"true" }

1772

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

1773

"true"}

1181

1774

# Find an unused name

1182

1775

for aname in (iname.format(i)

1183

1776

for i in itertools.count()):

1187

1780

if interface_names:

1188

1781

# Replace the class with a new subclass of it with

1189

1782

# methods, signals, etc. as created above.

1190

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

1191

(cls,), attr)

1783

if sys.version_info.major == 2:

1784

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

1785

(cls, ), attr)

1786

else:

1787

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

1788

(cls, ), attr)

1192

1789

return cls

1790

1193

1791

return wrapper

1194

1792

1195

1793

1196

1794

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

1197

"se.bsnet.fukt.Mandos"})

1795

"se.bsnet.fukt.Mandos"})

1198

1796

class ClientDBus(Client, DBusObjectWithProperties):

1199

1797

"""A Client class using D-Bus

1200

1798

1201

1799

Attributes:

1202

1800

dbus_object_path: dbus.ObjectPath

1203

1801

bus: dbus.SystemBus()

1204

1802

"""

1205

1803

1206

1804

runtime_expansions = (Client.runtime_expansions

1207

+ ("dbus_object_path",))

1208

1805

+ ("dbus_object_path", ))

1806

1807

_interface = "se.recompile.Mandos.Client"

1808

1209

1809

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

1210

1211

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

1810

1811

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

1212

1812

self.bus = bus

1213

1813

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

1214

1814

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

1215

1815

# the D-Bus

1216

client_object_name = unicode(self.name).translate(

1816

client_object_name = str(self.name).translate(

1217

1817

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

1218

1818

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

1219

self.dbus_object_path = (dbus.ObjectPath

1220

("/clients/" + client_object_name))

1819

self.dbus_object_path = dbus.ObjectPath(

1820

"/clients/" + client_object_name)

1221

1821

DBusObjectWithProperties.__init__(self, self.bus,

1222

1822

self.dbus_object_path)

1223

1224

def notifychangeproperty(transform_func,

1225

dbus_name, type_func=lambda x: x,

1226

variant_level=1):

1823

1824

def notifychangeproperty(transform_func, dbus_name,

1825

type_func=lambda x: x,

1826

variant_level=1,

1827

invalidate_only=False,

1828

_interface=_interface):

1227

1829

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

1228

1830

its changes to DBus.

1229

1831

1230

1832

transform_fun: Function that takes a value and a variant_level

1231

1833

and transforms it to a D-Bus type.

1232

1834

dbus_name: D-Bus name of the variable

1234

1836

to the D-Bus. Default: no transform

1235

1837

variant_level: D-Bus variant level. Default: 1

1236

1838

"""

1237

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

1839

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

1840

1238

1841

def setter(self, value):

1239

1842

if hasattr(self, "dbus_object_path"):

1240

1843

if (not hasattr(self, attrname) or

1241

1844

type_func(getattr(self, attrname, None))

1242

1845

!= type_func(value)):

1243

dbus_value = transform_func(type_func(value),

1244

variant_level

1245

=variant_level)

1246

self.PropertyChanged(dbus.String(dbus_name),

1247

dbus_value)

1846

if invalidate_only:

1847

self.PropertiesChanged(

1848

_interface, dbus.Dictionary(),

1849

dbus.Array((dbus_name, )))

1850

else:

1851

dbus_value = transform_func(

1852

type_func(value),

1853

variant_level=variant_level)

1854

self.PropertyChanged(dbus.String(dbus_name),

1855

dbus_value)

1856

self.PropertiesChanged(

1857

_interface,

1858

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

1859

dbus_value}),

1860

dbus.Array())

1248

1861

setattr(self, attrname, value)

1249

1862

1250

1863

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

1251

1864

1252

1865

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1253

1866

approvals_pending = notifychangeproperty(dbus.Boolean,

1254

1867

"ApprovalPending",

1255

type_func = bool)

1868

type_func=bool)

1256

1869

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

1257

1870

last_enabled = notifychangeproperty(datetime_to_dbus,

1258

1871

"LastEnabled")

1259

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

1260

type_func = lambda checker:

1261

checker is not None)

1872

checker = notifychangeproperty(

1873

dbus.Boolean, "CheckerRunning",

1874

type_func=lambda checker: checker is not None)

1262

1875

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1263

1876

"LastCheckedOK")

1264

1877

last_checker_status = notifychangeproperty(dbus.Int16,

1267

1880

datetime_to_dbus, "LastApprovalRequest")

1268

1881

approved_by_default = notifychangeproperty(dbus.Boolean,

1269

1882

"ApprovedByDefault")

1270

approval_delay = notifychangeproperty(dbus.UInt64,

1271

"ApprovalDelay",

1272

type_func =

1273

timedelta_to_milliseconds)

1883

approval_delay = notifychangeproperty(

1884

dbus.UInt64, "ApprovalDelay",

1885

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

1274

1886

approval_duration = notifychangeproperty(

1275

1887

dbus.UInt64, "ApprovalDuration",

1276

type_func = timedelta_to_milliseconds)

1888

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

1277

1889

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

1278

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

1279

type_func =

1280

timedelta_to_milliseconds)

1890

timeout = notifychangeproperty(

1891

dbus.UInt64, "Timeout",

1892

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

1281

1893

extended_timeout = notifychangeproperty(

1282

1894

dbus.UInt64, "ExtendedTimeout",

1283

type_func = timedelta_to_milliseconds)

1284

interval = notifychangeproperty(dbus.UInt64,

1285

"Interval",

1286

type_func =

1287

timedelta_to_milliseconds)

1895

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

1896

interval = notifychangeproperty(

1897

dbus.UInt64, "Interval",

1898

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

1288

1899

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

1289

1900

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

1901

invalidate_only=True)

1902

1290

1903

del notifychangeproperty

1291

1904

1292

1905

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

1293

1906

try:

1294

1907

self.remove_from_connection()

1297

1910

if hasattr(DBusObjectWithProperties, "__del__"):

1298

1911

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

1299

1912

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

1300

1301

def checker_callback(self, pid, condition, command,

1302

*args, **kwargs):

1303

self.checker_callback_tag = None

1304

self.checker = None

1305

if os.WIFEXITED(condition):

1306

exitstatus = os.WEXITSTATUS(condition)

1913

1914

def checker_callback(self, source, condition,

1915

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

1916

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

1917

connection, command, *args,

1918

**kwargs)

1919

exitstatus = self.last_checker_status

1920

if exitstatus >= 0:

1307

1921

# Emit D-Bus signal

1308

1922

self.CheckerCompleted(dbus.Int16(exitstatus),

1309

dbus.Int64(condition),

1923

# This is specific to GNU libC

1924

dbus.Int64(exitstatus << 8),

1310

1925

dbus.String(command))

1311

1926

else:

1312

1927

# Emit D-Bus signal

1313

1928

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

1314

dbus.Int64(condition),

1929

dbus.Int64(

1930

# This is specific to GNU libC

1931

(exitstatus << 8)

1932

| self.last_checker_signal),

1315

1933

dbus.String(command))

1316

1317

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

1318

*args, **kwargs)

1319

1934

return ret

1935

1320

1936

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

1321

old_checker = self.checker

1322

if self.checker is not None:

1323

old_checker_pid = self.checker.pid

1324

else:

1325

old_checker_pid = None

1937

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

1326

1938

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

1327

1939

# Only if new checker process was started

1328

1940

if (self.checker is not None

1330

1942

# Emit D-Bus signal

1331

1943

self.CheckerStarted(self.current_checker_command)

1332

1944

return r

1333

1945

1334

1946

def _reset_approved(self):

1335

1947

self.approved = None

1336

1948

return False

1337

1949

1338

1950

def approve(self, value=True):

1339

1951

self.approved = value

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1952

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

1953

* 1000), self._reset_approved)

1343

1954

self.send_changedstate()

1344

1345

## D-Bus methods, signals & properties

1346

_interface = "se.recompile.Mandos.Client"

1347

1348

## Interfaces

1349

1350

@dbus_interface_annotations(_interface)

1351

def _foo(self):

1352

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

1353

"false"}

1354

1355

## Signals

1356

1955

1956

# D-Bus methods, signals & properties

1957

1958

# Interfaces

1959

1960

# Signals

1961

1357

1962

# CheckerCompleted - signal

1358

1963

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

1359

1964

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

1360

1965

"D-Bus signal"

1361

1966

pass

1362

1967

1363

1968

# CheckerStarted - signal

1364

1969

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

1365

1970

def CheckerStarted(self, command):

1366

1971

"D-Bus signal"

1367

1972

pass

1368

1973

1369

1974

# PropertyChanged - signal

1975

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

1370

1976

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

1371

1977

def PropertyChanged(self, property, value):

1372

1978

"D-Bus signal"

1373

1979

pass

1374

1980

1375

1981

# GotSecret - signal

1376

1982

@dbus.service.signal(_interface)

1377

1983

def GotSecret(self):

1380

1986

server to mandos-client

1381

1987

"""

1382

1988

pass

1383

1989

1384

1990

# Rejected - signal

1385

1991

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

1386

1992

def Rejected(self, reason):

1387

1993

"D-Bus signal"

1388

1994

pass

1389

1995

1390

1996

# NeedApproval - signal

1391

1997

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

1392

1998

def NeedApproval(self, timeout, default):

1393

1999

"D-Bus signal"

1394

2000

return self.need_approval()

1395

1396

## Methods

1397

2001

2002

# Methods

2003

1398

2004

# Approve - method

1399

2005

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

1400

2006

def Approve(self, value):

1401

2007

self.approve(value)

1402

2008

1403

2009

# CheckedOK - method

1404

2010

@dbus.service.method(_interface)

1405

2011

def CheckedOK(self):

1406

2012

self.checked_ok()

1407

2013

1408

2014

# Enable - method

2015

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

1409

2016

@dbus.service.method(_interface)

1410

2017

def Enable(self):

1411

2018

"D-Bus method"

1412

2019

self.enable()

1413

2020

1414

2021

# StartChecker - method

2022

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

1415

2023

@dbus.service.method(_interface)

1416

2024

def StartChecker(self):

1417

2025

"D-Bus method"

1418

2026

self.start_checker()

1419

2027

1420

2028

# Disable - method

2029

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

1421

2030

@dbus.service.method(_interface)

1422

2031

def Disable(self):

1423

2032

"D-Bus method"

1424

2033

self.disable()

1425

2034

1426

2035

# StopChecker - method

2036

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

1427

2037

@dbus.service.method(_interface)

1428

2038

def StopChecker(self):

1429

2039

self.stop_checker()

1430

1431

## Properties

1432

2040

2041

# Properties

2042

1433

2043

# ApprovalPending - property

1434

2044

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

1435

2045

def ApprovalPending_dbus_property(self):

1436

2046

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

1437

2047

1438

2048

# ApprovedByDefault - property

1439

@dbus_service_property(_interface, signature="b",

2049

@dbus_service_property(_interface,

2050

signature="b",

1440

2051

access="readwrite")

1441

2052

def ApprovedByDefault_dbus_property(self, value=None):

1442

2053

if value is None: # get

1443

2054

return dbus.Boolean(self.approved_by_default)

1444

2055

self.approved_by_default = bool(value)

1445

2056

1446

2057

# ApprovalDelay - property

1447

@dbus_service_property(_interface, signature="t",

2058

@dbus_service_property(_interface,

2059

signature="t",

1448

2060

access="readwrite")

1449

2061

def ApprovalDelay_dbus_property(self, value=None):

1450

2062

if value is None: # get

1451

return dbus.UInt64(self.approval_delay_milliseconds())

2063

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

2064

* 1000)

1452

2065

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

1453

2066

1454

2067

# ApprovalDuration - property

1455

@dbus_service_property(_interface, signature="t",

2068

@dbus_service_property(_interface,

2069

signature="t",

1456

2070

access="readwrite")

1457

2071

def ApprovalDuration_dbus_property(self, value=None):

1458

2072

if value is None: # get

1459

return dbus.UInt64(timedelta_to_milliseconds(

1460

self.approval_duration))

2073

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

2074

* 1000)

1461

2075

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

1462

2076

1463

2077

# Name - property

2078

@dbus_annotations(

2079

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

1464

2080

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

1465

2081

def Name_dbus_property(self):

1466

2082

return dbus.String(self.name)

1467

2083

2084

# KeyID - property

2085

@dbus_annotations(

2086

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

2087

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

2088

def KeyID_dbus_property(self):

2089

return dbus.String(self.key_id)

2090

1468

2091

# Fingerprint - property

2092

@dbus_annotations(

2093

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

1469

2094

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

1470

2095

def Fingerprint_dbus_property(self):

1471

2096

return dbus.String(self.fingerprint)

1472

2097

1473

2098

# Host - property

1474

@dbus_service_property(_interface, signature="s",

2099

@dbus_service_property(_interface,

2100

signature="s",

1475

2101

access="readwrite")

1476

2102

def Host_dbus_property(self, value=None):

1477

2103

if value is None: # get

1478

2104

return dbus.String(self.host)

1479

self.host = unicode(value)

1480

2105

self.host = str(value)

2106

1481

2107

# Created - property

2108

@dbus_annotations(

2109

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

1482

2110

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

1483

2111

def Created_dbus_property(self):

1484

2112

return datetime_to_dbus(self.created)

1485

2113

1486

2114

# LastEnabled - property

1487

2115

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

1488

2116

def LastEnabled_dbus_property(self):

1489

2117

return datetime_to_dbus(self.last_enabled)

1490

2118

1491

2119

# Enabled - property

1492

@dbus_service_property(_interface, signature="b",

2120

@dbus_service_property(_interface,

2121

signature="b",

1493

2122

access="readwrite")

1494

2123

def Enabled_dbus_property(self, value=None):

1495

2124

if value is None: # get

1498

2127

self.enable()

1499

2128

else:

1500

2129

self.disable()

1501

2130

1502

2131

# LastCheckedOK - property

1503

@dbus_service_property(_interface, signature="s",

2132

@dbus_service_property(_interface,

2133

signature="s",

1504

2134

access="readwrite")

1505

2135

def LastCheckedOK_dbus_property(self, value=None):

1506

2136

if value is not None:

1507

2137

self.checked_ok()

1508

2138

return

1509

2139

return datetime_to_dbus(self.last_checked_ok)

1510

2140

1511

2141

# LastCheckerStatus - property

1512

@dbus_service_property(_interface, signature="n",

1513

access="read")

2142

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

1514

2143

def LastCheckerStatus_dbus_property(self):

1515

2144

return dbus.Int16(self.last_checker_status)

1516

2145

1517

2146

# Expires - property

1518

2147

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

1519

2148

def Expires_dbus_property(self):

1520

2149

return datetime_to_dbus(self.expires)

1521

2150

1522

2151

# LastApprovalRequest - property

1523

2152

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

1524

2153

def LastApprovalRequest_dbus_property(self):

1525

2154

return datetime_to_dbus(self.last_approval_request)

1526

2155

1527

2156

# Timeout - property

1528

@dbus_service_property(_interface, signature="t",

2157

@dbus_service_property(_interface,

2158

signature="t",

1529

2159

access="readwrite")

1530

2160

def Timeout_dbus_property(self, value=None):

1531

2161

if value is None: # get

1532

return dbus.UInt64(self.timeout_milliseconds())

2162

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

1533

2163

old_timeout = self.timeout

1534

2164

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

1535

2165

# Reschedule disabling

1543

2173

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

1544

2174

is None):

1545

2175

return

1546

gobject.source_remove(self.disable_initiator_tag)

1547

self.disable_initiator_tag = (

1548

gobject.timeout_add(

1549

timedelta_to_milliseconds(self.expires - now),

1550

self.disable))

1551

2176

GLib.source_remove(self.disable_initiator_tag)

2177

self.disable_initiator_tag = GLib.timeout_add(

2178

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

2179

self.disable)

2180

1552

2181

# ExtendedTimeout - property

1553

@dbus_service_property(_interface, signature="t",

2182

@dbus_service_property(_interface,

2183

signature="t",

1554

2184

access="readwrite")

1555

2185

def ExtendedTimeout_dbus_property(self, value=None):

1556

2186

if value is None: # get

1557

return dbus.UInt64(self.extended_timeout_milliseconds())

2187

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

2188

* 1000)

1558

2189

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

1559

2190

1560

2191

# Interval - property

1561

@dbus_service_property(_interface, signature="t",

2192

@dbus_service_property(_interface,

2193

signature="t",

1562

2194

access="readwrite")

1563

2195

def Interval_dbus_property(self, value=None):

1564

2196

if value is None: # get

1565

return dbus.UInt64(self.interval_milliseconds())

2197

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

1566

2198

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

1567

2199

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

1568

2200

return

1569

2201

if self.enabled:

1570

2202

# Reschedule checker run

1571

gobject.source_remove(self.checker_initiator_tag)

1572

self.checker_initiator_tag = (gobject.timeout_add

1573

(value, self.start_checker))

1574

self.start_checker() # Start one now, too

1575

2203

GLib.source_remove(self.checker_initiator_tag)

2204

self.checker_initiator_tag = GLib.timeout_add(

2205

value, self.start_checker)

2206

self.start_checker() # Start one now, too

2207

1576

2208

# Checker - property

1577

@dbus_service_property(_interface, signature="s",

2209

@dbus_service_property(_interface,

2210

signature="s",

1578

2211

access="readwrite")

1579

2212

def Checker_dbus_property(self, value=None):

1580

2213

if value is None: # get

1581

2214

return dbus.String(self.checker_command)

1582

self.checker_command = unicode(value)

1583

2215

self.checker_command = str(value)

2216

1584

2217

# CheckerRunning - property

1585

@dbus_service_property(_interface, signature="b",

2218

@dbus_service_property(_interface,

2219

signature="b",

1586

2220

access="readwrite")

1587

2221

def CheckerRunning_dbus_property(self, value=None):

1588

2222

if value is None: # get

1591

2225

self.start_checker()

1592

2226

else:

1593

2227

self.stop_checker()

1594

2228

1595

2229

# ObjectPath - property

2230

@dbus_annotations(

2231

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

2232

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

1596

2233

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

1597

2234

def ObjectPath_dbus_property(self):

1598

return self.dbus_object_path # is already a dbus.ObjectPath

1599

2235

return self.dbus_object_path # is already a dbus.ObjectPath

2236

1600

2237

# Secret = property

1601

@dbus_service_property(_interface, signature="ay",

1602

access="write", byte_arrays=True)

2238

@dbus_annotations(

2239

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

2240

"invalidates"})

2241

@dbus_service_property(_interface,

2242

signature="ay",

2243

access="write",

2244

byte_arrays=True)

1603

2245

def Secret_dbus_property(self, value):

1604

self.secret = str(value)

1605

2246

self.secret = bytes(value)

2247

1606

2248

del _interface

1607

2249

1608

2250

1609

class ProxyClient(object):

1610

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

2251

class ProxyClient:

2252

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

1611

2253

self._pipe = child_pipe

1612

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

2254

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

1613

2255

if not self._pipe.recv():

1614

raise KeyError()

1615

2256

raise KeyError(key_id or fpr)

2257

1616

2258

def __getattribute__(self, name):

1617

2259

if name == '_pipe':

1618

2260

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

1621

2263

if data[0] == 'data':

1622

2264

return data[1]

1623

2265

if data[0] == 'function':

2266

1624

2267

def func(*args, **kwargs):

1625

2268

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

1626

2269

return self._pipe.recv()[1]

2270

1627

2271

return func

1628

2272

1629

2273

def __setattr__(self, name, value):

1630

2274

if name == '_pipe':

1631

2275

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

1634

2278

1635

2279

class ClientHandler(socketserver.BaseRequestHandler, object):

1636

2280

"""A class to handle client connections.

1637

2281

1638

2282

Instantiated once for each connection to handle it.

1639

2283

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

1640

2284

1641

2285

def handle(self):

1642

2286

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

1643

2287

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

1644

unicode(self.client_address))

2288

str(self.client_address))

1645

2289

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

1646

2290

self.server.child_pipe.fileno())

1647

1648

session = (gnutls.connection

1649

.ClientSession(self.request,

1650

gnutls.connection

1651

.X509Credentials()))

1652

1653

# Note: gnutls.connection.X509Credentials is really a

1654

# generic GnuTLS certificate credentials object so long as

1655

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

1656

# here despite using OpenPGP certificates.

1657

1658

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

1659

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

1660

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

1661

# "+DHE-DSS"))

2291

2292

session = gnutls.ClientSession(self.request)

2293

2294

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

2295

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

2296

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

2297

# "+DHE-DSS"))

1662

2298

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

1663

2299

priority = self.server.gnutls_priority

1664

2300

if priority is None:

1665

2301

priority = "NORMAL"

1666

(gnutls.library.functions

1667

.gnutls_priority_set_direct(session._c_object,

1668

priority, None))

1669

2302

gnutls.priority_set_direct(session._c_object,

2303

priority.encode("utf-8"),

2304

None)

2305

1670

2306

# Start communication using the Mandos protocol

1671

2307

# Get protocol number

1672

2308

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

1673

2309

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

1674

2310

try:

1675

2311

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

1676

raise RuntimeError

2312

raise RuntimeError(line)

1677

2313

except (ValueError, IndexError, RuntimeError) as error:

1678

2314

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

1679

2315

return

1680

2316

1681

2317

# Start GnuTLS connection

1682

2318

try:

1683

2319

session.handshake()

1684

except gnutls.errors.GNUTLSError as error:

2320

except gnutls.Error as error:

1685

2321

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

1686

2322

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

1687

2323

# established. Just abandon the request.

1688

2324

return

1689

2325

logger.debug("Handshake succeeded")

1690

2326

1691

2327

approval_required = False

1692

2328

try:

1693

try:

1694

fpr = self.fingerprint(self.peer_certificate

1695

(session))

1696

except (TypeError,

1697

gnutls.errors.GNUTLSError) as error:

1698

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

1699

return

1700

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

1701

1702

try:

1703

client = ProxyClient(child_pipe, fpr,

2329

if gnutls.has_rawpk:

2330

fpr = b""

2331

try:

2332

key_id = self.key_id(

2333

self.peer_certificate(session))

2334

except (TypeError, gnutls.Error) as error:

2335

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

2336

return

2337

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

2338

2339

else:

2340

key_id = b""

2341

try:

2342

fpr = self.fingerprint(

2343

self.peer_certificate(session))

2344

except (TypeError, gnutls.Error) as error:

2345

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

2346

return

2347

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

2348

2349

try:

2350

client = ProxyClient(child_pipe, key_id, fpr,

1704

2351

self.client_address)

1705

2352

except KeyError:

1706

2353

return

1707

2354

1708

2355

if client.approval_delay:

1709

2356

delay = client.approval_delay

1710

2357

client.approvals_pending += 1

1711

2358

approval_required = True

1712

2359

1713

2360

while True:

1714

2361

if not client.enabled:

1715

2362

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

1716

client.name)

2363

client.name)

1717

2364

if self.server.use_dbus:

1718

2365

# Emit D-Bus signal

1719

2366

client.Rejected("Disabled")

1720

2367

return

1721

2368

1722

2369

if client.approved or not client.approval_delay:

1723

#We are approved or approval is disabled

2370

# We are approved or approval is disabled

1724

2371

break

1725

2372

elif client.approved is None:

1726

2373

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

1728

2375

if self.server.use_dbus:

1729

2376

# Emit D-Bus signal

1730

2377

client.NeedApproval(

1731

client.approval_delay_milliseconds(),

1732

client.approved_by_default)

2378

client.approval_delay.total_seconds()

2379

* 1000, client.approved_by_default)

1733

2380

else:

1734

2381

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

1735

2382

client.name)

1737

2384

# Emit D-Bus signal

1738

2385

client.Rejected("Denied")

1739

2386

return

1740

1741

#wait until timeout or approved

2387

2388

# wait until timeout or approved

1742

2389

time = datetime.datetime.now()

1743

2390

client.changedstate.acquire()

1744

client.changedstate.wait(

1745

float(timedelta_to_milliseconds(delay)

1746

/ 1000))

2391

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

1747

2392

client.changedstate.release()

1748

2393

time2 = datetime.datetime.now()

1749

2394

if (time2 - time) >= delay:

1759

2404

break

1760

2405

else:

1761

2406

delay -= time2 - time

1762

1763

sent_size = 0

1764

while sent_size < len(client.secret):

1765

try:

1766

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

1767

except gnutls.errors.GNUTLSError as error:

1768

logger.warning("gnutls send failed",

1769

exc_info=error)

1770

return

1771

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

1772

sent, len(client.secret)

1773

- (sent_size + sent))

1774

sent_size += sent

1775

2407

2408

try:

2409

session.send(client.secret)

2410

except gnutls.Error as error:

2411

logger.warning("gnutls send failed",

2412

exc_info=error)

2413

return

2414

1776

2415

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

1777

2416

# bump the timeout using extended_timeout

1778

2417

client.bump_timeout(client.extended_timeout)

1779

2418

if self.server.use_dbus:

1780

2419

# Emit D-Bus signal

1781

2420

client.GotSecret()

1782

2421

1783

2422

finally:

1784

2423

if approval_required:

1785

2424

client.approvals_pending -= 1

1786

2425

try:

1787

2426

session.bye()

1788

except gnutls.errors.GNUTLSError as error:

2427

except gnutls.Error as error:

1789

2428

logger.warning("GnuTLS bye failed",

1790

2429

exc_info=error)

1791

2430

1792

2431

@staticmethod

1793

2432

def peer_certificate(session):

1794

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

1795

# If not an OpenPGP certificate...

1796

if (gnutls.library.functions

1797

.gnutls_certificate_type_get(session._c_object)

1798

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1799

# ...do the normal thing

1800

return session.peer_certificate

2433

"Return the peer's certificate as a bytestring"

2434

try:

2435

cert_type = gnutls.certificate_type_get2(session._c_object,

2436

gnutls.CTYPE_PEERS)

2437

except AttributeError:

2438

cert_type = gnutls.certificate_type_get(session._c_object)

2439

if gnutls.has_rawpk:

2440

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2441

else:

2442

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2443

# If not a valid certificate type...

2444

if cert_type not in valid_cert_types:

2445

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

2446

valid_cert_types)

2447

# ...return invalid data

2448

return b""

1801

2449

list_size = ctypes.c_uint(1)

1802

cert_list = (gnutls.library.functions

1803

.gnutls_certificate_get_peers

2450

cert_list = (gnutls.certificate_get_peers

1804

2451

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

1805

2452

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

1806

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

1807

" certificate")

2453

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

1808

2454

if list_size.value == 0:

1809

2455

return None

1810

2456

cert = cert_list[0]

1811

2457

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

1812

2458

2459

@staticmethod

2460

def key_id(certificate):

2461

"Convert a certificate bytestring to a hexdigit key ID"

2462

# New GnuTLS "datum" with the public key

2463

datum = gnutls.datum_t(

2464

ctypes.cast(ctypes.c_char_p(certificate),

2465

ctypes.POINTER(ctypes.c_ubyte)),

2466

ctypes.c_uint(len(certificate)))

2467

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

2468

# New empty GnuTLS certificate

2469

pubkey = gnutls.pubkey_t()

2470

gnutls.pubkey_init(ctypes.byref(pubkey))

2471

# Import the raw public key into the certificate

2472

gnutls.pubkey_import(pubkey,

2473

ctypes.byref(datum),

2474

gnutls.X509_FMT_DER)

2475

# New buffer for the key ID

2476

buf = ctypes.create_string_buffer(32)

2477

buf_len = ctypes.c_size_t(len(buf))

2478

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

2479

gnutls.pubkey_get_key_id(

2480

pubkey,

2481

gnutls.KEYID_USE_SHA256,

2482

ctypes.cast(ctypes.byref(buf),

2483

ctypes.POINTER(ctypes.c_ubyte)),

2484

ctypes.byref(buf_len))

2485

# Deinit the certificate

2486

gnutls.pubkey_deinit(pubkey)

2487

2488

# Convert the buffer to a Python bytestring

2489

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

2490

# Convert the bytestring to hexadecimal notation

2491

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

2492

return hex_key_id

2493

1813

2494

@staticmethod

1814

2495

def fingerprint(openpgp):

1815

2496

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1816

2497

# New GnuTLS "datum" with the OpenPGP public key

1817

datum = (gnutls.library.types

1818

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

1819

ctypes.POINTER

1820

(ctypes.c_ubyte)),

1821

ctypes.c_uint(len(openpgp))))

2498

datum = gnutls.datum_t(

2499

ctypes.cast(ctypes.c_char_p(openpgp),

2500

ctypes.POINTER(ctypes.c_ubyte)),

2501

ctypes.c_uint(len(openpgp)))

1822

2502

# New empty GnuTLS certificate

1823

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1824

(gnutls.library.functions

1825

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2503

crt = gnutls.openpgp_crt_t()

2504

gnutls.openpgp_crt_init(ctypes.byref(crt))

1826

2505

# Import the OpenPGP public key into the certificate

1827

(gnutls.library.functions

1828

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

1829

gnutls.library.constants

1830

.GNUTLS_OPENPGP_FMT_RAW))

2506

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

2507

gnutls.OPENPGP_FMT_RAW)

1831

2508

# Verify the self signature in the key

1832

2509

crtverify = ctypes.c_uint()

1833

(gnutls.library.functions

1834

.gnutls_openpgp_crt_verify_self(crt, 0,

1835

ctypes.byref(crtverify)))

2510

gnutls.openpgp_crt_verify_self(crt, 0,

2511

ctypes.byref(crtverify))

1836

2512

if crtverify.value != 0:

1837

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1838

raise (gnutls.errors.CertificateSecurityError

1839

("Verify failed"))

2513

gnutls.openpgp_crt_deinit(crt)

2514

raise gnutls.CertificateSecurityError(code

2515

=crtverify.value)

1840

2516

# New buffer for the fingerprint

1841

2517

buf = ctypes.create_string_buffer(20)

1842

2518

buf_len = ctypes.c_size_t()

1843

2519

# Get the fingerprint from the certificate into the buffer

1844

(gnutls.library.functions

1845

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

1846

ctypes.byref(buf_len)))

2520

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

2521

ctypes.byref(buf_len))

1847

2522

# Deinit the certificate

1848

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2523

gnutls.openpgp_crt_deinit(crt)

1849

2524

# Convert the buffer to a Python bytestring

1850

2525

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

1851

2526

# Convert the bytestring to hexadecimal notation

1853

2528

return hex_fpr

1854

2529

1855

2530

1856

class MultiprocessingMixIn(object):

2531

class MultiprocessingMixIn:

1857

2532

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

2533

1858

2534

def sub_process_main(self, request, address):

1859

2535

try:

1860

2536

self.finish_request(request, address)

1861

2537

except Exception:

1862

2538

self.handle_error(request, address)

1863

2539

self.close_request(request)

1864

2540

1865

2541

def process_request(self, request, address):

1866

2542

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

1867

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

1868

args = (request, address))

2543

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

2544

args=(request, address))

1869

2545

proc.start()

1870

2546

return proc

1871

2547

1872

2548

1873

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2549

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1874

2550

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

2551

1875

2552

def process_request(self, request, client_address):

1876

2553

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

1877

2554

1878

2555

This function creates a new pipe in self.pipe

1879

2556

"""

1880

2557

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1881

2558

1882

2559

proc = MultiprocessingMixIn.process_request(self, request,

1883

2560

client_address)

1884

2561

self.child_pipe.close()

1885

2562

self.add_pipe(parent_pipe, proc)

1886

2563

1887

2564

def add_pipe(self, parent_pipe, proc):

1888

2565

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

1889

raise NotImplementedError

2566

raise NotImplementedError()

1890

2567

1891

2568

1892

2569

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1893

socketserver.TCPServer, object):

2570

socketserver.TCPServer):

1894

2571

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

1895

2572

1896

2573

Attributes:

1897

2574

enabled: Boolean; whether this server is activated yet

1898

2575

interface: None or a network interface name (string)

1899

2576

use_ipv6: Boolean; to use IPv6 or not

1900

2577

"""

2578

1901

2579

def __init__(self, server_address, RequestHandlerClass,

1902

interface=None, use_ipv6=True):

2580

interface=None,

2581

use_ipv6=True,

2582

socketfd=None):

2583

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

2584

creating a new one with socket.socket().

2585

"""

1903

2586

self.interface = interface

1904

2587

if use_ipv6:

1905

2588

self.address_family = socket.AF_INET6

2589

if socketfd is not None:

2590

# Save the file descriptor

2591

self.socketfd = socketfd

2592

# Save the original socket.socket() function

2593

self.socket_socket = socket.socket

2594

2595

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

2596

#

2597

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

2598

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

2599

# patching socket.socket.)

2600

#

2601

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

2602

@functools.wraps(socket.socket)

2603

def socket_wrapper(*args, **kwargs):

2604

# Restore original function so subsequent calls are

2605

# not affected.

2606

socket.socket = self.socket_socket

2607

del self.socket_socket

2608

# This time only, return a new socket object from the

2609

# saved file descriptor.

2610

return socket.fromfd(self.socketfd, *args, **kwargs)

2611

# Replace socket.socket() function with wrapper

2612

socket.socket = socket_wrapper

2613

# The socketserver.TCPServer.__init__ will call

2614

# socket.socket(), which might be our replacement,

2615

# socket_wrapper(), if socketfd was set.

1906

2616

socketserver.TCPServer.__init__(self, server_address,

1907

2617

RequestHandlerClass)

2618

1908

2619

def server_bind(self):

1909

2620

"""This overrides the normal server_bind() function

1910

2621

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

1911

2622

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

2623

global SO_BINDTODEVICE

1912

2624

if self.interface is not None:

1913

2625

if SO_BINDTODEVICE is None:

1914

logger.error("SO_BINDTODEVICE does not exist;"

1915

" cannot bind to interface %s",

1916

self.interface)

1917

else:

1918

try:

1919

self.socket.setsockopt(socket.SOL_SOCKET,

1920

SO_BINDTODEVICE,

1921

str(self.interface

1922

+ '\0'))

1923

except socket.error as error:

1924

if error.errno == errno.EPERM:

1925

logger.error("No permission to"

1926

" bind to interface %s",

1927

self.interface)

1928

elif error.errno == errno.ENOPROTOOPT:

1929

logger.error("SO_BINDTODEVICE not available;"

1930

" cannot bind to interface %s",

1931

self.interface)

1932

elif error.errno == errno.ENODEV:

1933

logger.error("Interface %s does not"

1934

" exist, cannot bind",

1935

self.interface)

1936

else:

1937

raise

2626

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

2627

# common enough.

2628

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

2629

SO_BINDTODEVICE = 25

2630

try:

2631

self.socket.setsockopt(

2632

socket.SOL_SOCKET, SO_BINDTODEVICE,

2633

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

2634

except socket.error as error:

2635

if error.errno == errno.EPERM:

2636

logger.error("No permission to bind to"

2637

" interface %s", self.interface)

2638

elif error.errno == errno.ENOPROTOOPT:

2639

logger.error("SO_BINDTODEVICE not available;"

2640

" cannot bind to interface %s",

2641

self.interface)

2642

elif error.errno == errno.ENODEV:

2643

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

2644

" cannot bind", self.interface)

2645

else:

2646

raise

1938

2647

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

1939

2648

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

2649

if self.server_address[1]:

2650

self.allow_reuse_address = True

1940

2651

if not self.server_address[0]:

1941

2652

if self.address_family == socket.AF_INET6:

1942

any_address = "::" # in6addr_any

2653

any_address = "::" # in6addr_any

1943

2654

else:

1944

any_address = socket.INADDR_ANY

2655

any_address = "0.0.0.0" # INADDR_ANY

1945

2656

self.server_address = (any_address,

1946

2657

self.server_address[1])

1947

2658

elif not self.server_address[1]:

1948

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

1949

0)

2659

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

1950

2660

# if self.interface:

1951

2661

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

1952

2662

# 0, # port

1958

2668

1959

2669

class MandosServer(IPv6_TCPServer):

1960

2670

"""Mandos server.

1961

2671

1962

2672

Attributes:

1963

2673

clients: set of Client objects

1964

2674

gnutls_priority GnuTLS priority string

1965

2675

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

1966

1967

Assumes a gobject.MainLoop event loop.

2676

2677

Assumes a GLib.MainLoop event loop.

1968

2678

"""

2679

1969

2680

def __init__(self, server_address, RequestHandlerClass,

1970

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

1971

gnutls_priority=None, use_dbus=True):

2681

interface=None,

2682

use_ipv6=True,

2683

clients=None,

2684

gnutls_priority=None,

2685

use_dbus=True,

2686

socketfd=None):

1972

2687

self.enabled = False

1973

2688

self.clients = clients

1974

2689

if self.clients is None:

1977

2692

self.gnutls_priority = gnutls_priority

1978

2693

IPv6_TCPServer.__init__(self, server_address,

1979

2694

RequestHandlerClass,

1980

interface = interface,

1981

use_ipv6 = use_ipv6)

2695

interface=interface,

2696

use_ipv6=use_ipv6,

2697

socketfd=socketfd)

2698

1982

2699

def server_activate(self):

1983

2700

if self.enabled:

1984

2701

return socketserver.TCPServer.server_activate(self)

1985

2702

1986

2703

def enable(self):

1987

2704

self.enabled = True

1988

2705

1989

2706

def add_pipe(self, parent_pipe, proc):

1990

2707

# Call "handle_ipc" for both data and EOF events

1991

gobject.io_add_watch(parent_pipe.fileno(),

1992

gobject.IO_IN | gobject.IO_HUP,

1993

functools.partial(self.handle_ipc,

1994

parent_pipe =

1995

parent_pipe,

1996

proc = proc))

1997

1998

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

1999

proc = None, client_object=None):

2708

GLib.io_add_watch(

2709

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

2710

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

2711

functools.partial(self.handle_ipc,

2712

parent_pipe=parent_pipe,

2713

proc=proc))

2714

2715

def handle_ipc(self, source, condition,

2716

parent_pipe=None,

2717

proc=None,

2718

client_object=None):

2000

2719

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

2001

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

2720

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

2002

2721

# Wait for other process to exit

2003

2722

proc.join()

2004

2723

return False

2005

2724

2006

2725

# Read a request from the child

2007

2726

request = parent_pipe.recv()

2008

2727

command = request[0]

2009

2728

2010

2729

if command == 'init':

2011

fpr = request[1]

2012

address = request[2]

2013

2014

for c in self.clients.itervalues():

2015

if c.fingerprint == fpr:

2730

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

2731

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

2732

address = request[3]

2733

2734

for c in self.clients.values():

2735

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2736

"27AE41E4649B934CA495991B7852B855"):

2737

continue

2738

if key_id and c.key_id == key_id:

2739

client = c

2740

break

2741

if fpr and c.fingerprint == fpr:

2016

2742

client = c

2017

2743

break

2018

2744

else:

2019

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

2020

"dress: %s", fpr, address)

2745

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

2746

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

2021

2747

if self.use_dbus:

2022

2748

# Emit D-Bus signal

2023

mandos_dbus_service.ClientNotFound(fpr,

2749

mandos_dbus_service.ClientNotFound(key_id or fpr,

2024

2750

address[0])

2025

2751

parent_pipe.send(False)

2026

2752

return False

2027

2028

gobject.io_add_watch(parent_pipe.fileno(),

2029

gobject.IO_IN | gobject.IO_HUP,

2030

functools.partial(self.handle_ipc,

2031

parent_pipe =

2032

parent_pipe,

2033

proc = proc,

2034

client_object =

2035

client))

2753

2754

GLib.io_add_watch(

2755

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

2756

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

2757

functools.partial(self.handle_ipc,

2758

parent_pipe=parent_pipe,

2759

proc=proc,

2760

client_object=client))

2036

2761

parent_pipe.send(True)

2037

2762

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

2038

2763

# same fileno

2041

2766

funcname = request[1]

2042

2767

args = request[2]

2043

2768

kwargs = request[3]

2044

2769

2045

2770

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

2046

2771

funcname)(*args,

2047

**kwargs)))

2048

2772

**kwargs)))

2773

2049

2774

if command == 'getattr':

2050

2775

attrname = request[1]

2051

if callable(client_object.__getattribute__(attrname)):

2052

parent_pipe.send(('function',))

2776

if isinstance(client_object.__getattribute__(attrname),

2777

collections.abc.Callable):

2778

parent_pipe.send(('function', ))

2053

2779

else:

2054

parent_pipe.send(('data', client_object

2055

.__getattribute__(attrname)))

2056

2780

parent_pipe.send((

2781

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

2782

2057

2783

if command == 'setattr':

2058

2784

attrname = request[1]

2059

2785

value = request[2]

2060

2786

setattr(client_object, attrname, value)

2061

2787

2062

2788

return True

2063

2789

2064

2790

2791

def rfc3339_duration_to_delta(duration):

2792

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

2793

2794

>>> timedelta = datetime.timedelta

2795

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

2796

True

2797

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

2798

True

2799

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

2800

True

2801

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

2802

True

2803

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

2804

True

2805

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

2806

True

2807

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

2808

True

2809

>>> del timedelta

2810

"""

2811

2812

# Parsing an RFC 3339 duration with regular expressions is not

2813

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

2814

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

2815

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

2816

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

2817

# avoid excessive use of external libraries.

2818

2819

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

2820

Token = collections.namedtuple("Token", (

2821

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

2822

# a "group" containing digits

2823

"value", # datetime.timedelta or None

2824

"followers")) # Tokens valid after this token

2825

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

2826

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

2827

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

2828

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

2829

datetime.timedelta(seconds=1),

2830

frozenset((token_end, )))

2831

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

2832

datetime.timedelta(minutes=1),

2833

frozenset((token_second, token_end)))

2834

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

2835

datetime.timedelta(hours=1),

2836

frozenset((token_minute, token_end)))

2837

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

2838

None,

2839

frozenset((token_hour, token_minute,

2840

token_second)))

2841

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

2842

datetime.timedelta(days=1),

2843

frozenset((token_time, token_end)))

2844

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

2845

datetime.timedelta(weeks=4),

2846

frozenset((token_day, token_end)))

2847

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

2848

datetime.timedelta(weeks=52),

2849

frozenset((token_month, token_end)))

2850

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

2851

datetime.timedelta(weeks=1),

2852

frozenset((token_end, )))

2853

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

2854

frozenset((token_year, token_month,

2855

token_day, token_time,

2856

token_week)))

2857

# Define starting values:

2858

# Value so far

2859

value = datetime.timedelta()

2860

found_token = None

2861

# Following valid tokens

2862

followers = frozenset((token_duration, ))

2863

# String left to parse

2864

s = duration

2865

# Loop until end token is found

2866

while found_token is not token_end:

2867

# Search for any currently valid tokens

2868

for token in followers:

2869

match = token.regexp.match(s)

2870

if match is not None:

2871

# Token found

2872

if token.value is not None:

2873

# Value found, parse digits

2874

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

2875

# Add to value so far

2876

value += factor * token.value

2877

# Strip token from string

2878

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

2879

# Go to found token

2880

found_token = token

2881

# Set valid next tokens

2882

followers = found_token.followers

2883

break

2884

else:

2885

# No currently valid tokens were found

2886

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

2887

.format(duration))

2888

# End token found

2889

return value

2890

2891

2065

2892

def string_to_delta(interval):

2066

2893

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

2067

2068

>>> string_to_delta('7d')

2069

datetime.timedelta(7)

2070

>>> string_to_delta('60s')

2071

datetime.timedelta(0, 60)

2072

>>> string_to_delta('60m')

2073

datetime.timedelta(0, 3600)

2074

>>> string_to_delta('24h')

2075

datetime.timedelta(1)

2076

>>> string_to_delta('1w')

2077

datetime.timedelta(7)

2078

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

2079

datetime.timedelta(0, 330)

2894

2895

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

2896

True

2897

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

2898

True

2899

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

2900

True

2901

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

2902

True

2903

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

2904

True

2905

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

2906

True

2080

2907

"""

2908

2909

try:

2910

return rfc3339_duration_to_delta(interval)

2911

except ValueError:

2912

pass

2913

2081

2914

timevalue = datetime.timedelta(0)

2082

2915

for s in interval.split():

2083

2916

try:

2084

suffix = unicode(s[-1])

2917

suffix = s[-1]

2085

2918

value = int(s[:-1])

2086

2919

if suffix == "d":

2087

2920

delta = datetime.timedelta(value)

2094

2927

elif suffix == "w":

2095

2928

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

2096

2929

else:

2097

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

2098

.format(suffix))

2099

except (ValueError, IndexError) as e:

2930

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

2931

except IndexError as e:

2100

2932

raise ValueError(*(e.args))

2101

2933

timevalue += delta

2102

2934

return timevalue

2103

2935

2104

2936

2105

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

2937

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

2106

2938

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

2107

2939

2108

2940

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

2109

2941

if os.fork():

2110

2942

sys.exit()

2118

2950

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

2119

2951

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

2120

2952

raise OSError(errno.ENODEV,

2121

"{0} not a character device"

2953

"{} not a character device"

2122

2954

.format(os.devnull))

2123

2955

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

2124

2956

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

2128

2960

2129

2961

2130

2962

def main():

2131

2963

2132

2964

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

2133

2965

# Parsing of options, both command line and config file

2134

2966

2135

2967

parser = argparse.ArgumentParser()

2136

2968

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

2137

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

2969

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

2138

2970

help="show version number and exit")

2139

2971

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

2140

2972

help="Bind to interface IF")

2146

2978

help="Run self-test")

2147

2979

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

2148

2980

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

2149

" to terminal")

2981

" to terminal", default=None)

2150

2982

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

2151

2983

help="Debug level for stdout output")

2152

2984

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

2159

2991

" files")

2160

2992

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

2161

2993

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

2162

" system bus interface")

2994

" system bus interface", default=None)

2163

2995

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

2164

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

2996

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

2997

default=None)

2165

2998

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

2166

2999

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

2167

" state")

3000

" state", default=None)

3001

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

3002

help="Specify a file descriptor to a network"

3003

" socket to use instead of creating one")

2168

3004

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

2169

3005

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

2170

3006

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

3007

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

3008

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

3009

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

3010

default=None)

3011

2171

3012

options = parser.parse_args()

2172

2173

if options.check:

2174

import doctest

2175

doctest.testmod()

2176

sys.exit()

2177

3013

2178

3014

# Default values for config file for server-global settings

2179

server_defaults = { "interface": "",

2180

"address": "",

2181

"port": "",

2182

"debug": "False",

2183

"priority":

2184

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

2185

"servicename": "Mandos",

2186

"use_dbus": "True",

2187

"use_ipv6": "True",

2188

"debuglevel": "",

2189

"restore": "True",

2190

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

2191

}

2192

3015

if gnutls.has_rawpk:

3016

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

3017

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

3018

else:

3019

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

3020

":+SIGN-DSA-SHA256")

3021

server_defaults = {"interface": "",

3022

"address": "",

3023

"port": "",

3024

"debug": "False",

3025

"priority": priority,

3026

"servicename": "Mandos",

3027

"use_dbus": "True",

3028

"use_ipv6": "True",

3029

"debuglevel": "",

3030

"restore": "True",

3031

"socket": "",

3032

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

3033

"foreground": "False",

3034

"zeroconf": "True",

3035

}

3036

del priority

3037

2193

3038

# Parse config file for server-global settings

2194

server_config = configparser.SafeConfigParser(server_defaults)

3039

server_config = configparser.ConfigParser(server_defaults)

2195

3040

del server_defaults

2196

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

2197

"mandos.conf"))

2198

# Convert the SafeConfigParser object to a dict

3041

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

3042

# Convert the ConfigParser object to a dict

2199

3043

server_settings = server_config.defaults()

2200

3044

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

2201

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

3045

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

3046

"foreground", "zeroconf"):

2202

3047

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

2203

3048

option)

2204

3049

if server_settings["port"]:

2205

3050

server_settings["port"] = server_config.getint("DEFAULT",

2206

3051

"port")

3052

if server_settings["socket"]:

3053

server_settings["socket"] = server_config.getint("DEFAULT",

3054

"socket")

3055

# Later, stdin will, and stdout and stderr might, be dup'ed

3056

# over with an opened os.devnull. But we don't want this to

3057

# happen with a supplied network socket.

3058

if 0 <= server_settings["socket"] <= 2:

3059

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

3060

["socket"])

2207

3061

del server_config

2208

3062

2209

3063

# Override the settings from the config file with command line

2210

3064

# options, if set.

2211

3065

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

2212

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

2213

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

2214

"statedir"):

3066

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

3067

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

3068

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

2215

3069

value = getattr(options, option)

2216

3070

if value is not None:

2217

3071

server_settings[option] = value

2218

3072

del options

2219

3073

# Force all strings to be unicode

2220

3074

for option in server_settings.keys():

2221

if type(server_settings[option]) is str:

2222

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

3075

if isinstance(server_settings[option], bytes):

3076

server_settings[option] = (server_settings[option]

3077

.decode("utf-8"))

3078

# Force all boolean options to be boolean

3079

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

3080

"foreground", "zeroconf"):

3081

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

3082

# Debug implies foreground

3083

if server_settings["debug"]:

3084

server_settings["foreground"] = True

2223

3085

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

2224

3086

2225

3087

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

2226

3088

3089

if (not server_settings["zeroconf"]

3090

and not (server_settings["port"]

3091

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

3092

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

3093

2227

3094

# For convenience

2228

3095

debug = server_settings["debug"]

2229

3096

debuglevel = server_settings["debuglevel"]

2231

3098

use_ipv6 = server_settings["use_ipv6"]

2232

3099

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

2233

3100

stored_state_file)

2234

3101

foreground = server_settings["foreground"]

3102

zeroconf = server_settings["zeroconf"]

3103

2235

3104

if debug:

2236

3105

initlogger(debug, logging.DEBUG)

2237

3106

else:

2240

3109

else:

2241

3110

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

2242

3111

initlogger(debug, level)

2243

3112

2244

3113

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

2245

syslogger.setFormatter(logging.Formatter

2246

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

2247

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

2248

.format(server_settings

2249

["servicename"])))

2250

3114

syslogger.setFormatter(

3115

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

3116

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

3117

server_settings["servicename"])))

3118

2251

3119

# Parse config file with clients

2252

client_config = configparser.SafeConfigParser(Client

2253

.client_defaults)

3120

client_config = configparser.ConfigParser(Client.client_defaults)

2254

3121

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

2255

3122

"clients.conf"))

2256

3123

2257

3124

global mandos_dbus_service

2258

3125

mandos_dbus_service = None

2259

2260

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

2261

server_settings["port"]),

2262

ClientHandler,

2263

interface=(server_settings["interface"]

2264

or None),

2265

use_ipv6=use_ipv6,

2266

gnutls_priority=

2267

server_settings["priority"],

2268

use_dbus=use_dbus)

2269

if not debug:

2270

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

3126

3127

socketfd = None

3128

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

3129

socketfd = server_settings["socket"]

3130

tcp_server = MandosServer(

3131

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

3132

ClientHandler,

3133

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

3134

use_ipv6=use_ipv6,

3135

gnutls_priority=server_settings["priority"],

3136

use_dbus=use_dbus,

3137

socketfd=socketfd)

3138

if not foreground:

3139

pidfilename = "/run/mandos.pid"

3140

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

3141

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

3142

pidfile = None

2271

3143

try:

2272

pidfile = open(pidfilename, "w")

3144

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

2273

3145

except IOError as e:

2274

3146

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

2275

3147

exc_info=e)

2276

2277

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

3148

3149

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

3150

("mandos", "mandos"),

3151

("nobody", "nogroup")):

2278

3152

try:

2279

3153

uid = pwd.getpwnam(name).pw_uid

2280

gid = pwd.getpwnam(name).pw_gid

3154

gid = pwd.getpwnam(group).pw_gid

2281

3155

break

2282

3156

except KeyError:

2283

3157

continue

2287

3161

try:

2288

3162

os.setgid(gid)

2289

3163

os.setuid(uid)

3164

if debug:

3165

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

3166

gid))

2290

3167

except OSError as error:

3168

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

3169

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

2291

3170

if error.errno != errno.EPERM:

2292

raise error

2293

3171

raise

3172

2294

3173

if debug:

2295

3174

# Enable all possible GnuTLS debugging

2296

3175

2297

3176

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

2298

3177

# - GnuTLS manual

2299

gnutls.library.functions.gnutls_global_set_log_level(11)

2300

2301

@gnutls.library.types.gnutls_log_func

3178

gnutls.global_set_log_level(11)

3179

3180

@gnutls.log_func

2302

3181

def debug_gnutls(level, string):

2303

3182

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

2304

2305

(gnutls.library.functions

2306

.gnutls_global_set_log_function(debug_gnutls))

2307

3183

3184

gnutls.global_set_log_function(debug_gnutls)

3185

2308

3186

# Redirect stdin so all checkers get /dev/null

2309

3187

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

2310

3188

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

2311

3189

if null > 2:

2312

3190

os.close(null)

2313

3191

2314

3192

# Need to fork before connecting to D-Bus

2315

if not debug:

3193

if not foreground:

2316

3194

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

2317

3195

daemon()

2318

2319

gobject.threads_init()

2320

3196

3197

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

3198

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

3199

# need to inform GLib that threads will be used.

3200

GLib.threads_init()

3201

2321

3202

global main_loop

2322

3203

# From the Avahi example code

2323

3204

DBusGMainLoop(set_as_default=True)

2324

main_loop = gobject.MainLoop()

3205

main_loop = GLib.MainLoop()

2325

3206

bus = dbus.SystemBus()

2326

3207

# End of Avahi example code

2327

3208

if use_dbus:

2328

3209

try:

2329

3210

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

2330

bus, do_not_queue=True)

2331

old_bus_name = (dbus.service.BusName

2332

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

2333

do_not_queue=True))

2334

except dbus.exceptions.NameExistsException as e:

3211

bus,

3212

do_not_queue=True)

3213

old_bus_name = dbus.service.BusName(

3214

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

3215

do_not_queue=True)

3216

except dbus.exceptions.DBusException as e:

2335

3217

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

2336

3218

use_dbus = False

2337

3219

server_settings["use_dbus"] = False

2338

3220

tcp_server.use_dbus = False

2339

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2340

service = AvahiServiceToSyslog(name =

2341

server_settings["servicename"],

2342

servicetype = "_mandos._tcp",

2343

protocol = protocol, bus = bus)

2344

if server_settings["interface"]:

2345

service.interface = (if_nametoindex

2346

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

2347

3221

if zeroconf:

3222

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3223

service = AvahiServiceToSyslog(

3224

name=server_settings["servicename"],

3225

servicetype="_mandos._tcp",

3226

protocol=protocol,

3227

bus=bus)

3228

if server_settings["interface"]:

3229

service.interface = if_nametoindex(

3230

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

3231

2348

3232

global multiprocessing_manager

2349

3233

multiprocessing_manager = multiprocessing.Manager()

2350

3234

2351

3235

client_class = Client

2352

3236

if use_dbus:

2353

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

2354

3237

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

3238

2355

3239

client_settings = Client.config_parser(client_config)

2356

3240

old_client_settings = {}

2357

3241

clients_data = {}

2358

3242

3243

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

3244

global wnull

3245

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

3246

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

3247

# mode

3248

if debug or not foreground:

3249

wnull.close()

3250

2359

3251

# Get client data and settings from last running state.

2360

3252

if server_settings["restore"]:

2361

3253

try:

2362

3254

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

2363

clients_data, old_client_settings = (pickle.load

2364

(stored_state))

3255

if sys.version_info.major == 2:

3256

clients_data, old_client_settings = pickle.load(

3257

stored_state)

3258

else:

3259

bytes_clients_data, bytes_old_client_settings = (

3260

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

3261

# Fix bytes to strings

3262

# clients_data

3263

# .keys()

3264

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

3265

if isinstance(key, bytes)

3266

else key): value

3267

for key, value in

3268

bytes_clients_data.items()}

3269

del bytes_clients_data

3270

for key in clients_data:

3271

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

3272

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

3273

for k, v in

3274

clients_data[key].items()}

3275

clients_data[key] = value

3276

# .client_structure

3277

value["client_structure"] = [

3278

(s.decode("utf-8")

3279

if isinstance(s, bytes)

3280

else s) for s in

3281

value["client_structure"]]

3282

# .name, .host, and .checker_command

3283

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

3284

if isinstance(value[k], bytes):

3285

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

3286

if "key_id" not in value:

3287

value["key_id"] = ""

3288

elif "fingerprint" not in value:

3289

value["fingerprint"] = ""

3290

# old_client_settings

3291

# .keys()

3292

old_client_settings = {

3293

(key.decode("utf-8")

3294

if isinstance(key, bytes)

3295

else key): value

3296

for key, value in

3297

bytes_old_client_settings.items()}

3298

del bytes_old_client_settings

3299

# .host and .checker_command

3300

for value in old_client_settings.values():

3301

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

3302

if isinstance(value[attribute], bytes):

3303

value[attribute] = (value[attribute]

3304

.decode("utf-8"))

2365

3305

os.remove(stored_state_path)

2366

3306

except IOError as e:

2367

3307

if e.errno == errno.ENOENT:

2368

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

2369

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

3308

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

3309

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

2370

3310

else:

2371

3311

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

2372

3312

exc_info=e)

2373

3313

raise

2374

3314

except EOFError as e:

2375

3315

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

2376

"EOFError:", exc_info=e)

2377

3316

"EOFError:",

3317

exc_info=e)

3318

2378

3319

with PGPEngine() as pgp:

2379

for client_name, client in clients_data.iteritems():

3320

for client_name, client in clients_data.items():

3321

# Skip removed clients

3322

if client_name not in client_settings:

3323

continue

3324

2380

3325

# Decide which value to use after restoring saved state.

2381

3326

# We have three different values: Old config file,

2382

3327

# new config file, and saved state.

2387

3332

# For each value in new config, check if it

2388

3333

# differs from the old config value (Except for

2389

3334

# the "secret" attribute)

2390

if (name != "secret" and

2391

value != old_client_settings[client_name]

2392

[name]):

3335

if (name != "secret"

3336

and (value !=

3337

old_client_settings[client_name][name])):

2393

3338

client[name] = value

2394

3339

except KeyError:

2395

3340

pass

2396

3341

2397

3342

# Clients who has passed its expire date can still be

2398

# enabled if its last checker was successful. Clients

3343

# enabled if its last checker was successful. A Client

2399

3344

# whose checker succeeded before we stored its state is

2400

3345

# assumed to have successfully run all checkers during

2401

3346

# downtime.

2403

3348

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

2404

3349

if not client["last_checked_ok"]:

2405

3350

logger.warning(

2406

"disabling client {0} - Client never "

2407

"performed a successful checker"

2408

.format(client_name))

3351

"disabling client {} - Client never "

3352

"performed a successful checker".format(

3353

client_name))

2409

3354

client["enabled"] = False

2410

3355

elif client["last_checker_status"] != 0:

2411

3356

logger.warning(

2412

"disabling client {0} - Client "

2413

"last checker failed with error code {1}"

2414

.format(client_name,

2415

client["last_checker_status"]))

3357

"disabling client {} - Client last"

3358

" checker failed with error code"

3359

" {}".format(

3360

client_name,

3361

client["last_checker_status"]))

2416

3362

client["enabled"] = False

2417

3363

else:

2418

client["expires"] = (datetime.datetime

2419

.utcnow()

2420

+ client["timeout"])

3364

client["expires"] = (

3365

datetime.datetime.utcnow()

3366

+ client["timeout"])

2421

3367

logger.debug("Last checker succeeded,"

2422

" keeping {0} enabled"

2423

.format(client_name))

3368

" keeping {} enabled".format(

3369

client_name))

2424

3370

try:

2425

client["secret"] = (

2426

pgp.decrypt(client["encrypted_secret"],

2427

client_settings[client_name]

2428

["secret"]))

3371

client["secret"] = pgp.decrypt(

3372

client["encrypted_secret"],

3373

client_settings[client_name]["secret"])

2429

3374

except PGPError:

2430

3375

# If decryption fails, we use secret from new settings

2431

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

2432

.format(client_name))

2433

client["secret"] = (

2434

client_settings[client_name]["secret"])

2435

3376

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

3377

client_name))

3378

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

3379

["secret"])

3380

2436

3381

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

2437

3382

for client_name in (set(old_client_settings)

2438

3383

- set(client_settings)):

2440

3385

for client_name in (set(client_settings)

2441

3386

- set(old_client_settings)):

2442

3387

clients_data[client_name] = client_settings[client_name]

2443

3388

2444

3389

# Create all client objects

2445

for client_name, client in clients_data.iteritems():

3390

for client_name, client in clients_data.items():

2446

3391

tcp_server.clients[client_name] = client_class(

2447

name = client_name, settings = client)

2448

3392

name=client_name,

3393

settings=client,

3394

server_settings=server_settings)

3395

2449

3396

if not tcp_server.clients:

2450

3397

logger.warning("No clients defined")

2451

2452

if not debug:

2453

try:

2454

with pidfile:

2455

pid = os.getpid()

2456

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

2457

del pidfile

2458

except IOError:

2459

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

2460

pidfilename, pid)

2461

except NameError:

2462

# "pidfile" was never created

2463

pass

3398

3399

if not foreground:

3400

if pidfile is not None:

3401

pid = os.getpid()

3402

try:

3403

with pidfile:

3404

print(pid, file=pidfile)

3405

except IOError:

3406

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

3407

pidfilename, pid)

3408

del pidfile

2464

3409

del pidfilename

2465

2466

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

2467

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

2468

3410

3411

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

3412

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3413

lambda: main_loop.quit() and False)

3414

2469

3415

if use_dbus:

2470

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

2471

"se.bsnet.fukt.Mandos"})

2472

class MandosDBusService(DBusObjectWithProperties):

3416

3417

@alternate_dbus_interfaces(

3418

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

3419

class MandosDBusService(DBusObjectWithObjectManager):

2473

3420

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

3421

2474

3422

def __init__(self):

2475

3423

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

3424

2476

3425

_interface = "se.recompile.Mandos"

2477

2478

@dbus_interface_annotations(_interface)

2479

def _foo(self):

2480

return { "org.freedesktop.DBus.Property"

2481

".EmitsChangedSignal":

2482

"false"}

2483

3426

2484

3427

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

2485

3428

def ClientAdded(self, objpath):

2486

3429

"D-Bus signal"

2487

3430

pass

2488

3431

2489

3432

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

2490

def ClientNotFound(self, fingerprint, address):

3433

def ClientNotFound(self, key_id, address):

2491

3434

"D-Bus signal"

2492

3435

pass

2493

3436

3437

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

3438

"true"})

2494

3439

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

2495

3440

def ClientRemoved(self, objpath, name):

2496

3441

"D-Bus signal"

2497

3442

pass

2498

3443

3444

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

3445

"true"})

2499

3446

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

2500

3447

def GetAllClients(self):

2501

3448

"D-Bus method"

2502

return dbus.Array(c.dbus_object_path

2503

for c in

2504

tcp_server.clients.itervalues())

2505

3449

return dbus.Array(c.dbus_object_path for c in

3450

tcp_server.clients.values())

3451

3452

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

3453

"true"})

2506

3454

@dbus.service.method(_interface,

2507

3455

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

2508

3456

def GetAllClientsWithProperties(self):

2509

3457

"D-Bus method"

2510

3458

return dbus.Dictionary(

2511

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

2512

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

3459

{c.dbus_object_path: c.GetAll(

3460

"se.recompile.Mandos.Client")

3461

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

2513

3462

signature="oa{sv}")

2514

3463

2515

3464

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

2516

3465

def RemoveClient(self, object_path):

2517

3466

"D-Bus method"

2518

for c in tcp_server.clients.itervalues():

3467

for c in tcp_server.clients.values():

2519

3468

if c.dbus_object_path == object_path:

2520

3469

del tcp_server.clients[c.name]

2521

3470

c.remove_from_connection()

2522

# Don't signal anything except ClientRemoved

3471

# Don't signal the disabling

2523

3472

c.disable(quiet=True)

2524

# Emit D-Bus signal

2525

self.ClientRemoved(object_path, c.name)

3473

# Emit D-Bus signal for removal

3474

self.client_removed_signal(c)

2526

3475

return

2527

3476

raise KeyError(object_path)

2528

3477

2529

3478

del _interface

2530

3479

3480

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3481

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

3482

def GetManagedObjects(self):

3483

"""D-Bus method"""

3484

return dbus.Dictionary(

3485

{client.dbus_object_path:

3486

dbus.Dictionary(

3487

{interface: client.GetAll(interface)

3488

for interface in

3489

client._get_all_interface_names()})

3490

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

3491

3492

def client_added_signal(self, client):

3493

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

3494

if use_dbus:

3495

# New standard signal

3496

self.InterfacesAdded(

3497

client.dbus_object_path,

3498

dbus.Dictionary(

3499

{interface: client.GetAll(interface)

3500

for interface in

3501

client._get_all_interface_names()}))

3502

# Old signal

3503

self.ClientAdded(client.dbus_object_path)

3504

3505

def client_removed_signal(self, client):

3506

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

3507

if use_dbus:

3508

# New standard signal

3509

self.InterfacesRemoved(

3510

client.dbus_object_path,

3511

client._get_all_interface_names())

3512

# Old signal

3513

self.ClientRemoved(client.dbus_object_path,

3514

client.name)

3515

2531

3516

mandos_dbus_service = MandosDBusService()

2532

3517

3518

# Save modules to variables to exempt the modules from being

3519

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

3520

mp = multiprocessing

3521

wn = wnull

3522

2533

3523

def cleanup():

2534

3524

"Cleanup function; run on exit"

2535

service.cleanup()

2536

2537

multiprocessing.active_children()

3525

if zeroconf:

3526

service.cleanup()

3527

3528

mp.active_children()

3529

wn.close()

2538

3530

if not (tcp_server.clients or client_settings):

2539

3531

return

2540

3532

2541

3533

# Store client before exiting. Secrets are encrypted with key

2542

3534

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

2543

3535

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

2544

3536

clients = {}

2545

3537

with PGPEngine() as pgp:

2546

for client in tcp_server.clients.itervalues():

3538

for client in tcp_server.clients.values():

2547

3539

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

2548

3540

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

2549

3541

key)

2550

3542

client_dict = {}

2551

3543

2552

3544

# A list of attributes that can not be pickled

2553

3545

# + secret.

2554

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

2555

"checker"))

2556

for name, typ in (inspect.getmembers

2557

(dbus.service.Object)):

3546

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

3547

"checker", "server_settings"}

3548

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

3549

.Object):

2558

3550

exclude.add(name)

2559

3551

2560

3552

client_dict["encrypted_secret"] = (client

2561

3553

.encrypted_secret)

2562

3554

for attr in client.client_structure:

2563

3555

if attr not in exclude:

2564

3556

client_dict[attr] = getattr(client, attr)

2565

3557

2566

3558

clients[client.name] = client_dict

2567

3559

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

2568

3560

2569

3561

try:

2570

with (tempfile.NamedTemporaryFile

2571

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

2572

dir=os.path.dirname(stored_state_path),

2573

delete=False)) as stored_state:

2574

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

2575

tempname=stored_state.name

3562

with tempfile.NamedTemporaryFile(

3563

mode='wb',

3564

suffix=".pickle",

3565

prefix='clients-',

3566

dir=os.path.dirname(stored_state_path),

3567

delete=False) as stored_state:

3568

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

3569

protocol=2)

3570

tempname = stored_state.name

2576

3571

os.rename(tempname, stored_state_path)

2577

3572

except (IOError, OSError) as e:

2578

3573

if not debug:

2581

3576

except NameError:

2582

3577

pass

2583

3578

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

2584

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

3579

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

2585

3580

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

2586

3581

else:

2587

3582

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

2588

3583

exc_info=e)

2589

raise e

2590

3584

raise

3585

2591

3586

# Delete all clients, and settings from config

2592

3587

while tcp_server.clients:

2593

3588

name, client = tcp_server.clients.popitem()

2594

3589

if use_dbus:

2595

3590

client.remove_from_connection()

2596

# Don't signal anything except ClientRemoved

3591

# Don't signal the disabling

2597

3592

client.disable(quiet=True)

3593

# Emit D-Bus signal for removal

2598

3594

if use_dbus:

2599

# Emit D-Bus signal

2600

mandos_dbus_service.ClientRemoved(client

2601

.dbus_object_path,

2602

client.name)

3595

mandos_dbus_service.client_removed_signal(client)

2603

3596

client_settings.clear()

2604

3597

2605

3598

atexit.register(cleanup)

2606

2607

for client in tcp_server.clients.itervalues():

3599

3600

for client in tcp_server.clients.values():

2608

3601

if use_dbus:

2609

# Emit D-Bus signal

2610

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3602

# Emit D-Bus signal for adding

3603

mandos_dbus_service.client_added_signal(client)

2611

3604

# Need to initiate checking of clients

2612

3605

if client.enabled:

2613

3606

client.init_checker()

2614

3607

2615

3608

tcp_server.enable()

2616

3609

tcp_server.server_activate()

2617

3610

2618

3611

# Find out what port we got

2619

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

3612

if zeroconf:

3613

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

2620

3614

if use_ipv6:

2621

3615

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

2622

3616

" flowinfo %d, scope_id %d",

2624

3618

else: # IPv4

2625

3619

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

2626

3620

*tcp_server.socket.getsockname())

2627

2628

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

2629

3621

3622

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

3623

2630

3624

try:

2631

# From the Avahi example code

2632

try:

2633

service.activate()

2634

except dbus.exceptions.DBusException as error:

2635

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

2636

cleanup()

2637

sys.exit(1)

2638

# End of Avahi example code

2639

2640

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

2641

lambda *args, **kwargs:

2642

(tcp_server.handle_request

2643

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

2644

3625

if zeroconf:

3626

# From the Avahi example code

3627

try:

3628

service.activate()

3629

except dbus.exceptions.DBusException as error:

3630

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

3631

cleanup()

3632

sys.exit(1)

3633

# End of Avahi example code

3634

3635

GLib.io_add_watch(

3636

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

3637

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3638

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

3639

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

3640

2645

3641

logger.debug("Starting main loop")

2646

3642

main_loop.run()

2647

3643

except AvahiError as error:

2656

3652

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

2657

3653

cleanup()

2658

3654

3655

3656

def should_only_run_tests():

3657

parser = argparse.ArgumentParser(add_help=False)

3658

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

3659

args, unknown_args = parser.parse_known_args()

3660

run_tests = args.check

3661

if run_tests:

3662

# Remove --check argument from sys.argv

3663

sys.argv[1:] = unknown_args

3664

return run_tests

3665

3666

# Add all tests from doctest strings

3667

def load_tests(loader, tests, none):

3668

import doctest

3669

tests.addTests(doctest.DocTestSuite())

3670

return tests

3671

2659

3672

if __name__ == '__main__':

2660

main()

3673

try:

3674

if should_only_run_tests():

3675

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

3676

unittest.main()

3677

else:

3678

main()

3679

finally:

3680

logging.shutdown()