/mandos/release : revision 237.7.154

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

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

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

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

import collections

79

import codecs

80

71

81

72

import dbus

82

73

import dbus.service

83

from gi.repository import GLib

74

import gobject

75

import avahi

84

76

from dbus.mainloop.glib import DBusGMainLoop

85

77

import ctypes

86

78

import ctypes.util

87

79

import xml.dom.minidom

88

80

import inspect

81

import GnuPGInterface

89

82

90

# Try to find the value of SO_BINDTODEVICE:

91

83

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:

94

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

95

85

except AttributeError:

96

86

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

99

87

from IN import SO_BINDTODEVICE

100

88

except ImportError:

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

89

SO_BINDTODEVICE = None

90

91

version = "1.5.5"

119

92

stored_state_file = "clients.pickle"

120

93

121

94

logger = logging.getLogger()

122

syslogger = None

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

123

98

124

99

try:

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

127

103

except (OSError, AttributeError):

128

129

104

def if_nametoindex(interface):

130

105

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

131

106

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

132

107

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

133

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

134

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

135

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

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

136

113

return interface_index

137

114

138

115

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

155

116

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

156

117

"""init logger and add loglevel"""

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

118

162

119

syslogger.setFormatter(logging.Formatter

163

120

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

164

121

' %(message)s'))

165

122

logger.addHandler(syslogger)

166

123

167

124

if debug:

168

125

console = logging.StreamHandler()

169

126

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

181

138

182

139

class PGPEngine(object):

183

140

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

184

185

141

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

186

143

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

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

144

self.gnupg = GnuPGInterface.GnuPG()

145

self.gnupg.options.meta_interactive = False

146

self.gnupg.options.homedir = self.tempdir

147

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

148

'--quiet',

149

'--no-use-agent'])

150

206

151

def __enter__(self):

207

152

return self

208

153

209

154

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

210

155

self._cleanup()

211

156

return False

212

157

213

158

def __del__(self):

214

159

self._cleanup()

215

160

216

161

def _cleanup(self):

217

162

if self.tempdir is not None:

218

163

# Delete contents of tempdir

219

164

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

220

topdown=False):

165

topdown = False):

221

166

for filename in files:

222

167

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

223

168

for dirname in dirs:

225

170

# Remove tempdir

226

171

os.rmdir(self.tempdir)

227

172

self.tempdir = None

228

173

229

174

def password_encode(self, password):

230

175

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

231

176

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

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

177

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

178

240

179

def encrypt(self, data, password):

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)

180

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

181

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

182

try:

183

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

184

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

185

attach_fhs={'stderr': devnull})

186

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

187

f.write(data)

188

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

189

ciphertext = f.read()

190

proc.wait()

191

except IOError as e:

192

raise PGPError(e)

193

self.gnupg.passphrase = None

256

194

return ciphertext

257

195

258

196

def decrypt(self, data, password):

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)

197

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

198

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

199

try:

200

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

201

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

202

attach_fhs={'stderr': devnull})

203

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

204

f.write(data)

205

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

206

decrypted_plaintext = f.read()

207

proc.wait()

208

except IOError as e:

209

raise PGPError(e)

210

self.gnupg.passphrase = None

274

211

return decrypted_plaintext

275

212

276

213

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

304

214

class AvahiError(Exception):

305

215

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

306

216

self.value = value

307

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

308

**kwargs)

309

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

310

220

311

221

class AvahiServiceError(AvahiError):

312

222

pass

313

223

314

315

224

class AvahiGroupError(AvahiError):

316

225

pass

317

226

318

227

319

228

class AvahiService(object):

320

229

"""An Avahi (Zeroconf) service.

321

230

322

231

Attributes:

323

232

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

324

233

Used to optionally bind to the specified interface.

325

234

name: string; Example: 'Mandos'

326

235

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

327

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

236

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

328

237

port: integer; what port to announce

329

238

TXT: list of strings; TXT record for the service

330

239

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

336

245

server: D-Bus Server

337

246

bus: dbus.SystemBus()

338

247

"""

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

248

249

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

250

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

251

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

252

protocol = avahi.PROTO_UNSPEC, bus = None):

351

253

self.interface = interface

352

254

self.name = name

353

255

self.type = servicetype

362

264

self.server = None

363

265

self.bus = bus

364

266

self.entry_group_state_changed_match = None

365

366

def rename(self, remove=True):

267

268

def rename(self):

367

269

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

368

270

if self.rename_count >= self.max_renames:

369

271

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

370

272

" after %i retries, exiting.",

371

273

self.rename_count)

372

274

raise AvahiServiceError("Too many renames")

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

376

277

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

377

278

self.name)

378

if remove:

379

self.remove()

279

self.remove()

380

280

try:

381

281

self.add()

382

282

except dbus.exceptions.DBusException as error:

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

283

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

284

self.cleanup()

285

os._exit(1)

286

self.rename_count += 1

287

392

288

def remove(self):

393

289

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

394

290

if self.entry_group_state_changed_match is not None:

396

292

self.entry_group_state_changed_match = None

397

293

if self.group is not None:

398

294

self.group.Reset()

399

295

400

296

def add(self):

401

297

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

402

298

self.remove()

419

315

dbus.UInt16(self.port),

420

316

avahi.string_array_to_txt_array(self.TXT))

421

317

self.group.Commit()

422

318

423

319

def entry_group_state_changed(self, state, error):

424

320

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

425

321

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

426

322

427

323

if state == avahi.ENTRY_GROUP_ESTABLISHED:

428

324

logger.debug("Zeroconf service established.")

429

325

elif state == avahi.ENTRY_GROUP_COLLISION:

431

327

self.rename()

432

328

elif state == avahi.ENTRY_GROUP_FAILURE:

433

329

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

434

str(error))

435

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

436

330

unicode(error))

331

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

332

.format(error))

333

437

334

def cleanup(self):

438

335

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

439

336

if self.group is not None:

444

341

pass

445

342

self.group = None

446

343

self.remove()

447

344

448

345

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

449

346

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

450

347

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

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

}

348

bad_states = { avahi.SERVER_INVALID:

349

"Zeroconf server invalid",

350

avahi.SERVER_REGISTERING: None,

351

avahi.SERVER_COLLISION:

352

"Zeroconf server name collision",

353

avahi.SERVER_FAILURE:

354

"Zeroconf server failure" }

457

355

if state in bad_states:

458

356

if bad_states[state] is not None:

459

357

if error is None:

462

360

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

463

361

self.cleanup()

464

362

elif state == avahi.SERVER_RUNNING:

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)

363

self.add()

477

364

else:

478

365

if error is None:

479

366

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

480

367

else:

481

368

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

482

369

483

370

def activate(self):

484

371

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

485

372

if self.server is None:

489

376

follow_name_owner_changes=True),

490

377

avahi.DBUS_INTERFACE_SERVER)

491

378

self.server.connect_to_signal("StateChanged",

492

self.server_state_changed)

379

self.server_state_changed)

493

380

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

494

381

495

382

496

383

class AvahiServiceToSyslog(AvahiService):

497

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

384

def rename(self):

498

385

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

499

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

500

syslogger.setFormatter(logging.Formatter(

501

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

502

.format(self.name)))

386

ret = AvahiService.rename(self)

387

syslogger.setFormatter(logging.Formatter

388

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

389

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

390

.format(self.name)))

503

391

return ret

504

392

505

393

506

# Pretend that we have a GnuTLS module

507

class GnuTLS(object):

508

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

509

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

510

511

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

512

if library is None:

513

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

514

_library = ctypes.cdll.LoadLibrary(library)

515

del library

516

_need_version = b"3.3.0"

517

518

def __init__(self):

519

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

520

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

521

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

522

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

523

.format(self._need_version))

524

525

# Unless otherwise indicated, the constants and types below are

526

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

527

528

# Constants

529

E_SUCCESS = 0

530

E_INTERRUPTED = -52

531

E_AGAIN = -28

532

CRT_OPENPGP = 2

533

CLIENT = 2

534

SHUT_RDWR = 0

535

CRD_CERTIFICATE = 1

536

E_NO_CERTIFICATE_FOUND = -49

537

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

538

539

# Types

540

class session_int(ctypes.Structure):

541

_fields_ = []

542

session_t = ctypes.POINTER(session_int)

543

544

class certificate_credentials_st(ctypes.Structure):

545

_fields_ = []

546

certificate_credentials_t = ctypes.POINTER(

547

certificate_credentials_st)

548

certificate_type_t = ctypes.c_int

549

550

class datum_t(ctypes.Structure):

551

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

552

('size', ctypes.c_uint)]

553

554

class openpgp_crt_int(ctypes.Structure):

555

_fields_ = []

556

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

557

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

558

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

559

credentials_type_t = ctypes.c_int

560

transport_ptr_t = ctypes.c_void_p

561

close_request_t = ctypes.c_int

562

563

# Exceptions

564

class Error(Exception):

565

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

566

# exception might be raised from within GnuTLS.__init__,

567

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

568

# global variable has happened.

569

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

570

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

571

# code is passed, convert it to a string with

572

# gnutls.strerror()

573

self.code = code

574

if message is None and code is not None:

575

message = GnuTLS.strerror(code)

576

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

577

message, *args)

578

579

class CertificateSecurityError(Error):

580

pass

581

582

# Classes

583

class Credentials(object):

584

def __init__(self):

585

self._c_object = gnutls.certificate_credentials_t()

586

gnutls.certificate_allocate_credentials(

587

ctypes.byref(self._c_object))

588

self.type = gnutls.CRD_CERTIFICATE

589

590

def __del__(self):

591

gnutls.certificate_free_credentials(self._c_object)

592

593

class ClientSession(object):

594

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

595

self._c_object = gnutls.session_t()

596

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

597

gnutls.set_default_priority(self._c_object)

598

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

599

gnutls.handshake_set_private_extensions(self._c_object,

600

True)

601

self.socket = socket

602

if credentials is None:

603

credentials = gnutls.Credentials()

604

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

605

ctypes.cast(credentials._c_object,

606

ctypes.c_void_p))

607

self.credentials = credentials

608

609

def __del__(self):

610

gnutls.deinit(self._c_object)

611

612

def handshake(self):

613

return gnutls.handshake(self._c_object)

614

615

def send(self, data):

616

data = bytes(data)

617

data_len = len(data)

618

while data_len > 0:

619

data_len -= gnutls.record_send(self._c_object,

620

data[-data_len:],

621

data_len)

622

623

def bye(self):

624

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

625

626

# Error handling functions

627

def _error_code(result):

628

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

629

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

630

if result >= 0:

631

return result

632

if result == gnutls.E_NO_CERTIFICATE_FOUND:

633

raise gnutls.CertificateSecurityError(code=result)

634

raise gnutls.Error(code=result)

635

636

def _retry_on_error(result, func, arguments):

637

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

638

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

639

while result < 0:

640

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

641

return _error_code(result)

642

result = func(*arguments)

643

return result

644

645

# Unless otherwise indicated, the function declarations below are

646

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

647

648

# Functions

649

priority_set_direct = _library.gnutls_priority_set_direct

650

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

651

ctypes.POINTER(ctypes.c_char_p)]

652

priority_set_direct.restype = _error_code

653

654

init = _library.gnutls_init

655

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

656

init.restype = _error_code

657

658

set_default_priority = _library.gnutls_set_default_priority

659

set_default_priority.argtypes = [session_t]

660

set_default_priority.restype = _error_code

661

662

record_send = _library.gnutls_record_send

663

record_send.argtypes = [session_t, ctypes.c_void_p,

664

ctypes.c_size_t]

665

record_send.restype = ctypes.c_ssize_t

666

record_send.errcheck = _retry_on_error

667

668

certificate_allocate_credentials = (

669

_library.gnutls_certificate_allocate_credentials)

670

certificate_allocate_credentials.argtypes = [

671

ctypes.POINTER(certificate_credentials_t)]

672

certificate_allocate_credentials.restype = _error_code

673

674

certificate_free_credentials = (

675

_library.gnutls_certificate_free_credentials)

676

certificate_free_credentials.argtypes = [

677

certificate_credentials_t]

678

certificate_free_credentials.restype = None

679

680

handshake_set_private_extensions = (

681

_library.gnutls_handshake_set_private_extensions)

682

handshake_set_private_extensions.argtypes = [session_t,

683

ctypes.c_int]

684

handshake_set_private_extensions.restype = None

685

686

credentials_set = _library.gnutls_credentials_set

687

credentials_set.argtypes = [session_t, credentials_type_t,

688

ctypes.c_void_p]

689

credentials_set.restype = _error_code

690

691

strerror = _library.gnutls_strerror

692

strerror.argtypes = [ctypes.c_int]

693

strerror.restype = ctypes.c_char_p

694

695

certificate_type_get = _library.gnutls_certificate_type_get

696

certificate_type_get.argtypes = [session_t]

697

certificate_type_get.restype = _error_code

698

699

certificate_get_peers = _library.gnutls_certificate_get_peers

700

certificate_get_peers.argtypes = [session_t,

701

ctypes.POINTER(ctypes.c_uint)]

702

certificate_get_peers.restype = ctypes.POINTER(datum_t)

703

704

global_set_log_level = _library.gnutls_global_set_log_level

705

global_set_log_level.argtypes = [ctypes.c_int]

706

global_set_log_level.restype = None

707

708

global_set_log_function = _library.gnutls_global_set_log_function

709

global_set_log_function.argtypes = [log_func]

710

global_set_log_function.restype = None

711

712

deinit = _library.gnutls_deinit

713

deinit.argtypes = [session_t]

714

deinit.restype = None

715

716

handshake = _library.gnutls_handshake

717

handshake.argtypes = [session_t]

718

handshake.restype = _error_code

719

handshake.errcheck = _retry_on_error

720

721

transport_set_ptr = _library.gnutls_transport_set_ptr

722

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

723

transport_set_ptr.restype = None

724

725

bye = _library.gnutls_bye

726

bye.argtypes = [session_t, close_request_t]

727

bye.restype = _error_code

728

bye.errcheck = _retry_on_error

729

730

check_version = _library.gnutls_check_version

731

check_version.argtypes = [ctypes.c_char_p]

732

check_version.restype = ctypes.c_char_p

733

734

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

735

736

openpgp_crt_init = _library.gnutls_openpgp_crt_init

737

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

738

openpgp_crt_init.restype = _error_code

739

740

openpgp_crt_import = _library.gnutls_openpgp_crt_import

741

openpgp_crt_import.argtypes = [openpgp_crt_t,

742

ctypes.POINTER(datum_t),

743

openpgp_crt_fmt_t]

744

openpgp_crt_import.restype = _error_code

745

746

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

747

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

748

ctypes.POINTER(ctypes.c_uint)]

749

openpgp_crt_verify_self.restype = _error_code

750

751

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

752

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

753

openpgp_crt_deinit.restype = None

754

755

openpgp_crt_get_fingerprint = (

756

_library.gnutls_openpgp_crt_get_fingerprint)

757

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

758

ctypes.c_void_p,

759

ctypes.POINTER(

760

ctypes.c_size_t)]

761

openpgp_crt_get_fingerprint.restype = _error_code

762

763

# Remove non-public functions

764

del _error_code, _retry_on_error

765

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

766

gnutls = GnuTLS()

767

768

769

def call_pipe(connection, # : multiprocessing.Connection

770

func, *args, **kwargs):

771

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

772

773

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

774

return value on the provided multiprocessing.Connection.

775

"""

776

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

777

connection.close()

394

def timedelta_to_milliseconds(td):

395

"Convert a datetime.timedelta() to milliseconds"

396

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

397

+ (td.seconds * 1000)

398

+ (td.microseconds // 1000))

778

399

779

400

780

401

class Client(object):

781

402

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

782

403

783

404

Attributes:

784

405

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

785

406

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

787

408

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

788

409

to see if the client lives.

789

410

'None' if no process is running.

790

checker_callback_tag: a GLib event source tag, or None

411

checker_callback_tag: a gobject event source tag, or None

791

412

checker_command: string; External command which is run to check

792

413

if client lives. %() expansions are done at

793

414

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

794

415

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

795

checker_initiator_tag: a GLib event source tag, or None

416

checker_initiator_tag: a gobject event source tag, or None

796

417

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

797

418

client_structure: Object describing what attributes a client has

798

419

and is used for storing the client at exit

799

420

current_checker_command: string; current running checker_command

800

disable_initiator_tag: a GLib event source tag, or None

421

disable_initiator_tag: a gobject event source tag, or None

801

422

enabled: bool()

802

423

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

803

424

uniquely identify the client

808

429

last_checker_status: integer between 0 and 255 reflecting exit

809

430

status of last checker. -1 reflects crashed

810

431

checker, -2 means no checker completed yet.

811

last_checker_signal: The signal which killed the last checker, if

812

last_checker_status is -1

813

432

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

814

433

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

815

434

D-Bus identifiers

820

439

runtime_expansions: Allowed attributes for runtime expansion.

821

440

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

822

441

disabled, or None

823

server_settings: The server_settings dict from main()

824

442

"""

825

443

826

444

runtime_expansions = ("approval_delay", "approval_duration",

827

445

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

828

446

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

829

447

"last_approval_request", "last_checked_ok",

830

448

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

831

client_defaults = {

832

"timeout": "PT5M",

833

"extended_timeout": "PT15M",

834

"interval": "PT2M",

835

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

836

"host": "",

837

"approval_delay": "PT0S",

838

"approval_duration": "PT1S",

839

"approved_by_default": "True",

840

"enabled": "True",

841

}

842

449

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

450

"extended_timeout": "15m",

451

"interval": "2m",

452

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

453

"host": "",

454

"approval_delay": "0s",

455

"approval_duration": "1s",

456

"approved_by_default": "True",

457

"enabled": "True",

458

}

459

460

def timeout_milliseconds(self):

461

"Return the 'timeout' attribute in milliseconds"

462

return timedelta_to_milliseconds(self.timeout)

463

464

def extended_timeout_milliseconds(self):

465

"Return the 'extended_timeout' attribute in milliseconds"

466

return timedelta_to_milliseconds(self.extended_timeout)

467

468

def interval_milliseconds(self):

469

"Return the 'interval' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.interval)

471

472

def approval_delay_milliseconds(self):

473

return timedelta_to_milliseconds(self.approval_delay)

474

843

475

@staticmethod

844

476

def config_parser(config):

845

477

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

852

484

for client_name in config.sections():

853

485

section = dict(config.items(client_name))

854

486

client = settings[client_name] = {}

855

487

856

488

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

857

489

# Reformat values from string types to Python types

858

490

client["approved_by_default"] = config.getboolean(

859

491

client_name, "approved_by_default")

860

492

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

861

493

"enabled")

862

863

# Uppercase and remove spaces from fingerprint for later

864

# comparison purposes with return value from the

865

# fingerprint() function

494

866

495

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

867

496

.replace(" ", ""))

868

497

if "secret" in section:

869

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

870

.encode("utf-8"),

871

"base64")

498

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

872

499

elif "secfile" in section:

873

500

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

874

501

(section["secfile"])),

875

502

"rb") as secfile:

876

503

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

877

504

else:

878

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

505

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

879

506

.format(section))

880

507

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

881

508

client["extended_timeout"] = string_to_delta(

889

516

client["last_approval_request"] = None

890

517

client["last_checked_ok"] = None

891

518

client["last_checker_status"] = -2

892

519

893

520

return settings

894

895

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

521

522

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

896

523

self.name = name

897

if server_settings is None:

898

server_settings = {}

899

self.server_settings = server_settings

900

524

# adding all client settings

901

for setting, value in settings.items():

525

for setting, value in settings.iteritems():

902

526

setattr(self, setting, value)

903

527

904

528

if self.enabled:

905

529

if not hasattr(self, "last_enabled"):

906

530

self.last_enabled = datetime.datetime.utcnow()

910

534

else:

911

535

self.last_enabled = None

912

536

self.expires = None

913

537

914

538

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

539

# Uppercase and remove spaces from fingerprint for later

540

# comparison purposes with return value from the fingerprint()

541

# function

915

542

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

916

543

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

917

544

datetime.datetime.utcnow())

918

545

919

546

# attributes specific for this server instance

920

547

self.checker = None

921

548

self.checker_initiator_tag = None

924

551

self.current_checker_command = None

925

552

self.approved = None

926

553

self.approvals_pending = 0

927

self.changedstate = multiprocessing_manager.Condition(

928

multiprocessing_manager.Lock())

929

self.client_structure = [attr

930

for attr in self.__dict__.keys()

554

self.changedstate = (multiprocessing_manager

555

.Condition(multiprocessing_manager

556

.Lock()))

557

self.client_structure = [attr for attr in

558

self.__dict__.iterkeys()

931

559

if not attr.startswith("_")]

932

560

self.client_structure.append("client_structure")

933

934

for name, t in inspect.getmembers(

935

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

561

562

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

563

lambda obj:

564

isinstance(obj,

565

property)):

936

566

if not name.startswith("_"):

937

567

self.client_structure.append(name)

938

568

939

569

# Send notice to process children that client state has changed

940

570

def send_changedstate(self):

941

571

with self.changedstate:

942

572

self.changedstate.notify_all()

943

573

944

574

def enable(self):

945

575

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

946

576

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

951

581

self.last_enabled = datetime.datetime.utcnow()

952

582

self.init_checker()

953

583

self.send_changedstate()

954

584

955

585

def disable(self, quiet=True):

956

586

"""Disable this client."""

957

587

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

959

589

if not quiet:

960

590

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

961

591

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

962

GLib.source_remove(self.disable_initiator_tag)

592

gobject.source_remove(self.disable_initiator_tag)

963

593

self.disable_initiator_tag = None

964

594

self.expires = None

965

595

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

966

GLib.source_remove(self.checker_initiator_tag)

596

gobject.source_remove(self.checker_initiator_tag)

967

597

self.checker_initiator_tag = None

968

598

self.stop_checker()

969

599

self.enabled = False

970

600

if not quiet:

971

601

self.send_changedstate()

972

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

602

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

973

603

return False

974

604

975

605

def __del__(self):

976

606

self.disable()

977

607

978

608

def init_checker(self):

979

609

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

980

610

# and every interval from then on.

981

611

if self.checker_initiator_tag is not None:

982

GLib.source_remove(self.checker_initiator_tag)

983

self.checker_initiator_tag = GLib.timeout_add(

984

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

985

self.start_checker)

612

gobject.source_remove(self.checker_initiator_tag)

613

self.checker_initiator_tag = (gobject.timeout_add

614

(self.interval_milliseconds(),

615

self.start_checker))

986

616

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

987

617

if self.disable_initiator_tag is not None:

988

GLib.source_remove(self.disable_initiator_tag)

989

self.disable_initiator_tag = GLib.timeout_add(

990

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

618

gobject.source_remove(self.disable_initiator_tag)

619

self.disable_initiator_tag = (gobject.timeout_add

620

(self.timeout_milliseconds(),

621

self.disable))

991

622

# Also start a new checker *right now*.

992

623

self.start_checker()

993

994

def checker_callback(self, source, condition, connection,

995

command):

624

625

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

996

626

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

997

627

self.checker_callback_tag = None

998

628

self.checker = None

999

# Read return code from connection (see call_pipe)

1000

returncode = connection.recv()

1001

connection.close()

1002

1003

if returncode >= 0:

1004

self.last_checker_status = returncode

1005

self.last_checker_signal = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1006

631

if self.last_checker_status == 0:

1007

632

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

1008

633

vars(self))

1009

634

self.checked_ok()

1010

635

else:

1011

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

636

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

637

vars(self))

1012

638

else:

1013

639

self.last_checker_status = -1

1014

self.last_checker_signal = -returncode

1015

640

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

1016

641

vars(self))

1017

return False

1018

642

1019

643

def checked_ok(self):

1020

644

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

1021

645

self.last_checked_ok = datetime.datetime.utcnow()

1022

646

self.last_checker_status = 0

1023

self.last_checker_signal = None

1024

647

self.bump_timeout()

1025

648

1026

649

def bump_timeout(self, timeout=None):

1027

650

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

1028

651

if timeout is None:

1029

652

timeout = self.timeout

1030

653

if self.disable_initiator_tag is not None:

1031

GLib.source_remove(self.disable_initiator_tag)

654

gobject.source_remove(self.disable_initiator_tag)

1032

655

self.disable_initiator_tag = None

1033

656

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

1034

self.disable_initiator_tag = GLib.timeout_add(

1035

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(timedelta_to_milliseconds

659

(timeout), self.disable))

1036

660

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

1037

661

1038

662

def need_approval(self):

1039

663

self.last_approval_request = datetime.datetime.utcnow()

1040

664

1041

665

def start_checker(self):

1042

666

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

1043

667

1044

668

If a checker already exists, leave it running and do

1045

669

nothing."""

1046

670

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

1051

675

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

1052

676

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

1053

677

# should be.

1054

1055

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

1056

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

1057

self.checker.join()

1058

self.checker = None

678

679

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

680

try:

681

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

682

except (AttributeError, OSError) as error:

683

if (isinstance(error, OSError)

684

and error.errno != errno.ECHILD):

685

raise error

686

else:

687

if pid:

688

logger.warning("Checker was a zombie")

689

gobject.source_remove(self.checker_callback_tag)

690

self.checker_callback(pid, status,

691

self.current_checker_command)

1059

692

# Start a new checker if needed

1060

693

if self.checker is None:

1061

694

# Escape attributes for the shell

1062

escaped_attrs = {

1063

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

1064

for attr in self.runtime_expansions}

695

escaped_attrs = dict(

696

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

697

for attr in

698

self.runtime_expansions)

1065

699

try:

1066

700

command = self.checker_command % escaped_attrs

1067

701

except TypeError as error:

1068

702

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

1069

self.checker_command,

703

self.checker_command, exc_info=error)

704

return True # Try again later

705

self.current_checker_command = command

706

try:

707

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

708

command, self.name)

709

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

710

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

711

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

712

# always replaced by /dev/null.)

713

self.checker = subprocess.Popen(command,

714

close_fds=True,

715

shell=True, cwd="/")

716

except OSError as error:

717

logger.error("Failed to start subprocess",

1070

718

exc_info=error)

1071

return True # Try again later

1072

self.current_checker_command = command

1073

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

1074

self.name)

1075

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

1076

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

1077

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

1078

# always replaced by /dev/null.)

1079

# The exception is when not debugging but nevertheless

1080

# running in the foreground; use the previously

1081

# created wnull.

1082

popen_args = {"close_fds": True,

1083

"shell": True,

1084

"cwd": "/"}

1085

if (not self.server_settings["debug"]

1086

and self.server_settings["foreground"]):

1087

popen_args.update({"stdout": wnull,

1088

"stderr": wnull})

1089

pipe = multiprocessing.Pipe(duplex=False)

1090

self.checker = multiprocessing.Process(

1091

target=call_pipe,

1092

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

1093

kwargs=popen_args)

1094

self.checker.start()

1095

self.checker_callback_tag = GLib.io_add_watch(

1096

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

1097

self.checker_callback, pipe[0], command)

1098

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

719

self.checker_callback_tag = (gobject.child_watch_add

720

(self.checker.pid,

721

self.checker_callback,

722

data=command))

723

# The checker may have completed before the gobject

724

# watch was added. Check for this.

725

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

726

if pid:

727

gobject.source_remove(self.checker_callback_tag)

728

self.checker_callback(pid, status, command)

729

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

1099

730

return True

1100

731

1101

732

def stop_checker(self):

1102

733

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

1103

734

if self.checker_callback_tag:

1104

GLib.source_remove(self.checker_callback_tag)

735

gobject.source_remove(self.checker_callback_tag)

1105

736

self.checker_callback_tag = None

1106

737

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

1107

738

return

1108

739

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

1109

self.checker.terminate()

740

try:

741

self.checker.terminate()

742

#time.sleep(0.5)

743

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

744

# self.checker.kill()

745

except OSError as error:

746

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

747

raise

1110

748

self.checker = None

1111

749

1112

750

1113

def dbus_service_property(dbus_interface,

1114

signature="v",

1115

access="readwrite",

1116

byte_arrays=False):

751

def dbus_service_property(dbus_interface, signature="v",

752

access="readwrite", byte_arrays=False):

1117

753

"""Decorators for marking methods of a DBusObjectWithProperties to

1118

754

become properties on the D-Bus.

1119

755

1120

756

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

1121

757

and with one argument by "Set".

1122

758

1123

759

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

1124

760

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

1125

761

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

1128

764

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

1129

765

if byte_arrays and signature != "ay":

1130

766

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

1131

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

1132

767

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

1133

768

def decorator(func):

1134

769

func._dbus_is_property = True

1135

770

func._dbus_interface = dbus_interface

1138

773

func._dbus_name = func.__name__

1139

774

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

1140

775

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

1141

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

776

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1142

777

return func

1143

1144

778

return decorator

1145

779

1146

780

1147

781

def dbus_interface_annotations(dbus_interface):

1148

782

"""Decorator for marking functions returning interface annotations

1149

783

1150

784

Usage:

1151

785

1152

786

@dbus_interface_annotations("org.example.Interface")

1153

787

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

1154

788

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

1155

789

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

1156

790

"false"}

1157

791

"""

1158

1159

792

def decorator(func):

1160

793

func._dbus_is_interface = True

1161

794

func._dbus_interface = dbus_interface

1162

795

func._dbus_name = dbus_interface

1163

796

return func

1164

1165

797

return decorator

1166

798

1167

799

1168

800

def dbus_annotations(annotations):

1169

801

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

1170

802

Usage:

1171

1172

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

1173

"org.freedesktop.DBus.Property."

1174

"EmitsChangedSignal": "false"})

803

1175

804

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

1176

805

access="r")

806

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

807

"org.freedesktop.DBus.Property."

808

"EmitsChangedSignal": "false"})

1177

809

def Property_dbus_property(self):

1178

810

return dbus.Boolean(False)

1179

1180

See also the DBusObjectWithAnnotations class.

1181

811

"""

1182

1183

812

def decorator(func):

1184

813

func._dbus_annotations = annotations

1185

814

return func

1186

1187

815

return decorator

1188

816

1189

817

1190

818

class DBusPropertyException(dbus.exceptions.DBusException):

1191

819

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

1192

820

"""

1193

pass

821

def __unicode__(self):

822

return unicode(str(self))

1194

823

1195

824

1196

825

class DBusPropertyAccessException(DBusPropertyException):

1205

834

pass

1206

835

1207

836

1208

class DBusObjectWithAnnotations(dbus.service.Object):

1209

"""A D-Bus object with annotations.

1210

1211

Classes inheriting from this can use the dbus_annotations

1212

decorator to add annotations to methods or signals.

837

class DBusObjectWithProperties(dbus.service.Object):

838

"""A D-Bus object with properties.

839

840

Classes inheriting from this can use the dbus_service_property

841

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

842

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

1213

843

"""

1214

844

1215

845

@staticmethod

1216

846

def _is_dbus_thing(thing):

1217

847

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

1218

848

1219

849

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

1220

850

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

1221

851

"""

1222

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

852

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

1223

853

False)

1224

854

1225

855

def _get_all_dbus_things(self, thing):

1226

856

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

1227

857

"""

1228

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

858

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

859

name),

1229

860

athing.__get__(self))

1230

861

for cls in self.__class__.__mro__

1231

862

for name, athing in

1232

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

1233

1234

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1235

out_signature="s",

1236

path_keyword='object_path',

1237

connection_keyword='connection')

1238

def Introspect(self, object_path, connection):

1239

"""Overloading of standard D-Bus method.

1240

1241

Inserts annotation tags on methods and signals.

1242

"""

1243

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

1244

connection)

1245

try:

1246

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

1247

1248

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

1249

# Add annotation tags

1250

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

1251

for tag in if_tag.getElementsByTagName(typ):

1252

annots = dict()

1253

for name, prop in (self.

1254

_get_all_dbus_things(typ)):

1255

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

1256

and prop._dbus_interface

1257

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

1258

annots.update(getattr(

1259

prop, "_dbus_annotations", {}))

1260

for name, value in annots.items():

1261

ann_tag = document.createElement(

1262

"annotation")

1263

ann_tag.setAttribute("name", name)

1264

ann_tag.setAttribute("value", value)

1265

tag.appendChild(ann_tag)

1266

# Add interface annotation tags

1267

for annotation, value in dict(

1268

itertools.chain.from_iterable(

1269

annotations().items()

1270

for name, annotations

1271

in self._get_all_dbus_things("interface")

1272

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

1273

)).items():

1274

ann_tag = document.createElement("annotation")

1275

ann_tag.setAttribute("name", annotation)

1276

ann_tag.setAttribute("value", value)

1277

if_tag.appendChild(ann_tag)

1278

# Fix argument name for the Introspect method itself

1279

if (if_tag.getAttribute("name")

1280

== dbus.INTROSPECTABLE_IFACE):

1281

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

1282

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

1283

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

1284

if (arg.getAttribute("direction")

1285

== "out"):

1286

arg.setAttribute("name",

1287

"xml_data")

1288

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

1289

document.unlink()

1290

except (AttributeError, xml.dom.DOMException,

1291

xml.parsers.expat.ExpatError) as error:

1292

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

1293

exc_info=error)

1294

return xmlstring

1295

1296

1297

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1298

"""A D-Bus object with properties.

1299

1300

Classes inheriting from this can use the dbus_service_property

1301

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

1302

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

1303

"""

1304

863

inspect.getmembers(cls,

864

self._is_dbus_thing(thing)))

865

1305

866

def _get_dbus_property(self, interface_name, property_name):

1306

867

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

1307

868

property with the specified name and interface.

1308

869

"""

1309

for cls in self.__class__.__mro__:

1310

for name, value in inspect.getmembers(

1311

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

870

for cls in self.__class__.__mro__:

871

for name, value in (inspect.getmembers

872

(cls,

873

self._is_dbus_thing("property"))):

1312

874

if (value._dbus_name == property_name

1313

875

and value._dbus_interface == interface_name):

1314

876

return value.__get__(self)

1315

877

1316

878

# No such property

1317

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

1318

self.dbus_object_path, interface_name, property_name))

1319

1320

@classmethod

1321

def _get_all_interface_names(cls):

1322

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

1323

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

1324

"_dbus_interface", None)

1325

for x in (inspect.getmro(cls))

1326

for attr in dir(x))

1327

if name is not None)

1328

1329

@dbus.service.method(dbus.PROPERTIES_IFACE,

1330

in_signature="ss",

879

raise DBusPropertyNotFound(self.dbus_object_path + ":"

880

+ interface_name + "."

881

+ property_name)

882

883

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

1331

884

out_signature="v")

1332

885

def Get(self, interface_name, property_name):

1333

886

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

1339

892

if not hasattr(value, "variant_level"):

1340

893

return value

1341

894

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

1342

895

1343

896

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

1344

897

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

1345

898

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

1351

904

# The byte_arrays option is not supported yet on

1352

905

# signatures other than "ay".

1353

906

if prop._dbus_signature != "ay":

1354

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

1355

"'ay' signature {!r}"

1356

.format(prop._dbus_signature))

907

raise ValueError

1357

908

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

1358

909

for byte in value))

1359

910

prop(value)

1360

1361

@dbus.service.method(dbus.PROPERTIES_IFACE,

1362

in_signature="s",

911

912

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

1363

913

out_signature="a{sv}")

1364

914

def GetAll(self, interface_name):

1365

915

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

1366

916

standard.

1367

917

1368

918

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

1369

919

"""

1370

920

properties = {}

1380

930

if not hasattr(value, "variant_level"):

1381

931

properties[name] = value

1382

932

continue

1383

properties[name] = type(value)(

1384

value, variant_level=value.variant_level + 1)

933

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

934

value.variant_level+1)

1385

935

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

1386

1387

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

1388

def PropertiesChanged(self, interface_name, changed_properties,

1389

invalidated_properties):

1390

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

1391

standard.

1392

"""

1393

pass

1394

936

1395

937

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1396

938

out_signature="s",

1397

939

path_keyword='object_path',

1398

940

connection_keyword='connection')

1399

941

def Introspect(self, object_path, connection):

1400

942

"""Overloading of standard D-Bus method.

1401

943

1402

944

Inserts property tags and interface annotation tags.

1403

945

"""

1404

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1405

object_path,

1406

connection)

946

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

947

connection)

1407

948

try:

1408

949

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

1409

1410

950

def make_tag(document, name, prop):

1411

951

e = document.createElement("property")

1412

952

e.setAttribute("name", name)

1413

953

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

1414

954

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

1415

955

return e

1416

1417

956

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

1418

957

# Add property tags

1419

958

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

1422

961

if prop._dbus_interface

1423

962

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

1424

963

if_tag.appendChild(tag)

1425

# Add annotation tags for properties

1426

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

1427

annots = dict()

1428

for name, prop in self._get_all_dbus_things(

1429

"property"):

1430

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

1431

and prop._dbus_interface

1432

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

1433

annots.update(getattr(

1434

prop, "_dbus_annotations", {}))

1435

for name, value in annots.items():

1436

ann_tag = document.createElement(

1437

"annotation")

1438

ann_tag.setAttribute("name", name)

1439

ann_tag.setAttribute("value", value)

1440

tag.appendChild(ann_tag)

964

# Add annotation tags

965

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

966

for tag in if_tag.getElementsByTagName(typ):

967

annots = dict()

968

for name, prop in (self.

969

_get_all_dbus_things(typ)):

970

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

971

and prop._dbus_interface

972

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

973

annots.update(getattr

974

(prop,

975

"_dbus_annotations",

976

{}))

977

for name, value in annots.iteritems():

978

ann_tag = document.createElement(

979

"annotation")

980

ann_tag.setAttribute("name", name)

981

ann_tag.setAttribute("value", value)

982

tag.appendChild(ann_tag)

983

# Add interface annotation tags

984

for annotation, value in dict(

985

itertools.chain.from_iterable(

986

annotations().iteritems()

987

for name, annotations in

988

self._get_all_dbus_things("interface")

989

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

990

)).iteritems():

991

ann_tag = document.createElement("annotation")

992

ann_tag.setAttribute("name", annotation)

993

ann_tag.setAttribute("value", value)

994

if_tag.appendChild(ann_tag)

1441

995

# Add the names to the return values for the

1442

996

# "org.freedesktop.DBus.Properties" methods

1443

997

if (if_tag.getAttribute("name")

1462

1016

return xmlstring

1463

1017

1464

1018

1465

try:

1466

dbus.OBJECT_MANAGER_IFACE

1467

except AttributeError:

1468

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

1469

1470

1471

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1472

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

1473

1474

Classes inheriting from this exposes the standard

1475

GetManagedObjects call and the InterfacesAdded and

1476

InterfacesRemoved signals on the standard

1477

"org.freedesktop.DBus.ObjectManager" interface.

1478

1479

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

1480

manually.

1481

"""

1482

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1483

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

1484

def GetManagedObjects(self):

1485

"""This function must be overridden"""

1486

raise NotImplementedError()

1487

1488

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1489

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

1490

def InterfacesAdded(self, object_path, interfaces_and_properties):

1491

pass

1492

1493

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

1494

def InterfacesRemoved(self, object_path, interfaces):

1495

pass

1496

1497

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1498

out_signature="s",

1499

path_keyword='object_path',

1500

connection_keyword='connection')

1501

def Introspect(self, object_path, connection):

1502

"""Overloading of standard D-Bus method.

1503

1504

Override return argument name of GetManagedObjects to be

1505

"objpath_interfaces_and_properties"

1506

"""

1507

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1508

object_path,

1509

connection)

1510

try:

1511

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

1512

1513

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

1514

# Fix argument name for the GetManagedObjects method

1515

if (if_tag.getAttribute("name")

1516

== dbus.OBJECT_MANAGER_IFACE):

1517

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

1518

if (cn.getAttribute("name")

1519

== "GetManagedObjects"):

1520

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

1521

if (arg.getAttribute("direction")

1522

== "out"):

1523

arg.setAttribute(

1524

"name",

1525

"objpath_interfaces"

1526

"_and_properties")

1527

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

1528

document.unlink()

1529

except (AttributeError, xml.dom.DOMException,

1530

xml.parsers.expat.ExpatError) as error:

1531

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

1532

exc_info=error)

1533

return xmlstring

1534

1535

1536

1019

def datetime_to_dbus(dt, variant_level=0):

1537

1020

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

1538

1021

if dt is None:

1539

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

1540

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

1022

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

1023

return dbus.String(dt.isoformat(),

1024

variant_level=variant_level)

1541

1025

1542

1026

1543

1027

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1545

1029

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

1546

1030

interface names according to the "alt_interface_names" mapping.

1547

1031

Usage:

1548

1032

1549

1033

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

1550

1034

"net.example.AlternateInterface"})

1551

1035

class SampleDBusObject(dbus.service.Object):

1552

1036

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

1553

1037

def SampleDBusMethod():

1554

1038

pass

1555

1039

1556

1040

The above "SampleDBusMethod" on "SampleDBusObject" will be

1557

1041

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

1558

1042

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

1559

1043

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

1560

1044

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

1561

1045

1562

1046

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

1563

1047

(from DBusObjectWithProperties) and interfaces (from the

1564

1048

dbus_interface_annotations decorator).

1565

1049

"""

1566

1567

1050

def wrapper(cls):

1568

1051

for orig_interface_name, alt_interface_name in (

1569

alt_interface_names.items()):

1052

alt_interface_names.iteritems()):

1570

1053

attr = {}

1571

1054

interface_names = set()

1572

1055

# Go though all attributes of the class

1574

1057

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

1575

1058

# with the wrong interface name

1576

1059

if (not hasattr(attribute, "_dbus_interface")

1577

or not attribute._dbus_interface.startswith(

1578

orig_interface_name)):

1060

or not attribute._dbus_interface

1061

.startswith(orig_interface_name)):

1579

1062

continue

1580

1063

# Create an alternate D-Bus interface name based on

1581

1064

# the current name

1582

alt_interface = attribute._dbus_interface.replace(

1583

orig_interface_name, alt_interface_name)

1065

alt_interface = (attribute._dbus_interface

1066

.replace(orig_interface_name,

1067

alt_interface_name))

1584

1068

interface_names.add(alt_interface)

1585

1069

# Is this a D-Bus signal?

1586

1070

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

1587

# Extract the original non-method undecorated

1588

# function by black magic

1589

if sys.version_info.major == 2:

1590

nonmethod_func = (dict(

1071

# Extract the original non-method function by

1072

# black magic

1073

nonmethod_func = (dict(

1591

1074

zip(attribute.func_code.co_freevars,

1592

attribute.__closure__))

1593

["func"].cell_contents)

1594

else:

1595

nonmethod_func = (dict(

1596

zip(attribute.__code__.co_freevars,

1597

attribute.__closure__))

1598

["func"].cell_contents)

1075

attribute.__closure__))["func"]

1076

.cell_contents)

1599

1077

# Create a new, but exactly alike, function

1600

1078

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

1601

1079

# with the alternate D-Bus interface name

1602

new_function = copy_function(nonmethod_func)

1603

new_function = (dbus.service.signal(

1604

alt_interface,

1605

attribute._dbus_signature)(new_function))

1080

new_function = (dbus.service.signal

1081

(alt_interface,

1082

attribute._dbus_signature)

1083

(types.FunctionType(

1084

nonmethod_func.func_code,

1085

nonmethod_func.func_globals,

1086

nonmethod_func.func_name,

1087

nonmethod_func.func_defaults,

1088

nonmethod_func.func_closure)))

1606

1089

# Copy annotations, if any

1607

1090

try:

1608

new_function._dbus_annotations = dict(

1609

attribute._dbus_annotations)

1091

new_function._dbus_annotations = (

1092

dict(attribute._dbus_annotations))

1610

1093

except AttributeError:

1611

1094

pass

1612

1613

1095

# Define a creator of a function to call both the

1614

1096

# original and alternate functions, so both the

1615

1097

# original and alternate signals gets sent when

1618

1100

"""This function is a scope container to pass

1619

1101

func1 and func2 to the "call_both" function

1620

1102

outside of its arguments"""

1621

1622

@functools.wraps(func2)

1623

1103

def call_both(*args, **kwargs):

1624

1104

"""This function will emit two D-Bus

1625

1105

signals by calling func1 and func2"""

1626

1106

func1(*args, **kwargs)

1627

1107

func2(*args, **kwargs)

1628

# Make wrapper function look like a D-Bus

1629

# signal

1630

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

1631

if name.startswith("_dbus_"):

1632

setattr(call_both, name, attr)

1633

1634

1108

return call_both

1635

1109

# Create the "call_both" function and add it to

1636

1110

# the class

1641

1115

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

1642

1116

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

1643

1117

# to the class.

1644

attr[attrname] = (

1645

dbus.service.method(

1646

alt_interface,

1647

attribute._dbus_in_signature,

1648

attribute._dbus_out_signature)

1649

(copy_function(attribute)))

1118

attr[attrname] = (dbus.service.method

1119

(alt_interface,

1120

attribute._dbus_in_signature,

1121

attribute._dbus_out_signature)

1122

(types.FunctionType

1123

(attribute.func_code,

1124

attribute.func_globals,

1125

attribute.func_name,

1126

attribute.func_defaults,

1127

attribute.func_closure)))

1650

1128

# Copy annotations, if any

1651

1129

try:

1652

attr[attrname]._dbus_annotations = dict(

1653

attribute._dbus_annotations)

1130

attr[attrname]._dbus_annotations = (

1131

dict(attribute._dbus_annotations))

1654

1132

except AttributeError:

1655

1133

pass

1656

1134

# Is this a D-Bus property?

1659

1137

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

1660

1138

# property with the alternate D-Bus interface

1661

1139

# name. Add it to the class.

1662

attr[attrname] = (dbus_service_property(

1663

alt_interface, attribute._dbus_signature,

1664

attribute._dbus_access,

1665

attribute._dbus_get_args_options

1666

["byte_arrays"])

1667

(copy_function(attribute)))

1140

attr[attrname] = (dbus_service_property

1141

(alt_interface,

1142

attribute._dbus_signature,

1143

attribute._dbus_access,

1144

attribute

1145

._dbus_get_args_options

1146

["byte_arrays"])

1147

(types.FunctionType

1148

(attribute.func_code,

1149

attribute.func_globals,

1150

attribute.func_name,

1151

attribute.func_defaults,

1152

attribute.func_closure)))

1668

1153

# Copy annotations, if any

1669

1154

try:

1670

attr[attrname]._dbus_annotations = dict(

1671

attribute._dbus_annotations)

1155

attr[attrname]._dbus_annotations = (

1156

dict(attribute._dbus_annotations))

1672

1157

except AttributeError:

1673

1158

pass

1674

1159

# Is this a D-Bus interface?

1677

1162

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

1678

1163

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

1679

1164

# to the class.

1680

attr[attrname] = (

1681

dbus_interface_annotations(alt_interface)

1682

(copy_function(attribute)))

1165

attr[attrname] = (dbus_interface_annotations

1166

(alt_interface)

1167

(types.FunctionType

1168

(attribute.func_code,

1169

attribute.func_globals,

1170

attribute.func_name,

1171

attribute.func_defaults,

1172

attribute.func_closure)))

1683

1173

if deprecate:

1684

1174

# Deprecate all alternate interfaces

1685

iname = "_AlternateDBusNames_interface_annotation{}"

1175

iname="_AlternateDBusNames_interface_annotation{0}"

1686

1176

for interface_name in interface_names:

1687

1688

1177

@dbus_interface_annotations(interface_name)

1689

1178

def func(self):

1690

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

1691

"true"}

1179

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

1180

"true" }

1692

1181

# Find an unused name

1693

1182

for aname in (iname.format(i)

1694

1183

for i in itertools.count()):

1698

1187

if interface_names:

1699

1188

# Replace the class with a new subclass of it with

1700

1189

# methods, signals, etc. as created above.

1701

if sys.version_info.major == 2:

1702

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

1703

(cls, ), attr)

1704

else:

1705

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

1706

(cls, ), attr)

1190

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

1191

(cls,), attr)

1707

1192

return cls

1708

1709

1193

return wrapper

1710

1194

1711

1195

1712

1196

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

1713

"se.bsnet.fukt.Mandos"})

1197

"se.bsnet.fukt.Mandos"})

1714

1198

class ClientDBus(Client, DBusObjectWithProperties):

1715

1199

"""A Client class using D-Bus

1716

1200

1717

1201

Attributes:

1718

1202

dbus_object_path: dbus.ObjectPath

1719

1203

bus: dbus.SystemBus()

1720

1204

"""

1721

1205

1722

1206

runtime_expansions = (Client.runtime_expansions

1723

+ ("dbus_object_path", ))

1724

1725

_interface = "se.recompile.Mandos.Client"

1726

1207

+ ("dbus_object_path",))

1208

1727

1209

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

1728

1729

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

1210

1211

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

1730

1212

self.bus = bus

1731

1213

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

1732

1214

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

1733

1215

# the D-Bus

1734

client_object_name = str(self.name).translate(

1216

client_object_name = unicode(self.name).translate(

1735

1217

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

1736

1218

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

1737

self.dbus_object_path = dbus.ObjectPath(

1738

"/clients/" + client_object_name)

1219

self.dbus_object_path = (dbus.ObjectPath

1220

("/clients/" + client_object_name))

1739

1221

DBusObjectWithProperties.__init__(self, self.bus,

1740

1222

self.dbus_object_path)

1741

1742

def notifychangeproperty(transform_func, dbus_name,

1743

type_func=lambda x: x,

1744

variant_level=1,

1745

invalidate_only=False,

1746

_interface=_interface):

1223

1224

def notifychangeproperty(transform_func,

1225

dbus_name, type_func=lambda x: x,

1226

variant_level=1):

1747

1227

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

1748

1228

its changes to DBus.

1749

1229

1750

1230

transform_fun: Function that takes a value and a variant_level

1751

1231

and transforms it to a D-Bus type.

1752

1232

dbus_name: D-Bus name of the variable

1754

1234

to the D-Bus. Default: no transform

1755

1235

variant_level: D-Bus variant level. Default: 1

1756

1236

"""

1757

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

1758

1237

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

1759

1238

def setter(self, value):

1760

1239

if hasattr(self, "dbus_object_path"):

1761

1240

if (not hasattr(self, attrname) or

1762

1241

type_func(getattr(self, attrname, None))

1763

1242

!= type_func(value)):

1764

if invalidate_only:

1765

self.PropertiesChanged(

1766

_interface, dbus.Dictionary(),

1767

dbus.Array((dbus_name, )))

1768

else:

1769

dbus_value = transform_func(

1770

type_func(value),

1771

variant_level=variant_level)

1772

self.PropertyChanged(dbus.String(dbus_name),

1773

dbus_value)

1774

self.PropertiesChanged(

1775

_interface,

1776

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

1777

dbus_value}),

1778

dbus.Array())

1243

dbus_value = transform_func(type_func(value),

1244

variant_level

1245

=variant_level)

1246

self.PropertyChanged(dbus.String(dbus_name),

1247

dbus_value)

1779

1248

setattr(self, attrname, value)

1780

1249

1781

1250

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

1782

1251

1783

1252

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1784

1253

approvals_pending = notifychangeproperty(dbus.Boolean,

1785

1254

"ApprovalPending",

1786

type_func=bool)

1255

type_func = bool)

1787

1256

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

1788

1257

last_enabled = notifychangeproperty(datetime_to_dbus,

1789

1258

"LastEnabled")

1790

checker = notifychangeproperty(

1791

dbus.Boolean, "CheckerRunning",

1792

type_func=lambda checker: checker is not None)

1259

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

1260

type_func = lambda checker:

1261

checker is not None)

1793

1262

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1794

1263

"LastCheckedOK")

1795

1264

last_checker_status = notifychangeproperty(dbus.Int16,

1798

1267

datetime_to_dbus, "LastApprovalRequest")

1799

1268

approved_by_default = notifychangeproperty(dbus.Boolean,

1800

1269

"ApprovedByDefault")

1801

approval_delay = notifychangeproperty(

1802

dbus.UInt64, "ApprovalDelay",

1803

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

1270

approval_delay = notifychangeproperty(dbus.UInt64,

1271

"ApprovalDelay",

1272

type_func =

1273

timedelta_to_milliseconds)

1804

1274

approval_duration = notifychangeproperty(

1805

1275

dbus.UInt64, "ApprovalDuration",

1806

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

1276

type_func = timedelta_to_milliseconds)

1807

1277

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

1808

timeout = notifychangeproperty(

1809

dbus.UInt64, "Timeout",

1810

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

1278

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

1279

type_func =

1280

timedelta_to_milliseconds)

1811

1281

extended_timeout = notifychangeproperty(

1812

1282

dbus.UInt64, "ExtendedTimeout",

1813

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

1814

interval = notifychangeproperty(

1815

dbus.UInt64, "Interval",

1816

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

1283

type_func = timedelta_to_milliseconds)

1284

interval = notifychangeproperty(dbus.UInt64,

1285

"Interval",

1286

type_func =

1287

timedelta_to_milliseconds)

1817

1288

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

1818

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

1819

invalidate_only=True)

1820

1289

1821

1290

del notifychangeproperty

1822

1291

1823

1292

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

1824

1293

try:

1825

1294

self.remove_from_connection()

1828

1297

if hasattr(DBusObjectWithProperties, "__del__"):

1829

1298

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

1830

1299

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

1831

1832

def checker_callback(self, source, condition,

1833

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

1834

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

1835

connection, command, *args,

1836

**kwargs)

1837

exitstatus = self.last_checker_status

1838

if exitstatus >= 0:

1300

1301

def checker_callback(self, pid, condition, command,

1302

*args, **kwargs):

1303

self.checker_callback_tag = None

1304

self.checker = None

1305

if os.WIFEXITED(condition):

1306

exitstatus = os.WEXITSTATUS(condition)

1839

1307

# Emit D-Bus signal

1840

1308

self.CheckerCompleted(dbus.Int16(exitstatus),

1841

# This is specific to GNU libC

1842

dbus.Int64(exitstatus << 8),

1309

dbus.Int64(condition),

1843

1310

dbus.String(command))

1844

1311

else:

1845

1312

# Emit D-Bus signal

1846

1313

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

1847

dbus.Int64(

1848

# This is specific to GNU libC

1849

(exitstatus << 8)

1850

| self.last_checker_signal),

1314

dbus.Int64(condition),

1851

1315

dbus.String(command))

1852

return ret

1853

1316

1317

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

1318

*args, **kwargs)

1319

1854

1320

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

1855

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

1321

old_checker = self.checker

1322

if self.checker is not None:

1323

old_checker_pid = self.checker.pid

1324

else:

1325

old_checker_pid = None

1856

1326

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

1857

1327

# Only if new checker process was started

1858

1328

if (self.checker is not None

1860

1330

# Emit D-Bus signal

1861

1331

self.CheckerStarted(self.current_checker_command)

1862

1332

return r

1863

1333

1864

1334

def _reset_approved(self):

1865

1335

self.approved = None

1866

1336

return False

1867

1337

1868

1338

def approve(self, value=True):

1869

1339

self.approved = value

1870

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

1871

* 1000), self._reset_approved)

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1872

1343

self.send_changedstate()

1873

1874

# D-Bus methods, signals & properties

1875

1876

# Interfaces

1877

1878

# Signals

1879

1344

1345

## D-Bus methods, signals & properties

1346

_interface = "se.recompile.Mandos.Client"

1347

1348

## Interfaces

1349

1350

@dbus_interface_annotations(_interface)

1351

def _foo(self):

1352

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

1353

"false"}

1354

1355

## Signals

1356

1880

1357

# CheckerCompleted - signal

1881

1358

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

1882

1359

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

1883

1360

"D-Bus signal"

1884

1361

pass

1885

1362

1886

1363

# CheckerStarted - signal

1887

1364

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

1888

1365

def CheckerStarted(self, command):

1889

1366

"D-Bus signal"

1890

1367

pass

1891

1368

1892

1369

# PropertyChanged - signal

1893

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

1894

1370

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

1895

1371

def PropertyChanged(self, property, value):

1896

1372

"D-Bus signal"

1897

1373

pass

1898

1374

1899

1375

# GotSecret - signal

1900

1376

@dbus.service.signal(_interface)

1901

1377

def GotSecret(self):

1904

1380

server to mandos-client

1905

1381

"""

1906

1382

pass

1907

1383

1908

1384

# Rejected - signal

1909

1385

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

1910

1386

def Rejected(self, reason):

1911

1387

"D-Bus signal"

1912

1388

pass

1913

1389

1914

1390

# NeedApproval - signal

1915

1391

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

1916

1392

def NeedApproval(self, timeout, default):

1917

1393

"D-Bus signal"

1918

1394

return self.need_approval()

1919

1920

# Methods

1921

1395

1396

## Methods

1397

1922

1398

# Approve - method

1923

1399

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

1924

1400

def Approve(self, value):

1925

1401

self.approve(value)

1926

1402

1927

1403

# CheckedOK - method

1928

1404

@dbus.service.method(_interface)

1929

1405

def CheckedOK(self):

1930

1406

self.checked_ok()

1931

1407

1932

1408

# Enable - method

1933

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

1934

1409

@dbus.service.method(_interface)

1935

1410

def Enable(self):

1936

1411

"D-Bus method"

1937

1412

self.enable()

1938

1413

1939

1414

# StartChecker - method

1940

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

1941

1415

@dbus.service.method(_interface)

1942

1416

def StartChecker(self):

1943

1417

"D-Bus method"

1944

1418

self.start_checker()

1945

1419

1946

1420

# Disable - method

1947

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

1948

1421

@dbus.service.method(_interface)

1949

1422

def Disable(self):

1950

1423

"D-Bus method"

1951

1424

self.disable()

1952

1425

1953

1426

# StopChecker - method

1954

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

1955

1427

@dbus.service.method(_interface)

1956

1428

def StopChecker(self):

1957

1429

self.stop_checker()

1958

1959

# Properties

1960

1430

1431

## Properties

1432

1961

1433

# ApprovalPending - property

1962

1434

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

1963

1435

def ApprovalPending_dbus_property(self):

1964

1436

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

1965

1437

1966

1438

# ApprovedByDefault - property

1967

@dbus_service_property(_interface,

1968

signature="b",

1439

@dbus_service_property(_interface, signature="b",

1969

1440

access="readwrite")

1970

1441

def ApprovedByDefault_dbus_property(self, value=None):

1971

1442

if value is None: # get

1972

1443

return dbus.Boolean(self.approved_by_default)

1973

1444

self.approved_by_default = bool(value)

1974

1445

1975

1446

# ApprovalDelay - property

1976

@dbus_service_property(_interface,

1977

signature="t",

1447

@dbus_service_property(_interface, signature="t",

1978

1448

access="readwrite")

1979

1449

def ApprovalDelay_dbus_property(self, value=None):

1980

1450

if value is None: # get

1981

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

1982

* 1000)

1451

return dbus.UInt64(self.approval_delay_milliseconds())

1983

1452

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

1984

1453

1985

1454

# ApprovalDuration - property

1986

@dbus_service_property(_interface,

1987

signature="t",

1455

@dbus_service_property(_interface, signature="t",

1988

1456

access="readwrite")

1989

1457

def ApprovalDuration_dbus_property(self, value=None):

1990

1458

if value is None: # get

1991

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

1992

* 1000)

1459

return dbus.UInt64(timedelta_to_milliseconds(

1460

self.approval_duration))

1993

1461

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

1994

1462

1995

1463

# Name - property

1996

@dbus_annotations(

1997

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

1998

1464

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

1999

1465

def Name_dbus_property(self):

2000

1466

return dbus.String(self.name)

2001

1467

2002

1468

# Fingerprint - property

2003

@dbus_annotations(

2004

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

2005

1469

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

2006

1470

def Fingerprint_dbus_property(self):

2007

1471

return dbus.String(self.fingerprint)

2008

1472

2009

1473

# Host - property

2010

@dbus_service_property(_interface,

2011

signature="s",

1474

@dbus_service_property(_interface, signature="s",

2012

1475

access="readwrite")

2013

1476

def Host_dbus_property(self, value=None):

2014

1477

if value is None: # get

2015

1478

return dbus.String(self.host)

2016

self.host = str(value)

2017

1479

self.host = unicode(value)

1480

2018

1481

# Created - property

2019

@dbus_annotations(

2020

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

2021

1482

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

2022

1483

def Created_dbus_property(self):

2023

1484

return datetime_to_dbus(self.created)

2024

1485

2025

1486

# LastEnabled - property

2026

1487

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

2027

1488

def LastEnabled_dbus_property(self):

2028

1489

return datetime_to_dbus(self.last_enabled)

2029

1490

2030

1491

# Enabled - property

2031

@dbus_service_property(_interface,

2032

signature="b",

1492

@dbus_service_property(_interface, signature="b",

2033

1493

access="readwrite")

2034

1494

def Enabled_dbus_property(self, value=None):

2035

1495

if value is None: # get

2038

1498

self.enable()

2039

1499

else:

2040

1500

self.disable()

2041

1501

2042

1502

# LastCheckedOK - property

2043

@dbus_service_property(_interface,

2044

signature="s",

1503

@dbus_service_property(_interface, signature="s",

2045

1504

access="readwrite")

2046

1505

def LastCheckedOK_dbus_property(self, value=None):

2047

1506

if value is not None:

2048

1507

self.checked_ok()

2049

1508

return

2050

1509

return datetime_to_dbus(self.last_checked_ok)

2051

1510

2052

1511

# LastCheckerStatus - property

2053

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

1512

@dbus_service_property(_interface, signature="n",

1513

access="read")

2054

1514

def LastCheckerStatus_dbus_property(self):

2055

1515

return dbus.Int16(self.last_checker_status)

2056

1516

2057

1517

# Expires - property

2058

1518

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

2059

1519

def Expires_dbus_property(self):

2060

1520

return datetime_to_dbus(self.expires)

2061

1521

2062

1522

# LastApprovalRequest - property

2063

1523

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

2064

1524

def LastApprovalRequest_dbus_property(self):

2065

1525

return datetime_to_dbus(self.last_approval_request)

2066

1526

2067

1527

# Timeout - property

2068

@dbus_service_property(_interface,

2069

signature="t",

1528

@dbus_service_property(_interface, signature="t",

2070

1529

access="readwrite")

2071

1530

def Timeout_dbus_property(self, value=None):

2072

1531

if value is None: # get

2073

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

1532

return dbus.UInt64(self.timeout_milliseconds())

2074

1533

old_timeout = self.timeout

2075

1534

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

2076

1535

# Reschedule disabling

2084

1543

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

2085

1544

is None):

2086

1545

return

2087

GLib.source_remove(self.disable_initiator_tag)

2088

self.disable_initiator_tag = GLib.timeout_add(

2089

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

2090

self.disable)

2091

1546

gobject.source_remove(self.disable_initiator_tag)

1547

self.disable_initiator_tag = (

1548

gobject.timeout_add(

1549

timedelta_to_milliseconds(self.expires - now),

1550

self.disable))

1551

2092

1552

# ExtendedTimeout - property

2093

@dbus_service_property(_interface,

2094

signature="t",

1553

@dbus_service_property(_interface, signature="t",

2095

1554

access="readwrite")

2096

1555

def ExtendedTimeout_dbus_property(self, value=None):

2097

1556

if value is None: # get

2098

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

2099

* 1000)

1557

return dbus.UInt64(self.extended_timeout_milliseconds())

2100

1558

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

2101

1559

2102

1560

# Interval - property

2103

@dbus_service_property(_interface,

2104

signature="t",

1561

@dbus_service_property(_interface, signature="t",

2105

1562

access="readwrite")

2106

1563

def Interval_dbus_property(self, value=None):

2107

1564

if value is None: # get

2108

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

1565

return dbus.UInt64(self.interval_milliseconds())

2109

1566

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

2110

1567

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

2111

1568

return

2112

1569

if self.enabled:

2113

1570

# Reschedule checker run

2114

GLib.source_remove(self.checker_initiator_tag)

2115

self.checker_initiator_tag = GLib.timeout_add(

2116

value, self.start_checker)

2117

self.start_checker() # Start one now, too

2118

1571

gobject.source_remove(self.checker_initiator_tag)

1572

self.checker_initiator_tag = (gobject.timeout_add

1573

(value, self.start_checker))

1574

self.start_checker() # Start one now, too

1575

2119

1576

# Checker - property

2120

@dbus_service_property(_interface,

2121

signature="s",

1577

@dbus_service_property(_interface, signature="s",

2122

1578

access="readwrite")

2123

1579

def Checker_dbus_property(self, value=None):

2124

1580

if value is None: # get

2125

1581

return dbus.String(self.checker_command)

2126

self.checker_command = str(value)

2127

1582

self.checker_command = unicode(value)

1583

2128

1584

# CheckerRunning - property

2129

@dbus_service_property(_interface,

2130

signature="b",

1585

@dbus_service_property(_interface, signature="b",

2131

1586

access="readwrite")

2132

1587

def CheckerRunning_dbus_property(self, value=None):

2133

1588

if value is None: # get

2136

1591

self.start_checker()

2137

1592

else:

2138

1593

self.stop_checker()

2139

1594

2140

1595

# ObjectPath - property

2141

@dbus_annotations(

2142

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

2143

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

2144

1596

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

2145

1597

def ObjectPath_dbus_property(self):

2146

return self.dbus_object_path # is already a dbus.ObjectPath

2147

1598

return self.dbus_object_path # is already a dbus.ObjectPath

1599

2148

1600

# Secret = property

2149

@dbus_annotations(

2150

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

2151

"invalidates"})

2152

@dbus_service_property(_interface,

2153

signature="ay",

2154

access="write",

2155

byte_arrays=True)

1601

@dbus_service_property(_interface, signature="ay",

1602

access="write", byte_arrays=True)

2156

1603

def Secret_dbus_property(self, value):

2157

self.secret = bytes(value)

2158

1604

self.secret = str(value)

1605

2159

1606

del _interface

2160

1607

2161

1608

2164

1611

self._pipe = child_pipe

2165

1612

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

2166

1613

if not self._pipe.recv():

2167

raise KeyError(fpr)

2168

1614

raise KeyError()

1615

2169

1616

def __getattribute__(self, name):

2170

1617

if name == '_pipe':

2171

1618

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

2174

1621

if data[0] == 'data':

2175

1622

return data[1]

2176

1623

if data[0] == 'function':

2177

2178

1624

def func(*args, **kwargs):

2179

1625

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

2180

1626

return self._pipe.recv()[1]

2181

2182

1627

return func

2183

1628

2184

1629

def __setattr__(self, name, value):

2185

1630

if name == '_pipe':

2186

1631

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

2189

1634

2190

1635

class ClientHandler(socketserver.BaseRequestHandler, object):

2191

1636

"""A class to handle client connections.

2192

1637

2193

1638

Instantiated once for each connection to handle it.

2194

1639

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

2195

1640

2196

1641

def handle(self):

2197

1642

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

2198

1643

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

2199

str(self.client_address))

1644

unicode(self.client_address))

2200

1645

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

2201

1646

self.server.child_pipe.fileno())

2202

2203

session = gnutls.ClientSession(self.request)

2204

2205

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

2206

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

2207

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

2208

# "+DHE-DSS"))

1647

1648

session = (gnutls.connection

1649

.ClientSession(self.request,

1650

gnutls.connection

1651

.X509Credentials()))

1652

1653

# Note: gnutls.connection.X509Credentials is really a

1654

# generic GnuTLS certificate credentials object so long as

1655

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

1656

# here despite using OpenPGP certificates.

1657

1658

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

1659

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

1660

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

1661

# "+DHE-DSS"))

2209

1662

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

2210

1663

priority = self.server.gnutls_priority

2211

1664

if priority is None:

2212

1665

priority = "NORMAL"

2213

gnutls.priority_set_direct(session._c_object,

2214

priority.encode("utf-8"),

2215

None)

2216

1666

(gnutls.library.functions

1667

.gnutls_priority_set_direct(session._c_object,

1668

priority, None))

1669

2217

1670

# Start communication using the Mandos protocol

2218

1671

# Get protocol number

2219

1672

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

2220

1673

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

2221

1674

try:

2222

1675

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

2223

raise RuntimeError(line)

1676

raise RuntimeError

2224

1677

except (ValueError, IndexError, RuntimeError) as error:

2225

1678

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

2226

1679

return

2227

1680

2228

1681

# Start GnuTLS connection

2229

1682

try:

2230

1683

session.handshake()

2231

except gnutls.Error as error:

1684

except gnutls.errors.GNUTLSError as error:

2232

1685

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

2233

1686

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

2234

1687

# established. Just abandon the request.

2235

1688

return

2236

1689

logger.debug("Handshake succeeded")

2237

1690

2238

1691

approval_required = False

2239

1692

try:

2240

1693

try:

2241

fpr = self.fingerprint(

2242

self.peer_certificate(session))

2243

except (TypeError, gnutls.Error) as error:

1694

fpr = self.fingerprint(self.peer_certificate

1695

(session))

1696

except (TypeError,

1697

gnutls.errors.GNUTLSError) as error:

2244

1698

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

2245

1699

return

2246

1700

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

2247

1701

2248

1702

try:

2249

1703

client = ProxyClient(child_pipe, fpr,

2250

1704

self.client_address)

2251

1705

except KeyError:

2252

1706

return

2253

1707

2254

1708

if client.approval_delay:

2255

1709

delay = client.approval_delay

2256

1710

client.approvals_pending += 1

2257

1711

approval_required = True

2258

1712

2259

1713

while True:

2260

1714

if not client.enabled:

2261

1715

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

2262

client.name)

1716

client.name)

2263

1717

if self.server.use_dbus:

2264

1718

# Emit D-Bus signal

2265

1719

client.Rejected("Disabled")

2266

1720

return

2267

1721

2268

1722

if client.approved or not client.approval_delay:

2269

# We are approved or approval is disabled

1723

#We are approved or approval is disabled

2270

1724

break

2271

1725

elif client.approved is None:

2272

1726

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

2274

1728

if self.server.use_dbus:

2275

1729

# Emit D-Bus signal

2276

1730

client.NeedApproval(

2277

client.approval_delay.total_seconds()

2278

* 1000, client.approved_by_default)

1731

client.approval_delay_milliseconds(),

1732

client.approved_by_default)

2279

1733

else:

2280

1734

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

2281

1735

client.name)

2283

1737

# Emit D-Bus signal

2284

1738

client.Rejected("Denied")

2285

1739

return

2286

2287

# wait until timeout or approved

1740

1741

#wait until timeout or approved

2288

1742

time = datetime.datetime.now()

2289

1743

client.changedstate.acquire()

2290

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

1744

client.changedstate.wait(

1745

float(timedelta_to_milliseconds(delay)

1746

/ 1000))

2291

1747

client.changedstate.release()

2292

1748

time2 = datetime.datetime.now()

2293

1749

if (time2 - time) >= delay:

2303

1759

break

2304

1760

else:

2305

1761

delay -= time2 - time

2306

2307

try:

2308

session.send(client.secret)

2309

except gnutls.Error as error:

2310

logger.warning("gnutls send failed",

2311

exc_info=error)

2312

return

2313

1762

1763

sent_size = 0

1764

while sent_size < len(client.secret):

1765

try:

1766

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

1767

except gnutls.errors.GNUTLSError as error:

1768

logger.warning("gnutls send failed",

1769

exc_info=error)

1770

return

1771

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

1772

sent, len(client.secret)

1773

- (sent_size + sent))

1774

sent_size += sent

1775

2314

1776

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

2315

1777

# bump the timeout using extended_timeout

2316

1778

client.bump_timeout(client.extended_timeout)

2317

1779

if self.server.use_dbus:

2318

1780

# Emit D-Bus signal

2319

1781

client.GotSecret()

2320

1782

2321

1783

finally:

2322

1784

if approval_required:

2323

1785

client.approvals_pending -= 1

2324

1786

try:

2325

1787

session.bye()

2326

except gnutls.Error as error:

1788

except gnutls.errors.GNUTLSError as error:

2327

1789

logger.warning("GnuTLS bye failed",

2328

1790

exc_info=error)

2329

1791

2330

1792

@staticmethod

2331

1793

def peer_certificate(session):

2332

1794

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

2333

1795

# If not an OpenPGP certificate...

2334

if (gnutls.certificate_type_get(session._c_object)

2335

!= gnutls.CRT_OPENPGP):

2336

# ...return invalid data

2337

return b""

1796

if (gnutls.library.functions

1797

.gnutls_certificate_type_get(session._c_object)

1798

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1799

# ...do the normal thing

1800

return session.peer_certificate

2338

1801

list_size = ctypes.c_uint(1)

2339

cert_list = (gnutls.certificate_get_peers

1802

cert_list = (gnutls.library.functions

1803

.gnutls_certificate_get_peers

2340

1804

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

2341

1805

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

2342

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

1806

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

1807

" certificate")

2343

1808

if list_size.value == 0:

2344

1809

return None

2345

1810

cert = cert_list[0]

2346

1811

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

2347

1812

2348

1813

@staticmethod

2349

1814

def fingerprint(openpgp):

2350

1815

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2351

1816

# New GnuTLS "datum" with the OpenPGP public key

2352

datum = gnutls.datum_t(

2353

ctypes.cast(ctypes.c_char_p(openpgp),

2354

ctypes.POINTER(ctypes.c_ubyte)),

2355

ctypes.c_uint(len(openpgp)))

1817

datum = (gnutls.library.types

1818

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

1819

ctypes.POINTER

1820

(ctypes.c_ubyte)),

1821

ctypes.c_uint(len(openpgp))))

2356

1822

# New empty GnuTLS certificate

2357

crt = gnutls.openpgp_crt_t()

2358

gnutls.openpgp_crt_init(ctypes.byref(crt))

1823

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1824

(gnutls.library.functions

1825

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2359

1826

# Import the OpenPGP public key into the certificate

2360

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

2361

gnutls.OPENPGP_FMT_RAW)

1827

(gnutls.library.functions

1828

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

1829

gnutls.library.constants

1830

.GNUTLS_OPENPGP_FMT_RAW))

2362

1831

# Verify the self signature in the key

2363

1832

crtverify = ctypes.c_uint()

2364

gnutls.openpgp_crt_verify_self(crt, 0,

2365

ctypes.byref(crtverify))

1833

(gnutls.library.functions

1834

.gnutls_openpgp_crt_verify_self(crt, 0,

1835

ctypes.byref(crtverify)))

2366

1836

if crtverify.value != 0:

2367

gnutls.openpgp_crt_deinit(crt)

2368

raise gnutls.CertificateSecurityError("Verify failed")

1837

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1838

raise (gnutls.errors.CertificateSecurityError

1839

("Verify failed"))

2369

1840

# New buffer for the fingerprint

2370

1841

buf = ctypes.create_string_buffer(20)

2371

1842

buf_len = ctypes.c_size_t()

2372

1843

# Get the fingerprint from the certificate into the buffer

2373

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

2374

ctypes.byref(buf_len))

1844

(gnutls.library.functions

1845

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

1846

ctypes.byref(buf_len)))

2375

1847

# Deinit the certificate

2376

gnutls.openpgp_crt_deinit(crt)

1848

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2377

1849

# Convert the buffer to a Python bytestring

2378

1850

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

2379

1851

# Convert the bytestring to hexadecimal notation

2383

1855

2384

1856

class MultiprocessingMixIn(object):

2385

1857

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

2386

2387

1858

def sub_process_main(self, request, address):

2388

1859

try:

2389

1860

self.finish_request(request, address)

2390

1861

except Exception:

2391

1862

self.handle_error(request, address)

2392

1863

self.close_request(request)

2393

1864

2394

1865

def process_request(self, request, address):

2395

1866

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

2396

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

2397

args=(request, address))

1867

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

1868

args = (request, address))

2398

1869

proc.start()

2399

1870

return proc

2400

1871

2401

1872

2402

1873

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2403

1874

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

2404

2405

1875

def process_request(self, request, client_address):

2406

1876

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

2407

1877

2408

1878

This function creates a new pipe in self.pipe

2409

1879

"""

2410

1880

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2411

1881

2412

1882

proc = MultiprocessingMixIn.process_request(self, request,

2413

1883

client_address)

2414

1884

self.child_pipe.close()

2415

1885

self.add_pipe(parent_pipe, proc)

2416

1886

2417

1887

def add_pipe(self, parent_pipe, proc):

2418

1888

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

2419

raise NotImplementedError()

1889

raise NotImplementedError

2420

1890

2421

1891

2422

1892

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2423

1893

socketserver.TCPServer, object):

2424

1894

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

2425

1895

2426

1896

Attributes:

2427

1897

enabled: Boolean; whether this server is activated yet

2428

1898

interface: None or a network interface name (string)

2429

1899

use_ipv6: Boolean; to use IPv6 or not

2430

1900

"""

2431

2432

1901

def __init__(self, server_address, RequestHandlerClass,

2433

interface=None,

2434

use_ipv6=True,

2435

socketfd=None):

1902

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

2436

1903

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

2437

1904

creating a new one with socket.socket().

2438

1905

"""

2444

1911

self.socketfd = socketfd

2445

1912

# Save the original socket.socket() function

2446

1913

self.socket_socket = socket.socket

2447

2448

1914

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

2449

#

1915

#

2450

1916

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

2451

1917

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

2452

1918

# patching socket.socket.)

2453

#

1919

#

2454

1920

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

2455

1921

@functools.wraps(socket.socket)

2456

1922

def socket_wrapper(*args, **kwargs):

2468

1934

# socket_wrapper(), if socketfd was set.

2469

1935

socketserver.TCPServer.__init__(self, server_address,

2470

1936

RequestHandlerClass)

2471

1937

2472

1938

def server_bind(self):

2473

1939

"""This overrides the normal server_bind() function

2474

1940

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

2475

1941

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

2476

global SO_BINDTODEVICE

2477

1942

if self.interface is not None:

2478

1943

if SO_BINDTODEVICE is None:

2479

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

2480

# common enough.

2481

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

2482

SO_BINDTODEVICE = 25

2483

try:

2484

self.socket.setsockopt(

2485

socket.SOL_SOCKET, SO_BINDTODEVICE,

2486

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

2487

except socket.error as error:

2488

if error.errno == errno.EPERM:

2489

logger.error("No permission to bind to"

2490

" interface %s", self.interface)

2491

elif error.errno == errno.ENOPROTOOPT:

2492

logger.error("SO_BINDTODEVICE not available;"

2493

" cannot bind to interface %s",

2494

self.interface)

2495

elif error.errno == errno.ENODEV:

2496

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

2497

" cannot bind", self.interface)

2498

else:

2499

raise

1944

logger.error("SO_BINDTODEVICE does not exist;"

1945

" cannot bind to interface %s",

1946

self.interface)

1947

else:

1948

try:

1949

self.socket.setsockopt(socket.SOL_SOCKET,

1950

SO_BINDTODEVICE,

1951

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

1952

except socket.error as error:

1953

if error.errno == errno.EPERM:

1954

logger.error("No permission to bind to"

1955

" interface %s", self.interface)

1956

elif error.errno == errno.ENOPROTOOPT:

1957

logger.error("SO_BINDTODEVICE not available;"

1958

" cannot bind to interface %s",

1959

self.interface)

1960

elif error.errno == errno.ENODEV:

1961

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

1962

" cannot bind", self.interface)

1963

else:

1964

raise

2500

1965

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

2501

1966

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

2502

1967

if not self.server_address[0]:

2503

1968

if self.address_family == socket.AF_INET6:

2504

any_address = "::" # in6addr_any

1969

any_address = "::" # in6addr_any

2505

1970

else:

2506

any_address = "0.0.0.0" # INADDR_ANY

1971

any_address = socket.INADDR_ANY

2507

1972

self.server_address = (any_address,

2508

1973

self.server_address[1])

2509

1974

elif not self.server_address[1]:

2510

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

1975

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

1976

0)

2511

1977

# if self.interface:

2512

1978

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

2513

1979

# 0, # port

2519

1985

2520

1986

class MandosServer(IPv6_TCPServer):

2521

1987

"""Mandos server.

2522

1988

2523

1989

Attributes:

2524

1990

clients: set of Client objects

2525

1991

gnutls_priority GnuTLS priority string

2526

1992

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

2527

2528

Assumes a GLib.MainLoop event loop.

1993

1994

Assumes a gobject.MainLoop event loop.

2529

1995

"""

2530

2531

1996

def __init__(self, server_address, RequestHandlerClass,

2532

interface=None,

2533

use_ipv6=True,

2534

clients=None,

2535

gnutls_priority=None,

2536

use_dbus=True,

2537

socketfd=None):

1997

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

1998

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

2538

1999

self.enabled = False

2539

2000

self.clients = clients

2540

2001

if self.clients is None:

2543

2004

self.gnutls_priority = gnutls_priority

2544

2005

IPv6_TCPServer.__init__(self, server_address,

2545

2006

RequestHandlerClass,

2546

interface=interface,

2547

use_ipv6=use_ipv6,

2548

socketfd=socketfd)

2549

2007

interface = interface,

2008

use_ipv6 = use_ipv6,

2009

socketfd = socketfd)

2550

2010

def server_activate(self):

2551

2011

if self.enabled:

2552

2012

return socketserver.TCPServer.server_activate(self)

2553

2013

2554

2014

def enable(self):

2555

2015

self.enabled = True

2556

2016

2557

2017

def add_pipe(self, parent_pipe, proc):

2558

2018

# Call "handle_ipc" for both data and EOF events

2559

GLib.io_add_watch(

2560

parent_pipe.fileno(),

2561

GLib.IO_IN | GLib.IO_HUP,

2562

functools.partial(self.handle_ipc,

2563

parent_pipe=parent_pipe,

2564

proc=proc))

2565

2566

def handle_ipc(self, source, condition,

2567

parent_pipe=None,

2568

proc=None,

2569

client_object=None):

2019

gobject.io_add_watch(parent_pipe.fileno(),

2020

gobject.IO_IN | gobject.IO_HUP,

2021

functools.partial(self.handle_ipc,

2022

parent_pipe =

2023

parent_pipe,

2024

proc = proc))

2025

2026

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

2027

proc = None, client_object=None):

2570

2028

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

2571

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

2029

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

2572

2030

# Wait for other process to exit

2573

2031

proc.join()

2574

2032

return False

2575

2033

2576

2034

# Read a request from the child

2577

2035

request = parent_pipe.recv()

2578

2036

command = request[0]

2579

2037

2580

2038

if command == 'init':

2581

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

2039

fpr = request[1]

2582

2040

address = request[2]

2583

2584

for c in self.clients.values():

2041

2042

for c in self.clients.itervalues():

2585

2043

if c.fingerprint == fpr:

2586

2044

client = c

2587

2045

break

2594

2052

address[0])

2595

2053

parent_pipe.send(False)

2596

2054

return False

2597

2598

GLib.io_add_watch(

2599

parent_pipe.fileno(),

2600

GLib.IO_IN | GLib.IO_HUP,

2601

functools.partial(self.handle_ipc,

2602

parent_pipe=parent_pipe,

2603

proc=proc,

2604

client_object=client))

2055

2056

gobject.io_add_watch(parent_pipe.fileno(),

2057

gobject.IO_IN | gobject.IO_HUP,

2058

functools.partial(self.handle_ipc,

2059

parent_pipe =

2060

parent_pipe,

2061

proc = proc,

2062

client_object =

2063

client))

2605

2064

parent_pipe.send(True)

2606

2065

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

2607

2066

# same fileno

2610

2069

funcname = request[1]

2611

2070

args = request[2]

2612

2071

kwargs = request[3]

2613

2072

2614

2073

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

2615

2074

funcname)(*args,

2616

**kwargs)))

2617

2075

**kwargs)))

2076

2618

2077

if command == 'getattr':

2619

2078

attrname = request[1]

2620

if isinstance(client_object.__getattribute__(attrname),

2621

collections.Callable):

2622

parent_pipe.send(('function', ))

2079

if callable(client_object.__getattribute__(attrname)):

2080

parent_pipe.send(('function',))

2623

2081

else:

2624

parent_pipe.send((

2625

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

2626

2082

parent_pipe.send(('data', client_object

2083

.__getattribute__(attrname)))

2084

2627

2085

if command == 'setattr':

2628

2086

attrname = request[1]

2629

2087

value = request[2]

2630

2088

setattr(client_object, attrname, value)

2631

2089

2632

2090

return True

2633

2091

2634

2092

2635

def rfc3339_duration_to_delta(duration):

2636

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

2637

2638

>>> rfc3339_duration_to_delta("P7D")

2639

datetime.timedelta(7)

2640

>>> rfc3339_duration_to_delta("PT60S")

2641

datetime.timedelta(0, 60)

2642

>>> rfc3339_duration_to_delta("PT60M")

2643

datetime.timedelta(0, 3600)

2644

>>> rfc3339_duration_to_delta("PT24H")

2645

datetime.timedelta(1)

2646

>>> rfc3339_duration_to_delta("P1W")

2647

datetime.timedelta(7)

2648

>>> rfc3339_duration_to_delta("PT5M30S")

2649

datetime.timedelta(0, 330)

2650

>>> rfc3339_duration_to_delta("P1DT3M20S")

2651

datetime.timedelta(1, 200)

2652

"""

2653

2654

# Parsing an RFC 3339 duration with regular expressions is not

2655

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

2656

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

2657

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

2658

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

2659

# avoid excessive use of external libraries.

2660

2661

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

2662

Token = collections.namedtuple("Token", (

2663

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

2664

# a "group" containing digits

2665

"value", # datetime.timedelta or None

2666

"followers")) # Tokens valid after this token

2667

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

2668

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

2669

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

2670

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

2671

datetime.timedelta(seconds=1),

2672

frozenset((token_end, )))

2673

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

2674

datetime.timedelta(minutes=1),

2675

frozenset((token_second, token_end)))

2676

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

2677

datetime.timedelta(hours=1),

2678

frozenset((token_minute, token_end)))

2679

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

2680

None,

2681

frozenset((token_hour, token_minute,

2682

token_second)))

2683

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

2684

datetime.timedelta(days=1),

2685

frozenset((token_time, token_end)))

2686

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

2687

datetime.timedelta(weeks=4),

2688

frozenset((token_day, token_end)))

2689

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

2690

datetime.timedelta(weeks=52),

2691

frozenset((token_month, token_end)))

2692

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

2693

datetime.timedelta(weeks=1),

2694

frozenset((token_end, )))

2695

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

2696

frozenset((token_year, token_month,

2697

token_day, token_time,

2698

token_week)))

2699

# Define starting values:

2700

# Value so far

2701

value = datetime.timedelta()

2702

found_token = None

2703

# Following valid tokens

2704

followers = frozenset((token_duration, ))

2705

# String left to parse

2706

s = duration

2707

# Loop until end token is found

2708

while found_token is not token_end:

2709

# Search for any currently valid tokens

2710

for token in followers:

2711

match = token.regexp.match(s)

2712

if match is not None:

2713

# Token found

2714

if token.value is not None:

2715

# Value found, parse digits

2716

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

2717

# Add to value so far

2718

value += factor * token.value

2719

# Strip token from string

2720

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

2721

# Go to found token

2722

found_token = token

2723

# Set valid next tokens

2724

followers = found_token.followers

2725

break

2726

else:

2727

# No currently valid tokens were found

2728

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

2729

.format(duration))

2730

# End token found

2731

return value

2732

2733

2734

2093

def string_to_delta(interval):

2735

2094

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

2736

2095

2737

2096

>>> string_to_delta('7d')

2738

2097

datetime.timedelta(7)

2739

2098

>>> string_to_delta('60s')

2747

2106

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

2748

2107

datetime.timedelta(0, 330)

2749

2108

"""

2750

2751

try:

2752

return rfc3339_duration_to_delta(interval)

2753

except ValueError:

2754

pass

2755

2756

2109

timevalue = datetime.timedelta(0)

2757

2110

for s in interval.split():

2758

2111

try:

2759

suffix = s[-1]

2112

suffix = unicode(s[-1])

2760

2113

value = int(s[:-1])

2761

2114

if suffix == "d":

2762

2115

delta = datetime.timedelta(value)

2769

2122

elif suffix == "w":

2770

2123

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

2771

2124

else:

2772

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

2773

except IndexError as e:

2125

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

2126

.format(suffix))

2127

except (ValueError, IndexError) as e:

2774

2128

raise ValueError(*(e.args))

2775

2129

timevalue += delta

2776

2130

return timevalue

2777

2131

2778

2132

2779

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

2133

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

2780

2134

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

2781

2135

2782

2136

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

2783

2137

if os.fork():

2784

2138

sys.exit()

2792

2146

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

2793

2147

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

2794

2148

raise OSError(errno.ENODEV,

2795

"{} not a character device"

2149

"{0} not a character device"

2796

2150

.format(os.devnull))

2797

2151

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

2798

2152

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

2802

2156

2803

2157

2804

2158

def main():

2805

2159

2806

2160

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

2807

2161

# Parsing of options, both command line and config file

2808

2162

2809

2163

parser = argparse.ArgumentParser()

2810

2164

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

2811

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

2165

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

2812

2166

help="show version number and exit")

2813

2167

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

2814

2168

help="Bind to interface IF")

2820

2174

help="Run self-test")

2821

2175

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

2822

2176

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

2823

" to terminal", default=None)

2177

" to terminal")

2824

2178

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

2825

2179

help="Debug level for stdout output")

2826

2180

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

2833

2187

" files")

2834

2188

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

2835

2189

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

2836

" system bus interface", default=None)

2190

" system bus interface")

2837

2191

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

2838

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

2839

default=None)

2192

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

2840

2193

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

2841

2194

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

2842

" state", default=None)

2195

" state")

2843

2196

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

2844

2197

help="Specify a file descriptor to a network"

2845

2198

" socket to use instead of creating one")

2846

2199

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

2847

2200

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

2848

2201

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

2849

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

2850

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

2851

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

2852

default=None)

2853

2202

help="Run in foreground")

2203

2854

2204

options = parser.parse_args()

2855

2205

2856

2206

if options.check:

2857

2207

import doctest

2858

fail_count, test_count = doctest.testmod()

2859

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

2860

2208

doctest.testmod()

2209

sys.exit()

2210

2861

2211

# Default values for config file for server-global settings

2862

server_defaults = {"interface": "",

2863

"address": "",

2864

"port": "",

2865

"debug": "False",

2866

"priority":

2867

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

2868

":+SIGN-DSA-SHA256",

2869

"servicename": "Mandos",

2870

"use_dbus": "True",

2871

"use_ipv6": "True",

2872

"debuglevel": "",

2873

"restore": "True",

2874

"socket": "",

2875

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

2876

"foreground": "False",

2877

"zeroconf": "True",

2878

}

2879

2212

server_defaults = { "interface": "",

2213

"address": "",

2214

"port": "",

2215

"debug": "False",

2216

"priority":

2217

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

2218

"servicename": "Mandos",

2219

"use_dbus": "True",

2220

"use_ipv6": "True",

2221

"debuglevel": "",

2222

"restore": "True",

2223

"socket": "",

2224

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

2225

"foreground": "False",

2226

}

2227

2880

2228

# Parse config file for server-global settings

2881

2229

server_config = configparser.SafeConfigParser(server_defaults)

2882

2230

del server_defaults

2883

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

2231

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

2232

"mandos.conf"))

2884

2233

# Convert the SafeConfigParser object to a dict

2885

2234

server_settings = server_config.defaults()

2886

2235

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

2887

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

2888

"foreground", "zeroconf"):

2236

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

2889

2237

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

2890

2238

option)

2891

2239

if server_settings["port"]:

2901

2249

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

2902

2250

["socket"])

2903

2251

del server_config

2904

2252

2905

2253

# Override the settings from the config file with command line

2906

2254

# options, if set.

2907

2255

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

2908

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

2909

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

2910

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

2256

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

2257

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

2258

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

2911

2259

value = getattr(options, option)

2912

2260

if value is not None:

2913

2261

server_settings[option] = value

2914

2262

del options

2915

2263

# Force all strings to be unicode

2916

2264

for option in server_settings.keys():

2917

if isinstance(server_settings[option], bytes):

2918

server_settings[option] = (server_settings[option]

2919

.decode("utf-8"))

2920

# Force all boolean options to be boolean

2921

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

2922

"foreground", "zeroconf"):

2923

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

2265

if type(server_settings[option]) is str:

2266

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

2924

2267

# Debug implies foreground

2925

2268

if server_settings["debug"]:

2926

2269

server_settings["foreground"] = True

2927

2270

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

2928

2271

2929

2272

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

2930

2931

if (not server_settings["zeroconf"]

2932

and not (server_settings["port"]

2933

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

2934

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

2935

2273

2936

2274

# For convenience

2937

2275

debug = server_settings["debug"]

2938

2276

debuglevel = server_settings["debuglevel"]

2941

2279

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

2942

2280

stored_state_file)

2943

2281

foreground = server_settings["foreground"]

2944

zeroconf = server_settings["zeroconf"]

2945

2282

2946

2283

if debug:

2947

2284

initlogger(debug, logging.DEBUG)

2948

2285

else:

2951

2288

else:

2952

2289

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

2953

2290

initlogger(debug, level)

2954

2291

2955

2292

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

2956

syslogger.setFormatter(

2957

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

2958

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

2959

server_settings["servicename"])))

2960

2293

syslogger.setFormatter(logging.Formatter

2294

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

2295

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

2296

.format(server_settings

2297

["servicename"])))

2298

2961

2299

# Parse config file with clients

2962

2300

client_config = configparser.SafeConfigParser(Client

2963

2301

.client_defaults)

2964

2302

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

2965

2303

"clients.conf"))

2966

2304

2967

2305

global mandos_dbus_service

2968

2306

mandos_dbus_service = None

2969

2970

socketfd = None

2971

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

2972

socketfd = server_settings["socket"]

2973

tcp_server = MandosServer(

2974

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

2975

ClientHandler,

2976

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

2977

use_ipv6=use_ipv6,

2978

gnutls_priority=server_settings["priority"],

2979

use_dbus=use_dbus,

2980

socketfd=socketfd)

2307

2308

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

2309

server_settings["port"]),

2310

ClientHandler,

2311

interface=(server_settings["interface"]

2312

or None),

2313

use_ipv6=use_ipv6,

2314

gnutls_priority=

2315

server_settings["priority"],

2316

use_dbus=use_dbus,

2317

socketfd=(server_settings["socket"]

2318

or None))

2981

2319

if not foreground:

2982

pidfilename = "/run/mandos.pid"

2983

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

2984

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

2320

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

2985

2321

pidfile = None

2986

2322

try:

2987

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

2323

pidfile = open(pidfilename, "w")

2988

2324

except IOError as e:

2989

2325

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

2990

2326

exc_info=e)

2991

2992

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

2993

("mandos", "mandos"),

2994

("nobody", "nogroup")):

2327

2328

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

2995

2329

try:

2996

2330

uid = pwd.getpwnam(name).pw_uid

2997

gid = pwd.getpwnam(group).pw_gid

2331

gid = pwd.getpwnam(name).pw_gid

2998

2332

break

2999

2333

except KeyError:

3000

2334

continue

3004

2338

try:

3005

2339

os.setgid(gid)

3006

2340

os.setuid(uid)

3007

if debug:

3008

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

3009

gid))

3010

2341

except OSError as error:

3011

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

3012

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

3013

2342

if error.errno != errno.EPERM:

3014

raise

3015

2343

raise error

2344

3016

2345

if debug:

3017

2346

# Enable all possible GnuTLS debugging

3018

2347

3019

2348

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

3020

2349

# - GnuTLS manual

3021

gnutls.global_set_log_level(11)

3022

3023

@gnutls.log_func

2350

gnutls.library.functions.gnutls_global_set_log_level(11)

2351

2352

@gnutls.library.types.gnutls_log_func

3024

2353

def debug_gnutls(level, string):

3025

2354

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

3026

3027

gnutls.global_set_log_function(debug_gnutls)

3028

2355

2356

(gnutls.library.functions

2357

.gnutls_global_set_log_function(debug_gnutls))

2358

3029

2359

# Redirect stdin so all checkers get /dev/null

3030

2360

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

3031

2361

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

3032

2362

if null > 2:

3033

2363

os.close(null)

3034

2364

3035

2365

# Need to fork before connecting to D-Bus

3036

2366

if not foreground:

3037

2367

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

3038

2368

daemon()

3039

3040

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

3041

# to inform GLib that threads will be used.

3042

GLib.threads_init()

3043

2369

2370

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

2371

# need to inform gobject that threads will be used.

2372

gobject.threads_init()

2373

3044

2374

global main_loop

3045

2375

# From the Avahi example code

3046

2376

DBusGMainLoop(set_as_default=True)

3047

main_loop = GLib.MainLoop()

2377

main_loop = gobject.MainLoop()

3048

2378

bus = dbus.SystemBus()

3049

2379

# End of Avahi example code

3050

2380

if use_dbus:

3051

2381

try:

3052

2382

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

3053

bus,

3054

do_not_queue=True)

3055

old_bus_name = dbus.service.BusName(

3056

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

3057

do_not_queue=True)

3058

except dbus.exceptions.DBusException as e:

2383

bus, do_not_queue=True)

2384

old_bus_name = (dbus.service.BusName

2385

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

2386

do_not_queue=True))

2387

except dbus.exceptions.NameExistsException as e:

3059

2388

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

3060

2389

use_dbus = False

3061

2390

server_settings["use_dbus"] = False

3062

2391

tcp_server.use_dbus = False

3063

if zeroconf:

3064

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3065

service = AvahiServiceToSyslog(

3066

name=server_settings["servicename"],

3067

servicetype="_mandos._tcp",

3068

protocol=protocol,

3069

bus=bus)

3070

if server_settings["interface"]:

3071

service.interface = if_nametoindex(

3072

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

3073

2392

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2393

service = AvahiServiceToSyslog(name =

2394

server_settings["servicename"],

2395

servicetype = "_mandos._tcp",

2396

protocol = protocol, bus = bus)

2397

if server_settings["interface"]:

2398

service.interface = (if_nametoindex

2399

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

2400

3074

2401

global multiprocessing_manager

3075

2402

multiprocessing_manager = multiprocessing.Manager()

3076

2403

3077

2404

client_class = Client

3078

2405

if use_dbus:

3079

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

3080

2406

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

2407

3081

2408

client_settings = Client.config_parser(client_config)

3082

2409

old_client_settings = {}

3083

2410

clients_data = {}

3084

3085

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

3086

global wnull

3087

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

3088

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

3089

# mode

3090

if debug or not foreground:

3091

wnull.close()

3092

2411

3093

2412

# Get client data and settings from last running state.

3094

2413

if server_settings["restore"]:

3095

2414

try:

3096

2415

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

3097

if sys.version_info.major == 2:

3098

clients_data, old_client_settings = pickle.load(

3099

stored_state)

3100

else:

3101

bytes_clients_data, bytes_old_client_settings = (

3102

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

3103

# Fix bytes to strings

3104

# clients_data

3105

# .keys()

3106

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

3107

if isinstance(key, bytes)

3108

else key): value

3109

for key, value in

3110

bytes_clients_data.items()}

3111

del bytes_clients_data

3112

for key in clients_data:

3113

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

3114

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

3115

for k, v in

3116

clients_data[key].items()}

3117

clients_data[key] = value

3118

# .client_structure

3119

value["client_structure"] = [

3120

(s.decode("utf-8")

3121

if isinstance(s, bytes)

3122

else s) for s in

3123

value["client_structure"]]

3124

# .name & .host

3125

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

3126

if isinstance(value[k], bytes):

3127

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

3128

# old_client_settings

3129

# .keys()

3130

old_client_settings = {

3131

(key.decode("utf-8")

3132

if isinstance(key, bytes)

3133

else key): value

3134

for key, value in

3135

bytes_old_client_settings.items()}

3136

del bytes_old_client_settings

3137

# .host

3138

for value in old_client_settings.values():

3139

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

3140

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

3141

.decode("utf-8"))

2416

clients_data, old_client_settings = (pickle.load

2417

(stored_state))

3142

2418

os.remove(stored_state_path)

3143

2419

except IOError as e:

3144

2420

if e.errno == errno.ENOENT:

3145

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

3146

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

2421

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

2422

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

3147

2423

else:

3148

2424

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

3149

2425

exc_info=e)

3150

2426

raise

3151

2427

except EOFError as e:

3152

2428

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

3153

"EOFError:",

3154

exc_info=e)

3155

2429

"EOFError:", exc_info=e)

2430

3156

2431

with PGPEngine() as pgp:

3157

for client_name, client in clients_data.items():

3158

# Skip removed clients

3159

if client_name not in client_settings:

3160

continue

3161

2432

for client_name, client in clients_data.iteritems():

3162

2433

# Decide which value to use after restoring saved state.

3163

2434

# We have three different values: Old config file,

3164

2435

# new config file, and saved state.

3169

2440

# For each value in new config, check if it

3170

2441

# differs from the old config value (Except for

3171

2442

# the "secret" attribute)

3172

if (name != "secret"

3173

and (value !=

3174

old_client_settings[client_name][name])):

2443

if (name != "secret" and

2444

value != old_client_settings[client_name]

2445

[name]):

3175

2446

client[name] = value

3176

2447

except KeyError:

3177

2448

pass

3178

2449

3179

2450

# Clients who has passed its expire date can still be

3180

# enabled if its last checker was successful. A Client

2451

# enabled if its last checker was successful. Clients

3181

2452

# whose checker succeeded before we stored its state is

3182

2453

# assumed to have successfully run all checkers during

3183

2454

# downtime.

3185

2456

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

3186

2457

if not client["last_checked_ok"]:

3187

2458

logger.warning(

3188

"disabling client {} - Client never "

3189

"performed a successful checker".format(

3190

client_name))

2459

"disabling client {0} - Client never "

2460

"performed a successful checker"

2461

.format(client_name))

3191

2462

client["enabled"] = False

3192

2463

elif client["last_checker_status"] != 0:

3193

2464

logger.warning(

3194

"disabling client {} - Client last"

3195

" checker failed with error code"

3196

" {}".format(

3197

client_name,

3198

client["last_checker_status"]))

2465

"disabling client {0} - Client "

2466

"last checker failed with error code {1}"

2467

.format(client_name,

2468

client["last_checker_status"]))

3199

2469

client["enabled"] = False

3200

2470

else:

3201

client["expires"] = (

3202

datetime.datetime.utcnow()

3203

+ client["timeout"])

2471

client["expires"] = (datetime.datetime

2472

.utcnow()

2473

+ client["timeout"])

3204

2474

logger.debug("Last checker succeeded,"

3205

" keeping {} enabled".format(

3206

client_name))

2475

" keeping {0} enabled"

2476

.format(client_name))

3207

2477

try:

3208

client["secret"] = pgp.decrypt(

3209

client["encrypted_secret"],

3210

client_settings[client_name]["secret"])

2478

client["secret"] = (

2479

pgp.decrypt(client["encrypted_secret"],

2480

client_settings[client_name]

2481

["secret"]))

3211

2482

except PGPError:

3212

2483

# If decryption fails, we use secret from new settings

3213

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

3214

client_name))

3215

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

3216

["secret"])

3217

2484

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

2485

.format(client_name))

2486

client["secret"] = (

2487

client_settings[client_name]["secret"])

2488

3218

2489

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

3219

2490

for client_name in (set(old_client_settings)

3220

2491

- set(client_settings)):

3222

2493

for client_name in (set(client_settings)

3223

2494

- set(old_client_settings)):

3224

2495

clients_data[client_name] = client_settings[client_name]

3225

2496

3226

2497

# Create all client objects

3227

for client_name, client in clients_data.items():

2498

for client_name, client in clients_data.iteritems():

3228

2499

tcp_server.clients[client_name] = client_class(

3229

name=client_name,

3230

settings=client,

3231

server_settings=server_settings)

3232

2500

name = client_name, settings = client)

2501

3233

2502

if not tcp_server.clients:

3234

2503

logger.warning("No clients defined")

3235

2504

3236

2505

if not foreground:

3237

2506

if pidfile is not None:

3238

pid = os.getpid()

3239

2507

try:

3240

2508

with pidfile:

3241

print(pid, file=pidfile)

2509

pid = os.getpid()

2510

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

3242

2511

except IOError:

3243

2512

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

3244

2513

pidfilename, pid)

3245

2514

del pidfile

3246

2515

del pidfilename

3247

3248

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

3249

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3250

lambda: main_loop.quit() and False)

3251

2516

2517

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

2518

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

2519

3252

2520

if use_dbus:

3253

3254

@alternate_dbus_interfaces(

3255

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

3256

class MandosDBusService(DBusObjectWithObjectManager):

2521

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

2522

"se.bsnet.fukt.Mandos"})

2523

class MandosDBusService(DBusObjectWithProperties):

3257

2524

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

3258

3259

2525

def __init__(self):

3260

2526

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

3261

3262

2527

_interface = "se.recompile.Mandos"

3263

2528

2529

@dbus_interface_annotations(_interface)

2530

def _foo(self):

2531

return { "org.freedesktop.DBus.Property"

2532

".EmitsChangedSignal":

2533

"false"}

2534

3264

2535

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

3265

2536

def ClientAdded(self, objpath):

3266

2537

"D-Bus signal"

3267

2538

pass

3268

2539

3269

2540

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

3270

2541

def ClientNotFound(self, fingerprint, address):

3271

2542

"D-Bus signal"

3272

2543

pass

3273

3274

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

3275

"true"})

2544

3276

2545

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

3277

2546

def ClientRemoved(self, objpath, name):

3278

2547

"D-Bus signal"

3279

2548

pass

3280

3281

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

3282

"true"})

2549

3283

2550

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

3284

2551

def GetAllClients(self):

3285

2552

"D-Bus method"

3286

return dbus.Array(c.dbus_object_path for c in

3287

tcp_server.clients.values())

3288

3289

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

3290

"true"})

2553

return dbus.Array(c.dbus_object_path

2554

for c in

2555

tcp_server.clients.itervalues())

2556

3291

2557

@dbus.service.method(_interface,

3292

2558

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

3293

2559

def GetAllClientsWithProperties(self):

3294

2560

"D-Bus method"

3295

2561

return dbus.Dictionary(

3296

{c.dbus_object_path: c.GetAll(

3297

"se.recompile.Mandos.Client")

3298

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

2562

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

2563

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

3299

2564

signature="oa{sv}")

3300

2565

3301

2566

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

3302

2567

def RemoveClient(self, object_path):

3303

2568

"D-Bus method"

3304

for c in tcp_server.clients.values():

2569

for c in tcp_server.clients.itervalues():

3305

2570

if c.dbus_object_path == object_path:

3306

2571

del tcp_server.clients[c.name]

3307

2572

c.remove_from_connection()

3308

# Don't signal the disabling

2573

# Don't signal anything except ClientRemoved

3309

2574

c.disable(quiet=True)

3310

# Emit D-Bus signal for removal

3311

self.client_removed_signal(c)

2575

# Emit D-Bus signal

2576

self.ClientRemoved(object_path, c.name)

3312

2577

return

3313

2578

raise KeyError(object_path)

3314

2579

3315

2580

del _interface

3316

3317

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3318

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

3319

def GetManagedObjects(self):

3320

"""D-Bus method"""

3321

return dbus.Dictionary(

3322

{client.dbus_object_path:

3323

dbus.Dictionary(

3324

{interface: client.GetAll(interface)

3325

for interface in

3326

client._get_all_interface_names()})

3327

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

3328

3329

def client_added_signal(self, client):

3330

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

3331

if use_dbus:

3332

# New standard signal

3333

self.InterfacesAdded(

3334

client.dbus_object_path,

3335

dbus.Dictionary(

3336

{interface: client.GetAll(interface)

3337

for interface in

3338

client._get_all_interface_names()}))

3339

# Old signal

3340

self.ClientAdded(client.dbus_object_path)

3341

3342

def client_removed_signal(self, client):

3343

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

3344

if use_dbus:

3345

# New standard signal

3346

self.InterfacesRemoved(

3347

client.dbus_object_path,

3348

client._get_all_interface_names())

3349

# Old signal

3350

self.ClientRemoved(client.dbus_object_path,

3351

client.name)

3352

2581

3353

2582

mandos_dbus_service = MandosDBusService()

3354

3355

# Save modules to variables to exempt the modules from being

3356

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

3357

mp = multiprocessing

3358

wn = wnull

3359

2583

3360

2584

def cleanup():

3361

2585

"Cleanup function; run on exit"

3362

if zeroconf:

3363

service.cleanup()

3364

3365

mp.active_children()

3366

wn.close()

2586

service.cleanup()

2587

2588

multiprocessing.active_children()

3367

2589

if not (tcp_server.clients or client_settings):

3368

2590

return

3369

2591

3370

2592

# Store client before exiting. Secrets are encrypted with key

3371

2593

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

3372

2594

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

3373

2595

clients = {}

3374

2596

with PGPEngine() as pgp:

3375

for client in tcp_server.clients.values():

2597

for client in tcp_server.clients.itervalues():

3376

2598

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

3377

2599

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

3378

2600

key)

3379

2601

client_dict = {}

3380

2602

3381

2603

# A list of attributes that can not be pickled

3382

2604

# + secret.

3383

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

3384

"checker", "server_settings"}

3385

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

3386

.Object):

2605

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

2606

"checker"))

2607

for name, typ in (inspect.getmembers

2608

(dbus.service.Object)):

3387

2609

exclude.add(name)

3388

2610

3389

2611

client_dict["encrypted_secret"] = (client

3390

2612

.encrypted_secret)

3391

2613

for attr in client.client_structure:

3392

2614

if attr not in exclude:

3393

2615

client_dict[attr] = getattr(client, attr)

3394

2616

3395

2617

clients[client.name] = client_dict

3396

2618

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

3397

2619

3398

2620

try:

3399

with tempfile.NamedTemporaryFile(

3400

mode='wb',

3401

suffix=".pickle",

3402

prefix='clients-',

3403

dir=os.path.dirname(stored_state_path),

3404

delete=False) as stored_state:

3405

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

3406

protocol=2)

3407

tempname = stored_state.name

2621

with (tempfile.NamedTemporaryFile

2622

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

2623

dir=os.path.dirname(stored_state_path),

2624

delete=False)) as stored_state:

2625

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

2626

tempname=stored_state.name

3408

2627

os.rename(tempname, stored_state_path)

3409

2628

except (IOError, OSError) as e:

3410

2629

if not debug:

3413

2632

except NameError:

3414

2633

pass

3415

2634

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

3416

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

2635

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

3417

2636

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

3418

2637

else:

3419

2638

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

3420

2639

exc_info=e)

3421

raise

3422

2640

raise e

2641

3423

2642

# Delete all clients, and settings from config

3424

2643

while tcp_server.clients:

3425

2644

name, client = tcp_server.clients.popitem()

3426

2645

if use_dbus:

3427

2646

client.remove_from_connection()

3428

# Don't signal the disabling

2647

# Don't signal anything except ClientRemoved

3429

2648

client.disable(quiet=True)

3430

# Emit D-Bus signal for removal

3431

2649

if use_dbus:

3432

mandos_dbus_service.client_removed_signal(client)

2650

# Emit D-Bus signal

2651

mandos_dbus_service.ClientRemoved(client

2652

.dbus_object_path,

2653

client.name)

3433

2654

client_settings.clear()

3434

2655

3435

2656

atexit.register(cleanup)

3436

3437

for client in tcp_server.clients.values():

2657

2658

for client in tcp_server.clients.itervalues():

3438

2659

if use_dbus:

3439

# Emit D-Bus signal for adding

3440

mandos_dbus_service.client_added_signal(client)

2660

# Emit D-Bus signal

2661

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3441

2662

# Need to initiate checking of clients

3442

2663

if client.enabled:

3443

2664

client.init_checker()

3444

2665

3445

2666

tcp_server.enable()

3446

2667

tcp_server.server_activate()

3447

2668

3448

2669

# Find out what port we got

3449

if zeroconf:

3450

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

2670

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

3451

2671

if use_ipv6:

3452

2672

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

3453

2673

" flowinfo %d, scope_id %d",

3455

2675

else: # IPv4

3456

2676

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

3457

2677

*tcp_server.socket.getsockname())

3458

3459

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

3460

2678

2679

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

2680

3461

2681

try:

3462

if zeroconf:

3463

# From the Avahi example code

3464

try:

3465

service.activate()

3466

except dbus.exceptions.DBusException as error:

3467

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

3468

cleanup()

3469

sys.exit(1)

3470

# End of Avahi example code

3471

3472

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

3473

lambda *args, **kwargs:

3474

(tcp_server.handle_request

3475

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

3476

2682

# From the Avahi example code

2683

try:

2684

service.activate()

2685

except dbus.exceptions.DBusException as error:

2686

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

2687

cleanup()

2688

sys.exit(1)

2689

# End of Avahi example code

2690

2691

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

2692

lambda *args, **kwargs:

2693

(tcp_server.handle_request

2694

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

2695

3477

2696

logger.debug("Starting main loop")

3478

2697

main_loop.run()

3479

2698

except AvahiError as error:

3488

2707

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

3489

2708

cleanup()

3490

2709

3491

3492

2710

if __name__ == '__main__':

3493

2711

main()