/mandos/trunk : revision 237.4.99

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

71

78

import collections

79

import codecs

72

80

73

81

import dbus

74

82

import dbus.service

75

import gobject

76

import avahi

83

from gi.repository import GLib

77

84

from dbus.mainloop.glib import DBusGMainLoop

78

85

import ctypes

79

86

import ctypes.util

80

87

import xml.dom.minidom

81

88

import inspect

82

import GnuPGInterface

83

89

90

# Try to find the value of SO_BINDTODEVICE:

84

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:

85

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

86

95

except AttributeError:

87

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

88

99

from IN import SO_BINDTODEVICE

89

100

except ImportError:

90

SO_BINDTODEVICE = None

91

92

version = "1.6.0"

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"

93

119

stored_state_file = "clients.pickle"

94

120

95

121

logger = logging.getLogger()

96

syslogger = (logging.handlers.SysLogHandler

97

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

98

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

122

syslogger = None

99

123

100

124

try:

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

104

127

except (OSError, AttributeError):

128

105

129

def if_nametoindex(interface):

106

130

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

107

131

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

108

132

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

109

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

110

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

111

interface))

112

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

113

ifreq[16:20])[0]

134

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

135

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

114

136

return interface_index

115

137

116

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

117

155

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

118

156

"""init logger and add loglevel"""

119

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

120

162

syslogger.setFormatter(logging.Formatter

121

163

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

122

164

' %(message)s'))

123

165

logger.addHandler(syslogger)

124

166

125

167

if debug:

126

168

console = logging.StreamHandler()

127

169

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

139

181

140

182

class PGPEngine(object):

141

183

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

184

142

185

def __init__(self):

143

self.gnupg = GnuPGInterface.GnuPG()

144

186

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

145

self.gnupg = GnuPGInterface.GnuPG()

146

self.gnupg.options.meta_interactive = False

147

self.gnupg.options.homedir = self.tempdir

148

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

149

'--quiet',

150

'--no-use-agent'])

151

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

152

206

def __enter__(self):

153

207

return self

154

208

155

209

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

156

210

self._cleanup()

157

211

return False

158

212

159

213

def __del__(self):

160

214

self._cleanup()

161

215

162

216

def _cleanup(self):

163

217

if self.tempdir is not None:

164

218

# Delete contents of tempdir

165

219

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

166

topdown = False):

220

topdown=False):

167

221

for filename in files:

168

222

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

169

223

for dirname in dirs:

171

225

# Remove tempdir

172

226

os.rmdir(self.tempdir)

173

227

self.tempdir = None

174

228

175

229

def password_encode(self, password):

176

230

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

177

231

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

178

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

179

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

180

240

def encrypt(self, data, password):

181

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

182

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

183

try:

184

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

185

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

186

attach_fhs={'stderr': devnull})

187

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

188

f.write(data)

189

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

190

ciphertext = f.read()

191

proc.wait()

192

except IOError as e:

193

raise PGPError(e)

194

self.gnupg.passphrase = None

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)

195

256

return ciphertext

196

257

197

258

def decrypt(self, data, password):

198

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

199

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

200

try:

201

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

202

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

203

attach_fhs={'stderr': devnull})

204

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

205

f.write(data)

206

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

207

decrypted_plaintext = f.read()

208

proc.wait()

209

except IOError as e:

210

raise PGPError(e)

211

self.gnupg.passphrase = None

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)

212

274

return decrypted_plaintext

213

275

214

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

215

304

class AvahiError(Exception):

216

305

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

217

306

self.value = value

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

307

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

308

**kwargs)

309

221

310

222

311

class AvahiServiceError(AvahiError):

223

312

pass

224

313

314

225

315

class AvahiGroupError(AvahiError):

226

316

pass

227

317

228

318

229

319

class AvahiService(object):

230

320

"""An Avahi (Zeroconf) service.

231

321

232

322

Attributes:

233

323

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

234

324

Used to optionally bind to the specified interface.

235

325

name: string; Example: 'Mandos'

236

326

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

237

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

327

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

238

328

port: integer; what port to announce

239

329

TXT: list of strings; TXT record for the service

240

330

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

246

336

server: D-Bus Server

247

337

bus: dbus.SystemBus()

248

338

"""

249

250

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

251

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

252

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

253

protocol = avahi.PROTO_UNSPEC, bus = None):

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

254

351

self.interface = interface

255

352

self.name = name

256

353

self.type = servicetype

265

362

self.server = None

266

363

self.bus = bus

267

364

self.entry_group_state_changed_match = None

268

269

def rename(self):

365

366

def rename(self, remove=True):

270

367

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

271

368

if self.rename_count >= self.max_renames:

272

369

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

273

370

" after %i retries, exiting.",

274

371

self.rename_count)

275

372

raise AvahiServiceError("Too many renames")

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

278

376

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

279

377

self.name)

280

self.remove()

378

if remove:

379

self.remove()

281

380

try:

282

381

self.add()

283

382

except dbus.exceptions.DBusException as error:

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

288

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

289

392

def remove(self):

290

393

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

291

394

if self.entry_group_state_changed_match is not None:

293

396

self.entry_group_state_changed_match = None

294

397

if self.group is not None:

295

398

self.group.Reset()

296

399

297

400

def add(self):

298

401

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

299

402

self.remove()

316

419

dbus.UInt16(self.port),

317

420

avahi.string_array_to_txt_array(self.TXT))

318

421

self.group.Commit()

319

422

320

423

def entry_group_state_changed(self, state, error):

321

424

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

322

425

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

323

426

324

427

if state == avahi.ENTRY_GROUP_ESTABLISHED:

325

428

logger.debug("Zeroconf service established.")

326

429

elif state == avahi.ENTRY_GROUP_COLLISION:

328

431

self.rename()

329

432

elif state == avahi.ENTRY_GROUP_FAILURE:

330

433

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

331

unicode(error))

332

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

333

.format(error))

334

434

str(error))

435

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

436

335

437

def cleanup(self):

336

438

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

337

439

if self.group is not None:

342

444

pass

343

445

self.group = None

344

446

self.remove()

345

447

346

448

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

347

449

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

348

450

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

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

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

}

356

457

if state in bad_states:

357

458

if bad_states[state] is not None:

358

459

if error is None:

361

462

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

362

463

self.cleanup()

363

464

elif state == avahi.SERVER_RUNNING:

364

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)

365

477

else:

366

478

if error is None:

367

479

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

368

480

else:

369

481

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

370

482

371

483

def activate(self):

372

484

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

373

485

if self.server is None:

377

489

follow_name_owner_changes=True),

378

490

avahi.DBUS_INTERFACE_SERVER)

379

491

self.server.connect_to_signal("StateChanged",

380

self.server_state_changed)

492

self.server_state_changed)

381

493

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

382

494

383

495

384

496

class AvahiServiceToSyslog(AvahiService):

385

def rename(self):

497

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

386

498

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

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

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

392

503

return ret

393

504

394

505

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

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

400

778

401

779

402

780

class Client(object):

403

781

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

404

782

405

783

Attributes:

406

784

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

407

785

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

409

787

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

410

788

to see if the client lives.

411

789

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

790

checker_callback_tag: a GLib event source tag, or None

413

791

checker_command: string; External command which is run to check

414

792

if client lives. %() expansions are done at

415

793

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

416

794

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

417

checker_initiator_tag: a gobject event source tag, or None

795

checker_initiator_tag: a GLib event source tag, or None

418

796

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

419

797

client_structure: Object describing what attributes a client has

420

798

and is used for storing the client at exit

421

799

current_checker_command: string; current running checker_command

422

disable_initiator_tag: a gobject event source tag, or None

800

disable_initiator_tag: a GLib event source tag, or None

423

801

enabled: bool()

424

802

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

425

803

uniquely identify the client

430

808

last_checker_status: integer between 0 and 255 reflecting exit

431

809

status of last checker. -1 reflects crashed

432

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

433

813

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

434

814

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

435

815

D-Bus identifiers

440

820

runtime_expansions: Allowed attributes for runtime expansion.

441

821

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

442

822

disabled, or None

823

server_settings: The server_settings dict from main()

443

824

"""

444

825

445

826

runtime_expansions = ("approval_delay", "approval_duration",

446

827

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

447

828

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

448

829

"last_approval_request", "last_checked_ok",

449

830

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

450

client_defaults = { "timeout": "PT5M",

451

"extended_timeout": "PT15M",

452

"interval": "PT2M",

453

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

454

"host": "",

455

"approval_delay": "PT0S",

456

"approval_duration": "PT1S",

457

"approved_by_default": "True",

458

"enabled": "True",

459

}

460

461

def timeout_milliseconds(self):

462

"Return the 'timeout' attribute in milliseconds"

463

return timedelta_to_milliseconds(self.timeout)

464

465

def extended_timeout_milliseconds(self):

466

"Return the 'extended_timeout' attribute in milliseconds"

467

return timedelta_to_milliseconds(self.extended_timeout)

468

469

def interval_milliseconds(self):

470

"Return the 'interval' attribute in milliseconds"

471

return timedelta_to_milliseconds(self.interval)

472

473

def approval_delay_milliseconds(self):

474

return timedelta_to_milliseconds(self.approval_delay)

475

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

476

843

@staticmethod

477

844

def config_parser(config):

478

845

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

485

852

for client_name in config.sections():

486

853

section = dict(config.items(client_name))

487

854

client = settings[client_name] = {}

488

855

489

856

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

490

857

# Reformat values from string types to Python types

491

858

client["approved_by_default"] = config.getboolean(

492

859

client_name, "approved_by_default")

493

860

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

494

861

"enabled")

495

862

863

# Uppercase and remove spaces from fingerprint for later

864

# comparison purposes with return value from the

865

# fingerprint() function

496

866

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

497

867

.replace(" ", ""))

498

868

if "secret" in section:

499

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

869

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

870

.encode("utf-8"),

871

"base64")

500

872

elif "secfile" in section:

501

873

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

502

874

(section["secfile"])),

503

875

"rb") as secfile:

504

876

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

505

877

else:

506

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

878

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

507

879

.format(section))

508

880

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

509

881

client["extended_timeout"] = string_to_delta(

517

889

client["last_approval_request"] = None

518

890

client["last_checked_ok"] = None

519

891

client["last_checker_status"] = -2

520

892

521

893

return settings

522

523

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

894

895

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

524

896

self.name = name

897

if server_settings is None:

898

server_settings = {}

899

self.server_settings = server_settings

525

900

# adding all client settings

526

for setting, value in settings.iteritems():

901

for setting, value in settings.items():

527

902

setattr(self, setting, value)

528

903

529

904

if self.enabled:

530

905

if not hasattr(self, "last_enabled"):

531

906

self.last_enabled = datetime.datetime.utcnow()

535

910

else:

536

911

self.last_enabled = None

537

912

self.expires = None

538

913

539

914

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

540

# Uppercase and remove spaces from fingerprint for later

541

# comparison purposes with return value from the fingerprint()

542

# function

543

915

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

544

916

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

545

917

datetime.datetime.utcnow())

546

918

547

919

# attributes specific for this server instance

548

920

self.checker = None

549

921

self.checker_initiator_tag = None

552

924

self.current_checker_command = None

553

925

self.approved = None

554

926

self.approvals_pending = 0

555

self.changedstate = (multiprocessing_manager

556

.Condition(multiprocessing_manager

557

.Lock()))

558

self.client_structure = [attr for attr in

559

self.__dict__.iterkeys()

927

self.changedstate = multiprocessing_manager.Condition(

928

multiprocessing_manager.Lock())

929

self.client_structure = [attr

930

for attr in self.__dict__.keys()

560

931

if not attr.startswith("_")]

561

932

self.client_structure.append("client_structure")

562

563

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

564

lambda obj:

565

isinstance(obj,

566

property)):

933

934

for name, t in inspect.getmembers(

935

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

567

936

if not name.startswith("_"):

568

937

self.client_structure.append(name)

569

938

570

939

# Send notice to process children that client state has changed

571

940

def send_changedstate(self):

572

941

with self.changedstate:

573

942

self.changedstate.notify_all()

574

943

575

944

def enable(self):

576

945

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

577

946

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

582

951

self.last_enabled = datetime.datetime.utcnow()

583

952

self.init_checker()

584

953

self.send_changedstate()

585

954

586

955

def disable(self, quiet=True):

587

956

"""Disable this client."""

588

957

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

590

959

if not quiet:

591

960

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

592

961

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

593

gobject.source_remove(self.disable_initiator_tag)

962

GLib.source_remove(self.disable_initiator_tag)

594

963

self.disable_initiator_tag = None

595

964

self.expires = None

596

965

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

597

gobject.source_remove(self.checker_initiator_tag)

966

GLib.source_remove(self.checker_initiator_tag)

598

967

self.checker_initiator_tag = None

599

968

self.stop_checker()

600

969

self.enabled = False

601

970

if not quiet:

602

971

self.send_changedstate()

603

# 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

604

973

return False

605

974

606

975

def __del__(self):

607

976

self.disable()

608

977

609

978

def init_checker(self):

610

979

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

611

980

# and every interval from then on.

612

981

if self.checker_initiator_tag is not None:

613

gobject.source_remove(self.checker_initiator_tag)

614

self.checker_initiator_tag = (gobject.timeout_add

615

(self.interval_milliseconds(),

616

self.start_checker))

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)

617

986

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

618

987

if self.disable_initiator_tag is not None:

619

gobject.source_remove(self.disable_initiator_tag)

620

self.disable_initiator_tag = (gobject.timeout_add

621

(self.timeout_milliseconds(),

622

self.disable))

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)

623

991

# Also start a new checker *right now*.

624

992

self.start_checker()

625

626

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

993

994

def checker_callback(self, source, condition, connection,

995

command):

627

996

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

628

997

self.checker_callback_tag = None

629

998

self.checker = None

630

if os.WIFEXITED(condition):

631

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

632

1006

if self.last_checker_status == 0:

633

1007

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

634

1008

vars(self))

635

1009

self.checked_ok()

636

1010

else:

637

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

638

vars(self))

1011

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

639

1012

else:

640

1013

self.last_checker_status = -1

1014

self.last_checker_signal = -returncode

641

1015

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

642

1016

vars(self))

643

1017

return False

1018

644

1019

def checked_ok(self):

645

1020

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

646

1021

self.last_checked_ok = datetime.datetime.utcnow()

647

1022

self.last_checker_status = 0

1023

self.last_checker_signal = None

648

1024

self.bump_timeout()

649

1025

650

1026

def bump_timeout(self, timeout=None):

651

1027

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

652

1028

if timeout is None:

653

1029

timeout = self.timeout

654

1030

if self.disable_initiator_tag is not None:

655

gobject.source_remove(self.disable_initiator_tag)

1031

GLib.source_remove(self.disable_initiator_tag)

656

1032

self.disable_initiator_tag = None

657

1033

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

658

self.disable_initiator_tag = (gobject.timeout_add

659

(timedelta_to_milliseconds

660

(timeout), self.disable))

1034

self.disable_initiator_tag = GLib.timeout_add(

1035

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

661

1036

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

662

1037

663

1038

def need_approval(self):

664

1039

self.last_approval_request = datetime.datetime.utcnow()

665

1040

666

1041

def start_checker(self):

667

1042

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

668

1043

669

1044

If a checker already exists, leave it running and do

670

1045

nothing."""

671

1046

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

676

1051

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

677

1052

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

678

1053

# should be.

679

680

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

681

try:

682

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

683

except (AttributeError, OSError) as error:

684

if (isinstance(error, OSError)

685

and error.errno != errno.ECHILD):

686

raise error

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

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

693

1059

# Start a new checker if needed

694

1060

if self.checker is None:

695

1061

# Escape attributes for the shell

696

escaped_attrs = dict(

697

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

698

for attr in

699

self.runtime_expansions)

1062

escaped_attrs = {

1063

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

1064

for attr in self.runtime_expansions}

700

1065

try:

701

1066

command = self.checker_command % escaped_attrs

702

1067

except TypeError as error:

703

1068

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

704

self.checker_command, exc_info=error)

705

return True # Try again later

1069

self.checker_command,

1070

exc_info=error)

1071

return True # Try again later

706

1072

self.current_checker_command = command

707

try:

708

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

709

command, self.name)

710

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

711

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

712

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

713

# always replaced by /dev/null.)

714

self.checker = subprocess.Popen(command,

715

close_fds=True,

716

shell=True, cwd="/")

717

except OSError as error:

718

logger.error("Failed to start subprocess",

719

exc_info=error)

720

self.checker_callback_tag = (gobject.child_watch_add

721

(self.checker.pid,

722

self.checker_callback,

723

data=command))

724

# The checker may have completed before the gobject

725

# watch was added. Check for this.

726

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

727

if pid:

728

gobject.source_remove(self.checker_callback_tag)

729

self.checker_callback(pid, status, command)

730

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

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

731

1099

return True

732

1100

733

1101

def stop_checker(self):

734

1102

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

735

1103

if self.checker_callback_tag:

736

gobject.source_remove(self.checker_callback_tag)

1104

GLib.source_remove(self.checker_callback_tag)

737

1105

self.checker_callback_tag = None

738

1106

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

739

1107

return

740

1108

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

741

try:

742

self.checker.terminate()

743

#time.sleep(0.5)

744

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

745

# self.checker.kill()

746

except OSError as error:

747

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

748

raise

1109

self.checker.terminate()

749

1110

self.checker = None

750

1111

751

1112

752

def dbus_service_property(dbus_interface, signature="v",

753

access="readwrite", byte_arrays=False):

1113

def dbus_service_property(dbus_interface,

1114

signature="v",

1115

access="readwrite",

1116

byte_arrays=False):

754

1117

"""Decorators for marking methods of a DBusObjectWithProperties to

755

1118

become properties on the D-Bus.

756

1119

757

1120

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

758

1121

and with one argument by "Set".

759

1122

760

1123

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

761

1124

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

762

1125

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

765

1128

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

766

1129

if byte_arrays and signature != "ay":

767

1130

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

768

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

1131

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

1132

769

1133

def decorator(func):

770

1134

func._dbus_is_property = True

771

1135

func._dbus_interface = dbus_interface

774

1138

func._dbus_name = func.__name__

775

1139

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

776

1140

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

777

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1141

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

778

1142

return func

1143

779

1144

return decorator

780

1145

781

1146

782

1147

def dbus_interface_annotations(dbus_interface):

783

1148

"""Decorator for marking functions returning interface annotations

784

1149

785

1150

Usage:

786

1151

787

1152

@dbus_interface_annotations("org.example.Interface")

788

1153

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

789

1154

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

790

1155

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

791

1156

"false"}

792

1157

"""

1158

793

1159

def decorator(func):

794

1160

func._dbus_is_interface = True

795

1161

func._dbus_interface = dbus_interface

796

1162

func._dbus_name = dbus_interface

797

1163

return func

1164

798

1165

return decorator

799

1166

800

1167

801

1168

def dbus_annotations(annotations):

802

1169

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

803

1170

Usage:

804

1171

1172

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

1173

"org.freedesktop.DBus.Property."

1174

"EmitsChangedSignal": "false"})

805

1175

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

806

1176

access="r")

807

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

808

"org.freedesktop.DBus.Property."

809

"EmitsChangedSignal": "false"})

810

1177

def Property_dbus_property(self):

811

1178

return dbus.Boolean(False)

1179

1180

See also the DBusObjectWithAnnotations class.

812

1181

"""

1182

813

1183

def decorator(func):

814

1184

func._dbus_annotations = annotations

815

1185

return func

1186

816

1187

return decorator

817

1188

818

1189

819

1190

class DBusPropertyException(dbus.exceptions.DBusException):

820

1191

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

821

1192

"""

822

def __unicode__(self):

823

return unicode(str(self))

1193

pass

824

1194

825

1195

826

1196

class DBusPropertyAccessException(DBusPropertyException):

835

1205

pass

836

1206

837

1207

838

class DBusObjectWithProperties(dbus.service.Object):

839

"""A D-Bus object with properties.

840

841

Classes inheriting from this can use the dbus_service_property

842

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

843

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

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.

844

1213

"""

845

1214

846

1215

@staticmethod

847

1216

def _is_dbus_thing(thing):

848

1217

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

849

1218

850

1219

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

851

1220

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

852

1221

"""

853

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

1222

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

854

1223

False)

855

1224

856

1225

def _get_all_dbus_things(self, thing):

857

1226

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

858

1227

"""

859

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

860

name),

1228

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

861

1229

athing.__get__(self))

862

1230

for cls in self.__class__.__mro__

863

1231

for name, athing in

864

inspect.getmembers(cls,

865

self._is_dbus_thing(thing)))

866

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

867

1305

def _get_dbus_property(self, interface_name, property_name):

868

1306

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

869

1307

property with the specified name and interface.

870

1308

"""

871

for cls in self.__class__.__mro__:

872

for name, value in (inspect.getmembers

873

(cls,

874

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

875

1312

if (value._dbus_name == property_name

876

1313

and value._dbus_interface == interface_name):

877

1314

return value.__get__(self)

878

1315

879

1316

# No such property

880

raise DBusPropertyNotFound(self.dbus_object_path + ":"

881

+ interface_name + "."

882

+ property_name)

883

884

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

885

1331

out_signature="v")

886

1332

def Get(self, interface_name, property_name):

887

1333

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

893

1339

if not hasattr(value, "variant_level"):

894

1340

return value

895

1341

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

896

1342

897

1343

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

898

1344

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

899

1345

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

905

1351

# The byte_arrays option is not supported yet on

906

1352

# signatures other than "ay".

907

1353

if prop._dbus_signature != "ay":

908

raise ValueError

1354

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

1355

"'ay' signature {!r}"

1356

.format(prop._dbus_signature))

909

1357

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

910

1358

for byte in value))

911

1359

prop(value)

912

913

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

1360

1361

@dbus.service.method(dbus.PROPERTIES_IFACE,

1362

in_signature="s",

914

1363

out_signature="a{sv}")

915

1364

def GetAll(self, interface_name):

916

1365

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

917

1366

standard.

918

1367

919

1368

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

920

1369

"""

921

1370

properties = {}

931

1380

if not hasattr(value, "variant_level"):

932

1381

properties[name] = value

933

1382

continue

934

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

935

value.variant_level+1)

1383

properties[name] = type(value)(

1384

value, variant_level=value.variant_level + 1)

936

1385

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

937

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

938

1395

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

939

1396

out_signature="s",

940

1397

path_keyword='object_path',

941

1398

connection_keyword='connection')

942

1399

def Introspect(self, object_path, connection):

943

1400

"""Overloading of standard D-Bus method.

944

1401

945

1402

Inserts property tags and interface annotation tags.

946

1403

"""

947

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

948

connection)

1404

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1405

object_path,

1406

connection)

949

1407

try:

950

1408

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

1409

951

1410

def make_tag(document, name, prop):

952

1411

e = document.createElement("property")

953

1412

e.setAttribute("name", name)

954

1413

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

955

1414

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

956

1415

return e

1416

957

1417

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

958

1418

# Add property tags

959

1419

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

962

1422

if prop._dbus_interface

963

1423

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

964

1424

if_tag.appendChild(tag)

965

# Add annotation tags

966

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

967

for tag in if_tag.getElementsByTagName(typ):

968

annots = dict()

969

for name, prop in (self.

970

_get_all_dbus_things(typ)):

971

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

972

and prop._dbus_interface

973

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

974

annots.update(getattr

975

(prop,

976

"_dbus_annotations",

977

{}))

978

for name, value in annots.iteritems():

979

ann_tag = document.createElement(

980

"annotation")

981

ann_tag.setAttribute("name", name)

982

ann_tag.setAttribute("value", value)

983

tag.appendChild(ann_tag)

984

# Add interface annotation tags

985

for annotation, value in dict(

986

itertools.chain.from_iterable(

987

annotations().iteritems()

988

for name, annotations in

989

self._get_all_dbus_things("interface")

990

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

991

)).iteritems():

992

ann_tag = document.createElement("annotation")

993

ann_tag.setAttribute("name", annotation)

994

ann_tag.setAttribute("value", value)

995

if_tag.appendChild(ann_tag)

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)

996

1441

# Add the names to the return values for the

997

1442

# "org.freedesktop.DBus.Properties" methods

998

1443

if (if_tag.getAttribute("name")

1017

1462

return xmlstring

1018

1463

1019

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

1020

1536

def datetime_to_dbus(dt, variant_level=0):

1021

1537

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

1022

1538

if dt is None:

1023

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

1024

return dbus.String(dt.isoformat(),

1025

variant_level=variant_level)

1539

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

1540

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

1026

1541

1027

1542

1028

1543

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1030

1545

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

1031

1546

interface names according to the "alt_interface_names" mapping.

1032

1547

Usage:

1033

1548

1034

1549

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

1035

1550

"net.example.AlternateInterface"})

1036

1551

class SampleDBusObject(dbus.service.Object):

1037

1552

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

1038

1553

def SampleDBusMethod():

1039

1554

pass

1040

1555

1041

1556

The above "SampleDBusMethod" on "SampleDBusObject" will be

1042

1557

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

1043

1558

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

1044

1559

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

1045

1560

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

1046

1561

1047

1562

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

1048

1563

(from DBusObjectWithProperties) and interfaces (from the

1049

1564

dbus_interface_annotations decorator).

1050

1565

"""

1566

1051

1567

def wrapper(cls):

1052

1568

for orig_interface_name, alt_interface_name in (

1053

alt_interface_names.iteritems()):

1569

alt_interface_names.items()):

1054

1570

attr = {}

1055

1571

interface_names = set()

1056

1572

# Go though all attributes of the class

1058

1574

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

1059

1575

# with the wrong interface name

1060

1576

if (not hasattr(attribute, "_dbus_interface")

1061

or not attribute._dbus_interface

1062

.startswith(orig_interface_name)):

1577

or not attribute._dbus_interface.startswith(

1578

orig_interface_name)):

1063

1579

continue

1064

1580

# Create an alternate D-Bus interface name based on

1065

1581

# the current name

1066

alt_interface = (attribute._dbus_interface

1067

.replace(orig_interface_name,

1068

alt_interface_name))

1582

alt_interface = attribute._dbus_interface.replace(

1583

orig_interface_name, alt_interface_name)

1069

1584

interface_names.add(alt_interface)

1070

1585

# Is this a D-Bus signal?

1071

1586

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

1072

# Extract the original non-method function by

1073

# black magic

1074

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(

1075

1591

zip(attribute.func_code.co_freevars,

1076

attribute.__closure__))["func"]

1077

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

1078

1599

# Create a new, but exactly alike, function

1079

1600

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

1080

1601

# with the alternate D-Bus interface name

1081

new_function = (dbus.service.signal

1082

(alt_interface,

1083

attribute._dbus_signature)

1084

(types.FunctionType(

1085

nonmethod_func.func_code,

1086

nonmethod_func.func_globals,

1087

nonmethod_func.func_name,

1088

nonmethod_func.func_defaults,

1089

nonmethod_func.func_closure)))

1602

new_function = copy_function(nonmethod_func)

1603

new_function = (dbus.service.signal(

1604

alt_interface,

1605

attribute._dbus_signature)(new_function))

1090

1606

# Copy annotations, if any

1091

1607

try:

1092

new_function._dbus_annotations = (

1093

dict(attribute._dbus_annotations))

1608

new_function._dbus_annotations = dict(

1609

attribute._dbus_annotations)

1094

1610

except AttributeError:

1095

1611

pass

1612

1096

1613

# Define a creator of a function to call both the

1097

1614

# original and alternate functions, so both the

1098

1615

# original and alternate signals gets sent when

1101

1618

"""This function is a scope container to pass

1102

1619

func1 and func2 to the "call_both" function

1103

1620

outside of its arguments"""

1621

1622

@functools.wraps(func2)

1104

1623

def call_both(*args, **kwargs):

1105

1624

"""This function will emit two D-Bus

1106

1625

signals by calling func1 and func2"""

1107

1626

func1(*args, **kwargs)

1108

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

1109

1634

return call_both

1110

1635

# Create the "call_both" function and add it to

1111

1636

# the class

1116

1641

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

1117

1642

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

1118

1643

# to the class.

1119

attr[attrname] = (dbus.service.method

1120

(alt_interface,

1121

attribute._dbus_in_signature,

1122

attribute._dbus_out_signature)

1123

(types.FunctionType

1124

(attribute.func_code,

1125

attribute.func_globals,

1126

attribute.func_name,

1127

attribute.func_defaults,

1128

attribute.func_closure)))

1644

attr[attrname] = (

1645

dbus.service.method(

1646

alt_interface,

1647

attribute._dbus_in_signature,

1648

attribute._dbus_out_signature)

1649

(copy_function(attribute)))

1129

1650

# Copy annotations, if any

1130

1651

try:

1131

attr[attrname]._dbus_annotations = (

1132

dict(attribute._dbus_annotations))

1652

attr[attrname]._dbus_annotations = dict(

1653

attribute._dbus_annotations)

1133

1654

except AttributeError:

1134

1655

pass

1135

1656

# Is this a D-Bus property?

1138

1659

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

1139

1660

# property with the alternate D-Bus interface

1140

1661

# name. Add it to the class.

1141

attr[attrname] = (dbus_service_property

1142

(alt_interface,

1143

attribute._dbus_signature,

1144

attribute._dbus_access,

1145

attribute

1146

._dbus_get_args_options

1147

["byte_arrays"])

1148

(types.FunctionType

1149

(attribute.func_code,

1150

attribute.func_globals,

1151

attribute.func_name,

1152

attribute.func_defaults,

1153

attribute.func_closure)))

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

1154

1668

# Copy annotations, if any

1155

1669

try:

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1670

attr[attrname]._dbus_annotations = dict(

1671

attribute._dbus_annotations)

1158

1672

except AttributeError:

1159

1673

pass

1160

1674

# Is this a D-Bus interface?

1163

1677

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

1164

1678

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

1165

1679

# to the class.

1166

attr[attrname] = (dbus_interface_annotations

1167

(alt_interface)

1168

(types.FunctionType

1169

(attribute.func_code,

1170

attribute.func_globals,

1171

attribute.func_name,

1172

attribute.func_defaults,

1173

attribute.func_closure)))

1680

attr[attrname] = (

1681

dbus_interface_annotations(alt_interface)

1682

(copy_function(attribute)))

1174

1683

if deprecate:

1175

1684

# Deprecate all alternate interfaces

1176

iname="_AlternateDBusNames_interface_annotation{0}"

1685

iname = "_AlternateDBusNames_interface_annotation{}"

1177

1686

for interface_name in interface_names:

1687

1178

1688

@dbus_interface_annotations(interface_name)

1179

1689

def func(self):

1180

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

1181

"true" }

1690

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

1691

"true"}

1182

1692

# Find an unused name

1183

1693

for aname in (iname.format(i)

1184

1694

for i in itertools.count()):

1188

1698

if interface_names:

1189

1699

# Replace the class with a new subclass of it with

1190

1700

# methods, signals, etc. as created above.

1191

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

1192

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

1193

1707

return cls

1708

1194

1709

return wrapper

1195

1710

1196

1711

1197

1712

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

1198

"se.bsnet.fukt.Mandos"})

1713

"se.bsnet.fukt.Mandos"})

1199

1714

class ClientDBus(Client, DBusObjectWithProperties):

1200

1715

"""A Client class using D-Bus

1201

1716

1202

1717

Attributes:

1203

1718

dbus_object_path: dbus.ObjectPath

1204

1719

bus: dbus.SystemBus()

1205

1720

"""

1206

1721

1207

1722

runtime_expansions = (Client.runtime_expansions

1208

+ ("dbus_object_path",))

1209

1723

+ ("dbus_object_path", ))

1724

1725

_interface = "se.recompile.Mandos.Client"

1726

1210

1727

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

1211

1212

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

1728

1729

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

1213

1730

self.bus = bus

1214

1731

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

1215

1732

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

1216

1733

# the D-Bus

1217

client_object_name = unicode(self.name).translate(

1734

client_object_name = str(self.name).translate(

1218

1735

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

1219

1736

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

1220

self.dbus_object_path = (dbus.ObjectPath

1221

("/clients/" + client_object_name))

1737

self.dbus_object_path = dbus.ObjectPath(

1738

"/clients/" + client_object_name)

1222

1739

DBusObjectWithProperties.__init__(self, self.bus,

1223

1740

self.dbus_object_path)

1224

1225

def notifychangeproperty(transform_func,

1226

dbus_name, type_func=lambda x: x,

1227

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

1228

1747

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

1229

1748

its changes to DBus.

1230

1749

1231

1750

transform_fun: Function that takes a value and a variant_level

1232

1751

and transforms it to a D-Bus type.

1233

1752

dbus_name: D-Bus name of the variable

1235

1754

to the D-Bus. Default: no transform

1236

1755

variant_level: D-Bus variant level. Default: 1

1237

1756

"""

1238

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

1757

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

1758

1239

1759

def setter(self, value):

1240

1760

if hasattr(self, "dbus_object_path"):

1241

1761

if (not hasattr(self, attrname) or

1242

1762

type_func(getattr(self, attrname, None))

1243

1763

!= type_func(value)):

1244

dbus_value = transform_func(type_func(value),

1245

variant_level

1246

=variant_level)

1247

self.PropertyChanged(dbus.String(dbus_name),

1248

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

1249

1779

setattr(self, attrname, value)

1250

1780

1251

1781

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

1252

1782

1253

1783

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1254

1784

approvals_pending = notifychangeproperty(dbus.Boolean,

1255

1785

"ApprovalPending",

1256

type_func = bool)

1786

type_func=bool)

1257

1787

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

1258

1788

last_enabled = notifychangeproperty(datetime_to_dbus,

1259

1789

"LastEnabled")

1260

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

1261

type_func = lambda checker:

1262

checker is not None)

1790

checker = notifychangeproperty(

1791

dbus.Boolean, "CheckerRunning",

1792

type_func=lambda checker: checker is not None)

1263

1793

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1264

1794

"LastCheckedOK")

1265

1795

last_checker_status = notifychangeproperty(dbus.Int16,

1268

1798

datetime_to_dbus, "LastApprovalRequest")

1269

1799

approved_by_default = notifychangeproperty(dbus.Boolean,

1270

1800

"ApprovedByDefault")

1271

approval_delay = notifychangeproperty(dbus.UInt64,

1272

"ApprovalDelay",

1273

type_func =

1274

timedelta_to_milliseconds)

1801

approval_delay = notifychangeproperty(

1802

dbus.UInt64, "ApprovalDelay",

1803

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

1275

1804

approval_duration = notifychangeproperty(

1276

1805

dbus.UInt64, "ApprovalDuration",

1277

type_func = timedelta_to_milliseconds)

1806

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

1278

1807

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

1279

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

1280

type_func =

1281

timedelta_to_milliseconds)

1808

timeout = notifychangeproperty(

1809

dbus.UInt64, "Timeout",

1810

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

1282

1811

extended_timeout = notifychangeproperty(

1283

1812

dbus.UInt64, "ExtendedTimeout",

1284

type_func = timedelta_to_milliseconds)

1285

interval = notifychangeproperty(dbus.UInt64,

1286

"Interval",

1287

type_func =

1288

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)

1289

1817

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

1290

1818

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

1819

invalidate_only=True)

1820

1291

1821

del notifychangeproperty

1292

1822

1293

1823

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

1294

1824

try:

1295

1825

self.remove_from_connection()

1298

1828

if hasattr(DBusObjectWithProperties, "__del__"):

1299

1829

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

1300

1830

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

1301

1302

def checker_callback(self, pid, condition, command,

1303

*args, **kwargs):

1304

self.checker_callback_tag = None

1305

self.checker = None

1306

if os.WIFEXITED(condition):

1307

exitstatus = os.WEXITSTATUS(condition)

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:

1308

1839

# Emit D-Bus signal

1309

1840

self.CheckerCompleted(dbus.Int16(exitstatus),

1310

dbus.Int64(condition),

1841

# This is specific to GNU libC

1842

dbus.Int64(exitstatus << 8),

1311

1843

dbus.String(command))

1312

1844

else:

1313

1845

# Emit D-Bus signal

1314

1846

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

1315

dbus.Int64(condition),

1847

dbus.Int64(

1848

# This is specific to GNU libC

1849

(exitstatus << 8)

1850

| self.last_checker_signal),

1316

1851

dbus.String(command))

1317

1318

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

1319

*args, **kwargs)

1320

1852

return ret

1853

1321

1854

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

1322

old_checker = self.checker

1323

if self.checker is not None:

1324

old_checker_pid = self.checker.pid

1325

else:

1326

old_checker_pid = None

1855

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

1327

1856

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

1328

1857

# Only if new checker process was started

1329

1858

if (self.checker is not None

1331

1860

# Emit D-Bus signal

1332

1861

self.CheckerStarted(self.current_checker_command)

1333

1862

return r

1334

1863

1335

1864

def _reset_approved(self):

1336

1865

self.approved = None

1337

1866

return False

1338

1867

1339

1868

def approve(self, value=True):

1340

1869

self.approved = value

1341

gobject.timeout_add(timedelta_to_milliseconds

1342

(self.approval_duration),

1343

self._reset_approved)

1870

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

1871

* 1000), self._reset_approved)

1344

1872

self.send_changedstate()

1345

1346

## D-Bus methods, signals & properties

1347

_interface = "se.recompile.Mandos.Client"

1348

1349

## Interfaces

1350

1351

@dbus_interface_annotations(_interface)

1352

def _foo(self):

1353

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

1354

"false"}

1355

1356

## Signals

1357

1873

1874

# D-Bus methods, signals & properties

1875

1876

# Interfaces

1877

1878

# Signals

1879

1358

1880

# CheckerCompleted - signal

1359

1881

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

1360

1882

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

1361

1883

"D-Bus signal"

1362

1884

pass

1363

1885

1364

1886

# CheckerStarted - signal

1365

1887

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

1366

1888

def CheckerStarted(self, command):

1367

1889

"D-Bus signal"

1368

1890

pass

1369

1891

1370

1892

# PropertyChanged - signal

1893

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

1371

1894

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

1372

1895

def PropertyChanged(self, property, value):

1373

1896

"D-Bus signal"

1374

1897

pass

1375

1898

1376

1899

# GotSecret - signal

1377

1900

@dbus.service.signal(_interface)

1378

1901

def GotSecret(self):

1381

1904

server to mandos-client

1382

1905

"""

1383

1906

pass

1384

1907

1385

1908

# Rejected - signal

1386

1909

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

1387

1910

def Rejected(self, reason):

1388

1911

"D-Bus signal"

1389

1912

pass

1390

1913

1391

1914

# NeedApproval - signal

1392

1915

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

1393

1916

def NeedApproval(self, timeout, default):

1394

1917

"D-Bus signal"

1395

1918

return self.need_approval()

1396

1397

## Methods

1398

1919

1920

# Methods

1921

1399

1922

# Approve - method

1400

1923

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

1401

1924

def Approve(self, value):

1402

1925

self.approve(value)

1403

1926

1404

1927

# CheckedOK - method

1405

1928

@dbus.service.method(_interface)

1406

1929

def CheckedOK(self):

1407

1930

self.checked_ok()

1408

1931

1409

1932

# Enable - method

1933

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

1410

1934

@dbus.service.method(_interface)

1411

1935

def Enable(self):

1412

1936

"D-Bus method"

1413

1937

self.enable()

1414

1938

1415

1939

# StartChecker - method

1940

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

1416

1941

@dbus.service.method(_interface)

1417

1942

def StartChecker(self):

1418

1943

"D-Bus method"

1419

1944

self.start_checker()

1420

1945

1421

1946

# Disable - method

1947

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

1422

1948

@dbus.service.method(_interface)

1423

1949

def Disable(self):

1424

1950

"D-Bus method"

1425

1951

self.disable()

1426

1952

1427

1953

# StopChecker - method

1954

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

1428

1955

@dbus.service.method(_interface)

1429

1956

def StopChecker(self):

1430

1957

self.stop_checker()

1431

1432

## Properties

1433

1958

1959

# Properties

1960

1434

1961

# ApprovalPending - property

1435

1962

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

1436

1963

def ApprovalPending_dbus_property(self):

1437

1964

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

1438

1965

1439

1966

# ApprovedByDefault - property

1440

@dbus_service_property(_interface, signature="b",

1967

@dbus_service_property(_interface,

1968

signature="b",

1441

1969

access="readwrite")

1442

1970

def ApprovedByDefault_dbus_property(self, value=None):

1443

1971

if value is None: # get

1444

1972

return dbus.Boolean(self.approved_by_default)

1445

1973

self.approved_by_default = bool(value)

1446

1974

1447

1975

# ApprovalDelay - property

1448

@dbus_service_property(_interface, signature="t",

1976

@dbus_service_property(_interface,

1977

signature="t",

1449

1978

access="readwrite")

1450

1979

def ApprovalDelay_dbus_property(self, value=None):

1451

1980

if value is None: # get

1452

return dbus.UInt64(self.approval_delay_milliseconds())

1981

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

1982

* 1000)

1453

1983

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

1454

1984

1455

1985

# ApprovalDuration - property

1456

@dbus_service_property(_interface, signature="t",

1986

@dbus_service_property(_interface,

1987

signature="t",

1457

1988

access="readwrite")

1458

1989

def ApprovalDuration_dbus_property(self, value=None):

1459

1990

if value is None: # get

1460

return dbus.UInt64(timedelta_to_milliseconds(

1461

self.approval_duration))

1991

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

1992

* 1000)

1462

1993

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

1463

1994

1464

1995

# Name - property

1996

@dbus_annotations(

1997

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

1465

1998

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

1466

1999

def Name_dbus_property(self):

1467

2000

return dbus.String(self.name)

1468

2001

1469

2002

# Fingerprint - property

2003

@dbus_annotations(

2004

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

1470

2005

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

1471

2006

def Fingerprint_dbus_property(self):

1472

2007

return dbus.String(self.fingerprint)

1473

2008

1474

2009

# Host - property

1475

@dbus_service_property(_interface, signature="s",

2010

@dbus_service_property(_interface,

2011

signature="s",

1476

2012

access="readwrite")

1477

2013

def Host_dbus_property(self, value=None):

1478

2014

if value is None: # get

1479

2015

return dbus.String(self.host)

1480

self.host = unicode(value)

1481

2016

self.host = str(value)

2017

1482

2018

# Created - property

2019

@dbus_annotations(

2020

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

1483

2021

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

1484

2022

def Created_dbus_property(self):

1485

2023

return datetime_to_dbus(self.created)

1486

2024

1487

2025

# LastEnabled - property

1488

2026

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

1489

2027

def LastEnabled_dbus_property(self):

1490

2028

return datetime_to_dbus(self.last_enabled)

1491

2029

1492

2030

# Enabled - property

1493

@dbus_service_property(_interface, signature="b",

2031

@dbus_service_property(_interface,

2032

signature="b",

1494

2033

access="readwrite")

1495

2034

def Enabled_dbus_property(self, value=None):

1496

2035

if value is None: # get

1499

2038

self.enable()

1500

2039

else:

1501

2040

self.disable()

1502

2041

1503

2042

# LastCheckedOK - property

1504

@dbus_service_property(_interface, signature="s",

2043

@dbus_service_property(_interface,

2044

signature="s",

1505

2045

access="readwrite")

1506

2046

def LastCheckedOK_dbus_property(self, value=None):

1507

2047

if value is not None:

1508

2048

self.checked_ok()

1509

2049

return

1510

2050

return datetime_to_dbus(self.last_checked_ok)

1511

2051

1512

2052

# LastCheckerStatus - property

1513

@dbus_service_property(_interface, signature="n",

1514

access="read")

2053

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

1515

2054

def LastCheckerStatus_dbus_property(self):

1516

2055

return dbus.Int16(self.last_checker_status)

1517

2056

1518

2057

# Expires - property

1519

2058

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

1520

2059

def Expires_dbus_property(self):

1521

2060

return datetime_to_dbus(self.expires)

1522

2061

1523

2062

# LastApprovalRequest - property

1524

2063

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

1525

2064

def LastApprovalRequest_dbus_property(self):

1526

2065

return datetime_to_dbus(self.last_approval_request)

1527

2066

1528

2067

# Timeout - property

1529

@dbus_service_property(_interface, signature="t",

2068

@dbus_service_property(_interface,

2069

signature="t",

1530

2070

access="readwrite")

1531

2071

def Timeout_dbus_property(self, value=None):

1532

2072

if value is None: # get

1533

return dbus.UInt64(self.timeout_milliseconds())

2073

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

1534

2074

old_timeout = self.timeout

1535

2075

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

1536

2076

# Reschedule disabling

1544

2084

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

1545

2085

is None):

1546

2086

return

1547

gobject.source_remove(self.disable_initiator_tag)

1548

self.disable_initiator_tag = (

1549

gobject.timeout_add(

1550

timedelta_to_milliseconds(self.expires - now),

1551

self.disable))

1552

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

1553

2092

# ExtendedTimeout - property

1554

@dbus_service_property(_interface, signature="t",

2093

@dbus_service_property(_interface,

2094

signature="t",

1555

2095

access="readwrite")

1556

2096

def ExtendedTimeout_dbus_property(self, value=None):

1557

2097

if value is None: # get

1558

return dbus.UInt64(self.extended_timeout_milliseconds())

2098

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

2099

* 1000)

1559

2100

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

1560

2101

1561

2102

# Interval - property

1562

@dbus_service_property(_interface, signature="t",

2103

@dbus_service_property(_interface,

2104

signature="t",

1563

2105

access="readwrite")

1564

2106

def Interval_dbus_property(self, value=None):

1565

2107

if value is None: # get

1566

return dbus.UInt64(self.interval_milliseconds())

2108

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

1567

2109

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

1568

2110

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

1569

2111

return

1570

2112

if self.enabled:

1571

2113

# Reschedule checker run

1572

gobject.source_remove(self.checker_initiator_tag)

1573

self.checker_initiator_tag = (gobject.timeout_add

1574

(value, self.start_checker))

1575

self.start_checker() # Start one now, too

1576

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

1577

2119

# Checker - property

1578

@dbus_service_property(_interface, signature="s",

2120

@dbus_service_property(_interface,

2121

signature="s",

1579

2122

access="readwrite")

1580

2123

def Checker_dbus_property(self, value=None):

1581

2124

if value is None: # get

1582

2125

return dbus.String(self.checker_command)

1583

self.checker_command = unicode(value)

1584

2126

self.checker_command = str(value)

2127

1585

2128

# CheckerRunning - property

1586

@dbus_service_property(_interface, signature="b",

2129

@dbus_service_property(_interface,

2130

signature="b",

1587

2131

access="readwrite")

1588

2132

def CheckerRunning_dbus_property(self, value=None):

1589

2133

if value is None: # get

1592

2136

self.start_checker()

1593

2137

else:

1594

2138

self.stop_checker()

1595

2139

1596

2140

# ObjectPath - property

2141

@dbus_annotations(

2142

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

2143

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

1597

2144

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

1598

2145

def ObjectPath_dbus_property(self):

1599

return self.dbus_object_path # is already a dbus.ObjectPath

1600

2146

return self.dbus_object_path # is already a dbus.ObjectPath

2147

1601

2148

# Secret = property

1602

@dbus_service_property(_interface, signature="ay",

1603

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)

1604

2156

def Secret_dbus_property(self, value):

1605

self.secret = str(value)

1606

2157

self.secret = bytes(value)

2158

1607

2159

del _interface

1608

2160

1609

2161

1612

2164

self._pipe = child_pipe

1613

2165

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

1614

2166

if not self._pipe.recv():

1615

raise KeyError()

1616

2167

raise KeyError(fpr)

2168

1617

2169

def __getattribute__(self, name):

1618

2170

if name == '_pipe':

1619

2171

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

1622

2174

if data[0] == 'data':

1623

2175

return data[1]

1624

2176

if data[0] == 'function':

2177

1625

2178

def func(*args, **kwargs):

1626

2179

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

1627

2180

return self._pipe.recv()[1]

2181

1628

2182

return func

1629

2183

1630

2184

def __setattr__(self, name, value):

1631

2185

if name == '_pipe':

1632

2186

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

1635

2189

1636

2190

class ClientHandler(socketserver.BaseRequestHandler, object):

1637

2191

"""A class to handle client connections.

1638

2192

1639

2193

Instantiated once for each connection to handle it.

1640

2194

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

1641

2195

1642

2196

def handle(self):

1643

2197

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

1644

2198

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

1645

unicode(self.client_address))

2199

str(self.client_address))

1646

2200

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

1647

2201

self.server.child_pipe.fileno())

1648

1649

session = (gnutls.connection

1650

.ClientSession(self.request,

1651

gnutls.connection

1652

.X509Credentials()))

1653

1654

# Note: gnutls.connection.X509Credentials is really a

1655

# generic GnuTLS certificate credentials object so long as

1656

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

1657

# here despite using OpenPGP certificates.

1658

1659

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

1660

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

1661

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

1662

# "+DHE-DSS"))

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

1663

2209

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

1664

2210

priority = self.server.gnutls_priority

1665

2211

if priority is None:

1666

2212

priority = "NORMAL"

1667

(gnutls.library.functions

1668

.gnutls_priority_set_direct(session._c_object,

1669

priority, None))

1670

2213

gnutls.priority_set_direct(session._c_object,

2214

priority.encode("utf-8"),

2215

None)

2216

1671

2217

# Start communication using the Mandos protocol

1672

2218

# Get protocol number

1673

2219

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

1674

2220

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

1675

2221

try:

1676

2222

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

1677

raise RuntimeError

2223

raise RuntimeError(line)

1678

2224

except (ValueError, IndexError, RuntimeError) as error:

1679

2225

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

1680

2226

return

1681

2227

1682

2228

# Start GnuTLS connection

1683

2229

try:

1684

2230

session.handshake()

1685

except gnutls.errors.GNUTLSError as error:

2231

except gnutls.Error as error:

1686

2232

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

1687

2233

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

1688

2234

# established. Just abandon the request.

1689

2235

return

1690

2236

logger.debug("Handshake succeeded")

1691

2237

1692

2238

approval_required = False

1693

2239

try:

1694

2240

try:

1695

fpr = self.fingerprint(self.peer_certificate

1696

(session))

1697

except (TypeError,

1698

gnutls.errors.GNUTLSError) as error:

2241

fpr = self.fingerprint(

2242

self.peer_certificate(session))

2243

except (TypeError, gnutls.Error) as error:

1699

2244

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

1700

2245

return

1701

2246

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

1702

2247

1703

2248

try:

1704

2249

client = ProxyClient(child_pipe, fpr,

1705

2250

self.client_address)

1706

2251

except KeyError:

1707

2252

return

1708

2253

1709

2254

if client.approval_delay:

1710

2255

delay = client.approval_delay

1711

2256

client.approvals_pending += 1

1712

2257

approval_required = True

1713

2258

1714

2259

while True:

1715

2260

if not client.enabled:

1716

2261

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

1717

client.name)

2262

client.name)

1718

2263

if self.server.use_dbus:

1719

2264

# Emit D-Bus signal

1720

2265

client.Rejected("Disabled")

1721

2266

return

1722

2267

1723

2268

if client.approved or not client.approval_delay:

1724

#We are approved or approval is disabled

2269

# We are approved or approval is disabled

1725

2270

break

1726

2271

elif client.approved is None:

1727

2272

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

1729

2274

if self.server.use_dbus:

1730

2275

# Emit D-Bus signal

1731

2276

client.NeedApproval(

1732

client.approval_delay_milliseconds(),

1733

client.approved_by_default)

2277

client.approval_delay.total_seconds()

2278

* 1000, client.approved_by_default)

1734

2279

else:

1735

2280

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

1736

2281

client.name)

1738

2283

# Emit D-Bus signal

1739

2284

client.Rejected("Denied")

1740

2285

return

1741

1742

#wait until timeout or approved

2286

2287

# wait until timeout or approved

1743

2288

time = datetime.datetime.now()

1744

2289

client.changedstate.acquire()

1745

client.changedstate.wait(

1746

float(timedelta_to_milliseconds(delay)

1747

/ 1000))

2290

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

1748

2291

client.changedstate.release()

1749

2292

time2 = datetime.datetime.now()

1750

2293

if (time2 - time) >= delay:

1760

2303

break

1761

2304

else:

1762

2305

delay -= time2 - time

1763

1764

sent_size = 0

1765

while sent_size < len(client.secret):

1766

try:

1767

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

1768

except gnutls.errors.GNUTLSError as error:

1769

logger.warning("gnutls send failed",

1770

exc_info=error)

1771

return

1772

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

1773

sent, len(client.secret)

1774

- (sent_size + sent))

1775

sent_size += sent

1776

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

1777

2314

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

1778

2315

# bump the timeout using extended_timeout

1779

2316

client.bump_timeout(client.extended_timeout)

1780

2317

if self.server.use_dbus:

1781

2318

# Emit D-Bus signal

1782

2319

client.GotSecret()

1783

2320

1784

2321

finally:

1785

2322

if approval_required:

1786

2323

client.approvals_pending -= 1

1787

2324

try:

1788

2325

session.bye()

1789

except gnutls.errors.GNUTLSError as error:

2326

except gnutls.Error as error:

1790

2327

logger.warning("GnuTLS bye failed",

1791

2328

exc_info=error)

1792

2329

1793

2330

@staticmethod

1794

2331

def peer_certificate(session):

1795

2332

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

1796

2333

# If not an OpenPGP certificate...

1797

if (gnutls.library.functions

1798

.gnutls_certificate_type_get(session._c_object)

1799

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1800

# ...do the normal thing

1801

return session.peer_certificate

2334

if (gnutls.certificate_type_get(session._c_object)

2335

!= gnutls.CRT_OPENPGP):

2336

# ...return invalid data

2337

return b""

1802

2338

list_size = ctypes.c_uint(1)

1803

cert_list = (gnutls.library.functions

1804

.gnutls_certificate_get_peers

2339

cert_list = (gnutls.certificate_get_peers

1805

2340

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

1806

2341

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

1807

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

1808

" certificate")

2342

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

1809

2343

if list_size.value == 0:

1810

2344

return None

1811

2345

cert = cert_list[0]

1812

2346

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

1813

2347

1814

2348

@staticmethod

1815

2349

def fingerprint(openpgp):

1816

2350

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1817

2351

# New GnuTLS "datum" with the OpenPGP public key

1818

datum = (gnutls.library.types

1819

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

1820

ctypes.POINTER

1821

(ctypes.c_ubyte)),

1822

ctypes.c_uint(len(openpgp))))

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

1823

2356

# New empty GnuTLS certificate

1824

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1825

(gnutls.library.functions

1826

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2357

crt = gnutls.openpgp_crt_t()

2358

gnutls.openpgp_crt_init(ctypes.byref(crt))

1827

2359

# Import the OpenPGP public key into the certificate

1828

(gnutls.library.functions

1829

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

1830

gnutls.library.constants

1831

.GNUTLS_OPENPGP_FMT_RAW))

2360

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

2361

gnutls.OPENPGP_FMT_RAW)

1832

2362

# Verify the self signature in the key

1833

2363

crtverify = ctypes.c_uint()

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_verify_self(crt, 0,

1836

ctypes.byref(crtverify)))

2364

gnutls.openpgp_crt_verify_self(crt, 0,

2365

ctypes.byref(crtverify))

1837

2366

if crtverify.value != 0:

1838

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1839

raise (gnutls.errors.CertificateSecurityError

1840

("Verify failed"))

2367

gnutls.openpgp_crt_deinit(crt)

2368

raise gnutls.CertificateSecurityError(code

2369

=crtverify.value)

1841

2370

# New buffer for the fingerprint

1842

2371

buf = ctypes.create_string_buffer(20)

1843

2372

buf_len = ctypes.c_size_t()

1844

2373

# Get the fingerprint from the certificate into the buffer

1845

(gnutls.library.functions

1846

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

1847

ctypes.byref(buf_len)))

2374

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

2375

ctypes.byref(buf_len))

1848

2376

# Deinit the certificate

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2377

gnutls.openpgp_crt_deinit(crt)

1850

2378

# Convert the buffer to a Python bytestring

1851

2379

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

1852

2380

# Convert the bytestring to hexadecimal notation

1856

2384

1857

2385

class MultiprocessingMixIn(object):

1858

2386

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

2387

1859

2388

def sub_process_main(self, request, address):

1860

2389

try:

1861

2390

self.finish_request(request, address)

1862

2391

except Exception:

1863

2392

self.handle_error(request, address)

1864

2393

self.close_request(request)

1865

2394

1866

2395

def process_request(self, request, address):

1867

2396

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

1868

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

1869

args = (request, address))

2397

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

2398

args=(request, address))

1870

2399

proc.start()

1871

2400

return proc

1872

2401

1873

2402

1874

2403

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1875

2404

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

2405

1876

2406

def process_request(self, request, client_address):

1877

2407

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

1878

2408

1879

2409

This function creates a new pipe in self.pipe

1880

2410

"""

1881

2411

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1882

2412

1883

2413

proc = MultiprocessingMixIn.process_request(self, request,

1884

2414

client_address)

1885

2415

self.child_pipe.close()

1886

2416

self.add_pipe(parent_pipe, proc)

1887

2417

1888

2418

def add_pipe(self, parent_pipe, proc):

1889

2419

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

1890

raise NotImplementedError

2420

raise NotImplementedError()

1891

2421

1892

2422

1893

2423

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1894

2424

socketserver.TCPServer, object):

1895

2425

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

1896

2426

1897

2427

Attributes:

1898

2428

enabled: Boolean; whether this server is activated yet

1899

2429

interface: None or a network interface name (string)

1900

2430

use_ipv6: Boolean; to use IPv6 or not

1901

2431

"""

2432

1902

2433

def __init__(self, server_address, RequestHandlerClass,

1903

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

2434

interface=None,

2435

use_ipv6=True,

2436

socketfd=None):

1904

2437

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

1905

2438

creating a new one with socket.socket().

1906

2439

"""

1912

2445

self.socketfd = socketfd

1913

2446

# Save the original socket.socket() function

1914

2447

self.socket_socket = socket.socket

2448

1915

2449

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

1916

#

2450

#

1917

2451

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

1918

2452

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

1919

2453

# patching socket.socket.)

1920

#

2454

#

1921

2455

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

1922

2456

@functools.wraps(socket.socket)

1923

2457

def socket_wrapper(*args, **kwargs):

1935

2469

# socket_wrapper(), if socketfd was set.

1936

2470

socketserver.TCPServer.__init__(self, server_address,

1937

2471

RequestHandlerClass)

1938

2472

1939

2473

def server_bind(self):

1940

2474

"""This overrides the normal server_bind() function

1941

2475

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

1942

2476

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

2477

global SO_BINDTODEVICE

1943

2478

if self.interface is not None:

1944

2479

if SO_BINDTODEVICE is None:

1945

logger.error("SO_BINDTODEVICE does not exist;"

1946

" cannot bind to interface %s",

1947

self.interface)

1948

else:

1949

try:

1950

self.socket.setsockopt(socket.SOL_SOCKET,

1951

SO_BINDTODEVICE,

1952

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

1953

except socket.error as error:

1954

if error.errno == errno.EPERM:

1955

logger.error("No permission to bind to"

1956

" interface %s", self.interface)

1957

elif error.errno == errno.ENOPROTOOPT:

1958

logger.error("SO_BINDTODEVICE not available;"

1959

" cannot bind to interface %s",

1960

self.interface)

1961

elif error.errno == errno.ENODEV:

1962

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

1963

" cannot bind", self.interface)

1964

else:

1965

raise

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

1966

2501

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

1967

2502

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

1968

2503

if not self.server_address[0]:

1969

2504

if self.address_family == socket.AF_INET6:

1970

any_address = "::" # in6addr_any

2505

any_address = "::" # in6addr_any

1971

2506

else:

1972

any_address = socket.INADDR_ANY

2507

any_address = "0.0.0.0" # INADDR_ANY

1973

2508

self.server_address = (any_address,

1974

2509

self.server_address[1])

1975

2510

elif not self.server_address[1]:

1976

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

1977

0)

2511

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

1978

2512

# if self.interface:

1979

2513

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

1980

2514

# 0, # port

1986

2520

1987

2521

class MandosServer(IPv6_TCPServer):

1988

2522

"""Mandos server.

1989

2523

1990

2524

Attributes:

1991

2525

clients: set of Client objects

1992

2526

gnutls_priority GnuTLS priority string

1993

2527

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

1994

1995

Assumes a gobject.MainLoop event loop.

2528

2529

Assumes a GLib.MainLoop event loop.

1996

2530

"""

2531

1997

2532

def __init__(self, server_address, RequestHandlerClass,

1998

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

1999

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

2000

2539

self.enabled = False

2001

2540

self.clients = clients

2002

2541

if self.clients is None:

2005

2544

self.gnutls_priority = gnutls_priority

2006

2545

IPv6_TCPServer.__init__(self, server_address,

2007

2546

RequestHandlerClass,

2008

interface = interface,

2009

use_ipv6 = use_ipv6,

2010

socketfd = socketfd)

2547

interface=interface,

2548

use_ipv6=use_ipv6,

2549

socketfd=socketfd)

2550

2011

2551

def server_activate(self):

2012

2552

if self.enabled:

2013

2553

return socketserver.TCPServer.server_activate(self)

2014

2554

2015

2555

def enable(self):

2016

2556

self.enabled = True

2017

2557

2018

2558

def add_pipe(self, parent_pipe, proc):

2019

2559

# Call "handle_ipc" for both data and EOF events

2020

gobject.io_add_watch(parent_pipe.fileno(),

2021

gobject.IO_IN | gobject.IO_HUP,

2022

functools.partial(self.handle_ipc,

2023

parent_pipe =

2024

parent_pipe,

2025

proc = proc))

2026

2027

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

2028

proc = None, client_object=None):

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

2029

2571

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

2030

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

2572

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

2031

2573

# Wait for other process to exit

2032

2574

proc.join()

2033

2575

return False

2034

2576

2035

2577

# Read a request from the child

2036

2578

request = parent_pipe.recv()

2037

2579

command = request[0]

2038

2580

2039

2581

if command == 'init':

2040

fpr = request[1]

2582

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

2041

2583

address = request[2]

2042

2043

for c in self.clients.itervalues():

2584

2585

for c in self.clients.values():

2044

2586

if c.fingerprint == fpr:

2045

2587

client = c

2046

2588

break

2053

2595

address[0])

2054

2596

parent_pipe.send(False)

2055

2597

return False

2056

2057

gobject.io_add_watch(parent_pipe.fileno(),

2058

gobject.IO_IN | gobject.IO_HUP,

2059

functools.partial(self.handle_ipc,

2060

parent_pipe =

2061

parent_pipe,

2062

proc = proc,

2063

client_object =

2064

client))

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

2065

2606

parent_pipe.send(True)

2066

2607

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

2067

2608

# same fileno

2070

2611

funcname = request[1]

2071

2612

args = request[2]

2072

2613

kwargs = request[3]

2073

2614

2074

2615

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

2075

2616

funcname)(*args,

2076

**kwargs)))

2077

2617

**kwargs)))

2618

2078

2619

if command == 'getattr':

2079

2620

attrname = request[1]

2080

if callable(client_object.__getattribute__(attrname)):

2081

parent_pipe.send(('function',))

2621

if isinstance(client_object.__getattribute__(attrname),

2622

collections.Callable):

2623

parent_pipe.send(('function', ))

2082

2624

else:

2083

parent_pipe.send(('data', client_object

2084

.__getattribute__(attrname)))

2085

2625

parent_pipe.send((

2626

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

2627

2086

2628

if command == 'setattr':

2087

2629

attrname = request[1]

2088

2630

value = request[2]

2089

2631

setattr(client_object, attrname, value)

2090

2632

2091

2633

return True

2092

2634

2093

2635

2094

2636

def rfc3339_duration_to_delta(duration):

2095

2637

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

2096

2638

2097

2639

>>> rfc3339_duration_to_delta("P7D")

2098

2640

datetime.timedelta(7)

2099

2641

>>> rfc3339_duration_to_delta("PT60S")

2109

2651

>>> rfc3339_duration_to_delta("P1DT3M20S")

2110

2652

datetime.timedelta(1, 200)

2111

2653

"""

2112

2654

2113

2655

# Parsing an RFC 3339 duration with regular expressions is not

2114

2656

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

2115

2657

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

2116

2658

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

2117

2659

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

2118

2660

# avoid excessive use of external libraries.

2119

2661

2120

2662

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

2121

Token = collections.namedtuple("Token",

2122

("regexp", # To match token; if

2123

# "value" is not None,

2124

# must have a "group"

2125

# containing digits

2126

"value", # datetime.timedelta or

2127

# None

2128

"followers")) # Tokens valid after

2129

# this token

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

2130

2668

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

2131

2669

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

2132

2670

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

2133

2671

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

2134

2672

datetime.timedelta(seconds=1),

2135

frozenset((token_end,)))

2673

frozenset((token_end, )))

2136

2674

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

2137

2675

datetime.timedelta(minutes=1),

2138

2676

frozenset((token_second, token_end)))

2154

2692

frozenset((token_month, token_end)))

2155

2693

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

2156

2694

datetime.timedelta(weeks=1),

2157

frozenset((token_end,)))

2695

frozenset((token_end, )))

2158

2696

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

2159

2697

frozenset((token_year, token_month,

2160

2698

token_day, token_time,

2161

token_week))),

2162

# Define starting values

2163

value = datetime.timedelta() # Value so far

2699

token_week)))

2700

# Define starting values:

2701

# Value so far

2702

value = datetime.timedelta()

2164

2703

found_token = None

2165

followers = frozenset(token_duration,) # Following valid tokens

2166

s = duration # String left to parse

2704

# Following valid tokens

2705

followers = frozenset((token_duration, ))

2706

# String left to parse

2707

s = duration

2167

2708

# Loop until end token is found

2168

2709

while found_token is not token_end:

2169

2710

# Search for any currently valid tokens

2185

2726

break

2186

2727

else:

2187

2728

# No currently valid tokens were found

2188

raise ValueError("Invalid RFC 3339 duration")

2729

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

2730

.format(duration))

2189

2731

# End token found

2190

2732

return value

2191

2733

2192

2734

2193

2735

def string_to_delta(interval):

2194

2736

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

2195

2737

2196

2738

>>> string_to_delta('7d')

2197

2739

datetime.timedelta(7)

2198

2740

>>> string_to_delta('60s')

2206

2748

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

2207

2749

datetime.timedelta(0, 330)

2208

2750

"""

2209

2751

2210

2752

try:

2211

2753

return rfc3339_duration_to_delta(interval)

2212

2754

except ValueError:

2213

2755

pass

2214

2756

2215

2757

timevalue = datetime.timedelta(0)

2216

2758

for s in interval.split():

2217

2759

try:

2218

suffix = unicode(s[-1])

2760

suffix = s[-1]

2219

2761

value = int(s[:-1])

2220

2762

if suffix == "d":

2221

2763

delta = datetime.timedelta(value)

2228

2770

elif suffix == "w":

2229

2771

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

2230

2772

else:

2231

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

2232

.format(suffix))

2233

except (ValueError, IndexError) as e:

2773

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

2774

except IndexError as e:

2234

2775

raise ValueError(*(e.args))

2235

2776

timevalue += delta

2236

2777

return timevalue

2237

2778

2238

2779

2239

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

2780

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

2240

2781

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

2241

2782

2242

2783

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

2243

2784

if os.fork():

2244

2785

sys.exit()

2252

2793

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

2253

2794

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

2254

2795

raise OSError(errno.ENODEV,

2255

"{0} not a character device"

2796

"{} not a character device"

2256

2797

.format(os.devnull))

2257

2798

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

2258

2799

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

2262

2803

2263

2804

2264

2805

def main():

2265

2806

2266

2807

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

2267

2808

# Parsing of options, both command line and config file

2268

2809

2269

2810

parser = argparse.ArgumentParser()

2270

2811

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

2271

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

2812

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

2272

2813

help="show version number and exit")

2273

2814

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

2274

2815

help="Bind to interface IF")

2280

2821

help="Run self-test")

2281

2822

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

2282

2823

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

2283

" to terminal")

2824

" to terminal", default=None)

2284

2825

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

2285

2826

help="Debug level for stdout output")

2286

2827

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

2293

2834

" files")

2294

2835

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

2295

2836

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

2296

" system bus interface")

2837

" system bus interface", default=None)

2297

2838

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

2298

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

2839

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

2840

default=None)

2299

2841

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

2300

2842

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

2301

" state")

2843

" state", default=None)

2302

2844

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

2303

2845

help="Specify a file descriptor to a network"

2304

2846

" socket to use instead of creating one")

2305

2847

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

2306

2848

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

2307

2849

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

2308

help="Run in foreground")

2309

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

2310

2855

options = parser.parse_args()

2311

2856

2312

2857

if options.check:

2313

2858

import doctest

2314

doctest.testmod()

2315

sys.exit()

2316

2859

fail_count, test_count = doctest.testmod()

2860

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

2861

2317

2862

# Default values for config file for server-global settings

2318

server_defaults = { "interface": "",

2319

"address": "",

2320

"port": "",

2321

"debug": "False",

2322

"priority":

2323

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

2324

"servicename": "Mandos",

2325

"use_dbus": "True",

2326

"use_ipv6": "True",

2327

"debuglevel": "",

2328

"restore": "True",

2329

"socket": "",

2330

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

2331

"foreground": "False",

2332

}

2333

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

2334

2881

# Parse config file for server-global settings

2335

2882

server_config = configparser.SafeConfigParser(server_defaults)

2336

2883

del server_defaults

2337

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

2338

"mandos.conf"))

2884

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

2339

2885

# Convert the SafeConfigParser object to a dict

2340

2886

server_settings = server_config.defaults()

2341

2887

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

2342

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

2888

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

2889

"foreground", "zeroconf"):

2343

2890

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

2344

2891

option)

2345

2892

if server_settings["port"]:

2355

2902

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

2356

2903

["socket"])

2357

2904

del server_config

2358

2905

2359

2906

# Override the settings from the config file with command line

2360

2907

# options, if set.

2361

2908

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

2362

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

2363

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

2364

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

2909

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

2910

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

2911

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

2365

2912

value = getattr(options, option)

2366

2913

if value is not None:

2367

2914

server_settings[option] = value

2368

2915

del options

2369

2916

# Force all strings to be unicode

2370

2917

for option in server_settings.keys():

2371

if type(server_settings[option]) is str:

2372

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

2373

2925

# Debug implies foreground

2374

2926

if server_settings["debug"]:

2375

2927

server_settings["foreground"] = True

2376

2928

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

2377

2929

2378

2930

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

2379

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

2380

2937

# For convenience

2381

2938

debug = server_settings["debug"]

2382

2939

debuglevel = server_settings["debuglevel"]

2385

2942

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

2386

2943

stored_state_file)

2387

2944

foreground = server_settings["foreground"]

2388

2945

zeroconf = server_settings["zeroconf"]

2946

2389

2947

if debug:

2390

2948

initlogger(debug, logging.DEBUG)

2391

2949

else:

2394

2952

else:

2395

2953

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

2396

2954

initlogger(debug, level)

2397

2955

2398

2956

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

2399

syslogger.setFormatter(logging.Formatter

2400

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

2401

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

2402

.format(server_settings

2403

["servicename"])))

2404

2957

syslogger.setFormatter(

2958

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

2959

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

2960

server_settings["servicename"])))

2961

2405

2962

# Parse config file with clients

2406

2963

client_config = configparser.SafeConfigParser(Client

2407

2964

.client_defaults)

2408

2965

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

2409

2966

"clients.conf"))

2410

2967

2411

2968

global mandos_dbus_service

2412

2969

mandos_dbus_service = None

2413

2414

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

2415

server_settings["port"]),

2416

ClientHandler,

2417

interface=(server_settings["interface"]

2418

or None),

2419

use_ipv6=use_ipv6,

2420

gnutls_priority=

2421

server_settings["priority"],

2422

use_dbus=use_dbus,

2423

socketfd=(server_settings["socket"]

2424

or None))

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)

2425

2982

if not foreground:

2426

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

2983

pidfilename = "/run/mandos.pid"

2984

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

2985

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

2427

2986

pidfile = None

2428

2987

try:

2429

pidfile = open(pidfilename, "w")

2988

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

2430

2989

except IOError as e:

2431

2990

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

2432

2991

exc_info=e)

2433

2434

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

2992

2993

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

2994

("mandos", "mandos"),

2995

("nobody", "nogroup")):

2435

2996

try:

2436

2997

uid = pwd.getpwnam(name).pw_uid

2437

gid = pwd.getpwnam(name).pw_gid

2998

gid = pwd.getpwnam(group).pw_gid

2438

2999

break

2439

3000

except KeyError:

2440

3001

continue

2444

3005

try:

2445

3006

os.setgid(gid)

2446

3007

os.setuid(uid)

3008

if debug:

3009

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

3010

gid))

2447

3011

except OSError as error:

3012

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

3013

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

2448

3014

if error.errno != errno.EPERM:

2449

raise error

2450

3015

raise

3016

2451

3017

if debug:

2452

3018

# Enable all possible GnuTLS debugging

2453

3019

2454

3020

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

2455

3021

# - GnuTLS manual

2456

gnutls.library.functions.gnutls_global_set_log_level(11)

2457

2458

@gnutls.library.types.gnutls_log_func

3022

gnutls.global_set_log_level(11)

3023

3024

@gnutls.log_func

2459

3025

def debug_gnutls(level, string):

2460

3026

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

2461

2462

(gnutls.library.functions

2463

.gnutls_global_set_log_function(debug_gnutls))

2464

3027

3028

gnutls.global_set_log_function(debug_gnutls)

3029

2465

3030

# Redirect stdin so all checkers get /dev/null

2466

3031

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

2467

3032

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

2468

3033

if null > 2:

2469

3034

os.close(null)

2470

3035

2471

3036

# Need to fork before connecting to D-Bus

2472

3037

if not foreground:

2473

3038

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

2474

3039

daemon()

2475

2476

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

2477

# need to inform gobject that threads will be used.

2478

gobject.threads_init()

2479

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

2480

3045

global main_loop

2481

3046

# From the Avahi example code

2482

3047

DBusGMainLoop(set_as_default=True)

2483

main_loop = gobject.MainLoop()

3048

main_loop = GLib.MainLoop()

2484

3049

bus = dbus.SystemBus()

2485

3050

# End of Avahi example code

2486

3051

if use_dbus:

2487

3052

try:

2488

3053

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

2489

bus, do_not_queue=True)

2490

old_bus_name = (dbus.service.BusName

2491

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

2492

do_not_queue=True))

2493

except dbus.exceptions.NameExistsException as e:

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:

2494

3060

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

2495

3061

use_dbus = False

2496

3062

server_settings["use_dbus"] = False

2497

3063

tcp_server.use_dbus = False

2498

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2499

service = AvahiServiceToSyslog(name =

2500

server_settings["servicename"],

2501

servicetype = "_mandos._tcp",

2502

protocol = protocol, bus = bus)

2503

if server_settings["interface"]:

2504

service.interface = (if_nametoindex

2505

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

2506

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

2507

3075

global multiprocessing_manager

2508

3076

multiprocessing_manager = multiprocessing.Manager()

2509

3077

2510

3078

client_class = Client

2511

3079

if use_dbus:

2512

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

2513

3080

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

3081

2514

3082

client_settings = Client.config_parser(client_config)

2515

3083

old_client_settings = {}

2516

3084

clients_data = {}

2517

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

2518

3094

# Get client data and settings from last running state.

2519

3095

if server_settings["restore"]:

2520

3096

try:

2521

3097

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

2522

clients_data, old_client_settings = (pickle.load

2523

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

2524

3143

os.remove(stored_state_path)

2525

3144

except IOError as e:

2526

3145

if e.errno == errno.ENOENT:

2527

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

2528

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

3146

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

3147

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

2529

3148

else:

2530

3149

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

2531

3150

exc_info=e)

2532

3151

raise

2533

3152

except EOFError as e:

2534

3153

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

2535

"EOFError:", exc_info=e)

2536

3154

"EOFError:",

3155

exc_info=e)

3156

2537

3157

with PGPEngine() as pgp:

2538

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

2539

3163

# Decide which value to use after restoring saved state.

2540

3164

# We have three different values: Old config file,

2541

3165

# new config file, and saved state.

2546

3170

# For each value in new config, check if it

2547

3171

# differs from the old config value (Except for

2548

3172

# the "secret" attribute)

2549

if (name != "secret" and

2550

value != old_client_settings[client_name]

2551

[name]):

3173

if (name != "secret"

3174

and (value !=

3175

old_client_settings[client_name][name])):

2552

3176

client[name] = value

2553

3177

except KeyError:

2554

3178

pass

2555

3179

2556

3180

# Clients who has passed its expire date can still be

2557

# enabled if its last checker was successful. Clients

3181

# enabled if its last checker was successful. A Client

2558

3182

# whose checker succeeded before we stored its state is

2559

3183

# assumed to have successfully run all checkers during

2560

3184

# downtime.

2562

3186

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

2563

3187

if not client["last_checked_ok"]:

2564

3188

logger.warning(

2565

"disabling client {0} - Client never "

2566

"performed a successful checker"

2567

.format(client_name))

3189

"disabling client {} - Client never "

3190

"performed a successful checker".format(

3191

client_name))

2568

3192

client["enabled"] = False

2569

3193

elif client["last_checker_status"] != 0:

2570

3194

logger.warning(

2571

"disabling client {0} - Client "

2572

"last checker failed with error code {1}"

2573

.format(client_name,

2574

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

2575

3200

client["enabled"] = False

2576

3201

else:

2577

client["expires"] = (datetime.datetime

2578

.utcnow()

2579

+ client["timeout"])

3202

client["expires"] = (

3203

datetime.datetime.utcnow()

3204

+ client["timeout"])

2580

3205

logger.debug("Last checker succeeded,"

2581

" keeping {0} enabled"

2582

.format(client_name))

3206

" keeping {} enabled".format(

3207

client_name))

2583

3208

try:

2584

client["secret"] = (

2585

pgp.decrypt(client["encrypted_secret"],

2586

client_settings[client_name]

2587

["secret"]))

3209

client["secret"] = pgp.decrypt(

3210

client["encrypted_secret"],

3211

client_settings[client_name]["secret"])

2588

3212

except PGPError:

2589

3213

# If decryption fails, we use secret from new settings

2590

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

2591

.format(client_name))

2592

client["secret"] = (

2593

client_settings[client_name]["secret"])

2594

3214

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

3215

client_name))

3216

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

3217

["secret"])

3218

2595

3219

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

2596

3220

for client_name in (set(old_client_settings)

2597

3221

- set(client_settings)):

2599

3223

for client_name in (set(client_settings)

2600

3224

- set(old_client_settings)):

2601

3225

clients_data[client_name] = client_settings[client_name]

2602

3226

2603

3227

# Create all client objects

2604

for client_name, client in clients_data.iteritems():

3228

for client_name, client in clients_data.items():

2605

3229

tcp_server.clients[client_name] = client_class(

2606

name = client_name, settings = client)

2607

3230

name=client_name,

3231

settings=client,

3232

server_settings=server_settings)

3233

2608

3234

if not tcp_server.clients:

2609

3235

logger.warning("No clients defined")

2610

3236

2611

3237

if not foreground:

2612

3238

if pidfile is not None:

3239

pid = os.getpid()

2613

3240

try:

2614

3241

with pidfile:

2615

pid = os.getpid()

2616

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

3242

print(pid, file=pidfile)

2617

3243

except IOError:

2618

3244

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

2619

3245

pidfilename, pid)

2620

3246

del pidfile

2621

3247

del pidfilename

2622

2623

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

2624

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

2625

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

2626

3253

if use_dbus:

2627

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

2628

"se.bsnet.fukt.Mandos"})

2629

class MandosDBusService(DBusObjectWithProperties):

3254

3255

@alternate_dbus_interfaces(

3256

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

3257

class MandosDBusService(DBusObjectWithObjectManager):

2630

3258

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

3259

2631

3260

def __init__(self):

2632

3261

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

3262

2633

3263

_interface = "se.recompile.Mandos"

2634

2635

@dbus_interface_annotations(_interface)

2636

def _foo(self):

2637

return { "org.freedesktop.DBus.Property"

2638

".EmitsChangedSignal":

2639

"false"}

2640

3264

2641

3265

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

2642

3266

def ClientAdded(self, objpath):

2643

3267

"D-Bus signal"

2644

3268

pass

2645

3269

2646

3270

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

2647

3271

def ClientNotFound(self, fingerprint, address):

2648

3272

"D-Bus signal"

2649

3273

pass

2650

3274

3275

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

3276

"true"})

2651

3277

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

2652

3278

def ClientRemoved(self, objpath, name):

2653

3279

"D-Bus signal"

2654

3280

pass

2655

3281

3282

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

3283

"true"})

2656

3284

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

2657

3285

def GetAllClients(self):

2658

3286

"D-Bus method"

2659

return dbus.Array(c.dbus_object_path

2660

for c in

2661

tcp_server.clients.itervalues())

2662

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

2663

3292

@dbus.service.method(_interface,

2664

3293

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

2665

3294

def GetAllClientsWithProperties(self):

2666

3295

"D-Bus method"

2667

3296

return dbus.Dictionary(

2668

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

2669

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

2670

3300

signature="oa{sv}")

2671

3301

2672

3302

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

2673

3303

def RemoveClient(self, object_path):

2674

3304

"D-Bus method"

2675

for c in tcp_server.clients.itervalues():

3305

for c in tcp_server.clients.values():

2676

3306

if c.dbus_object_path == object_path:

2677

3307

del tcp_server.clients[c.name]

2678

3308

c.remove_from_connection()

2679

# Don't signal anything except ClientRemoved

3309

# Don't signal the disabling

2680

3310

c.disable(quiet=True)

2681

# Emit D-Bus signal

2682

self.ClientRemoved(object_path, c.name)

3311

# Emit D-Bus signal for removal

3312

self.client_removed_signal(c)

2683

3313

return

2684

3314

raise KeyError(object_path)

2685

3315

2686

3316

del _interface

2687

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

2688

3354

mandos_dbus_service = MandosDBusService()

2689

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

2690

3361

def cleanup():

2691

3362

"Cleanup function; run on exit"

2692

service.cleanup()

2693

2694

multiprocessing.active_children()

3363

if zeroconf:

3364

service.cleanup()

3365

3366

mp.active_children()

3367

wn.close()

2695

3368

if not (tcp_server.clients or client_settings):

2696

3369

return

2697

3370

2698

3371

# Store client before exiting. Secrets are encrypted with key

2699

3372

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

2700

3373

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

2701

3374

clients = {}

2702

3375

with PGPEngine() as pgp:

2703

for client in tcp_server.clients.itervalues():

3376

for client in tcp_server.clients.values():

2704

3377

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

2705

3378

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

2706

3379

key)

2707

3380

client_dict = {}

2708

3381

2709

3382

# A list of attributes that can not be pickled

2710

3383

# + secret.

2711

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

2712

"checker"))

2713

for name, typ in (inspect.getmembers

2714

(dbus.service.Object)):

3384

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

3385

"checker", "server_settings"}

3386

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

3387

.Object):

2715

3388

exclude.add(name)

2716

3389

2717

3390

client_dict["encrypted_secret"] = (client

2718

3391

.encrypted_secret)

2719

3392

for attr in client.client_structure:

2720

3393

if attr not in exclude:

2721

3394

client_dict[attr] = getattr(client, attr)

2722

3395

2723

3396

clients[client.name] = client_dict

2724

3397

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

2725

3398

2726

3399

try:

2727

with (tempfile.NamedTemporaryFile

2728

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

2729

dir=os.path.dirname(stored_state_path),

2730

delete=False)) as stored_state:

2731

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

2732

tempname=stored_state.name

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

2733

3409

os.rename(tempname, stored_state_path)

2734

3410

except (IOError, OSError) as e:

2735

3411

if not debug:

2738

3414

except NameError:

2739

3415

pass

2740

3416

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

2741

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

3417

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

2742

3418

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

2743

3419

else:

2744

3420

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

2745

3421

exc_info=e)

2746

raise e

2747

3422

raise

3423

2748

3424

# Delete all clients, and settings from config

2749

3425

while tcp_server.clients:

2750

3426

name, client = tcp_server.clients.popitem()

2751

3427

if use_dbus:

2752

3428

client.remove_from_connection()

2753

# Don't signal anything except ClientRemoved

3429

# Don't signal the disabling

2754

3430

client.disable(quiet=True)

3431

# Emit D-Bus signal for removal

2755

3432

if use_dbus:

2756

# Emit D-Bus signal

2757

mandos_dbus_service.ClientRemoved(client

2758

.dbus_object_path,

2759

client.name)

3433

mandos_dbus_service.client_removed_signal(client)

2760

3434

client_settings.clear()

2761

3435

2762

3436

atexit.register(cleanup)

2763

2764

for client in tcp_server.clients.itervalues():

3437

3438

for client in tcp_server.clients.values():

2765

3439

if use_dbus:

2766

# Emit D-Bus signal

2767

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3440

# Emit D-Bus signal for adding

3441

mandos_dbus_service.client_added_signal(client)

2768

3442

# Need to initiate checking of clients

2769

3443

if client.enabled:

2770

3444

client.init_checker()

2771

3445

2772

3446

tcp_server.enable()

2773

3447

tcp_server.server_activate()

2774

3448

2775

3449

# Find out what port we got

2776

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

3450

if zeroconf:

3451

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

2777

3452

if use_ipv6:

2778

3453

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

2779

3454

" flowinfo %d, scope_id %d",

2781

3456

else: # IPv4

2782

3457

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

2783

3458

*tcp_server.socket.getsockname())

2784

2785

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

2786

3459

3460

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

3461

2787

3462

try:

2788

# From the Avahi example code

2789

try:

2790

service.activate()

2791

except dbus.exceptions.DBusException as error:

2792

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

2793

cleanup()

2794

sys.exit(1)

2795

# End of Avahi example code

2796

2797

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

2798

lambda *args, **kwargs:

2799

(tcp_server.handle_request

2800

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

2801

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

2802

3478

logger.debug("Starting main loop")

2803

3479

main_loop.run()

2804

3480

except AvahiError as error:

2813

3489

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

2814

3490

cleanup()

2815

3491

3492

2816

3493

if __name__ == '__main__':

2817

3494

main()