/mandos/release : revision 237.7.471

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.16"

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(self, *args,

500

**kwargs)

501

syslogger.setFormatter(logging.Formatter(

502

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

503

.format(self.name)))

392

504

return ret

393

505

394

506

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

507

# Pretend that we have a GnuTLS module

508

class GnuTLS(object):

509

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

510

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

511

512

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

513

if library is None:

514

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

515

_library = ctypes.cdll.LoadLibrary(library)

516

del library

517

_need_version = b"3.3.0"

518

519

def __init__(self):

520

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

521

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

522

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

523

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

524

.format(self._need_version))

525

526

# Unless otherwise indicated, the constants and types below are

527

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

528

529

# Constants

530

E_SUCCESS = 0

531

E_INTERRUPTED = -52

532

E_AGAIN = -28

533

CRT_OPENPGP = 2

534

CLIENT = 2

535

SHUT_RDWR = 0

536

CRD_CERTIFICATE = 1

537

E_NO_CERTIFICATE_FOUND = -49

538

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

539

540

# Types

541

class session_int(ctypes.Structure):

542

_fields_ = []

543

session_t = ctypes.POINTER(session_int)

544

545

class certificate_credentials_st(ctypes.Structure):

546

_fields_ = []

547

certificate_credentials_t = ctypes.POINTER(

548

certificate_credentials_st)

549

certificate_type_t = ctypes.c_int

550

551

class datum_t(ctypes.Structure):

552

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

553

('size', ctypes.c_uint)]

554

555

class openpgp_crt_int(ctypes.Structure):

556

_fields_ = []

557

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

558

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

559

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

560

credentials_type_t = ctypes.c_int

561

transport_ptr_t = ctypes.c_void_p

562

close_request_t = ctypes.c_int

563

564

# Exceptions

565

class Error(Exception):

566

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

567

# exception might be raised from within GnuTLS.__init__,

568

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

569

# global variable has happened.

570

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

571

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

572

# code is passed, convert it to a string with

573

# gnutls.strerror()

574

self.code = code

575

if message is None and code is not None:

576

message = GnuTLS.strerror(code)

577

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

578

message, *args)

579

580

class CertificateSecurityError(Error):

581

pass

582

583

# Classes

584

class Credentials(object):

585

def __init__(self):

586

self._c_object = gnutls.certificate_credentials_t()

587

gnutls.certificate_allocate_credentials(

588

ctypes.byref(self._c_object))

589

self.type = gnutls.CRD_CERTIFICATE

590

591

def __del__(self):

592

gnutls.certificate_free_credentials(self._c_object)

593

594

class ClientSession(object):

595

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

596

self._c_object = gnutls.session_t()

597

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

598

gnutls.set_default_priority(self._c_object)

599

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

600

gnutls.handshake_set_private_extensions(self._c_object,

601

True)

602

self.socket = socket

603

if credentials is None:

604

credentials = gnutls.Credentials()

605

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

606

ctypes.cast(credentials._c_object,

607

ctypes.c_void_p))

608

self.credentials = credentials

609

610

def __del__(self):

611

gnutls.deinit(self._c_object)

612

613

def handshake(self):

614

return gnutls.handshake(self._c_object)

615

616

def send(self, data):

617

data = bytes(data)

618

data_len = len(data)

619

while data_len > 0:

620

data_len -= gnutls.record_send(self._c_object,

621

data[-data_len:],

622

data_len)

623

624

def bye(self):

625

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

626

627

# Error handling functions

628

def _error_code(result):

629

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

630

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

631

if result >= 0:

632

return result

633

if result == gnutls.E_NO_CERTIFICATE_FOUND:

634

raise gnutls.CertificateSecurityError(code=result)

635

raise gnutls.Error(code=result)

636

637

def _retry_on_error(result, func, arguments):

638

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

639

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

640

while result < 0:

641

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

642

return _error_code(result)

643

result = func(*arguments)

644

return result

645

646

# Unless otherwise indicated, the function declarations below are

647

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

648

649

# Functions

650

priority_set_direct = _library.gnutls_priority_set_direct

651

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

652

ctypes.POINTER(ctypes.c_char_p)]

653

priority_set_direct.restype = _error_code

654

655

init = _library.gnutls_init

656

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

657

init.restype = _error_code

658

659

set_default_priority = _library.gnutls_set_default_priority

660

set_default_priority.argtypes = [session_t]

661

set_default_priority.restype = _error_code

662

663

record_send = _library.gnutls_record_send

664

record_send.argtypes = [session_t, ctypes.c_void_p,

665

ctypes.c_size_t]

666

record_send.restype = ctypes.c_ssize_t

667

record_send.errcheck = _retry_on_error

668

669

certificate_allocate_credentials = (

670

_library.gnutls_certificate_allocate_credentials)

671

certificate_allocate_credentials.argtypes = [

672

ctypes.POINTER(certificate_credentials_t)]

673

certificate_allocate_credentials.restype = _error_code

674

675

certificate_free_credentials = (

676

_library.gnutls_certificate_free_credentials)

677

certificate_free_credentials.argtypes = [

678

certificate_credentials_t]

679

certificate_free_credentials.restype = None

680

681

handshake_set_private_extensions = (

682

_library.gnutls_handshake_set_private_extensions)

683

handshake_set_private_extensions.argtypes = [session_t,

684

ctypes.c_int]

685

handshake_set_private_extensions.restype = None

686

687

credentials_set = _library.gnutls_credentials_set

688

credentials_set.argtypes = [session_t, credentials_type_t,

689

ctypes.c_void_p]

690

credentials_set.restype = _error_code

691

692

strerror = _library.gnutls_strerror

693

strerror.argtypes = [ctypes.c_int]

694

strerror.restype = ctypes.c_char_p

695

696

certificate_type_get = _library.gnutls_certificate_type_get

697

certificate_type_get.argtypes = [session_t]

698

certificate_type_get.restype = _error_code

699

700

certificate_get_peers = _library.gnutls_certificate_get_peers

701

certificate_get_peers.argtypes = [session_t,

702

ctypes.POINTER(ctypes.c_uint)]

703

certificate_get_peers.restype = ctypes.POINTER(datum_t)

704

705

global_set_log_level = _library.gnutls_global_set_log_level

706

global_set_log_level.argtypes = [ctypes.c_int]

707

global_set_log_level.restype = None

708

709

global_set_log_function = _library.gnutls_global_set_log_function

710

global_set_log_function.argtypes = [log_func]

711

global_set_log_function.restype = None

712

713

deinit = _library.gnutls_deinit

714

deinit.argtypes = [session_t]

715

deinit.restype = None

716

717

handshake = _library.gnutls_handshake

718

handshake.argtypes = [session_t]

719

handshake.restype = _error_code

720

handshake.errcheck = _retry_on_error

721

722

transport_set_ptr = _library.gnutls_transport_set_ptr

723

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

724

transport_set_ptr.restype = None

725

726

bye = _library.gnutls_bye

727

bye.argtypes = [session_t, close_request_t]

728

bye.restype = _error_code

729

bye.errcheck = _retry_on_error

730

731

check_version = _library.gnutls_check_version

732

check_version.argtypes = [ctypes.c_char_p]

733

check_version.restype = ctypes.c_char_p

734

735

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

736

737

openpgp_crt_init = _library.gnutls_openpgp_crt_init

738

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

739

openpgp_crt_init.restype = _error_code

740

741

openpgp_crt_import = _library.gnutls_openpgp_crt_import

742

openpgp_crt_import.argtypes = [openpgp_crt_t,

743

ctypes.POINTER(datum_t),

744

openpgp_crt_fmt_t]

745

openpgp_crt_import.restype = _error_code

746

747

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

748

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

749

ctypes.POINTER(ctypes.c_uint)]

750

openpgp_crt_verify_self.restype = _error_code

751

752

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

753

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

754

openpgp_crt_deinit.restype = None

755

756

openpgp_crt_get_fingerprint = (

757

_library.gnutls_openpgp_crt_get_fingerprint)

758

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

759

ctypes.c_void_p,

760

ctypes.POINTER(

761

ctypes.c_size_t)]

762

openpgp_crt_get_fingerprint.restype = _error_code

763

764

# Remove non-public functions

765

del _error_code, _retry_on_error

766

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

767

gnutls = GnuTLS()

768

769

770

def call_pipe(connection, # : multiprocessing.Connection

771

func, *args, **kwargs):

772

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

773

774

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

775

return value on the provided multiprocessing.Connection.

776

"""

777

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

778

connection.close()

400

779

401

780

402

781

class Client(object):

403

782

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

404

783

405

784

Attributes:

406

785

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

407

786

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

409

788

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

410

789

to see if the client lives.

411

790

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

791

checker_callback_tag: a GLib event source tag, or None

413

792

checker_command: string; External command which is run to check

414

793

if client lives. %() expansions are done at

415

794

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

416

795

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

417

checker_initiator_tag: a gobject event source tag, or None

796

checker_initiator_tag: a GLib event source tag, or None

418

797

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

419

798

client_structure: Object describing what attributes a client has

420

799

and is used for storing the client at exit

421

800

current_checker_command: string; current running checker_command

422

disable_initiator_tag: a gobject event source tag, or None

801

disable_initiator_tag: a GLib event source tag, or None

423

802

enabled: bool()

424

803

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

425

804

uniquely identify the client

430

809

last_checker_status: integer between 0 and 255 reflecting exit

431

810

status of last checker. -1 reflects crashed

432

811

checker, -2 means no checker completed yet.

812

last_checker_signal: The signal which killed the last checker, if

813

last_checker_status is -1

433

814

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

434

815

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

435

816

D-Bus identifiers

440

821

runtime_expansions: Allowed attributes for runtime expansion.

441

822

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

442

823

disabled, or None

824

server_settings: The server_settings dict from main()

443

825

"""

444

826

445

827

runtime_expansions = ("approval_delay", "approval_duration",

446

828

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

447

829

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

448

830

"last_approval_request", "last_checked_ok",

449

831

"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

832

client_defaults = {

833

"timeout": "PT5M",

834

"extended_timeout": "PT15M",

835

"interval": "PT2M",

836

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

837

"host": "",

838

"approval_delay": "PT0S",

839

"approval_duration": "PT1S",

840

"approved_by_default": "True",

841

"enabled": "True",

842

}

843

476

844

@staticmethod

477

845

def config_parser(config):

478

846

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

485

853

for client_name in config.sections():

486

854

section = dict(config.items(client_name))

487

855

client = settings[client_name] = {}

488

856

489

857

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

490

858

# Reformat values from string types to Python types

491

859

client["approved_by_default"] = config.getboolean(

492

860

client_name, "approved_by_default")

493

861

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

494

862

"enabled")

495

863

864

# Uppercase and remove spaces from fingerprint for later

865

# comparison purposes with return value from the

866

# fingerprint() function

496

867

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

497

868

.replace(" ", ""))

498

869

if "secret" in section:

499

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

870

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

871

.encode("utf-8"),

872

"base64")

500

873

elif "secfile" in section:

501

874

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

502

875

(section["secfile"])),

503

876

"rb") as secfile:

504

877

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

505

878

else:

506

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

879

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

507

880

.format(section))

508

881

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

509

882

client["extended_timeout"] = string_to_delta(

517

890

client["last_approval_request"] = None

518

891

client["last_checked_ok"] = None

519

892

client["last_checker_status"] = -2

520

893

521

894

return settings

522

523

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

895

896

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

524

897

self.name = name

898

if server_settings is None:

899

server_settings = {}

900

self.server_settings = server_settings

525

901

# adding all client settings

526

for setting, value in settings.iteritems():

902

for setting, value in settings.items():

527

903

setattr(self, setting, value)

528

904

529

905

if self.enabled:

530

906

if not hasattr(self, "last_enabled"):

531

907

self.last_enabled = datetime.datetime.utcnow()

535

911

else:

536

912

self.last_enabled = None

537

913

self.expires = None

538

914

539

915

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

916

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

544

917

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

545

918

datetime.datetime.utcnow())

546

919

547

920

# attributes specific for this server instance

548

921

self.checker = None

549

922

self.checker_initiator_tag = None

552

925

self.current_checker_command = None

553

926

self.approved = None

554

927

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

928

self.changedstate = multiprocessing_manager.Condition(

929

multiprocessing_manager.Lock())

930

self.client_structure = [attr

931

for attr in self.__dict__.keys()

560

932

if not attr.startswith("_")]

561

933

self.client_structure.append("client_structure")

562

563

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

564

lambda obj:

565

isinstance(obj,

566

property)):

934

935

for name, t in inspect.getmembers(

936

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

567

937

if not name.startswith("_"):

568

938

self.client_structure.append(name)

569

939

570

940

# Send notice to process children that client state has changed

571

941

def send_changedstate(self):

572

942

with self.changedstate:

573

943

self.changedstate.notify_all()

574

944

575

945

def enable(self):

576

946

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

577

947

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

582

952

self.last_enabled = datetime.datetime.utcnow()

583

953

self.init_checker()

584

954

self.send_changedstate()

585

955

586

956

def disable(self, quiet=True):

587

957

"""Disable this client."""

588

958

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

590

960

if not quiet:

591

961

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

592

962

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

593

gobject.source_remove(self.disable_initiator_tag)

963

GLib.source_remove(self.disable_initiator_tag)

594

964

self.disable_initiator_tag = None

595

965

self.expires = None

596

966

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

597

gobject.source_remove(self.checker_initiator_tag)

967

GLib.source_remove(self.checker_initiator_tag)

598

968

self.checker_initiator_tag = None

599

969

self.stop_checker()

600

970

self.enabled = False

601

971

if not quiet:

602

972

self.send_changedstate()

603

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

973

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

604

974

return False

605

975

606

976

def __del__(self):

607

977

self.disable()

608

978

609

979

def init_checker(self):

610

980

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

611

981

# and every interval from then on.

612

982

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

983

GLib.source_remove(self.checker_initiator_tag)

984

self.checker_initiator_tag = GLib.timeout_add(

985

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

986

self.start_checker)

617

987

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

618

988

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

989

GLib.source_remove(self.disable_initiator_tag)

990

self.disable_initiator_tag = GLib.timeout_add(

991

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

623

992

# Also start a new checker *right now*.

624

993

self.start_checker()

625

626

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

994

995

def checker_callback(self, source, condition, connection,

996

command):

627

997

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

628

998

self.checker_callback_tag = None

629

999

self.checker = None

630

if os.WIFEXITED(condition):

631

self.last_checker_status = os.WEXITSTATUS(condition)

1000

# Read return code from connection (see call_pipe)

1001

returncode = connection.recv()

1002

connection.close()

1003

1004

if returncode >= 0:

1005

self.last_checker_status = returncode

1006

self.last_checker_signal = None

632

1007

if self.last_checker_status == 0:

633

1008

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

634

1009

vars(self))

635

1010

self.checked_ok()

636

1011

else:

637

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

638

vars(self))

1012

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

639

1013

else:

640

1014

self.last_checker_status = -1

1015

self.last_checker_signal = -returncode

641

1016

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

642

1017

vars(self))

643

1018

return False

1019

644

1020

def checked_ok(self):

645

1021

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

646

1022

self.last_checked_ok = datetime.datetime.utcnow()

647

1023

self.last_checker_status = 0

1024

self.last_checker_signal = None

648

1025

self.bump_timeout()

649

1026

650

1027

def bump_timeout(self, timeout=None):

651

1028

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

652

1029

if timeout is None:

653

1030

timeout = self.timeout

654

1031

if self.disable_initiator_tag is not None:

655

gobject.source_remove(self.disable_initiator_tag)

1032

GLib.source_remove(self.disable_initiator_tag)

656

1033

self.disable_initiator_tag = None

657

1034

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

658

self.disable_initiator_tag = (gobject.timeout_add

659

(timedelta_to_milliseconds

660

(timeout), self.disable))

1035

self.disable_initiator_tag = GLib.timeout_add(

1036

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

661

1037

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

662

1038

663

1039

def need_approval(self):

664

1040

self.last_approval_request = datetime.datetime.utcnow()

665

1041

666

1042

def start_checker(self):

667

1043

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

668

1044

669

1045

If a checker already exists, leave it running and do

670

1046

nothing."""

671

1047

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

676

1052

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

677

1053

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

678

1054

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

1055

1056

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

1057

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

1058

self.checker.join()

1059

self.checker = None

693

1060

# Start a new checker if needed

694

1061

if self.checker is None:

695

1062

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

1063

escaped_attrs = {

1064

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

1065

for attr in self.runtime_expansions}

700

1066

try:

701

1067

command = self.checker_command % escaped_attrs

702

1068

except TypeError as error:

703

1069

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

704

self.checker_command, exc_info=error)

705

return True # Try again later

1070

self.checker_command,

1071

exc_info=error)

1072

return True # Try again later

706

1073

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

1074

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

1075

self.name)

1076

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

1077

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

1078

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

1079

# always replaced by /dev/null.)

1080

# The exception is when not debugging but nevertheless

1081

# running in the foreground; use the previously

1082

# created wnull.

1083

popen_args = {"close_fds": True,

1084

"shell": True,

1085

"cwd": "/"}

1086

if (not self.server_settings["debug"]

1087

and self.server_settings["foreground"]):

1088

popen_args.update({"stdout": wnull,

1089

"stderr": wnull})

1090

pipe = multiprocessing.Pipe(duplex=False)

1091

self.checker = multiprocessing.Process(

1092

target=call_pipe,

1093

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

1094

kwargs=popen_args)

1095

self.checker.start()

1096

self.checker_callback_tag = GLib.io_add_watch(

1097

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

1098

self.checker_callback, pipe[0], command)

1099

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

731

1100

return True

732

1101

733

1102

def stop_checker(self):

734

1103

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

735

1104

if self.checker_callback_tag:

736

gobject.source_remove(self.checker_callback_tag)

1105

GLib.source_remove(self.checker_callback_tag)

737

1106

self.checker_callback_tag = None

738

1107

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

739

1108

return

740

1109

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

1110

self.checker.terminate()

749

1111

self.checker = None

750

1112

751

1113

752

def dbus_service_property(dbus_interface, signature="v",

753

access="readwrite", byte_arrays=False):

1114

def dbus_service_property(dbus_interface,

1115

signature="v",

1116

access="readwrite",

1117

byte_arrays=False):

754

1118

"""Decorators for marking methods of a DBusObjectWithProperties to

755

1119

become properties on the D-Bus.

756

1120

757

1121

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

758

1122

and with one argument by "Set".

759

1123

760

1124

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

761

1125

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

762

1126

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

765

1129

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

766

1130

if byte_arrays and signature != "ay":

767

1131

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

768

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

1132

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

1133

769

1134

def decorator(func):

770

1135

func._dbus_is_property = True

771

1136

func._dbus_interface = dbus_interface

774

1139

func._dbus_name = func.__name__

775

1140

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

776

1141

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

777

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1142

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

778

1143

return func

1144

779

1145

return decorator

780

1146

781

1147

782

1148

def dbus_interface_annotations(dbus_interface):

783

1149

"""Decorator for marking functions returning interface annotations

784

1150

785

1151

Usage:

786

1152

787

1153

@dbus_interface_annotations("org.example.Interface")

788

1154

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

789

1155

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

790

1156

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

791

1157

"false"}

792

1158

"""

1159

793

1160

def decorator(func):

794

1161

func._dbus_is_interface = True

795

1162

func._dbus_interface = dbus_interface

796

1163

func._dbus_name = dbus_interface

797

1164

return func

1165

798

1166

return decorator

799

1167

800

1168

801

1169

def dbus_annotations(annotations):

802

1170

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

803

1171

Usage:

804

1172

1173

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

1174

"org.freedesktop.DBus.Property."

1175

"EmitsChangedSignal": "false"})

805

1176

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

806

1177

access="r")

807

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

808

"org.freedesktop.DBus.Property."

809

"EmitsChangedSignal": "false"})

810

1178

def Property_dbus_property(self):

811

1179

return dbus.Boolean(False)

1180

1181

See also the DBusObjectWithAnnotations class.

812

1182

"""

1183

813

1184

def decorator(func):

814

1185

func._dbus_annotations = annotations

815

1186

return func

1187

816

1188

return decorator

817

1189

818

1190

819

1191

class DBusPropertyException(dbus.exceptions.DBusException):

820

1192

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

821

1193

"""

822

def __unicode__(self):

823

return unicode(str(self))

1194

pass

824

1195

825

1196

826

1197

class DBusPropertyAccessException(DBusPropertyException):

835

1206

pass

836

1207

837

1208

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.

1209

class DBusObjectWithAnnotations(dbus.service.Object):

1210

"""A D-Bus object with annotations.

1211

1212

Classes inheriting from this can use the dbus_annotations

1213

decorator to add annotations to methods or signals.

844

1214

"""

845

1215

846

1216

@staticmethod

847

1217

def _is_dbus_thing(thing):

848

1218

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

849

1219

850

1220

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

851

1221

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

852

1222

"""

853

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

1223

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

854

1224

False)

855

1225

856

1226

def _get_all_dbus_things(self, thing):

857

1227

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

858

1228

"""

859

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

860

name),

1229

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

861

1230

athing.__get__(self))

862

1231

for cls in self.__class__.__mro__

863

1232

for name, athing in

864

inspect.getmembers(cls,

865

self._is_dbus_thing(thing)))

866

1233

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

1234

1235

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1236

out_signature="s",

1237

path_keyword='object_path',

1238

connection_keyword='connection')

1239

def Introspect(self, object_path, connection):

1240

"""Overloading of standard D-Bus method.

1241

1242

Inserts annotation tags on methods and signals.

1243

"""

1244

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

1245

connection)

1246

try:

1247

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

1248

1249

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

1250

# Add annotation tags

1251

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

1252

for tag in if_tag.getElementsByTagName(typ):

1253

annots = dict()

1254

for name, prop in (self.

1255

_get_all_dbus_things(typ)):

1256

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

1257

and prop._dbus_interface

1258

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

1259

annots.update(getattr(

1260

prop, "_dbus_annotations", {}))

1261

for name, value in annots.items():

1262

ann_tag = document.createElement(

1263

"annotation")

1264

ann_tag.setAttribute("name", name)

1265

ann_tag.setAttribute("value", value)

1266

tag.appendChild(ann_tag)

1267

# Add interface annotation tags

1268

for annotation, value in dict(

1269

itertools.chain.from_iterable(

1270

annotations().items()

1271

for name, annotations

1272

in self._get_all_dbus_things("interface")

1273

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

1274

)).items():

1275

ann_tag = document.createElement("annotation")

1276

ann_tag.setAttribute("name", annotation)

1277

ann_tag.setAttribute("value", value)

1278

if_tag.appendChild(ann_tag)

1279

# Fix argument name for the Introspect method itself

1280

if (if_tag.getAttribute("name")

1281

== dbus.INTROSPECTABLE_IFACE):

1282

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

1283

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

1284

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

1285

if (arg.getAttribute("direction")

1286

== "out"):

1287

arg.setAttribute("name",

1288

"xml_data")

1289

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

1290

document.unlink()

1291

except (AttributeError, xml.dom.DOMException,

1292

xml.parsers.expat.ExpatError) as error:

1293

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

1294

exc_info=error)

1295

return xmlstring

1296

1297

1298

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1299

"""A D-Bus object with properties.

1300

1301

Classes inheriting from this can use the dbus_service_property

1302

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

1303

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

1304

"""

1305

867

1306

def _get_dbus_property(self, interface_name, property_name):

868

1307

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

869

1308

property with the specified name and interface.

870

1309

"""

871

for cls in self.__class__.__mro__:

872

for name, value in (inspect.getmembers

873

(cls,

874

self._is_dbus_thing("property"))):

1310

for cls in self.__class__.__mro__:

1311

for name, value in inspect.getmembers(

1312

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

875

1313

if (value._dbus_name == property_name

876

1314

and value._dbus_interface == interface_name):

877

1315

return value.__get__(self)

878

1316

879

1317

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

1318

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

1319

self.dbus_object_path, interface_name, property_name))

1320

1321

@classmethod

1322

def _get_all_interface_names(cls):

1323

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

1324

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

1325

"_dbus_interface", None)

1326

for x in (inspect.getmro(cls))

1327

for attr in dir(x))

1328

if name is not None)

1329

1330

@dbus.service.method(dbus.PROPERTIES_IFACE,

1331

in_signature="ss",

885

1332

out_signature="v")

886

1333

def Get(self, interface_name, property_name):

887

1334

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

893

1340

if not hasattr(value, "variant_level"):

894

1341

return value

895

1342

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

896

1343

897

1344

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

898

1345

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

899

1346

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

905

1352

# The byte_arrays option is not supported yet on

906

1353

# signatures other than "ay".

907

1354

if prop._dbus_signature != "ay":

908

raise ValueError

1355

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

1356

"'ay' signature {!r}"

1357

.format(prop._dbus_signature))

909

1358

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

910

1359

for byte in value))

911

1360

prop(value)

912

913

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

1361

1362

@dbus.service.method(dbus.PROPERTIES_IFACE,

1363

in_signature="s",

914

1364

out_signature="a{sv}")

915

1365

def GetAll(self, interface_name):

916

1366

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

917

1367

standard.

918

1368

919

1369

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

920

1370

"""

921

1371

properties = {}

931

1381

if not hasattr(value, "variant_level"):

932

1382

properties[name] = value

933

1383

continue

934

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

935

value.variant_level+1)

1384

properties[name] = type(value)(

1385

value, variant_level=value.variant_level + 1)

936

1386

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

937

1387

1388

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

1389

def PropertiesChanged(self, interface_name, changed_properties,

1390

invalidated_properties):

1391

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

1392

standard.

1393

"""

1394

pass

1395

938

1396

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

939

1397

out_signature="s",

940

1398

path_keyword='object_path',

941

1399

connection_keyword='connection')

942

1400

def Introspect(self, object_path, connection):

943

1401

"""Overloading of standard D-Bus method.

944

1402

945

1403

Inserts property tags and interface annotation tags.

946

1404

"""

947

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

948

connection)

1405

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1406

object_path,

1407

connection)

949

1408

try:

950

1409

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

1410

951

1411

def make_tag(document, name, prop):

952

1412

e = document.createElement("property")

953

1413

e.setAttribute("name", name)

954

1414

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

955

1415

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

956

1416

return e

1417

957

1418

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

958

1419

# Add property tags

959

1420

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

962

1423

if prop._dbus_interface

963

1424

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

964

1425

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)

1426

# Add annotation tags for properties

1427

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

1428

annots = dict()

1429

for name, prop in self._get_all_dbus_things(

1430

"property"):

1431

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

1432

and prop._dbus_interface

1433

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

1434

annots.update(getattr(

1435

prop, "_dbus_annotations", {}))

1436

for name, value in annots.items():

1437

ann_tag = document.createElement(

1438

"annotation")

1439

ann_tag.setAttribute("name", name)

1440

ann_tag.setAttribute("value", value)

1441

tag.appendChild(ann_tag)

996

1442

# Add the names to the return values for the

997

1443

# "org.freedesktop.DBus.Properties" methods

998

1444

if (if_tag.getAttribute("name")

1017

1463

return xmlstring

1018

1464

1019

1465

1466

try:

1467

dbus.OBJECT_MANAGER_IFACE

1468

except AttributeError:

1469

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

1470

1471

1472

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1473

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

1474

1475

Classes inheriting from this exposes the standard

1476

GetManagedObjects call and the InterfacesAdded and

1477

InterfacesRemoved signals on the standard

1478

"org.freedesktop.DBus.ObjectManager" interface.

1479

1480

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

1481

manually.

1482

"""

1483

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1484

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

1485

def GetManagedObjects(self):

1486

"""This function must be overridden"""

1487

raise NotImplementedError()

1488

1489

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1490

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

1491

def InterfacesAdded(self, object_path, interfaces_and_properties):

1492

pass

1493

1494

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

1495

def InterfacesRemoved(self, object_path, interfaces):

1496

pass

1497

1498

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1499

out_signature="s",

1500

path_keyword='object_path',

1501

connection_keyword='connection')

1502

def Introspect(self, object_path, connection):

1503

"""Overloading of standard D-Bus method.

1504

1505

Override return argument name of GetManagedObjects to be

1506

"objpath_interfaces_and_properties"

1507

"""

1508

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1509

object_path,

1510

connection)

1511

try:

1512

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

1513

1514

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

1515

# Fix argument name for the GetManagedObjects method

1516

if (if_tag.getAttribute("name")

1517

== dbus.OBJECT_MANAGER_IFACE):

1518

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

1519

if (cn.getAttribute("name")

1520

== "GetManagedObjects"):

1521

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

1522

if (arg.getAttribute("direction")

1523

== "out"):

1524

arg.setAttribute(

1525

"name",

1526

"objpath_interfaces"

1527

"_and_properties")

1528

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

1529

document.unlink()

1530

except (AttributeError, xml.dom.DOMException,

1531

xml.parsers.expat.ExpatError) as error:

1532

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

1533

exc_info=error)

1534

return xmlstring

1535

1536

1020

1537

def datetime_to_dbus(dt, variant_level=0):

1021

1538

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

1022

1539

if dt is None:

1023

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

1024

return dbus.String(dt.isoformat(),

1025

variant_level=variant_level)

1540

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

1541

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

1026

1542

1027

1543

1028

1544

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1030

1546

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

1031

1547

interface names according to the "alt_interface_names" mapping.

1032

1548

Usage:

1033

1549

1034

1550

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

1035

1551

"net.example.AlternateInterface"})

1036

1552

class SampleDBusObject(dbus.service.Object):

1037

1553

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

1038

1554

def SampleDBusMethod():

1039

1555

pass

1040

1556

1041

1557

The above "SampleDBusMethod" on "SampleDBusObject" will be

1042

1558

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

1043

1559

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

1044

1560

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

1045

1561

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

1046

1562

1047

1563

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

1048

1564

(from DBusObjectWithProperties) and interfaces (from the

1049

1565

dbus_interface_annotations decorator).

1050

1566

"""

1567

1051

1568

def wrapper(cls):

1052

1569

for orig_interface_name, alt_interface_name in (

1053

alt_interface_names.iteritems()):

1570

alt_interface_names.items()):

1054

1571

attr = {}

1055

1572

interface_names = set()

1056

1573

# Go though all attributes of the class

1058

1575

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

1059

1576

# with the wrong interface name

1060

1577

if (not hasattr(attribute, "_dbus_interface")

1061

or not attribute._dbus_interface

1062

.startswith(orig_interface_name)):

1578

or not attribute._dbus_interface.startswith(

1579

orig_interface_name)):

1063

1580

continue

1064

1581

# Create an alternate D-Bus interface name based on

1065

1582

# the current name

1066

alt_interface = (attribute._dbus_interface

1067

.replace(orig_interface_name,

1068

alt_interface_name))

1583

alt_interface = attribute._dbus_interface.replace(

1584

orig_interface_name, alt_interface_name)

1069

1585

interface_names.add(alt_interface)

1070

1586

# Is this a D-Bus signal?

1071

1587

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

1072

# Extract the original non-method function by

1073

# black magic

1074

nonmethod_func = (dict(

1588

# Extract the original non-method undecorated

1589

# function by black magic

1590

if sys.version_info.major == 2:

1591

nonmethod_func = (dict(

1075

1592

zip(attribute.func_code.co_freevars,

1076

attribute.__closure__))["func"]

1077

.cell_contents)

1593

attribute.__closure__))

1594

["func"].cell_contents)

1595

else:

1596

nonmethod_func = (dict(

1597

zip(attribute.__code__.co_freevars,

1598

attribute.__closure__))

1599

["func"].cell_contents)

1078

1600

# Create a new, but exactly alike, function

1079

1601

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

1080

1602

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

1603

new_function = copy_function(nonmethod_func)

1604

new_function = (dbus.service.signal(

1605

alt_interface,

1606

attribute._dbus_signature)(new_function))

1090

1607

# Copy annotations, if any

1091

1608

try:

1092

new_function._dbus_annotations = (

1093

dict(attribute._dbus_annotations))

1609

new_function._dbus_annotations = dict(

1610

attribute._dbus_annotations)

1094

1611

except AttributeError:

1095

1612

pass

1613

1096

1614

# Define a creator of a function to call both the

1097

1615

# original and alternate functions, so both the

1098

1616

# original and alternate signals gets sent when

1101

1619

"""This function is a scope container to pass

1102

1620

func1 and func2 to the "call_both" function

1103

1621

outside of its arguments"""

1622

1623

@functools.wraps(func2)

1104

1624

def call_both(*args, **kwargs):

1105

1625

"""This function will emit two D-Bus

1106

1626

signals by calling func1 and func2"""

1107

1627

func1(*args, **kwargs)

1108

1628

func2(*args, **kwargs)

1629

# Make wrapper function look like a D-Bus

1630

# signal

1631

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

1632

if name.startswith("_dbus_"):

1633

setattr(call_both, name, attr)

1634

1109

1635

return call_both

1110

1636

# Create the "call_both" function and add it to

1111

1637

# the class

1116

1642

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

1117

1643

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

1118

1644

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

1645

attr[attrname] = (

1646

dbus.service.method(

1647

alt_interface,

1648

attribute._dbus_in_signature,

1649

attribute._dbus_out_signature)

1650

(copy_function(attribute)))

1129

1651

# Copy annotations, if any

1130

1652

try:

1131

attr[attrname]._dbus_annotations = (

1132

dict(attribute._dbus_annotations))

1653

attr[attrname]._dbus_annotations = dict(

1654

attribute._dbus_annotations)

1133

1655

except AttributeError:

1134

1656

pass

1135

1657

# Is this a D-Bus property?

1138

1660

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

1139

1661

# property with the alternate D-Bus interface

1140

1662

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

1663

attr[attrname] = (dbus_service_property(

1664

alt_interface, attribute._dbus_signature,

1665

attribute._dbus_access,

1666

attribute._dbus_get_args_options

1667

["byte_arrays"])

1668

(copy_function(attribute)))

1154

1669

# Copy annotations, if any

1155

1670

try:

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1671

attr[attrname]._dbus_annotations = dict(

1672

attribute._dbus_annotations)

1158

1673

except AttributeError:

1159

1674

pass

1160

1675

# Is this a D-Bus interface?

1163

1678

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

1164

1679

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

1165

1680

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

1681

attr[attrname] = (

1682

dbus_interface_annotations(alt_interface)

1683

(copy_function(attribute)))

1174

1684

if deprecate:

1175

1685

# Deprecate all alternate interfaces

1176

iname="_AlternateDBusNames_interface_annotation{0}"

1686

iname = "_AlternateDBusNames_interface_annotation{}"

1177

1687

for interface_name in interface_names:

1688

1178

1689

@dbus_interface_annotations(interface_name)

1179

1690

def func(self):

1180

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

1181

"true" }

1691

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

1692

"true"}

1182

1693

# Find an unused name

1183

1694

for aname in (iname.format(i)

1184

1695

for i in itertools.count()):

1188

1699

if interface_names:

1189

1700

# Replace the class with a new subclass of it with

1190

1701

# methods, signals, etc. as created above.

1191

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

1192

(cls,), attr)

1702

if sys.version_info.major == 2:

1703

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

1704

(cls, ), attr)

1705

else:

1706

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

1707

(cls, ), attr)

1193

1708

return cls

1709

1194

1710

return wrapper

1195

1711

1196

1712

1197

1713

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

1198

"se.bsnet.fukt.Mandos"})

1714

"se.bsnet.fukt.Mandos"})

1199

1715

class ClientDBus(Client, DBusObjectWithProperties):

1200

1716

"""A Client class using D-Bus

1201

1717

1202

1718

Attributes:

1203

1719

dbus_object_path: dbus.ObjectPath

1204

1720

bus: dbus.SystemBus()

1205

1721

"""

1206

1722

1207

1723

runtime_expansions = (Client.runtime_expansions

1208

+ ("dbus_object_path",))

1209

1724

+ ("dbus_object_path", ))

1725

1726

_interface = "se.recompile.Mandos.Client"

1727

1210

1728

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

1211

1212

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

1729

1730

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

1213

1731

self.bus = bus

1214

1732

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

1215

1733

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

1216

1734

# the D-Bus

1217

client_object_name = unicode(self.name).translate(

1735

client_object_name = str(self.name).translate(

1218

1736

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

1219

1737

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

1220

self.dbus_object_path = (dbus.ObjectPath

1221

("/clients/" + client_object_name))

1738

self.dbus_object_path = dbus.ObjectPath(

1739

"/clients/" + client_object_name)

1222

1740

DBusObjectWithProperties.__init__(self, self.bus,

1223

1741

self.dbus_object_path)

1224

1225

def notifychangeproperty(transform_func,

1226

dbus_name, type_func=lambda x: x,

1227

variant_level=1):

1742

1743

def notifychangeproperty(transform_func, dbus_name,

1744

type_func=lambda x: x,

1745

variant_level=1,

1746

invalidate_only=False,

1747

_interface=_interface):

1228

1748

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

1229

1749

its changes to DBus.

1230

1750

1231

1751

transform_fun: Function that takes a value and a variant_level

1232

1752

and transforms it to a D-Bus type.

1233

1753

dbus_name: D-Bus name of the variable

1235

1755

to the D-Bus. Default: no transform

1236

1756

variant_level: D-Bus variant level. Default: 1

1237

1757

"""

1238

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

1758

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

1759

1239

1760

def setter(self, value):

1240

1761

if hasattr(self, "dbus_object_path"):

1241

1762

if (not hasattr(self, attrname) or

1242

1763

type_func(getattr(self, attrname, None))

1243

1764

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

1765

if invalidate_only:

1766

self.PropertiesChanged(

1767

_interface, dbus.Dictionary(),

1768

dbus.Array((dbus_name, )))

1769

else:

1770

dbus_value = transform_func(

1771

type_func(value),

1772

variant_level=variant_level)

1773

self.PropertyChanged(dbus.String(dbus_name),

1774

dbus_value)

1775

self.PropertiesChanged(

1776

_interface,

1777

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

1778

dbus_value}),

1779

dbus.Array())

1249

1780

setattr(self, attrname, value)

1250

1781

1251

1782

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

1252

1783

1253

1784

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1254

1785

approvals_pending = notifychangeproperty(dbus.Boolean,

1255

1786

"ApprovalPending",

1256

type_func = bool)

1787

type_func=bool)

1257

1788

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

1258

1789

last_enabled = notifychangeproperty(datetime_to_dbus,

1259

1790

"LastEnabled")

1260

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

1261

type_func = lambda checker:

1262

checker is not None)

1791

checker = notifychangeproperty(

1792

dbus.Boolean, "CheckerRunning",

1793

type_func=lambda checker: checker is not None)

1263

1794

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1264

1795

"LastCheckedOK")

1265

1796

last_checker_status = notifychangeproperty(dbus.Int16,

1268

1799

datetime_to_dbus, "LastApprovalRequest")

1269

1800

approved_by_default = notifychangeproperty(dbus.Boolean,

1270

1801

"ApprovedByDefault")

1271

approval_delay = notifychangeproperty(dbus.UInt64,

1272

"ApprovalDelay",

1273

type_func =

1274

timedelta_to_milliseconds)

1802

approval_delay = notifychangeproperty(

1803

dbus.UInt64, "ApprovalDelay",

1804

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

1275

1805

approval_duration = notifychangeproperty(

1276

1806

dbus.UInt64, "ApprovalDuration",

1277

type_func = timedelta_to_milliseconds)

1807

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

1278

1808

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

1279

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

1280

type_func =

1281

timedelta_to_milliseconds)

1809

timeout = notifychangeproperty(

1810

dbus.UInt64, "Timeout",

1811

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

1282

1812

extended_timeout = notifychangeproperty(

1283

1813

dbus.UInt64, "ExtendedTimeout",

1284

type_func = timedelta_to_milliseconds)

1285

interval = notifychangeproperty(dbus.UInt64,

1286

"Interval",

1287

type_func =

1288

timedelta_to_milliseconds)

1814

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

1815

interval = notifychangeproperty(

1816

dbus.UInt64, "Interval",

1817

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

1289

1818

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

1290

1819

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

1820

invalidate_only=True)

1821

1291

1822

del notifychangeproperty

1292

1823

1293

1824

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

1294

1825

try:

1295

1826

self.remove_from_connection()

1298

1829

if hasattr(DBusObjectWithProperties, "__del__"):

1299

1830

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

1300

1831

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)

1832

1833

def checker_callback(self, source, condition,

1834

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

1835

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

1836

connection, command, *args,

1837

**kwargs)

1838

exitstatus = self.last_checker_status

1839

if exitstatus >= 0:

1308

1840

# Emit D-Bus signal

1309

1841

self.CheckerCompleted(dbus.Int16(exitstatus),

1310

dbus.Int64(condition),

1842

# This is specific to GNU libC

1843

dbus.Int64(exitstatus << 8),

1311

1844

dbus.String(command))

1312

1845

else:

1313

1846

# Emit D-Bus signal

1314

1847

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

1315

dbus.Int64(condition),

1848

dbus.Int64(

1849

# This is specific to GNU libC

1850

(exitstatus << 8)

1851

| self.last_checker_signal),

1316

1852

dbus.String(command))

1317

1318

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

1319

*args, **kwargs)

1320

1853

return ret

1854

1321

1855

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

1856

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

1327

1857

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

1328

1858

# Only if new checker process was started

1329

1859

if (self.checker is not None

1331

1861

# Emit D-Bus signal

1332

1862

self.CheckerStarted(self.current_checker_command)

1333

1863

return r

1334

1864

1335

1865

def _reset_approved(self):

1336

1866

self.approved = None

1337

1867

return False

1338

1868

1339

1869

def approve(self, value=True):

1340

1870

self.approved = value

1341

gobject.timeout_add(timedelta_to_milliseconds

1342

(self.approval_duration),

1343

self._reset_approved)

1871

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

1872

* 1000), self._reset_approved)

1344

1873

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

1874

1875

# D-Bus methods, signals & properties

1876

1877

# Interfaces

1878

1879

# Signals

1880

1358

1881

# CheckerCompleted - signal

1359

1882

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

1360

1883

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

1361

1884

"D-Bus signal"

1362

1885

pass

1363

1886

1364

1887

# CheckerStarted - signal

1365

1888

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

1366

1889

def CheckerStarted(self, command):

1367

1890

"D-Bus signal"

1368

1891

pass

1369

1892

1370

1893

# PropertyChanged - signal

1894

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

1371

1895

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

1372

1896

def PropertyChanged(self, property, value):

1373

1897

"D-Bus signal"

1374

1898

pass

1375

1899

1376

1900

# GotSecret - signal

1377

1901

@dbus.service.signal(_interface)

1378

1902

def GotSecret(self):

1381

1905

server to mandos-client

1382

1906

"""

1383

1907

pass

1384

1908

1385

1909

# Rejected - signal

1386

1910

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

1387

1911

def Rejected(self, reason):

1388

1912

"D-Bus signal"

1389

1913

pass

1390

1914

1391

1915

# NeedApproval - signal

1392

1916

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

1393

1917

def NeedApproval(self, timeout, default):

1394

1918

"D-Bus signal"

1395

1919

return self.need_approval()

1396

1397

## Methods

1398

1920

1921

# Methods

1922

1399

1923

# Approve - method

1400

1924

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

1401

1925

def Approve(self, value):

1402

1926

self.approve(value)

1403

1927

1404

1928

# CheckedOK - method

1405

1929

@dbus.service.method(_interface)

1406

1930

def CheckedOK(self):

1407

1931

self.checked_ok()

1408

1932

1409

1933

# Enable - method

1934

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

1410

1935

@dbus.service.method(_interface)

1411

1936

def Enable(self):

1412

1937

"D-Bus method"

1413

1938

self.enable()

1414

1939

1415

1940

# StartChecker - method

1941

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

1416

1942

@dbus.service.method(_interface)

1417

1943

def StartChecker(self):

1418

1944

"D-Bus method"

1419

1945

self.start_checker()

1420

1946

1421

1947

# Disable - method

1948

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

1422

1949

@dbus.service.method(_interface)

1423

1950

def Disable(self):

1424

1951

"D-Bus method"

1425

1952

self.disable()

1426

1953

1427

1954

# StopChecker - method

1955

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

1428

1956

@dbus.service.method(_interface)

1429

1957

def StopChecker(self):

1430

1958

self.stop_checker()

1431

1432

## Properties

1433

1959

1960

# Properties

1961

1434

1962

# ApprovalPending - property

1435

1963

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

1436

1964

def ApprovalPending_dbus_property(self):

1437

1965

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

1438

1966

1439

1967

# ApprovedByDefault - property

1440

@dbus_service_property(_interface, signature="b",

1968

@dbus_service_property(_interface,

1969

signature="b",

1441

1970

access="readwrite")

1442

1971

def ApprovedByDefault_dbus_property(self, value=None):

1443

1972

if value is None: # get

1444

1973

return dbus.Boolean(self.approved_by_default)

1445

1974

self.approved_by_default = bool(value)

1446

1975

1447

1976

# ApprovalDelay - property

1448

@dbus_service_property(_interface, signature="t",

1977

@dbus_service_property(_interface,

1978

signature="t",

1449

1979

access="readwrite")

1450

1980

def ApprovalDelay_dbus_property(self, value=None):

1451

1981

if value is None: # get

1452

return dbus.UInt64(self.approval_delay_milliseconds())

1982

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

1983

* 1000)

1453

1984

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

1454

1985

1455

1986

# ApprovalDuration - property

1456

@dbus_service_property(_interface, signature="t",

1987

@dbus_service_property(_interface,

1988

signature="t",

1457

1989

access="readwrite")

1458

1990

def ApprovalDuration_dbus_property(self, value=None):

1459

1991

if value is None: # get

1460

return dbus.UInt64(timedelta_to_milliseconds(

1461

self.approval_duration))

1992

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

1993

* 1000)

1462

1994

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

1463

1995

1464

1996

# Name - property

1997

@dbus_annotations(

1998

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

1465

1999

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

1466

2000

def Name_dbus_property(self):

1467

2001

return dbus.String(self.name)

1468

2002

1469

2003

# Fingerprint - property

2004

@dbus_annotations(

2005

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

1470

2006

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

1471

2007

def Fingerprint_dbus_property(self):

1472

2008

return dbus.String(self.fingerprint)

1473

2009

1474

2010

# Host - property

1475

@dbus_service_property(_interface, signature="s",

2011

@dbus_service_property(_interface,

2012

signature="s",

1476

2013

access="readwrite")

1477

2014

def Host_dbus_property(self, value=None):

1478

2015

if value is None: # get

1479

2016

return dbus.String(self.host)

1480

self.host = unicode(value)

1481

2017

self.host = str(value)

2018

1482

2019

# Created - property

2020

@dbus_annotations(

2021

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

1483

2022

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

1484

2023

def Created_dbus_property(self):

1485

2024

return datetime_to_dbus(self.created)

1486

2025

1487

2026

# LastEnabled - property

1488

2027

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

1489

2028

def LastEnabled_dbus_property(self):

1490

2029

return datetime_to_dbus(self.last_enabled)

1491

2030

1492

2031

# Enabled - property

1493

@dbus_service_property(_interface, signature="b",

2032

@dbus_service_property(_interface,

2033

signature="b",

1494

2034

access="readwrite")

1495

2035

def Enabled_dbus_property(self, value=None):

1496

2036

if value is None: # get

1499

2039

self.enable()

1500

2040

else:

1501

2041

self.disable()

1502

2042

1503

2043

# LastCheckedOK - property

1504

@dbus_service_property(_interface, signature="s",

2044

@dbus_service_property(_interface,

2045

signature="s",

1505

2046

access="readwrite")

1506

2047

def LastCheckedOK_dbus_property(self, value=None):

1507

2048

if value is not None:

1508

2049

self.checked_ok()

1509

2050

return

1510

2051

return datetime_to_dbus(self.last_checked_ok)

1511

2052

1512

2053

# LastCheckerStatus - property

1513

@dbus_service_property(_interface, signature="n",

1514

access="read")

2054

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

1515

2055

def LastCheckerStatus_dbus_property(self):

1516

2056

return dbus.Int16(self.last_checker_status)

1517

2057

1518

2058

# Expires - property

1519

2059

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

1520

2060

def Expires_dbus_property(self):

1521

2061

return datetime_to_dbus(self.expires)

1522

2062

1523

2063

# LastApprovalRequest - property

1524

2064

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

1525

2065

def LastApprovalRequest_dbus_property(self):

1526

2066

return datetime_to_dbus(self.last_approval_request)

1527

2067

1528

2068

# Timeout - property

1529

@dbus_service_property(_interface, signature="t",

2069

@dbus_service_property(_interface,

2070

signature="t",

1530

2071

access="readwrite")

1531

2072

def Timeout_dbus_property(self, value=None):

1532

2073

if value is None: # get

1533

return dbus.UInt64(self.timeout_milliseconds())

2074

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

1534

2075

old_timeout = self.timeout

1535

2076

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

1536

2077

# Reschedule disabling

1544

2085

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

1545

2086

is None):

1546

2087

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

2088

GLib.source_remove(self.disable_initiator_tag)

2089

self.disable_initiator_tag = GLib.timeout_add(

2090

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

2091

self.disable)

2092

1553

2093

# ExtendedTimeout - property

1554

@dbus_service_property(_interface, signature="t",

2094

@dbus_service_property(_interface,

2095

signature="t",

1555

2096

access="readwrite")

1556

2097

def ExtendedTimeout_dbus_property(self, value=None):

1557

2098

if value is None: # get

1558

return dbus.UInt64(self.extended_timeout_milliseconds())

2099

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

2100

* 1000)

1559

2101

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

1560

2102

1561

2103

# Interval - property

1562

@dbus_service_property(_interface, signature="t",

2104

@dbus_service_property(_interface,

2105

signature="t",

1563

2106

access="readwrite")

1564

2107

def Interval_dbus_property(self, value=None):

1565

2108

if value is None: # get

1566

return dbus.UInt64(self.interval_milliseconds())

2109

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

1567

2110

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

1568

2111

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

1569

2112

return

1570

2113

if self.enabled:

1571

2114

# 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

2115

GLib.source_remove(self.checker_initiator_tag)

2116

self.checker_initiator_tag = GLib.timeout_add(

2117

value, self.start_checker)

2118

self.start_checker() # Start one now, too

2119

1577

2120

# Checker - property

1578

@dbus_service_property(_interface, signature="s",

2121

@dbus_service_property(_interface,

2122

signature="s",

1579

2123

access="readwrite")

1580

2124

def Checker_dbus_property(self, value=None):

1581

2125

if value is None: # get

1582

2126

return dbus.String(self.checker_command)

1583

self.checker_command = unicode(value)

1584

2127

self.checker_command = str(value)

2128

1585

2129

# CheckerRunning - property

1586

@dbus_service_property(_interface, signature="b",

2130

@dbus_service_property(_interface,

2131

signature="b",

1587

2132

access="readwrite")

1588

2133

def CheckerRunning_dbus_property(self, value=None):

1589

2134

if value is None: # get

1592

2137

self.start_checker()

1593

2138

else:

1594

2139

self.stop_checker()

1595

2140

1596

2141

# ObjectPath - property

2142

@dbus_annotations(

2143

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

2144

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

1597

2145

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

1598

2146

def ObjectPath_dbus_property(self):

1599

return self.dbus_object_path # is already a dbus.ObjectPath

1600

2147

return self.dbus_object_path # is already a dbus.ObjectPath

2148

1601

2149

# Secret = property

1602

@dbus_service_property(_interface, signature="ay",

1603

access="write", byte_arrays=True)

2150

@dbus_annotations(

2151

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

2152

"invalidates"})

2153

@dbus_service_property(_interface,

2154

signature="ay",

2155

access="write",

2156

byte_arrays=True)

1604

2157

def Secret_dbus_property(self, value):

1605

self.secret = str(value)

1606

2158

self.secret = bytes(value)

2159

1607

2160

del _interface

1608

2161

1609

2162

1612

2165

self._pipe = child_pipe

1613

2166

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

1614

2167

if not self._pipe.recv():

1615

raise KeyError()

1616

2168

raise KeyError(fpr)

2169

1617

2170

def __getattribute__(self, name):

1618

2171

if name == '_pipe':

1619

2172

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

1622

2175

if data[0] == 'data':

1623

2176

return data[1]

1624

2177

if data[0] == 'function':

2178

1625

2179

def func(*args, **kwargs):

1626

2180

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

1627

2181

return self._pipe.recv()[1]

2182

1628

2183

return func

1629

2184

1630

2185

def __setattr__(self, name, value):

1631

2186

if name == '_pipe':

1632

2187

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

1635

2190

1636

2191

class ClientHandler(socketserver.BaseRequestHandler, object):

1637

2192

"""A class to handle client connections.

1638

2193

1639

2194

Instantiated once for each connection to handle it.

1640

2195

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

1641

2196

1642

2197

def handle(self):

1643

2198

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

1644

2199

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

1645

unicode(self.client_address))

2200

str(self.client_address))

1646

2201

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

1647

2202

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

2203

2204

session = gnutls.ClientSession(self.request)

2205

2206

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

2207

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

2208

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

2209

# "+DHE-DSS"))

1663

2210

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

1664

2211

priority = self.server.gnutls_priority

1665

2212

if priority is None:

1666

2213

priority = "NORMAL"

1667

(gnutls.library.functions

1668

.gnutls_priority_set_direct(session._c_object,

1669

priority, None))

1670

2214

gnutls.priority_set_direct(session._c_object,

2215

priority.encode("utf-8"),

2216

None)

2217

1671

2218

# Start communication using the Mandos protocol

1672

2219

# Get protocol number

1673

2220

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

1674

2221

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

1675

2222

try:

1676

2223

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

1677

raise RuntimeError

2224

raise RuntimeError(line)

1678

2225

except (ValueError, IndexError, RuntimeError) as error:

1679

2226

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

1680

2227

return

1681

2228

1682

2229

# Start GnuTLS connection

1683

2230

try:

1684

2231

session.handshake()

1685

except gnutls.errors.GNUTLSError as error:

2232

except gnutls.Error as error:

1686

2233

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

1687

2234

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

1688

2235

# established. Just abandon the request.

1689

2236

return

1690

2237

logger.debug("Handshake succeeded")

1691

2238

1692

2239

approval_required = False

1693

2240

try:

1694

2241

try:

1695

fpr = self.fingerprint(self.peer_certificate

1696

(session))

1697

except (TypeError,

1698

gnutls.errors.GNUTLSError) as error:

2242

fpr = self.fingerprint(

2243

self.peer_certificate(session))

2244

except (TypeError, gnutls.Error) as error:

1699

2245

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

1700

2246

return

1701

2247

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

1702

2248

1703

2249

try:

1704

2250

client = ProxyClient(child_pipe, fpr,

1705

2251

self.client_address)

1706

2252

except KeyError:

1707

2253

return

1708

2254

1709

2255

if client.approval_delay:

1710

2256

delay = client.approval_delay

1711

2257

client.approvals_pending += 1

1712

2258

approval_required = True

1713

2259

1714

2260

while True:

1715

2261

if not client.enabled:

1716

2262

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

1717

client.name)

2263

client.name)

1718

2264

if self.server.use_dbus:

1719

2265

# Emit D-Bus signal

1720

2266

client.Rejected("Disabled")

1721

2267

return

1722

2268

1723

2269

if client.approved or not client.approval_delay:

1724

#We are approved or approval is disabled

2270

# We are approved or approval is disabled

1725

2271

break

1726

2272

elif client.approved is None:

1727

2273

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

1729

2275

if self.server.use_dbus:

1730

2276

# Emit D-Bus signal

1731

2277

client.NeedApproval(

1732

client.approval_delay_milliseconds(),

1733

client.approved_by_default)

2278

client.approval_delay.total_seconds()

2279

* 1000, client.approved_by_default)

1734

2280

else:

1735

2281

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

1736

2282

client.name)

1738

2284

# Emit D-Bus signal

1739

2285

client.Rejected("Denied")

1740

2286

return

1741

1742

#wait until timeout or approved

2287

2288

# wait until timeout or approved

1743

2289

time = datetime.datetime.now()

1744

2290

client.changedstate.acquire()

1745

client.changedstate.wait(

1746

float(timedelta_to_milliseconds(delay)

1747

/ 1000))

2291

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

1748

2292

client.changedstate.release()

1749

2293

time2 = datetime.datetime.now()

1750

2294

if (time2 - time) >= delay:

1760

2304

break

1761

2305

else:

1762

2306

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

2307

2308

try:

2309

session.send(client.secret)

2310

except gnutls.Error as error:

2311

logger.warning("gnutls send failed",

2312

exc_info=error)

2313

return

2314

1777

2315

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

1778

2316

# bump the timeout using extended_timeout

1779

2317

client.bump_timeout(client.extended_timeout)

1780

2318

if self.server.use_dbus:

1781

2319

# Emit D-Bus signal

1782

2320

client.GotSecret()

1783

2321

1784

2322

finally:

1785

2323

if approval_required:

1786

2324

client.approvals_pending -= 1

1787

2325

try:

1788

2326

session.bye()

1789

except gnutls.errors.GNUTLSError as error:

2327

except gnutls.Error as error:

1790

2328

logger.warning("GnuTLS bye failed",

1791

2329

exc_info=error)

1792

2330

1793

2331

@staticmethod

1794

2332

def peer_certificate(session):

1795

2333

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

1796

2334

# 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

2335

if (gnutls.certificate_type_get(session._c_object)

2336

!= gnutls.CRT_OPENPGP):

2337

# ...return invalid data

2338

return b""

1802

2339

list_size = ctypes.c_uint(1)

1803

cert_list = (gnutls.library.functions

1804

.gnutls_certificate_get_peers

2340

cert_list = (gnutls.certificate_get_peers

1805

2341

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

1806

2342

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

1807

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

1808

" certificate")

2343

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

1809

2344

if list_size.value == 0:

1810

2345

return None

1811

2346

cert = cert_list[0]

1812

2347

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

1813

2348

1814

2349

@staticmethod

1815

2350

def fingerprint(openpgp):

1816

2351

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1817

2352

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

2353

datum = gnutls.datum_t(

2354

ctypes.cast(ctypes.c_char_p(openpgp),

2355

ctypes.POINTER(ctypes.c_ubyte)),

2356

ctypes.c_uint(len(openpgp)))

1823

2357

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

2358

crt = gnutls.openpgp_crt_t()

2359

gnutls.openpgp_crt_init(ctypes.byref(crt))

1827

2360

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

2361

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

2362

gnutls.OPENPGP_FMT_RAW)

1832

2363

# Verify the self signature in the key

1833

2364

crtverify = ctypes.c_uint()

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_verify_self(crt, 0,

1836

ctypes.byref(crtverify)))

2365

gnutls.openpgp_crt_verify_self(crt, 0,

2366

ctypes.byref(crtverify))

1837

2367

if crtverify.value != 0:

1838

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1839

raise (gnutls.errors.CertificateSecurityError

1840

("Verify failed"))

2368

gnutls.openpgp_crt_deinit(crt)

2369

raise gnutls.CertificateSecurityError("Verify failed")

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