/mandos/trunk : revision 896

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

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

1026

1461

return xmlstring

1027

1462

1028

1463

1464

try:

1465

dbus.OBJECT_MANAGER_IFACE

1466

except AttributeError:

1467

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

1468

1469

1470

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1471

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

1472

1473

Classes inheriting from this exposes the standard

1474

GetManagedObjects call and the InterfacesAdded and

1475

InterfacesRemoved signals on the standard

1476

"org.freedesktop.DBus.ObjectManager" interface.

1477

1478

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

1479

manually.

1480

"""

1481

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1482

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

1483

def GetManagedObjects(self):

1484

"""This function must be overridden"""

1485

raise NotImplementedError()

1486

1487

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1488

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

1489

def InterfacesAdded(self, object_path, interfaces_and_properties):

1490

pass

1491

1492

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

1493

def InterfacesRemoved(self, object_path, interfaces):

1494

pass

1495

1496

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1497

out_signature="s",

1498

path_keyword='object_path',

1499

connection_keyword='connection')

1500

def Introspect(self, object_path, connection):

1501

"""Overloading of standard D-Bus method.

1502

1503

Override return argument name of GetManagedObjects to be

1504

"objpath_interfaces_and_properties"

1505

"""

1506

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1507

object_path,

1508

connection)

1509

try:

1510

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

1511

1512

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

1513

# Fix argument name for the GetManagedObjects method

1514

if (if_tag.getAttribute("name")

1515

== dbus.OBJECT_MANAGER_IFACE):

1516

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

1517

if (cn.getAttribute("name")

1518

== "GetManagedObjects"):

1519

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

1520

if (arg.getAttribute("direction")

1521

== "out"):

1522

arg.setAttribute(

1523

"name",

1524

"objpath_interfaces"

1525

"_and_properties")

1526

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

1527

document.unlink()

1528

except (AttributeError, xml.dom.DOMException,

1529

xml.parsers.expat.ExpatError) as error:

1530

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

1531

exc_info=error)

1532

return xmlstring

1533

1534

1029

1535

def datetime_to_dbus(dt, variant_level=0):

1030

1536

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

1031

1537

if dt is None:

1032

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

1033

return dbus.String(dt.isoformat(),

1034

variant_level=variant_level)

1538

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

1539

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

1035

1540

1036

1541

1037

1542

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1039

1544

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

1040

1545

interface names according to the "alt_interface_names" mapping.

1041

1546

Usage:

1042

1547

1043

1548

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

1044

1549

"net.example.AlternateInterface"})

1045

1550

class SampleDBusObject(dbus.service.Object):

1046

1551

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

1047

1552

def SampleDBusMethod():

1048

1553

pass

1049

1554

1050

1555

The above "SampleDBusMethod" on "SampleDBusObject" will be

1051

1556

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

1052

1557

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

1053

1558

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

1054

1559

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

1055

1560

1056

1561

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

1057

1562

(from DBusObjectWithProperties) and interfaces (from the

1058

1563

dbus_interface_annotations decorator).

1059

1564

"""

1565

1060

1566

def wrapper(cls):

1061

1567

for orig_interface_name, alt_interface_name in (

1062

alt_interface_names.iteritems()):

1568

alt_interface_names.items()):

1063

1569

attr = {}

1064

1570

interface_names = set()

1065

1571

# Go though all attributes of the class

1067

1573

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

1068

1574

# with the wrong interface name

1069

1575

if (not hasattr(attribute, "_dbus_interface")

1070

or not attribute._dbus_interface

1071

.startswith(orig_interface_name)):

1576

or not attribute._dbus_interface.startswith(

1577

orig_interface_name)):

1072

1578

continue

1073

1579

# Create an alternate D-Bus interface name based on

1074

1580

# the current name

1075

alt_interface = (attribute._dbus_interface

1076

.replace(orig_interface_name,

1077

alt_interface_name))

1581

alt_interface = attribute._dbus_interface.replace(

1582

orig_interface_name, alt_interface_name)

1078

1583

interface_names.add(alt_interface)

1079

1584

# Is this a D-Bus signal?

1080

1585

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

1081

# Extract the original non-method function by

1082

# black magic

1083

nonmethod_func = (dict(

1586

# Extract the original non-method undecorated

1587

# function by black magic

1588

if sys.version_info.major == 2:

1589

nonmethod_func = (dict(

1084

1590

zip(attribute.func_code.co_freevars,

1085

attribute.__closure__))["func"]

1086

.cell_contents)

1591

attribute.__closure__))

1592

["func"].cell_contents)

1593

else:

1594

nonmethod_func = (dict(

1595

zip(attribute.__code__.co_freevars,

1596

attribute.__closure__))

1597

["func"].cell_contents)

1087

1598

# Create a new, but exactly alike, function

1088

1599

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

1089

1600

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

1601

new_function = copy_function(nonmethod_func)

1602

new_function = (dbus.service.signal(

1603

alt_interface,

1604

attribute._dbus_signature)(new_function))

1099

1605

# Copy annotations, if any

1100

1606

try:

1101

new_function._dbus_annotations = (

1102

dict(attribute._dbus_annotations))

1607

new_function._dbus_annotations = dict(

1608

attribute._dbus_annotations)

1103

1609

except AttributeError:

1104

1610

pass

1611

1105

1612

# Define a creator of a function to call both the

1106

1613

# original and alternate functions, so both the

1107

1614

# original and alternate signals gets sent when

1110

1617

"""This function is a scope container to pass

1111

1618

func1 and func2 to the "call_both" function

1112

1619

outside of its arguments"""

1620

1621

@functools.wraps(func2)

1113

1622

def call_both(*args, **kwargs):

1114

1623

"""This function will emit two D-Bus

1115

1624

signals by calling func1 and func2"""

1116

1625

func1(*args, **kwargs)

1117

1626

func2(*args, **kwargs)

1627

# Make wrapper function look like a D-Bus

1628

# signal

1629

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

1630

if name.startswith("_dbus_"):

1631

setattr(call_both, name, attr)

1632

1118

1633

return call_both

1119

1634

# Create the "call_both" function and add it to

1120

1635

# the class

1125

1640

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

1126

1641

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

1127

1642

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

1643

attr[attrname] = (

1644

dbus.service.method(

1645

alt_interface,

1646

attribute._dbus_in_signature,

1647

attribute._dbus_out_signature)

1648

(copy_function(attribute)))

1138

1649

# Copy annotations, if any

1139

1650

try:

1140

attr[attrname]._dbus_annotations = (

1141

dict(attribute._dbus_annotations))

1651

attr[attrname]._dbus_annotations = dict(

1652

attribute._dbus_annotations)

1142

1653

except AttributeError:

1143

1654

pass

1144

1655

# Is this a D-Bus property?

1147

1658

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

1148

1659

# property with the alternate D-Bus interface

1149

1660

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

1661

attr[attrname] = (dbus_service_property(

1662

alt_interface, attribute._dbus_signature,

1663

attribute._dbus_access,

1664

attribute._dbus_get_args_options

1665

["byte_arrays"])

1666

(copy_function(attribute)))

1163

1667

# Copy annotations, if any

1164

1668

try:

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1669

attr[attrname]._dbus_annotations = dict(

1670

attribute._dbus_annotations)

1167

1671

except AttributeError:

1168

1672

pass

1169

1673

# Is this a D-Bus interface?

1172

1676

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

1173

1677

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

1174

1678

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

1679

attr[attrname] = (

1680

dbus_interface_annotations(alt_interface)

1681

(copy_function(attribute)))

1183

1682

if deprecate:

1184

1683

# Deprecate all alternate interfaces

1185

iname="_AlternateDBusNames_interface_annotation{0}"

1684

iname = "_AlternateDBusNames_interface_annotation{}"

1186

1685

for interface_name in interface_names:

1686

1187

1687

@dbus_interface_annotations(interface_name)

1188

1688

def func(self):

1189

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

1190

"true" }

1689

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

1690

"true"}

1191

1691

# Find an unused name

1192

1692

for aname in (iname.format(i)

1193

1693

for i in itertools.count()):

1197

1697

if interface_names:

1198

1698

# Replace the class with a new subclass of it with

1199

1699

# methods, signals, etc. as created above.

1200

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

1201

(cls,), attr)

1700

if sys.version_info.major == 2:

1701

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

1702

(cls, ), attr)

1703

else:

1704

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

1705

(cls, ), attr)

1202

1706

return cls

1707

1203

1708

return wrapper

1204

1709

1205

1710

1206

1711

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

1207

"se.bsnet.fukt.Mandos"})

1712

"se.bsnet.fukt.Mandos"})

1208

1713

class ClientDBus(Client, DBusObjectWithProperties):

1209

1714

"""A Client class using D-Bus

1210

1715

1211

1716

Attributes:

1212

1717

dbus_object_path: dbus.ObjectPath

1213

1718

bus: dbus.SystemBus()

1214

1719

"""

1215

1720

1216

1721

runtime_expansions = (Client.runtime_expansions

1217

+ ("dbus_object_path",))

1218

1722

+ ("dbus_object_path", ))

1723

1724

_interface = "se.recompile.Mandos.Client"

1725

1219

1726

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

1220

1221

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

1727

1728

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

1222

1729

self.bus = bus

1223

1730

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

1224

1731

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

1225

1732

# the D-Bus

1226

client_object_name = unicode(self.name).translate(

1733

client_object_name = str(self.name).translate(

1227

1734

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

1228

1735

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

1229

self.dbus_object_path = (dbus.ObjectPath

1230

("/clients/" + client_object_name))

1736

self.dbus_object_path = dbus.ObjectPath(

1737

"/clients/" + client_object_name)

1231

1738

DBusObjectWithProperties.__init__(self, self.bus,

1232

1739

self.dbus_object_path)

1233

1234

def notifychangeproperty(transform_func,

1235

dbus_name, type_func=lambda x: x,

1236

variant_level=1):

1740

1741

def notifychangeproperty(transform_func, dbus_name,

1742

type_func=lambda x: x,

1743

variant_level=1,

1744

invalidate_only=False,

1745

_interface=_interface):

1237

1746

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

1238

1747

its changes to DBus.

1239

1748

1240

1749

transform_fun: Function that takes a value and a variant_level

1241

1750

and transforms it to a D-Bus type.

1242

1751

dbus_name: D-Bus name of the variable

1244

1753

to the D-Bus. Default: no transform

1245

1754

variant_level: D-Bus variant level. Default: 1

1246

1755

"""

1247

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

1756

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

1757

1248

1758

def setter(self, value):

1249

1759

if hasattr(self, "dbus_object_path"):

1250

1760

if (not hasattr(self, attrname) or

1251

1761

type_func(getattr(self, attrname, None))

1252

1762

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

1763

if invalidate_only:

1764

self.PropertiesChanged(

1765

_interface, dbus.Dictionary(),

1766

dbus.Array((dbus_name, )))

1767

else:

1768

dbus_value = transform_func(

1769

type_func(value),

1770

variant_level=variant_level)

1771

self.PropertyChanged(dbus.String(dbus_name),

1772

dbus_value)

1773

self.PropertiesChanged(

1774

_interface,

1775

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

1776

dbus_value}),

1777

dbus.Array())

1258

1778

setattr(self, attrname, value)

1259

1779

1260

1780

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

1261

1781

1262

1782

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1263

1783

approvals_pending = notifychangeproperty(dbus.Boolean,

1264

1784

"ApprovalPending",

1265

type_func = bool)

1785

type_func=bool)

1266

1786

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

1267

1787

last_enabled = notifychangeproperty(datetime_to_dbus,

1268

1788

"LastEnabled")

1269

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

1270

type_func = lambda checker:

1271

checker is not None)

1789

checker = notifychangeproperty(

1790

dbus.Boolean, "CheckerRunning",

1791

type_func=lambda checker: checker is not None)

1272

1792

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1273

1793

"LastCheckedOK")

1274

1794

last_checker_status = notifychangeproperty(dbus.Int16,

1277

1797

datetime_to_dbus, "LastApprovalRequest")

1278

1798

approved_by_default = notifychangeproperty(dbus.Boolean,

1279

1799

"ApprovedByDefault")

1280

approval_delay = notifychangeproperty(dbus.UInt64,

1281

"ApprovalDelay",

1282

type_func =

1283

timedelta_to_milliseconds)

1800

approval_delay = notifychangeproperty(

1801

dbus.UInt64, "ApprovalDelay",

1802

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

1284

1803

approval_duration = notifychangeproperty(

1285

1804

dbus.UInt64, "ApprovalDuration",

1286

type_func = timedelta_to_milliseconds)

1805

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

1287

1806

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

1288

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

1289

type_func =

1290

timedelta_to_milliseconds)

1807

timeout = notifychangeproperty(

1808

dbus.UInt64, "Timeout",

1809

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

1291

1810

extended_timeout = notifychangeproperty(

1292

1811

dbus.UInt64, "ExtendedTimeout",

1293

type_func = timedelta_to_milliseconds)

1294

interval = notifychangeproperty(dbus.UInt64,

1295

"Interval",

1296

type_func =

1297

timedelta_to_milliseconds)

1812

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

1813

interval = notifychangeproperty(

1814

dbus.UInt64, "Interval",

1815

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

1298

1816

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

1299

1817

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

1818

invalidate_only=True)

1819

1300

1820

del notifychangeproperty

1301

1821

1302

1822

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

1303

1823

try:

1304

1824

self.remove_from_connection()

1307

1827

if hasattr(DBusObjectWithProperties, "__del__"):

1308

1828

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

1309

1829

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)

1830

1831

def checker_callback(self, source, condition,

1832

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

1833

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

1834

connection, command, *args,

1835

**kwargs)

1836

exitstatus = self.last_checker_status

1837

if exitstatus >= 0:

1317

1838

# Emit D-Bus signal

1318

1839

self.CheckerCompleted(dbus.Int16(exitstatus),

1319

dbus.Int64(condition),

1840

# This is specific to GNU libC

1841

dbus.Int64(exitstatus << 8),

1320

1842

dbus.String(command))

1321

1843

else:

1322

1844

# Emit D-Bus signal

1323

1845

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

1324

dbus.Int64(condition),

1846

dbus.Int64(

1847

# This is specific to GNU libC

1848

(exitstatus << 8)

1849

| self.last_checker_signal),

1325

1850

dbus.String(command))

1326

1327

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

1328

*args, **kwargs)

1329

1851

return ret

1852

1330

1853

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

1854

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

1336

1855

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

1337

1856

# Only if new checker process was started

1338

1857

if (self.checker is not None

1340

1859

# Emit D-Bus signal

1341

1860

self.CheckerStarted(self.current_checker_command)

1342

1861

return r

1343

1862

1344

1863

def _reset_approved(self):

1345

1864

self.approved = None

1346

1865

return False

1347

1866

1348

1867

def approve(self, value=True):

1349

1868

self.approved = value

1350

gobject.timeout_add(timedelta_to_milliseconds

1351

(self.approval_duration),

1352

self._reset_approved)

1869

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

1870

* 1000), self._reset_approved)

1353

1871

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

1872

1873

# D-Bus methods, signals & properties

1874

1875

# Interfaces

1876

1877

# Signals

1878

1367

1879

# CheckerCompleted - signal

1368

1880

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

1369

1881

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

1370

1882

"D-Bus signal"

1371

1883

pass

1372

1884

1373

1885

# CheckerStarted - signal

1374

1886

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

1375

1887

def CheckerStarted(self, command):

1376

1888

"D-Bus signal"

1377

1889

pass

1378

1890

1379

1891

# PropertyChanged - signal

1892

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

1380

1893

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

1381

1894

def PropertyChanged(self, property, value):

1382

1895

"D-Bus signal"

1383

1896

pass

1384

1897

1385

1898

# GotSecret - signal

1386

1899

@dbus.service.signal(_interface)

1387

1900

def GotSecret(self):

1390

1903

server to mandos-client

1391

1904

"""

1392

1905

pass

1393

1906

1394

1907

# Rejected - signal

1395

1908

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

1396

1909

def Rejected(self, reason):

1397

1910

"D-Bus signal"

1398

1911

pass

1399

1912

1400

1913

# NeedApproval - signal

1401

1914

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

1402

1915

def NeedApproval(self, timeout, default):

1403

1916

"D-Bus signal"

1404

1917

return self.need_approval()

1405

1406

## Methods

1407

1918

1919

# Methods

1920

1408

1921

# Approve - method

1409

1922

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

1410

1923

def Approve(self, value):

1411

1924

self.approve(value)

1412

1925

1413

1926

# CheckedOK - method

1414

1927

@dbus.service.method(_interface)

1415

1928

def CheckedOK(self):

1416

1929

self.checked_ok()

1417

1930

1418

1931

# Enable - method

1932

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

1419

1933

@dbus.service.method(_interface)

1420

1934

def Enable(self):

1421

1935

"D-Bus method"

1422

1936

self.enable()

1423

1937

1424

1938

# StartChecker - method

1939

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

1425

1940

@dbus.service.method(_interface)

1426

1941

def StartChecker(self):

1427

1942

"D-Bus method"

1428

1943

self.start_checker()

1429

1944

1430

1945

# Disable - method

1946

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

1431

1947

@dbus.service.method(_interface)

1432

1948

def Disable(self):

1433

1949

"D-Bus method"

1434

1950

self.disable()

1435

1951

1436

1952

# StopChecker - method

1953

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

1437

1954

@dbus.service.method(_interface)

1438

1955

def StopChecker(self):

1439

1956

self.stop_checker()

1440

1441

## Properties

1442

1957

1958

# Properties

1959

1443

1960

# ApprovalPending - property

1444

1961

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

1445

1962

def ApprovalPending_dbus_property(self):

1446

1963

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

1447

1964

1448

1965

# ApprovedByDefault - property

1449

@dbus_service_property(_interface, signature="b",

1966

@dbus_service_property(_interface,

1967

signature="b",

1450

1968

access="readwrite")

1451

1969

def ApprovedByDefault_dbus_property(self, value=None):

1452

1970

if value is None: # get

1453

1971

return dbus.Boolean(self.approved_by_default)

1454

1972

self.approved_by_default = bool(value)

1455

1973

1456

1974

# ApprovalDelay - property

1457

@dbus_service_property(_interface, signature="t",

1975

@dbus_service_property(_interface,

1976

signature="t",

1458

1977

access="readwrite")

1459

1978

def ApprovalDelay_dbus_property(self, value=None):

1460

1979

if value is None: # get

1461

return dbus.UInt64(self.approval_delay_milliseconds())

1980

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

1981

* 1000)

1462

1982

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

1463

1983

1464

1984

# ApprovalDuration - property

1465

@dbus_service_property(_interface, signature="t",

1985

@dbus_service_property(_interface,

1986

signature="t",

1466

1987

access="readwrite")

1467

1988

def ApprovalDuration_dbus_property(self, value=None):

1468

1989

if value is None: # get

1469

return dbus.UInt64(timedelta_to_milliseconds(

1470

self.approval_duration))

1990

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

1991

* 1000)

1471

1992

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

1472

1993

1473

1994

# Name - property

1995

@dbus_annotations(

1996

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

1474

1997

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

1475

1998

def Name_dbus_property(self):

1476

1999

return dbus.String(self.name)

1477

2000

1478

2001

# Fingerprint - property

2002

@dbus_annotations(

2003

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

1479

2004

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

1480

2005

def Fingerprint_dbus_property(self):

1481

2006

return dbus.String(self.fingerprint)

1482

2007

1483

2008

# Host - property

1484

@dbus_service_property(_interface, signature="s",

2009

@dbus_service_property(_interface,

2010

signature="s",

1485

2011

access="readwrite")

1486

2012

def Host_dbus_property(self, value=None):

1487

2013

if value is None: # get

1488

2014

return dbus.String(self.host)

1489

self.host = unicode(value)

1490

2015

self.host = str(value)

2016

1491

2017

# Created - property

2018

@dbus_annotations(

2019

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

1492

2020

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

1493

2021

def Created_dbus_property(self):

1494

2022

return datetime_to_dbus(self.created)

1495

2023

1496

2024

# LastEnabled - property

1497

2025

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

1498

2026

def LastEnabled_dbus_property(self):

1499

2027

return datetime_to_dbus(self.last_enabled)

1500

2028

1501

2029

# Enabled - property

1502

@dbus_service_property(_interface, signature="b",

2030

@dbus_service_property(_interface,

2031

signature="b",

1503

2032

access="readwrite")

1504

2033

def Enabled_dbus_property(self, value=None):

1505

2034

if value is None: # get

1508

2037

self.enable()

1509

2038

else:

1510

2039

self.disable()

1511

2040

1512

2041

# LastCheckedOK - property

1513

@dbus_service_property(_interface, signature="s",

2042

@dbus_service_property(_interface,

2043

signature="s",

1514

2044

access="readwrite")

1515

2045

def LastCheckedOK_dbus_property(self, value=None):

1516

2046

if value is not None:

1517

2047

self.checked_ok()

1518

2048

return

1519

2049

return datetime_to_dbus(self.last_checked_ok)

1520

2050

1521

2051

# LastCheckerStatus - property

1522

@dbus_service_property(_interface, signature="n",

1523

access="read")

2052

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

1524

2053

def LastCheckerStatus_dbus_property(self):

1525

2054

return dbus.Int16(self.last_checker_status)

1526

2055

1527

2056

# Expires - property

1528

2057

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

1529

2058

def Expires_dbus_property(self):

1530

2059

return datetime_to_dbus(self.expires)

1531

2060

1532

2061

# LastApprovalRequest - property

1533

2062

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

1534

2063

def LastApprovalRequest_dbus_property(self):

1535

2064

return datetime_to_dbus(self.last_approval_request)

1536

2065

1537

2066

# Timeout - property

1538

@dbus_service_property(_interface, signature="t",

2067

@dbus_service_property(_interface,

2068

signature="t",

1539

2069

access="readwrite")

1540

2070

def Timeout_dbus_property(self, value=None):

1541

2071

if value is None: # get

1542

return dbus.UInt64(self.timeout_milliseconds())

2072

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

1543

2073

old_timeout = self.timeout

1544

2074

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

1545

2075

# Reschedule disabling

1553

2083

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

1554

2084

is None):

1555

2085

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

2086

GLib.source_remove(self.disable_initiator_tag)

2087

self.disable_initiator_tag = GLib.timeout_add(

2088

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

2089

self.disable)

2090

1562

2091

# ExtendedTimeout - property

1563

@dbus_service_property(_interface, signature="t",

2092

@dbus_service_property(_interface,

2093

signature="t",

1564

2094

access="readwrite")

1565

2095

def ExtendedTimeout_dbus_property(self, value=None):

1566

2096

if value is None: # get

1567

return dbus.UInt64(self.extended_timeout_milliseconds())

2097

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

2098

* 1000)

1568

2099

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

1569

2100

1570

2101

# Interval - property

1571

@dbus_service_property(_interface, signature="t",

2102

@dbus_service_property(_interface,

2103

signature="t",

1572

2104

access="readwrite")

1573

2105

def Interval_dbus_property(self, value=None):

1574

2106

if value is None: # get

1575

return dbus.UInt64(self.interval_milliseconds())

2107

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

1576

2108

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

1577

2109

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

1578

2110

return

1579

2111

if self.enabled:

1580

2112

# 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

2113

GLib.source_remove(self.checker_initiator_tag)

2114

self.checker_initiator_tag = GLib.timeout_add(

2115

value, self.start_checker)

2116

self.start_checker() # Start one now, too

2117

1586

2118

# Checker - property

1587

@dbus_service_property(_interface, signature="s",

2119

@dbus_service_property(_interface,

2120

signature="s",

1588

2121

access="readwrite")

1589

2122

def Checker_dbus_property(self, value=None):

1590

2123

if value is None: # get

1591

2124

return dbus.String(self.checker_command)

1592

self.checker_command = unicode(value)

1593

2125

self.checker_command = str(value)

2126

1594

2127

# CheckerRunning - property

1595

@dbus_service_property(_interface, signature="b",

2128

@dbus_service_property(_interface,

2129

signature="b",

1596

2130

access="readwrite")

1597

2131

def CheckerRunning_dbus_property(self, value=None):

1598

2132

if value is None: # get

1601

2135

self.start_checker()

1602

2136

else:

1603

2137

self.stop_checker()

1604

2138

1605

2139

# ObjectPath - property

2140

@dbus_annotations(

2141

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

2142

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

1606

2143

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

1607

2144

def ObjectPath_dbus_property(self):

1608

return self.dbus_object_path # is already a dbus.ObjectPath

1609

2145

return self.dbus_object_path # is already a dbus.ObjectPath

2146

1610

2147

# Secret = property

1611

@dbus_service_property(_interface, signature="ay",

1612

access="write", byte_arrays=True)

2148

@dbus_annotations(

2149

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

2150

"invalidates"})

2151

@dbus_service_property(_interface,

2152

signature="ay",

2153

access="write",

2154

byte_arrays=True)

1613

2155

def Secret_dbus_property(self, value):

1614

self.secret = str(value)

1615

2156

self.secret = bytes(value)

2157

1616

2158

del _interface

1617

2159

1618

2160

1621

2163

self._pipe = child_pipe

1622

2164

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

1623

2165

if not self._pipe.recv():

1624

raise KeyError()

1625

2166

raise KeyError(fpr)

2167

1626

2168

def __getattribute__(self, name):

1627

2169

if name == '_pipe':

1628

2170

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

1631

2173

if data[0] == 'data':

1632

2174

return data[1]

1633

2175

if data[0] == 'function':

2176

1634

2177

def func(*args, **kwargs):

1635

2178

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

1636

2179

return self._pipe.recv()[1]

2180

1637

2181

return func

1638

2182

1639

2183

def __setattr__(self, name, value):

1640

2184

if name == '_pipe':

1641

2185

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

1644

2188

1645

2189

class ClientHandler(socketserver.BaseRequestHandler, object):

1646

2190

"""A class to handle client connections.

1647

2191

1648

2192

Instantiated once for each connection to handle it.

1649

2193

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

1650

2194

1651

2195

def handle(self):

1652

2196

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

1653

2197

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

1654

unicode(self.client_address))

2198

str(self.client_address))

1655

2199

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

1656

2200

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

2201

2202

session = gnutls.ClientSession(self.request)

2203

2204

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

2205

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

2206

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

2207

# "+DHE-DSS"))

1672

2208

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

1673

2209

priority = self.server.gnutls_priority

1674

2210

if priority is None:

1675

2211

priority = "NORMAL"

1676

(gnutls.library.functions

1677

.gnutls_priority_set_direct(session._c_object,

1678

priority, None))

1679

2212

gnutls.priority_set_direct(session._c_object,

2213

priority.encode("utf-8"),

2214

None)

2215

1680

2216

# Start communication using the Mandos protocol

1681

2217

# Get protocol number

1682

2218

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

1683

2219

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

1684

2220

try:

1685

2221

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

1686

raise RuntimeError

2222

raise RuntimeError(line)

1687

2223

except (ValueError, IndexError, RuntimeError) as error:

1688

2224

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

1689

2225

return

1690

2226

1691

2227

# Start GnuTLS connection

1692

2228

try:

1693

2229

session.handshake()

1694

except gnutls.errors.GNUTLSError as error:

2230

except gnutls.Error as error:

1695

2231

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

1696

2232

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

1697

2233

# established. Just abandon the request.

1698

2234

return

1699

2235

logger.debug("Handshake succeeded")

1700

2236

1701

2237

approval_required = False

1702

2238

try:

1703

2239

try:

1704

fpr = self.fingerprint(self.peer_certificate

1705

(session))

1706

except (TypeError,

1707

gnutls.errors.GNUTLSError) as error:

2240

fpr = self.fingerprint(

2241

self.peer_certificate(session))

2242

except (TypeError, gnutls.Error) as error:

1708

2243

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

1709

2244

return

1710

2245

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

1711

2246

1712

2247

try:

1713

2248

client = ProxyClient(child_pipe, fpr,

1714

2249

self.client_address)

1715

2250

except KeyError:

1716

2251

return

1717

2252

1718

2253

if client.approval_delay:

1719

2254

delay = client.approval_delay

1720

2255

client.approvals_pending += 1

1721

2256

approval_required = True

1722

2257

1723

2258

while True:

1724

2259

if not client.enabled:

1725

2260

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

1726

client.name)

2261

client.name)

1727

2262

if self.server.use_dbus:

1728

2263

# Emit D-Bus signal

1729

2264

client.Rejected("Disabled")

1730

2265

return

1731

2266

1732

2267

if client.approved or not client.approval_delay:

1733

#We are approved or approval is disabled

2268

# We are approved or approval is disabled

1734

2269

break

1735

2270

elif client.approved is None:

1736

2271

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

1738

2273

if self.server.use_dbus:

1739

2274

# Emit D-Bus signal

1740

2275

client.NeedApproval(

1741

client.approval_delay_milliseconds(),

1742

client.approved_by_default)

2276

client.approval_delay.total_seconds()

2277

* 1000, client.approved_by_default)

1743

2278

else:

1744

2279

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

1745

2280

client.name)

1747

2282

# Emit D-Bus signal

1748

2283

client.Rejected("Denied")

1749

2284

return

1750

1751

#wait until timeout or approved

2285

2286

# wait until timeout or approved

1752

2287

time = datetime.datetime.now()

1753

2288

client.changedstate.acquire()

1754

client.changedstate.wait(

1755

float(timedelta_to_milliseconds(delay)

1756

/ 1000))

2289

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

1757

2290

client.changedstate.release()

1758

2291

time2 = datetime.datetime.now()

1759

2292

if (time2 - time) >= delay:

1769

2302

break

1770

2303

else:

1771

2304

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

2305

2306

try:

2307

session.send(client.secret)

2308

except gnutls.Error as error:

2309

logger.warning("gnutls send failed",

2310

exc_info=error)

2311

return

2312

1786

2313

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

1787

2314

# bump the timeout using extended_timeout

1788

2315

client.bump_timeout(client.extended_timeout)

1789

2316

if self.server.use_dbus:

1790

2317

# Emit D-Bus signal

1791

2318

client.GotSecret()

1792

2319

1793

2320

finally:

1794

2321

if approval_required:

1795

2322

client.approvals_pending -= 1

1796

2323

try:

1797

2324

session.bye()

1798

except gnutls.errors.GNUTLSError as error:

2325

except gnutls.Error as error:

1799

2326

logger.warning("GnuTLS bye failed",

1800

2327

exc_info=error)

1801

2328

1802

2329

@staticmethod

1803

2330

def peer_certificate(session):

1804

2331

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

1805

2332

# 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

2333

if (gnutls.certificate_type_get(session._c_object)

2334

!= gnutls.CRT_OPENPGP):

2335

# ...return invalid data

2336

return b""

1811

2337

list_size = ctypes.c_uint(1)

1812

cert_list = (gnutls.library.functions

1813

.gnutls_certificate_get_peers

2338

cert_list = (gnutls.certificate_get_peers

1814

2339

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

1815

2340

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

1816

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

1817

" certificate")

2341

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

1818

2342

if list_size.value == 0:

1819

2343

return None

1820

2344

cert = cert_list[0]

1821

2345

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

1822

2346

1823

2347

@staticmethod

1824

2348

def fingerprint(openpgp):

1825

2349

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1826

2350

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

2351

datum = gnutls.datum_t(

2352

ctypes.cast(ctypes.c_char_p(openpgp),

2353

ctypes.POINTER(ctypes.c_ubyte)),

2354

ctypes.c_uint(len(openpgp)))

1832

2355

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

2356

crt = gnutls.openpgp_crt_t()

2357

gnutls.openpgp_crt_init(ctypes.byref(crt))

1836

2358

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

2359

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

2360

gnutls.OPENPGP_FMT_RAW)

1841

2361

# Verify the self signature in the key

1842

2362

crtverify = ctypes.c_uint()

1843

(gnutls.library.functions

1844

.gnutls_openpgp_crt_verify_self(crt, 0,

1845

ctypes.byref(crtverify)))

2363

gnutls.openpgp_crt_verify_self(crt, 0,

2364

ctypes.byref(crtverify))

1846

2365

if crtverify.value != 0:

1847

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1848

raise (gnutls.errors.CertificateSecurityError

1849

("Verify failed"))

2366

gnutls.openpgp_crt_deinit(crt)

2367

raise gnutls.CertificateSecurityError("Verify failed")

1850

2368

# New buffer for the fingerprint

1851

2369

buf = ctypes.create_string_buffer(20)

1852

2370

buf_len = ctypes.c_size_t()

1853

2371

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

2372

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

2373

ctypes.byref(buf_len))

1857

2374

# Deinit the certificate

1858

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2375

gnutls.openpgp_crt_deinit(crt)

1859

2376

# Convert the buffer to a Python bytestring

1860

2377

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

1861

2378

# Convert the bytestring to hexadecimal notation

1865

2382

1866

2383

class MultiprocessingMixIn(object):

1867

2384

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

2385

1868

2386

def sub_process_main(self, request, address):

1869

2387

try:

1870

2388

self.finish_request(request, address)

1871

2389

except Exception:

1872

2390

self.handle_error(request, address)

1873

2391

self.close_request(request)

1874

2392

1875

2393

def process_request(self, request, address):

1876

2394

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

1877

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

1878

args = (request, address))

2395

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

2396

args=(request, address))

1879

2397

proc.start()

1880

2398

return proc

1881

2399

1882

2400

1883

2401

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1884

2402

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

2403

1885

2404

def process_request(self, request, client_address):

1886

2405

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

1887

2406

1888

2407

This function creates a new pipe in self.pipe

1889

2408

"""

1890

2409

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1891

2410

1892

2411

proc = MultiprocessingMixIn.process_request(self, request,

1893

2412

client_address)

1894

2413

self.child_pipe.close()

1895

2414

self.add_pipe(parent_pipe, proc)

1896

2415

1897

2416

def add_pipe(self, parent_pipe, proc):

1898

2417

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

1899

raise NotImplementedError

2418

raise NotImplementedError()

1900

2419

1901

2420

1902

2421

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1903

2422

socketserver.TCPServer, object):

1904

2423

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

1905

2424

1906

2425

Attributes:

1907

2426

enabled: Boolean; whether this server is activated yet

1908

2427

interface: None or a network interface name (string)

1909

2428

use_ipv6: Boolean; to use IPv6 or not

1910

2429

"""

2430

1911

2431

def __init__(self, server_address, RequestHandlerClass,

1912

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

2432

interface=None,

2433

use_ipv6=True,

2434

socketfd=None):

1913

2435

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

1914

2436

creating a new one with socket.socket().

1915

2437

"""

1921

2443

self.socketfd = socketfd

1922

2444

# Save the original socket.socket() function

1923

2445

self.socket_socket = socket.socket

2446

1924

2447

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

1925

#

2448

#

1926

2449

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

1927

2450

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

1928

2451

# patching socket.socket.)

1929

#

2452

#

1930

2453

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

1931

2454

@functools.wraps(socket.socket)

1932

2455

def socket_wrapper(*args, **kwargs):

1944

2467

# socket_wrapper(), if socketfd was set.

1945

2468

socketserver.TCPServer.__init__(self, server_address,

1946

2469

RequestHandlerClass)

1947

2470

1948

2471

def server_bind(self):

1949

2472

"""This overrides the normal server_bind() function

1950

2473

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

1951

2474

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

2475

global SO_BINDTODEVICE

1952

2476

if self.interface is not None:

1953

2477

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

2478

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

2479

# common enough.

2480

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

2481

SO_BINDTODEVICE = 25

2482

try:

2483

self.socket.setsockopt(

2484

socket.SOL_SOCKET, SO_BINDTODEVICE,

2485

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

2486

except socket.error as error:

2487

if error.errno == errno.EPERM:

2488

logger.error("No permission to bind to"

2489

" interface %s", self.interface)

2490

elif error.errno == errno.ENOPROTOOPT:

2491

logger.error("SO_BINDTODEVICE not available;"

2492

" cannot bind to interface %s",

2493

self.interface)

2494

elif error.errno == errno.ENODEV:

2495

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

2496

" cannot bind", self.interface)

2497

else:

2498

raise

1975

2499

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

1976

2500

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

1977

2501

if not self.server_address[0]:

1978

2502

if self.address_family == socket.AF_INET6:

1979

any_address = "::" # in6addr_any

2503

any_address = "::" # in6addr_any

1980

2504

else:

1981

any_address = socket.INADDR_ANY

2505

any_address = "0.0.0.0" # INADDR_ANY

1982

2506

self.server_address = (any_address,

1983

2507

self.server_address[1])

1984

2508

elif not self.server_address[1]:

1985

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

1986

0)

2509

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

1987

2510

# if self.interface:

1988

2511

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

1989

2512

# 0, # port

1995

2518

1996

2519

class MandosServer(IPv6_TCPServer):

1997

2520

"""Mandos server.

1998

2521

1999

2522

Attributes:

2000

2523

clients: set of Client objects

2001

2524

gnutls_priority GnuTLS priority string

2002

2525

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

2003

2004

Assumes a gobject.MainLoop event loop.

2526

2527

Assumes a GLib.MainLoop event loop.

2005

2528

"""

2529

2006

2530

def __init__(self, server_address, RequestHandlerClass,

2007

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

2008

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

2531

interface=None,

2532

use_ipv6=True,

2533

clients=None,

2534

gnutls_priority=None,

2535

use_dbus=True,

2536

socketfd=None):

2009

2537

self.enabled = False

2010

2538

self.clients = clients

2011

2539

if self.clients is None:

2014

2542

self.gnutls_priority = gnutls_priority

2015

2543

IPv6_TCPServer.__init__(self, server_address,

2016

2544

RequestHandlerClass,

2017

interface = interface,

2018

use_ipv6 = use_ipv6,

2019

socketfd = socketfd)

2545

interface=interface,

2546

use_ipv6=use_ipv6,

2547

socketfd=socketfd)

2548

2020

2549

def server_activate(self):

2021

2550

if self.enabled:

2022

2551

return socketserver.TCPServer.server_activate(self)

2023

2552

2024

2553

def enable(self):

2025

2554

self.enabled = True

2026

2555

2027

2556

def add_pipe(self, parent_pipe, proc):

2028

2557

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

2558

GLib.io_add_watch(

2559

parent_pipe.fileno(),

2560

GLib.IO_IN | GLib.IO_HUP,

2561

functools.partial(self.handle_ipc,

2562

parent_pipe=parent_pipe,

2563

proc=proc))

2564

2565

def handle_ipc(self, source, condition,

2566

parent_pipe=None,

2567

proc=None,

2568

client_object=None):

2038

2569

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

2039

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

2570

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

2040

2571

# Wait for other process to exit

2041

2572

proc.join()

2042

2573

return False

2043

2574

2044

2575

# Read a request from the child

2045

2576

request = parent_pipe.recv()

2046

2577

command = request[0]

2047

2578

2048

2579

if command == 'init':

2049

2580

fpr = request[1]

2050

2581

address = request[2]

2051

2052

for c in self.clients.itervalues():

2582

2583

for c in self.clients.values():

2053

2584

if c.fingerprint == fpr:

2054

2585

client = c

2055

2586

break

2062

2593

address[0])

2063

2594

parent_pipe.send(False)

2064

2595

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

2596

2597

GLib.io_add_watch(

2598

parent_pipe.fileno(),

2599

GLib.IO_IN | GLib.IO_HUP,

2600

functools.partial(self.handle_ipc,

2601

parent_pipe=parent_pipe,

2602

proc=proc,

2603

client_object=client))

2074

2604

parent_pipe.send(True)

2075

2605

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

2076

2606

# same fileno

2079

2609

funcname = request[1]

2080

2610

args = request[2]

2081

2611

kwargs = request[3]

2082

2612

2083

2613

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

2084

2614

funcname)(*args,

2085

**kwargs)))

2086

2615

**kwargs)))

2616

2087

2617

if command == 'getattr':

2088

2618

attrname = request[1]

2089

if callable(client_object.__getattribute__(attrname)):

2090

parent_pipe.send(('function',))

2619

if isinstance(client_object.__getattribute__(attrname),

2620

collections.Callable):

2621

parent_pipe.send(('function', ))

2091

2622

else:

2092

parent_pipe.send(('data', client_object

2093

.__getattribute__(attrname)))

2094

2623

parent_pipe.send((

2624

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

2625

2095

2626

if command == 'setattr':

2096

2627

attrname = request[1]

2097

2628

value = request[2]

2098

2629

setattr(client_object, attrname, value)

2099

2630

2100

2631

return True

2101

2632

2102

2633

2103

2634

def rfc3339_duration_to_delta(duration):

2104

2635

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

2105

2636

2106

2637

>>> rfc3339_duration_to_delta("P7D")

2107

2638

datetime.timedelta(7)

2108

2639

>>> rfc3339_duration_to_delta("PT60S")

2118

2649

>>> rfc3339_duration_to_delta("P1DT3M20S")

2119

2650

datetime.timedelta(1, 200)

2120

2651

"""

2121

2652

2122

2653

# Parsing an RFC 3339 duration with regular expressions is not

2123

2654

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

2124

2655

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

2125

2656

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

2126

2657

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

2127

2658

# avoid excessive use of external libraries.

2128

2659

2129

2660

# 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

2661

Token = collections.namedtuple("Token", (

2662

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

2663

# a "group" containing digits

2664

"value", # datetime.timedelta or None

2665

"followers")) # Tokens valid after this token

2139

2666

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

2140

2667

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

2141

2668

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

2142

2669

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

2143

2670

datetime.timedelta(seconds=1),

2144

frozenset((token_end,)))

2671

frozenset((token_end, )))

2145

2672

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

2146

2673

datetime.timedelta(minutes=1),

2147

2674

frozenset((token_second, token_end)))

2163

2690

frozenset((token_month, token_end)))

2164

2691

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

2165

2692

datetime.timedelta(weeks=1),

2166

frozenset((token_end,)))

2693

frozenset((token_end, )))

2167

2694

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

2168

2695

frozenset((token_year, token_month,

2169

2696

token_day, token_time,

2170

token_week))),

2171

# Define starting values

2172

value = datetime.timedelta() # Value so far

2697

token_week)))

2698

# Define starting values:

2699

# Value so far

2700

value = datetime.timedelta()

2173

2701

found_token = None

2174

followers = frozenset(token_duration,) # Following valid tokens

2175

s = duration # String left to parse

2702

# Following valid tokens

2703

followers = frozenset((token_duration, ))

2704

# String left to parse

2705

s = duration

2176

2706

# Loop until end token is found

2177

2707

while found_token is not token_end:

2178

2708

# Search for any currently valid tokens

2194

2724

break

2195

2725

else:

2196

2726

# No currently valid tokens were found

2197

raise ValueError("Invalid RFC 3339 duration")

2727

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

2728

.format(duration))

2198

2729

# End token found

2199

2730

return value

2200

2731

2201

2732

2202

2733

def string_to_delta(interval):

2203

2734

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

2204

2735

2205

2736

>>> string_to_delta('7d')

2206

2737

datetime.timedelta(7)

2207

2738

>>> string_to_delta('60s')

2215

2746

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

2216

2747

datetime.timedelta(0, 330)

2217

2748

"""

2218

2749

2219

2750

try:

2220

2751

return rfc3339_duration_to_delta(interval)

2221

2752

except ValueError:

2222

2753

pass

2223

2754

2224

2755

timevalue = datetime.timedelta(0)

2225

2756

for s in interval.split():

2226

2757

try:

2227

suffix = unicode(s[-1])

2758

suffix = s[-1]

2228

2759

value = int(s[:-1])

2229

2760

if suffix == "d":

2230

2761

delta = datetime.timedelta(value)

2237

2768

elif suffix == "w":

2238

2769

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

2239

2770

else:

2240

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

2241

.format(suffix))

2242

except (ValueError, IndexError) as e:

2771

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

2772

except IndexError as e:

2243

2773

raise ValueError(*(e.args))

2244

2774

timevalue += delta

2245

2775

return timevalue

2246

2776

2247

2777

2248

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

2778

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

2249

2779

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

2250

2780

2251

2781

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

2252

2782

if os.fork():

2253

2783

sys.exit()

2261

2791

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

2262

2792

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

2263

2793

raise OSError(errno.ENODEV,

2264

"{0} not a character device"

2794

"{} not a character device"

2265

2795

.format(os.devnull))

2266

2796

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

2267

2797

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

2271

2801

2272

2802

2273

2803

def main():

2274

2804

2275

2805

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

2276

2806

# Parsing of options, both command line and config file

2277

2807

2278

2808

parser = argparse.ArgumentParser()

2279

2809

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

2280

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

2810

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

2281

2811

help="show version number and exit")

2282

2812

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

2283

2813

help="Bind to interface IF")

2289

2819

help="Run self-test")

2290

2820

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

2291

2821

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

2292

" to terminal")

2822

" to terminal", default=None)

2293

2823

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

2294

2824

help="Debug level for stdout output")

2295

2825

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

2302

2832

" files")

2303

2833

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

2304

2834

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

2305

" system bus interface")

2835

" system bus interface", default=None)

2306

2836

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

2307

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

2837

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

2838

default=None)

2308

2839

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

2309

2840

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

2310

" state")

2841

" state", default=None)

2311

2842

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

2312

2843

help="Specify a file descriptor to a network"

2313

2844

" socket to use instead of creating one")

2314

2845

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

2315

2846

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

2316

2847

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

2317

help="Run in foreground")

2318

2848

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

2849

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

2850

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

2851

default=None)

2852

2319

2853

options = parser.parse_args()

2320

2854

2321

2855

if options.check:

2322

2856

import doctest

2323

doctest.testmod()

2324

sys.exit()

2325

2857

fail_count, test_count = doctest.testmod()

2858

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

2859

2326

2860

# 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

2861

server_defaults = {"interface": "",

2862

"address": "",

2863

"port": "",

2864

"debug": "False",

2865

"priority":

2866

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

2867

":+SIGN-DSA-SHA256",

2868

"servicename": "Mandos",

2869

"use_dbus": "True",

2870

"use_ipv6": "True",

2871

"debuglevel": "",

2872

"restore": "True",

2873

"socket": "",

2874

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

2875

"foreground": "False",

2876

"zeroconf": "True",

2877

}

2878

2343

2879

# Parse config file for server-global settings

2344

2880

server_config = configparser.SafeConfigParser(server_defaults)

2345

2881

del server_defaults

2346

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

2347

"mandos.conf"))

2882

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

2348

2883

# Convert the SafeConfigParser object to a dict

2349

2884

server_settings = server_config.defaults()

2350

2885

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

2364

2899

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

2365

2900

["socket"])

2366

2901

del server_config

2367

2902

2368

2903

# Override the settings from the config file with command line

2369

2904

# options, if set.

2370

2905

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

2371

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

2372

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

2373

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

2906

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

2907

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

2908

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

2374

2909

value = getattr(options, option)

2375

2910

if value is not None:

2376

2911

server_settings[option] = value

2377

2912

del options

2378

2913

# Force all strings to be unicode

2379

2914

for option in server_settings.keys():

2380

if type(server_settings[option]) is str:

2381

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

2915

if isinstance(server_settings[option], bytes):

2916

server_settings[option] = (server_settings[option]

2917

.decode("utf-8"))

2918

# Force all boolean options to be boolean

2919

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

2920

"foreground", "zeroconf"):

2921

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

2382

2922

# Debug implies foreground

2383

2923

if server_settings["debug"]:

2384

2924

server_settings["foreground"] = True

2385

2925

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

2386

2926

2387

2927

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

2388

2928

2929

if (not server_settings["zeroconf"]

2930

and not (server_settings["port"]

2931

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

2932

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

2933

2389

2934

# For convenience

2390

2935

debug = server_settings["debug"]

2391

2936

debuglevel = server_settings["debuglevel"]

2394

2939

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

2395

2940

stored_state_file)

2396

2941

foreground = server_settings["foreground"]

2397

2942

zeroconf = server_settings["zeroconf"]

2943

2398

2944

if debug:

2399

2945

initlogger(debug, logging.DEBUG)

2400

2946

else:

2403

2949

else:

2404

2950

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

2405

2951

initlogger(debug, level)

2406

2952

2407

2953

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

2954

syslogger.setFormatter(

2955

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

2956

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

2957

server_settings["servicename"])))

2958

2414

2959

# Parse config file with clients

2415

2960

client_config = configparser.SafeConfigParser(Client

2416

2961

.client_defaults)

2417

2962

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

2418

2963

"clients.conf"))

2419

2964

2420

2965

global mandos_dbus_service

2421

2966

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

2967

2968

socketfd = None

2969

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

2970

socketfd = server_settings["socket"]

2971

tcp_server = MandosServer(

2972

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

2973

ClientHandler,

2974

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

2975

use_ipv6=use_ipv6,

2976

gnutls_priority=server_settings["priority"],

2977

use_dbus=use_dbus,

2978

socketfd=socketfd)

2434

2979

if not foreground:

2435

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

2980

pidfilename = "/run/mandos.pid"

2981

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

2982

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

2436

2983

pidfile = None

2437

2984

try:

2438

pidfile = open(pidfilename, "w")

2985

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

2439

2986

except IOError as e:

2440

2987

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

2441

2988

exc_info=e)

2442

2443

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

2989

2990

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

2991

("mandos", "mandos"),

2992

("nobody", "nogroup")):

2444

2993

try:

2445

2994

uid = pwd.getpwnam(name).pw_uid

2446

gid = pwd.getpwnam(name).pw_gid

2995

gid = pwd.getpwnam(group).pw_gid

2447

2996

break

2448

2997

except KeyError:

2449

2998

continue

2453

3002

try:

2454

3003

os.setgid(gid)

2455

3004

os.setuid(uid)

3005

if debug:

3006

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

3007

gid))

2456

3008

except OSError as error:

3009

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

3010

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

2457

3011

if error.errno != errno.EPERM:

2458

raise error

2459

3012

raise

3013

2460

3014

if debug:

2461

3015

# Enable all possible GnuTLS debugging

2462

3016

2463

3017

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

2464

3018

# - GnuTLS manual

2465

gnutls.library.functions.gnutls_global_set_log_level(11)

2466

2467

@gnutls.library.types.gnutls_log_func

3019

gnutls.global_set_log_level(11)

3020

3021

@gnutls.log_func

2468

3022

def debug_gnutls(level, string):

2469

3023

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

2470

2471

(gnutls.library.functions

2472

.gnutls_global_set_log_function(debug_gnutls))

2473

3024

3025

gnutls.global_set_log_function(debug_gnutls)

3026

2474

3027

# Redirect stdin so all checkers get /dev/null

2475

3028

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

2476

3029

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

2477

3030

if null > 2:

2478

3031

os.close(null)

2479

3032

2480

3033

# Need to fork before connecting to D-Bus

2481

3034

if not foreground:

2482

3035

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

2483

3036

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

3037

3038

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

3039

# to inform GLib that threads will be used.

3040

GLib.threads_init()

3041

2489

3042

global main_loop

2490

3043

# From the Avahi example code

2491

3044

DBusGMainLoop(set_as_default=True)

2492

main_loop = gobject.MainLoop()

3045

main_loop = GLib.MainLoop()

2493

3046

bus = dbus.SystemBus()

2494

3047

# End of Avahi example code

2495

3048

if use_dbus:

2496

3049

try:

2497

3050

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:

3051

bus,

3052

do_not_queue=True)

3053

old_bus_name = dbus.service.BusName(

3054

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

3055

do_not_queue=True)

3056

except dbus.exceptions.DBusException as e:

2503

3057

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

2504

3058

use_dbus = False

2505

3059

server_settings["use_dbus"] = False

2506

3060

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

3061

if zeroconf:

3062

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3063

service = AvahiServiceToSyslog(

3064

name=server_settings["servicename"],

3065

servicetype="_mandos._tcp",

3066

protocol=protocol,

3067

bus=bus)

3068

if server_settings["interface"]:

3069

service.interface = if_nametoindex(

3070

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

3071

2516

3072

global multiprocessing_manager

2517

3073

multiprocessing_manager = multiprocessing.Manager()

2518

3074

2519

3075

client_class = Client

2520

3076

if use_dbus:

2521

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

2522

3077

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

3078

2523

3079

client_settings = Client.config_parser(client_config)

2524

3080

old_client_settings = {}

2525

3081

clients_data = {}

2526

3082

3083

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

3084

global wnull

3085

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

3086

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

3087

# mode

3088

if debug or not foreground:

3089

wnull.close()

3090

2527

3091

# Get client data and settings from last running state.

2528

3092

if server_settings["restore"]:

2529

3093

try:

2530

3094

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

2531

clients_data, old_client_settings = (pickle.load

2532

(stored_state))

3095

if sys.version_info.major == 2:

3096

clients_data, old_client_settings = pickle.load(

3097

stored_state)

3098

else:

3099

bytes_clients_data, bytes_old_client_settings = (

3100

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

3101

# Fix bytes to strings

3102

# clients_data

3103

# .keys()

3104

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

3105

if isinstance(key, bytes)

3106

else key): value

3107

for key, value in

3108

bytes_clients_data.items()}

3109

del bytes_clients_data

3110

for key in clients_data:

3111

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

3112

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

3113

for k, v in

3114

clients_data[key].items()}

3115

clients_data[key] = value

3116

# .client_structure

3117

value["client_structure"] = [

3118

(s.decode("utf-8")

3119

if isinstance(s, bytes)

3120

else s) for s in

3121

value["client_structure"]]

3122

# .name & .host

3123

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

3124

if isinstance(value[k], bytes):

3125

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

3126

# old_client_settings

3127

# .keys()

3128

old_client_settings = {

3129

(key.decode("utf-8")

3130

if isinstance(key, bytes)

3131

else key): value

3132

for key, value in

3133

bytes_old_client_settings.items()}

3134

del bytes_old_client_settings

3135

# .host

3136

for value in old_client_settings.values():

3137

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

3138

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

3139

.decode("utf-8"))

2533

3140

os.remove(stored_state_path)

2534

3141

except IOError as e:

2535

3142

if e.errno == errno.ENOENT:

2536

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

2537

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

3143

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

3144

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

2538

3145

else:

2539

3146

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

2540

3147

exc_info=e)

2541

3148

raise

2542

3149

except EOFError as e:

2543

3150

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

2544

"EOFError:", exc_info=e)

2545

3151

"EOFError:",

3152

exc_info=e)

3153

2546

3154

with PGPEngine() as pgp:

2547

for client_name, client in clients_data.iteritems():

3155

for client_name, client in clients_data.items():

3156

# Skip removed clients

3157

if client_name not in client_settings:

3158

continue

3159

2548

3160

# Decide which value to use after restoring saved state.

2549

3161

# We have three different values: Old config file,

2550

3162

# new config file, and saved state.

2555

3167

# For each value in new config, check if it

2556

3168

# differs from the old config value (Except for

2557

3169

# the "secret" attribute)

2558

if (name != "secret" and

2559

value != old_client_settings[client_name]

2560

[name]):

3170

if (name != "secret"

3171

and (value !=

3172

old_client_settings[client_name][name])):

2561

3173

client[name] = value

2562

3174

except KeyError:

2563

3175

pass

2564

3176

2565

3177

# Clients who has passed its expire date can still be

2566

# enabled if its last checker was successful. Clients

3178

# enabled if its last checker was successful. A Client

2567

3179

# whose checker succeeded before we stored its state is

2568

3180

# assumed to have successfully run all checkers during

2569

3181

# downtime.

2571

3183

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

2572

3184

if not client["last_checked_ok"]:

2573

3185

logger.warning(

2574

"disabling client {0} - Client never "

2575

"performed a successful checker"

2576

.format(client_name))

3186

"disabling client {} - Client never "

3187

"performed a successful checker".format(

3188

client_name))

2577

3189

client["enabled"] = False

2578

3190

elif client["last_checker_status"] != 0:

2579

3191

logger.warning(

2580

"disabling client {0} - Client "

2581

"last checker failed with error code {1}"

2582

.format(client_name,

2583

client["last_checker_status"]))

3192

"disabling client {} - Client last"

3193

" checker failed with error code"

3194

" {}".format(

3195

client_name,

3196

client["last_checker_status"]))

2584

3197

client["enabled"] = False

2585

3198

else:

2586

client["expires"] = (datetime.datetime

2587

.utcnow()

2588

+ client["timeout"])

3199

client["expires"] = (

3200

datetime.datetime.utcnow()

3201

+ client["timeout"])

2589

3202

logger.debug("Last checker succeeded,"

2590

" keeping {0} enabled"

2591

.format(client_name))

3203

" keeping {} enabled".format(

3204

client_name))

2592

3205

try:

2593

client["secret"] = (

2594

pgp.decrypt(client["encrypted_secret"],

2595

client_settings[client_name]

2596

["secret"]))

3206

client["secret"] = pgp.decrypt(

3207

client["encrypted_secret"],

3208

client_settings[client_name]["secret"])

2597

3209

except PGPError:

2598

3210

# 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

3211

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

3212

client_name))

3213

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

3214

["secret"])

3215

2604

3216

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

2605

3217

for client_name in (set(old_client_settings)

2606

3218

- set(client_settings)):

2608

3220

for client_name in (set(client_settings)

2609

3221

- set(old_client_settings)):

2610

3222

clients_data[client_name] = client_settings[client_name]

2611

3223

2612

3224

# Create all client objects

2613

for client_name, client in clients_data.iteritems():

3225

for client_name, client in clients_data.items():

2614

3226

tcp_server.clients[client_name] = client_class(

2615

name = client_name, settings = client)

2616

3227

name=client_name,

3228

settings=client,

3229

server_settings=server_settings)

3230

2617

3231

if not tcp_server.clients:

2618

3232

logger.warning("No clients defined")

2619

3233

2620

3234

if not foreground:

2621

3235

if pidfile is not None:

3236

pid = os.getpid()

2622

3237

try:

2623

3238

with pidfile:

2624

pid = os.getpid()

2625

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

3239

print(pid, file=pidfile)

2626

3240

except IOError:

2627

3241

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

2628

3242

pidfilename, pid)

2629

3243

del pidfile

2630

3244

del pidfilename

2631

2632

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

2633

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

2634

3245

3246

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

3247

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3248

lambda: main_loop.quit() and False)

3249

2635

3250

if use_dbus:

2636

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

2637

"se.bsnet.fukt.Mandos"})

2638

class MandosDBusService(DBusObjectWithProperties):

3251

3252

@alternate_dbus_interfaces(

3253

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

3254

class MandosDBusService(DBusObjectWithObjectManager):

2639

3255

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

3256

2640

3257

def __init__(self):

2641

3258

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

3259

2642

3260

_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

3261

2650

3262

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

2651

3263

def ClientAdded(self, objpath):

2652

3264

"D-Bus signal"

2653

3265

pass

2654

3266

2655

3267

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

2656

3268

def ClientNotFound(self, fingerprint, address):

2657

3269

"D-Bus signal"

2658

3270

pass

2659

3271

3272

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

3273

"true"})

2660

3274

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

2661

3275

def ClientRemoved(self, objpath, name):

2662

3276

"D-Bus signal"

2663

3277

pass

2664

3278

3279

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

3280

"true"})

2665

3281

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

2666

3282

def GetAllClients(self):

2667

3283

"D-Bus method"

2668

return dbus.Array(c.dbus_object_path

2669

for c in

2670

tcp_server.clients.itervalues())

2671

3284

return dbus.Array(c.dbus_object_path for c in

3285

tcp_server.clients.values())

3286

3287

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

3288

"true"})

2672

3289

@dbus.service.method(_interface,

2673

3290

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

2674

3291

def GetAllClientsWithProperties(self):

2675

3292

"D-Bus method"

2676

3293

return dbus.Dictionary(

2677

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

2678

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

3294

{c.dbus_object_path: c.GetAll(

3295

"se.recompile.Mandos.Client")

3296

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

2679

3297

signature="oa{sv}")

2680

3298

2681

3299

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

2682

3300

def RemoveClient(self, object_path):

2683

3301

"D-Bus method"

2684

for c in tcp_server.clients.itervalues():

3302

for c in tcp_server.clients.values():

2685

3303

if c.dbus_object_path == object_path:

2686

3304

del tcp_server.clients[c.name]

2687

3305

c.remove_from_connection()

2688

# Don't signal anything except ClientRemoved

3306

# Don't signal the disabling

2689

3307

c.disable(quiet=True)

2690

# Emit D-Bus signal

2691

self.ClientRemoved(object_path, c.name)

3308

# Emit D-Bus signal for removal

3309

self.client_removed_signal(c)

2692

3310

return

2693

3311

raise KeyError(object_path)

2694

3312

2695

3313

del _interface

2696

3314

3315

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3316

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

3317

def GetManagedObjects(self):

3318

"""D-Bus method"""

3319

return dbus.Dictionary(

3320

{client.dbus_object_path:

3321

dbus.Dictionary(

3322

{interface: client.GetAll(interface)

3323

for interface in

3324

client._get_all_interface_names()})

3325

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

3326

3327

def client_added_signal(self, client):

3328

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

3329

if use_dbus:

3330

# New standard signal

3331

self.InterfacesAdded(

3332

client.dbus_object_path,

3333

dbus.Dictionary(

3334

{interface: client.GetAll(interface)

3335

for interface in

3336

client._get_all_interface_names()}))

3337

# Old signal

3338

self.ClientAdded(client.dbus_object_path)

3339

3340

def client_removed_signal(self, client):

3341

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

3342

if use_dbus:

3343

# New standard signal

3344

self.InterfacesRemoved(

3345

client.dbus_object_path,

3346

client._get_all_interface_names())

3347

# Old signal

3348

self.ClientRemoved(client.dbus_object_path,

3349

client.name)

3350

2697

3351

mandos_dbus_service = MandosDBusService()

2698

3352

3353

# Save modules to variables to exempt the modules from being

3354

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

3355

mp = multiprocessing

3356

wn = wnull

3357

2699

3358

def cleanup():

2700

3359

"Cleanup function; run on exit"

2701

service.cleanup()

2702

2703

multiprocessing.active_children()

3360

if zeroconf:

3361

service.cleanup()

3362

3363

mp.active_children()

3364

wn.close()

2704

3365

if not (tcp_server.clients or client_settings):

2705

3366

return

2706

3367

2707

3368

# Store client before exiting. Secrets are encrypted with key

2708

3369

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

2709

3370

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

2710

3371

clients = {}

2711

3372

with PGPEngine() as pgp:

2712

for client in tcp_server.clients.itervalues():

3373

for client in tcp_server.clients.values():

2713

3374

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

2714

3375

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

2715

3376

key)

2716

3377

client_dict = {}

2717

3378

2718

3379

# A list of attributes that can not be pickled

2719

3380

# + secret.

2720

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

2721

"checker"))

2722

for name, typ in (inspect.getmembers

2723

(dbus.service.Object)):

3381

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

3382

"checker", "server_settings"}

3383

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

3384

.Object):

2724

3385

exclude.add(name)

2725

3386

2726

3387

client_dict["encrypted_secret"] = (client

2727

3388

.encrypted_secret)

2728

3389

for attr in client.client_structure:

2729

3390

if attr not in exclude:

2730

3391

client_dict[attr] = getattr(client, attr)

2731

3392

2732

3393

clients[client.name] = client_dict

2733

3394

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

2734

3395

2735

3396

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

3397

with tempfile.NamedTemporaryFile(

3398

mode='wb',

3399

suffix=".pickle",

3400

prefix='clients-',

3401

dir=os.path.dirname(stored_state_path),

3402

delete=False) as stored_state:

3403

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

3404

protocol=2)

3405

tempname = stored_state.name

2742

3406

os.rename(tempname, stored_state_path)

2743

3407

except (IOError, OSError) as e:

2744

3408

if not debug:

2747

3411

except NameError:

2748

3412

pass

2749

3413

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

2750

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

3414

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

2751

3415

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

2752

3416

else:

2753

3417

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

2754

3418

exc_info=e)

2755

raise e

2756

3419

raise

3420

2757

3421

# Delete all clients, and settings from config

2758

3422

while tcp_server.clients:

2759

3423

name, client = tcp_server.clients.popitem()

2760

3424

if use_dbus:

2761

3425

client.remove_from_connection()

2762

# Don't signal anything except ClientRemoved

3426

# Don't signal the disabling

2763

3427

client.disable(quiet=True)

3428

# Emit D-Bus signal for removal

2764

3429

if use_dbus:

2765

# Emit D-Bus signal

2766

mandos_dbus_service.ClientRemoved(client

2767

.dbus_object_path,

2768

client.name)

3430

mandos_dbus_service.client_removed_signal(client)

2769

3431

client_settings.clear()

2770

3432

2771

3433

atexit.register(cleanup)

2772

2773

for client in tcp_server.clients.itervalues():

3434

3435

for client in tcp_server.clients.values():

2774

3436

if use_dbus:

2775

# Emit D-Bus signal

2776

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3437

# Emit D-Bus signal for adding

3438

mandos_dbus_service.client_added_signal(client)

2777

3439

# Need to initiate checking of clients

2778

3440

if client.enabled:

2779

3441

client.init_checker()

2780

3442

2781

3443

tcp_server.enable()

2782

3444

tcp_server.server_activate()

2783

3445

2784

3446

# Find out what port we got

2785

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

3447

if zeroconf:

3448

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

2786

3449

if use_ipv6:

2787

3450

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

2788

3451

" flowinfo %d, scope_id %d",

2790

3453

else: # IPv4

2791

3454

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

2792

3455

*tcp_server.socket.getsockname())

2793

2794

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

2795

3456

3457

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

3458

2796

3459

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

3460

if zeroconf:

3461

# From the Avahi example code

3462

try:

3463

service.activate()

3464

except dbus.exceptions.DBusException as error:

3465

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

3466

cleanup()

3467

sys.exit(1)

3468

# End of Avahi example code

3469

3470

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

3471

lambda *args, **kwargs:

3472

(tcp_server.handle_request

3473

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

3474

2811

3475

logger.debug("Starting main loop")

2812

3476

main_loop.run()

2813

3477

except AvahiError as error:

2822

3486

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

2823

3487

cleanup()

2824

3488

3489

2825

3490

if __name__ == '__main__':

2826

3491

main()