/mandos/release : revision 237.7.433

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

from future_builtins import *

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

38

41

39

import SocketServer as socketserver

42

try:

43

import SocketServer as socketserver

44

except ImportError:

45

import socketserver

40

46

import socket

41

47

import argparse

42

48

import datetime

43

49

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

50

try:

51

import ConfigParser as configparser

52

except ImportError:

53

import configparser

51

54

import sys

52

55

import re

53

56

import os

62

65

import struct

63

66

import fcntl

64

67

import functools

65

import cPickle as pickle

68

try:

69

import cPickle as pickle

70

except ImportError:

71

import pickle

66

72

import multiprocessing

67

73

import types

68

74

import binascii

69

75

import tempfile

70

76

import itertools

71

77

import collections

78

import codecs

72

79

73

80

import dbus

74

81

import dbus.service

75

import gobject

76

import avahi

82

from gi.repository import GLib

77

83

from dbus.mainloop.glib import DBusGMainLoop

78

84

import ctypes

79

85

import ctypes.util

80

86

import xml.dom.minidom

81

87

import inspect

82

import GnuPGInterface

83

88

89

# Try to find the value of SO_BINDTODEVICE:

84

90

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:

85

93

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

86

94

except AttributeError:

87

95

try:

96

# This is where SO_BINDTODEVICE was up to and including Python

97

# 2.6, and also 3.2:

88

98

from IN import SO_BINDTODEVICE

89

99

except ImportError:

90

SO_BINDTODEVICE = None

91

92

version = "1.6.0"

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"

93

118

stored_state_file = "clients.pickle"

94

119

95

120

logger = logging.getLogger()

96

syslogger = (logging.handlers.SysLogHandler

97

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

98

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

121

syslogger = None

99

122

100

123

try:

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

124

if_nametoindex = ctypes.cdll.LoadLibrary(

125

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

104

126

except (OSError, AttributeError):

127

105

128

def if_nametoindex(interface):

106

129

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

107

130

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

108

131

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

109

132

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

110

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

111

interface))

112

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

113

ifreq[16:20])[0]

133

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

134

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

114

135

return interface_index

115

136

116

137

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

117

154

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

118

155

"""init logger and add loglevel"""

119

156

157

global syslogger

158

syslogger = (logging.handlers.SysLogHandler(

159

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

160

address="/dev/log"))

120

161

syslogger.setFormatter(logging.Formatter

121

162

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

122

163

' %(message)s'))

123

164

logger.addHandler(syslogger)

124

165

125

166

if debug:

126

167

console = logging.StreamHandler()

127

168

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

139

180

140

181

class PGPEngine(object):

141

182

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

183

142

184

def __init__(self):

143

self.gnupg = GnuPGInterface.GnuPG()

144

185

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

145

self.gnupg = GnuPGInterface.GnuPG()

146

self.gnupg.options.meta_interactive = False

147

self.gnupg.options.homedir = self.tempdir

148

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

149

'--quiet',

150

'--no-use-agent'])

151

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

152

205

def __enter__(self):

153

206

return self

154

207

155

208

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

156

209

self._cleanup()

157

210

return False

158

211

159

212

def __del__(self):

160

213

self._cleanup()

161

214

162

215

def _cleanup(self):

163

216

if self.tempdir is not None:

164

217

# Delete contents of tempdir

165

218

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

166

topdown = False):

219

topdown=False):

167

220

for filename in files:

168

221

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

169

222

for dirname in dirs:

171

224

# Remove tempdir

172

225

os.rmdir(self.tempdir)

173

226

self.tempdir = None

174

227

175

228

def password_encode(self, password):

176

229

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

177

230

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

178

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

179

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

180

239

def encrypt(self, data, password):

181

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

182

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

183

try:

184

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

185

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

186

attach_fhs={'stderr': devnull})

187

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

188

f.write(data)

189

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

190

ciphertext = f.read()

191

proc.wait()

192

except IOError as e:

193

raise PGPError(e)

194

self.gnupg.passphrase = None

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)

195

255

return ciphertext

196

256

197

257

def decrypt(self, data, password):

198

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

199

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

200

try:

201

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

202

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

203

attach_fhs={'stderr': devnull})

204

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

205

f.write(data)

206

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

207

decrypted_plaintext = f.read()

208

proc.wait()

209

except IOError as e:

210

raise PGPError(e)

211

self.gnupg.passphrase = None

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)

212

273

return decrypted_plaintext

213

274

214

275

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

215

303

class AvahiError(Exception):

216

304

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

217

305

self.value = value

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

306

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

307

**kwargs)

308

221

309

222

310

class AvahiServiceError(AvahiError):

223

311

pass

224

312

313

225

314

class AvahiGroupError(AvahiError):

226

315

pass

227

316

228

317

229

318

class AvahiService(object):

230

319

"""An Avahi (Zeroconf) service.

231

320

232

321

Attributes:

233

322

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

234

323

Used to optionally bind to the specified interface.

235

324

name: string; Example: 'Mandos'

236

325

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

237

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

326

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

238

327

port: integer; what port to announce

239

328

TXT: list of strings; TXT record for the service

240

329

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

246

335

server: D-Bus Server

247

336

bus: dbus.SystemBus()

248

337

"""

249

250

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

251

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

252

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

253

protocol = avahi.PROTO_UNSPEC, bus = None):

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

254

350

self.interface = interface

255

351

self.name = name

256

352

self.type = servicetype

265

361

self.server = None

266

362

self.bus = bus

267

363

self.entry_group_state_changed_match = None

268

269

def rename(self):

364

365

def rename(self, remove=True):

270

366

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

271

367

if self.rename_count >= self.max_renames:

272

368

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

273

369

" after %i retries, exiting.",

274

370

self.rename_count)

275

371

raise AvahiServiceError("Too many renames")

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

278

375

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

279

376

self.name)

280

self.remove()

377

if remove:

378

self.remove()

281

379

try:

282

380

self.add()

283

381

except dbus.exceptions.DBusException as error:

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

288

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

289

391

def remove(self):

290

392

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

291

393

if self.entry_group_state_changed_match is not None:

293

395

self.entry_group_state_changed_match = None

294

396

if self.group is not None:

295

397

self.group.Reset()

296

398

297

399

def add(self):

298

400

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

299

401

self.remove()

316

418

dbus.UInt16(self.port),

317

419

avahi.string_array_to_txt_array(self.TXT))

318

420

self.group.Commit()

319

421

320

422

def entry_group_state_changed(self, state, error):

321

423

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

322

424

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

323

425

324

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

325

427

logger.debug("Zeroconf service established.")

326

428

elif state == avahi.ENTRY_GROUP_COLLISION:

328

430

self.rename()

329

431

elif state == avahi.ENTRY_GROUP_FAILURE:

330

432

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

331

unicode(error))

332

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

333

.format(error))

334

433

str(error))

434

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

435

335

436

def cleanup(self):

336

437

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

337

438

if self.group is not None:

342

443

pass

343

444

self.group = None

344

445

self.remove()

345

446

346

447

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

347

448

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

348

449

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

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

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

}

356

456

if state in bad_states:

357

457

if bad_states[state] is not None:

358

458

if error is None:

361

461

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

362

462

self.cleanup()

363

463

elif state == avahi.SERVER_RUNNING:

364

self.add()

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)

365

476

else:

366

477

if error is None:

367

478

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

368

479

else:

369

480

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

370

481

371

482

def activate(self):

372

483

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

373

484

if self.server is None:

377

488

follow_name_owner_changes=True),

378

489

avahi.DBUS_INTERFACE_SERVER)

379

490

self.server.connect_to_signal("StateChanged",

380

self.server_state_changed)

491

self.server_state_changed)

381

492

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

382

493

383

494

384

495

class AvahiServiceToSyslog(AvahiService):

385

def rename(self):

496

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

386

497

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

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

498

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

499

syslogger.setFormatter(logging.Formatter(

500

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

501

.format(self.name)))

392

502

return ret

393

503

394

504

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

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

400

777

401

778

402

779

class Client(object):

403

780

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

404

781

405

782

Attributes:

406

783

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

407

784

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

409

786

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

410

787

to see if the client lives.

411

788

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

789

checker_callback_tag: a GLib event source tag, or None

413

790

checker_command: string; External command which is run to check

414

791

if client lives. %() expansions are done at

415

792

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

416

793

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

417

checker_initiator_tag: a gobject event source tag, or None

794

checker_initiator_tag: a GLib event source tag, or None

418

795

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

419

796

client_structure: Object describing what attributes a client has

420

797

and is used for storing the client at exit

421

798

current_checker_command: string; current running checker_command

422

disable_initiator_tag: a gobject event source tag, or None

799

disable_initiator_tag: a GLib event source tag, or None

423

800

enabled: bool()

424

801

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

425

802

uniquely identify the client

430

807

last_checker_status: integer between 0 and 255 reflecting exit

431

808

status of last checker. -1 reflects crashed

432

809

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

433

812

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

434

813

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

435

814

D-Bus identifiers

440

819

runtime_expansions: Allowed attributes for runtime expansion.

441

820

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

442

821

disabled, or None

822

server_settings: The server_settings dict from main()

443

823

"""

444

824

445

825

runtime_expansions = ("approval_delay", "approval_duration",

446

826

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

447

827

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

448

828

"last_approval_request", "last_checked_ok",

449

829

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

450

client_defaults = { "timeout": "PT5M",

451

"extended_timeout": "PT15M",

452

"interval": "PT2M",

453

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

454

"host": "",

455

"approval_delay": "PT0S",

456

"approval_duration": "PT1S",

457

"approved_by_default": "True",

458

"enabled": "True",

459

}

460

461

def timeout_milliseconds(self):

462

"Return the 'timeout' attribute in milliseconds"

463

return timedelta_to_milliseconds(self.timeout)

464

465

def extended_timeout_milliseconds(self):

466

"Return the 'extended_timeout' attribute in milliseconds"

467

return timedelta_to_milliseconds(self.extended_timeout)

468

469

def interval_milliseconds(self):

470

"Return the 'interval' attribute in milliseconds"

471

return timedelta_to_milliseconds(self.interval)

472

473

def approval_delay_milliseconds(self):

474

return timedelta_to_milliseconds(self.approval_delay)

475

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

476

842

@staticmethod

477

843

def config_parser(config):

478

844

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

485

851

for client_name in config.sections():

486

852

section = dict(config.items(client_name))

487

853

client = settings[client_name] = {}

488

854

489

855

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

490

856

# Reformat values from string types to Python types

491

857

client["approved_by_default"] = config.getboolean(

492

858

client_name, "approved_by_default")

493

859

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

494

860

"enabled")

495

861

862

# Uppercase and remove spaces from fingerprint for later

863

# comparison purposes with return value from the

864

# fingerprint() function

496

865

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

497

866

.replace(" ", ""))

498

867

if "secret" in section:

499

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

868

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

869

.encode("utf-8"),

870

"base64")

500

871

elif "secfile" in section:

501

872

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

502

873

(section["secfile"])),

503

874

"rb") as secfile:

504

875

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

505

876

else:

506

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

877

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

507

878

.format(section))

508

879

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

509

880

client["extended_timeout"] = string_to_delta(

517

888

client["last_approval_request"] = None

518

889

client["last_checked_ok"] = None

519

890

client["last_checker_status"] = -2

520

891

521

892

return settings

522

523

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

893

894

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

524

895

self.name = name

896

if server_settings is None:

897

server_settings = {}

898

self.server_settings = server_settings

525

899

# adding all client settings

526

for setting, value in settings.iteritems():

900

for setting, value in settings.items():

527

901

setattr(self, setting, value)

528

902

529

903

if self.enabled:

530

904

if not hasattr(self, "last_enabled"):

531

905

self.last_enabled = datetime.datetime.utcnow()

535

909

else:

536

910

self.last_enabled = None

537

911

self.expires = None

538

912

539

913

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

540

# Uppercase and remove spaces from fingerprint for later

541

# comparison purposes with return value from the fingerprint()

542

# function

543

914

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

544

915

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

545

916

datetime.datetime.utcnow())

546

917

547

918

# attributes specific for this server instance

548

919

self.checker = None

549

920

self.checker_initiator_tag = None

552

923

self.current_checker_command = None

553

924

self.approved = None

554

925

self.approvals_pending = 0

555

self.changedstate = (multiprocessing_manager

556

.Condition(multiprocessing_manager

557

.Lock()))

558

self.client_structure = [attr for attr in

559

self.__dict__.iterkeys()

926

self.changedstate = multiprocessing_manager.Condition(

927

multiprocessing_manager.Lock())

928

self.client_structure = [attr

929

for attr in self.__dict__.keys()

560

930

if not attr.startswith("_")]

561

931

self.client_structure.append("client_structure")

562

563

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

564

lambda obj:

565

isinstance(obj,

566

property)):

932

933

for name, t in inspect.getmembers(

934

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

567

935

if not name.startswith("_"):

568

936

self.client_structure.append(name)

569

937

570

938

# Send notice to process children that client state has changed

571

939

def send_changedstate(self):

572

940

with self.changedstate:

573

941

self.changedstate.notify_all()

574

942

575

943

def enable(self):

576

944

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

577

945

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

582

950

self.last_enabled = datetime.datetime.utcnow()

583

951

self.init_checker()

584

952

self.send_changedstate()

585

953

586

954

def disable(self, quiet=True):

587

955

"""Disable this client."""

588

956

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

590

958

if not quiet:

591

959

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

592

960

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

593

gobject.source_remove(self.disable_initiator_tag)

961

GLib.source_remove(self.disable_initiator_tag)

594

962

self.disable_initiator_tag = None

595

963

self.expires = None

596

964

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

597

gobject.source_remove(self.checker_initiator_tag)

965

GLib.source_remove(self.checker_initiator_tag)

598

966

self.checker_initiator_tag = None

599

967

self.stop_checker()

600

968

self.enabled = False

601

969

if not quiet:

602

970

self.send_changedstate()

603

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

971

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

604

972

return False

605

973

606

974

def __del__(self):

607

975

self.disable()

608

976

609

977

def init_checker(self):

610

978

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

611

979

# and every interval from then on.

612

980

if self.checker_initiator_tag is not None:

613

gobject.source_remove(self.checker_initiator_tag)

614

self.checker_initiator_tag = (gobject.timeout_add

615

(self.interval_milliseconds(),

616

self.start_checker))

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)

617

985

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

618

986

if self.disable_initiator_tag is not None:

619

gobject.source_remove(self.disable_initiator_tag)

620

self.disable_initiator_tag = (gobject.timeout_add

621

(self.timeout_milliseconds(),

622

self.disable))

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)

623

990

# Also start a new checker *right now*.

624

991

self.start_checker()

625

626

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

992

993

def checker_callback(self, source, condition, connection,

994

command):

627

995

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

628

996

self.checker_callback_tag = None

629

997

self.checker = None

630

if os.WIFEXITED(condition):

631

self.last_checker_status = os.WEXITSTATUS(condition)

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

632

1005

if self.last_checker_status == 0:

633

1006

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

634

1007

vars(self))

635

1008

self.checked_ok()

636

1009

else:

637

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

638

vars(self))

1010

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

639

1011

else:

640

1012

self.last_checker_status = -1

1013

self.last_checker_signal = -returncode

641

1014

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

642

1015

vars(self))

643

1016

return False

1017

644

1018

def checked_ok(self):

645

1019

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

646

1020

self.last_checked_ok = datetime.datetime.utcnow()

647

1021

self.last_checker_status = 0

1022

self.last_checker_signal = None

648

1023

self.bump_timeout()

649

1024

650

1025

def bump_timeout(self, timeout=None):

651

1026

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

652

1027

if timeout is None:

653

1028

timeout = self.timeout

654

1029

if self.disable_initiator_tag is not None:

655

gobject.source_remove(self.disable_initiator_tag)

1030

GLib.source_remove(self.disable_initiator_tag)

656

1031

self.disable_initiator_tag = None

657

1032

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

658

self.disable_initiator_tag = (gobject.timeout_add

659

(timedelta_to_milliseconds

660

(timeout), self.disable))

1033

self.disable_initiator_tag = GLib.timeout_add(

1034

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

661

1035

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

662

1036

663

1037

def need_approval(self):

664

1038

self.last_approval_request = datetime.datetime.utcnow()

665

1039

666

1040

def start_checker(self):

667

1041

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

668

1042

669

1043

If a checker already exists, leave it running and do

670

1044

nothing."""

671

1045

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

676

1050

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

677

1051

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

678

1052

# should be.

679

680

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

681

try:

682

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

683

except (AttributeError, OSError) as error:

684

if (isinstance(error, OSError)

685

and error.errno != errno.ECHILD):

686

raise error

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

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

693

1058

# Start a new checker if needed

694

1059

if self.checker is None:

695

1060

# Escape attributes for the shell

696

escaped_attrs = dict(

697

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

698

for attr in

699

self.runtime_expansions)

1061

escaped_attrs = {

1062

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

1063

for attr in self.runtime_expansions}

700

1064

try:

701

1065

command = self.checker_command % escaped_attrs

702

1066

except TypeError as error:

703

1067

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

704

self.checker_command, exc_info=error)

705

return True # Try again later

1068

self.checker_command,

1069

exc_info=error)

1070

return True # Try again later

706

1071

self.current_checker_command = command

707

try:

708

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

709

command, self.name)

710

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

711

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

712

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

713

# always replaced by /dev/null.)

714

self.checker = subprocess.Popen(command,

715

close_fds=True,

716

shell=True, cwd="/")

717

except OSError as error:

718

logger.error("Failed to start subprocess",

719

exc_info=error)

720

return True

721

self.checker_callback_tag = (gobject.child_watch_add

722

(self.checker.pid,

723

self.checker_callback,

724

data=command))

725

# The checker may have completed before the gobject

726

# watch was added. Check for this.

727

try:

728

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

729

except OSError as error:

730

if error.errno == errno.ECHILD:

731

# This should never happen

732

logger.error("Child process vanished",

733

exc_info=error)

734

return True

735

raise

736

if pid:

737

gobject.source_remove(self.checker_callback_tag)

738

self.checker_callback(pid, status, command)

739

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

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

740

1098

return True

741

1099

742

1100

def stop_checker(self):

743

1101

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

744

1102

if self.checker_callback_tag:

745

gobject.source_remove(self.checker_callback_tag)

1103

GLib.source_remove(self.checker_callback_tag)

746

1104

self.checker_callback_tag = None

747

1105

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

748

1106

return

749

1107

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

750

try:

751

self.checker.terminate()

752

#time.sleep(0.5)

753

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

754

# self.checker.kill()

755

except OSError as error:

756

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

757

raise

1108

self.checker.terminate()

758

1109

self.checker = None

759

1110

760

1111

761

def dbus_service_property(dbus_interface, signature="v",

762

access="readwrite", byte_arrays=False):

1112

def dbus_service_property(dbus_interface,

1113

signature="v",

1114

access="readwrite",

1115

byte_arrays=False):

763

1116

"""Decorators for marking methods of a DBusObjectWithProperties to

764

1117

become properties on the D-Bus.

765

1118

766

1119

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

767

1120

and with one argument by "Set".

768

1121

769

1122

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

770

1123

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

771

1124

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

774

1127

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

775

1128

if byte_arrays and signature != "ay":

776

1129

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

777

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

1130

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

1131

778

1132

def decorator(func):

779

1133

func._dbus_is_property = True

780

1134

func._dbus_interface = dbus_interface

783

1137

func._dbus_name = func.__name__

784

1138

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

785

1139

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

786

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1140

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

787

1141

return func

1142

788

1143

return decorator

789

1144

790

1145

791

1146

def dbus_interface_annotations(dbus_interface):

792

1147

"""Decorator for marking functions returning interface annotations

793

1148

794

1149

Usage:

795

1150

796

1151

@dbus_interface_annotations("org.example.Interface")

797

1152

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

798

1153

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

799

1154

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

800

1155

"false"}

801

1156

"""

1157

802

1158

def decorator(func):

803

1159

func._dbus_is_interface = True

804

1160

func._dbus_interface = dbus_interface

805

1161

func._dbus_name = dbus_interface

806

1162

return func

1163

807

1164

return decorator

808

1165

809

1166

810

1167

def dbus_annotations(annotations):

811

1168

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

812

1169

Usage:

813

1170

1171

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

1172

"org.freedesktop.DBus.Property."

1173

"EmitsChangedSignal": "false"})

814

1174

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

815

1175

access="r")

816

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

817

"org.freedesktop.DBus.Property."

818

"EmitsChangedSignal": "false"})

819

1176

def Property_dbus_property(self):

820

1177

return dbus.Boolean(False)

1178

1179

See also the DBusObjectWithAnnotations class.

821

1180

"""

1181

822

1182

def decorator(func):

823

1183

func._dbus_annotations = annotations

824

1184

return func

1185

825

1186

return decorator

826

1187

827

1188

828

1189

class DBusPropertyException(dbus.exceptions.DBusException):

829

1190

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

830

1191

"""

831

def __unicode__(self):

832

return unicode(str(self))

1192

pass

833

1193

834

1194

835

1195

class DBusPropertyAccessException(DBusPropertyException):

844

1204

pass

845

1205

846

1206

847

class DBusObjectWithProperties(dbus.service.Object):

848

"""A D-Bus object with properties.

849

850

Classes inheriting from this can use the dbus_service_property

851

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

852

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

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.

853

1212

"""

854

1213

855

1214

@staticmethod

856

1215

def _is_dbus_thing(thing):

857

1216

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

858

1217

859

1218

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

860

1219

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

861

1220

"""

862

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

1221

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

863

1222

False)

864

1223

865

1224

def _get_all_dbus_things(self, thing):

866

1225

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

867

1226

"""

868

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

869

name),

1227

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

870

1228

athing.__get__(self))

871

1229

for cls in self.__class__.__mro__

872

1230

for name, athing in

873

inspect.getmembers(cls,

874

self._is_dbus_thing(thing)))

875

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

876

1304

def _get_dbus_property(self, interface_name, property_name):

877

1305

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

878

1306

property with the specified name and interface.

879

1307

"""

880

for cls in self.__class__.__mro__:

881

for name, value in (inspect.getmembers

882

(cls,

883

self._is_dbus_thing("property"))):

1308

for cls in self.__class__.__mro__:

1309

for name, value in inspect.getmembers(

1310

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

884

1311

if (value._dbus_name == property_name

885

1312

and value._dbus_interface == interface_name):

886

1313

return value.__get__(self)

887

1314

888

1315

# No such property

889

raise DBusPropertyNotFound(self.dbus_object_path + ":"

890

+ interface_name + "."

891

+ property_name)

892

893

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

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

894

1330

out_signature="v")

895

1331

def Get(self, interface_name, property_name):

896

1332

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

902

1338

if not hasattr(value, "variant_level"):

903

1339

return value

904

1340

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

905

1341

906

1342

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

907

1343

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

908

1344

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

914

1350

# The byte_arrays option is not supported yet on

915

1351

# signatures other than "ay".

916

1352

if prop._dbus_signature != "ay":

917

raise ValueError

1353

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

1354

"'ay' signature {!r}"

1355

.format(prop._dbus_signature))

918

1356

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

919

1357

for byte in value))

920

1358

prop(value)

921

922

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

1359

1360

@dbus.service.method(dbus.PROPERTIES_IFACE,

1361

in_signature="s",

923

1362

out_signature="a{sv}")

924

1363

def GetAll(self, interface_name):

925

1364

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

926

1365

standard.

927

1366

928

1367

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

929

1368

"""

930

1369

properties = {}

940

1379

if not hasattr(value, "variant_level"):

941

1380

properties[name] = value

942

1381

continue

943

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

944

value.variant_level+1)

1382

properties[name] = type(value)(

1383

value, variant_level=value.variant_level + 1)

945

1384

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

946

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

947

1394

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

948

1395

out_signature="s",

949

1396

path_keyword='object_path',

950

1397

connection_keyword='connection')

951

1398

def Introspect(self, object_path, connection):

952

1399

"""Overloading of standard D-Bus method.

953

1400

954

1401

Inserts property tags and interface annotation tags.

955

1402

"""

956

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

957

connection)

1403

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1404

object_path,

1405

connection)

958

1406

try:

959

1407

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

1408

960

1409

def make_tag(document, name, prop):

961

1410

e = document.createElement("property")

962

1411

e.setAttribute("name", name)

963

1412

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

964

1413

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

965

1414

return e

1415

966

1416

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

967

1417

# Add property tags

968

1418

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

971

1421

if prop._dbus_interface

972

1422

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

973

1423

if_tag.appendChild(tag)

974

# Add annotation tags

975

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

976

for tag in if_tag.getElementsByTagName(typ):

977

annots = dict()

978

for name, prop in (self.

979

_get_all_dbus_things(typ)):

980

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

981

and prop._dbus_interface

982

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

983

annots.update(getattr

984

(prop,

985

"_dbus_annotations",

986

{}))

987

for name, value in annots.iteritems():

988

ann_tag = document.createElement(

989

"annotation")

990

ann_tag.setAttribute("name", name)

991

ann_tag.setAttribute("value", value)

992

tag.appendChild(ann_tag)

993

# Add interface annotation tags

994

for annotation, value in dict(

995

itertools.chain.from_iterable(

996

annotations().iteritems()

997

for name, annotations in

998

self._get_all_dbus_things("interface")

999

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

1000

)).iteritems():

1001

ann_tag = document.createElement("annotation")

1002

ann_tag.setAttribute("name", annotation)

1003

ann_tag.setAttribute("value", value)

1004

if_tag.appendChild(ann_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)

1005

1440

# Add the names to the return values for the

1006

1441

# "org.freedesktop.DBus.Properties" methods

1007

1442

if (if_tag.getAttribute("name")

1025

1460

exc_info=error)

1026

1461

return xmlstring

1027

1462

1463

try:

1464

dbus.OBJECT_MANAGER_IFACE

1465

except AttributeError:

1466

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

1467

1468

1469

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1470

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

1471

1472

Classes inheriting from this exposes the standard

1473

GetManagedObjects call and the InterfacesAdded and

1474

InterfacesRemoved signals on the standard

1475

"org.freedesktop.DBus.ObjectManager" interface.

1476

1477

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

1478

manually.

1479

"""

1480

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1481

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

1482

def GetManagedObjects(self):

1483

"""This function must be overridden"""

1484

raise NotImplementedError()

1485

1486

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1487

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

1488

def InterfacesAdded(self, object_path, interfaces_and_properties):

1489

pass

1490

1491

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

1492

def InterfacesRemoved(self, object_path, interfaces):

1493

pass

1494

1495

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1496

out_signature="s",

1497

path_keyword='object_path',

1498

connection_keyword='connection')

1499

def Introspect(self, object_path, connection):

1500

"""Overloading of standard D-Bus method.

1501

1502

Override return argument name of GetManagedObjects to be

1503

"objpath_interfaces_and_properties"

1504

"""

1505

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1506

object_path,

1507

connection)

1508

try:

1509

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

1510

1511

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

1512

# Fix argument name for the GetManagedObjects method

1513

if (if_tag.getAttribute("name")

1514

== dbus.OBJECT_MANAGER_IFACE):

1515

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

1516

if (cn.getAttribute("name")

1517

== "GetManagedObjects"):

1518

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

1519

if (arg.getAttribute("direction")

1520

== "out"):

1521

arg.setAttribute(

1522

"name",

1523

"objpath_interfaces"

1524

"_and_properties")

1525

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

1526

document.unlink()

1527

except (AttributeError, xml.dom.DOMException,

1528

xml.parsers.expat.ExpatError) as error:

1529

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

1530

exc_info=error)

1531

return xmlstring

1532

1028

1533

1029

1534

def datetime_to_dbus(dt, variant_level=0):

1030

1535

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

1031

1536

if dt is None:

1032

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

1033

return dbus.String(dt.isoformat(),

1034

variant_level=variant_level)

1537

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

1538

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

1035

1539

1036

1540

1037

1541

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1039

1543

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

1040

1544

interface names according to the "alt_interface_names" mapping.

1041

1545

Usage:

1042

1546

1043

1547

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

1044

1548

"net.example.AlternateInterface"})

1045

1549

class SampleDBusObject(dbus.service.Object):

1046

1550

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

1047

1551

def SampleDBusMethod():

1048

1552

pass

1049

1553

1050

1554

The above "SampleDBusMethod" on "SampleDBusObject" will be

1051

1555

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

1052

1556

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

1053

1557

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

1054

1558

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

1055

1559

1056

1560

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

1057

1561

(from DBusObjectWithProperties) and interfaces (from the

1058

1562

dbus_interface_annotations decorator).

1059

1563

"""

1564

1060

1565

def wrapper(cls):

1061

1566

for orig_interface_name, alt_interface_name in (

1062

alt_interface_names.iteritems()):

1567

alt_interface_names.items()):

1063

1568

attr = {}

1064

1569

interface_names = set()

1065

1570

# Go though all attributes of the class

1067

1572

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

1068

1573

# with the wrong interface name

1069

1574

if (not hasattr(attribute, "_dbus_interface")

1070

or not attribute._dbus_interface

1071

.startswith(orig_interface_name)):

1575

or not attribute._dbus_interface.startswith(

1576

orig_interface_name)):

1072

1577

continue

1073

1578

# Create an alternate D-Bus interface name based on

1074

1579

# the current name

1075

alt_interface = (attribute._dbus_interface

1076

.replace(orig_interface_name,

1077

alt_interface_name))

1580

alt_interface = attribute._dbus_interface.replace(

1581

orig_interface_name, alt_interface_name)

1078

1582

interface_names.add(alt_interface)

1079

1583

# Is this a D-Bus signal?

1080

1584

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

1081

# Extract the original non-method function by

1082

# black magic

1083

nonmethod_func = (dict(

1585

# Extract the original non-method undecorated

1586

# function by black magic

1587

if sys.version_info.major == 2:

1588

nonmethod_func = (dict(

1084

1589

zip(attribute.func_code.co_freevars,

1085

attribute.__closure__))["func"]

1086

.cell_contents)

1590

attribute.__closure__))

1591

["func"].cell_contents)

1592

else:

1593

nonmethod_func = (dict(

1594

zip(attribute.__code__.co_freevars,

1595

attribute.__closure__))

1596

["func"].cell_contents)

1087

1597

# Create a new, but exactly alike, function

1088

1598

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

1089

1599

# with the alternate D-Bus interface name

1090

new_function = (dbus.service.signal

1091

(alt_interface,

1092

attribute._dbus_signature)

1093

(types.FunctionType(

1094

nonmethod_func.func_code,

1095

nonmethod_func.func_globals,

1096

nonmethod_func.func_name,

1097

nonmethod_func.func_defaults,

1098

nonmethod_func.func_closure)))

1600

new_function = copy_function(nonmethod_func)

1601

new_function = (dbus.service.signal(

1602

alt_interface,

1603

attribute._dbus_signature)(new_function))

1099

1604

# Copy annotations, if any

1100

1605

try:

1101

new_function._dbus_annotations = (

1102

dict(attribute._dbus_annotations))

1606

new_function._dbus_annotations = dict(

1607

attribute._dbus_annotations)

1103

1608

except AttributeError:

1104

1609

pass

1610

1105

1611

# Define a creator of a function to call both the

1106

1612

# original and alternate functions, so both the

1107

1613

# original and alternate signals gets sent when

1110

1616

"""This function is a scope container to pass

1111

1617

func1 and func2 to the "call_both" function

1112

1618

outside of its arguments"""

1619

1620

@functools.wraps(func2)

1113

1621

def call_both(*args, **kwargs):

1114

1622

"""This function will emit two D-Bus

1115

1623

signals by calling func1 and func2"""

1116

1624

func1(*args, **kwargs)

1117

1625

func2(*args, **kwargs)

1626

# Make wrapper function look like a D-Bus

1627

# signal

1628

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

1629

if name.startswith("_dbus_"):

1630

setattr(call_both, name, attr)

1631

1118

1632

return call_both

1119

1633

# Create the "call_both" function and add it to

1120

1634

# the class

1125

1639

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

1126

1640

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

1127

1641

# to the class.

1128

attr[attrname] = (dbus.service.method

1129

(alt_interface,

1130

attribute._dbus_in_signature,

1131

attribute._dbus_out_signature)

1132

(types.FunctionType

1133

(attribute.func_code,

1134

attribute.func_globals,

1135

attribute.func_name,

1136

attribute.func_defaults,

1137

attribute.func_closure)))

1642

attr[attrname] = (

1643

dbus.service.method(

1644

alt_interface,

1645

attribute._dbus_in_signature,

1646

attribute._dbus_out_signature)

1647

(copy_function(attribute)))

1138

1648

# Copy annotations, if any

1139

1649

try:

1140

attr[attrname]._dbus_annotations = (

1141

dict(attribute._dbus_annotations))

1650

attr[attrname]._dbus_annotations = dict(

1651

attribute._dbus_annotations)

1142

1652

except AttributeError:

1143

1653

pass

1144

1654

# Is this a D-Bus property?

1147

1657

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

1148

1658

# property with the alternate D-Bus interface

1149

1659

# name. Add it to the class.

1150

attr[attrname] = (dbus_service_property

1151

(alt_interface,

1152

attribute._dbus_signature,

1153

attribute._dbus_access,

1154

attribute

1155

._dbus_get_args_options

1156

["byte_arrays"])

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1660

attr[attrname] = (dbus_service_property(

1661

alt_interface, attribute._dbus_signature,

1662

attribute._dbus_access,

1663

attribute._dbus_get_args_options

1664

["byte_arrays"])

1665

(copy_function(attribute)))

1163

1666

# Copy annotations, if any

1164

1667

try:

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1668

attr[attrname]._dbus_annotations = dict(

1669

attribute._dbus_annotations)

1167

1670

except AttributeError:

1168

1671

pass

1169

1672

# Is this a D-Bus interface?

1172

1675

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

1173

1676

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

1174

1677

# to the class.

1175

attr[attrname] = (dbus_interface_annotations

1176

(alt_interface)

1177

(types.FunctionType

1178

(attribute.func_code,

1179

attribute.func_globals,

1180

attribute.func_name,

1181

attribute.func_defaults,

1182

attribute.func_closure)))

1678

attr[attrname] = (

1679

dbus_interface_annotations(alt_interface)

1680

(copy_function(attribute)))

1183

1681

if deprecate:

1184

1682

# Deprecate all alternate interfaces

1185

iname="_AlternateDBusNames_interface_annotation{0}"

1683

iname = "_AlternateDBusNames_interface_annotation{}"

1186

1684

for interface_name in interface_names:

1685

1187

1686

@dbus_interface_annotations(interface_name)

1188

1687

def func(self):

1189

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

1190

"true" }

1688

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

1689

"true"}

1191

1690

# Find an unused name

1192

1691

for aname in (iname.format(i)

1193

1692

for i in itertools.count()):

1197

1696

if interface_names:

1198

1697

# Replace the class with a new subclass of it with

1199

1698

# methods, signals, etc. as created above.

1200

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

1201

(cls,), attr)

1699

if sys.version_info.major == 2:

1700

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

1701

(cls, ), attr)

1702

else:

1703

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

1704

(cls, ), attr)

1202

1705

return cls

1706

1203

1707

return wrapper

1204

1708

1205

1709

1206

1710

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

1207

"se.bsnet.fukt.Mandos"})

1711

"se.bsnet.fukt.Mandos"})

1208

1712

class ClientDBus(Client, DBusObjectWithProperties):

1209

1713

"""A Client class using D-Bus

1210

1714

1211

1715

Attributes:

1212

1716

dbus_object_path: dbus.ObjectPath

1213

1717

bus: dbus.SystemBus()

1214

1718

"""

1215

1719

1216

1720

runtime_expansions = (Client.runtime_expansions

1217

+ ("dbus_object_path",))

1218

1721

+ ("dbus_object_path", ))

1722

1723

_interface = "se.recompile.Mandos.Client"

1724

1219

1725

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

1220

1221

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

1726

1727

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

1222

1728

self.bus = bus

1223

1729

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

1224

1730

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

1225

1731

# the D-Bus

1226

client_object_name = unicode(self.name).translate(

1732

client_object_name = str(self.name).translate(

1227

1733

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

1228

1734

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

1229

self.dbus_object_path = (dbus.ObjectPath

1230

("/clients/" + client_object_name))

1735

self.dbus_object_path = dbus.ObjectPath(

1736

"/clients/" + client_object_name)

1231

1737

DBusObjectWithProperties.__init__(self, self.bus,

1232

1738

self.dbus_object_path)

1233

1234

def notifychangeproperty(transform_func,

1235

dbus_name, type_func=lambda x: x,

1236

variant_level=1):

1739

1740

def notifychangeproperty(transform_func, dbus_name,

1741

type_func=lambda x: x,

1742

variant_level=1,

1743

invalidate_only=False,

1744

_interface=_interface):

1237

1745

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

1238

1746

its changes to DBus.

1239

1747

1240

1748

transform_fun: Function that takes a value and a variant_level

1241

1749

and transforms it to a D-Bus type.

1242

1750

dbus_name: D-Bus name of the variable

1244

1752

to the D-Bus. Default: no transform

1245

1753

variant_level: D-Bus variant level. Default: 1

1246

1754

"""

1247

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

1755

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

1756

1248

1757

def setter(self, value):

1249

1758

if hasattr(self, "dbus_object_path"):

1250

1759

if (not hasattr(self, attrname) or

1251

1760

type_func(getattr(self, attrname, None))

1252

1761

!= type_func(value)):

1253

dbus_value = transform_func(type_func(value),

1254

variant_level

1255

=variant_level)

1256

self.PropertyChanged(dbus.String(dbus_name),

1257

dbus_value)

1762

if invalidate_only:

1763

self.PropertiesChanged(

1764

_interface, dbus.Dictionary(),

1765

dbus.Array((dbus_name, )))

1766

else:

1767

dbus_value = transform_func(

1768

type_func(value),

1769

variant_level=variant_level)

1770

self.PropertyChanged(dbus.String(dbus_name),

1771

dbus_value)

1772

self.PropertiesChanged(

1773

_interface,

1774

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

1775

dbus_value}),

1776

dbus.Array())

1258

1777

setattr(self, attrname, value)

1259

1778

1260

1779

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

1261

1780

1262

1781

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1263

1782

approvals_pending = notifychangeproperty(dbus.Boolean,

1264

1783

"ApprovalPending",

1265

type_func = bool)

1784

type_func=bool)

1266

1785

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

1267

1786

last_enabled = notifychangeproperty(datetime_to_dbus,

1268

1787

"LastEnabled")

1269

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

1270

type_func = lambda checker:

1271

checker is not None)

1788

checker = notifychangeproperty(

1789

dbus.Boolean, "CheckerRunning",

1790

type_func=lambda checker: checker is not None)

1272

1791

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1273

1792

"LastCheckedOK")

1274

1793

last_checker_status = notifychangeproperty(dbus.Int16,

1277

1796

datetime_to_dbus, "LastApprovalRequest")

1278

1797

approved_by_default = notifychangeproperty(dbus.Boolean,

1279

1798

"ApprovedByDefault")

1280

approval_delay = notifychangeproperty(dbus.UInt64,

1281

"ApprovalDelay",

1282

type_func =

1283

timedelta_to_milliseconds)

1799

approval_delay = notifychangeproperty(

1800

dbus.UInt64, "ApprovalDelay",

1801

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

1284

1802

approval_duration = notifychangeproperty(

1285

1803

dbus.UInt64, "ApprovalDuration",

1286

type_func = timedelta_to_milliseconds)

1804

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

1287

1805

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

1288

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

1289

type_func =

1290

timedelta_to_milliseconds)

1806

timeout = notifychangeproperty(

1807

dbus.UInt64, "Timeout",

1808

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

1291

1809

extended_timeout = notifychangeproperty(

1292

1810

dbus.UInt64, "ExtendedTimeout",

1293

type_func = timedelta_to_milliseconds)

1294

interval = notifychangeproperty(dbus.UInt64,

1295

"Interval",

1296

type_func =

1297

timedelta_to_milliseconds)

1811

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

1812

interval = notifychangeproperty(

1813

dbus.UInt64, "Interval",

1814

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

1298

1815

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

1299

1816

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

1817

invalidate_only=True)

1818

1300

1819

del notifychangeproperty

1301

1820

1302

1821

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

1303

1822

try:

1304

1823

self.remove_from_connection()

1307

1826

if hasattr(DBusObjectWithProperties, "__del__"):

1308

1827

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

1309

1828

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

1310

1311

def checker_callback(self, pid, condition, command,

1312

*args, **kwargs):

1313

self.checker_callback_tag = None

1314

self.checker = None

1315

if os.WIFEXITED(condition):

1316

exitstatus = os.WEXITSTATUS(condition)

1829

1830

def checker_callback(self, source, condition,

1831

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

1832

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

1833

connection, command, *args,

1834

**kwargs)

1835

exitstatus = self.last_checker_status

1836

if exitstatus >= 0:

1317

1837

# Emit D-Bus signal

1318

1838

self.CheckerCompleted(dbus.Int16(exitstatus),

1319

dbus.Int64(condition),

1839

# This is specific to GNU libC

1840

dbus.Int64(exitstatus << 8),

1320

1841

dbus.String(command))

1321

1842

else:

1322

1843

# Emit D-Bus signal

1323

1844

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

1324

dbus.Int64(condition),

1845

dbus.Int64(

1846

# This is specific to GNU libC

1847

(exitstatus << 8)

1848

| self.last_checker_signal),

1325

1849

dbus.String(command))

1326

1327

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

1328

*args, **kwargs)

1329

1850

return ret

1851

1330

1852

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

1331

old_checker = self.checker

1332

if self.checker is not None:

1333

old_checker_pid = self.checker.pid

1334

else:

1335

old_checker_pid = None

1853

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

1336

1854

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

1337

1855

# Only if new checker process was started

1338

1856

if (self.checker is not None

1340

1858

# Emit D-Bus signal

1341

1859

self.CheckerStarted(self.current_checker_command)

1342

1860

return r

1343

1861

1344

1862

def _reset_approved(self):

1345

1863

self.approved = None

1346

1864

return False

1347

1865

1348

1866

def approve(self, value=True):

1349

1867

self.approved = value

1350

gobject.timeout_add(timedelta_to_milliseconds

1351

(self.approval_duration),

1352

self._reset_approved)

1868

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

1869

* 1000), self._reset_approved)

1353

1870

self.send_changedstate()

1354

1355

## D-Bus methods, signals & properties

1356

_interface = "se.recompile.Mandos.Client"

1357

1358

## Interfaces

1359

1360

@dbus_interface_annotations(_interface)

1361

def _foo(self):

1362

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

1363

"false"}

1364

1365

## Signals

1366

1871

1872

# D-Bus methods, signals & properties

1873

1874

# Interfaces

1875

1876

# Signals

1877

1367

1878

# CheckerCompleted - signal

1368

1879

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

1369

1880

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

1370

1881

"D-Bus signal"

1371

1882

pass

1372

1883

1373

1884

# CheckerStarted - signal

1374

1885

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

1375

1886

def CheckerStarted(self, command):

1376

1887

"D-Bus signal"

1377

1888

pass

1378

1889

1379

1890

# PropertyChanged - signal

1891

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

1380

1892

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

1381

1893

def PropertyChanged(self, property, value):

1382

1894

"D-Bus signal"

1383

1895

pass

1384

1896

1385

1897

# GotSecret - signal

1386

1898

@dbus.service.signal(_interface)

1387

1899

def GotSecret(self):

1390

1902

server to mandos-client

1391

1903

"""

1392

1904

pass

1393

1905

1394

1906

# Rejected - signal

1395

1907

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

1396

1908

def Rejected(self, reason):

1397

1909

"D-Bus signal"

1398

1910

pass

1399

1911

1400

1912

# NeedApproval - signal

1401

1913

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

1402

1914

def NeedApproval(self, timeout, default):

1403

1915

"D-Bus signal"

1404

1916

return self.need_approval()

1405

1406

## Methods

1407

1917

1918

# Methods

1919

1408

1920

# Approve - method

1409

1921

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

1410

1922

def Approve(self, value):

1411

1923

self.approve(value)

1412

1924

1413

1925

# CheckedOK - method

1414

1926

@dbus.service.method(_interface)

1415

1927

def CheckedOK(self):

1416

1928

self.checked_ok()

1417

1929

1418

1930

# Enable - method

1931

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

1419

1932

@dbus.service.method(_interface)

1420

1933

def Enable(self):

1421

1934

"D-Bus method"

1422

1935

self.enable()

1423

1936

1424

1937

# StartChecker - method

1938

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

1425

1939

@dbus.service.method(_interface)

1426

1940

def StartChecker(self):

1427

1941

"D-Bus method"

1428

1942

self.start_checker()

1429

1943

1430

1944

# Disable - method

1945

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

1431

1946

@dbus.service.method(_interface)

1432

1947

def Disable(self):

1433

1948

"D-Bus method"

1434

1949

self.disable()

1435

1950

1436

1951

# StopChecker - method

1952

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

1437

1953

@dbus.service.method(_interface)

1438

1954

def StopChecker(self):

1439

1955

self.stop_checker()

1440

1441

## Properties

1442

1956

1957

# Properties

1958

1443

1959

# ApprovalPending - property

1444

1960

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

1445

1961

def ApprovalPending_dbus_property(self):

1446

1962

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

1447

1963

1448

1964

# ApprovedByDefault - property

1449

@dbus_service_property(_interface, signature="b",

1965

@dbus_service_property(_interface,

1966

signature="b",

1450

1967

access="readwrite")

1451

1968

def ApprovedByDefault_dbus_property(self, value=None):

1452

1969

if value is None: # get

1453

1970

return dbus.Boolean(self.approved_by_default)

1454

1971

self.approved_by_default = bool(value)

1455

1972

1456

1973

# ApprovalDelay - property

1457

@dbus_service_property(_interface, signature="t",

1974

@dbus_service_property(_interface,

1975

signature="t",

1458

1976

access="readwrite")

1459

1977

def ApprovalDelay_dbus_property(self, value=None):

1460

1978

if value is None: # get

1461

return dbus.UInt64(self.approval_delay_milliseconds())

1979

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

1980

* 1000)

1462

1981

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

1463

1982

1464

1983

# ApprovalDuration - property

1465

@dbus_service_property(_interface, signature="t",

1984

@dbus_service_property(_interface,

1985

signature="t",

1466

1986

access="readwrite")

1467

1987

def ApprovalDuration_dbus_property(self, value=None):

1468

1988

if value is None: # get

1469

return dbus.UInt64(timedelta_to_milliseconds(

1470

self.approval_duration))

1989

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

1990

* 1000)

1471

1991

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

1472

1992

1473

1993

# Name - property

1994

@dbus_annotations(

1995

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

1474

1996

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

1475

1997

def Name_dbus_property(self):

1476

1998

return dbus.String(self.name)

1477

1999

1478

2000

# Fingerprint - property

2001

@dbus_annotations(

2002

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

1479

2003

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

1480

2004

def Fingerprint_dbus_property(self):

1481

2005

return dbus.String(self.fingerprint)

1482

2006

1483

2007

# Host - property

1484

@dbus_service_property(_interface, signature="s",

2008

@dbus_service_property(_interface,

2009

signature="s",

1485

2010

access="readwrite")

1486

2011

def Host_dbus_property(self, value=None):

1487

2012

if value is None: # get

1488

2013

return dbus.String(self.host)

1489

self.host = unicode(value)

1490

2014

self.host = str(value)

2015

1491

2016

# Created - property

2017

@dbus_annotations(

2018

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

1492

2019

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

1493

2020

def Created_dbus_property(self):

1494

2021

return datetime_to_dbus(self.created)

1495

2022

1496

2023

# LastEnabled - property

1497

2024

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

1498

2025

def LastEnabled_dbus_property(self):

1499

2026

return datetime_to_dbus(self.last_enabled)

1500

2027

1501

2028

# Enabled - property

1502

@dbus_service_property(_interface, signature="b",

2029

@dbus_service_property(_interface,

2030

signature="b",

1503

2031

access="readwrite")

1504

2032

def Enabled_dbus_property(self, value=None):

1505

2033

if value is None: # get

1508

2036

self.enable()

1509

2037

else:

1510

2038

self.disable()

1511

2039

1512

2040

# LastCheckedOK - property

1513

@dbus_service_property(_interface, signature="s",

2041

@dbus_service_property(_interface,

2042

signature="s",

1514

2043

access="readwrite")

1515

2044

def LastCheckedOK_dbus_property(self, value=None):

1516

2045

if value is not None:

1517

2046

self.checked_ok()

1518

2047

return

1519

2048

return datetime_to_dbus(self.last_checked_ok)

1520

2049

1521

2050

# LastCheckerStatus - property

1522

@dbus_service_property(_interface, signature="n",

1523

access="read")

2051

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

1524

2052

def LastCheckerStatus_dbus_property(self):

1525

2053

return dbus.Int16(self.last_checker_status)

1526

2054

1527

2055

# Expires - property

1528

2056

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

1529

2057

def Expires_dbus_property(self):

1530

2058

return datetime_to_dbus(self.expires)

1531

2059

1532

2060

# LastApprovalRequest - property

1533

2061

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

1534

2062

def LastApprovalRequest_dbus_property(self):

1535

2063

return datetime_to_dbus(self.last_approval_request)

1536

2064

1537

2065

# Timeout - property

1538

@dbus_service_property(_interface, signature="t",

2066

@dbus_service_property(_interface,

2067

signature="t",

1539

2068

access="readwrite")

1540

2069

def Timeout_dbus_property(self, value=None):

1541

2070

if value is None: # get

1542

return dbus.UInt64(self.timeout_milliseconds())

2071

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

1543

2072

old_timeout = self.timeout

1544

2073

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

1545

2074

# Reschedule disabling

1553

2082

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

1554

2083

is None):

1555

2084

return

1556

gobject.source_remove(self.disable_initiator_tag)

1557

self.disable_initiator_tag = (

1558

gobject.timeout_add(

1559

timedelta_to_milliseconds(self.expires - now),

1560

self.disable))

1561

2085

GLib.source_remove(self.disable_initiator_tag)

2086

self.disable_initiator_tag = GLib.timeout_add(

2087

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

2088

self.disable)

2089

1562

2090

# ExtendedTimeout - property

1563

@dbus_service_property(_interface, signature="t",

2091

@dbus_service_property(_interface,

2092

signature="t",

1564

2093

access="readwrite")

1565

2094

def ExtendedTimeout_dbus_property(self, value=None):

1566

2095

if value is None: # get

1567

return dbus.UInt64(self.extended_timeout_milliseconds())

2096

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

2097

* 1000)

1568

2098

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

1569

2099

1570

2100

# Interval - property

1571

@dbus_service_property(_interface, signature="t",

2101

@dbus_service_property(_interface,

2102

signature="t",

1572

2103

access="readwrite")

1573

2104

def Interval_dbus_property(self, value=None):

1574

2105

if value is None: # get

1575

return dbus.UInt64(self.interval_milliseconds())

2106

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

1576

2107

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

1577

2108

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

1578

2109

return

1579

2110

if self.enabled:

1580

2111

# Reschedule checker run

1581

gobject.source_remove(self.checker_initiator_tag)

1582

self.checker_initiator_tag = (gobject.timeout_add

1583

(value, self.start_checker))

1584

self.start_checker() # Start one now, too

1585

2112

GLib.source_remove(self.checker_initiator_tag)

2113

self.checker_initiator_tag = GLib.timeout_add(

2114

value, self.start_checker)

2115

self.start_checker() # Start one now, too

2116

1586

2117

# Checker - property

1587

@dbus_service_property(_interface, signature="s",

2118

@dbus_service_property(_interface,

2119

signature="s",

1588

2120

access="readwrite")

1589

2121

def Checker_dbus_property(self, value=None):

1590

2122

if value is None: # get

1591

2123

return dbus.String(self.checker_command)

1592

self.checker_command = unicode(value)

1593

2124

self.checker_command = str(value)

2125

1594

2126

# CheckerRunning - property

1595

@dbus_service_property(_interface, signature="b",

2127

@dbus_service_property(_interface,

2128

signature="b",

1596

2129

access="readwrite")

1597

2130

def CheckerRunning_dbus_property(self, value=None):

1598

2131

if value is None: # get

1601

2134

self.start_checker()

1602

2135

else:

1603

2136

self.stop_checker()

1604

2137

1605

2138

# ObjectPath - property

2139

@dbus_annotations(

2140

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

2141

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

1606

2142

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

1607

2143

def ObjectPath_dbus_property(self):

1608

return self.dbus_object_path # is already a dbus.ObjectPath

1609

2144

return self.dbus_object_path # is already a dbus.ObjectPath

2145

1610

2146

# Secret = property

1611

@dbus_service_property(_interface, signature="ay",

1612

access="write", byte_arrays=True)

2147

@dbus_annotations(

2148

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

2149

"invalidates"})

2150

@dbus_service_property(_interface,

2151

signature="ay",

2152

access="write",

2153

byte_arrays=True)

1613

2154

def Secret_dbus_property(self, value):

1614

self.secret = str(value)

1615

2155

self.secret = bytes(value)

2156

1616

2157

del _interface

1617

2158

1618

2159

1621

2162

self._pipe = child_pipe

1622

2163

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

1623

2164

if not self._pipe.recv():

1624

raise KeyError()

1625

2165

raise KeyError(fpr)

2166

1626

2167

def __getattribute__(self, name):

1627

2168

if name == '_pipe':

1628

2169

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

1631

2172

if data[0] == 'data':

1632

2173

return data[1]

1633

2174

if data[0] == 'function':

2175

1634

2176

def func(*args, **kwargs):

1635

2177

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

1636

2178

return self._pipe.recv()[1]

2179

1637

2180

return func

1638

2181

1639

2182

def __setattr__(self, name, value):

1640

2183

if name == '_pipe':

1641

2184

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

1644

2187

1645

2188

class ClientHandler(socketserver.BaseRequestHandler, object):

1646

2189

"""A class to handle client connections.

1647

2190

1648

2191

Instantiated once for each connection to handle it.

1649

2192

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

1650

2193

1651

2194

def handle(self):

1652

2195

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

1653

2196

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

1654

unicode(self.client_address))

2197

str(self.client_address))

1655

2198

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

1656

2199

self.server.child_pipe.fileno())

1657

1658

session = (gnutls.connection

1659

.ClientSession(self.request,

1660

gnutls.connection

1661

.X509Credentials()))

1662

1663

# Note: gnutls.connection.X509Credentials is really a

1664

# generic GnuTLS certificate credentials object so long as

1665

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

1666

# here despite using OpenPGP certificates.

1667

1668

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

1669

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

1670

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

1671

# "+DHE-DSS"))

2200

2201

session = gnutls.ClientSession(self.request)

2202

2203

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

2204

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

2205

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

2206

# "+DHE-DSS"))

1672

2207

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

1673

2208

priority = self.server.gnutls_priority

1674

2209

if priority is None:

1675

2210

priority = "NORMAL"

1676

(gnutls.library.functions

1677

.gnutls_priority_set_direct(session._c_object,

1678

priority, None))

1679

2211

gnutls.priority_set_direct(session._c_object,

2212

priority.encode("utf-8"),

2213

None)

2214

1680

2215

# Start communication using the Mandos protocol

1681

2216

# Get protocol number

1682

2217

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

1683

2218

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

1684

2219

try:

1685

2220

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

1686

raise RuntimeError

2221

raise RuntimeError(line)

1687

2222

except (ValueError, IndexError, RuntimeError) as error:

1688

2223

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

1689

2224

return

1690

2225

1691

2226

# Start GnuTLS connection

1692

2227

try:

1693

2228

session.handshake()

1694

except gnutls.errors.GNUTLSError as error:

2229

except gnutls.Error as error:

1695

2230

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

1696

2231

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

1697

2232

# established. Just abandon the request.

1698

2233

return

1699

2234

logger.debug("Handshake succeeded")

1700

2235

1701

2236

approval_required = False

1702

2237

try:

1703

2238

try:

1704

fpr = self.fingerprint(self.peer_certificate

1705

(session))

1706

except (TypeError,

1707

gnutls.errors.GNUTLSError) as error:

2239

fpr = self.fingerprint(

2240

self.peer_certificate(session))

2241

except (TypeError, gnutls.Error) as error:

1708

2242

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

1709

2243

return

1710

2244

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

1711

2245

1712

2246

try:

1713

2247

client = ProxyClient(child_pipe, fpr,

1714

2248

self.client_address)

1715

2249

except KeyError:

1716

2250

return

1717

2251

1718

2252

if client.approval_delay:

1719

2253

delay = client.approval_delay

1720

2254

client.approvals_pending += 1

1721

2255

approval_required = True

1722

2256

1723

2257

while True:

1724

2258

if not client.enabled:

1725

2259

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

1726

client.name)

2260

client.name)

1727

2261

if self.server.use_dbus:

1728

2262

# Emit D-Bus signal

1729

2263

client.Rejected("Disabled")

1730

2264

return

1731

2265

1732

2266

if client.approved or not client.approval_delay:

1733

#We are approved or approval is disabled

2267

# We are approved or approval is disabled

1734

2268

break

1735

2269

elif client.approved is None:

1736

2270

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

1738

2272

if self.server.use_dbus:

1739

2273

# Emit D-Bus signal

1740

2274

client.NeedApproval(

1741

client.approval_delay_milliseconds(),

1742

client.approved_by_default)

2275

client.approval_delay.total_seconds()

2276

* 1000, client.approved_by_default)

1743

2277

else:

1744

2278

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

1745

2279

client.name)

1747

2281

# Emit D-Bus signal

1748

2282

client.Rejected("Denied")

1749

2283

return

1750

1751

#wait until timeout or approved

2284

2285

# wait until timeout or approved

1752

2286

time = datetime.datetime.now()

1753

2287

client.changedstate.acquire()

1754

client.changedstate.wait(

1755

float(timedelta_to_milliseconds(delay)

1756

/ 1000))

2288

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

1757

2289

client.changedstate.release()

1758

2290

time2 = datetime.datetime.now()

1759

2291

if (time2 - time) >= delay:

1769

2301

break

1770

2302

else:

1771

2303

delay -= time2 - time

1772

1773

sent_size = 0

1774

while sent_size < len(client.secret):

1775

try:

1776

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

1777

except gnutls.errors.GNUTLSError as error:

1778

logger.warning("gnutls send failed",

1779

exc_info=error)

1780

return

1781

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

1782

sent, len(client.secret)

1783

- (sent_size + sent))

1784

sent_size += sent

1785

2304

2305

try:

2306

session.send(client.secret)

2307

except gnutls.Error as error:

2308

logger.warning("gnutls send failed",

2309

exc_info=error)

2310

return

2311

1786

2312

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

1787

2313

# bump the timeout using extended_timeout

1788

2314

client.bump_timeout(client.extended_timeout)

1789

2315

if self.server.use_dbus:

1790

2316

# Emit D-Bus signal

1791

2317

client.GotSecret()

1792

2318

1793

2319

finally:

1794

2320

if approval_required:

1795

2321

client.approvals_pending -= 1

1796

2322

try:

1797

2323

session.bye()

1798

except gnutls.errors.GNUTLSError as error:

2324

except gnutls.Error as error:

1799

2325

logger.warning("GnuTLS bye failed",

1800

2326

exc_info=error)

1801

2327

1802

2328

@staticmethod

1803

2329

def peer_certificate(session):

1804

2330

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

1805

2331

# If not an OpenPGP certificate...

1806

if (gnutls.library.functions

1807

.gnutls_certificate_type_get(session._c_object)

1808

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1809

# ...do the normal thing

1810

return session.peer_certificate

2332

if (gnutls.certificate_type_get(session._c_object)

2333

!= gnutls.CRT_OPENPGP):

2334

# ...return invalid data

2335

return b""

1811

2336

list_size = ctypes.c_uint(1)

1812

cert_list = (gnutls.library.functions

1813

.gnutls_certificate_get_peers

2337

cert_list = (gnutls.certificate_get_peers

1814

2338

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

1815

2339

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

1816

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

1817

" certificate")

2340

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

1818

2341

if list_size.value == 0:

1819

2342

return None

1820

2343

cert = cert_list[0]

1821

2344

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

1822

2345

1823

2346

@staticmethod

1824

2347

def fingerprint(openpgp):

1825

2348

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1826

2349

# New GnuTLS "datum" with the OpenPGP public key

1827

datum = (gnutls.library.types

1828

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

1829

ctypes.POINTER

1830

(ctypes.c_ubyte)),

1831

ctypes.c_uint(len(openpgp))))

2350

datum = gnutls.datum_t(

2351

ctypes.cast(ctypes.c_char_p(openpgp),

2352

ctypes.POINTER(ctypes.c_ubyte)),

2353

ctypes.c_uint(len(openpgp)))

1832

2354

# New empty GnuTLS certificate

1833

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2355

crt = gnutls.openpgp_crt_t()

2356

gnutls.openpgp_crt_init(ctypes.byref(crt))

1836

2357

# Import the OpenPGP public key into the certificate

1837

(gnutls.library.functions

1838

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

1839

gnutls.library.constants

1840

.GNUTLS_OPENPGP_FMT_RAW))

2358

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

2359

gnutls.OPENPGP_FMT_RAW)

1841

2360

# Verify the self signature in the key

1842

2361

crtverify = ctypes.c_uint()

1843

(gnutls.library.functions

1844

.gnutls_openpgp_crt_verify_self(crt, 0,

1845

ctypes.byref(crtverify)))

2362

gnutls.openpgp_crt_verify_self(crt, 0,

2363

ctypes.byref(crtverify))

1846

2364

if crtverify.value != 0:

1847

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1848

raise (gnutls.errors.CertificateSecurityError

1849

("Verify failed"))

2365

gnutls.openpgp_crt_deinit(crt)

2366

raise gnutls.CertificateSecurityError("Verify failed")

1850

2367

# New buffer for the fingerprint

1851

2368

buf = ctypes.create_string_buffer(20)

1852

2369

buf_len = ctypes.c_size_t()

1853

2370

# Get the fingerprint from the certificate into the buffer

1854

(gnutls.library.functions

1855

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

1856

ctypes.byref(buf_len)))

2371

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

2372

ctypes.byref(buf_len))

1857

2373

# Deinit the certificate

1858

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2374

gnutls.openpgp_crt_deinit(crt)

1859

2375

# Convert the buffer to a Python bytestring

1860

2376

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

1861

2377

# Convert the bytestring to hexadecimal notation

1865

2381

1866

2382

class MultiprocessingMixIn(object):

1867

2383

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

2384

1868

2385

def sub_process_main(self, request, address):

1869

2386

try:

1870

2387

self.finish_request(request, address)

1871

2388

except Exception:

1872

2389

self.handle_error(request, address)

1873

2390

self.close_request(request)

1874

2391

1875

2392

def process_request(self, request, address):

1876

2393

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

1877

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

1878

args = (request, address))

2394

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

2395

args=(request, address))

1879

2396

proc.start()

1880

2397

return proc

1881

2398

1882

2399

1883

2400

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1884

2401

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

2402

1885

2403

def process_request(self, request, client_address):

1886

2404

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

1887

2405

1888

2406

This function creates a new pipe in self.pipe

1889

2407

"""

1890

2408

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1891

2409

1892

2410

proc = MultiprocessingMixIn.process_request(self, request,

1893

2411

client_address)

1894

2412

self.child_pipe.close()

1895

2413

self.add_pipe(parent_pipe, proc)

1896

2414

1897

2415

def add_pipe(self, parent_pipe, proc):

1898

2416

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

1899

raise NotImplementedError

2417

raise NotImplementedError()

1900

2418

1901

2419

1902

2420

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1903

2421

socketserver.TCPServer, object):

1904

2422

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

1905

2423

1906

2424

Attributes:

1907

2425

enabled: Boolean; whether this server is activated yet

1908

2426

interface: None or a network interface name (string)

1909

2427

use_ipv6: Boolean; to use IPv6 or not

1910

2428

"""

2429

1911

2430

def __init__(self, server_address, RequestHandlerClass,

1912

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

2431

interface=None,

2432

use_ipv6=True,

2433

socketfd=None):

1913

2434

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

1914

2435

creating a new one with socket.socket().

1915

2436

"""

1921

2442

self.socketfd = socketfd

1922

2443

# Save the original socket.socket() function

1923

2444

self.socket_socket = socket.socket

2445

1924

2446

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

1925

#

2447

#

1926

2448

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

1927

2449

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

1928

2450

# patching socket.socket.)

1929

#

2451

#

1930

2452

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

1931

2453

@functools.wraps(socket.socket)

1932

2454

def socket_wrapper(*args, **kwargs):

1944

2466

# socket_wrapper(), if socketfd was set.

1945

2467

socketserver.TCPServer.__init__(self, server_address,

1946

2468

RequestHandlerClass)

1947

2469

1948

2470

def server_bind(self):

1949

2471

"""This overrides the normal server_bind() function

1950

2472

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

1951

2473

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

2474

global SO_BINDTODEVICE

1952

2475

if self.interface is not None:

1953

2476

if SO_BINDTODEVICE is None:

1954

logger.error("SO_BINDTODEVICE does not exist;"

1955

" cannot bind to interface %s",

1956

self.interface)

1957

else:

1958

try:

1959

self.socket.setsockopt(socket.SOL_SOCKET,

1960

SO_BINDTODEVICE,

1961

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

1962

except socket.error as error:

1963

if error.errno == errno.EPERM:

1964

logger.error("No permission to bind to"

1965

" interface %s", self.interface)

1966

elif error.errno == errno.ENOPROTOOPT:

1967

logger.error("SO_BINDTODEVICE not available;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

elif error.errno == errno.ENODEV:

1971

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

1972

" cannot bind", self.interface)

1973

else:

1974

raise

2477

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

2478

# common enough.

2479

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

2480

SO_BINDTODEVICE = 25

2481

try:

2482

self.socket.setsockopt(

2483

socket.SOL_SOCKET, SO_BINDTODEVICE,

2484

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

2485

except socket.error as error:

2486

if error.errno == errno.EPERM:

2487

logger.error("No permission to bind to"

2488

" interface %s", self.interface)

2489

elif error.errno == errno.ENOPROTOOPT:

2490

logger.error("SO_BINDTODEVICE not available;"

2491

" cannot bind to interface %s",

2492

self.interface)

2493

elif error.errno == errno.ENODEV:

2494

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

2495

" cannot bind", self.interface)

2496

else:

2497

raise

1975

2498

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

1976

2499

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

1977

2500

if not self.server_address[0]:

1978

2501

if self.address_family == socket.AF_INET6:

1979

any_address = "::" # in6addr_any

2502

any_address = "::" # in6addr_any

1980

2503

else:

1981

any_address = socket.INADDR_ANY

2504

any_address = "0.0.0.0" # INADDR_ANY

1982

2505

self.server_address = (any_address,

1983

2506

self.server_address[1])

1984

2507

elif not self.server_address[1]:

1985

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

1986

0)

2508

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

1987

2509

# if self.interface:

1988

2510

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

1989

2511

# 0, # port

1995

2517

1996

2518

class MandosServer(IPv6_TCPServer):

1997

2519

"""Mandos server.

1998

2520

1999

2521

Attributes:

2000

2522

clients: set of Client objects

2001

2523

gnutls_priority GnuTLS priority string

2002

2524

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

2003

2004

Assumes a gobject.MainLoop event loop.

2525

2526

Assumes a GLib.MainLoop event loop.

2005

2527

"""

2528

2006

2529

def __init__(self, server_address, RequestHandlerClass,

2007

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

2008

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

2530

interface=None,

2531

use_ipv6=True,

2532

clients=None,

2533

gnutls_priority=None,

2534

use_dbus=True,

2535

socketfd=None):

2009

2536

self.enabled = False

2010

2537

self.clients = clients

2011

2538

if self.clients is None:

2014

2541

self.gnutls_priority = gnutls_priority

2015

2542

IPv6_TCPServer.__init__(self, server_address,

2016

2543

RequestHandlerClass,

2017

interface = interface,

2018

use_ipv6 = use_ipv6,

2019

socketfd = socketfd)

2544

interface=interface,

2545

use_ipv6=use_ipv6,

2546

socketfd=socketfd)

2547

2020

2548

def server_activate(self):

2021

2549

if self.enabled:

2022

2550

return socketserver.TCPServer.server_activate(self)

2023

2551

2024

2552

def enable(self):

2025

2553

self.enabled = True

2026

2554

2027

2555

def add_pipe(self, parent_pipe, proc):

2028

2556

# Call "handle_ipc" for both data and EOF events

2029

gobject.io_add_watch(parent_pipe.fileno(),

2030

gobject.IO_IN | gobject.IO_HUP,

2031

functools.partial(self.handle_ipc,

2032

parent_pipe =

2033

parent_pipe,

2034

proc = proc))

2035

2036

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

2037

proc = None, client_object=None):

2557

GLib.io_add_watch(

2558

parent_pipe.fileno(),

2559

GLib.IO_IN | GLib.IO_HUP,

2560

functools.partial(self.handle_ipc,

2561

parent_pipe=parent_pipe,

2562

proc=proc))

2563

2564

def handle_ipc(self, source, condition,

2565

parent_pipe=None,

2566

proc=None,

2567

client_object=None):

2038

2568

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

2039

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

2569

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

2040

2570

# Wait for other process to exit

2041

2571

proc.join()

2042

2572

return False

2043

2573

2044

2574

# Read a request from the child

2045

2575

request = parent_pipe.recv()

2046

2576

command = request[0]

2047

2577

2048

2578

if command == 'init':

2049

2579

fpr = request[1]

2050

2580

address = request[2]

2051

2052

for c in self.clients.itervalues():

2581

2582

for c in self.clients.values():

2053

2583

if c.fingerprint == fpr:

2054

2584

client = c

2055

2585

break

2062

2592

address[0])

2063

2593

parent_pipe.send(False)

2064

2594

return False

2065

2066

gobject.io_add_watch(parent_pipe.fileno(),

2067

gobject.IO_IN | gobject.IO_HUP,

2068

functools.partial(self.handle_ipc,

2069

parent_pipe =

2070

parent_pipe,

2071

proc = proc,

2072

client_object =

2073

client))

2595

2596

GLib.io_add_watch(

2597

parent_pipe.fileno(),

2598

GLib.IO_IN | GLib.IO_HUP,

2599

functools.partial(self.handle_ipc,

2600

parent_pipe=parent_pipe,

2601

proc=proc,

2602

client_object=client))

2074

2603

parent_pipe.send(True)

2075

2604

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

2076

2605

# same fileno

2079

2608

funcname = request[1]

2080

2609

args = request[2]

2081

2610

kwargs = request[3]

2082

2611

2083

2612

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

2084

2613

funcname)(*args,

2085

**kwargs)))

2086

2614

**kwargs)))

2615

2087

2616

if command == 'getattr':

2088

2617

attrname = request[1]

2089

if callable(client_object.__getattribute__(attrname)):

2090

parent_pipe.send(('function',))

2618

if isinstance(client_object.__getattribute__(attrname),

2619

collections.Callable):

2620

parent_pipe.send(('function', ))

2091

2621

else:

2092

parent_pipe.send(('data', client_object

2093

.__getattribute__(attrname)))

2094

2622

parent_pipe.send((

2623

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

2624

2095

2625

if command == 'setattr':

2096

2626

attrname = request[1]

2097

2627

value = request[2]

2098

2628

setattr(client_object, attrname, value)

2099

2629

2100

2630

return True

2101

2631

2102

2632

2103

2633

def rfc3339_duration_to_delta(duration):

2104

2634

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

2105

2635

2106

2636

>>> rfc3339_duration_to_delta("P7D")

2107

2637

datetime.timedelta(7)

2108

2638

>>> rfc3339_duration_to_delta("PT60S")

2118

2648

>>> rfc3339_duration_to_delta("P1DT3M20S")

2119

2649

datetime.timedelta(1, 200)

2120

2650

"""

2121

2651

2122

2652

# Parsing an RFC 3339 duration with regular expressions is not

2123

2653

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

2124

2654

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

2125

2655

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

2126

2656

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

2127

2657

# avoid excessive use of external libraries.

2128

2658

2129

2659

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

2130

Token = collections.namedtuple("Token",

2131

("regexp", # To match token; if

2132

# "value" is not None,

2133

# must have a "group"

2134

# containing digits

2135

"value", # datetime.timedelta or

2136

# None

2137

"followers")) # Tokens valid after

2138

# this token

2660

Token = collections.namedtuple("Token", (

2661

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

2662

# a "group" containing digits

2663

"value", # datetime.timedelta or None

2664

"followers")) # Tokens valid after this token

2139

2665

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

2140

2666

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

2141

2667

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

2142

2668

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

2143

2669

datetime.timedelta(seconds=1),

2144

frozenset((token_end,)))

2670

frozenset((token_end, )))

2145

2671

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

2146

2672

datetime.timedelta(minutes=1),

2147

2673

frozenset((token_second, token_end)))

2163

2689

frozenset((token_month, token_end)))

2164

2690

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

2165

2691

datetime.timedelta(weeks=1),

2166

frozenset((token_end,)))

2692

frozenset((token_end, )))

2167

2693

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

2168

2694

frozenset((token_year, token_month,

2169

2695

token_day, token_time,

2170

token_week))),

2171

# Define starting values

2172

value = datetime.timedelta() # Value so far

2696

token_week)))

2697

# Define starting values:

2698

# Value so far

2699

value = datetime.timedelta()

2173

2700

found_token = None

2174

followers = frozenset(token_duration,) # Following valid tokens

2175

s = duration # String left to parse

2701

# Following valid tokens

2702

followers = frozenset((token_duration, ))

2703

# String left to parse

2704

s = duration

2176

2705

# Loop until end token is found

2177

2706

while found_token is not token_end:

2178

2707

# Search for any currently valid tokens

2194

2723

break

2195

2724

else:

2196

2725

# No currently valid tokens were found

2197

raise ValueError("Invalid RFC 3339 duration")

2726

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

2727

.format(duration))

2198

2728

# End token found

2199

2729

return value

2200

2730

2201

2731

2202

2732

def string_to_delta(interval):

2203

2733

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

2204

2734

2205

2735

>>> string_to_delta('7d')

2206

2736

datetime.timedelta(7)

2207

2737

>>> string_to_delta('60s')

2215

2745

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

2216

2746

datetime.timedelta(0, 330)

2217

2747

"""

2218

2748

2219

2749

try:

2220

2750

return rfc3339_duration_to_delta(interval)

2221

2751

except ValueError:

2222

2752

pass

2223

2753

2224

2754

timevalue = datetime.timedelta(0)

2225

2755

for s in interval.split():

2226

2756

try:

2227

suffix = unicode(s[-1])

2757

suffix = s[-1]

2228

2758

value = int(s[:-1])

2229

2759

if suffix == "d":

2230

2760

delta = datetime.timedelta(value)

2237

2767

elif suffix == "w":

2238

2768

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

2239

2769

else:

2240

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

2241

.format(suffix))

2242

except (ValueError, IndexError) as e:

2770

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

2771

except IndexError as e:

2243

2772

raise ValueError(*(e.args))

2244

2773

timevalue += delta

2245

2774

return timevalue

2246

2775

2247

2776

2248

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

2777

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

2249

2778

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

2250

2779

2251

2780

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

2252

2781

if os.fork():

2253

2782

sys.exit()

2261

2790

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

2262

2791

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

2263

2792

raise OSError(errno.ENODEV,

2264

"{0} not a character device"

2793

"{} not a character device"

2265

2794

.format(os.devnull))

2266

2795

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

2267

2796

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

2271

2800

2272

2801

2273

2802

def main():

2274

2803

2275

2804

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

2276

2805

# Parsing of options, both command line and config file

2277

2806

2278

2807

parser = argparse.ArgumentParser()

2279

2808

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

2280

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

2809

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

2281

2810

help="show version number and exit")

2282

2811

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

2283

2812

help="Bind to interface IF")

2289

2818

help="Run self-test")

2290

2819

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

2291

2820

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

2292

" to terminal")

2821

" to terminal", default=None)

2293

2822

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

2294

2823

help="Debug level for stdout output")

2295

2824

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

2302

2831

" files")

2303

2832

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

2304

2833

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

2305

" system bus interface")

2834

" system bus interface", default=None)

2306

2835

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

2307

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

2836

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

2837

default=None)

2308

2838

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

2309

2839

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

2310

" state")

2840

" state", default=None)

2311

2841

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

2312

2842

help="Specify a file descriptor to a network"

2313

2843

" socket to use instead of creating one")

2314

2844

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

2315

2845

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

2316

2846

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

2317

help="Run in foreground")

2318

2847

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

2848

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

2849

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

2850

default=None)

2851

2319

2852

options = parser.parse_args()

2320

2853

2321

2854

if options.check:

2322

2855

import doctest

2323

doctest.testmod()

2324

sys.exit()

2325

2856

fail_count, test_count = doctest.testmod()

2857

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

2858

2326

2859

# Default values for config file for server-global settings

2327

server_defaults = { "interface": "",

2328

"address": "",

2329

"port": "",

2330

"debug": "False",

2331

"priority":

2332

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

2333

"servicename": "Mandos",

2334

"use_dbus": "True",

2335

"use_ipv6": "True",

2336

"debuglevel": "",

2337

"restore": "True",

2338

"socket": "",

2339

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

2340

"foreground": "False",

2341

}

2342

2860

server_defaults = {"interface": "",

2861

"address": "",

2862

"port": "",

2863

"debug": "False",

2864

"priority":

2865

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

2866

":+SIGN-DSA-SHA256",

2867

"servicename": "Mandos",

2868

"use_dbus": "True",

2869

"use_ipv6": "True",

2870

"debuglevel": "",

2871

"restore": "True",

2872

"socket": "",

2873

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

2874

"foreground": "False",

2875

"zeroconf": "True",

2876

}

2877

2343

2878

# Parse config file for server-global settings

2344

2879

server_config = configparser.SafeConfigParser(server_defaults)

2345

2880

del server_defaults

2346

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

2347

"mandos.conf"))

2881

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

2348

2882

# Convert the SafeConfigParser object to a dict

2349

2883

server_settings = server_config.defaults()

2350

2884

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

2364

2898

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

2365

2899

["socket"])

2366

2900

del server_config

2367

2901

2368

2902

# Override the settings from the config file with command line

2369

2903

# options, if set.

2370

2904

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

2371

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

2372

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

2373

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

2905

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

2906

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

2907

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

2374

2908

value = getattr(options, option)

2375

2909

if value is not None:

2376

2910

server_settings[option] = value

2377

2911

del options

2378

2912

# Force all strings to be unicode

2379

2913

for option in server_settings.keys():

2380

if type(server_settings[option]) is str:

2381

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

2914

if isinstance(server_settings[option], bytes):

2915

server_settings[option] = (server_settings[option]

2916

.decode("utf-8"))

2917

# Force all boolean options to be boolean

2918

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

2919

"foreground", "zeroconf"):

2920

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

2382

2921

# Debug implies foreground

2383

2922

if server_settings["debug"]:

2384

2923

server_settings["foreground"] = True

2385

2924

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

2386

2925

2387

2926

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

2388

2927

2928

if (not server_settings["zeroconf"]

2929

and not (server_settings["port"]

2930

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

2931

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

2932

2389

2933

# For convenience

2390

2934

debug = server_settings["debug"]

2391

2935

debuglevel = server_settings["debuglevel"]

2394

2938

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

2395

2939

stored_state_file)

2396

2940

foreground = server_settings["foreground"]

2397

2941

zeroconf = server_settings["zeroconf"]

2942

2398

2943

if debug:

2399

2944

initlogger(debug, logging.DEBUG)

2400

2945

else:

2403

2948

else:

2404

2949

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

2405

2950

initlogger(debug, level)

2406

2951

2407

2952

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

2408

syslogger.setFormatter(logging.Formatter

2409

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

2410

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

2411

.format(server_settings

2412

["servicename"])))

2413

2953

syslogger.setFormatter(

2954

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

2955

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

2956

server_settings["servicename"])))

2957

2414

2958

# Parse config file with clients

2415

2959

client_config = configparser.SafeConfigParser(Client

2416

2960

.client_defaults)

2417

2961

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

2418

2962

"clients.conf"))

2419

2963

2420

2964

global mandos_dbus_service

2421

2965

mandos_dbus_service = None

2422

2423

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

2424

server_settings["port"]),

2425

ClientHandler,

2426

interface=(server_settings["interface"]

2427

or None),

2428

use_ipv6=use_ipv6,

2429

gnutls_priority=

2430

server_settings["priority"],

2431

use_dbus=use_dbus,

2432

socketfd=(server_settings["socket"]

2433

or None))

2966

2967

socketfd = None

2968

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

2969

socketfd = server_settings["socket"]

2970

tcp_server = MandosServer(

2971

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

2972

ClientHandler,

2973

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

2974

use_ipv6=use_ipv6,

2975

gnutls_priority=server_settings["priority"],

2976

use_dbus=use_dbus,

2977

socketfd=socketfd)

2434

2978

if not foreground:

2435

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

2979

pidfilename = "/run/mandos.pid"

2980

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

2981

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

2436

2982

pidfile = None

2437

2983

try:

2438

pidfile = open(pidfilename, "w")

2984

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

2439

2985

except IOError as e:

2440

2986

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

2441

2987

exc_info=e)

2442

2443

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

2988

2989

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

2990

("mandos", "mandos"),

2991

("nobody", "nogroup")):

2444

2992

try:

2445

2993

uid = pwd.getpwnam(name).pw_uid

2446

gid = pwd.getpwnam(name).pw_gid

2994

gid = pwd.getpwnam(group).pw_gid

2447

2995

break

2448

2996

except KeyError:

2449

2997

continue

2453

3001

try:

2454

3002

os.setgid(gid)

2455

3003

os.setuid(uid)

3004

if debug:

3005

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

3006

gid))

2456

3007

except OSError as error:

3008

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

3009

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

2457

3010

if error.errno != errno.EPERM:

2458

raise error

2459

3011

raise

3012

2460

3013

if debug:

2461

3014

# Enable all possible GnuTLS debugging

2462

3015

2463

3016

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

2464

3017

# - GnuTLS manual

2465

gnutls.library.functions.gnutls_global_set_log_level(11)

2466

2467

@gnutls.library.types.gnutls_log_func

3018

gnutls.global_set_log_level(11)

3019

3020

@gnutls.log_func

2468

3021

def debug_gnutls(level, string):

2469

3022

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

2470

2471

(gnutls.library.functions

2472

.gnutls_global_set_log_function(debug_gnutls))

2473

3023

3024

gnutls.global_set_log_function(debug_gnutls)

3025

2474

3026

# Redirect stdin so all checkers get /dev/null

2475

3027

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

2476

3028

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

2477

3029

if null > 2:

2478

3030

os.close(null)

2479

3031

2480

3032

# Need to fork before connecting to D-Bus

2481

3033

if not foreground:

2482

3034

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

2483

3035

daemon()

2484

2485

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

2486

# need to inform gobject that threads will be used.

2487

gobject.threads_init()

2488

3036

3037

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

3038

# to inform GLib that threads will be used.

3039

GLib.threads_init()

3040

2489

3041

global main_loop

2490

3042

# From the Avahi example code

2491

3043

DBusGMainLoop(set_as_default=True)

2492

main_loop = gobject.MainLoop()

3044

main_loop = GLib.MainLoop()

2493

3045

bus = dbus.SystemBus()

2494

3046

# End of Avahi example code

2495

3047

if use_dbus:

2496

3048

try:

2497

3049

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

2498

bus, do_not_queue=True)

2499

old_bus_name = (dbus.service.BusName

2500

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

2501

do_not_queue=True))

2502

except dbus.exceptions.NameExistsException as e:

3050

bus,

3051

do_not_queue=True)

3052

old_bus_name = dbus.service.BusName(

3053

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

3054

do_not_queue=True)

3055

except dbus.exceptions.DBusException as e:

2503

3056

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

2504

3057

use_dbus = False

2505

3058

server_settings["use_dbus"] = False

2506

3059

tcp_server.use_dbus = False

2507

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2508

service = AvahiServiceToSyslog(name =

2509

server_settings["servicename"],

2510

servicetype = "_mandos._tcp",

2511

protocol = protocol, bus = bus)

2512

if server_settings["interface"]:

2513

service.interface = (if_nametoindex

2514

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

2515

3060

if zeroconf:

3061

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3062

service = AvahiServiceToSyslog(

3063

name=server_settings["servicename"],

3064

servicetype="_mandos._tcp",

3065

protocol=protocol,

3066

bus=bus)

3067

if server_settings["interface"]:

3068

service.interface = if_nametoindex(

3069

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

3070

2516

3071

global multiprocessing_manager

2517

3072

multiprocessing_manager = multiprocessing.Manager()

2518

3073

2519

3074

client_class = Client

2520

3075

if use_dbus:

2521

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

2522

3076

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

3077

2523

3078

client_settings = Client.config_parser(client_config)

2524

3079

old_client_settings = {}

2525

3080

clients_data = {}

2526

3081

3082

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

3083

global wnull

3084

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

3085

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

3086

# mode

3087

if debug or not foreground:

3088

wnull.close()

3089

2527

3090

# Get client data and settings from last running state.

2528

3091

if server_settings["restore"]:

2529

3092

try:

2530

3093

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

2531

clients_data, old_client_settings = (pickle.load

2532

(stored_state))

3094

if sys.version_info.major == 2:

3095

clients_data, old_client_settings = pickle.load(

3096

stored_state)

3097

else:

3098

bytes_clients_data, bytes_old_client_settings = (

3099

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

3100

# Fix bytes to strings

3101

# clients_data

3102

# .keys()

3103

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

3104

if isinstance(key, bytes)

3105

else key): value

3106

for key, value in

3107

bytes_clients_data.items()}

3108

del bytes_clients_data

3109

for key in clients_data:

3110

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

3111

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

3112

for k, v in

3113

clients_data[key].items()}

3114

clients_data[key] = value

3115

# .client_structure

3116

value["client_structure"] = [

3117

(s.decode("utf-8")

3118

if isinstance(s, bytes)

3119

else s) for s in

3120

value["client_structure"]]

3121

# .name & .host

3122

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

3123

if isinstance(value[k], bytes):

3124

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

3125

# old_client_settings

3126

# .keys()

3127

old_client_settings = {

3128

(key.decode("utf-8")

3129

if isinstance(key, bytes)

3130

else key): value

3131

for key, value in

3132

bytes_old_client_settings.items()}

3133

del bytes_old_client_settings

3134

# .host

3135

for value in old_client_settings.values():

3136

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

3137

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

3138

.decode("utf-8"))

2533

3139

os.remove(stored_state_path)

2534

3140

except IOError as e:

2535

3141

if e.errno == errno.ENOENT:

2536

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

2537

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

3142

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

3143

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

2538

3144

else:

2539

3145

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

2540

3146

exc_info=e)

2541

3147

raise

2542

3148

except EOFError as e:

2543

3149

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

2544

"EOFError:", exc_info=e)

2545

3150

"EOFError:",

3151

exc_info=e)

3152

2546

3153

with PGPEngine() as pgp:

2547

for client_name, client in clients_data.iteritems():

3154

for client_name, client in clients_data.items():

3155

# Skip removed clients

3156

if client_name not in client_settings:

3157

continue

3158

2548

3159

# Decide which value to use after restoring saved state.

2549

3160

# We have three different values: Old config file,

2550

3161

# new config file, and saved state.

2555

3166

# For each value in new config, check if it

2556

3167

# differs from the old config value (Except for

2557

3168

# the "secret" attribute)

2558

if (name != "secret" and

2559

value != old_client_settings[client_name]

2560

[name]):

3169

if (name != "secret"

3170

and (value !=

3171

old_client_settings[client_name][name])):

2561

3172

client[name] = value

2562

3173

except KeyError:

2563

3174

pass

2564

3175

2565

3176

# Clients who has passed its expire date can still be

2566

# enabled if its last checker was successful. Clients

3177

# enabled if its last checker was successful. A Client

2567

3178

# whose checker succeeded before we stored its state is

2568

3179

# assumed to have successfully run all checkers during

2569

3180

# downtime.

2571

3182

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

2572

3183

if not client["last_checked_ok"]:

2573

3184

logger.warning(

2574

"disabling client {0} - Client never "

2575

"performed a successful checker"

2576

.format(client_name))

3185

"disabling client {} - Client never "

3186

"performed a successful checker".format(

3187

client_name))

2577

3188

client["enabled"] = False

2578

3189

elif client["last_checker_status"] != 0:

2579

3190

logger.warning(

2580

"disabling client {0} - Client "

2581

"last checker failed with error code {1}"

2582

.format(client_name,

2583

client["last_checker_status"]))

3191

"disabling client {} - Client last"

3192

" checker failed with error code"

3193

" {}".format(

3194

client_name,

3195

client["last_checker_status"]))

2584

3196

client["enabled"] = False

2585

3197

else:

2586

client["expires"] = (datetime.datetime

2587

.utcnow()

2588

+ client["timeout"])

3198

client["expires"] = (

3199

datetime.datetime.utcnow()

3200

+ client["timeout"])

2589

3201

logger.debug("Last checker succeeded,"

2590

" keeping {0} enabled"

2591

.format(client_name))

3202

" keeping {} enabled".format(

3203

client_name))

2592

3204

try:

2593

client["secret"] = (

2594

pgp.decrypt(client["encrypted_secret"],

2595

client_settings[client_name]

2596

["secret"]))

3205

client["secret"] = pgp.decrypt(

3206

client["encrypted_secret"],

3207

client_settings[client_name]["secret"])

2597

3208

except PGPError:

2598

3209

# If decryption fails, we use secret from new settings

2599

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

2600

.format(client_name))

2601

client["secret"] = (

2602

client_settings[client_name]["secret"])

2603

3210

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

3211

client_name))

3212

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

3213

["secret"])

3214

2604

3215

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

2605

3216

for client_name in (set(old_client_settings)

2606

3217

- set(client_settings)):

2608

3219

for client_name in (set(client_settings)

2609

3220

- set(old_client_settings)):

2610

3221

clients_data[client_name] = client_settings[client_name]

2611

3222

2612

3223

# Create all client objects

2613

for client_name, client in clients_data.iteritems():

3224

for client_name, client in clients_data.items():

2614

3225

tcp_server.clients[client_name] = client_class(

2615

name = client_name, settings = client)

2616

3226

name=client_name,

3227

settings=client,

3228

server_settings=server_settings)

3229

2617

3230

if not tcp_server.clients:

2618

3231

logger.warning("No clients defined")

2619

3232

2620

3233

if not foreground:

2621

3234

if pidfile is not None:

3235

pid = os.getpid()

2622

3236

try:

2623

3237

with pidfile:

2624

pid = os.getpid()

2625

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

3238

print(pid, file=pidfile)

2626

3239

except IOError:

2627

3240

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

2628

3241

pidfilename, pid)

2629

3242

del pidfile

2630

3243

del pidfilename

2631

2632

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

2633

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

2634

3244

3245

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

3246

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3247

lambda: main_loop.quit() and False)

3248

2635

3249

if use_dbus:

2636

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

2637

"se.bsnet.fukt.Mandos"})

2638

class MandosDBusService(DBusObjectWithProperties):

3250

3251

@alternate_dbus_interfaces(

3252

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

3253

class MandosDBusService(DBusObjectWithObjectManager):

2639

3254

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

3255

2640

3256

def __init__(self):

2641

3257

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

3258

2642

3259

_interface = "se.recompile.Mandos"

2643

2644

@dbus_interface_annotations(_interface)

2645

def _foo(self):

2646

return { "org.freedesktop.DBus.Property"

2647

".EmitsChangedSignal":

2648

"false"}

2649

3260

2650

3261

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

2651

3262

def ClientAdded(self, objpath):

2652

3263

"D-Bus signal"

2653

3264

pass

2654

3265

2655

3266

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

2656

3267

def ClientNotFound(self, fingerprint, address):

2657

3268

"D-Bus signal"

2658

3269

pass

2659

3270

3271

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

3272

"true"})

2660

3273

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

2661

3274

def ClientRemoved(self, objpath, name):

2662

3275

"D-Bus signal"

2663

3276

pass

2664

3277

3278

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

3279

"true"})

2665

3280

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

2666

3281

def GetAllClients(self):

2667

3282

"D-Bus method"

2668

return dbus.Array(c.dbus_object_path

2669

for c in

2670

tcp_server.clients.itervalues())

2671

3283

return dbus.Array(c.dbus_object_path for c in

3284

tcp_server.clients.values())

3285

3286

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

3287

"true"})

2672

3288

@dbus.service.method(_interface,

2673

3289

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

2674

3290

def GetAllClientsWithProperties(self):

2675

3291

"D-Bus method"

2676

3292

return dbus.Dictionary(

2677

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

2678

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

3293

{c.dbus_object_path: c.GetAll(

3294

"se.recompile.Mandos.Client")

3295

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

2679

3296

signature="oa{sv}")

2680

3297

2681

3298

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

2682

3299

def RemoveClient(self, object_path):

2683

3300

"D-Bus method"

2684

for c in tcp_server.clients.itervalues():

3301

for c in tcp_server.clients.values():

2685

3302

if c.dbus_object_path == object_path:

2686

3303

del tcp_server.clients[c.name]

2687

3304

c.remove_from_connection()

2688

# Don't signal anything except ClientRemoved

3305

# Don't signal the disabling

2689

3306

c.disable(quiet=True)

2690

# Emit D-Bus signal

2691

self.ClientRemoved(object_path, c.name)

3307

# Emit D-Bus signal for removal

3308

self.client_removed_signal(c)

2692

3309

return

2693

3310

raise KeyError(object_path)

2694

3311

2695

3312

del _interface

2696

3313

3314

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3315

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

3316

def GetManagedObjects(self):

3317

"""D-Bus method"""

3318

return dbus.Dictionary(

3319

{client.dbus_object_path:

3320

dbus.Dictionary(

3321

{interface: client.GetAll(interface)

3322

for interface in

3323

client._get_all_interface_names()})

3324

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

3325

3326

def client_added_signal(self, client):

3327

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

3328

if use_dbus:

3329

# New standard signal

3330

self.InterfacesAdded(

3331

client.dbus_object_path,

3332

dbus.Dictionary(

3333

{interface: client.GetAll(interface)

3334

for interface in

3335

client._get_all_interface_names()}))

3336

# Old signal

3337

self.ClientAdded(client.dbus_object_path)

3338

3339

def client_removed_signal(self, client):

3340

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

3341

if use_dbus:

3342

# New standard signal

3343

self.InterfacesRemoved(

3344

client.dbus_object_path,

3345

client._get_all_interface_names())

3346

# Old signal

3347

self.ClientRemoved(client.dbus_object_path,

3348

client.name)

3349

2697

3350

mandos_dbus_service = MandosDBusService()

2698

3351

3352

# Save modules to variables to exempt the modules from being

3353

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

3354

mp = multiprocessing

3355

wn = wnull

3356

2699

3357

def cleanup():

2700

3358

"Cleanup function; run on exit"

2701

service.cleanup()

2702

2703

multiprocessing.active_children()

3359

if zeroconf:

3360

service.cleanup()

3361

3362

mp.active_children()

3363

wn.close()

2704

3364

if not (tcp_server.clients or client_settings):

2705

3365

return

2706

3366

2707

3367

# Store client before exiting. Secrets are encrypted with key

2708

3368

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

2709

3369

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

2710

3370

clients = {}

2711

3371

with PGPEngine() as pgp:

2712

for client in tcp_server.clients.itervalues():

3372

for client in tcp_server.clients.values():

2713

3373

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

2714

3374

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

2715

3375

key)

2716

3376

client_dict = {}

2717

3377

2718

3378

# A list of attributes that can not be pickled

2719

3379

# + secret.

2720

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

2721

"checker"))

2722

for name, typ in (inspect.getmembers

2723

(dbus.service.Object)):

3380

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

3381

"checker", "server_settings"}

3382

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

3383

.Object):

2724

3384

exclude.add(name)

2725

3385

2726

3386

client_dict["encrypted_secret"] = (client

2727

3387

.encrypted_secret)

2728

3388

for attr in client.client_structure:

2729

3389

if attr not in exclude:

2730

3390

client_dict[attr] = getattr(client, attr)

2731

3391

2732

3392

clients[client.name] = client_dict

2733

3393

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

2734

3394

2735

3395

try:

2736

with (tempfile.NamedTemporaryFile

2737

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

2738

dir=os.path.dirname(stored_state_path),

2739

delete=False)) as stored_state:

2740

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

2741

tempname=stored_state.name

3396

with tempfile.NamedTemporaryFile(

3397

mode='wb',

3398

suffix=".pickle",

3399

prefix='clients-',

3400

dir=os.path.dirname(stored_state_path),

3401

delete=False) as stored_state:

3402

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

3403

protocol=2)

3404

tempname = stored_state.name

2742

3405

os.rename(tempname, stored_state_path)

2743

3406

except (IOError, OSError) as e:

2744

3407

if not debug:

2747

3410

except NameError:

2748

3411

pass

2749

3412

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

2750

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

3413

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

2751

3414

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

2752

3415

else:

2753

3416

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

2754

3417

exc_info=e)

2755

raise e

2756

3418

raise

3419

2757

3420

# Delete all clients, and settings from config

2758

3421

while tcp_server.clients:

2759

3422

name, client = tcp_server.clients.popitem()

2760

3423

if use_dbus:

2761

3424

client.remove_from_connection()

2762

# Don't signal anything except ClientRemoved

3425

# Don't signal the disabling

2763

3426

client.disable(quiet=True)

3427

# Emit D-Bus signal for removal

2764

3428

if use_dbus:

2765

# Emit D-Bus signal

2766

mandos_dbus_service.ClientRemoved(client

2767

.dbus_object_path,

2768

client.name)

3429

mandos_dbus_service.client_removed_signal(client)

2769

3430

client_settings.clear()

2770

3431

2771

3432

atexit.register(cleanup)

2772

2773

for client in tcp_server.clients.itervalues():

3433

3434

for client in tcp_server.clients.values():

2774

3435

if use_dbus:

2775

# Emit D-Bus signal

2776

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3436

# Emit D-Bus signal for adding

3437

mandos_dbus_service.client_added_signal(client)

2777

3438

# Need to initiate checking of clients

2778

3439

if client.enabled:

2779

3440

client.init_checker()

2780

3441

2781

3442

tcp_server.enable()

2782

3443

tcp_server.server_activate()

2783

3444

2784

3445

# Find out what port we got

2785

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

3446

if zeroconf:

3447

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

2786

3448

if use_ipv6:

2787

3449

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

2788

3450

" flowinfo %d, scope_id %d",

2790

3452

else: # IPv4

2791

3453

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

2792

3454

*tcp_server.socket.getsockname())

2793

2794

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

2795

3455

3456

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

3457

2796

3458

try:

2797

# From the Avahi example code

2798

try:

2799

service.activate()

2800

except dbus.exceptions.DBusException as error:

2801

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

2802

cleanup()

2803

sys.exit(1)

2804

# End of Avahi example code

2805

2806

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

2807

lambda *args, **kwargs:

2808

(tcp_server.handle_request

2809

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

2810

3459

if zeroconf:

3460

# From the Avahi example code

3461

try:

3462

service.activate()

3463

except dbus.exceptions.DBusException as error:

3464

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

3465

cleanup()

3466

sys.exit(1)

3467

# End of Avahi example code

3468

3469

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

3470

lambda *args, **kwargs:

3471

(tcp_server.handle_request

3472

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

3473

2811

3474

logger.debug("Starting main loop")

2812

3475

main_loop.run()

2813

3476

except AvahiError as error:

2822

3485

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

2823

3486

cleanup()

2824

3487

3488

2825

3489

if __name__ == '__main__':

2826

3490

main()