/mandos/release : revision 237.7.502

1

#!/usr/bin/python

2

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

3

#

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

71

80

72

81

import dbus

73

82

import dbus.service

74

import gobject

75

import avahi

83

from gi.repository import GLib

76

84

from dbus.mainloop.glib import DBusGMainLoop

77

85

import ctypes

78

86

import ctypes.util

79

87

import xml.dom.minidom

80

88

import inspect

81

import GnuPGInterface

82

89

90

# Try to find the value of SO_BINDTODEVICE:

83

91

try:

92

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

93

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

84

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

95

except AttributeError:

86

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

87

99

from IN import SO_BINDTODEVICE

88

100

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.5.5"

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.7.19"

92

119

stored_state_file = "clients.pickle"

93

120

94

121

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

122

syslogger = None

98

123

99

124

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

103

127

except (OSError, AttributeError):

128

104

129

def if_nametoindex(interface):

105

130

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

106

131

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

107

132

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

108

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

134

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

135

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

113

136

return interface_index

114

137

115

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

116

155

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

117

156

"""init logger and add loglevel"""

118

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

119

162

syslogger.setFormatter(logging.Formatter

120

163

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

121

164

' %(message)s'))

122

165

logger.addHandler(syslogger)

123

166

124

167

if debug:

125

168

console = logging.StreamHandler()

126

169

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

138

181

139

182

class PGPEngine(object):

140

183

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

184

141

185

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

143

186

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

198

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

200

'--force-mdc',

201

'--quiet']

202

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

203

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

204

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

205

151

206

def __enter__(self):

152

207

return self

153

208

154

209

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

155

210

self._cleanup()

156

211

return False

157

212

158

213

def __del__(self):

159

214

self._cleanup()

160

215

161

216

def _cleanup(self):

162

217

if self.tempdir is not None:

163

218

# Delete contents of tempdir

164

219

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

165

topdown = False):

220

topdown=False):

166

221

for filename in files:

167

222

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

168

223

for dirname in dirs:

170

225

# Remove tempdir

171

226

os.rmdir(self.tempdir)

172

227

self.tempdir = None

173

228

174

229

def password_encode(self, password):

175

230

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

176

231

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

177

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

178

232

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

233

if len(encoded) > 2048:

234

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

235

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

236

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

237

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

238

return encoded

239

179

240

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

241

passphrase = self.password_encode(password)

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

244

passfile.write(passphrase)

245

passfile.flush()

246

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

247

'--passphrase-file',

248

passfile.name]

249

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

254

if proc.returncode != 0:

255

raise PGPError(err)

194

256

return ciphertext

195

257

196

258

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

259

passphrase = self.password_encode(password)

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

262

passfile.write(passphrase)

263

passfile.flush()

264

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

265

'--passphrase-file',

266

passfile.name]

267

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

272

if proc.returncode != 0:

273

raise PGPError(err)

211

274

return decrypted_plaintext

212

275

213

276

277

# Pretend that we have an Avahi module

278

class Avahi(object):

279

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

280

It is instantiated once, and simulates having an Avahi module."""

281

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

282

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

283

PROTO_INET = 0 # avahi-common/address.h

284

PROTO_INET6 = 1 # avahi-common/address.h

285

DBUS_NAME = "org.freedesktop.Avahi"

286

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

287

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

288

DBUS_PATH_SERVER = "/"

289

290

def string_array_to_txt_array(self, t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

avahi = Avahi()

302

303

214

304

class AvahiError(Exception):

215

305

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

216

306

self.value = value

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

307

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

308

**kwargs)

309

220

310

221

311

class AvahiServiceError(AvahiError):

222

312

pass

223

313

314

224

315

class AvahiGroupError(AvahiError):

225

316

pass

226

317

227

318

228

319

class AvahiService(object):

229

320

"""An Avahi (Zeroconf) service.

230

321

231

322

Attributes:

232

323

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

233

324

Used to optionally bind to the specified interface.

234

325

name: string; Example: 'Mandos'

235

326

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

236

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

327

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

237

328

port: integer; what port to announce

238

329

TXT: list of strings; TXT record for the service

239

330

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

245

336

server: D-Bus Server

246

337

bus: dbus.SystemBus()

247

338

"""

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

339

340

def __init__(self,

341

interface=avahi.IF_UNSPEC,

342

name=None,

343

servicetype=None,

344

port=None,

345

TXT=None,

346

domain="",

347

host="",

348

max_renames=32768,

349

protocol=avahi.PROTO_UNSPEC,

350

bus=None):

253

351

self.interface = interface

254

352

self.name = name

255

353

self.type = servicetype

264

362

self.server = None

265

363

self.bus = bus

266

364

self.entry_group_state_changed_match = None

267

268

def rename(self):

365

366

def rename(self, remove=True):

269

367

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

270

368

if self.rename_count >= self.max_renames:

271

369

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

272

370

" after %i retries, exiting.",

273

371

self.rename_count)

274

372

raise AvahiServiceError("Too many renames")

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

277

376

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

278

377

self.name)

279

self.remove()

378

if remove:

379

self.remove()

280

380

try:

281

381

self.add()

282

382

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

383

if (error.get_dbus_name()

384

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

385

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

386

return self.rename(remove=False)

387

else:

388

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

389

self.cleanup()

390

os._exit(1)

391

288

392

def remove(self):

289

393

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

290

394

if self.entry_group_state_changed_match is not None:

292

396

self.entry_group_state_changed_match = None

293

397

if self.group is not None:

294

398

self.group.Reset()

295

399

296

400

def add(self):

297

401

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

298

402

self.remove()

315

419

dbus.UInt16(self.port),

316

420

avahi.string_array_to_txt_array(self.TXT))

317

421

self.group.Commit()

318

422

319

423

def entry_group_state_changed(self, state, error):

320

424

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

321

425

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

322

426

323

427

if state == avahi.ENTRY_GROUP_ESTABLISHED:

324

428

logger.debug("Zeroconf service established.")

325

429

elif state == avahi.ENTRY_GROUP_COLLISION:

327

431

self.rename()

328

432

elif state == avahi.ENTRY_GROUP_FAILURE:

329

433

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

330

unicode(error))

331

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

332

.format(error))

333

434

str(error))

435

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

436

334

437

def cleanup(self):

335

438

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

336

439

if self.group is not None:

341

444

pass

342

445

self.group = None

343

446

self.remove()

344

447

345

448

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

346

449

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

347

450

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

451

bad_states = {

452

avahi.SERVER_INVALID: "Zeroconf server invalid",

453

avahi.SERVER_REGISTERING: None,

454

avahi.SERVER_COLLISION: "Zeroconf server name collision",

455

avahi.SERVER_FAILURE: "Zeroconf server failure",

456

}

355

457

if state in bad_states:

356

458

if bad_states[state] is not None:

357

459

if error is None:

360

462

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

361

463

self.cleanup()

362

464

elif state == avahi.SERVER_RUNNING:

363

self.add()

465

try:

466

self.add()

467

except dbus.exceptions.DBusException as error:

468

if (error.get_dbus_name()

469

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

470

logger.info("Local Zeroconf service name"

471

" collision.")

472

return self.rename(remove=False)

473

else:

474

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

475

self.cleanup()

476

os._exit(1)

364

477

else:

365

478

if error is None:

366

479

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

367

480

else:

368

481

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

369

482

370

483

def activate(self):

371

484

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

372

485

if self.server is None:

376

489

follow_name_owner_changes=True),

377

490

avahi.DBUS_INTERFACE_SERVER)

378

491

self.server.connect_to_signal("StateChanged",

379

self.server_state_changed)

492

self.server_state_changed)

380

493

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

381

494

382

495

383

496

class AvahiServiceToSyslog(AvahiService):

384

def rename(self):

497

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

385

498

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

499

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

500

syslogger.setFormatter(logging.Formatter(

501

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

502

.format(self.name)))

391

503

return ret

392

504

393

505

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

506

# Pretend that we have a GnuTLS module

507

class GnuTLS(object):

508

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

509

It is instantiated once, and simulates having a GnuTLS module."""

510

511

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

512

if library is None:

513

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

514

_library = ctypes.cdll.LoadLibrary(library)

515

del library

516

_need_version = b"3.3.0"

517

518

def __init__(self):

519

# Need to use "self" here, since this method is called before

520

# the assignment to the "gnutls" global variable happens.

521

if self.check_version(self._need_version) is None:

522

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

523

.format(self._need_version))

524

525

# Unless otherwise indicated, the constants and types below are

526

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

527

528

# Constants

529

E_SUCCESS = 0

530

E_INTERRUPTED = -52

531

E_AGAIN = -28

532

CRT_OPENPGP = 2

533

CLIENT = 2

534

SHUT_RDWR = 0

535

CRD_CERTIFICATE = 1

536

E_NO_CERTIFICATE_FOUND = -49

537

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

538

539

# Types

540

class session_int(ctypes.Structure):

541

_fields_ = []

542

session_t = ctypes.POINTER(session_int)

543

544

class certificate_credentials_st(ctypes.Structure):

545

_fields_ = []

546

certificate_credentials_t = ctypes.POINTER(

547

certificate_credentials_st)

548

certificate_type_t = ctypes.c_int

549

550

class datum_t(ctypes.Structure):

551

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

552

('size', ctypes.c_uint)]

553

554

class openpgp_crt_int(ctypes.Structure):

555

_fields_ = []

556

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

557

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

558

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

559

credentials_type_t = ctypes.c_int

560

transport_ptr_t = ctypes.c_void_p

561

close_request_t = ctypes.c_int

562

563

# Exceptions

564

class Error(Exception):

565

# We need to use the class name "GnuTLS" here, since this

566

# exception might be raised from within GnuTLS.__init__,

567

# which is called before the assignment to the "gnutls"

568

# global variable has happened.

569

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

570

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

571

# code is passed, convert it to a string with

572

# gnutls.strerror()

573

self.code = code

574

if message is None and code is not None:

575

message = GnuTLS.strerror(code)

576

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

577

message, *args)

578

579

class CertificateSecurityError(Error):

580

pass

581

582

# Classes

583

class Credentials(object):

584

def __init__(self):

585

self._c_object = gnutls.certificate_credentials_t()

586

gnutls.certificate_allocate_credentials(

587

ctypes.byref(self._c_object))

588

self.type = gnutls.CRD_CERTIFICATE

589

590

def __del__(self):

591

gnutls.certificate_free_credentials(self._c_object)

592

593

class ClientSession(object):

594

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

595

self._c_object = gnutls.session_t()

596

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

597

gnutls.set_default_priority(self._c_object)

598

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

599

gnutls.handshake_set_private_extensions(self._c_object,

600

True)

601

self.socket = socket

602

if credentials is None:

603

credentials = gnutls.Credentials()

604

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

605

ctypes.cast(credentials._c_object,

606

ctypes.c_void_p))

607

self.credentials = credentials

608

609

def __del__(self):

610

gnutls.deinit(self._c_object)

611

612

def handshake(self):

613

return gnutls.handshake(self._c_object)

614

615

def send(self, data):

616

data = bytes(data)

617

data_len = len(data)

618

while data_len > 0:

619

data_len -= gnutls.record_send(self._c_object,

620

data[-data_len:],

621

data_len)

622

623

def bye(self):

624

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

625

626

# Error handling functions

627

def _error_code(result):

628

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

629

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

630

if result >= 0:

631

return result

632

if result == gnutls.E_NO_CERTIFICATE_FOUND:

633

raise gnutls.CertificateSecurityError(code=result)

634

raise gnutls.Error(code=result)

635

636

def _retry_on_error(result, func, arguments):

637

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

638

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

639

while result < 0:

640

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

641

return _error_code(result)

642

result = func(*arguments)

643

return result

644

645

# Unless otherwise indicated, the function declarations below are

646

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

647

648

# Functions

649

priority_set_direct = _library.gnutls_priority_set_direct

650

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

651

ctypes.POINTER(ctypes.c_char_p)]

652

priority_set_direct.restype = _error_code

653

654

init = _library.gnutls_init

655

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

656

init.restype = _error_code

657

658

set_default_priority = _library.gnutls_set_default_priority

659

set_default_priority.argtypes = [session_t]

660

set_default_priority.restype = _error_code

661

662

record_send = _library.gnutls_record_send

663

record_send.argtypes = [session_t, ctypes.c_void_p,

664

ctypes.c_size_t]

665

record_send.restype = ctypes.c_ssize_t

666

record_send.errcheck = _retry_on_error

667

668

certificate_allocate_credentials = (

669

_library.gnutls_certificate_allocate_credentials)

670

certificate_allocate_credentials.argtypes = [

671

ctypes.POINTER(certificate_credentials_t)]

672

certificate_allocate_credentials.restype = _error_code

673

674

certificate_free_credentials = (

675

_library.gnutls_certificate_free_credentials)

676

certificate_free_credentials.argtypes = [

677

certificate_credentials_t]

678

certificate_free_credentials.restype = None

679

680

handshake_set_private_extensions = (

681

_library.gnutls_handshake_set_private_extensions)

682

handshake_set_private_extensions.argtypes = [session_t,

683

ctypes.c_int]

684

handshake_set_private_extensions.restype = None

685

686

credentials_set = _library.gnutls_credentials_set

687

credentials_set.argtypes = [session_t, credentials_type_t,

688

ctypes.c_void_p]

689

credentials_set.restype = _error_code

690

691

strerror = _library.gnutls_strerror

692

strerror.argtypes = [ctypes.c_int]

693

strerror.restype = ctypes.c_char_p

694

695

certificate_type_get = _library.gnutls_certificate_type_get

696

certificate_type_get.argtypes = [session_t]

697

certificate_type_get.restype = _error_code

698

699

certificate_get_peers = _library.gnutls_certificate_get_peers

700

certificate_get_peers.argtypes = [session_t,

701

ctypes.POINTER(ctypes.c_uint)]

702

certificate_get_peers.restype = ctypes.POINTER(datum_t)

703

704

global_set_log_level = _library.gnutls_global_set_log_level

705

global_set_log_level.argtypes = [ctypes.c_int]

706

global_set_log_level.restype = None

707

708

global_set_log_function = _library.gnutls_global_set_log_function

709

global_set_log_function.argtypes = [log_func]

710

global_set_log_function.restype = None

711

712

deinit = _library.gnutls_deinit

713

deinit.argtypes = [session_t]

714

deinit.restype = None

715

716

handshake = _library.gnutls_handshake

717

handshake.argtypes = [session_t]

718

handshake.restype = _error_code

719

handshake.errcheck = _retry_on_error

720

721

transport_set_ptr = _library.gnutls_transport_set_ptr

722

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

723

transport_set_ptr.restype = None

724

725

bye = _library.gnutls_bye

726

bye.argtypes = [session_t, close_request_t]

727

bye.restype = _error_code

728

bye.errcheck = _retry_on_error

729

730

check_version = _library.gnutls_check_version

731

check_version.argtypes = [ctypes.c_char_p]

732

check_version.restype = ctypes.c_char_p

733

734

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

735

736

openpgp_crt_init = _library.gnutls_openpgp_crt_init

737

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

738

openpgp_crt_init.restype = _error_code

739

740

openpgp_crt_import = _library.gnutls_openpgp_crt_import

741

openpgp_crt_import.argtypes = [openpgp_crt_t,

742

ctypes.POINTER(datum_t),

743

openpgp_crt_fmt_t]

744

openpgp_crt_import.restype = _error_code

745

746

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

747

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

748

ctypes.POINTER(ctypes.c_uint)]

749

openpgp_crt_verify_self.restype = _error_code

750

751

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

752

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

753

openpgp_crt_deinit.restype = None

754

755

openpgp_crt_get_fingerprint = (

756

_library.gnutls_openpgp_crt_get_fingerprint)

757

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

758

ctypes.c_void_p,

759

ctypes.POINTER(

760

ctypes.c_size_t)]

761

openpgp_crt_get_fingerprint.restype = _error_code

762

763

# Remove non-public functions

764

del _error_code, _retry_on_error

765

# Create the global "gnutls" object, simulating a module

766

gnutls = GnuTLS()

767

768

769

def call_pipe(connection, # : multiprocessing.Connection

770

func, *args, **kwargs):

771

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

772

773

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

774

return value on the provided multiprocessing.Connection.

775

"""

776

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

777

connection.close()

399

778

400

779

401

780

class Client(object):

402

781

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

403

782

404

783

Attributes:

405

784

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

406

785

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

408

787

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

409

788

to see if the client lives.

410

789

'None' if no process is running.

411

checker_callback_tag: a gobject event source tag, or None

790

checker_callback_tag: a GLib event source tag, or None

412

791

checker_command: string; External command which is run to check

413

792

if client lives. %() expansions are done at

414

793

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

415

794

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

416

checker_initiator_tag: a gobject event source tag, or None

795

checker_initiator_tag: a GLib event source tag, or None

417

796

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

418

797

client_structure: Object describing what attributes a client has

419

798

and is used for storing the client at exit

420

799

current_checker_command: string; current running checker_command

421

disable_initiator_tag: a gobject event source tag, or None

800

disable_initiator_tag: a GLib event source tag, or None

422

801

enabled: bool()

423

802

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

424

803

uniquely identify the client

429

808

last_checker_status: integer between 0 and 255 reflecting exit

430

809

status of last checker. -1 reflects crashed

431

810

checker, -2 means no checker completed yet.

811

last_checker_signal: The signal which killed the last checker, if

812

last_checker_status is -1

432

813

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

433

814

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

434

815

D-Bus identifiers

439

820

runtime_expansions: Allowed attributes for runtime expansion.

440

821

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

441

822

disabled, or None

823

server_settings: The server_settings dict from main()

442

824

"""

443

825

444

826

runtime_expansions = ("approval_delay", "approval_duration",

445

827

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

446

828

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

447

829

"last_approval_request", "last_checked_ok",

448

830

"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

831

client_defaults = {

832

"timeout": "PT5M",

833

"extended_timeout": "PT15M",

834

"interval": "PT2M",

835

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

836

"host": "",

837

"approval_delay": "PT0S",

838

"approval_duration": "PT1S",

839

"approved_by_default": "True",

840

"enabled": "True",

841

}

842

475

843

@staticmethod

476

844

def config_parser(config):

477

845

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

484

852

for client_name in config.sections():

485

853

section = dict(config.items(client_name))

486

854

client = settings[client_name] = {}

487

855

488

856

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

489

857

# Reformat values from string types to Python types

490

858

client["approved_by_default"] = config.getboolean(

491

859

client_name, "approved_by_default")

492

860

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

493

861

"enabled")

494

862

863

# Uppercase and remove spaces from fingerprint for later

864

# comparison purposes with return value from the

865

# fingerprint() function

495

866

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

496

867

.replace(" ", ""))

497

868

if "secret" in section:

498

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

869

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

870

.encode("utf-8"),

871

"base64")

499

872

elif "secfile" in section:

500

873

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

501

874

(section["secfile"])),

502

875

"rb") as secfile:

503

876

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

504

877

else:

505

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

878

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

506

879

.format(section))

507

880

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

508

881

client["extended_timeout"] = string_to_delta(

516

889

client["last_approval_request"] = None

517

890

client["last_checked_ok"] = None

518

891

client["last_checker_status"] = -2

519

892

520

893

return settings

521

522

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

894

895

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

523

896

self.name = name

897

if server_settings is None:

898

server_settings = {}

899

self.server_settings = server_settings

524

900

# adding all client settings

525

for setting, value in settings.iteritems():

901

for setting, value in settings.items():

526

902

setattr(self, setting, value)

527

903

528

904

if self.enabled:

529

905

if not hasattr(self, "last_enabled"):

530

906

self.last_enabled = datetime.datetime.utcnow()

534

910

else:

535

911

self.last_enabled = None

536

912

self.expires = None

537

913

538

914

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

542

915

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

543

916

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

544

917

datetime.datetime.utcnow())

545

918

546

919

# attributes specific for this server instance

547

920

self.checker = None

548

921

self.checker_initiator_tag = None

551

924

self.current_checker_command = None

552

925

self.approved = None

553

926

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

927

self.changedstate = multiprocessing_manager.Condition(

928

multiprocessing_manager.Lock())

929

self.client_structure = [attr

930

for attr in self.__dict__.keys()

559

931

if not attr.startswith("_")]

560

932

self.client_structure.append("client_structure")

561

562

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

563

lambda obj:

564

isinstance(obj,

565

property)):

933

934

for name, t in inspect.getmembers(

935

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

566

936

if not name.startswith("_"):

567

937

self.client_structure.append(name)

568

938

569

939

# Send notice to process children that client state has changed

570

940

def send_changedstate(self):

571

941

with self.changedstate:

572

942

self.changedstate.notify_all()

573

943

574

944

def enable(self):

575

945

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

576

946

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

581

951

self.last_enabled = datetime.datetime.utcnow()

582

952

self.init_checker()

583

953

self.send_changedstate()

584

954

585

955

def disable(self, quiet=True):

586

956

"""Disable this client."""

587

957

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

589

959

if not quiet:

590

960

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

591

961

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

592

gobject.source_remove(self.disable_initiator_tag)

962

GLib.source_remove(self.disable_initiator_tag)

593

963

self.disable_initiator_tag = None

594

964

self.expires = None

595

965

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

596

gobject.source_remove(self.checker_initiator_tag)

966

GLib.source_remove(self.checker_initiator_tag)

597

967

self.checker_initiator_tag = None

598

968

self.stop_checker()

599

969

self.enabled = False

600

970

if not quiet:

601

971

self.send_changedstate()

602

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

972

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

603

973

return False

604

974

605

975

def __del__(self):

606

976

self.disable()

607

977

608

978

def init_checker(self):

609

979

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

610

980

# and every interval from then on.

611

981

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

982

GLib.source_remove(self.checker_initiator_tag)

983

self.checker_initiator_tag = GLib.timeout_add(

984

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

985

self.start_checker)

616

986

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

617

987

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

988

GLib.source_remove(self.disable_initiator_tag)

989

self.disable_initiator_tag = GLib.timeout_add(

990

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

622

991

# Also start a new checker *right now*.

623

992

self.start_checker()

624

625

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

993

994

def checker_callback(self, source, condition, connection,

995

command):

626

996

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

627

997

self.checker_callback_tag = None

628

998

self.checker = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

999

# Read return code from connection (see call_pipe)

1000

returncode = connection.recv()

1001

connection.close()

1002

1003

if returncode >= 0:

1004

self.last_checker_status = returncode

1005

self.last_checker_signal = None

631

1006

if self.last_checker_status == 0:

632

1007

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

633

1008

vars(self))

634

1009

self.checked_ok()

635

1010

else:

636

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

637

vars(self))

1011

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

638

1012

else:

639

1013

self.last_checker_status = -1

1014

self.last_checker_signal = -returncode

640

1015

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

641

1016

vars(self))

642

1017

return False

1018

643

1019

def checked_ok(self):

644

1020

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

645

1021

self.last_checked_ok = datetime.datetime.utcnow()

646

1022

self.last_checker_status = 0

1023

self.last_checker_signal = None

647

1024

self.bump_timeout()

648

1025

649

1026

def bump_timeout(self, timeout=None):

650

1027

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

651

1028

if timeout is None:

652

1029

timeout = self.timeout

653

1030

if self.disable_initiator_tag is not None:

654

gobject.source_remove(self.disable_initiator_tag)

1031

GLib.source_remove(self.disable_initiator_tag)

655

1032

self.disable_initiator_tag = None

656

1033

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(timedelta_to_milliseconds

659

(timeout), self.disable))

1034

self.disable_initiator_tag = GLib.timeout_add(

1035

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

660

1036

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

661

1037

662

1038

def need_approval(self):

663

1039

self.last_approval_request = datetime.datetime.utcnow()

664

1040

665

1041

def start_checker(self):

666

1042

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

667

1043

668

1044

If a checker already exists, leave it running and do

669

1045

nothing."""

670

1046

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

675

1051

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

676

1052

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

677

1053

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

1054

1055

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

1056

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

1057

self.checker.join()

1058

self.checker = None

692

1059

# Start a new checker if needed

693

1060

if self.checker is None:

694

1061

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

1062

escaped_attrs = {

1063

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

1064

for attr in self.runtime_expansions}

699

1065

try:

700

1066

command = self.checker_command % escaped_attrs

701

1067

except TypeError as error:

702

1068

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

703

self.checker_command, exc_info=error)

704

return True # Try again later

1069

self.checker_command,

1070

exc_info=error)

1071

return True # Try again later

705

1072

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

1073

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

1074

self.name)

1075

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

1076

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

1077

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

1078

# always replaced by /dev/null.)

1079

# The exception is when not debugging but nevertheless

1080

# running in the foreground; use the previously

1081

# created wnull.

1082

popen_args = {"close_fds": True,

1083

"shell": True,

1084

"cwd": "/"}

1085

if (not self.server_settings["debug"]

1086

and self.server_settings["foreground"]):

1087

popen_args.update({"stdout": wnull,

1088

"stderr": wnull})

1089

pipe = multiprocessing.Pipe(duplex=False)

1090

self.checker = multiprocessing.Process(

1091

target=call_pipe,

1092

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

1093

kwargs=popen_args)

1094

self.checker.start()

1095

self.checker_callback_tag = GLib.io_add_watch(

1096

pipe[0].fileno(), GLib.IO_IN,

1097

self.checker_callback, pipe[0], command)

1098

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

730

1099

return True

731

1100

732

1101

def stop_checker(self):

733

1102

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

734

1103

if self.checker_callback_tag:

735

gobject.source_remove(self.checker_callback_tag)

1104

GLib.source_remove(self.checker_callback_tag)

736

1105

self.checker_callback_tag = None

737

1106

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

738

1107

return

739

1108

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

1109

self.checker.terminate()

748

1110

self.checker = None

749

1111

750

1112

751

def dbus_service_property(dbus_interface, signature="v",

752

access="readwrite", byte_arrays=False):

1113

def dbus_service_property(dbus_interface,

1114

signature="v",

1115

access="readwrite",

1116

byte_arrays=False):

753

1117

"""Decorators for marking methods of a DBusObjectWithProperties to

754

1118

become properties on the D-Bus.

755

1119

756

1120

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

757

1121

and with one argument by "Set".

758

1122

759

1123

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

760

1124

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

761

1125

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

764

1128

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

765

1129

if byte_arrays and signature != "ay":

766

1130

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

767

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

1131

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

1132

768

1133

def decorator(func):

769

1134

func._dbus_is_property = True

770

1135

func._dbus_interface = dbus_interface

773

1138

func._dbus_name = func.__name__

774

1139

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

775

1140

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

776

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1141

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

777

1142

return func

1143

778

1144

return decorator

779

1145

780

1146

781

1147

def dbus_interface_annotations(dbus_interface):

782

1148

"""Decorator for marking functions returning interface annotations

783

1149

784

1150

Usage:

785

1151

786

1152

@dbus_interface_annotations("org.example.Interface")

787

1153

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

788

1154

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

789

1155

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

790

1156

"false"}

791

1157

"""

1158

792

1159

def decorator(func):

793

1160

func._dbus_is_interface = True

794

1161

func._dbus_interface = dbus_interface

795

1162

func._dbus_name = dbus_interface

796

1163

return func

1164

797

1165

return decorator

798

1166

799

1167

800

1168

def dbus_annotations(annotations):

801

1169

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

802

1170

Usage:

803

1171

1172

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

1173

"org.freedesktop.DBus.Property."

1174

"EmitsChangedSignal": "false"})

804

1175

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

805

1176

access="r")

806

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

807

"org.freedesktop.DBus.Property."

808

"EmitsChangedSignal": "false"})

809

1177

def Property_dbus_property(self):

810

1178

return dbus.Boolean(False)

1179

1180

See also the DBusObjectWithAnnotations class.

811

1181

"""

1182

812

1183

def decorator(func):

813

1184

func._dbus_annotations = annotations

814

1185

return func

1186

815

1187

return decorator

816

1188

817

1189

818

1190

class DBusPropertyException(dbus.exceptions.DBusException):

819

1191

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

820

1192

"""

821

def __unicode__(self):

822

return unicode(str(self))

1193

pass

823

1194

824

1195

825

1196

class DBusPropertyAccessException(DBusPropertyException):

834

1205

pass

835

1206

836

1207

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.

1208

class DBusObjectWithAnnotations(dbus.service.Object):

1209

"""A D-Bus object with annotations.

1210

1211

Classes inheriting from this can use the dbus_annotations

1212

decorator to add annotations to methods or signals.

843

1213

"""

844

1214

845

1215

@staticmethod

846

1216

def _is_dbus_thing(thing):

847

1217

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

848

1218

849

1219

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

850

1220

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

851

1221

"""

852

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

1222

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

853

1223

False)

854

1224

855

1225

def _get_all_dbus_things(self, thing):

856

1226

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

857

1227

"""

858

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

859

name),

1228

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

860

1229

athing.__get__(self))

861

1230

for cls in self.__class__.__mro__

862

1231

for name, athing in

863

inspect.getmembers(cls,

864

self._is_dbus_thing(thing)))

865

1232

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

1233

1234

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1235

out_signature="s",

1236

path_keyword='object_path',

1237

connection_keyword='connection')

1238

def Introspect(self, object_path, connection):

1239

"""Overloading of standard D-Bus method.

1240

1241

Inserts annotation tags on methods and signals.

1242

"""

1243

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

1244

connection)

1245

try:

1246

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

1247

1248

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

1249

# Add annotation tags

1250

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

1251

for tag in if_tag.getElementsByTagName(typ):

1252

annots = dict()

1253

for name, prop in (self.

1254

_get_all_dbus_things(typ)):

1255

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

1256

and prop._dbus_interface

1257

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

1258

annots.update(getattr(

1259

prop, "_dbus_annotations", {}))

1260

for name, value in annots.items():

1261

ann_tag = document.createElement(

1262

"annotation")

1263

ann_tag.setAttribute("name", name)

1264

ann_tag.setAttribute("value", value)

1265

tag.appendChild(ann_tag)

1266

# Add interface annotation tags

1267

for annotation, value in dict(

1268

itertools.chain.from_iterable(

1269

annotations().items()

1270

for name, annotations

1271

in self._get_all_dbus_things("interface")

1272

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

1273

)).items():

1274

ann_tag = document.createElement("annotation")

1275

ann_tag.setAttribute("name", annotation)

1276

ann_tag.setAttribute("value", value)

1277

if_tag.appendChild(ann_tag)

1278

# Fix argument name for the Introspect method itself

1279

if (if_tag.getAttribute("name")

1280

== dbus.INTROSPECTABLE_IFACE):

1281

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

1282

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

1283

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

1284

if (arg.getAttribute("direction")

1285

== "out"):

1286

arg.setAttribute("name",

1287

"xml_data")

1288

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

1289

document.unlink()

1290

except (AttributeError, xml.dom.DOMException,

1291

xml.parsers.expat.ExpatError) as error:

1292

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

1293

exc_info=error)

1294

return xmlstring

1295

1296

1297

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1298

"""A D-Bus object with properties.

1299

1300

Classes inheriting from this can use the dbus_service_property

1301

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

1302

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

1303

"""

1304

866

1305

def _get_dbus_property(self, interface_name, property_name):

867

1306

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

868

1307

property with the specified name and interface.

869

1308

"""

870

for cls in self.__class__.__mro__:

871

for name, value in (inspect.getmembers

872

(cls,

873

self._is_dbus_thing("property"))):

1309

for cls in self.__class__.__mro__:

1310

for name, value in inspect.getmembers(

1311

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

874

1312

if (value._dbus_name == property_name

875

1313

and value._dbus_interface == interface_name):

876

1314

return value.__get__(self)

877

1315

878

1316

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

1317

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

1318

self.dbus_object_path, interface_name, property_name))

1319

1320

@classmethod

1321

def _get_all_interface_names(cls):

1322

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

1323

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

1324

"_dbus_interface", None)

1325

for x in (inspect.getmro(cls))

1326

for attr in dir(x))

1327

if name is not None)

1328

1329

@dbus.service.method(dbus.PROPERTIES_IFACE,

1330

in_signature="ss",

884

1331

out_signature="v")

885

1332

def Get(self, interface_name, property_name):

886

1333

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

892

1339

if not hasattr(value, "variant_level"):

893

1340

return value

894

1341

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

895

1342

896

1343

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

897

1344

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

898

1345

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

904

1351

# The byte_arrays option is not supported yet on

905

1352

# signatures other than "ay".

906

1353

if prop._dbus_signature != "ay":

907

raise ValueError

1354

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

1355

"'ay' signature {!r}"

1356

.format(prop._dbus_signature))

908

1357

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

909

1358

for byte in value))

910

1359

prop(value)

911

912

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

1360

1361

@dbus.service.method(dbus.PROPERTIES_IFACE,

1362

in_signature="s",

913

1363

out_signature="a{sv}")

914

1364

def GetAll(self, interface_name):

915

1365

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

916

1366

standard.

917

1367

918

1368

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

919

1369

"""

920

1370

properties = {}

930

1380

if not hasattr(value, "variant_level"):

931

1381

properties[name] = value

932

1382

continue

933

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

934

value.variant_level+1)

1383

properties[name] = type(value)(

1384

value, variant_level=value.variant_level + 1)

935

1385

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

936

1386

1387

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

1388

def PropertiesChanged(self, interface_name, changed_properties,

1389

invalidated_properties):

1390

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

1391

standard.

1392

"""

1393

pass

1394

937

1395

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

938

1396

out_signature="s",

939

1397

path_keyword='object_path',

940

1398

connection_keyword='connection')

941

1399

def Introspect(self, object_path, connection):

942

1400

"""Overloading of standard D-Bus method.

943

1401

944

1402

Inserts property tags and interface annotation tags.

945

1403

"""

946

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

947

connection)

1404

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1405

object_path,

1406

connection)

948

1407

try:

949

1408

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

1409

950

1410

def make_tag(document, name, prop):

951

1411

e = document.createElement("property")

952

1412

e.setAttribute("name", name)

953

1413

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

954

1414

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

955

1415

return e

1416

956

1417

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

957

1418

# Add property tags

958

1419

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

961

1422

if prop._dbus_interface

962

1423

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

963

1424

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)

1425

# Add annotation tags for properties

1426

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

1427

annots = dict()

1428

for name, prop in self._get_all_dbus_things(

1429

"property"):

1430

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

1431

and prop._dbus_interface

1432

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

1433

annots.update(getattr(

1434

prop, "_dbus_annotations", {}))

1435

for name, value in annots.items():

1436

ann_tag = document.createElement(

1437

"annotation")

1438

ann_tag.setAttribute("name", name)

1439

ann_tag.setAttribute("value", value)

1440

tag.appendChild(ann_tag)

995

1441

# Add the names to the return values for the

996

1442

# "org.freedesktop.DBus.Properties" methods

997

1443

if (if_tag.getAttribute("name")

1016

1462

return xmlstring

1017

1463

1018

1464

1465

try:

1466

dbus.OBJECT_MANAGER_IFACE

1467

except AttributeError:

1468

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

1469

1470

1471

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1472

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

1473

1474

Classes inheriting from this exposes the standard

1475

GetManagedObjects call and the InterfacesAdded and

1476

InterfacesRemoved signals on the standard

1477

"org.freedesktop.DBus.ObjectManager" interface.

1478

1479

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

1480

manually.

1481

"""

1482

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1483

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

1484

def GetManagedObjects(self):

1485

"""This function must be overridden"""

1486

raise NotImplementedError()

1487

1488

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1489

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

1490

def InterfacesAdded(self, object_path, interfaces_and_properties):

1491

pass

1492

1493

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

1494

def InterfacesRemoved(self, object_path, interfaces):

1495

pass

1496

1497

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1498

out_signature="s",

1499

path_keyword='object_path',

1500

connection_keyword='connection')

1501

def Introspect(self, object_path, connection):

1502

"""Overloading of standard D-Bus method.

1503

1504

Override return argument name of GetManagedObjects to be

1505

"objpath_interfaces_and_properties"

1506

"""

1507

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1508

object_path,

1509

connection)

1510

try:

1511

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

1512

1513

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

1514

# Fix argument name for the GetManagedObjects method

1515

if (if_tag.getAttribute("name")

1516

== dbus.OBJECT_MANAGER_IFACE):

1517

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

1518

if (cn.getAttribute("name")

1519

== "GetManagedObjects"):

1520

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

1521

if (arg.getAttribute("direction")

1522

== "out"):

1523

arg.setAttribute(

1524

"name",

1525

"objpath_interfaces"

1526

"_and_properties")

1527

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

1528

document.unlink()

1529

except (AttributeError, xml.dom.DOMException,

1530

xml.parsers.expat.ExpatError) as error:

1531

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

1532

exc_info=error)

1533

return xmlstring

1534

1535

1019

1536

def datetime_to_dbus(dt, variant_level=0):

1020

1537

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

1021

1538

if dt is None:

1022

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

1023

return dbus.String(dt.isoformat(),

1024

variant_level=variant_level)

1539

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

1540

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

1025

1541

1026

1542

1027

1543

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1029

1545

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

1030

1546

interface names according to the "alt_interface_names" mapping.

1031

1547

Usage:

1032

1548

1033

1549

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

1034

1550

"net.example.AlternateInterface"})

1035

1551

class SampleDBusObject(dbus.service.Object):

1036

1552

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

1037

1553

def SampleDBusMethod():

1038

1554

pass

1039

1555

1040

1556

The above "SampleDBusMethod" on "SampleDBusObject" will be

1041

1557

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

1042

1558

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

1043

1559

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

1044

1560

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

1045

1561

1046

1562

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

1047

1563

(from DBusObjectWithProperties) and interfaces (from the

1048

1564

dbus_interface_annotations decorator).

1049

1565

"""

1566

1050

1567

def wrapper(cls):

1051

1568

for orig_interface_name, alt_interface_name in (

1052

alt_interface_names.iteritems()):

1569

alt_interface_names.items()):

1053

1570

attr = {}

1054

1571

interface_names = set()

1055

1572

# Go though all attributes of the class

1057

1574

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

1058

1575

# with the wrong interface name

1059

1576

if (not hasattr(attribute, "_dbus_interface")

1060

or not attribute._dbus_interface

1061

.startswith(orig_interface_name)):

1577

or not attribute._dbus_interface.startswith(

1578

orig_interface_name)):

1062

1579

continue

1063

1580

# Create an alternate D-Bus interface name based on

1064

1581

# the current name

1065

alt_interface = (attribute._dbus_interface

1066

.replace(orig_interface_name,

1067

alt_interface_name))

1582

alt_interface = attribute._dbus_interface.replace(

1583

orig_interface_name, alt_interface_name)

1068

1584

interface_names.add(alt_interface)

1069

1585

# Is this a D-Bus signal?

1070

1586

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

1071

# Extract the original non-method function by

1072

# black magic

1073

nonmethod_func = (dict(

1587

# Extract the original non-method undecorated

1588

# function by black magic

1589

if sys.version_info.major == 2:

1590

nonmethod_func = (dict(

1074

1591

zip(attribute.func_code.co_freevars,

1075

attribute.__closure__))["func"]

1076

.cell_contents)

1592

attribute.__closure__))

1593

["func"].cell_contents)

1594

else:

1595

nonmethod_func = (dict(

1596

zip(attribute.__code__.co_freevars,

1597

attribute.__closure__))

1598

["func"].cell_contents)

1077

1599

# Create a new, but exactly alike, function

1078

1600

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

1079

1601

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

1602

new_function = copy_function(nonmethod_func)

1603

new_function = (dbus.service.signal(

1604

alt_interface,

1605

attribute._dbus_signature)(new_function))

1089

1606

# Copy annotations, if any

1090

1607

try:

1091

new_function._dbus_annotations = (

1092

dict(attribute._dbus_annotations))

1608

new_function._dbus_annotations = dict(

1609

attribute._dbus_annotations)

1093

1610

except AttributeError:

1094

1611

pass

1612

1095

1613

# Define a creator of a function to call both the

1096

1614

# original and alternate functions, so both the

1097

1615

# original and alternate signals gets sent when

1100

1618

"""This function is a scope container to pass

1101

1619

func1 and func2 to the "call_both" function

1102

1620

outside of its arguments"""

1621

1622

@functools.wraps(func2)

1103

1623

def call_both(*args, **kwargs):

1104

1624

"""This function will emit two D-Bus

1105

1625

signals by calling func1 and func2"""

1106

1626

func1(*args, **kwargs)

1107

1627

func2(*args, **kwargs)

1628

# Make wrapper function look like a D-Bus

1629

# signal

1630

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

1631

if name.startswith("_dbus_"):

1632

setattr(call_both, name, attr)

1633

1108

1634

return call_both

1109

1635

# Create the "call_both" function and add it to

1110

1636

# the class

1115

1641

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

1116

1642

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

1117

1643

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

1644

attr[attrname] = (

1645

dbus.service.method(

1646

alt_interface,

1647

attribute._dbus_in_signature,

1648

attribute._dbus_out_signature)

1649

(copy_function(attribute)))

1128

1650

# Copy annotations, if any

1129

1651

try:

1130

attr[attrname]._dbus_annotations = (

1131

dict(attribute._dbus_annotations))

1652

attr[attrname]._dbus_annotations = dict(

1653

attribute._dbus_annotations)

1132

1654

except AttributeError:

1133

1655

pass

1134

1656

# Is this a D-Bus property?

1137

1659

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

1138

1660

# property with the alternate D-Bus interface

1139

1661

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

1662

attr[attrname] = (dbus_service_property(

1663

alt_interface, attribute._dbus_signature,

1664

attribute._dbus_access,

1665

attribute._dbus_get_args_options

1666

["byte_arrays"])

1667

(copy_function(attribute)))

1153

1668

# Copy annotations, if any

1154

1669

try:

1155

attr[attrname]._dbus_annotations = (

1156

dict(attribute._dbus_annotations))

1670

attr[attrname]._dbus_annotations = dict(

1671

attribute._dbus_annotations)

1157

1672

except AttributeError:

1158

1673

pass

1159

1674

# Is this a D-Bus interface?

1162

1677

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

1163

1678

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

1164

1679

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

1680

attr[attrname] = (

1681

dbus_interface_annotations(alt_interface)

1682

(copy_function(attribute)))

1173

1683

if deprecate:

1174

1684

# Deprecate all alternate interfaces

1175

iname="_AlternateDBusNames_interface_annotation{0}"

1685

iname = "_AlternateDBusNames_interface_annotation{}"

1176

1686

for interface_name in interface_names:

1687

1177

1688

@dbus_interface_annotations(interface_name)

1178

1689

def func(self):

1179

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

1180

"true" }

1690

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

1691

"true"}

1181

1692

# Find an unused name

1182

1693

for aname in (iname.format(i)

1183

1694

for i in itertools.count()):

1187

1698

if interface_names:

1188

1699

# Replace the class with a new subclass of it with

1189

1700

# methods, signals, etc. as created above.

1190

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

1191

(cls,), attr)

1701

if sys.version_info.major == 2:

1702

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

1703

(cls, ), attr)

1704

else:

1705

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

1706

(cls, ), attr)

1192

1707

return cls

1708

1193

1709

return wrapper

1194

1710

1195

1711

1196

1712

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

1197

"se.bsnet.fukt.Mandos"})

1713

"se.bsnet.fukt.Mandos"})

1198

1714

class ClientDBus(Client, DBusObjectWithProperties):

1199

1715

"""A Client class using D-Bus

1200

1716

1201

1717

Attributes:

1202

1718

dbus_object_path: dbus.ObjectPath

1203

1719

bus: dbus.SystemBus()

1204

1720

"""

1205

1721

1206

1722

runtime_expansions = (Client.runtime_expansions

1207

+ ("dbus_object_path",))

1208

1723

+ ("dbus_object_path", ))

1724

1725

_interface = "se.recompile.Mandos.Client"

1726

1209

1727

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

1210

1211

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

1728

1729

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

1212

1730

self.bus = bus

1213

1731

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

1214

1732

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

1215

1733

# the D-Bus

1216

client_object_name = unicode(self.name).translate(

1734

client_object_name = str(self.name).translate(

1217

1735

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

1218

1736

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

1219

self.dbus_object_path = (dbus.ObjectPath

1220

("/clients/" + client_object_name))

1737

self.dbus_object_path = dbus.ObjectPath(

1738

"/clients/" + client_object_name)

1221

1739

DBusObjectWithProperties.__init__(self, self.bus,

1222

1740

self.dbus_object_path)

1223

1224

def notifychangeproperty(transform_func,

1225

dbus_name, type_func=lambda x: x,

1226

variant_level=1):

1741

1742

def notifychangeproperty(transform_func, dbus_name,

1743

type_func=lambda x: x,

1744

variant_level=1,

1745

invalidate_only=False,

1746

_interface=_interface):

1227

1747

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

1228

1748

its changes to DBus.

1229

1749

1230

1750

transform_fun: Function that takes a value and a variant_level

1231

1751

and transforms it to a D-Bus type.

1232

1752

dbus_name: D-Bus name of the variable

1234

1754

to the D-Bus. Default: no transform

1235

1755

variant_level: D-Bus variant level. Default: 1

1236

1756

"""

1237

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

1757

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

1758

1238

1759

def setter(self, value):

1239

1760

if hasattr(self, "dbus_object_path"):

1240

1761

if (not hasattr(self, attrname) or

1241

1762

type_func(getattr(self, attrname, None))

1242

1763

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

1764

if invalidate_only:

1765

self.PropertiesChanged(

1766

_interface, dbus.Dictionary(),

1767

dbus.Array((dbus_name, )))

1768

else:

1769

dbus_value = transform_func(

1770

type_func(value),

1771

variant_level=variant_level)

1772

self.PropertyChanged(dbus.String(dbus_name),

1773

dbus_value)

1774

self.PropertiesChanged(

1775

_interface,

1776

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

1777

dbus_value}),

1778

dbus.Array())

1248

1779

setattr(self, attrname, value)

1249

1780

1250

1781

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

1251

1782

1252

1783

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1253

1784

approvals_pending = notifychangeproperty(dbus.Boolean,

1254

1785

"ApprovalPending",

1255

type_func = bool)

1786

type_func=bool)

1256

1787

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

1257

1788

last_enabled = notifychangeproperty(datetime_to_dbus,

1258

1789

"LastEnabled")

1259

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

1260

type_func = lambda checker:

1261

checker is not None)

1790

checker = notifychangeproperty(

1791

dbus.Boolean, "CheckerRunning",

1792

type_func=lambda checker: checker is not None)

1262

1793

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1263

1794

"LastCheckedOK")

1264

1795

last_checker_status = notifychangeproperty(dbus.Int16,

1267

1798

datetime_to_dbus, "LastApprovalRequest")

1268

1799

approved_by_default = notifychangeproperty(dbus.Boolean,

1269

1800

"ApprovedByDefault")

1270

approval_delay = notifychangeproperty(dbus.UInt64,

1271

"ApprovalDelay",

1272

type_func =

1273

timedelta_to_milliseconds)

1801

approval_delay = notifychangeproperty(

1802

dbus.UInt64, "ApprovalDelay",

1803

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

1274

1804

approval_duration = notifychangeproperty(

1275

1805

dbus.UInt64, "ApprovalDuration",

1276

type_func = timedelta_to_milliseconds)

1806

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

1277

1807

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

1278

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

1279

type_func =

1280

timedelta_to_milliseconds)

1808

timeout = notifychangeproperty(

1809

dbus.UInt64, "Timeout",

1810

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

1281

1811

extended_timeout = notifychangeproperty(

1282

1812

dbus.UInt64, "ExtendedTimeout",

1283

type_func = timedelta_to_milliseconds)

1284

interval = notifychangeproperty(dbus.UInt64,

1285

"Interval",

1286

type_func =

1287

timedelta_to_milliseconds)

1813

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

1814

interval = notifychangeproperty(

1815

dbus.UInt64, "Interval",

1816

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

1288

1817

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

1289

1818

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

1819

invalidate_only=True)

1820

1290

1821

del notifychangeproperty

1291

1822

1292

1823

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

1293

1824

try:

1294

1825

self.remove_from_connection()

1297

1828

if hasattr(DBusObjectWithProperties, "__del__"):

1298

1829

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

1299

1830

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)

1831

1832

def checker_callback(self, source, condition,

1833

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

1834

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

1835

connection, command, *args,

1836

**kwargs)

1837

exitstatus = self.last_checker_status

1838

if exitstatus >= 0:

1307

1839

# Emit D-Bus signal

1308

1840

self.CheckerCompleted(dbus.Int16(exitstatus),

1309

dbus.Int64(condition),

1841

# This is specific to GNU libC

1842

dbus.Int64(exitstatus << 8),

1310

1843

dbus.String(command))

1311

1844

else:

1312

1845

# Emit D-Bus signal

1313

1846

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

1314

dbus.Int64(condition),

1847

dbus.Int64(

1848

# This is specific to GNU libC

1849

(exitstatus << 8)

1850

| self.last_checker_signal),

1315

1851

dbus.String(command))

1316

1317

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

1318

*args, **kwargs)

1319

1852

return ret

1853

1320

1854

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

1855

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

1326

1856

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

1327

1857

# Only if new checker process was started

1328

1858

if (self.checker is not None

1330

1860

# Emit D-Bus signal

1331

1861

self.CheckerStarted(self.current_checker_command)

1332

1862

return r

1333

1863

1334

1864

def _reset_approved(self):

1335

1865

self.approved = None

1336

1866

return False

1337

1867

1338

1868

def approve(self, value=True):

1339

1869

self.approved = value

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1870

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

1871

* 1000), self._reset_approved)

1343

1872

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

1873

1874

# D-Bus methods, signals & properties

1875

1876

# Interfaces

1877

1878

# Signals

1879

1357

1880

# CheckerCompleted - signal

1358

1881

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

1359

1882

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

1360

1883

"D-Bus signal"

1361

1884

pass

1362

1885

1363

1886

# CheckerStarted - signal

1364

1887

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

1365

1888

def CheckerStarted(self, command):

1366

1889

"D-Bus signal"

1367

1890

pass

1368

1891

1369

1892

# PropertyChanged - signal

1893

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

1370

1894

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

1371

1895

def PropertyChanged(self, property, value):

1372

1896

"D-Bus signal"

1373

1897

pass

1374

1898

1375

1899

# GotSecret - signal

1376

1900

@dbus.service.signal(_interface)

1377

1901

def GotSecret(self):

1380

1904

server to mandos-client

1381

1905

"""

1382

1906

pass

1383

1907

1384

1908

# Rejected - signal

1385

1909

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

1386

1910

def Rejected(self, reason):

1387

1911

"D-Bus signal"

1388

1912

pass

1389

1913

1390

1914

# NeedApproval - signal

1391

1915

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

1392

1916

def NeedApproval(self, timeout, default):

1393

1917

"D-Bus signal"

1394

1918

return self.need_approval()

1395

1396

## Methods

1397

1919

1920

# Methods

1921

1398

1922

# Approve - method

1399

1923

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

1400

1924

def Approve(self, value):

1401

1925

self.approve(value)

1402

1926

1403

1927

# CheckedOK - method

1404

1928

@dbus.service.method(_interface)

1405

1929

def CheckedOK(self):

1406

1930

self.checked_ok()

1407

1931

1408

1932

# Enable - method

1933

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

1409

1934

@dbus.service.method(_interface)

1410

1935

def Enable(self):

1411

1936

"D-Bus method"

1412

1937

self.enable()

1413

1938

1414

1939

# StartChecker - method

1940

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

1415

1941

@dbus.service.method(_interface)

1416

1942

def StartChecker(self):

1417

1943

"D-Bus method"

1418

1944

self.start_checker()

1419

1945

1420

1946

# Disable - method

1947

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

1421

1948

@dbus.service.method(_interface)

1422

1949

def Disable(self):

1423

1950

"D-Bus method"

1424

1951

self.disable()

1425

1952

1426

1953

# StopChecker - method

1954

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

1427

1955

@dbus.service.method(_interface)

1428

1956

def StopChecker(self):

1429

1957

self.stop_checker()

1430

1431

## Properties

1432

1958

1959

# Properties

1960

1433

1961

# ApprovalPending - property

1434

1962

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

1435

1963

def ApprovalPending_dbus_property(self):

1436

1964

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

1437

1965

1438

1966

# ApprovedByDefault - property

1439

@dbus_service_property(_interface, signature="b",

1967

@dbus_service_property(_interface,

1968

signature="b",

1440

1969

access="readwrite")

1441

1970

def ApprovedByDefault_dbus_property(self, value=None):

1442

1971

if value is None: # get

1443

1972

return dbus.Boolean(self.approved_by_default)

1444

1973

self.approved_by_default = bool(value)

1445

1974

1446

1975

# ApprovalDelay - property

1447

@dbus_service_property(_interface, signature="t",

1976

@dbus_service_property(_interface,

1977

signature="t",

1448

1978

access="readwrite")

1449

1979

def ApprovalDelay_dbus_property(self, value=None):

1450

1980

if value is None: # get

1451

return dbus.UInt64(self.approval_delay_milliseconds())

1981

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

1982

* 1000)

1452

1983

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

1453

1984

1454

1985

# ApprovalDuration - property

1455

@dbus_service_property(_interface, signature="t",

1986

@dbus_service_property(_interface,

1987

signature="t",

1456

1988

access="readwrite")

1457

1989

def ApprovalDuration_dbus_property(self, value=None):

1458

1990

if value is None: # get

1459

return dbus.UInt64(timedelta_to_milliseconds(

1460

self.approval_duration))

1991

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

1992

* 1000)

1461

1993

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

1462

1994

1463

1995

# Name - property

1996

@dbus_annotations(

1997

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

1464

1998

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

1465

1999

def Name_dbus_property(self):

1466

2000

return dbus.String(self.name)

1467

2001

1468

2002

# Fingerprint - property

2003

@dbus_annotations(

2004

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

1469

2005

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

1470

2006

def Fingerprint_dbus_property(self):

1471

2007

return dbus.String(self.fingerprint)

1472

2008

1473

2009

# Host - property

1474

@dbus_service_property(_interface, signature="s",

2010

@dbus_service_property(_interface,

2011

signature="s",

1475

2012

access="readwrite")

1476

2013

def Host_dbus_property(self, value=None):

1477

2014

if value is None: # get

1478

2015

return dbus.String(self.host)

1479

self.host = unicode(value)

1480

2016

self.host = str(value)

2017

1481

2018

# Created - property

2019

@dbus_annotations(

2020

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

1482

2021

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

1483

2022

def Created_dbus_property(self):

1484

2023

return datetime_to_dbus(self.created)

1485

2024

1486

2025

# LastEnabled - property

1487

2026

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

1488

2027

def LastEnabled_dbus_property(self):

1489

2028

return datetime_to_dbus(self.last_enabled)

1490

2029

1491

2030

# Enabled - property

1492

@dbus_service_property(_interface, signature="b",

2031

@dbus_service_property(_interface,

2032

signature="b",

1493

2033

access="readwrite")

1494

2034

def Enabled_dbus_property(self, value=None):

1495

2035

if value is None: # get

1498

2038

self.enable()

1499

2039

else:

1500

2040

self.disable()

1501

2041

1502

2042

# LastCheckedOK - property

1503

@dbus_service_property(_interface, signature="s",

2043

@dbus_service_property(_interface,

2044

signature="s",

1504

2045

access="readwrite")

1505

2046

def LastCheckedOK_dbus_property(self, value=None):

1506

2047

if value is not None:

1507

2048

self.checked_ok()

1508

2049

return

1509

2050

return datetime_to_dbus(self.last_checked_ok)

1510

2051

1511

2052

# LastCheckerStatus - property

1512

@dbus_service_property(_interface, signature="n",

1513

access="read")

2053

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

1514

2054

def LastCheckerStatus_dbus_property(self):

1515

2055

return dbus.Int16(self.last_checker_status)

1516

2056

1517

2057

# Expires - property

1518

2058

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

1519

2059

def Expires_dbus_property(self):

1520

2060

return datetime_to_dbus(self.expires)

1521

2061

1522

2062

# LastApprovalRequest - property

1523

2063

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

1524

2064

def LastApprovalRequest_dbus_property(self):

1525

2065

return datetime_to_dbus(self.last_approval_request)

1526

2066

1527

2067

# Timeout - property

1528

@dbus_service_property(_interface, signature="t",

2068

@dbus_service_property(_interface,

2069

signature="t",

1529

2070

access="readwrite")

1530

2071

def Timeout_dbus_property(self, value=None):

1531

2072

if value is None: # get

1532

return dbus.UInt64(self.timeout_milliseconds())

2073

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

1533

2074

old_timeout = self.timeout

1534

2075

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

1535

2076

# Reschedule disabling

1543

2084

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

1544

2085

is None):

1545

2086

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

2087

GLib.source_remove(self.disable_initiator_tag)

2088

self.disable_initiator_tag = GLib.timeout_add(

2089

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

2090

self.disable)

2091

1552

2092

# ExtendedTimeout - property

1553

@dbus_service_property(_interface, signature="t",

2093

@dbus_service_property(_interface,

2094

signature="t",

1554

2095

access="readwrite")

1555

2096

def ExtendedTimeout_dbus_property(self, value=None):

1556

2097

if value is None: # get

1557

return dbus.UInt64(self.extended_timeout_milliseconds())

2098

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

2099

* 1000)

1558

2100

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

1559

2101

1560

2102

# Interval - property

1561

@dbus_service_property(_interface, signature="t",

2103

@dbus_service_property(_interface,

2104

signature="t",

1562

2105

access="readwrite")

1563

2106

def Interval_dbus_property(self, value=None):

1564

2107

if value is None: # get

1565

return dbus.UInt64(self.interval_milliseconds())

2108

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

1566

2109

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

1567

2110

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

1568

2111

return

1569

2112

if self.enabled:

1570

2113

# 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

2114

GLib.source_remove(self.checker_initiator_tag)

2115

self.checker_initiator_tag = GLib.timeout_add(

2116

value, self.start_checker)

2117

self.start_checker() # Start one now, too

2118

1576

2119

# Checker - property

1577

@dbus_service_property(_interface, signature="s",

2120

@dbus_service_property(_interface,

2121

signature="s",

1578

2122

access="readwrite")

1579

2123

def Checker_dbus_property(self, value=None):

1580

2124

if value is None: # get

1581

2125

return dbus.String(self.checker_command)

1582

self.checker_command = unicode(value)

1583

2126

self.checker_command = str(value)

2127

1584

2128

# CheckerRunning - property

1585

@dbus_service_property(_interface, signature="b",

2129

@dbus_service_property(_interface,

2130

signature="b",

1586

2131

access="readwrite")

1587

2132

def CheckerRunning_dbus_property(self, value=None):

1588

2133

if value is None: # get

1591

2136

self.start_checker()

1592

2137

else:

1593

2138

self.stop_checker()

1594

2139

1595

2140

# ObjectPath - property

2141

@dbus_annotations(

2142

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

2143

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

1596

2144

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

1597

2145

def ObjectPath_dbus_property(self):

1598

return self.dbus_object_path # is already a dbus.ObjectPath

1599

2146

return self.dbus_object_path # is already a dbus.ObjectPath

2147

1600

2148

# Secret = property

1601

@dbus_service_property(_interface, signature="ay",

1602

access="write", byte_arrays=True)

2149

@dbus_annotations(

2150

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

2151

"invalidates"})

2152

@dbus_service_property(_interface,

2153

signature="ay",

2154

access="write",

2155

byte_arrays=True)

1603

2156

def Secret_dbus_property(self, value):

1604

self.secret = str(value)

1605

2157

self.secret = bytes(value)

2158

1606

2159

del _interface

1607

2160

1608

2161

1611

2164

self._pipe = child_pipe

1612

2165

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

1613

2166

if not self._pipe.recv():

1614

raise KeyError()

1615

2167

raise KeyError(fpr)

2168

1616

2169

def __getattribute__(self, name):

1617

2170

if name == '_pipe':

1618

2171

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

1621

2174

if data[0] == 'data':

1622

2175

return data[1]

1623

2176

if data[0] == 'function':

2177

1624

2178

def func(*args, **kwargs):

1625

2179

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

1626

2180

return self._pipe.recv()[1]

2181

1627

2182

return func

1628

2183

1629

2184

def __setattr__(self, name, value):

1630

2185

if name == '_pipe':

1631

2186

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

1634

2189

1635

2190

class ClientHandler(socketserver.BaseRequestHandler, object):

1636

2191

"""A class to handle client connections.

1637

2192

1638

2193

Instantiated once for each connection to handle it.

1639

2194

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

1640

2195

1641

2196

def handle(self):

1642

2197

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

1643

2198

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

1644

unicode(self.client_address))

2199

str(self.client_address))

1645

2200

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

1646

2201

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

2202

2203

session = gnutls.ClientSession(self.request)

2204

2205

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

2206

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

2207

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

2208

# "+DHE-DSS"))

1662

2209

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

1663

2210

priority = self.server.gnutls_priority

1664

2211

if priority is None:

1665

2212

priority = "NORMAL"

1666

(gnutls.library.functions

1667

.gnutls_priority_set_direct(session._c_object,

1668

priority, None))

1669

2213

gnutls.priority_set_direct(session._c_object,

2214

priority.encode("utf-8"),

2215

None)

2216

1670

2217

# Start communication using the Mandos protocol

1671

2218

# Get protocol number

1672

2219

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

1673

2220

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

1674

2221

try:

1675

2222

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

1676

raise RuntimeError

2223

raise RuntimeError(line)

1677

2224

except (ValueError, IndexError, RuntimeError) as error:

1678

2225

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

1679

2226

return

1680

2227

1681

2228

# Start GnuTLS connection

1682

2229

try:

1683

2230

session.handshake()

1684

except gnutls.errors.GNUTLSError as error:

2231

except gnutls.Error as error:

1685

2232

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

1686

2233

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

1687

2234

# established. Just abandon the request.

1688

2235

return

1689

2236

logger.debug("Handshake succeeded")

1690

2237

1691

2238

approval_required = False

1692

2239

try:

1693

2240

try:

1694

fpr = self.fingerprint(self.peer_certificate

1695

(session))

1696

except (TypeError,

1697

gnutls.errors.GNUTLSError) as error:

2241

fpr = self.fingerprint(

2242

self.peer_certificate(session))

2243

except (TypeError, gnutls.Error) as error:

1698

2244

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

1699

2245

return

1700

2246

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

1701

2247

1702

2248

try:

1703

2249

client = ProxyClient(child_pipe, fpr,

1704

2250

self.client_address)

1705

2251

except KeyError:

1706

2252

return

1707

2253

1708

2254

if client.approval_delay:

1709

2255

delay = client.approval_delay

1710

2256

client.approvals_pending += 1

1711

2257

approval_required = True

1712

2258

1713

2259

while True:

1714

2260

if not client.enabled:

1715

2261

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

1716

client.name)

2262

client.name)

1717

2263

if self.server.use_dbus:

1718

2264

# Emit D-Bus signal

1719

2265

client.Rejected("Disabled")

1720

2266

return

1721

2267

1722

2268

if client.approved or not client.approval_delay:

1723

#We are approved or approval is disabled

2269

# We are approved or approval is disabled

1724

2270

break

1725

2271

elif client.approved is None:

1726

2272

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

1728

2274

if self.server.use_dbus:

1729

2275

# Emit D-Bus signal

1730

2276

client.NeedApproval(

1731

client.approval_delay_milliseconds(),

1732

client.approved_by_default)

2277

client.approval_delay.total_seconds()

2278

* 1000, client.approved_by_default)

1733

2279

else:

1734

2280

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

1735

2281

client.name)

1737

2283

# Emit D-Bus signal

1738

2284

client.Rejected("Denied")

1739

2285

return

1740

1741

#wait until timeout or approved

2286

2287

# wait until timeout or approved

1742

2288

time = datetime.datetime.now()

1743

2289

client.changedstate.acquire()

1744

client.changedstate.wait(

1745

float(timedelta_to_milliseconds(delay)

1746

/ 1000))

2290

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

1747

2291

client.changedstate.release()

1748

2292

time2 = datetime.datetime.now()

1749

2293

if (time2 - time) >= delay:

1759

2303

break

1760

2304

else:

1761

2305

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

2306

2307

try:

2308

session.send(client.secret)

2309

except gnutls.Error as error:

2310

logger.warning("gnutls send failed",

2311

exc_info=error)

2312

return

2313

1776

2314

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

1777

2315

# bump the timeout using extended_timeout

1778

2316

client.bump_timeout(client.extended_timeout)

1779

2317

if self.server.use_dbus:

1780

2318

# Emit D-Bus signal

1781

2319

client.GotSecret()

1782

2320

1783

2321

finally:

1784

2322

if approval_required:

1785

2323

client.approvals_pending -= 1

1786

2324

try:

1787

2325

session.bye()

1788

except gnutls.errors.GNUTLSError as error:

2326

except gnutls.Error as error:

1789

2327

logger.warning("GnuTLS bye failed",

1790

2328

exc_info=error)

1791

2329

1792

2330

@staticmethod

1793

2331

def peer_certificate(session):

1794

2332

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

1795

2333

# 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

2334

if (gnutls.certificate_type_get(session._c_object)

2335

!= gnutls.CRT_OPENPGP):

2336

# ...return invalid data

2337

return b""

1801

2338

list_size = ctypes.c_uint(1)

1802

cert_list = (gnutls.library.functions

1803

.gnutls_certificate_get_peers

2339

cert_list = (gnutls.certificate_get_peers

1804

2340

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

1805

2341

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

1806

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

1807

" certificate")

2342

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

1808

2343

if list_size.value == 0:

1809

2344

return None

1810

2345

cert = cert_list[0]

1811

2346

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

1812

2347

1813

2348

@staticmethod

1814

2349

def fingerprint(openpgp):

1815

2350

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1816

2351

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

2352

datum = gnutls.datum_t(

2353

ctypes.cast(ctypes.c_char_p(openpgp),

2354

ctypes.POINTER(ctypes.c_ubyte)),

2355

ctypes.c_uint(len(openpgp)))

1822

2356

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

2357

crt = gnutls.openpgp_crt_t()

2358

gnutls.openpgp_crt_init(ctypes.byref(crt))

1826

2359

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

2360

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

2361

gnutls.OPENPGP_FMT_RAW)

1831

2362

# Verify the self signature in the key

1832

2363

crtverify = ctypes.c_uint()

1833

(gnutls.library.functions

1834

.gnutls_openpgp_crt_verify_self(crt, 0,

1835

ctypes.byref(crtverify)))

2364

gnutls.openpgp_crt_verify_self(crt, 0,

2365

ctypes.byref(crtverify))

1836

2366

if crtverify.value != 0:

1837

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1838

raise (gnutls.errors.CertificateSecurityError

1839

("Verify failed"))

2367

gnutls.openpgp_crt_deinit(crt)

2368

raise gnutls.CertificateSecurityError(code

2369

=crtverify.value)

1840

2370

# New buffer for the fingerprint

1841

2371

buf = ctypes.create_string_buffer(20)

1842

2372

buf_len = ctypes.c_size_t()

1843

2373

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

2374

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

2375

ctypes.byref(buf_len))

1847

2376

# Deinit the certificate

1848

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2377

gnutls.openpgp_crt_deinit(crt)

1849

2378

# Convert the buffer to a Python bytestring

1850

2379

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

1851

2380

# Convert the bytestring to hexadecimal notation

1855

2384

1856

2385

class MultiprocessingMixIn(object):

1857

2386

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

2387

1858

2388

def sub_process_main(self, request, address):

1859

2389

try:

1860

2390

self.finish_request(request, address)

1861

2391

except Exception:

1862

2392

self.handle_error(request, address)

1863

2393

self.close_request(request)

1864

2394

1865

2395

def process_request(self, request, address):

1866

2396

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

1867

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

1868

args = (request, address))

2397

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

2398

args=(request, address))

1869

2399

proc.start()

1870

2400

return proc

1871

2401

1872

2402

1873

2403

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1874

2404

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

2405

1875

2406

def process_request(self, request, client_address):

1876

2407

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

1877

2408

1878

2409

This function creates a new pipe in self.pipe

1879

2410

"""

1880

2411

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1881

2412

1882

2413

proc = MultiprocessingMixIn.process_request(self, request,

1883

2414

client_address)

1884

2415

self.child_pipe.close()

1885

2416

self.add_pipe(parent_pipe, proc)

1886

2417

1887

2418

def add_pipe(self, parent_pipe, proc):

1888

2419

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

1889

raise NotImplementedError

2420

raise NotImplementedError()

1890

2421

1891

2422

1892

2423

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1893

2424

socketserver.TCPServer, object):

1894

2425

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

1895

2426

1896

2427

Attributes:

1897

2428

enabled: Boolean; whether this server is activated yet

1898

2429

interface: None or a network interface name (string)

1899

2430

use_ipv6: Boolean; to use IPv6 or not

1900

2431

"""

2432

1901

2433

def __init__(self, server_address, RequestHandlerClass,

1902

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

2434

interface=None,

2435

use_ipv6=True,

2436

socketfd=None):

1903

2437

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

1904

2438

creating a new one with socket.socket().

1905

2439

"""

1911

2445

self.socketfd = socketfd

1912

2446

# Save the original socket.socket() function

1913

2447

self.socket_socket = socket.socket

2448

1914

2449

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

1915

#

2450

#

1916

2451

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

1917

2452

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

1918

2453

# patching socket.socket.)

1919

#

2454

#

1920

2455

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

1921

2456

@functools.wraps(socket.socket)

1922

2457

def socket_wrapper(*args, **kwargs):

1934

2469

# socket_wrapper(), if socketfd was set.

1935

2470

socketserver.TCPServer.__init__(self, server_address,

1936

2471

RequestHandlerClass)

1937

2472

1938

2473

def server_bind(self):

1939

2474

"""This overrides the normal server_bind() function

1940

2475

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

1941

2476

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

2477

global SO_BINDTODEVICE

1942

2478

if self.interface is not None:

1943

2479

if SO_BINDTODEVICE is None:

1944

logger.error("SO_BINDTODEVICE does not exist;"

1945

" cannot bind to interface %s",

1946

self.interface)

1947

else:

1948

try:

1949

self.socket.setsockopt(socket.SOL_SOCKET,

1950

SO_BINDTODEVICE,

1951

str(self.interface

1952

+ '\0'))

1953

except socket.error as error:

1954

if error.errno == errno.EPERM:

1955

logger.error("No permission to"

1956

" bind to interface %s",

1957

self.interface)

1958

elif error.errno == errno.ENOPROTOOPT:

1959

logger.error("SO_BINDTODEVICE not available;"

1960

" cannot bind to interface %s",

1961

self.interface)

1962

elif error.errno == errno.ENODEV:

1963

logger.error("Interface %s does not"

1964

" exist, cannot bind",

1965

self.interface)

1966

else:

1967

raise

2480

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

2481

# common enough.

2482

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

2483

SO_BINDTODEVICE = 25

2484

try:

2485

self.socket.setsockopt(

2486

socket.SOL_SOCKET, SO_BINDTODEVICE,

2487

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

2488

except socket.error as error:

2489

if error.errno == errno.EPERM:

2490

logger.error("No permission to bind to"

2491

" interface %s", self.interface)

2492

elif error.errno == errno.ENOPROTOOPT:

2493

logger.error("SO_BINDTODEVICE not available;"

2494

" cannot bind to interface %s",

2495

self.interface)

2496

elif error.errno == errno.ENODEV:

2497

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

2498

" cannot bind", self.interface)

2499

else:

2500

raise

1968

2501

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

1969

2502

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

1970

2503

if not self.server_address[0]:

1971

2504

if self.address_family == socket.AF_INET6:

1972

any_address = "::" # in6addr_any

2505

any_address = "::" # in6addr_any

1973

2506

else:

1974

any_address = socket.INADDR_ANY

2507

any_address = "0.0.0.0" # INADDR_ANY

1975

2508

self.server_address = (any_address,

1976

2509

self.server_address[1])

1977

2510

elif not self.server_address[1]:

1978

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

1979

0)

2511

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

1980

2512

# if self.interface:

1981

2513

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

1982

2514

# 0, # port

1988

2520

1989

2521

class MandosServer(IPv6_TCPServer):

1990

2522

"""Mandos server.

1991

2523

1992

2524

Attributes:

1993

2525

clients: set of Client objects

1994

2526

gnutls_priority GnuTLS priority string

1995

2527

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

1996

1997

Assumes a gobject.MainLoop event loop.

2528

2529

Assumes a GLib.MainLoop event loop.

1998

2530

"""

2531

1999

2532

def __init__(self, server_address, RequestHandlerClass,

2000

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

2001

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

2533

interface=None,

2534

use_ipv6=True,

2535

clients=None,

2536

gnutls_priority=None,

2537

use_dbus=True,

2538

socketfd=None):

2002

2539

self.enabled = False

2003

2540

self.clients = clients

2004

2541

if self.clients is None:

2007

2544

self.gnutls_priority = gnutls_priority

2008

2545

IPv6_TCPServer.__init__(self, server_address,

2009

2546

RequestHandlerClass,

2010

interface = interface,

2011

use_ipv6 = use_ipv6,

2012

socketfd = socketfd)

2547

interface=interface,

2548

use_ipv6=use_ipv6,

2549

socketfd=socketfd)

2550

2013

2551

def server_activate(self):

2014

2552

if self.enabled:

2015

2553

return socketserver.TCPServer.server_activate(self)

2016

2554

2017

2555

def enable(self):

2018

2556

self.enabled = True

2019

2557

2020

2558

def add_pipe(self, parent_pipe, proc):

2021

2559

# Call "handle_ipc" for both data and EOF events

2022

gobject.io_add_watch(parent_pipe.fileno(),

2023

gobject.IO_IN | gobject.IO_HUP,

2024

functools.partial(self.handle_ipc,

2025

parent_pipe =

2026

parent_pipe,

2027

proc = proc))

2028

2029

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

2030

proc = None, client_object=None):

2560

GLib.io_add_watch(

2561

parent_pipe.fileno(),

2562

GLib.IO_IN | GLib.IO_HUP,

2563

functools.partial(self.handle_ipc,

2564

parent_pipe=parent_pipe,

2565

proc=proc))

2566

2567

def handle_ipc(self, source, condition,

2568

parent_pipe=None,

2569

proc=None,

2570

client_object=None):

2031

2571

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

2032

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

2572

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

2033

2573

# Wait for other process to exit

2034

2574

proc.join()

2035

2575

return False

2036

2576

2037

2577

# Read a request from the child

2038

2578

request = parent_pipe.recv()

2039

2579

command = request[0]

2040

2580

2041

2581

if command == 'init':

2042

fpr = request[1]

2582

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

2043

2583

address = request[2]

2044

2045

for c in self.clients.itervalues():

2584

2585

for c in self.clients.values():

2046

2586

if c.fingerprint == fpr:

2047

2587

client = c

2048

2588

break

2055

2595

address[0])

2056

2596

parent_pipe.send(False)

2057

2597

return False

2058

2059

gobject.io_add_watch(parent_pipe.fileno(),

2060

gobject.IO_IN | gobject.IO_HUP,

2061

functools.partial(self.handle_ipc,

2062

parent_pipe =

2063

parent_pipe,

2064

proc = proc,

2065

client_object =

2066

client))

2598

2599

GLib.io_add_watch(

2600

parent_pipe.fileno(),

2601

GLib.IO_IN | GLib.IO_HUP,

2602

functools.partial(self.handle_ipc,

2603

parent_pipe=parent_pipe,

2604

proc=proc,

2605

client_object=client))

2067

2606

parent_pipe.send(True)

2068

2607

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

2069

2608

# same fileno

2072

2611

funcname = request[1]

2073

2612

args = request[2]

2074

2613

kwargs = request[3]

2075

2614

2076

2615

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

2077

2616

funcname)(*args,

2078

**kwargs)))

2079

2617

**kwargs)))

2618

2080

2619

if command == 'getattr':

2081

2620

attrname = request[1]

2082

if callable(client_object.__getattribute__(attrname)):

2083

parent_pipe.send(('function',))

2621

if isinstance(client_object.__getattribute__(attrname),

2622

collections.Callable):

2623

parent_pipe.send(('function', ))

2084

2624

else:

2085

parent_pipe.send(('data', client_object

2086

.__getattribute__(attrname)))

2087

2625

parent_pipe.send((

2626

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

2627

2088

2628

if command == 'setattr':

2089

2629

attrname = request[1]

2090

2630

value = request[2]

2091

2631

setattr(client_object, attrname, value)

2092

2632

2093

2633

return True

2094

2634

2095

2635

2636

def rfc3339_duration_to_delta(duration):

2637

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

2638

2639

>>> rfc3339_duration_to_delta("P7D")

2640

datetime.timedelta(7)

2641

>>> rfc3339_duration_to_delta("PT60S")

2642

datetime.timedelta(0, 60)

2643

>>> rfc3339_duration_to_delta("PT60M")

2644

datetime.timedelta(0, 3600)

2645

>>> rfc3339_duration_to_delta("PT24H")

2646

datetime.timedelta(1)

2647

>>> rfc3339_duration_to_delta("P1W")

2648

datetime.timedelta(7)

2649

>>> rfc3339_duration_to_delta("PT5M30S")

2650

datetime.timedelta(0, 330)

2651

>>> rfc3339_duration_to_delta("P1DT3M20S")

2652

datetime.timedelta(1, 200)

2653

"""

2654

2655

# Parsing an RFC 3339 duration with regular expressions is not

2656

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

2657

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

2658

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

2659

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

2660

# avoid excessive use of external libraries.

2661

2662

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

2663

Token = collections.namedtuple("Token", (

2664

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

2665

# a "group" containing digits

2666

"value", # datetime.timedelta or None

2667

"followers")) # Tokens valid after this token

2668

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

2669

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

2670

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

2671

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

2672

datetime.timedelta(seconds=1),

2673

frozenset((token_end, )))

2674

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

2675

datetime.timedelta(minutes=1),

2676

frozenset((token_second, token_end)))

2677

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

2678

datetime.timedelta(hours=1),

2679

frozenset((token_minute, token_end)))

2680

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

2681

None,

2682

frozenset((token_hour, token_minute,

2683

token_second)))

2684

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

2685

datetime.timedelta(days=1),

2686

frozenset((token_time, token_end)))

2687

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

2688

datetime.timedelta(weeks=4),

2689

frozenset((token_day, token_end)))

2690

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

2691

datetime.timedelta(weeks=52),

2692

frozenset((token_month, token_end)))

2693

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

2694

datetime.timedelta(weeks=1),

2695

frozenset((token_end, )))

2696

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

2697

frozenset((token_year, token_month,

2698

token_day, token_time,

2699

token_week)))

2700

# Define starting values:

2701

# Value so far

2702

value = datetime.timedelta()

2703

found_token = None

2704

# Following valid tokens

2705

followers = frozenset((token_duration, ))

2706

# String left to parse

2707

s = duration

2708

# Loop until end token is found

2709

while found_token is not token_end:

2710

# Search for any currently valid tokens

2711

for token in followers:

2712

match = token.regexp.match(s)

2713

if match is not None:

2714

# Token found

2715

if token.value is not None:

2716

# Value found, parse digits

2717

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

2718

# Add to value so far

2719

value += factor * token.value

2720

# Strip token from string

2721

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

2722

# Go to found token

2723

found_token = token

2724

# Set valid next tokens

2725

followers = found_token.followers

2726

break

2727

else:

2728

# No currently valid tokens were found

2729

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

2730

.format(duration))

2731

# End token found

2732

return value

2733

2734

2096

2735

def string_to_delta(interval):

2097

2736

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

2098

2737

2099

2738

>>> string_to_delta('7d')

2100

2739

datetime.timedelta(7)

2101

2740

>>> string_to_delta('60s')

2109

2748

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

2110

2749

datetime.timedelta(0, 330)

2111

2750

"""

2751

2752

try:

2753

return rfc3339_duration_to_delta(interval)

2754

except ValueError:

2755

pass

2756

2112

2757

timevalue = datetime.timedelta(0)

2113

2758

for s in interval.split():

2114

2759

try:

2115

suffix = unicode(s[-1])

2760

suffix = s[-1]

2116

2761

value = int(s[:-1])

2117

2762

if suffix == "d":

2118

2763

delta = datetime.timedelta(value)

2125

2770

elif suffix == "w":

2126

2771

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

2127

2772

else:

2128

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

2129

.format(suffix))

2130

except (ValueError, IndexError) as e:

2773

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

2774

except IndexError as e:

2131

2775

raise ValueError(*(e.args))

2132

2776

timevalue += delta

2133

2777

return timevalue

2134

2778

2135

2779

2136

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

2780

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

2137

2781

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

2138

2782

2139

2783

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

2140

2784

if os.fork():

2141

2785

sys.exit()

2149

2793

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

2150

2794

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

2151

2795

raise OSError(errno.ENODEV,

2152

"{0} not a character device"

2796

"{} not a character device"

2153

2797

.format(os.devnull))

2154

2798

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

2155

2799

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

2159

2803

2160

2804

2161

2805

def main():

2162

2806

2163

2807

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

2164

2808

# Parsing of options, both command line and config file

2165

2809

2166

2810

parser = argparse.ArgumentParser()

2167

2811

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

2168

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

2812

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

2169

2813

help="show version number and exit")

2170

2814

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

2171

2815

help="Bind to interface IF")

2177

2821

help="Run self-test")

2178

2822

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

2179

2823

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

2180

" to terminal")

2824

" to terminal", default=None)

2181

2825

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

2182

2826

help="Debug level for stdout output")

2183

2827

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

2190

2834

" files")

2191

2835

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

2192

2836

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

2193

" system bus interface")

2837

" system bus interface", default=None)

2194

2838

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

2195

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

2839

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

2840

default=None)

2196

2841

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

2197

2842

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

2198

" state")

2843

" state", default=None)

2199

2844

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

2200

2845

help="Specify a file descriptor to a network"

2201

2846

" socket to use instead of creating one")

2202

2847

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

2203

2848

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

2204

2849

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

2850

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

2851

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

2852

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

2853

default=None)

2854

2205

2855

options = parser.parse_args()

2206

2856

2207

2857

if options.check:

2208

2858

import doctest

2209

doctest.testmod()

2210

sys.exit()

2211

2859

fail_count, test_count = doctest.testmod()

2860

sys.exit(os.EX_OK if fail_count == 0 else 1)

2861

2212

2862

# Default values for config file for server-global settings

2213

server_defaults = { "interface": "",

2214

"address": "",

2215

"port": "",

2216

"debug": "False",

2217

"priority":

2218

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

2219

"servicename": "Mandos",

2220

"use_dbus": "True",

2221

"use_ipv6": "True",

2222

"debuglevel": "",

2223

"restore": "True",

2224

"socket": "",

2225

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

2226

}

2227

2863

server_defaults = {"interface": "",

2864

"address": "",

2865

"port": "",

2866

"debug": "False",

2867

"priority":

2868

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

2869

":+SIGN-DSA-SHA256",

2870

"servicename": "Mandos",

2871

"use_dbus": "True",

2872

"use_ipv6": "True",

2873

"debuglevel": "",

2874

"restore": "True",

2875

"socket": "",

2876

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

2877

"foreground": "False",

2878

"zeroconf": "True",

2879

}

2880

2228

2881

# Parse config file for server-global settings

2229

2882

server_config = configparser.SafeConfigParser(server_defaults)

2230

2883

del server_defaults

2231

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

2232

"mandos.conf"))

2884

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

2233

2885

# Convert the SafeConfigParser object to a dict

2234

2886

server_settings = server_config.defaults()

2235

2887

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

2236

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

2888

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

2889

"foreground", "zeroconf"):

2237

2890

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

2238

2891

option)

2239

2892

if server_settings["port"]:

2249

2902

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

2250

2903

["socket"])

2251

2904

del server_config

2252

2905

2253

2906

# Override the settings from the config file with command line

2254

2907

# options, if set.

2255

2908

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

2256

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

2257

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

2258

"statedir", "socket"):

2909

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

2910

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

2911

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

2259

2912

value = getattr(options, option)

2260

2913

if value is not None:

2261

2914

server_settings[option] = value

2262

2915

del options

2263

2916

# Force all strings to be unicode

2264

2917

for option in server_settings.keys():

2265

if type(server_settings[option]) is str:

2266

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

2918

if isinstance(server_settings[option], bytes):

2919

server_settings[option] = (server_settings[option]

2920

.decode("utf-8"))

2921

# Force all boolean options to be boolean

2922

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

2923

"foreground", "zeroconf"):

2924

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

2925

# Debug implies foreground

2926

if server_settings["debug"]:

2927

server_settings["foreground"] = True

2267

2928

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

2268

2929

2269

2930

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

2270

2931

2932

if (not server_settings["zeroconf"]

2933

and not (server_settings["port"]

2934

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

2935

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

2936

2271

2937

# For convenience

2272

2938

debug = server_settings["debug"]

2273

2939

debuglevel = server_settings["debuglevel"]

2275

2941

use_ipv6 = server_settings["use_ipv6"]

2276

2942

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

2277

2943

stored_state_file)

2278

2944

foreground = server_settings["foreground"]

2945

zeroconf = server_settings["zeroconf"]

2946

2279

2947

if debug:

2280

2948

initlogger(debug, logging.DEBUG)

2281

2949

else:

2284

2952

else:

2285

2953

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

2286

2954

initlogger(debug, level)

2287

2955

2288

2956

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

2289

syslogger.setFormatter(logging.Formatter

2290

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

2291

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

2292

.format(server_settings

2293

["servicename"])))

2294

2957

syslogger.setFormatter(

2958

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

2959

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

2960

server_settings["servicename"])))

2961

2295

2962

# Parse config file with clients

2296

2963

client_config = configparser.SafeConfigParser(Client

2297

2964

.client_defaults)

2298

2965

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

2299

2966

"clients.conf"))

2300

2967

2301

2968

global mandos_dbus_service

2302

2969

mandos_dbus_service = None

2303

2304

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

2305

server_settings["port"]),

2306

ClientHandler,

2307

interface=(server_settings["interface"]

2308

or None),

2309

use_ipv6=use_ipv6,

2310

gnutls_priority=

2311

server_settings["priority"],

2312

use_dbus=use_dbus,

2313

socketfd=(server_settings["socket"]

2314

or None))

2315

if not debug:

2316

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

2970

2971

socketfd = None

2972

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

2973

socketfd = server_settings["socket"]

2974

tcp_server = MandosServer(

2975

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

2976

ClientHandler,

2977

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

2978

use_ipv6=use_ipv6,

2979

gnutls_priority=server_settings["priority"],

2980

use_dbus=use_dbus,

2981

socketfd=socketfd)

2982

if not foreground:

2983

pidfilename = "/run/mandos.pid"

2984

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

2985

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

2986

pidfile = None

2317

2987

try:

2318

pidfile = open(pidfilename, "w")

2988

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

2319

2989

except IOError as e:

2320

2990

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

2321

2991

exc_info=e)

2322

2323

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

2992

2993

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

2994

("mandos", "mandos"),

2995

("nobody", "nogroup")):

2324

2996

try:

2325

2997

uid = pwd.getpwnam(name).pw_uid

2326

gid = pwd.getpwnam(name).pw_gid

2998

gid = pwd.getpwnam(group).pw_gid

2327

2999

break

2328

3000

except KeyError:

2329

3001

continue

2333

3005

try:

2334

3006

os.setgid(gid)

2335

3007

os.setuid(uid)

3008

if debug:

3009

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

3010

gid))

2336

3011

except OSError as error:

3012

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

3013

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

2337

3014

if error.errno != errno.EPERM:

2338

raise error

2339

3015

raise

3016

2340

3017

if debug:

2341

3018

# Enable all possible GnuTLS debugging

2342

3019

2343

3020

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

2344

3021

# - GnuTLS manual

2345

gnutls.library.functions.gnutls_global_set_log_level(11)

2346

2347

@gnutls.library.types.gnutls_log_func

3022

gnutls.global_set_log_level(11)

3023

3024

@gnutls.log_func

2348

3025

def debug_gnutls(level, string):

2349

3026

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

2350

2351

(gnutls.library.functions

2352

.gnutls_global_set_log_function(debug_gnutls))

2353

3027

3028

gnutls.global_set_log_function(debug_gnutls)

3029

2354

3030

# Redirect stdin so all checkers get /dev/null

2355

3031

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

2356

3032

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

2357

3033

if null > 2:

2358

3034

os.close(null)

2359

3035

2360

3036

# Need to fork before connecting to D-Bus

2361

if not debug:

3037

if not foreground:

2362

3038

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

2363

3039

daemon()

2364

2365

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

2366

# need to inform gobject that threads will be used.

2367

gobject.threads_init()

2368

3040

3041

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

3042

# to inform GLib that threads will be used.

3043

GLib.threads_init()

3044

2369

3045

global main_loop

2370

3046

# From the Avahi example code

2371

3047

DBusGMainLoop(set_as_default=True)

2372

main_loop = gobject.MainLoop()

3048

main_loop = GLib.MainLoop()

2373

3049

bus = dbus.SystemBus()

2374

3050

# End of Avahi example code

2375

3051

if use_dbus:

2376

3052

try:

2377

3053

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

2378

bus, do_not_queue=True)

2379

old_bus_name = (dbus.service.BusName

2380

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

2381

do_not_queue=True))

2382

except dbus.exceptions.NameExistsException as e:

3054

bus,

3055

do_not_queue=True)

3056

old_bus_name = dbus.service.BusName(

3057

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

3058

do_not_queue=True)

3059

except dbus.exceptions.DBusException as e:

2383

3060

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

2384

3061

use_dbus = False

2385

3062

server_settings["use_dbus"] = False

2386

3063

tcp_server.use_dbus = False

2387

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2388

service = AvahiServiceToSyslog(name =

2389

server_settings["servicename"],

2390

servicetype = "_mandos._tcp",

2391

protocol = protocol, bus = bus)

2392

if server_settings["interface"]:

2393

service.interface = (if_nametoindex

2394

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

2395

3064

if zeroconf:

3065

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3066

service = AvahiServiceToSyslog(

3067

name=server_settings["servicename"],

3068

servicetype="_mandos._tcp",

3069

protocol=protocol,

3070

bus=bus)

3071

if server_settings["interface"]:

3072

service.interface = if_nametoindex(

3073

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

3074

2396

3075

global multiprocessing_manager

2397

3076

multiprocessing_manager = multiprocessing.Manager()

2398

3077

2399

3078

client_class = Client

2400

3079

if use_dbus:

2401

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

2402

3080

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

3081

2403

3082

client_settings = Client.config_parser(client_config)

2404

3083

old_client_settings = {}

2405

3084

clients_data = {}

2406

3085

3086

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

3087

global wnull

3088

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

3089

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

3090

# mode

3091

if debug or not foreground:

3092

wnull.close()

3093

2407

3094

# Get client data and settings from last running state.

2408

3095

if server_settings["restore"]:

2409

3096

try:

2410

3097

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

2411

clients_data, old_client_settings = (pickle.load

2412

(stored_state))

3098

if sys.version_info.major == 2:

3099

clients_data, old_client_settings = pickle.load(

3100

stored_state)

3101

else:

3102

bytes_clients_data, bytes_old_client_settings = (

3103

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

3104

# Fix bytes to strings

3105

# clients_data

3106

# .keys()

3107

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

3108

if isinstance(key, bytes)

3109

else key): value

3110

for key, value in

3111

bytes_clients_data.items()}

3112

del bytes_clients_data

3113

for key in clients_data:

3114

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

3115

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

3116

for k, v in

3117

clients_data[key].items()}

3118

clients_data[key] = value

3119

# .client_structure

3120

value["client_structure"] = [

3121

(s.decode("utf-8")

3122

if isinstance(s, bytes)

3123

else s) for s in

3124

value["client_structure"]]

3125

# .name & .host

3126

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

3127

if isinstance(value[k], bytes):

3128

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

3129

# old_client_settings

3130

# .keys()

3131

old_client_settings = {

3132

(key.decode("utf-8")

3133

if isinstance(key, bytes)

3134

else key): value

3135

for key, value in

3136

bytes_old_client_settings.items()}

3137

del bytes_old_client_settings

3138

# .host

3139

for value in old_client_settings.values():

3140

if isinstance(value["host"], bytes):

3141

value["host"] = (value["host"]

3142

.decode("utf-8"))

2413

3143

os.remove(stored_state_path)

2414

3144

except IOError as e:

2415

3145

if e.errno == errno.ENOENT:

2416

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

2417

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

3146

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

3147

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

2418

3148

else:

2419

3149

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

2420

3150

exc_info=e)

2421

3151

raise

2422

3152

except EOFError as e:

2423

3153

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

2424

"EOFError:", exc_info=e)

2425

3154

"EOFError:",

3155

exc_info=e)

3156

2426

3157

with PGPEngine() as pgp:

2427

for client_name, client in clients_data.iteritems():

3158

for client_name, client in clients_data.items():

3159

# Skip removed clients

3160

if client_name not in client_settings:

3161

continue

3162

2428

3163

# Decide which value to use after restoring saved state.

2429

3164

# We have three different values: Old config file,

2430

3165

# new config file, and saved state.

2435

3170

# For each value in new config, check if it

2436

3171

# differs from the old config value (Except for

2437

3172

# the "secret" attribute)

2438

if (name != "secret" and

2439

value != old_client_settings[client_name]

2440

[name]):

3173

if (name != "secret"

3174

and (value !=

3175

old_client_settings[client_name][name])):

2441

3176

client[name] = value

2442

3177

except KeyError:

2443

3178

pass

2444

3179

2445

3180

# Clients who has passed its expire date can still be

2446

# enabled if its last checker was successful. Clients

3181

# enabled if its last checker was successful. A Client

2447

3182

# whose checker succeeded before we stored its state is

2448

3183

# assumed to have successfully run all checkers during

2449

3184

# downtime.

2451

3186

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

2452

3187

if not client["last_checked_ok"]:

2453

3188

logger.warning(

2454

"disabling client {0} - Client never "

2455

"performed a successful checker"

2456

.format(client_name))

3189

"disabling client {} - Client never "

3190

"performed a successful checker".format(

3191

client_name))

2457

3192

client["enabled"] = False

2458

3193

elif client["last_checker_status"] != 0:

2459

3194

logger.warning(

2460

"disabling client {0} - Client "

2461

"last checker failed with error code {1}"

2462

.format(client_name,

2463

client["last_checker_status"]))

3195

"disabling client {} - Client last"

3196

" checker failed with error code"

3197

" {}".format(

3198

client_name,

3199

client["last_checker_status"]))

2464

3200

client["enabled"] = False

2465

3201

else:

2466

client["expires"] = (datetime.datetime

2467

.utcnow()

2468

+ client["timeout"])

3202

client["expires"] = (

3203

datetime.datetime.utcnow()

3204

+ client["timeout"])

2469

3205

logger.debug("Last checker succeeded,"

2470

" keeping {0} enabled"

2471

.format(client_name))

3206

" keeping {} enabled".format(

3207

client_name))

2472

3208

try:

2473

client["secret"] = (

2474

pgp.decrypt(client["encrypted_secret"],

2475

client_settings[client_name]

2476

["secret"]))

3209

client["secret"] = pgp.decrypt(

3210

client["encrypted_secret"],

3211

client_settings[client_name]["secret"])

2477

3212

except PGPError:

2478

3213

# If decryption fails, we use secret from new settings

2479

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

2480

.format(client_name))

2481

client["secret"] = (

2482

client_settings[client_name]["secret"])

2483

3214

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

3215

client_name))

3216

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

3217

["secret"])

3218

2484

3219

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

2485

3220

for client_name in (set(old_client_settings)

2486

3221

- set(client_settings)):

2488

3223

for client_name in (set(client_settings)

2489

3224

- set(old_client_settings)):

2490

3225

clients_data[client_name] = client_settings[client_name]

2491

3226

2492

3227

# Create all client objects

2493

for client_name, client in clients_data.iteritems():

3228

for client_name, client in clients_data.items():

2494

3229

tcp_server.clients[client_name] = client_class(

2495

name = client_name, settings = client)

2496

3230

name=client_name,

3231

settings=client,

3232

server_settings=server_settings)

3233

2497

3234

if not tcp_server.clients:

2498

3235

logger.warning("No clients defined")

2499

2500

if not debug:

2501

try:

2502

with pidfile:

2503

pid = os.getpid()

2504

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

2505

del pidfile

2506

except IOError:

2507

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

2508

pidfilename, pid)

2509

except NameError:

2510

# "pidfile" was never created

2511

pass

3236

3237

if not foreground:

3238

if pidfile is not None:

3239

pid = os.getpid()

3240

try:

3241

with pidfile:

3242

print(pid, file=pidfile)

3243

except IOError:

3244

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

3245

pidfilename, pid)

3246

del pidfile

2512

3247

del pidfilename

2513

2514

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

2515

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

2516

3248

3249

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

3250

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3251

lambda: main_loop.quit() and False)

3252

2517

3253

if use_dbus:

2518

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

2519

"se.bsnet.fukt.Mandos"})

2520

class MandosDBusService(DBusObjectWithProperties):

3254

3255

@alternate_dbus_interfaces(

3256

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

3257

class MandosDBusService(DBusObjectWithObjectManager):

2521

3258

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

3259

2522

3260

def __init__(self):

2523

3261

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

3262

2524

3263

_interface = "se.recompile.Mandos"

2525

2526

@dbus_interface_annotations(_interface)

2527

def _foo(self):

2528

return { "org.freedesktop.DBus.Property"

2529

".EmitsChangedSignal":

2530

"false"}

2531

3264

2532

3265

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

2533

3266

def ClientAdded(self, objpath):

2534

3267

"D-Bus signal"

2535

3268

pass

2536

3269

2537

3270

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

2538

3271

def ClientNotFound(self, fingerprint, address):

2539

3272

"D-Bus signal"

2540

3273

pass

2541

3274

3275

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

3276

"true"})

2542

3277

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

2543

3278

def ClientRemoved(self, objpath, name):

2544

3279

"D-Bus signal"

2545

3280

pass

2546

3281

3282

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

3283

"true"})

2547

3284

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

2548

3285

def GetAllClients(self):

2549

3286

"D-Bus method"

2550

return dbus.Array(c.dbus_object_path

2551

for c in

2552

tcp_server.clients.itervalues())

2553

3287

return dbus.Array(c.dbus_object_path for c in

3288

tcp_server.clients.values())

3289

3290

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

3291

"true"})

2554

3292

@dbus.service.method(_interface,

2555

3293

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

2556

3294

def GetAllClientsWithProperties(self):

2557

3295

"D-Bus method"

2558

3296

return dbus.Dictionary(

2559

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

2560

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

3297

{c.dbus_object_path: c.GetAll(

3298

"se.recompile.Mandos.Client")

3299

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

2561

3300

signature="oa{sv}")

2562

3301

2563

3302

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

2564

3303

def RemoveClient(self, object_path):

2565

3304

"D-Bus method"

2566

for c in tcp_server.clients.itervalues():

3305

for c in tcp_server.clients.values():

2567

3306

if c.dbus_object_path == object_path:

2568

3307

del tcp_server.clients[c.name]

2569

3308

c.remove_from_connection()

2570

# Don't signal anything except ClientRemoved

3309

# Don't signal the disabling

2571

3310

c.disable(quiet=True)

2572

# Emit D-Bus signal

2573

self.ClientRemoved(object_path, c.name)

3311

# Emit D-Bus signal for removal

3312

self.client_removed_signal(c)

2574

3313

return

2575

3314

raise KeyError(object_path)

2576

3315

2577

3316

del _interface

2578

3317

3318

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3319

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

3320

def GetManagedObjects(self):

3321

"""D-Bus method"""

3322

return dbus.Dictionary(

3323

{client.dbus_object_path:

3324

dbus.Dictionary(

3325

{interface: client.GetAll(interface)

3326

for interface in

3327

client._get_all_interface_names()})

3328

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

3329

3330

def client_added_signal(self, client):

3331

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

3332

if use_dbus:

3333

# New standard signal

3334

self.InterfacesAdded(

3335

client.dbus_object_path,

3336

dbus.Dictionary(

3337

{interface: client.GetAll(interface)

3338

for interface in

3339

client._get_all_interface_names()}))

3340

# Old signal

3341

self.ClientAdded(client.dbus_object_path)

3342

3343

def client_removed_signal(self, client):

3344

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

3345

if use_dbus:

3346

# New standard signal

3347

self.InterfacesRemoved(

3348

client.dbus_object_path,

3349

client._get_all_interface_names())

3350

# Old signal

3351

self.ClientRemoved(client.dbus_object_path,

3352

client.name)

3353

2579

3354

mandos_dbus_service = MandosDBusService()

2580

3355

3356

# Save modules to variables to exempt the modules from being

3357

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

3358

mp = multiprocessing

3359

wn = wnull

3360

2581

3361

def cleanup():

2582

3362

"Cleanup function; run on exit"

2583

service.cleanup()

2584

2585

multiprocessing.active_children()

3363

if zeroconf:

3364

service.cleanup()

3365

3366

mp.active_children()

3367

wn.close()

2586

3368

if not (tcp_server.clients or client_settings):

2587

3369

return

2588

3370

2589

3371

# Store client before exiting. Secrets are encrypted with key

2590

3372

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

2591

3373

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

2592

3374

clients = {}

2593

3375

with PGPEngine() as pgp:

2594

for client in tcp_server.clients.itervalues():

3376

for client in tcp_server.clients.values():

2595

3377

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

2596

3378

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

2597

3379

key)

2598

3380

client_dict = {}

2599

3381

2600

3382

# A list of attributes that can not be pickled

2601

3383

# + secret.

2602

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

2603

"checker"))

2604

for name, typ in (inspect.getmembers

2605

(dbus.service.Object)):

3384

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

3385

"checker", "server_settings"}

3386

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

3387

.Object):

2606

3388

exclude.add(name)

2607

3389

2608

3390

client_dict["encrypted_secret"] = (client

2609

3391

.encrypted_secret)

2610

3392

for attr in client.client_structure:

2611

3393

if attr not in exclude:

2612

3394

client_dict[attr] = getattr(client, attr)

2613

3395

2614

3396

clients[client.name] = client_dict

2615

3397

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

2616

3398

2617

3399

try:

2618

with (tempfile.NamedTemporaryFile

2619

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

2620

dir=os.path.dirname(stored_state_path),

2621

delete=False)) as stored_state:

2622

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

2623

tempname=stored_state.name

3400

with tempfile.NamedTemporaryFile(

3401

mode='wb',

3402

suffix=".pickle",

3403

prefix='clients-',

3404

dir=os.path.dirname(stored_state_path),

3405

delete=False) as stored_state:

3406

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

3407

protocol=2)

3408

tempname = stored_state.name

2624

3409

os.rename(tempname, stored_state_path)

2625

3410

except (IOError, OSError) as e:

2626

3411

if not debug:

2629

3414

except NameError:

2630

3415

pass

2631

3416

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

2632

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

3417

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

2633

3418

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

2634

3419

else:

2635

3420

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

2636

3421

exc_info=e)

2637

raise e

2638

3422

raise

3423

2639

3424

# Delete all clients, and settings from config

2640

3425

while tcp_server.clients:

2641

3426

name, client = tcp_server.clients.popitem()

2642

3427

if use_dbus:

2643

3428

client.remove_from_connection()

2644

# Don't signal anything except ClientRemoved

3429

# Don't signal the disabling

2645

3430

client.disable(quiet=True)

3431

# Emit D-Bus signal for removal

2646

3432

if use_dbus:

2647

# Emit D-Bus signal

2648

mandos_dbus_service.ClientRemoved(client

2649

.dbus_object_path,

2650

client.name)

3433

mandos_dbus_service.client_removed_signal(client)

2651

3434

client_settings.clear()

2652

3435

2653

3436

atexit.register(cleanup)

2654

2655

for client in tcp_server.clients.itervalues():

3437

3438

for client in tcp_server.clients.values():

2656

3439

if use_dbus:

2657

# Emit D-Bus signal

2658

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3440

# Emit D-Bus signal for adding

3441

mandos_dbus_service.client_added_signal(client)

2659

3442

# Need to initiate checking of clients

2660

3443

if client.enabled:

2661

3444

client.init_checker()

2662

3445

2663

3446

tcp_server.enable()

2664

3447

tcp_server.server_activate()

2665

3448

2666

3449

# Find out what port we got

2667

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

3450

if zeroconf:

3451

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

2668

3452

if use_ipv6:

2669

3453

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

2670

3454

" flowinfo %d, scope_id %d",

2672

3456

else: # IPv4

2673

3457

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

2674

3458

*tcp_server.socket.getsockname())

2675

2676

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

2677

3459

3460

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

3461

2678

3462

try:

2679

# From the Avahi example code

2680

try:

2681

service.activate()

2682

except dbus.exceptions.DBusException as error:

2683

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

2684

cleanup()

2685

sys.exit(1)

2686

# End of Avahi example code

2687

2688

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

2689

lambda *args, **kwargs:

2690

(tcp_server.handle_request

2691

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

2692

3463

if zeroconf:

3464

# From the Avahi example code

3465

try:

3466

service.activate()

3467

except dbus.exceptions.DBusException as error:

3468

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

3469

cleanup()

3470

sys.exit(1)

3471

# End of Avahi example code

3472

3473

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

3474

lambda *args, **kwargs:

3475

(tcp_server.handle_request

3476

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

3477

2693

3478

logger.debug("Starting main loop")

2694

3479

main_loop.run()

2695

3480

except AvahiError as error:

2704

3489

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

2705

3490

cleanup()

2706

3491

3492

2707

3493

if __name__ == '__main__':

2708

3494

main()