/mandos/release : revision 302

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

#

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

19

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

23

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

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

# GNU General Public License for more details.

26

#

26

#

27

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

28

# along with this program. If not, see

29

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

30

#

30

#

31

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

32

#

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

37

from future_builtins import *

41

38

42

try:

43

import SocketServer as socketserver

44

except ImportError:

45

import socketserver

39

import SocketServer as socketserver

46

40

import socket

47

41

import argparse

48

42

import datetime

49

43

import errno

50

try:

51

import ConfigParser as configparser

52

except ImportError:

53

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

54

51

import sys

55

52

import re

56

53

import os

65

62

import struct

66

63

import fcntl

67

64

import functools

68

try:

69

import cPickle as pickle

70

except ImportError:

71

import pickle

65

import cPickle as pickle

72

66

import multiprocessing

73

67

import types

74

68

import binascii

75

69

import tempfile

76

70

import itertools

77

import collections

78

import codecs

79

71

80

72

import dbus

81

73

import dbus.service

82

from gi.repository import GLib

74

import gobject

75

import avahi

83

76

from dbus.mainloop.glib import DBusGMainLoop

84

77

import ctypes

85

78

import ctypes.util

86

79

import xml.dom.minidom

87

80

import inspect

81

import GnuPGInterface

88

82

89

# Try to find the value of SO_BINDTODEVICE:

90

83

try:

91

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

92

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

93

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

94

85

except AttributeError:

95

86

try:

96

# This is where SO_BINDTODEVICE was up to and including Python

97

# 2.6, and also 3.2:

98

87

from IN import SO_BINDTODEVICE

99

88

except ImportError:

100

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

101

# Try running the C preprocessor:

102

try:

103

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

104

"/dev/stdin"],

105

stdin=subprocess.PIPE,

106

stdout=subprocess.PIPE)

107

stdout = cc.communicate(

108

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

109

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

110

except (OSError, ValueError, IndexError):

111

# No value found

112

SO_BINDTODEVICE = None

113

114

if sys.version_info.major == 2:

115

str = unicode

116

117

version = "1.7.13"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.0"

118

92

stored_state_file = "clients.pickle"

119

93

120

94

logger = logging.getLogger()

121

syslogger = None

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

122

98

123

99

try:

124

if_nametoindex = ctypes.cdll.LoadLibrary(

125

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

126

103

except (OSError, AttributeError):

127

128

104

def if_nametoindex(interface):

129

105

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

130

106

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

131

107

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

132

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

133

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

134

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]

135

113

return interface_index

136

114

137

115

138

def copy_function(func):

139

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

140

if sys.version_info.major == 2:

141

return types.FunctionType(func.func_code,

142

func.func_globals,

143

func.func_name,

144

func.func_defaults,

145

func.func_closure)

146

else:

147

return types.FunctionType(func.__code__,

148

func.__globals__,

149

func.__name__,

150

func.__defaults__,

151

func.__closure__)

152

153

154

116

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

155

117

"""init logger and add loglevel"""

156

157

global syslogger

158

syslogger = (logging.handlers.SysLogHandler(

159

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

160

address="/dev/log"))

118

161

119

syslogger.setFormatter(logging.Formatter

162

120

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

163

121

' %(message)s'))

164

122

logger.addHandler(syslogger)

165

123

166

124

if debug:

167

125

console = logging.StreamHandler()

168

126

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

180

138

181

139

class PGPEngine(object):

182

140

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

183

184

141

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

185

143

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

186

self.gpg = "gpg"

187

try:

188

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

189

for line in output.splitlines():

190

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

191

if name == "gpg":

192

self.gpg = path

193

break

194

except OSError as e:

195

if e.errno != errno.ENOENT:

196

raise

197

self.gnupgargs = ['--batch',

198

'--homedir', self.tempdir,

199

'--force-mdc',

200

'--quiet']

201

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

202

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

203

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

204

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

205

151

def __enter__(self):

206

152

return self

207

153

208

154

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

209

155

self._cleanup()

210

156

return False

211

157

212

158

def __del__(self):

213

159

self._cleanup()

214

160

215

161

def _cleanup(self):

216

162

if self.tempdir is not None:

217

163

# Delete contents of tempdir

218

164

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

219

topdown=False):

165

topdown = False):

220

166

for filename in files:

221

167

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

222

168

for dirname in dirs:

224

170

# Remove tempdir

225

171

os.rmdir(self.tempdir)

226

172

self.tempdir = None

227

173

228

174

def password_encode(self, password):

229

175

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

230

176

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

231

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

232

if len(encoded) > 2048:

233

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

234

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

235

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

236

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

237

return encoded

238

177

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

178

239

179

def encrypt(self, data, password):

240

passphrase = self.password_encode(password)

241

with tempfile.NamedTemporaryFile(

242

dir=self.tempdir) as passfile:

243

passfile.write(passphrase)

244

passfile.flush()

245

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

246

'--passphrase-file',

247

passfile.name]

248

+ self.gnupgargs,

249

stdin=subprocess.PIPE,

250

stdout=subprocess.PIPE,

251

stderr=subprocess.PIPE)

252

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

253

if proc.returncode != 0:

254

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

255

194

return ciphertext

256

195

257

196

def decrypt(self, data, password):

258

passphrase = self.password_encode(password)

259

with tempfile.NamedTemporaryFile(

260

dir=self.tempdir) as passfile:

261

passfile.write(passphrase)

262

passfile.flush()

263

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

264

'--passphrase-file',

265

passfile.name]

266

+ self.gnupgargs,

267

stdin=subprocess.PIPE,

268

stdout=subprocess.PIPE,

269

stderr=subprocess.PIPE)

270

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

271

if proc.returncode != 0:

272

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

273

211

return decrypted_plaintext

274

212

275

213

276

# Pretend that we have an Avahi module

277

class Avahi(object):

278

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

279

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

280

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

281

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

282

PROTO_INET = 0 # avahi-common/address.h

283

PROTO_INET6 = 1 # avahi-common/address.h

284

DBUS_NAME = "org.freedesktop.Avahi"

285

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

286

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

287

DBUS_PATH_SERVER = "/"

288

289

def string_array_to_txt_array(self, t):

290

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

291

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

292

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

293

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

294

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

295

SERVER_INVALID = 0 # avahi-common/defs.h

296

SERVER_REGISTERING = 1 # avahi-common/defs.h

297

SERVER_RUNNING = 2 # avahi-common/defs.h

298

SERVER_COLLISION = 3 # avahi-common/defs.h

299

SERVER_FAILURE = 4 # avahi-common/defs.h

300

avahi = Avahi()

301

302

303

214

class AvahiError(Exception):

304

215

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

305

216

self.value = value

306

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

307

**kwargs)

308

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

309

220

310

221

class AvahiServiceError(AvahiError):

311

222

pass

312

223

313

314

224

class AvahiGroupError(AvahiError):

315

225

pass

316

226

317

227

318

228

class AvahiService(object):

319

229

"""An Avahi (Zeroconf) service.

320

230

321

231

Attributes:

322

232

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

323

233

Used to optionally bind to the specified interface.

324

234

name: string; Example: 'Mandos'

325

235

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

326

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

236

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

327

237

port: integer; what port to announce

328

238

TXT: list of strings; TXT record for the service

329

239

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

335

245

server: D-Bus Server

336

246

bus: dbus.SystemBus()

337

247

"""

338

339

def __init__(self,

340

interface=avahi.IF_UNSPEC,

341

name=None,

342

servicetype=None,

343

port=None,

344

TXT=None,

345

domain="",

346

host="",

347

max_renames=32768,

348

protocol=avahi.PROTO_UNSPEC,

349

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

350

253

self.interface = interface

351

254

self.name = name

352

255

self.type = servicetype

361

264

self.server = None

362

265

self.bus = bus

363

266

self.entry_group_state_changed_match = None

364

365

def rename(self, remove=True):

267

268

def rename(self):

366

269

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

367

270

if self.rename_count >= self.max_renames:

368

271

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

369

272

" after %i retries, exiting.",

370

273

self.rename_count)

371

274

raise AvahiServiceError("Too many renames")

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

375

277

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

376

278

self.name)

377

if remove:

378

self.remove()

279

self.remove()

379

280

try:

380

281

self.add()

381

282

except dbus.exceptions.DBusException as error:

382

if (error.get_dbus_name()

383

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

384

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

385

return self.rename(remove=False)

386

else:

387

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

388

self.cleanup()

389

os._exit(1)

390

283

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

284

self.cleanup()

285

os._exit(1)

286

self.rename_count += 1

287

391

288

def remove(self):

392

289

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

393

290

if self.entry_group_state_changed_match is not None:

395

292

self.entry_group_state_changed_match = None

396

293

if self.group is not None:

397

294

self.group.Reset()

398

295

399

296

def add(self):

400

297

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

401

298

self.remove()

418

315

dbus.UInt16(self.port),

419

316

avahi.string_array_to_txt_array(self.TXT))

420

317

self.group.Commit()

421

318

422

319

def entry_group_state_changed(self, state, error):

423

320

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

424

321

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

425

322

426

323

if state == avahi.ENTRY_GROUP_ESTABLISHED:

427

324

logger.debug("Zeroconf service established.")

428

325

elif state == avahi.ENTRY_GROUP_COLLISION:

430

327

self.rename()

431

328

elif state == avahi.ENTRY_GROUP_FAILURE:

432

329

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

433

str(error))

434

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

435

330

unicode(error))

331

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

332

.format(error))

333

436

334

def cleanup(self):

437

335

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

438

336

if self.group is not None:

443

341

pass

444

342

self.group = None

445

343

self.remove()

446

344

447

345

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

448

346

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

449

347

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

450

bad_states = {

451

avahi.SERVER_INVALID: "Zeroconf server invalid",

452

avahi.SERVER_REGISTERING: None,

453

avahi.SERVER_COLLISION: "Zeroconf server name collision",

454

avahi.SERVER_FAILURE: "Zeroconf server failure",

455

}

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

456

355

if state in bad_states:

457

356

if bad_states[state] is not None:

458

357

if error is None:

461

360

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

462

361

self.cleanup()

463

362

elif state == avahi.SERVER_RUNNING:

464

try:

465

self.add()

466

except dbus.exceptions.DBusException as error:

467

if (error.get_dbus_name()

468

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

469

logger.info("Local Zeroconf service name"

470

" collision.")

471

return self.rename(remove=False)

472

else:

473

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

474

self.cleanup()

475

os._exit(1)

363

self.add()

476

364

else:

477

365

if error is None:

478

366

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

479

367

else:

480

368

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

481

369

482

370

def activate(self):

483

371

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

484

372

if self.server is None:

488

376

follow_name_owner_changes=True),

489

377

avahi.DBUS_INTERFACE_SERVER)

490

378

self.server.connect_to_signal("StateChanged",

491

self.server_state_changed)

379

self.server_state_changed)

492

380

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

493

381

494

382

495

383

class AvahiServiceToSyslog(AvahiService):

496

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

384

def rename(self):

497

385

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

498

ret = AvahiService.rename(self, *args, **kwargs)

499

syslogger.setFormatter(logging.Formatter(

500

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

501

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

502

391

return ret

503

392

504

393

505

# Pretend that we have a GnuTLS module

506

class GnuTLS(object):

507

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

508

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

509

510

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

511

if library is None:

512

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

513

_library = ctypes.cdll.LoadLibrary(library)

514

del library

515

_need_version = b"3.3.0"

516

517

def __init__(self):

518

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

519

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

520

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

521

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

522

.format(self._need_version))

523

524

# Unless otherwise indicated, the constants and types below are

525

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

526

527

# Constants

528

E_SUCCESS = 0

529

E_INTERRUPTED = -52

530

E_AGAIN = -28

531

CRT_OPENPGP = 2

532

CLIENT = 2

533

SHUT_RDWR = 0

534

CRD_CERTIFICATE = 1

535

E_NO_CERTIFICATE_FOUND = -49

536

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

537

538

# Types

539

class session_int(ctypes.Structure):

540

_fields_ = []

541

session_t = ctypes.POINTER(session_int)

542

543

class certificate_credentials_st(ctypes.Structure):

544

_fields_ = []

545

certificate_credentials_t = ctypes.POINTER(

546

certificate_credentials_st)

547

certificate_type_t = ctypes.c_int

548

549

class datum_t(ctypes.Structure):

550

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

551

('size', ctypes.c_uint)]

552

553

class openpgp_crt_int(ctypes.Structure):

554

_fields_ = []

555

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

556

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

557

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

558

credentials_type_t = ctypes.c_int

559

transport_ptr_t = ctypes.c_void_p

560

close_request_t = ctypes.c_int

561

562

# Exceptions

563

class Error(Exception):

564

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

565

# exception might be raised from within GnuTLS.__init__,

566

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

567

# global variable has happened.

568

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

569

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

570

# code is passed, convert it to a string with

571

# gnutls.strerror()

572

self.code = code

573

if message is None and code is not None:

574

message = GnuTLS.strerror(code)

575

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

576

message, *args)

577

578

class CertificateSecurityError(Error):

579

pass

580

581

# Classes

582

class Credentials(object):

583

def __init__(self):

584

self._c_object = gnutls.certificate_credentials_t()

585

gnutls.certificate_allocate_credentials(

586

ctypes.byref(self._c_object))

587

self.type = gnutls.CRD_CERTIFICATE

588

589

def __del__(self):

590

gnutls.certificate_free_credentials(self._c_object)

591

592

class ClientSession(object):

593

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

594

self._c_object = gnutls.session_t()

595

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

596

gnutls.set_default_priority(self._c_object)

597

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

598

gnutls.handshake_set_private_extensions(self._c_object,

599

True)

600

self.socket = socket

601

if credentials is None:

602

credentials = gnutls.Credentials()

603

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

604

ctypes.cast(credentials._c_object,

605

ctypes.c_void_p))

606

self.credentials = credentials

607

608

def __del__(self):

609

gnutls.deinit(self._c_object)

610

611

def handshake(self):

612

return gnutls.handshake(self._c_object)

613

614

def send(self, data):

615

data = bytes(data)

616

data_len = len(data)

617

while data_len > 0:

618

data_len -= gnutls.record_send(self._c_object,

619

data[-data_len:],

620

data_len)

621

622

def bye(self):

623

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

624

625

# Error handling functions

626

def _error_code(result):

627

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

628

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

629

if result >= 0:

630

return result

631

if result == gnutls.E_NO_CERTIFICATE_FOUND:

632

raise gnutls.CertificateSecurityError(code=result)

633

raise gnutls.Error(code=result)

634

635

def _retry_on_error(result, func, arguments):

636

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

637

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

638

while result < 0:

639

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

640

return _error_code(result)

641

result = func(*arguments)

642

return result

643

644

# Unless otherwise indicated, the function declarations below are

645

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

646

647

# Functions

648

priority_set_direct = _library.gnutls_priority_set_direct

649

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

650

ctypes.POINTER(ctypes.c_char_p)]

651

priority_set_direct.restype = _error_code

652

653

init = _library.gnutls_init

654

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

655

init.restype = _error_code

656

657

set_default_priority = _library.gnutls_set_default_priority

658

set_default_priority.argtypes = [session_t]

659

set_default_priority.restype = _error_code

660

661

record_send = _library.gnutls_record_send

662

record_send.argtypes = [session_t, ctypes.c_void_p,

663

ctypes.c_size_t]

664

record_send.restype = ctypes.c_ssize_t

665

record_send.errcheck = _retry_on_error

666

667

certificate_allocate_credentials = (

668

_library.gnutls_certificate_allocate_credentials)

669

certificate_allocate_credentials.argtypes = [

670

ctypes.POINTER(certificate_credentials_t)]

671

certificate_allocate_credentials.restype = _error_code

672

673

certificate_free_credentials = (

674

_library.gnutls_certificate_free_credentials)

675

certificate_free_credentials.argtypes = [

676

certificate_credentials_t]

677

certificate_free_credentials.restype = None

678

679

handshake_set_private_extensions = (

680

_library.gnutls_handshake_set_private_extensions)

681

handshake_set_private_extensions.argtypes = [session_t,

682

ctypes.c_int]

683

handshake_set_private_extensions.restype = None

684

685

credentials_set = _library.gnutls_credentials_set

686

credentials_set.argtypes = [session_t, credentials_type_t,

687

ctypes.c_void_p]

688

credentials_set.restype = _error_code

689

690

strerror = _library.gnutls_strerror

691

strerror.argtypes = [ctypes.c_int]

692

strerror.restype = ctypes.c_char_p

693

694

certificate_type_get = _library.gnutls_certificate_type_get

695

certificate_type_get.argtypes = [session_t]

696

certificate_type_get.restype = _error_code

697

698

certificate_get_peers = _library.gnutls_certificate_get_peers

699

certificate_get_peers.argtypes = [session_t,

700

ctypes.POINTER(ctypes.c_uint)]

701

certificate_get_peers.restype = ctypes.POINTER(datum_t)

702

703

global_set_log_level = _library.gnutls_global_set_log_level

704

global_set_log_level.argtypes = [ctypes.c_int]

705

global_set_log_level.restype = None

706

707

global_set_log_function = _library.gnutls_global_set_log_function

708

global_set_log_function.argtypes = [log_func]

709

global_set_log_function.restype = None

710

711

deinit = _library.gnutls_deinit

712

deinit.argtypes = [session_t]

713

deinit.restype = None

714

715

handshake = _library.gnutls_handshake

716

handshake.argtypes = [session_t]

717

handshake.restype = _error_code

718

handshake.errcheck = _retry_on_error

719

720

transport_set_ptr = _library.gnutls_transport_set_ptr

721

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

722

transport_set_ptr.restype = None

723

724

bye = _library.gnutls_bye

725

bye.argtypes = [session_t, close_request_t]

726

bye.restype = _error_code

727

bye.errcheck = _retry_on_error

728

729

check_version = _library.gnutls_check_version

730

check_version.argtypes = [ctypes.c_char_p]

731

check_version.restype = ctypes.c_char_p

732

733

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

734

735

openpgp_crt_init = _library.gnutls_openpgp_crt_init

736

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

737

openpgp_crt_init.restype = _error_code

738

739

openpgp_crt_import = _library.gnutls_openpgp_crt_import

740

openpgp_crt_import.argtypes = [openpgp_crt_t,

741

ctypes.POINTER(datum_t),

742

openpgp_crt_fmt_t]

743

openpgp_crt_import.restype = _error_code

744

745

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

746

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

747

ctypes.POINTER(ctypes.c_uint)]

748

openpgp_crt_verify_self.restype = _error_code

749

750

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

751

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

752

openpgp_crt_deinit.restype = None

753

754

openpgp_crt_get_fingerprint = (

755

_library.gnutls_openpgp_crt_get_fingerprint)

756

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

757

ctypes.c_void_p,

758

ctypes.POINTER(

759

ctypes.c_size_t)]

760

openpgp_crt_get_fingerprint.restype = _error_code

761

762

# Remove non-public functions

763

del _error_code, _retry_on_error

764

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

765

gnutls = GnuTLS()

766

767

768

def call_pipe(connection, # : multiprocessing.Connection

769

func, *args, **kwargs):

770

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

771

772

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

773

return value on the provided multiprocessing.Connection.

774

"""

775

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

776

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

777

399

778

400

779

401

class Client(object):

780

402

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

781

403

782

404

Attributes:

783

405

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

784

406

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

786

408

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

787

409

to see if the client lives.

788

410

'None' if no process is running.

789

checker_callback_tag: a GLib event source tag, or None

411

checker_callback_tag: a gobject event source tag, or None

790

412

checker_command: string; External command which is run to check

791

413

if client lives. %() expansions are done at

792

414

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

793

415

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

794

checker_initiator_tag: a GLib event source tag, or None

416

checker_initiator_tag: a gobject event source tag, or None

795

417

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

796

418

client_structure: Object describing what attributes a client has

797

419

and is used for storing the client at exit

798

420

current_checker_command: string; current running checker_command

799

disable_initiator_tag: a GLib event source tag, or None

421

disable_initiator_tag: a gobject event source tag, or None

800

422

enabled: bool()

801

423

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

802

424

uniquely identify the client

807

429

last_checker_status: integer between 0 and 255 reflecting exit

808

430

status of last checker. -1 reflects crashed

809

431

checker, -2 means no checker completed yet.

810

last_checker_signal: The signal which killed the last checker, if

811

last_checker_status is -1

812

432

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

813

433

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

814

434

D-Bus identifiers

819

439

runtime_expansions: Allowed attributes for runtime expansion.

820

440

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

821

441

disabled, or None

822

server_settings: The server_settings dict from main()

823

442

"""

824

443

825

444

runtime_expansions = ("approval_delay", "approval_duration",

826

445

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

827

446

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

828

447

"last_approval_request", "last_checked_ok",

829

448

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

830

client_defaults = {

831

"timeout": "PT5M",

832

"extended_timeout": "PT15M",

833

"interval": "PT2M",

834

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

835

"host": "",

836

"approval_delay": "PT0S",

837

"approval_duration": "PT1S",

838

"approved_by_default": "True",

839

"enabled": "True",

840

}

841

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

842

475

@staticmethod

843

476

def config_parser(config):

844

477

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

851

484

for client_name in config.sections():

852

485

section = dict(config.items(client_name))

853

486

client = settings[client_name] = {}

854

487

855

488

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

856

489

# Reformat values from string types to Python types

857

490

client["approved_by_default"] = config.getboolean(

858

491

client_name, "approved_by_default")

859

492

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

860

493

"enabled")

861

862

# Uppercase and remove spaces from fingerprint for later

863

# comparison purposes with return value from the

864

# fingerprint() function

494

865

495

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

866

496

.replace(" ", ""))

867

497

if "secret" in section:

868

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

869

.encode("utf-8"),

870

"base64")

498

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

871

499

elif "secfile" in section:

872

500

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

873

501

(section["secfile"])),

874

502

"rb") as secfile:

875

503

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

876

504

else:

877

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

505

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

878

506

.format(section))

879

507

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

880

508

client["extended_timeout"] = string_to_delta(

888

516

client["last_approval_request"] = None

889

517

client["last_checked_ok"] = None

890

518

client["last_checker_status"] = -2

891

519

892

520

return settings

893

894

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

521

522

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

895

523

self.name = name

896

if server_settings is None:

897

server_settings = {}

898

self.server_settings = server_settings

899

524

# adding all client settings

900

for setting, value in settings.items():

525

for setting, value in settings.iteritems():

901

526

setattr(self, setting, value)

902

527

903

528

if self.enabled:

904

529

if not hasattr(self, "last_enabled"):

905

530

self.last_enabled = datetime.datetime.utcnow()

909

534

else:

910

535

self.last_enabled = None

911

536

self.expires = None

912

537

913

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

914

542

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

915

543

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

916

544

datetime.datetime.utcnow())

917

545

918

546

# attributes specific for this server instance

919

547

self.checker = None

920

548

self.checker_initiator_tag = None

923

551

self.current_checker_command = None

924

552

self.approved = None

925

553

self.approvals_pending = 0

926

self.changedstate = multiprocessing_manager.Condition(

927

multiprocessing_manager.Lock())

928

self.client_structure = [attr

929

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

930

559

if not attr.startswith("_")]

931

560

self.client_structure.append("client_structure")

932

933

for name, t in inspect.getmembers(

934

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

935

566

if not name.startswith("_"):

936

567

self.client_structure.append(name)

937

568

938

569

# Send notice to process children that client state has changed

939

570

def send_changedstate(self):

940

571

with self.changedstate:

941

572

self.changedstate.notify_all()

942

573

943

574

def enable(self):

944

575

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

945

576

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

950

581

self.last_enabled = datetime.datetime.utcnow()

951

582

self.init_checker()

952

583

self.send_changedstate()

953

584

954

585

def disable(self, quiet=True):

955

586

"""Disable this client."""

956

587

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

958

589

if not quiet:

959

590

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

960

591

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

961

GLib.source_remove(self.disable_initiator_tag)

592

gobject.source_remove(self.disable_initiator_tag)

962

593

self.disable_initiator_tag = None

963

594

self.expires = None

964

595

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

965

GLib.source_remove(self.checker_initiator_tag)

596

gobject.source_remove(self.checker_initiator_tag)

966

597

self.checker_initiator_tag = None

967

598

self.stop_checker()

968

599

self.enabled = False

969

600

if not quiet:

970

601

self.send_changedstate()

971

# 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

972

603

return False

973

604

974

605

def __del__(self):

975

606

self.disable()

976

607

977

608

def init_checker(self):

978

609

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

979

610

# and every interval from then on.

980

611

if self.checker_initiator_tag is not None:

981

GLib.source_remove(self.checker_initiator_tag)

982

self.checker_initiator_tag = GLib.timeout_add(

983

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

984

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

985

616

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

986

617

if self.disable_initiator_tag is not None:

987

GLib.source_remove(self.disable_initiator_tag)

988

self.disable_initiator_tag = GLib.timeout_add(

989

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

990

622

# Also start a new checker *right now*.

991

623

self.start_checker()

992

993

def checker_callback(self, source, condition, connection,

994

command):

624

625

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

995

626

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

996

627

self.checker_callback_tag = None

997

628

self.checker = None

998

# Read return code from connection (see call_pipe)

999

returncode = connection.recv()

1000

connection.close()

1001

1002

if returncode >= 0:

1003

self.last_checker_status = returncode

1004

self.last_checker_signal = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1005

631

if self.last_checker_status == 0:

1006

632

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

1007

633

vars(self))

1008

634

self.checked_ok()

1009

635

else:

1010

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

636

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

637

vars(self))

1011

638

else:

1012

639

self.last_checker_status = -1

1013

self.last_checker_signal = -returncode

1014

640

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

1015

641

vars(self))

1016

return False

1017

642

1018

643

def checked_ok(self):

1019

644

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

1020

645

self.last_checked_ok = datetime.datetime.utcnow()

1021

646

self.last_checker_status = 0

1022

self.last_checker_signal = None

1023

647

self.bump_timeout()

1024

648

1025

649

def bump_timeout(self, timeout=None):

1026

650

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

1027

651

if timeout is None:

1028

652

timeout = self.timeout

1029

653

if self.disable_initiator_tag is not None:

1030

GLib.source_remove(self.disable_initiator_tag)

654

gobject.source_remove(self.disable_initiator_tag)

1031

655

self.disable_initiator_tag = None

1032

656

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

1033

self.disable_initiator_tag = GLib.timeout_add(

1034

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(timedelta_to_milliseconds

659

(timeout), self.disable))

1035

660

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

1036

661

1037

662

def need_approval(self):

1038

663

self.last_approval_request = datetime.datetime.utcnow()

1039

664

1040

665

def start_checker(self):

1041

666

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

1042

667

1043

668

If a checker already exists, leave it running and do

1044

669

nothing."""

1045

670

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

1050

675

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

1051

676

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

1052

677

# should be.

1053

1054

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

1055

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

1056

self.checker.join()

1057

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)

1058

692

# Start a new checker if needed

1059

693

if self.checker is None:

1060

694

# Escape attributes for the shell

1061

escaped_attrs = {

1062

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

1063

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)

1064

699

try:

1065

700

command = self.checker_command % escaped_attrs

1066

701

except TypeError as error:

1067

702

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

1068

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

1069

718

exc_info=error)

1070

return True # Try again later

1071

self.current_checker_command = command

1072

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

1073

self.name)

1074

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

1075

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

1076

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

1077

# always replaced by /dev/null.)

1078

# The exception is when not debugging but nevertheless

1079

# running in the foreground; use the previously

1080

# created wnull.

1081

popen_args = {"close_fds": True,

1082

"shell": True,

1083

"cwd": "/"}

1084

if (not self.server_settings["debug"]

1085

and self.server_settings["foreground"]):

1086

popen_args.update({"stdout": wnull,

1087

"stderr": wnull})

1088

pipe = multiprocessing.Pipe(duplex=False)

1089

self.checker = multiprocessing.Process(

1090

target=call_pipe,

1091

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

1092

kwargs=popen_args)

1093

self.checker.start()

1094

self.checker_callback_tag = GLib.io_add_watch(

1095

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

1096

self.checker_callback, pipe[0], command)

1097

# 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

1098

730

return True

1099

731

1100

732

def stop_checker(self):

1101

733

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

1102

734

if self.checker_callback_tag:

1103

GLib.source_remove(self.checker_callback_tag)

735

gobject.source_remove(self.checker_callback_tag)

1104

736

self.checker_callback_tag = None

1105

737

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

1106

738

return

1107

739

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

1108

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

1109

748

self.checker = None

1110

749

1111

750

1112

def dbus_service_property(dbus_interface,

1113

signature="v",

1114

access="readwrite",

1115

byte_arrays=False):

751

def dbus_service_property(dbus_interface, signature="v",

752

access="readwrite", byte_arrays=False):

1116

753

"""Decorators for marking methods of a DBusObjectWithProperties to

1117

754

become properties on the D-Bus.

1118

755

1119

756

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

1120

757

and with one argument by "Set".

1121

758

1122

759

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

1123

760

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

1124

761

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

1127

764

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

1128

765

if byte_arrays and signature != "ay":

1129

766

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

1130

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

1131

767

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

1132

768

def decorator(func):

1133

769

func._dbus_is_property = True

1134

770

func._dbus_interface = dbus_interface

1137

773

func._dbus_name = func.__name__

1138

774

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

1139

775

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

1140

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

776

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1141

777

return func

1142

1143

778

return decorator

1144

779

1145

780

1146

781

def dbus_interface_annotations(dbus_interface):

1147

782

"""Decorator for marking functions returning interface annotations

1148

783

1149

784

Usage:

1150

785

1151

786

@dbus_interface_annotations("org.example.Interface")

1152

787

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

1153

788

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

1154

789

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

1155

790

"false"}

1156

791

"""

1157

1158

792

def decorator(func):

1159

793

func._dbus_is_interface = True

1160

794

func._dbus_interface = dbus_interface

1161

795

func._dbus_name = dbus_interface

1162

796

return func

1163

1164

797

return decorator

1165

798

1166

799

1167

800

def dbus_annotations(annotations):

1168

801

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

1169

802

Usage:

1170

1171

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

1172

"org.freedesktop.DBus.Property."

1173

"EmitsChangedSignal": "false"})

803

1174

804

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

1175

805

access="r")

806

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

807

"org.freedesktop.DBus.Property."

808

"EmitsChangedSignal": "false"})

1176

809

def Property_dbus_property(self):

1177

810

return dbus.Boolean(False)

1178

1179

See also the DBusObjectWithAnnotations class.

1180

811

"""

1181

1182

812

def decorator(func):

1183

813

func._dbus_annotations = annotations

1184

814

return func

1185

1186

815

return decorator

1187

816

1188

817

1189

818

class DBusPropertyException(dbus.exceptions.DBusException):

1190

819

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

1191

820

"""

1192

pass

821

def __unicode__(self):

822

return unicode(str(self))

1193

823

1194

824

1195

825

class DBusPropertyAccessException(DBusPropertyException):

1204

834

pass

1205

835

1206

836

1207

class DBusObjectWithAnnotations(dbus.service.Object):

1208

"""A D-Bus object with annotations.

1209

1210

Classes inheriting from this can use the dbus_annotations

1211

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.

1212

843

"""

1213

844

1214

845

@staticmethod

1215

846

def _is_dbus_thing(thing):

1216

847

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

1217

848

1218

849

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

1219

850

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

1220

851

"""

1221

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

852

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

1222

853

False)

1223

854

1224

855

def _get_all_dbus_things(self, thing):

1225

856

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

1226

857

"""

1227

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

858

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

859

name),

1228

860

athing.__get__(self))

1229

861

for cls in self.__class__.__mro__

1230

862

for name, athing in

1231

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

1232

1233

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1234

out_signature="s",

1235

path_keyword='object_path',

1236

connection_keyword='connection')

1237

def Introspect(self, object_path, connection):

1238

"""Overloading of standard D-Bus method.

1239

1240

Inserts annotation tags on methods and signals.

1241

"""

1242

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

1243

connection)

1244

try:

1245

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

1246

1247

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

1248

# Add annotation tags

1249

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

1250

for tag in if_tag.getElementsByTagName(typ):

1251

annots = dict()

1252

for name, prop in (self.

1253

_get_all_dbus_things(typ)):

1254

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

1255

and prop._dbus_interface

1256

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

1257

annots.update(getattr(

1258

prop, "_dbus_annotations", {}))

1259

for name, value in annots.items():

1260

ann_tag = document.createElement(

1261

"annotation")

1262

ann_tag.setAttribute("name", name)

1263

ann_tag.setAttribute("value", value)

1264

tag.appendChild(ann_tag)

1265

# Add interface annotation tags

1266

for annotation, value in dict(

1267

itertools.chain.from_iterable(

1268

annotations().items()

1269

for name, annotations

1270

in self._get_all_dbus_things("interface")

1271

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

1272

)).items():

1273

ann_tag = document.createElement("annotation")

1274

ann_tag.setAttribute("name", annotation)

1275

ann_tag.setAttribute("value", value)

1276

if_tag.appendChild(ann_tag)

1277

# Fix argument name for the Introspect method itself

1278

if (if_tag.getAttribute("name")

1279

== dbus.INTROSPECTABLE_IFACE):

1280

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

1281

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

1282

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

1283

if (arg.getAttribute("direction")

1284

== "out"):

1285

arg.setAttribute("name",

1286

"xml_data")

1287

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

1288

document.unlink()

1289

except (AttributeError, xml.dom.DOMException,

1290

xml.parsers.expat.ExpatError) as error:

1291

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

1292

exc_info=error)

1293

return xmlstring

1294

1295

1296

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1297

"""A D-Bus object with properties.

1298

1299

Classes inheriting from this can use the dbus_service_property

1300

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

1301

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

1302

"""

1303

863

inspect.getmembers(cls,

864

self._is_dbus_thing(thing)))

865

1304

866

def _get_dbus_property(self, interface_name, property_name):

1305

867

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

1306

868

property with the specified name and interface.

1307

869

"""

1308

for cls in self.__class__.__mro__:

1309

for name, value in inspect.getmembers(

1310

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

1311

874

if (value._dbus_name == property_name

1312

875

and value._dbus_interface == interface_name):

1313

876

return value.__get__(self)

1314

877

1315

878

# No such property

1316

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

1317

self.dbus_object_path, interface_name, property_name))

1318

1319

@classmethod

1320

def _get_all_interface_names(cls):

1321

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

1322

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

1323

"_dbus_interface", None)

1324

for x in (inspect.getmro(cls))

1325

for attr in dir(x))

1326

if name is not None)

1327

1328

@dbus.service.method(dbus.PROPERTIES_IFACE,

1329

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

1330

884

out_signature="v")

1331

885

def Get(self, interface_name, property_name):

1332

886

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

1338

892

if not hasattr(value, "variant_level"):

1339

893

return value

1340

894

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

1341

895

1342

896

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

1343

897

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

1344

898

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

1350

904

# The byte_arrays option is not supported yet on

1351

905

# signatures other than "ay".

1352

906

if prop._dbus_signature != "ay":

1353

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

1354

"'ay' signature {!r}"

1355

.format(prop._dbus_signature))

907

raise ValueError

1356

908

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

1357

909

for byte in value))

1358

910

prop(value)

1359

1360

@dbus.service.method(dbus.PROPERTIES_IFACE,

1361

in_signature="s",

911

912

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

1362

913

out_signature="a{sv}")

1363

914

def GetAll(self, interface_name):

1364

915

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

1365

916

standard.

1366

917

1367

918

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

1368

919

"""

1369

920

properties = {}

1379

930

if not hasattr(value, "variant_level"):

1380

931

properties[name] = value

1381

932

continue

1382

properties[name] = type(value)(

1383

value, variant_level=value.variant_level + 1)

933

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

934

value.variant_level+1)

1384

935

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

1385

1386

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

1387

def PropertiesChanged(self, interface_name, changed_properties,

1388

invalidated_properties):

1389

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

1390

standard.

1391

"""

1392

pass

1393

936

1394

937

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1395

938

out_signature="s",

1396

939

path_keyword='object_path',

1397

940

connection_keyword='connection')

1398

941

def Introspect(self, object_path, connection):

1399

942

"""Overloading of standard D-Bus method.

1400

943

1401

944

Inserts property tags and interface annotation tags.

1402

945

"""

1403

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1404

object_path,

1405

connection)

946

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

947

connection)

1406

948

try:

1407

949

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

1408

1409

950

def make_tag(document, name, prop):

1410

951

e = document.createElement("property")

1411

952

e.setAttribute("name", name)

1412

953

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

1413

954

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

1414

955

return e

1415

1416

956

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

1417

957

# Add property tags

1418

958

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

1421

961

if prop._dbus_interface

1422

962

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

1423

963

if_tag.appendChild(tag)

1424

# Add annotation tags for properties

1425

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

1426

annots = dict()

1427

for name, prop in self._get_all_dbus_things(

1428

"property"):

1429

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

1430

and prop._dbus_interface

1431

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

1432

annots.update(getattr(

1433

prop, "_dbus_annotations", {}))

1434

for name, value in annots.items():

1435

ann_tag = document.createElement(

1436

"annotation")

1437

ann_tag.setAttribute("name", name)

1438

ann_tag.setAttribute("value", value)

1439

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)

1440

995

# Add the names to the return values for the

1441

996

# "org.freedesktop.DBus.Properties" methods

1442

997

if (if_tag.getAttribute("name")

1461

1016

return xmlstring

1462

1017

1463

1018

1464

try:

1465

dbus.OBJECT_MANAGER_IFACE

1466

except AttributeError:

1467

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

1468

1469

1470

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1471

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

1472

1473

Classes inheriting from this exposes the standard

1474

GetManagedObjects call and the InterfacesAdded and

1475

InterfacesRemoved signals on the standard

1476

"org.freedesktop.DBus.ObjectManager" interface.

1477

1478

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

1479

manually.

1480

"""

1481

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1482

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

1483

def GetManagedObjects(self):

1484

"""This function must be overridden"""

1485

raise NotImplementedError()

1486

1487

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1488

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

1489

def InterfacesAdded(self, object_path, interfaces_and_properties):

1490

pass

1491

1492

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

1493

def InterfacesRemoved(self, object_path, interfaces):

1494

pass

1495

1496

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1497

out_signature="s",

1498

path_keyword='object_path',

1499

connection_keyword='connection')

1500

def Introspect(self, object_path, connection):

1501

"""Overloading of standard D-Bus method.

1502

1503

Override return argument name of GetManagedObjects to be

1504

"objpath_interfaces_and_properties"

1505

"""

1506

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1507

object_path,

1508

connection)

1509

try:

1510

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

1511

1512

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

1513

# Fix argument name for the GetManagedObjects method

1514

if (if_tag.getAttribute("name")

1515

== dbus.OBJECT_MANAGER_IFACE):

1516

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

1517

if (cn.getAttribute("name")

1518

== "GetManagedObjects"):

1519

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

1520

if (arg.getAttribute("direction")

1521

== "out"):

1522

arg.setAttribute(

1523

"name",

1524

"objpath_interfaces"

1525

"_and_properties")

1526

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

1527

document.unlink()

1528

except (AttributeError, xml.dom.DOMException,

1529

xml.parsers.expat.ExpatError) as error:

1530

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

1531

exc_info=error)

1532

return xmlstring

1533

1534

1535

1019

def datetime_to_dbus(dt, variant_level=0):

1536

1020

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

1537

1021

if dt is None:

1538

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

1539

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)

1540

1025

1541

1026

1542

1027

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1544

1029

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

1545

1030

interface names according to the "alt_interface_names" mapping.

1546

1031

Usage:

1547

1032

1548

1033

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

1549

1034

"net.example.AlternateInterface"})

1550

1035

class SampleDBusObject(dbus.service.Object):

1551

1036

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

1552

1037

def SampleDBusMethod():

1553

1038

pass

1554

1039

1555

1040

The above "SampleDBusMethod" on "SampleDBusObject" will be

1556

1041

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

1557

1042

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

1558

1043

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

1559

1044

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

1560

1045

1561

1046

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

1562

1047

(from DBusObjectWithProperties) and interfaces (from the

1563

1048

dbus_interface_annotations decorator).

1564

1049

"""

1565

1566

1050

def wrapper(cls):

1567

1051

for orig_interface_name, alt_interface_name in (

1568

alt_interface_names.items()):

1052

alt_interface_names.iteritems()):

1569

1053

attr = {}

1570

1054

interface_names = set()

1571

1055

# Go though all attributes of the class

1573

1057

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

1574

1058

# with the wrong interface name

1575

1059

if (not hasattr(attribute, "_dbus_interface")

1576

or not attribute._dbus_interface.startswith(

1577

orig_interface_name)):

1060

or not attribute._dbus_interface

1061

.startswith(orig_interface_name)):

1578

1062

continue

1579

1063

# Create an alternate D-Bus interface name based on

1580

1064

# the current name

1581

alt_interface = attribute._dbus_interface.replace(

1582

orig_interface_name, alt_interface_name)

1065

alt_interface = (attribute._dbus_interface

1066

.replace(orig_interface_name,

1067

alt_interface_name))

1583

1068

interface_names.add(alt_interface)

1584

1069

# Is this a D-Bus signal?

1585

1070

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

1586

# Extract the original non-method undecorated

1587

# function by black magic

1588

if sys.version_info.major == 2:

1589

nonmethod_func = (dict(

1071

# Extract the original non-method function by

1072

# black magic

1073

nonmethod_func = (dict(

1590

1074

zip(attribute.func_code.co_freevars,

1591

attribute.__closure__))

1592

["func"].cell_contents)

1593

else:

1594

nonmethod_func = (dict(

1595

zip(attribute.__code__.co_freevars,

1596

attribute.__closure__))

1597

["func"].cell_contents)

1075

attribute.__closure__))["func"]

1076

.cell_contents)

1598

1077

# Create a new, but exactly alike, function

1599

1078

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

1600

1079

# with the alternate D-Bus interface name

1601

new_function = copy_function(nonmethod_func)

1602

new_function = (dbus.service.signal(

1603

alt_interface,

1604

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

1605

1089

# Copy annotations, if any

1606

1090

try:

1607

new_function._dbus_annotations = dict(

1608

attribute._dbus_annotations)

1091

new_function._dbus_annotations = (

1092

dict(attribute._dbus_annotations))

1609

1093

except AttributeError:

1610

1094

pass

1611

1612

1095

# Define a creator of a function to call both the

1613

1096

# original and alternate functions, so both the

1614

1097

# original and alternate signals gets sent when

1617

1100

"""This function is a scope container to pass

1618

1101

func1 and func2 to the "call_both" function

1619

1102

outside of its arguments"""

1620

1621

@functools.wraps(func2)

1622

1103

def call_both(*args, **kwargs):

1623

1104

"""This function will emit two D-Bus

1624

1105

signals by calling func1 and func2"""

1625

1106

func1(*args, **kwargs)

1626

1107

func2(*args, **kwargs)

1627

# Make wrapper function look like a D-Bus

1628

# signal

1629

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

1630

if name.startswith("_dbus_"):

1631

setattr(call_both, name, attr)

1632

1633

1108

return call_both

1634

1109

# Create the "call_both" function and add it to

1635

1110

# the class

1640

1115

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

1641

1116

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

1642

1117

# to the class.

1643

attr[attrname] = (

1644

dbus.service.method(

1645

alt_interface,

1646

attribute._dbus_in_signature,

1647

attribute._dbus_out_signature)

1648

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

1649

1128

# Copy annotations, if any

1650

1129

try:

1651

attr[attrname]._dbus_annotations = dict(

1652

attribute._dbus_annotations)

1130

attr[attrname]._dbus_annotations = (

1131

dict(attribute._dbus_annotations))

1653

1132

except AttributeError:

1654

1133

pass

1655

1134

# Is this a D-Bus property?

1658

1137

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

1659

1138

# property with the alternate D-Bus interface

1660

1139

# name. Add it to the class.

1661

attr[attrname] = (dbus_service_property(

1662

alt_interface, attribute._dbus_signature,

1663

attribute._dbus_access,

1664

attribute._dbus_get_args_options

1665

["byte_arrays"])

1666

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

1667

1153

# Copy annotations, if any

1668

1154

try:

1669

attr[attrname]._dbus_annotations = dict(

1670

attribute._dbus_annotations)

1155

attr[attrname]._dbus_annotations = (

1156

dict(attribute._dbus_annotations))

1671

1157

except AttributeError:

1672

1158

pass

1673

1159

# Is this a D-Bus interface?

1676

1162

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

1677

1163

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

1678

1164

# to the class.

1679

attr[attrname] = (

1680

dbus_interface_annotations(alt_interface)

1681

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

1682

1173

if deprecate:

1683

1174

# Deprecate all alternate interfaces

1684

iname = "_AlternateDBusNames_interface_annotation{}"

1175

iname="_AlternateDBusNames_interface_annotation{0}"

1685

1176

for interface_name in interface_names:

1686

1687

1177

@dbus_interface_annotations(interface_name)

1688

1178

def func(self):

1689

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

1690

"true"}

1179

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

1180

"true" }

1691

1181

# Find an unused name

1692

1182

for aname in (iname.format(i)

1693

1183

for i in itertools.count()):

1697

1187

if interface_names:

1698

1188

# Replace the class with a new subclass of it with

1699

1189

# methods, signals, etc. as created above.

1700

if sys.version_info.major == 2:

1701

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

1702

(cls, ), attr)

1703

else:

1704

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

1705

(cls, ), attr)

1190

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

1191

(cls,), attr)

1706

1192

return cls

1707

1708

1193

return wrapper

1709

1194

1710

1195

1711

1196

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

1712

"se.bsnet.fukt.Mandos"})

1197

"se.bsnet.fukt.Mandos"})

1713

1198

class ClientDBus(Client, DBusObjectWithProperties):

1714

1199

"""A Client class using D-Bus

1715

1200

1716

1201

Attributes:

1717

1202

dbus_object_path: dbus.ObjectPath

1718

1203

bus: dbus.SystemBus()

1719

1204

"""

1720

1205

1721

1206

runtime_expansions = (Client.runtime_expansions

1722

+ ("dbus_object_path", ))

1723

1724

_interface = "se.recompile.Mandos.Client"

1725

1207

+ ("dbus_object_path",))

1208

1726

1209

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

1727

1728

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

1210

1211

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

1729

1212

self.bus = bus

1730

1213

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

1731

1214

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

1732

1215

# the D-Bus

1733

client_object_name = str(self.name).translate(

1216

client_object_name = unicode(self.name).translate(

1734

1217

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

1735

1218

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

1736

self.dbus_object_path = dbus.ObjectPath(

1737

"/clients/" + client_object_name)

1219

self.dbus_object_path = (dbus.ObjectPath

1220

("/clients/" + client_object_name))

1738

1221

DBusObjectWithProperties.__init__(self, self.bus,

1739

1222

self.dbus_object_path)

1740

1741

def notifychangeproperty(transform_func, dbus_name,

1742

type_func=lambda x: x,

1743

variant_level=1,

1744

invalidate_only=False,

1745

_interface=_interface):

1223

1224

def notifychangeproperty(transform_func,

1225

dbus_name, type_func=lambda x: x,

1226

variant_level=1):

1746

1227

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

1747

1228

its changes to DBus.

1748

1229

1749

1230

transform_fun: Function that takes a value and a variant_level

1750

1231

and transforms it to a D-Bus type.

1751

1232

dbus_name: D-Bus name of the variable

1753

1234

to the D-Bus. Default: no transform

1754

1235

variant_level: D-Bus variant level. Default: 1

1755

1236

"""

1756

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

1757

1237

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

1758

1238

def setter(self, value):

1759

1239

if hasattr(self, "dbus_object_path"):

1760

1240

if (not hasattr(self, attrname) or

1761

1241

type_func(getattr(self, attrname, None))

1762

1242

!= type_func(value)):

1763

if invalidate_only:

1764

self.PropertiesChanged(

1765

_interface, dbus.Dictionary(),

1766

dbus.Array((dbus_name, )))

1767

else:

1768

dbus_value = transform_func(

1769

type_func(value),

1770

variant_level=variant_level)

1771

self.PropertyChanged(dbus.String(dbus_name),

1772

dbus_value)

1773

self.PropertiesChanged(

1774

_interface,

1775

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

1776

dbus_value}),

1777

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)

1778

1248

setattr(self, attrname, value)

1779

1249

1780

1250

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

1781

1251

1782

1252

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1783

1253

approvals_pending = notifychangeproperty(dbus.Boolean,

1784

1254

"ApprovalPending",

1785

type_func=bool)

1255

type_func = bool)

1786

1256

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

1787

1257

last_enabled = notifychangeproperty(datetime_to_dbus,

1788

1258

"LastEnabled")

1789

checker = notifychangeproperty(

1790

dbus.Boolean, "CheckerRunning",

1791

type_func=lambda checker: checker is not None)

1259

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

1260

type_func = lambda checker:

1261

checker is not None)

1792

1262

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1793

1263

"LastCheckedOK")

1794

1264

last_checker_status = notifychangeproperty(dbus.Int16,

1797

1267

datetime_to_dbus, "LastApprovalRequest")

1798

1268

approved_by_default = notifychangeproperty(dbus.Boolean,

1799

1269

"ApprovedByDefault")

1800

approval_delay = notifychangeproperty(

1801

dbus.UInt64, "ApprovalDelay",

1802

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

1270

approval_delay = notifychangeproperty(dbus.UInt64,

1271

"ApprovalDelay",

1272

type_func =

1273

timedelta_to_milliseconds)

1803

1274

approval_duration = notifychangeproperty(

1804

1275

dbus.UInt64, "ApprovalDuration",

1805

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

1276

type_func = timedelta_to_milliseconds)

1806

1277

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

1807

timeout = notifychangeproperty(

1808

dbus.UInt64, "Timeout",

1809

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

1278

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

1279

type_func =

1280

timedelta_to_milliseconds)

1810

1281

extended_timeout = notifychangeproperty(

1811

1282

dbus.UInt64, "ExtendedTimeout",

1812

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

1813

interval = notifychangeproperty(

1814

dbus.UInt64, "Interval",

1815

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)

1816

1288

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

1817

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

1818

invalidate_only=True)

1819

1289

1820

1290

del notifychangeproperty

1821

1291

1822

1292

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

1823

1293

try:

1824

1294

self.remove_from_connection()

1827

1297

if hasattr(DBusObjectWithProperties, "__del__"):

1828

1298

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

1829

1299

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

1830

1831

def checker_callback(self, source, condition,

1832

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

1833

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

1834

connection, command, *args,

1835

**kwargs)

1836

exitstatus = self.last_checker_status

1837

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)

1838

1307

# Emit D-Bus signal

1839

1308

self.CheckerCompleted(dbus.Int16(exitstatus),

1840

# This is specific to GNU libC

1841

dbus.Int64(exitstatus << 8),

1309

dbus.Int64(condition),

1842

1310

dbus.String(command))

1843

1311

else:

1844

1312

# Emit D-Bus signal

1845

1313

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

1846

dbus.Int64(

1847

# This is specific to GNU libC

1848

(exitstatus << 8)

1849

| self.last_checker_signal),

1314

dbus.Int64(condition),

1850

1315

dbus.String(command))

1851

return ret

1852

1316

1317

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

1318

*args, **kwargs)

1319

1853

1320

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

1854

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

1855

1326

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

1856

1327

# Only if new checker process was started

1857

1328

if (self.checker is not None

1859

1330

# Emit D-Bus signal

1860

1331

self.CheckerStarted(self.current_checker_command)

1861

1332

return r

1862

1333

1863

1334

def _reset_approved(self):

1864

1335

self.approved = None

1865

1336

return False

1866

1337

1867

1338

def approve(self, value=True):

1868

1339

self.approved = value

1869

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

1870

* 1000), self._reset_approved)

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1871

1343

self.send_changedstate()

1872

1873

# D-Bus methods, signals & properties

1874

1875

# Interfaces

1876

1877

# Signals

1878

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

1879

1357

# CheckerCompleted - signal

1880

1358

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

1881

1359

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

1882

1360

"D-Bus signal"

1883

1361

pass

1884

1362

1885

1363

# CheckerStarted - signal

1886

1364

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

1887

1365

def CheckerStarted(self, command):

1888

1366

"D-Bus signal"

1889

1367

pass

1890

1368

1891

1369

# PropertyChanged - signal

1892

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

1893

1370

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

1894

1371

def PropertyChanged(self, property, value):

1895

1372

"D-Bus signal"

1896

1373

pass

1897

1374

1898

1375

# GotSecret - signal

1899

1376

@dbus.service.signal(_interface)

1900

1377

def GotSecret(self):

1903

1380

server to mandos-client

1904

1381

"""

1905

1382

pass

1906

1383

1907

1384

# Rejected - signal

1908

1385

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

1909

1386

def Rejected(self, reason):

1910

1387

"D-Bus signal"

1911

1388

pass

1912

1389

1913

1390

# NeedApproval - signal

1914

1391

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

1915

1392

def NeedApproval(self, timeout, default):

1916

1393

"D-Bus signal"

1917

1394

return self.need_approval()

1918

1919

# Methods

1920

1395

1396

## Methods

1397

1921

1398

# Approve - method

1922

1399

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

1923

1400

def Approve(self, value):

1924

1401

self.approve(value)

1925

1402

1926

1403

# CheckedOK - method

1927

1404

@dbus.service.method(_interface)

1928

1405

def CheckedOK(self):

1929

1406

self.checked_ok()

1930

1407

1931

1408

# Enable - method

1932

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

1933

1409

@dbus.service.method(_interface)

1934

1410

def Enable(self):

1935

1411

"D-Bus method"

1936

1412

self.enable()

1937

1413

1938

1414

# StartChecker - method

1939

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

1940

1415

@dbus.service.method(_interface)

1941

1416

def StartChecker(self):

1942

1417

"D-Bus method"

1943

1418

self.start_checker()

1944

1419

1945

1420

# Disable - method

1946

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

1947

1421

@dbus.service.method(_interface)

1948

1422

def Disable(self):

1949

1423

"D-Bus method"

1950

1424

self.disable()

1951

1425

1952

1426

# StopChecker - method

1953

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

1954

1427

@dbus.service.method(_interface)

1955

1428

def StopChecker(self):

1956

1429

self.stop_checker()

1957

1958

# Properties

1959

1430

1431

## Properties

1432

1960

1433

# ApprovalPending - property

1961

1434

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

1962

1435

def ApprovalPending_dbus_property(self):

1963

1436

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

1964

1437

1965

1438

# ApprovedByDefault - property

1966

@dbus_service_property(_interface,

1967

signature="b",

1439

@dbus_service_property(_interface, signature="b",

1968

1440

access="readwrite")

1969

1441

def ApprovedByDefault_dbus_property(self, value=None):

1970

1442

if value is None: # get

1971

1443

return dbus.Boolean(self.approved_by_default)

1972

1444

self.approved_by_default = bool(value)

1973

1445

1974

1446

# ApprovalDelay - property

1975

@dbus_service_property(_interface,

1976

signature="t",

1447

@dbus_service_property(_interface, signature="t",

1977

1448

access="readwrite")

1978

1449

def ApprovalDelay_dbus_property(self, value=None):

1979

1450

if value is None: # get

1980

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

1981

* 1000)

1451

return dbus.UInt64(self.approval_delay_milliseconds())

1982

1452

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

1983

1453

1984

1454

# ApprovalDuration - property

1985

@dbus_service_property(_interface,

1986

signature="t",

1455

@dbus_service_property(_interface, signature="t",

1987

1456

access="readwrite")

1988

1457

def ApprovalDuration_dbus_property(self, value=None):

1989

1458

if value is None: # get

1990

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

1991

* 1000)

1459

return dbus.UInt64(timedelta_to_milliseconds(

1460

self.approval_duration))

1992

1461

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

1993

1462

1994

1463

# Name - property

1995

@dbus_annotations(

1996

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

1997

1464

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

1998

1465

def Name_dbus_property(self):

1999

1466

return dbus.String(self.name)

2000

1467

2001

1468

# Fingerprint - property

2002

@dbus_annotations(

2003

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

2004

1469

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

2005

1470

def Fingerprint_dbus_property(self):

2006

1471

return dbus.String(self.fingerprint)

2007

1472

2008

1473

# Host - property

2009

@dbus_service_property(_interface,

2010

signature="s",

1474

@dbus_service_property(_interface, signature="s",

2011

1475

access="readwrite")

2012

1476

def Host_dbus_property(self, value=None):

2013

1477

if value is None: # get

2014

1478

return dbus.String(self.host)

2015

self.host = str(value)

2016

1479

self.host = unicode(value)

1480

2017

1481

# Created - property

2018

@dbus_annotations(

2019

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

2020

1482

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

2021

1483

def Created_dbus_property(self):

2022

1484

return datetime_to_dbus(self.created)

2023

1485

2024

1486

# LastEnabled - property

2025

1487

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

2026

1488

def LastEnabled_dbus_property(self):

2027

1489

return datetime_to_dbus(self.last_enabled)

2028

1490

2029

1491

# Enabled - property

2030

@dbus_service_property(_interface,

2031

signature="b",

1492

@dbus_service_property(_interface, signature="b",

2032

1493

access="readwrite")

2033

1494

def Enabled_dbus_property(self, value=None):

2034

1495

if value is None: # get

2037

1498

self.enable()

2038

1499

else:

2039

1500

self.disable()

2040

1501

2041

1502

# LastCheckedOK - property

2042

@dbus_service_property(_interface,

2043

signature="s",

1503

@dbus_service_property(_interface, signature="s",

2044

1504

access="readwrite")

2045

1505

def LastCheckedOK_dbus_property(self, value=None):

2046

1506

if value is not None:

2047

1507

self.checked_ok()

2048

1508

return

2049

1509

return datetime_to_dbus(self.last_checked_ok)

2050

1510

2051

1511

# LastCheckerStatus - property

2052

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

1512

@dbus_service_property(_interface, signature="n",

1513

access="read")

2053

1514

def LastCheckerStatus_dbus_property(self):

2054

1515

return dbus.Int16(self.last_checker_status)

2055

1516

2056

1517

# Expires - property

2057

1518

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

2058

1519

def Expires_dbus_property(self):

2059

1520

return datetime_to_dbus(self.expires)

2060

1521

2061

1522

# LastApprovalRequest - property

2062

1523

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

2063

1524

def LastApprovalRequest_dbus_property(self):

2064

1525

return datetime_to_dbus(self.last_approval_request)

2065

1526

2066

1527

# Timeout - property

2067

@dbus_service_property(_interface,

2068

signature="t",

1528

@dbus_service_property(_interface, signature="t",

2069

1529

access="readwrite")

2070

1530

def Timeout_dbus_property(self, value=None):

2071

1531

if value is None: # get

2072

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

1532

return dbus.UInt64(self.timeout_milliseconds())

2073

1533

old_timeout = self.timeout

2074

1534

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

2075

1535

# Reschedule disabling

2083

1543

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

2084

1544

is None):

2085

1545

return

2086

GLib.source_remove(self.disable_initiator_tag)

2087

self.disable_initiator_tag = GLib.timeout_add(

2088

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

2089

self.disable)

2090

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

2091

1552

# ExtendedTimeout - property

2092

@dbus_service_property(_interface,

2093

signature="t",

1553

@dbus_service_property(_interface, signature="t",

2094

1554

access="readwrite")

2095

1555

def ExtendedTimeout_dbus_property(self, value=None):

2096

1556

if value is None: # get

2097

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

2098

* 1000)

1557

return dbus.UInt64(self.extended_timeout_milliseconds())

2099

1558

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

2100

1559

2101

1560

# Interval - property

2102

@dbus_service_property(_interface,

2103

signature="t",

1561

@dbus_service_property(_interface, signature="t",

2104

1562

access="readwrite")

2105

1563

def Interval_dbus_property(self, value=None):

2106

1564

if value is None: # get

2107

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

1565

return dbus.UInt64(self.interval_milliseconds())

2108

1566

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

2109

1567

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

2110

1568

return

2111

1569

if self.enabled:

2112

1570

# Reschedule checker run

2113

GLib.source_remove(self.checker_initiator_tag)

2114

self.checker_initiator_tag = GLib.timeout_add(

2115

value, self.start_checker)

2116

self.start_checker() # Start one now, too

2117

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

2118

1576

# Checker - property

2119

@dbus_service_property(_interface,

2120

signature="s",

1577

@dbus_service_property(_interface, signature="s",

2121

1578

access="readwrite")

2122

1579

def Checker_dbus_property(self, value=None):

2123

1580

if value is None: # get

2124

1581

return dbus.String(self.checker_command)

2125

self.checker_command = str(value)

2126

1582

self.checker_command = unicode(value)

1583

2127

1584

# CheckerRunning - property

2128

@dbus_service_property(_interface,

2129

signature="b",

1585

@dbus_service_property(_interface, signature="b",

2130

1586

access="readwrite")

2131

1587

def CheckerRunning_dbus_property(self, value=None):

2132

1588

if value is None: # get

2135

1591

self.start_checker()

2136

1592

else:

2137

1593

self.stop_checker()

2138

1594

2139

1595

# ObjectPath - property

2140

@dbus_annotations(

2141

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

2142

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

2143

1596

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

2144

1597

def ObjectPath_dbus_property(self):

2145

return self.dbus_object_path # is already a dbus.ObjectPath

2146

1598

return self.dbus_object_path # is already a dbus.ObjectPath

1599

2147

1600

# Secret = property

2148

@dbus_annotations(

2149

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

2150

"invalidates"})

2151

@dbus_service_property(_interface,

2152

signature="ay",

2153

access="write",

2154

byte_arrays=True)

1601

@dbus_service_property(_interface, signature="ay",

1602

access="write", byte_arrays=True)

2155

1603

def Secret_dbus_property(self, value):

2156

self.secret = bytes(value)

2157

1604

self.secret = str(value)

1605

2158

1606

del _interface

2159

1607

2160

1608

2163

1611

self._pipe = child_pipe

2164

1612

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

2165

1613

if not self._pipe.recv():

2166

raise KeyError(fpr)

2167

1614

raise KeyError()

1615

2168

1616

def __getattribute__(self, name):

2169

1617

if name == '_pipe':

2170

1618

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

2173

1621

if data[0] == 'data':

2174

1622

return data[1]

2175

1623

if data[0] == 'function':

2176

2177

1624

def func(*args, **kwargs):

2178

1625

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

2179

1626

return self._pipe.recv()[1]

2180

2181

1627

return func

2182

1628

2183

1629

def __setattr__(self, name, value):

2184

1630

if name == '_pipe':

2185

1631

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

2188

1634

2189

1635

class ClientHandler(socketserver.BaseRequestHandler, object):

2190

1636

"""A class to handle client connections.

2191

1637

2192

1638

Instantiated once for each connection to handle it.

2193

1639

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

2194

1640

2195

1641

def handle(self):

2196

1642

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

2197

1643

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

2198

str(self.client_address))

1644

unicode(self.client_address))

2199

1645

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

2200

1646

self.server.child_pipe.fileno())

2201

2202

session = gnutls.ClientSession(self.request)

2203

2204

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

2205

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

2206

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

2207

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

2208

1662

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

2209

1663

priority = self.server.gnutls_priority

2210

1664

if priority is None:

2211

1665

priority = "NORMAL"

2212

gnutls.priority_set_direct(session._c_object,

2213

priority.encode("utf-8"),

2214

None)

2215

1666

(gnutls.library.functions

1667

.gnutls_priority_set_direct(session._c_object,

1668

priority, None))

1669

2216

1670

# Start communication using the Mandos protocol

2217

1671

# Get protocol number

2218

1672

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

2219

1673

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

2220

1674

try:

2221

1675

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

2222

raise RuntimeError(line)

1676

raise RuntimeError

2223

1677

except (ValueError, IndexError, RuntimeError) as error:

2224

1678

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

2225

1679

return

2226

1680

2227

1681

# Start GnuTLS connection

2228

1682

try:

2229

1683

session.handshake()

2230

except gnutls.Error as error:

1684

except gnutls.errors.GNUTLSError as error:

2231

1685

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

2232

1686

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

2233

1687

# established. Just abandon the request.

2234

1688

return

2235

1689

logger.debug("Handshake succeeded")

2236

1690

2237

1691

approval_required = False

2238

1692

try:

2239

1693

try:

2240

fpr = self.fingerprint(

2241

self.peer_certificate(session))

2242

except (TypeError, gnutls.Error) as error:

1694

fpr = self.fingerprint(self.peer_certificate

1695

(session))

1696

except (TypeError,

1697

gnutls.errors.GNUTLSError) as error:

2243

1698

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

2244

1699

return

2245

1700

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

2246

1701

2247

1702

try:

2248

1703

client = ProxyClient(child_pipe, fpr,

2249

1704

self.client_address)

2250

1705

except KeyError:

2251

1706

return

2252

1707

2253

1708

if client.approval_delay:

2254

1709

delay = client.approval_delay

2255

1710

client.approvals_pending += 1

2256

1711

approval_required = True

2257

1712

2258

1713

while True:

2259

1714

if not client.enabled:

2260

1715

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

2261

client.name)

1716

client.name)

2262

1717

if self.server.use_dbus:

2263

1718

# Emit D-Bus signal

2264

1719

client.Rejected("Disabled")

2265

1720

return

2266

1721

2267

1722

if client.approved or not client.approval_delay:

2268

# We are approved or approval is disabled

1723

#We are approved or approval is disabled

2269

1724

break

2270

1725

elif client.approved is None:

2271

1726

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

2273

1728

if self.server.use_dbus:

2274

1729

# Emit D-Bus signal

2275

1730

client.NeedApproval(

2276

client.approval_delay.total_seconds()

2277

* 1000, client.approved_by_default)

1731

client.approval_delay_milliseconds(),

1732

client.approved_by_default)

2278

1733

else:

2279

1734

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

2280

1735

client.name)

2282

1737

# Emit D-Bus signal

2283

1738

client.Rejected("Denied")

2284

1739

return

2285

2286

# wait until timeout or approved

1740

1741

#wait until timeout or approved

2287

1742

time = datetime.datetime.now()

2288

1743

client.changedstate.acquire()

2289

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

1744

client.changedstate.wait(

1745

float(timedelta_to_milliseconds(delay)

1746

/ 1000))

2290

1747

client.changedstate.release()

2291

1748

time2 = datetime.datetime.now()

2292

1749

if (time2 - time) >= delay:

2302

1759

break

2303

1760

else:

2304

1761

delay -= time2 - time

2305

2306

try:

2307

session.send(client.secret)

2308

except gnutls.Error as error:

2309

logger.warning("gnutls send failed",

2310

exc_info=error)

2311

return

2312

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

2313

1776

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

2314

1777

# bump the timeout using extended_timeout

2315

1778

client.bump_timeout(client.extended_timeout)

2316

1779

if self.server.use_dbus:

2317

1780

# Emit D-Bus signal

2318

1781

client.GotSecret()

2319

1782

2320

1783

finally:

2321

1784

if approval_required:

2322

1785

client.approvals_pending -= 1

2323

1786

try:

2324

1787

session.bye()

2325

except gnutls.Error as error:

1788

except gnutls.errors.GNUTLSError as error:

2326

1789

logger.warning("GnuTLS bye failed",

2327

1790

exc_info=error)

2328

1791

2329

1792

@staticmethod

2330

1793

def peer_certificate(session):

2331

1794

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

2332

1795

# If not an OpenPGP certificate...

2333

if (gnutls.certificate_type_get(session._c_object)

2334

!= gnutls.CRT_OPENPGP):

2335

# ...return invalid data

2336

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

2337

1801

list_size = ctypes.c_uint(1)

2338

cert_list = (gnutls.certificate_get_peers

1802

cert_list = (gnutls.library.functions

1803

.gnutls_certificate_get_peers

2339

1804

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

2340

1805

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

2341

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

1806

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

1807

" certificate")

2342

1808

if list_size.value == 0:

2343

1809

return None

2344

1810

cert = cert_list[0]

2345

1811

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

2346

1812

2347

1813

@staticmethod

2348

1814

def fingerprint(openpgp):

2349

1815

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2350

1816

# New GnuTLS "datum" with the OpenPGP public key

2351

datum = gnutls.datum_t(

2352

ctypes.cast(ctypes.c_char_p(openpgp),

2353

ctypes.POINTER(ctypes.c_ubyte)),

2354

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

2355

1822

# New empty GnuTLS certificate

2356

crt = gnutls.openpgp_crt_t()

2357

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

2358

1826

# Import the OpenPGP public key into the certificate

2359

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

2360

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

2361

1831

# Verify the self signature in the key

2362

1832

crtverify = ctypes.c_uint()

2363

gnutls.openpgp_crt_verify_self(crt, 0,

2364

ctypes.byref(crtverify))

1833

(gnutls.library.functions

1834

.gnutls_openpgp_crt_verify_self(crt, 0,

1835

ctypes.byref(crtverify)))

2365

1836

if crtverify.value != 0:

2366

gnutls.openpgp_crt_deinit(crt)

2367

raise gnutls.CertificateSecurityError("Verify failed")

1837

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1838

raise (gnutls.errors.CertificateSecurityError

1839

("Verify failed"))

2368

1840

# New buffer for the fingerprint

2369

1841

buf = ctypes.create_string_buffer(20)

2370

1842

buf_len = ctypes.c_size_t()

2371

1843

# Get the fingerprint from the certificate into the buffer

2372

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

2373

ctypes.byref(buf_len))

1844

(gnutls.library.functions

1845

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

1846

ctypes.byref(buf_len)))

2374

1847

# Deinit the certificate

2375

gnutls.openpgp_crt_deinit(crt)

1848

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2376

1849

# Convert the buffer to a Python bytestring

2377

1850

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

2378

1851

# Convert the bytestring to hexadecimal notation

2382

1855

2383

1856

class MultiprocessingMixIn(object):

2384

1857

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

2385

2386

1858

def sub_process_main(self, request, address):

2387

1859

try:

2388

1860

self.finish_request(request, address)

2389

1861

except Exception:

2390

1862

self.handle_error(request, address)

2391

1863

self.close_request(request)

2392

1864

2393

1865

def process_request(self, request, address):

2394

1866

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

2395

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

2396

args=(request, address))

1867

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

1868

args = (request, address))

2397

1869

proc.start()

2398

1870

return proc

2399

1871

2400

1872

2401

1873

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2402

1874

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

2403

2404

1875

def process_request(self, request, client_address):

2405

1876

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

2406

1877

2407

1878

This function creates a new pipe in self.pipe

2408

1879

"""

2409

1880

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2410

1881

2411

1882

proc = MultiprocessingMixIn.process_request(self, request,

2412

1883

client_address)

2413

1884

self.child_pipe.close()

2414

1885

self.add_pipe(parent_pipe, proc)

2415

1886

2416

1887

def add_pipe(self, parent_pipe, proc):

2417

1888

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

2418

raise NotImplementedError()

1889

raise NotImplementedError

2419

1890

2420

1891

2421

1892

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2422

1893

socketserver.TCPServer, object):

2423

1894

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

2424

1895

2425

1896

Attributes:

2426

1897

enabled: Boolean; whether this server is activated yet

2427

1898

interface: None or a network interface name (string)

2428

1899

use_ipv6: Boolean; to use IPv6 or not

2429

1900

"""

2430

2431

1901

def __init__(self, server_address, RequestHandlerClass,

2432

interface=None,

2433

use_ipv6=True,

2434

socketfd=None):

1902

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

2435

1903

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

2436

1904

creating a new one with socket.socket().

2437

1905

"""

2443

1911

self.socketfd = socketfd

2444

1912

# Save the original socket.socket() function

2445

1913

self.socket_socket = socket.socket

2446

2447

1914

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

2448

#

1915

#

2449

1916

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

2450

1917

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

2451

1918

# patching socket.socket.)

2452

#

1919

#

2453

1920

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

2454

1921

@functools.wraps(socket.socket)

2455

1922

def socket_wrapper(*args, **kwargs):

2467

1934

# socket_wrapper(), if socketfd was set.

2468

1935

socketserver.TCPServer.__init__(self, server_address,

2469

1936

RequestHandlerClass)

2470

1937

2471

1938

def server_bind(self):

2472

1939

"""This overrides the normal server_bind() function

2473

1940

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

2474

1941

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

2475

global SO_BINDTODEVICE

2476

1942

if self.interface is not None:

2477

1943

if SO_BINDTODEVICE is None:

2478

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

2479

# common enough.

2480

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

2481

SO_BINDTODEVICE = 25

2482

try:

2483

self.socket.setsockopt(

2484

socket.SOL_SOCKET, SO_BINDTODEVICE,

2485

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

2486

except socket.error as error:

2487

if error.errno == errno.EPERM:

2488

logger.error("No permission to bind to"

2489

" interface %s", self.interface)

2490

elif error.errno == errno.ENOPROTOOPT:

2491

logger.error("SO_BINDTODEVICE not available;"

2492

" cannot bind to interface %s",

2493

self.interface)

2494

elif error.errno == errno.ENODEV:

2495

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

2496

" cannot bind", self.interface)

2497

else:

2498

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

2499

1965

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

2500

1966

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

2501

1967

if not self.server_address[0]:

2502

1968

if self.address_family == socket.AF_INET6:

2503

any_address = "::" # in6addr_any

1969

any_address = "::" # in6addr_any

2504

1970

else:

2505

any_address = "0.0.0.0" # INADDR_ANY

1971

any_address = socket.INADDR_ANY

2506

1972

self.server_address = (any_address,

2507

1973

self.server_address[1])

2508

1974

elif not self.server_address[1]:

2509

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

1975

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

1976

0)

2510

1977

# if self.interface:

2511

1978

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

2512

1979

# 0, # port

2518

1985

2519

1986

class MandosServer(IPv6_TCPServer):

2520

1987

"""Mandos server.

2521

1988

2522

1989

Attributes:

2523

1990

clients: set of Client objects

2524

1991

gnutls_priority GnuTLS priority string

2525

1992

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

2526

2527

Assumes a GLib.MainLoop event loop.

1993

1994

Assumes a gobject.MainLoop event loop.

2528

1995

"""

2529

2530

1996

def __init__(self, server_address, RequestHandlerClass,

2531

interface=None,

2532

use_ipv6=True,

2533

clients=None,

2534

gnutls_priority=None,

2535

use_dbus=True,

2536

socketfd=None):

1997

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

1998

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

2537

1999

self.enabled = False

2538

2000

self.clients = clients

2539

2001

if self.clients is None:

2542

2004

self.gnutls_priority = gnutls_priority

2543

2005

IPv6_TCPServer.__init__(self, server_address,

2544

2006

RequestHandlerClass,

2545

interface=interface,

2546

use_ipv6=use_ipv6,

2547

socketfd=socketfd)

2548

2007

interface = interface,

2008

use_ipv6 = use_ipv6,

2009

socketfd = socketfd)

2549

2010

def server_activate(self):

2550

2011

if self.enabled:

2551

2012

return socketserver.TCPServer.server_activate(self)

2552

2013

2553

2014

def enable(self):

2554

2015

self.enabled = True

2555

2016

2556

2017

def add_pipe(self, parent_pipe, proc):

2557

2018

# Call "handle_ipc" for both data and EOF events

2558

GLib.io_add_watch(

2559

parent_pipe.fileno(),

2560

GLib.IO_IN | GLib.IO_HUP,

2561

functools.partial(self.handle_ipc,

2562

parent_pipe=parent_pipe,

2563

proc=proc))

2564

2565

def handle_ipc(self, source, condition,

2566

parent_pipe=None,

2567

proc=None,

2568

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

2569

2028

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

2570

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

2029

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

2571

2030

# Wait for other process to exit

2572

2031

proc.join()

2573

2032

return False

2574

2033

2575

2034

# Read a request from the child

2576

2035

request = parent_pipe.recv()

2577

2036

command = request[0]

2578

2037

2579

2038

if command == 'init':

2580

2039

fpr = request[1]

2581

2040

address = request[2]

2582

2583

for c in self.clients.values():

2041

2042

for c in self.clients.itervalues():

2584

2043

if c.fingerprint == fpr:

2585

2044

client = c

2586

2045

break

2593

2052

address[0])

2594

2053

parent_pipe.send(False)

2595

2054

return False

2596

2597

GLib.io_add_watch(

2598

parent_pipe.fileno(),

2599

GLib.IO_IN | GLib.IO_HUP,

2600

functools.partial(self.handle_ipc,

2601

parent_pipe=parent_pipe,

2602

proc=proc,

2603

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

2604

2064

parent_pipe.send(True)

2605

2065

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

2606

2066

# same fileno

2609

2069

funcname = request[1]

2610

2070

args = request[2]

2611

2071

kwargs = request[3]

2612

2072

2613

2073

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

2614

2074

funcname)(*args,

2615

**kwargs)))

2616

2075

**kwargs)))

2076

2617

2077

if command == 'getattr':

2618

2078

attrname = request[1]

2619

if isinstance(client_object.__getattribute__(attrname),

2620

collections.Callable):

2621

parent_pipe.send(('function', ))

2079

if callable(client_object.__getattribute__(attrname)):

2080

parent_pipe.send(('function',))

2622

2081

else:

2623

parent_pipe.send((

2624

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

2625

2082

parent_pipe.send(('data', client_object

2083

.__getattribute__(attrname)))

2084

2626

2085

if command == 'setattr':

2627

2086

attrname = request[1]

2628

2087

value = request[2]

2629

2088

setattr(client_object, attrname, value)

2630

2089

2631

2090

return True

2632

2091

2633

2092

2634

def rfc3339_duration_to_delta(duration):

2635

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

2636

2637

>>> rfc3339_duration_to_delta("P7D")

2638

datetime.timedelta(7)

2639

>>> rfc3339_duration_to_delta("PT60S")

2640

datetime.timedelta(0, 60)

2641

>>> rfc3339_duration_to_delta("PT60M")

2642

datetime.timedelta(0, 3600)

2643

>>> rfc3339_duration_to_delta("PT24H")

2644

datetime.timedelta(1)

2645

>>> rfc3339_duration_to_delta("P1W")

2646

datetime.timedelta(7)

2647

>>> rfc3339_duration_to_delta("PT5M30S")

2648

datetime.timedelta(0, 330)

2649

>>> rfc3339_duration_to_delta("P1DT3M20S")

2650

datetime.timedelta(1, 200)

2651

"""

2652

2653

# Parsing an RFC 3339 duration with regular expressions is not

2654

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

2655

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

2656

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

2657

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

2658

# avoid excessive use of external libraries.

2659

2660

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

2661

Token = collections.namedtuple("Token", (

2662

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

2663

# a "group" containing digits

2664

"value", # datetime.timedelta or None

2665

"followers")) # Tokens valid after this token

2666

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

2667

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

2668

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

2669

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

2670

datetime.timedelta(seconds=1),

2671

frozenset((token_end, )))

2672

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

2673

datetime.timedelta(minutes=1),

2674

frozenset((token_second, token_end)))

2675

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

2676

datetime.timedelta(hours=1),

2677

frozenset((token_minute, token_end)))

2678

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

2679

None,

2680

frozenset((token_hour, token_minute,

2681

token_second)))

2682

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

2683

datetime.timedelta(days=1),

2684

frozenset((token_time, token_end)))

2685

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

2686

datetime.timedelta(weeks=4),

2687

frozenset((token_day, token_end)))

2688

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

2689

datetime.timedelta(weeks=52),

2690

frozenset((token_month, token_end)))

2691

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

2692

datetime.timedelta(weeks=1),

2693

frozenset((token_end, )))

2694

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

2695

frozenset((token_year, token_month,

2696

token_day, token_time,

2697

token_week)))

2698

# Define starting values:

2699

# Value so far

2700

value = datetime.timedelta()

2701

found_token = None

2702

# Following valid tokens

2703

followers = frozenset((token_duration, ))

2704

# String left to parse

2705

s = duration

2706

# Loop until end token is found

2707

while found_token is not token_end:

2708

# Search for any currently valid tokens

2709

for token in followers:

2710

match = token.regexp.match(s)

2711

if match is not None:

2712

# Token found

2713

if token.value is not None:

2714

# Value found, parse digits

2715

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

2716

# Add to value so far

2717

value += factor * token.value

2718

# Strip token from string

2719

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

2720

# Go to found token

2721

found_token = token

2722

# Set valid next tokens

2723

followers = found_token.followers

2724

break

2725

else:

2726

# No currently valid tokens were found

2727

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

2728

.format(duration))

2729

# End token found

2730

return value

2731

2732

2733

2093

def string_to_delta(interval):

2734

2094

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

2735

2095

2736

2096

>>> string_to_delta('7d')

2737

2097

datetime.timedelta(7)

2738

2098

>>> string_to_delta('60s')

2746

2106

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

2747

2107

datetime.timedelta(0, 330)

2748

2108

"""

2749

2750

try:

2751

return rfc3339_duration_to_delta(interval)

2752

except ValueError:

2753

pass

2754

2755

2109

timevalue = datetime.timedelta(0)

2756

2110

for s in interval.split():

2757

2111

try:

2758

suffix = s[-1]

2112

suffix = unicode(s[-1])

2759

2113

value = int(s[:-1])

2760

2114

if suffix == "d":

2761

2115

delta = datetime.timedelta(value)

2768

2122

elif suffix == "w":

2769

2123

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

2770

2124

else:

2771

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

2772

except IndexError as e:

2125

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

2126

.format(suffix))

2127

except (ValueError, IndexError) as e:

2773

2128

raise ValueError(*(e.args))

2774

2129

timevalue += delta

2775

2130

return timevalue

2776

2131

2777

2132

2778

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

2133

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

2779

2134

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

2780

2135

2781

2136

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

2782

2137

if os.fork():

2783

2138

sys.exit()

2791

2146

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

2792

2147

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

2793

2148

raise OSError(errno.ENODEV,

2794

"{} not a character device"

2149

"{0} not a character device"

2795

2150

.format(os.devnull))

2796

2151

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

2797

2152

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

2801

2156

2802

2157

2803

2158

def main():

2804

2159

2805

2160

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

2806

2161

# Parsing of options, both command line and config file

2807

2162

2808

2163

parser = argparse.ArgumentParser()

2809

2164

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

2810

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

2165

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

2811

2166

help="show version number and exit")

2812

2167

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

2813

2168

help="Bind to interface IF")

2819

2174

help="Run self-test")

2820

2175

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

2821

2176

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

2822

" to terminal", default=None)

2177

" to terminal")

2823

2178

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

2824

2179

help="Debug level for stdout output")

2825

2180

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

2832

2187

" files")

2833

2188

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

2834

2189

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

2835

" system bus interface", default=None)

2190

" system bus interface")

2836

2191

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

2837

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

2838

default=None)

2192

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

2839

2193

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

2840

2194

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

2841

" state", default=None)

2195

" state")

2842

2196

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

2843

2197

help="Specify a file descriptor to a network"

2844

2198

" socket to use instead of creating one")

2845

2199

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

2846

2200

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

2847

2201

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

2848

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

2849

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

2850

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

2851

default=None)

2852

2202

help="Run in foreground")

2203

2853

2204

options = parser.parse_args()

2854

2205

2855

2206

if options.check:

2856

2207

import doctest

2857

fail_count, test_count = doctest.testmod()

2858

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

2859

2208

doctest.testmod()

2209

sys.exit()

2210

2860

2211

# Default values for config file for server-global settings

2861

server_defaults = {"interface": "",

2862

"address": "",

2863

"port": "",

2864

"debug": "False",

2865

"priority":

2866

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

2867

":+SIGN-DSA-SHA256",

2868

"servicename": "Mandos",

2869

"use_dbus": "True",

2870

"use_ipv6": "True",

2871

"debuglevel": "",

2872

"restore": "True",

2873

"socket": "",

2874

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

2875

"foreground": "False",

2876

"zeroconf": "True",

2877

}

2878

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

2879

2228

# Parse config file for server-global settings

2880

2229

server_config = configparser.SafeConfigParser(server_defaults)

2881

2230

del server_defaults

2882

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

2231

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

2232

"mandos.conf"))

2883

2233

# Convert the SafeConfigParser object to a dict

2884

2234

server_settings = server_config.defaults()

2885

2235

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

2899

2249

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

2900

2250

["socket"])

2901

2251

del server_config

2902

2252

2903

2253

# Override the settings from the config file with command line

2904

2254

# options, if set.

2905

2255

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

2906

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

2907

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

2908

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

2256

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

2257

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

2258

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

2909

2259

value = getattr(options, option)

2910

2260

if value is not None:

2911

2261

server_settings[option] = value

2912

2262

del options

2913

2263

# Force all strings to be unicode

2914

2264

for option in server_settings.keys():

2915

if isinstance(server_settings[option], bytes):

2916

server_settings[option] = (server_settings[option]

2917

.decode("utf-8"))

2918

# Force all boolean options to be boolean

2919

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

2920

"foreground", "zeroconf"):

2921

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

2265

if type(server_settings[option]) is str:

2266

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

2922

2267

# Debug implies foreground

2923

2268

if server_settings["debug"]:

2924

2269

server_settings["foreground"] = True

2925

2270

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

2926

2271

2927

2272

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

2928

2929

if (not server_settings["zeroconf"]

2930

and not (server_settings["port"]

2931

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

2932

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

2933

2273

2934

2274

# For convenience

2935

2275

debug = server_settings["debug"]

2936

2276

debuglevel = server_settings["debuglevel"]

2939

2279

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

2940

2280

stored_state_file)

2941

2281

foreground = server_settings["foreground"]

2942

zeroconf = server_settings["zeroconf"]

2943

2282

2944

2283

if debug:

2945

2284

initlogger(debug, logging.DEBUG)

2946

2285

else:

2949

2288

else:

2950

2289

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

2951

2290

initlogger(debug, level)

2952

2291

2953

2292

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

2954

syslogger.setFormatter(

2955

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

2956

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

2957

server_settings["servicename"])))

2958

2293

syslogger.setFormatter(logging.Formatter

2294

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

2295

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

2296

.format(server_settings

2297

["servicename"])))

2298

2959

2299

# Parse config file with clients

2960

2300

client_config = configparser.SafeConfigParser(Client

2961

2301

.client_defaults)

2962

2302

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

2963

2303

"clients.conf"))

2964

2304

2965

2305

global mandos_dbus_service

2966

2306

mandos_dbus_service = None

2967

2968

socketfd = None

2969

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

2970

socketfd = server_settings["socket"]

2971

tcp_server = MandosServer(

2972

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

2973

ClientHandler,

2974

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

2975

use_ipv6=use_ipv6,

2976

gnutls_priority=server_settings["priority"],

2977

use_dbus=use_dbus,

2978

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

2979

2319

if not foreground:

2980

pidfilename = "/run/mandos.pid"

2981

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

2982

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

2320

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

2983

2321

pidfile = None

2984

2322

try:

2985

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

2323

pidfile = open(pidfilename, "w")

2986

2324

except IOError as e:

2987

2325

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

2988

2326

exc_info=e)

2989

2990

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

2991

("mandos", "mandos"),

2992

("nobody", "nogroup")):

2327

2328

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

2993

2329

try:

2994

2330

uid = pwd.getpwnam(name).pw_uid

2995

gid = pwd.getpwnam(group).pw_gid

2331

gid = pwd.getpwnam(name).pw_gid

2996

2332

break

2997

2333

except KeyError:

2998

2334

continue

3002

2338

try:

3003

2339

os.setgid(gid)

3004

2340

os.setuid(uid)

3005

if debug:

3006

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

3007

gid))

3008

2341

except OSError as error:

3009

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

3010

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

3011

2342

if error.errno != errno.EPERM:

3012

raise

3013

2343

raise error

2344

3014

2345

if debug:

3015

2346

# Enable all possible GnuTLS debugging

3016

2347

3017

2348

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

3018

2349

# - GnuTLS manual

3019

gnutls.global_set_log_level(11)

3020

3021

@gnutls.log_func

2350

gnutls.library.functions.gnutls_global_set_log_level(11)

2351

2352

@gnutls.library.types.gnutls_log_func

3022

2353

def debug_gnutls(level, string):

3023

2354

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

3024

3025

gnutls.global_set_log_function(debug_gnutls)

3026

2355

2356

(gnutls.library.functions

2357

.gnutls_global_set_log_function(debug_gnutls))

2358

3027

2359

# Redirect stdin so all checkers get /dev/null

3028

2360

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

3029

2361

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

3030

2362

if null > 2:

3031

2363

os.close(null)

3032

2364

3033

2365

# Need to fork before connecting to D-Bus

3034

2366

if not foreground:

3035

2367

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

3036

2368

daemon()

3037

3038

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

3039

# to inform GLib that threads will be used.

3040

GLib.threads_init()

3041

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

3042

2374

global main_loop

3043

2375

# From the Avahi example code

3044

2376

DBusGMainLoop(set_as_default=True)

3045

main_loop = GLib.MainLoop()

2377

main_loop = gobject.MainLoop()

3046

2378

bus = dbus.SystemBus()

3047

2379

# End of Avahi example code

3048

2380

if use_dbus:

3049

2381

try:

3050

2382

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

3051

bus,

3052

do_not_queue=True)

3053

old_bus_name = dbus.service.BusName(

3054

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

3055

do_not_queue=True)

3056

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:

3057

2388

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

3058

2389

use_dbus = False

3059

2390

server_settings["use_dbus"] = False

3060

2391

tcp_server.use_dbus = False

3061

if zeroconf:

3062

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3063

service = AvahiServiceToSyslog(

3064

name=server_settings["servicename"],

3065

servicetype="_mandos._tcp",

3066

protocol=protocol,

3067

bus=bus)

3068

if server_settings["interface"]:

3069

service.interface = if_nametoindex(

3070

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

3071

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

3072

2401

global multiprocessing_manager

3073

2402

multiprocessing_manager = multiprocessing.Manager()

3074

2403

3075

2404

client_class = Client

3076

2405

if use_dbus:

3077

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

3078

2406

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

2407

3079

2408

client_settings = Client.config_parser(client_config)

3080

2409

old_client_settings = {}

3081

2410

clients_data = {}

3082

3083

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

3084

global wnull

3085

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

3086

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

3087

# mode

3088

if debug or not foreground:

3089

wnull.close()

3090

2411

3091

2412

# Get client data and settings from last running state.

3092

2413

if server_settings["restore"]:

3093

2414

try:

3094

2415

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

3095

if sys.version_info.major == 2:

3096

clients_data, old_client_settings = pickle.load(

3097

stored_state)

3098

else:

3099

bytes_clients_data, bytes_old_client_settings = (

3100

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

3101

# Fix bytes to strings

3102

# clients_data

3103

# .keys()

3104

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

3105

if isinstance(key, bytes)

3106

else key): value

3107

for key, value in

3108

bytes_clients_data.items()}

3109

del bytes_clients_data

3110

for key in clients_data:

3111

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

3112

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

3113

for k, v in

3114

clients_data[key].items()}

3115

clients_data[key] = value

3116

# .client_structure

3117

value["client_structure"] = [

3118

(s.decode("utf-8")

3119

if isinstance(s, bytes)

3120

else s) for s in

3121

value["client_structure"]]

3122

# .name & .host

3123

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

3124

if isinstance(value[k], bytes):

3125

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

3126

# old_client_settings

3127

# .keys()

3128

old_client_settings = {

3129

(key.decode("utf-8")

3130

if isinstance(key, bytes)

3131

else key): value

3132

for key, value in

3133

bytes_old_client_settings.items()}

3134

del bytes_old_client_settings

3135

# .host

3136

for value in old_client_settings.values():

3137

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

3138

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

3139

.decode("utf-8"))

2416

clients_data, old_client_settings = (pickle.load

2417

(stored_state))

3140

2418

os.remove(stored_state_path)

3141

2419

except IOError as e:

3142

2420

if e.errno == errno.ENOENT:

3143

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

3144

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

2421

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

2422

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

3145

2423

else:

3146

2424

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

3147

2425

exc_info=e)

3148

2426

raise

3149

2427

except EOFError as e:

3150

2428

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

3151

"EOFError:",

3152

exc_info=e)

3153

2429

"EOFError:", exc_info=e)

2430

3154

2431

with PGPEngine() as pgp:

3155

for client_name, client in clients_data.items():

3156

# Skip removed clients

3157

if client_name not in client_settings:

3158

continue

3159

2432

for client_name, client in clients_data.iteritems():

3160

2433

# Decide which value to use after restoring saved state.

3161

2434

# We have three different values: Old config file,

3162

2435

# new config file, and saved state.

3167

2440

# For each value in new config, check if it

3168

2441

# differs from the old config value (Except for

3169

2442

# the "secret" attribute)

3170

if (name != "secret"

3171

and (value !=

3172

old_client_settings[client_name][name])):

2443

if (name != "secret" and

2444

value != old_client_settings[client_name]

2445

[name]):

3173

2446

client[name] = value

3174

2447

except KeyError:

3175

2448

pass

3176

2449

3177

2450

# Clients who has passed its expire date can still be

3178

# enabled if its last checker was successful. A Client

2451

# enabled if its last checker was successful. Clients

3179

2452

# whose checker succeeded before we stored its state is

3180

2453

# assumed to have successfully run all checkers during

3181

2454

# downtime.

3183

2456

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

3184

2457

if not client["last_checked_ok"]:

3185

2458

logger.warning(

3186

"disabling client {} - Client never "

3187

"performed a successful checker".format(

3188

client_name))

2459

"disabling client {0} - Client never "

2460

"performed a successful checker"

2461

.format(client_name))

3189

2462

client["enabled"] = False

3190

2463

elif client["last_checker_status"] != 0:

3191

2464

logger.warning(

3192

"disabling client {} - Client last"

3193

" checker failed with error code"

3194

" {}".format(

3195

client_name,

3196

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

3197

2469

client["enabled"] = False

3198

2470

else:

3199

client["expires"] = (

3200

datetime.datetime.utcnow()

3201

+ client["timeout"])

2471

client["expires"] = (datetime.datetime

2472

.utcnow()

2473

+ client["timeout"])

3202

2474

logger.debug("Last checker succeeded,"

3203

" keeping {} enabled".format(

3204

client_name))

2475

" keeping {0} enabled"

2476

.format(client_name))

3205

2477

try:

3206

client["secret"] = pgp.decrypt(

3207

client["encrypted_secret"],

3208

client_settings[client_name]["secret"])

2478

client["secret"] = (

2479

pgp.decrypt(client["encrypted_secret"],

2480

client_settings[client_name]

2481

["secret"]))

3209

2482

except PGPError:

3210

2483

# If decryption fails, we use secret from new settings

3211

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

3212

client_name))

3213

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

3214

["secret"])

3215

2484

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

2485

.format(client_name))

2486

client["secret"] = (

2487

client_settings[client_name]["secret"])

2488

3216

2489

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

3217

2490

for client_name in (set(old_client_settings)

3218

2491

- set(client_settings)):

3220

2493

for client_name in (set(client_settings)

3221

2494

- set(old_client_settings)):

3222

2495

clients_data[client_name] = client_settings[client_name]

3223

2496

3224

2497

# Create all client objects

3225

for client_name, client in clients_data.items():

2498

for client_name, client in clients_data.iteritems():

3226

2499

tcp_server.clients[client_name] = client_class(

3227

name=client_name,

3228

settings=client,

3229

server_settings=server_settings)

3230

2500

name = client_name, settings = client)

2501

3231

2502

if not tcp_server.clients:

3232

2503

logger.warning("No clients defined")

3233

2504

3234

2505

if not foreground:

3235

2506

if pidfile is not None:

3236

pid = os.getpid()

3237

2507

try:

3238

2508

with pidfile:

3239

print(pid, file=pidfile)

2509

pid = os.getpid()

2510

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

3240

2511

except IOError:

3241

2512

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

3242

2513

pidfilename, pid)

3243

2514

del pidfile

3244

2515

del pidfilename

3245

3246

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

3247

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3248

lambda: main_loop.quit() and False)

3249

2516

2517

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

2518

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

2519

3250

2520

if use_dbus:

3251

3252

@alternate_dbus_interfaces(

3253

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

3254

class MandosDBusService(DBusObjectWithObjectManager):

2521

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

2522

"se.bsnet.fukt.Mandos"})

2523

class MandosDBusService(DBusObjectWithProperties):

3255

2524

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

3256

3257

2525

def __init__(self):

3258

2526

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

3259

3260

2527

_interface = "se.recompile.Mandos"

3261

2528

2529

@dbus_interface_annotations(_interface)

2530

def _foo(self):

2531

return { "org.freedesktop.DBus.Property"

2532

".EmitsChangedSignal":

2533

"false"}

2534

3262

2535

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

3263

2536

def ClientAdded(self, objpath):

3264

2537

"D-Bus signal"

3265

2538

pass

3266

2539

3267

2540

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

3268

2541

def ClientNotFound(self, fingerprint, address):

3269

2542

"D-Bus signal"

3270

2543

pass

3271

3272

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

3273

"true"})

2544

3274

2545

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

3275

2546

def ClientRemoved(self, objpath, name):

3276

2547

"D-Bus signal"

3277

2548

pass

3278

3279

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

3280

"true"})

2549

3281

2550

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

3282

2551

def GetAllClients(self):

3283

2552

"D-Bus method"

3284

return dbus.Array(c.dbus_object_path for c in

3285

tcp_server.clients.values())

3286

3287

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

3288

"true"})

2553

return dbus.Array(c.dbus_object_path

2554

for c in

2555

tcp_server.clients.itervalues())

2556

3289

2557

@dbus.service.method(_interface,

3290

2558

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

3291

2559

def GetAllClientsWithProperties(self):

3292

2560

"D-Bus method"

3293

2561

return dbus.Dictionary(

3294

{c.dbus_object_path: c.GetAll(

3295

"se.recompile.Mandos.Client")

3296

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

2562

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

2563

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

3297

2564

signature="oa{sv}")

3298

2565

3299

2566

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

3300

2567

def RemoveClient(self, object_path):

3301

2568

"D-Bus method"

3302

for c in tcp_server.clients.values():

2569

for c in tcp_server.clients.itervalues():

3303

2570

if c.dbus_object_path == object_path:

3304

2571

del tcp_server.clients[c.name]

3305

2572

c.remove_from_connection()

3306

# Don't signal the disabling

2573

# Don't signal anything except ClientRemoved

3307

2574

c.disable(quiet=True)

3308

# Emit D-Bus signal for removal

3309

self.client_removed_signal(c)

2575

# Emit D-Bus signal

2576

self.ClientRemoved(object_path, c.name)

3310

2577

return

3311

2578

raise KeyError(object_path)

3312

2579

3313

2580

del _interface

3314

3315

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3316

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

3317

def GetManagedObjects(self):

3318

"""D-Bus method"""

3319

return dbus.Dictionary(

3320

{client.dbus_object_path:

3321

dbus.Dictionary(

3322

{interface: client.GetAll(interface)

3323

for interface in

3324

client._get_all_interface_names()})

3325

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

3326

3327

def client_added_signal(self, client):

3328

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

3329

if use_dbus:

3330

# New standard signal

3331

self.InterfacesAdded(

3332

client.dbus_object_path,

3333

dbus.Dictionary(

3334

{interface: client.GetAll(interface)

3335

for interface in

3336

client._get_all_interface_names()}))

3337

# Old signal

3338

self.ClientAdded(client.dbus_object_path)

3339

3340

def client_removed_signal(self, client):

3341

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

3342

if use_dbus:

3343

# New standard signal

3344

self.InterfacesRemoved(

3345

client.dbus_object_path,

3346

client._get_all_interface_names())

3347

# Old signal

3348

self.ClientRemoved(client.dbus_object_path,

3349

client.name)

3350

2581

3351

2582

mandos_dbus_service = MandosDBusService()

3352

3353

# Save modules to variables to exempt the modules from being

3354

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

3355

mp = multiprocessing

3356

wn = wnull

3357

2583

3358

2584

def cleanup():

3359

2585

"Cleanup function; run on exit"

3360

if zeroconf:

3361

service.cleanup()

3362

3363

mp.active_children()

3364

wn.close()

2586

service.cleanup()

2587

2588

multiprocessing.active_children()

3365

2589

if not (tcp_server.clients or client_settings):

3366

2590

return

3367

2591

3368

2592

# Store client before exiting. Secrets are encrypted with key

3369

2593

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

3370

2594

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

3371

2595

clients = {}

3372

2596

with PGPEngine() as pgp:

3373

for client in tcp_server.clients.values():

2597

for client in tcp_server.clients.itervalues():

3374

2598

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

3375

2599

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

3376

2600

key)

3377

2601

client_dict = {}

3378

2602

3379

2603

# A list of attributes that can not be pickled

3380

2604

# + secret.

3381

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

3382

"checker", "server_settings"}

3383

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

3384

.Object):

2605

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

2606

"checker"))

2607

for name, typ in (inspect.getmembers

2608

(dbus.service.Object)):

3385

2609

exclude.add(name)

3386

2610

3387

2611

client_dict["encrypted_secret"] = (client

3388

2612

.encrypted_secret)

3389

2613

for attr in client.client_structure:

3390

2614

if attr not in exclude:

3391

2615

client_dict[attr] = getattr(client, attr)

3392

2616

3393

2617

clients[client.name] = client_dict

3394

2618

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

3395

2619

3396

2620

try:

3397

with tempfile.NamedTemporaryFile(

3398

mode='wb',

3399

suffix=".pickle",

3400

prefix='clients-',

3401

dir=os.path.dirname(stored_state_path),

3402

delete=False) as stored_state:

3403

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

3404

protocol=2)

3405

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

3406

2627

os.rename(tempname, stored_state_path)

3407

2628

except (IOError, OSError) as e:

3408

2629

if not debug:

3411

2632

except NameError:

3412

2633

pass

3413

2634

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

3414

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

2635

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

3415

2636

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

3416

2637

else:

3417

2638

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

3418

2639

exc_info=e)

3419

raise

3420

2640

raise e

2641

3421

2642

# Delete all clients, and settings from config

3422

2643

while tcp_server.clients:

3423

2644

name, client = tcp_server.clients.popitem()

3424

2645

if use_dbus:

3425

2646

client.remove_from_connection()

3426

# Don't signal the disabling

2647

# Don't signal anything except ClientRemoved

3427

2648

client.disable(quiet=True)

3428

# Emit D-Bus signal for removal

3429

2649

if use_dbus:

3430

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)

3431

2654

client_settings.clear()

3432

2655

3433

2656

atexit.register(cleanup)

3434

3435

for client in tcp_server.clients.values():

2657

2658

for client in tcp_server.clients.itervalues():

3436

2659

if use_dbus:

3437

# Emit D-Bus signal for adding

3438

mandos_dbus_service.client_added_signal(client)

2660

# Emit D-Bus signal

2661

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3439

2662

# Need to initiate checking of clients

3440

2663

if client.enabled:

3441

2664

client.init_checker()

3442

2665

3443

2666

tcp_server.enable()

3444

2667

tcp_server.server_activate()

3445

2668

3446

2669

# Find out what port we got

3447

if zeroconf:

3448

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

2670

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

3449

2671

if use_ipv6:

3450

2672

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

3451

2673

" flowinfo %d, scope_id %d",

3453

2675

else: # IPv4

3454

2676

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

3455

2677

*tcp_server.socket.getsockname())

3456

3457

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

3458

2678

2679

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

2680

3459

2681

try:

3460

if zeroconf:

3461

# From the Avahi example code

3462

try:

3463

service.activate()

3464

except dbus.exceptions.DBusException as error:

3465

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

3466

cleanup()

3467

sys.exit(1)

3468

# End of Avahi example code

3469

3470

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

3471

lambda *args, **kwargs:

3472

(tcp_server.handle_request

3473

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

3474

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

3475

2696

logger.debug("Starting main loop")

3476

2697

main_loop.run()

3477

2698

except AvahiError as error:

3486

2707

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

3487

2708

cleanup()

3488

2709

3489

3490

2710

if __name__ == '__main__':

3491

2711

main()