/mandos/trunk : revision 1091

1

#!/usr/bin/python

2

# -*- mode: python; coding: utf-8 -*-

3

#

3

#

4

# Mandos server - give out binary blobs to connecting clients.

5

#

5

#

6

# This program is partly derived from an example program for an Avahi

7

# service publisher, downloaded from

8

# <http://avahi.org/wiki/PythonPublishExample>. This includes the

9

# methods "add", "remove", "server_state_changed",

10

# "entry_group_state_changed", "cleanup", and "activate" in the

11

# "AvahiService" class, and some lines in "main".

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This program is free software: you can redistribute it and/or modify

18

# it under the terms of the GNU General Public License as published by

14

15

16

#

17

# This file is part of Mandos.

18

#

19

# Mandos is free software: you can redistribute it and/or modify it

20

# under the terms of the GNU General Public License as published by

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

72

80

73

81

import dbus

74

82

import dbus.service

75

import gobject

76

import avahi

83

from gi.repository import GLib

77

84

from dbus.mainloop.glib import DBusGMainLoop

78

85

import ctypes

79

86

import ctypes.util

80

87

import xml.dom.minidom

81

88

import inspect

82

89

90

# Try to find the value of SO_BINDTODEVICE:

83

91

try:

92

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

93

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

84

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

95

except AttributeError:

86

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

87

99

from IN import SO_BINDTODEVICE

88

100

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.4"

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.8.3"

92

119

stored_state_file = "clients.pickle"

93

120

94

121

logger = logging.getLogger()

95

122

syslogger = None

96

123

97

124

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

101

127

except (OSError, AttributeError):

128

102

129

def if_nametoindex(interface):

103

130

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

104

131

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

105

132

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

106

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

134

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

135

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

111

136

return interface_index

112

137

113

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

114

155

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

115

156

"""init logger and add loglevel"""

116

117

syslogger = (logging.handlers.SysLogHandler

118

(facility =

119

logging.handlers.SysLogHandler.LOG_DAEMON,

120

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

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

121

162

syslogger.setFormatter(logging.Formatter

122

163

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

123

164

' %(message)s'))

124

165

logger.addHandler(syslogger)

125

166

126

167

if debug:

127

168

console = logging.StreamHandler()

128

169

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

140

181

141

182

class PGPEngine(object):

142

183

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

184

143

185

def __init__(self):

144

186

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

145

198

self.gnupgargs = ['--batch',

146

'--home', self.tempdir,

199

'--homedir', self.tempdir,

147

200

'--force-mdc',

148

'--quiet',

149

'--no-use-agent']

150

201

'--quiet']

202

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

203

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

204

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

205

151

206

def __enter__(self):

152

207

return self

153

208

154

209

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

155

210

self._cleanup()

156

211

return False

157

212

158

213

def __del__(self):

159

214

self._cleanup()

160

215

161

216

def _cleanup(self):

162

217

if self.tempdir is not None:

163

218

# Delete contents of tempdir

164

219

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

165

topdown = False):

220

topdown=False):

166

221

for filename in files:

167

222

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

168

223

for dirname in dirs:

170

225

# Remove tempdir

171

226

os.rmdir(self.tempdir)

172

227

self.tempdir = None

173

228

174

229

def password_encode(self, password):

175

230

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

176

231

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

181

236

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

182

237

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

183

238

return encoded

184

239

185

240

def encrypt(self, data, password):

186

241

passphrase = self.password_encode(password)

187

with tempfile.NamedTemporaryFile(dir=self.tempdir

188

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

189

244

passfile.write(passphrase)

190

245

passfile.flush()

191

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

246

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

192

247

'--passphrase-file',

193

248

passfile.name]

194

249

+ self.gnupgargs,

195

stdin = subprocess.PIPE,

196

stdout = subprocess.PIPE,

197

stderr = subprocess.PIPE)

198

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

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

199

254

if proc.returncode != 0:

200

255

raise PGPError(err)

201

256

return ciphertext

202

257

203

258

def decrypt(self, data, password):

204

259

passphrase = self.password_encode(password)

205

with tempfile.NamedTemporaryFile(dir = self.tempdir

206

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

207

262

passfile.write(passphrase)

208

263

passfile.flush()

209

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

264

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

210

265

'--passphrase-file',

211

266

passfile.name]

212

267

+ self.gnupgargs,

213

stdin = subprocess.PIPE,

214

stdout = subprocess.PIPE,

215

stderr = subprocess.PIPE)

216

decrypted_plaintext, err = proc.communicate(input

217

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

218

272

if proc.returncode != 0:

219

273

raise PGPError(err)

220

274

return decrypted_plaintext

221

275

222

276

277

# Pretend that we have an Avahi module

278

class avahi(object):

279

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

280

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

@staticmethod

290

def string_array_to_txt_array(t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

302

223

303

class AvahiError(Exception):

224

304

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

225

305

self.value = value

226

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

227

def __unicode__(self):

228

return unicode(repr(self.value))

306

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

307

**kwargs)

308

229

309

230

310

class AvahiServiceError(AvahiError):

231

311

pass

232

312

313

233

314

class AvahiGroupError(AvahiError):

234

315

pass

235

316

236

317

237

318

class AvahiService(object):

238

319

"""An Avahi (Zeroconf) service.

239

320

240

321

Attributes:

241

322

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

242

323

Used to optionally bind to the specified interface.

254

335

server: D-Bus Server

255

336

bus: dbus.SystemBus()

256

337

"""

257

258

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

259

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

260

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

261

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

262

350

self.interface = interface

263

351

self.name = name

264

352

self.type = servicetype

273

361

self.server = None

274

362

self.bus = bus

275

363

self.entry_group_state_changed_match = None

276

277

def rename(self):

364

365

def rename(self, remove=True):

278

366

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

279

367

if self.rename_count >= self.max_renames:

280

368

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

281

369

" after %i retries, exiting.",

282

370

self.rename_count)

283

371

raise AvahiServiceError("Too many renames")

284

self.name = unicode(self.server

285

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

286

375

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

287

376

self.name)

288

self.remove()

377

if remove:

378

self.remove()

289

379

try:

290

380

self.add()

291

381

except dbus.exceptions.DBusException as error:

292

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

293

self.cleanup()

294

os._exit(1)

295

self.rename_count += 1

296

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

297

391

def remove(self):

298

392

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

299

393

if self.entry_group_state_changed_match is not None:

301

395

self.entry_group_state_changed_match = None

302

396

if self.group is not None:

303

397

self.group.Reset()

304

398

305

399

def add(self):

306

400

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

307

401

self.remove()

324

418

dbus.UInt16(self.port),

325

419

avahi.string_array_to_txt_array(self.TXT))

326

420

self.group.Commit()

327

421

328

422

def entry_group_state_changed(self, state, error):

329

423

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

330

424

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

331

425

332

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

333

427

logger.debug("Zeroconf service established.")

334

428

elif state == avahi.ENTRY_GROUP_COLLISION:

336

430

self.rename()

337

431

elif state == avahi.ENTRY_GROUP_FAILURE:

338

432

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

339

unicode(error))

340

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

341

.format(error))

342

433

str(error))

434

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

435

343

436

def cleanup(self):

344

437

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

345

438

if self.group is not None:

350

443

pass

351

444

self.group = None

352

445

self.remove()

353

446

354

447

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

355

448

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

356

449

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

357

bad_states = { avahi.SERVER_INVALID:

358

"Zeroconf server invalid",

359

avahi.SERVER_REGISTERING: None,

360

avahi.SERVER_COLLISION:

361

"Zeroconf server name collision",

362

avahi.SERVER_FAILURE:

363

"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

}

364

456

if state in bad_states:

365

457

if bad_states[state] is not None:

366

458

if error is None:

369

461

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

370

462

self.cleanup()

371

463

elif state == avahi.SERVER_RUNNING:

372

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)

373

476

else:

374

477

if error is None:

375

478

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

376

479

else:

377

480

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

378

481

379

482

def activate(self):

380

483

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

381

484

if self.server is None:

385

488

follow_name_owner_changes=True),

386

489

avahi.DBUS_INTERFACE_SERVER)

387

490

self.server.connect_to_signal("StateChanged",

388

self.server_state_changed)

491

self.server_state_changed)

389

492

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

390

493

391

494

392

495

class AvahiServiceToSyslog(AvahiService):

393

def rename(self):

496

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

394

497

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

395

ret = AvahiService.rename(self)

396

syslogger.setFormatter(logging.Formatter

397

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

398

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

399

.format(self.name)))

498

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

499

syslogger.setFormatter(logging.Formatter(

500

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

501

.format(self.name)))

400

502

return ret

401

503

402

504

403

def timedelta_to_milliseconds(td):

404

"Convert a datetime.timedelta() to milliseconds"

405

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

406

+ (td.seconds * 1000)

407

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

509

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

510

if library is None:

511

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

512

_library = ctypes.cdll.LoadLibrary(library)

513

del library

514

515

# Unless otherwise indicated, the constants and types below are

516

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

517

518

# Constants

519

E_SUCCESS = 0

520

E_INTERRUPTED = -52

521

E_AGAIN = -28

522

CRT_OPENPGP = 2

523

CRT_RAWPK = 3

524

CLIENT = 2

525

SHUT_RDWR = 0

526

CRD_CERTIFICATE = 1

527

E_NO_CERTIFICATE_FOUND = -49

528

X509_FMT_DER = 0

529

NO_TICKETS = 1<<10

530

ENABLE_RAWPK = 1<<18

531

CTYPE_PEERS = 3

532

KEYID_USE_SHA256 = 1 # gnutls/x509.h

533

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

534

535

# Types

536

class session_int(ctypes.Structure):

537

_fields_ = []

538

session_t = ctypes.POINTER(session_int)

539

540

class certificate_credentials_st(ctypes.Structure):

541

_fields_ = []

542

certificate_credentials_t = ctypes.POINTER(

543

certificate_credentials_st)

544

certificate_type_t = ctypes.c_int

545

546

class datum_t(ctypes.Structure):

547

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

548

('size', ctypes.c_uint)]

549

550

class openpgp_crt_int(ctypes.Structure):

551

_fields_ = []

552

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

553

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

554

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

555

credentials_type_t = ctypes.c_int

556

transport_ptr_t = ctypes.c_void_p

557

close_request_t = ctypes.c_int

558

559

# Exceptions

560

class Error(Exception):

561

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

562

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

563

# code is passed, convert it to a string with

564

# gnutls.strerror()

565

self.code = code

566

if message is None and code is not None:

567

message = gnutls.strerror(code)

568

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

569

message, *args)

570

571

class CertificateSecurityError(Error):

572

pass

573

574

# Classes

575

class Credentials(object):

576

def __init__(self):

577

self._c_object = gnutls.certificate_credentials_t()

578

gnutls.certificate_allocate_credentials(

579

ctypes.byref(self._c_object))

580

self.type = gnutls.CRD_CERTIFICATE

581

582

def __del__(self):

583

gnutls.certificate_free_credentials(self._c_object)

584

585

class ClientSession(object):

586

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

587

self._c_object = gnutls.session_t()

588

gnutls_flags = gnutls.CLIENT

589

if gnutls.check_version("3.5.6"):

590

gnutls_flags |= gnutls.NO_TICKETS

591

if gnutls.has_rawpk:

592

gnutls_flags |= gnutls.ENABLE_RAWPK

593

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

594

del gnutls_flags

595

gnutls.set_default_priority(self._c_object)

596

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

597

gnutls.handshake_set_private_extensions(self._c_object,

598

True)

599

self.socket = socket

600

if credentials is None:

601

credentials = gnutls.Credentials()

602

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

603

ctypes.cast(credentials._c_object,

604

ctypes.c_void_p))

605

self.credentials = credentials

606

607

def __del__(self):

608

gnutls.deinit(self._c_object)

609

610

def handshake(self):

611

return gnutls.handshake(self._c_object)

612

613

def send(self, data):

614

data = bytes(data)

615

data_len = len(data)

616

while data_len > 0:

617

data_len -= gnutls.record_send(self._c_object,

618

data[-data_len:],

619

data_len)

620

621

def bye(self):

622

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

623

624

# Error handling functions

625

def _error_code(result):

626

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

627

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

628

if result >= 0:

629

return result

630

if result == gnutls.E_NO_CERTIFICATE_FOUND:

631

raise gnutls.CertificateSecurityError(code=result)

632

raise gnutls.Error(code=result)

633

634

def _retry_on_error(result, func, arguments):

635

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

636

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

637

while result < 0:

638

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

639

return _error_code(result)

640

result = func(*arguments)

641

return result

642

643

# Unless otherwise indicated, the function declarations below are

644

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

645

646

# Functions

647

priority_set_direct = _library.gnutls_priority_set_direct

648

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

649

ctypes.POINTER(ctypes.c_char_p)]

650

priority_set_direct.restype = _error_code

651

652

init = _library.gnutls_init

653

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

654

init.restype = _error_code

655

656

set_default_priority = _library.gnutls_set_default_priority

657

set_default_priority.argtypes = [session_t]

658

set_default_priority.restype = _error_code

659

660

record_send = _library.gnutls_record_send

661

record_send.argtypes = [session_t, ctypes.c_void_p,

662

ctypes.c_size_t]

663

record_send.restype = ctypes.c_ssize_t

664

record_send.errcheck = _retry_on_error

665

666

certificate_allocate_credentials = (

667

_library.gnutls_certificate_allocate_credentials)

668

certificate_allocate_credentials.argtypes = [

669

ctypes.POINTER(certificate_credentials_t)]

670

certificate_allocate_credentials.restype = _error_code

671

672

certificate_free_credentials = (

673

_library.gnutls_certificate_free_credentials)

674

certificate_free_credentials.argtypes = [

675

certificate_credentials_t]

676

certificate_free_credentials.restype = None

677

678

handshake_set_private_extensions = (

679

_library.gnutls_handshake_set_private_extensions)

680

handshake_set_private_extensions.argtypes = [session_t,

681

ctypes.c_int]

682

handshake_set_private_extensions.restype = None

683

684

credentials_set = _library.gnutls_credentials_set

685

credentials_set.argtypes = [session_t, credentials_type_t,

686

ctypes.c_void_p]

687

credentials_set.restype = _error_code

688

689

strerror = _library.gnutls_strerror

690

strerror.argtypes = [ctypes.c_int]

691

strerror.restype = ctypes.c_char_p

692

693

certificate_type_get = _library.gnutls_certificate_type_get

694

certificate_type_get.argtypes = [session_t]

695

certificate_type_get.restype = _error_code

696

697

certificate_get_peers = _library.gnutls_certificate_get_peers

698

certificate_get_peers.argtypes = [session_t,

699

ctypes.POINTER(ctypes.c_uint)]

700

certificate_get_peers.restype = ctypes.POINTER(datum_t)

701

702

global_set_log_level = _library.gnutls_global_set_log_level

703

global_set_log_level.argtypes = [ctypes.c_int]

704

global_set_log_level.restype = None

705

706

global_set_log_function = _library.gnutls_global_set_log_function

707

global_set_log_function.argtypes = [log_func]

708

global_set_log_function.restype = None

709

710

deinit = _library.gnutls_deinit

711

deinit.argtypes = [session_t]

712

deinit.restype = None

713

714

handshake = _library.gnutls_handshake

715

handshake.argtypes = [session_t]

716

handshake.restype = _error_code

717

handshake.errcheck = _retry_on_error

718

719

transport_set_ptr = _library.gnutls_transport_set_ptr

720

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

721

transport_set_ptr.restype = None

722

723

bye = _library.gnutls_bye

724

bye.argtypes = [session_t, close_request_t]

725

bye.restype = _error_code

726

bye.errcheck = _retry_on_error

727

728

check_version = _library.gnutls_check_version

729

check_version.argtypes = [ctypes.c_char_p]

730

check_version.restype = ctypes.c_char_p

731

732

_need_version = b"3.3.0"

733

if check_version(_need_version) is None:

734

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

735

.format(_need_version))

736

737

_tls_rawpk_version = b"3.6.6"

738

has_rawpk = bool(check_version(_tls_rawpk_version))

739

740

if has_rawpk:

741

# Types

742

class pubkey_st(ctypes.Structure):

743

_fields = []

744

pubkey_t = ctypes.POINTER(pubkey_st)

745

746

x509_crt_fmt_t = ctypes.c_int

747

748

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

749

pubkey_init = _library.gnutls_pubkey_init

750

pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]

751

pubkey_init.restype = _error_code

752

753

pubkey_import = _library.gnutls_pubkey_import

754

pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),

755

x509_crt_fmt_t]

756

pubkey_import.restype = _error_code

757

758

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

759

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

760

ctypes.POINTER(ctypes.c_ubyte),

761

ctypes.POINTER(ctypes.c_size_t)]

762

pubkey_get_key_id.restype = _error_code

763

764

pubkey_deinit = _library.gnutls_pubkey_deinit

765

pubkey_deinit.argtypes = [pubkey_t]

766

pubkey_deinit.restype = None

767

else:

768

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

769

770

openpgp_crt_init = _library.gnutls_openpgp_crt_init

771

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

772

openpgp_crt_init.restype = _error_code

773

774

openpgp_crt_import = _library.gnutls_openpgp_crt_import

775

openpgp_crt_import.argtypes = [openpgp_crt_t,

776

ctypes.POINTER(datum_t),

777

openpgp_crt_fmt_t]

778

openpgp_crt_import.restype = _error_code

779

780

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

781

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

782

ctypes.POINTER(ctypes.c_uint)]

783

openpgp_crt_verify_self.restype = _error_code

784

785

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

786

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

787

openpgp_crt_deinit.restype = None

788

789

openpgp_crt_get_fingerprint = (

790

_library.gnutls_openpgp_crt_get_fingerprint)

791

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

792

ctypes.c_void_p,

793

ctypes.POINTER(

794

ctypes.c_size_t)]

795

openpgp_crt_get_fingerprint.restype = _error_code

796

797

if check_version("3.6.4"):

798

certificate_type_get2 = _library.gnutls_certificate_type_get2

799

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

800

certificate_type_get2.restype = _error_code

801

802

# Remove non-public functions

803

del _error_code, _retry_on_error

804

805

806

def call_pipe(connection, # : multiprocessing.Connection

807

func, *args, **kwargs):

808

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

809

810

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

811

return value on the provided multiprocessing.Connection.

812

"""

813

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

814

connection.close()

408

815

409

816

410

817

class Client(object):

411

818

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

412

819

413

820

Attributes:

414

821

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

415

822

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

417

824

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

418

825

to see if the client lives.

419

826

'None' if no process is running.

420

checker_callback_tag: a gobject event source tag, or None

827

checker_callback_tag: a GLib event source tag, or None

421

828

checker_command: string; External command which is run to check

422

829

if client lives. %() expansions are done at

423

830

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

424

831

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

425

checker_initiator_tag: a gobject event source tag, or None

832

checker_initiator_tag: a GLib event source tag, or None

426

833

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

427

834

client_structure: Object describing what attributes a client has

428

835

and is used for storing the client at exit

429

836

current_checker_command: string; current running checker_command

430

disable_initiator_tag: a gobject event source tag, or None

837

disable_initiator_tag: a GLib event source tag, or None

431

838

enabled: bool()

432

839

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

433

uniquely identify the client

840

uniquely identify an OpenPGP client

841

key_id: string (64 hexadecimal digits); used to uniquely identify

842

a client using raw public keys

434

843

host: string; available for use by the checker command

435

844

interval: datetime.timedelta(); How often to start a new checker

436

845

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

438

847

last_checker_status: integer between 0 and 255 reflecting exit

439

848

status of last checker. -1 reflects crashed

440

849

checker, -2 means no checker completed yet.

850

last_checker_signal: The signal which killed the last checker, if

851

last_checker_status is -1

441

852

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

442

853

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

443

854

D-Bus identifiers

450

861

disabled, or None

451

862

server_settings: The server_settings dict from main()

452

863

"""

453

864

454

865

runtime_expansions = ("approval_delay", "approval_duration",

455

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

866

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

456

867

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

457

868

"last_approval_request", "last_checked_ok",

458

869

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

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

462

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

463

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

466

"approved_by_default": "True",

467

"enabled": "True",

468

}

469

470

def timeout_milliseconds(self):

471

"Return the 'timeout' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.timeout)

473

474

def extended_timeout_milliseconds(self):

475

"Return the 'extended_timeout' attribute in milliseconds"

476

return timedelta_to_milliseconds(self.extended_timeout)

477

478

def interval_milliseconds(self):

479

"Return the 'interval' attribute in milliseconds"

480

return timedelta_to_milliseconds(self.interval)

481

482

def approval_delay_milliseconds(self):

483

return timedelta_to_milliseconds(self.approval_delay)

484

870

client_defaults = {

871

"timeout": "PT5M",

872

"extended_timeout": "PT15M",

873

"interval": "PT2M",

874

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

875

"host": "",

876

"approval_delay": "PT0S",

877

"approval_duration": "PT1S",

878

"approved_by_default": "True",

879

"enabled": "True",

880

}

881

485

882

@staticmethod

486

883

def config_parser(config):

487

884

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

494

891

for client_name in config.sections():

495

892

section = dict(config.items(client_name))

496

893

client = settings[client_name] = {}

497

894

498

895

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

499

896

# Reformat values from string types to Python types

500

897

client["approved_by_default"] = config.getboolean(

501

898

client_name, "approved_by_default")

502

899

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

503

900

"enabled")

504

901

902

# Uppercase and remove spaces from key_id and fingerprint

903

# for later comparison purposes with return value from the

904

# key_id() and fingerprint() functions

905

client["key_id"] = (section.get("key_id", "").upper()

906

.replace(" ", ""))

505

907

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

506

908

.replace(" ", ""))

507

909

if "secret" in section:

508

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

910

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

911

.encode("utf-8"),

912

"base64")

509

913

elif "secfile" in section:

510

914

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

511

915

(section["secfile"])),

512

916

"rb") as secfile:

513

917

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

514

918

else:

515

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

919

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

516

920

.format(section))

517

921

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

518

922

client["extended_timeout"] = string_to_delta(

526

930

client["last_approval_request"] = None

527

931

client["last_checked_ok"] = None

528

932

client["last_checker_status"] = -2

529

933

530

934

return settings

531

532

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

935

936

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

533

937

self.name = name

534

938

if server_settings is None:

535

939

server_settings = {}

536

940

self.server_settings = server_settings

537

941

# adding all client settings

538

for setting, value in settings.iteritems():

942

for setting, value in settings.items():

539

943

setattr(self, setting, value)

540

944

541

945

if self.enabled:

542

946

if not hasattr(self, "last_enabled"):

543

947

self.last_enabled = datetime.datetime.utcnow()

547

951

else:

548

952

self.last_enabled = None

549

953

self.expires = None

550

954

551

955

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

552

# Uppercase and remove spaces from fingerprint for later

553

# comparison purposes with return value from the fingerprint()

554

# function

956

logger.debug(" Key ID: %s", self.key_id)

555

957

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

556

958

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

557

959

datetime.datetime.utcnow())

558

960

559

961

# attributes specific for this server instance

560

962

self.checker = None

561

963

self.checker_initiator_tag = None

564

966

self.current_checker_command = None

565

967

self.approved = None

566

968

self.approvals_pending = 0

567

self.changedstate = (multiprocessing_manager

568

.Condition(multiprocessing_manager

569

.Lock()))

570

self.client_structure = [attr for attr in

571

self.__dict__.iterkeys()

969

self.changedstate = multiprocessing_manager.Condition(

970

multiprocessing_manager.Lock())

971

self.client_structure = [attr

972

for attr in self.__dict__.keys()

572

973

if not attr.startswith("_")]

573

974

self.client_structure.append("client_structure")

574

575

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

576

lambda obj:

577

isinstance(obj,

578

property)):

975

976

for name, t in inspect.getmembers(

977

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

579

978

if not name.startswith("_"):

580

979

self.client_structure.append(name)

581

980

582

981

# Send notice to process children that client state has changed

583

982

def send_changedstate(self):

584

983

with self.changedstate:

585

984

self.changedstate.notify_all()

586

985

587

986

def enable(self):

588

987

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

589

988

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

594

993

self.last_enabled = datetime.datetime.utcnow()

595

994

self.init_checker()

596

995

self.send_changedstate()

597

996

598

997

def disable(self, quiet=True):

599

998

"""Disable this client."""

600

999

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

602

1001

if not quiet:

603

1002

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

604

1003

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

605

gobject.source_remove(self.disable_initiator_tag)

1004

GLib.source_remove(self.disable_initiator_tag)

606

1005

self.disable_initiator_tag = None

607

1006

self.expires = None

608

1007

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

609

gobject.source_remove(self.checker_initiator_tag)

1008

GLib.source_remove(self.checker_initiator_tag)

610

1009

self.checker_initiator_tag = None

611

1010

self.stop_checker()

612

1011

self.enabled = False

613

1012

if not quiet:

614

1013

self.send_changedstate()

615

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

1014

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

616

1015

return False

617

1016

618

1017

def __del__(self):

619

1018

self.disable()

620

1019

621

1020

def init_checker(self):

622

1021

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

623

1022

# and every interval from then on.

624

1023

if self.checker_initiator_tag is not None:

625

gobject.source_remove(self.checker_initiator_tag)

626

self.checker_initiator_tag = (gobject.timeout_add

627

(self.interval_milliseconds(),

628

self.start_checker))

1024

GLib.source_remove(self.checker_initiator_tag)

1025

self.checker_initiator_tag = GLib.timeout_add(

1026

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

1027

self.start_checker)

629

1028

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

630

1029

if self.disable_initiator_tag is not None:

631

gobject.source_remove(self.disable_initiator_tag)

632

self.disable_initiator_tag = (gobject.timeout_add

633

(self.timeout_milliseconds(),

634

self.disable))

1030

GLib.source_remove(self.disable_initiator_tag)

1031

self.disable_initiator_tag = GLib.timeout_add(

1032

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

635

1033

# Also start a new checker *right now*.

636

1034

self.start_checker()

637

638

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

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

639

1038

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

640

1039

self.checker_callback_tag = None

641

1040

self.checker = None

642

if os.WIFEXITED(condition):

643

self.last_checker_status = os.WEXITSTATUS(condition)

1041

# Read return code from connection (see call_pipe)

1042

returncode = connection.recv()

1043

connection.close()

1044

1045

if returncode >= 0:

1046

self.last_checker_status = returncode

1047

self.last_checker_signal = None

644

1048

if self.last_checker_status == 0:

645

1049

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

646

1050

vars(self))

647

1051

self.checked_ok()

648

1052

else:

649

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

650

vars(self))

1053

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

651

1054

else:

652

1055

self.last_checker_status = -1

1056

self.last_checker_signal = -returncode

653

1057

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

654

1058

vars(self))

655

1059

return False

1060

656

1061

def checked_ok(self):

657

1062

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

658

1063

self.last_checked_ok = datetime.datetime.utcnow()

659

1064

self.last_checker_status = 0

1065

self.last_checker_signal = None

660

1066

self.bump_timeout()

661

1067

662

1068

def bump_timeout(self, timeout=None):

663

1069

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

664

1070

if timeout is None:

665

1071

timeout = self.timeout

666

1072

if self.disable_initiator_tag is not None:

667

gobject.source_remove(self.disable_initiator_tag)

1073

GLib.source_remove(self.disable_initiator_tag)

668

1074

self.disable_initiator_tag = None

669

1075

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

670

self.disable_initiator_tag = (gobject.timeout_add

671

(timedelta_to_milliseconds

672

(timeout), self.disable))

1076

self.disable_initiator_tag = GLib.timeout_add(

1077

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

673

1078

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

674

1079

675

1080

def need_approval(self):

676

1081

self.last_approval_request = datetime.datetime.utcnow()

677

1082

678

1083

def start_checker(self):

679

1084

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

680

1085

681

1086

If a checker already exists, leave it running and do

682

1087

nothing."""

683

1088

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

688

1093

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

689

1094

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

690

1095

# should be.

691

692

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

693

try:

694

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

695

except AttributeError:

696

pass

697

except OSError as error:

698

if error.errno != errno.ECHILD:

699

raise

700

else:

701

if pid:

702

logger.warning("Checker was a zombie")

703

gobject.source_remove(self.checker_callback_tag)

704

self.checker_callback(pid, status,

705

self.current_checker_command)

1096

1097

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

1098

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

1099

self.checker.join()

1100

self.checker = None

706

1101

# Start a new checker if needed

707

1102

if self.checker is None:

708

1103

# Escape attributes for the shell

709

escaped_attrs = dict(

710

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

711

for attr in

712

self.runtime_expansions)

1104

escaped_attrs = {

1105

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

1106

for attr in self.runtime_expansions}

713

1107

try:

714

1108

command = self.checker_command % escaped_attrs

715

1109

except TypeError as error:

716

1110

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

717

self.checker_command, exc_info=error)

718

return True # Try again later

1111

self.checker_command,

1112

exc_info=error)

1113

return True # Try again later

719

1114

self.current_checker_command = command

720

try:

721

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

722

command, self.name)

723

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

724

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

725

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

726

# always replaced by /dev/null.)

727

# The exception is when not debugging but nevertheless

728

# running in the foreground; use the previously

729

# created wnull.

730

popen_args = {}

731

if (not self.server_settings["debug"]

732

and self.server_settings["foreground"]):

733

popen_args.update({"stdout": wnull,

734

"stderr": wnull })

735

self.checker = subprocess.Popen(command,

736

close_fds=True,

737

shell=True, cwd="/",

738

**popen_args)

739

except OSError as error:

740

logger.error("Failed to start subprocess",

741

exc_info=error)

742

return True

743

self.checker_callback_tag = (gobject.child_watch_add

744

(self.checker.pid,

745

self.checker_callback,

746

data=command))

747

# The checker may have completed before the gobject

748

# watch was added. Check for this.

749

try:

750

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

751

except OSError as error:

752

if error.errno == errno.ECHILD:

753

# This should never happen

754

logger.error("Child process vanished",

755

exc_info=error)

756

return True

757

raise

758

if pid:

759

gobject.source_remove(self.checker_callback_tag)

760

self.checker_callback(pid, status, command)

761

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

1115

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

1116

self.name)

1117

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

1118

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

1119

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

1120

# always replaced by /dev/null.)

1121

# The exception is when not debugging but nevertheless

1122

# running in the foreground; use the previously

1123

# created wnull.

1124

popen_args = {"close_fds": True,

1125

"shell": True,

1126

"cwd": "/"}

1127

if (not self.server_settings["debug"]

1128

and self.server_settings["foreground"]):

1129

popen_args.update({"stdout": wnull,

1130

"stderr": wnull})

1131

pipe = multiprocessing.Pipe(duplex=False)

1132

self.checker = multiprocessing.Process(

1133

target=call_pipe,

1134

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

1135

kwargs=popen_args)

1136

self.checker.start()

1137

self.checker_callback_tag = GLib.io_add_watch(

1138

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

1139

self.checker_callback, pipe[0], command)

1140

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

762

1141

return True

763

1142

764

1143

def stop_checker(self):

765

1144

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

766

1145

if self.checker_callback_tag:

767

gobject.source_remove(self.checker_callback_tag)

1146

GLib.source_remove(self.checker_callback_tag)

768

1147

self.checker_callback_tag = None

769

1148

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

770

1149

return

771

1150

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

772

try:

773

self.checker.terminate()

774

#time.sleep(0.5)

775

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

776

# self.checker.kill()

777

except OSError as error:

778

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

779

raise

1151

self.checker.terminate()

780

1152

self.checker = None

781

1153

782

1154

783

def dbus_service_property(dbus_interface, signature="v",

784

access="readwrite", byte_arrays=False):

1155

def dbus_service_property(dbus_interface,

1156

signature="v",

1157

access="readwrite",

1158

byte_arrays=False):

785

1159

"""Decorators for marking methods of a DBusObjectWithProperties to

786

1160

become properties on the D-Bus.

787

1161

788

1162

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

789

1163

and with one argument by "Set".

790

1164

791

1165

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

792

1166

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

793

1167

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

796

1170

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

797

1171

if byte_arrays and signature != "ay":

798

1172

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

799

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

1173

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

1174

800

1175

def decorator(func):

801

1176

func._dbus_is_property = True

802

1177

func._dbus_interface = dbus_interface

805

1180

func._dbus_name = func.__name__

806

1181

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

807

1182

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

808

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1183

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

809

1184

return func

1185

810

1186

return decorator

811

1187

812

1188

813

1189

def dbus_interface_annotations(dbus_interface):

814

1190

"""Decorator for marking functions returning interface annotations

815

1191

816

1192

Usage:

817

1193

818

1194

@dbus_interface_annotations("org.example.Interface")

819

1195

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

820

1196

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

821

1197

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

822

1198

"false"}

823

1199

"""

1200

824

1201

def decorator(func):

825

1202

func._dbus_is_interface = True

826

1203

func._dbus_interface = dbus_interface

827

1204

func._dbus_name = dbus_interface

828

1205

return func

1206

829

1207

return decorator

830

1208

831

1209

832

1210

def dbus_annotations(annotations):

833

1211

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

834

1212

Usage:

835

1213

1214

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

1215

"org.freedesktop.DBus.Property."

1216

"EmitsChangedSignal": "false"})

836

1217

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

837

1218

access="r")

838

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

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

841

1219

def Property_dbus_property(self):

842

1220

return dbus.Boolean(False)

1221

1222

See also the DBusObjectWithAnnotations class.

843

1223

"""

1224

844

1225

def decorator(func):

845

1226

func._dbus_annotations = annotations

846

1227

return func

1228

847

1229

return decorator

848

1230

849

1231

850

1232

class DBusPropertyException(dbus.exceptions.DBusException):

851

1233

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

852

1234

"""

853

def __unicode__(self):

854

return unicode(str(self))

1235

pass

855

1236

856

1237

857

1238

class DBusPropertyAccessException(DBusPropertyException):

866

1247

pass

867

1248

868

1249

869

class DBusObjectWithProperties(dbus.service.Object):

870

"""A D-Bus object with properties.

871

872

Classes inheriting from this can use the dbus_service_property

873

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

874

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

1250

class DBusObjectWithAnnotations(dbus.service.Object):

1251

"""A D-Bus object with annotations.

1252

1253

Classes inheriting from this can use the dbus_annotations

1254

decorator to add annotations to methods or signals.

875

1255

"""

876

1256

877

1257

@staticmethod

878

1258

def _is_dbus_thing(thing):

879

1259

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

880

1260

881

1261

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

882

1262

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

883

1263

"""

884

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

1264

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

885

1265

False)

886

1266

887

1267

def _get_all_dbus_things(self, thing):

888

1268

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

889

1269

"""

890

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

891

name),

1270

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

892

1271

athing.__get__(self))

893

1272

for cls in self.__class__.__mro__

894

1273

for name, athing in

895

inspect.getmembers(cls,

896

self._is_dbus_thing(thing)))

897

1274

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

1275

1276

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1277

out_signature="s",

1278

path_keyword='object_path',

1279

connection_keyword='connection')

1280

def Introspect(self, object_path, connection):

1281

"""Overloading of standard D-Bus method.

1282

1283

Inserts annotation tags on methods and signals.

1284

"""

1285

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

1286

connection)

1287

try:

1288

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

1289

1290

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

1291

# Add annotation tags

1292

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

1293

for tag in if_tag.getElementsByTagName(typ):

1294

annots = dict()

1295

for name, prop in (self.

1296

_get_all_dbus_things(typ)):

1297

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

1298

and prop._dbus_interface

1299

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

1300

annots.update(getattr(

1301

prop, "_dbus_annotations", {}))

1302

for name, value in annots.items():

1303

ann_tag = document.createElement(

1304

"annotation")

1305

ann_tag.setAttribute("name", name)

1306

ann_tag.setAttribute("value", value)

1307

tag.appendChild(ann_tag)

1308

# Add interface annotation tags

1309

for annotation, value in dict(

1310

itertools.chain.from_iterable(

1311

annotations().items()

1312

for name, annotations

1313

in self._get_all_dbus_things("interface")

1314

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

1315

)).items():

1316

ann_tag = document.createElement("annotation")

1317

ann_tag.setAttribute("name", annotation)

1318

ann_tag.setAttribute("value", value)

1319

if_tag.appendChild(ann_tag)

1320

# Fix argument name for the Introspect method itself

1321

if (if_tag.getAttribute("name")

1322

== dbus.INTROSPECTABLE_IFACE):

1323

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

1324

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

1325

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

1326

if (arg.getAttribute("direction")

1327

== "out"):

1328

arg.setAttribute("name",

1329

"xml_data")

1330

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

1331

document.unlink()

1332

except (AttributeError, xml.dom.DOMException,

1333

xml.parsers.expat.ExpatError) as error:

1334

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

1335

exc_info=error)

1336

return xmlstring

1337

1338

1339

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1340

"""A D-Bus object with properties.

1341

1342

Classes inheriting from this can use the dbus_service_property

1343

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

1344

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

1345

"""

1346

898

1347

def _get_dbus_property(self, interface_name, property_name):

899

1348

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

900

1349

property with the specified name and interface.

901

1350

"""

902

for cls in self.__class__.__mro__:

903

for name, value in (inspect.getmembers

904

(cls,

905

self._is_dbus_thing("property"))):

1351

for cls in self.__class__.__mro__:

1352

for name, value in inspect.getmembers(

1353

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

906

1354

if (value._dbus_name == property_name

907

1355

and value._dbus_interface == interface_name):

908

1356

return value.__get__(self)

909

1357

910

1358

# No such property

911

raise DBusPropertyNotFound(self.dbus_object_path + ":"

912

+ interface_name + "."

913

+ property_name)

914

915

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

1359

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

1360

self.dbus_object_path, interface_name, property_name))

1361

1362

@classmethod

1363

def _get_all_interface_names(cls):

1364

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

1365

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

1366

"_dbus_interface", None)

1367

for x in (inspect.getmro(cls))

1368

for attr in dir(x))

1369

if name is not None)

1370

1371

@dbus.service.method(dbus.PROPERTIES_IFACE,

1372

in_signature="ss",

916

1373

out_signature="v")

917

1374

def Get(self, interface_name, property_name):

918

1375

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

924

1381

if not hasattr(value, "variant_level"):

925

1382

return value

926

1383

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

927

1384

928

1385

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

929

1386

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

930

1387

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

937

1394

# signatures other than "ay".

938

1395

if prop._dbus_signature != "ay":

939

1396

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

940

"'ay' signature {0!r}"

1397

"'ay' signature {!r}"

941

1398

.format(prop._dbus_signature))

942

1399

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

943

1400

for byte in value))

944

1401

prop(value)

945

946

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

1402

1403

@dbus.service.method(dbus.PROPERTIES_IFACE,

1404

in_signature="s",

947

1405

out_signature="a{sv}")

948

1406

def GetAll(self, interface_name):

949

1407

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

950

1408

standard.

951

1409

952

1410

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

953

1411

"""

954

1412

properties = {}

964

1422

if not hasattr(value, "variant_level"):

965

1423

properties[name] = value

966

1424

continue

967

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

968

value.variant_level+1)

1425

properties[name] = type(value)(

1426

value, variant_level=value.variant_level + 1)

969

1427

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

970

1428

1429

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

1430

def PropertiesChanged(self, interface_name, changed_properties,

1431

invalidated_properties):

1432

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

1433

standard.

1434

"""

1435

pass

1436

971

1437

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

972

1438

out_signature="s",

973

1439

path_keyword='object_path',

974

1440

connection_keyword='connection')

975

1441

def Introspect(self, object_path, connection):

976

1442

"""Overloading of standard D-Bus method.

977

1443

978

1444

Inserts property tags and interface annotation tags.

979

1445

"""

980

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

981

connection)

1446

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1447

object_path,

1448

connection)

982

1449

try:

983

1450

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

1451

984

1452

def make_tag(document, name, prop):

985

1453

e = document.createElement("property")

986

1454

e.setAttribute("name", name)

987

1455

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

988

1456

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

989

1457

return e

1458

990

1459

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

991

1460

# Add property tags

992

1461

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

995

1464

if prop._dbus_interface

996

1465

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

997

1466

if_tag.appendChild(tag)

998

# Add annotation tags

999

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

1000

for tag in if_tag.getElementsByTagName(typ):

1001

annots = dict()

1002

for name, prop in (self.

1003

_get_all_dbus_things(typ)):

1004

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

1005

and prop._dbus_interface

1006

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

1007

annots.update(getattr

1008

(prop,

1009

"_dbus_annotations",

1010

{}))

1011

for name, value in annots.iteritems():

1012

ann_tag = document.createElement(

1013

"annotation")

1014

ann_tag.setAttribute("name", name)

1015

ann_tag.setAttribute("value", value)

1016

tag.appendChild(ann_tag)

1017

# Add interface annotation tags

1018

for annotation, value in dict(

1019

itertools.chain.from_iterable(

1020

annotations().iteritems()

1021

for name, annotations in

1022

self._get_all_dbus_things("interface")

1023

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

1024

)).iteritems():

1025

ann_tag = document.createElement("annotation")

1026

ann_tag.setAttribute("name", annotation)

1027

ann_tag.setAttribute("value", value)

1028

if_tag.appendChild(ann_tag)

1467

# Add annotation tags for properties

1468

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

1469

annots = dict()

1470

for name, prop in self._get_all_dbus_things(

1471

"property"):

1472

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

1473

and prop._dbus_interface

1474

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

1475

annots.update(getattr(

1476

prop, "_dbus_annotations", {}))

1477

for name, value in annots.items():

1478

ann_tag = document.createElement(

1479

"annotation")

1480

ann_tag.setAttribute("name", name)

1481

ann_tag.setAttribute("value", value)

1482

tag.appendChild(ann_tag)

1029

1483

# Add the names to the return values for the

1030

1484

# "org.freedesktop.DBus.Properties" methods

1031

1485

if (if_tag.getAttribute("name")

1050

1504

return xmlstring

1051

1505

1052

1506

1507

try:

1508

dbus.OBJECT_MANAGER_IFACE

1509

except AttributeError:

1510

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

1511

1512

1513

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1514

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

1515

1516

Classes inheriting from this exposes the standard

1517

GetManagedObjects call and the InterfacesAdded and

1518

InterfacesRemoved signals on the standard

1519

"org.freedesktop.DBus.ObjectManager" interface.

1520

1521

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

1522

manually.

1523

"""

1524

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1525

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

1526

def GetManagedObjects(self):

1527

"""This function must be overridden"""

1528

raise NotImplementedError()

1529

1530

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1531

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

1532

def InterfacesAdded(self, object_path, interfaces_and_properties):

1533

pass

1534

1535

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

1536

def InterfacesRemoved(self, object_path, interfaces):

1537

pass

1538

1539

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1540

out_signature="s",

1541

path_keyword='object_path',

1542

connection_keyword='connection')

1543

def Introspect(self, object_path, connection):

1544

"""Overloading of standard D-Bus method.

1545

1546

Override return argument name of GetManagedObjects to be

1547

"objpath_interfaces_and_properties"

1548

"""

1549

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1550

object_path,

1551

connection)

1552

try:

1553

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

1554

1555

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

1556

# Fix argument name for the GetManagedObjects method

1557

if (if_tag.getAttribute("name")

1558

== dbus.OBJECT_MANAGER_IFACE):

1559

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

1560

if (cn.getAttribute("name")

1561

== "GetManagedObjects"):

1562

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

1563

if (arg.getAttribute("direction")

1564

== "out"):

1565

arg.setAttribute(

1566

"name",

1567

"objpath_interfaces"

1568

"_and_properties")

1569

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

1570

document.unlink()

1571

except (AttributeError, xml.dom.DOMException,

1572

xml.parsers.expat.ExpatError) as error:

1573

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

1574

exc_info=error)

1575

return xmlstring

1576

1577

1053

1578

def datetime_to_dbus(dt, variant_level=0):

1054

1579

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

1055

1580

if dt is None:

1056

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

1057

return dbus.String(dt.isoformat(),

1058

variant_level=variant_level)

1581

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

1582

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

1059

1583

1060

1584

1061

1585

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1063

1587

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

1064

1588

interface names according to the "alt_interface_names" mapping.

1065

1589

Usage:

1066

1590

1067

1591

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

1068

1592

"net.example.AlternateInterface"})

1069

1593

class SampleDBusObject(dbus.service.Object):

1070

1594

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

1071

1595

def SampleDBusMethod():

1072

1596

pass

1073

1597

1074

1598

The above "SampleDBusMethod" on "SampleDBusObject" will be

1075

1599

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

1076

1600

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

1077

1601

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

1078

1602

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

1079

1603

1080

1604

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

1081

1605

(from DBusObjectWithProperties) and interfaces (from the

1082

1606

dbus_interface_annotations decorator).

1083

1607

"""

1608

1084

1609

def wrapper(cls):

1085

1610

for orig_interface_name, alt_interface_name in (

1086

alt_interface_names.iteritems()):

1611

alt_interface_names.items()):

1087

1612

attr = {}

1088

1613

interface_names = set()

1089

1614

# Go though all attributes of the class

1091

1616

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

1092

1617

# with the wrong interface name

1093

1618

if (not hasattr(attribute, "_dbus_interface")

1094

or not attribute._dbus_interface

1095

.startswith(orig_interface_name)):

1619

or not attribute._dbus_interface.startswith(

1620

orig_interface_name)):

1096

1621

continue

1097

1622

# Create an alternate D-Bus interface name based on

1098

1623

# the current name

1099

alt_interface = (attribute._dbus_interface

1100

.replace(orig_interface_name,

1101

alt_interface_name))

1624

alt_interface = attribute._dbus_interface.replace(

1625

orig_interface_name, alt_interface_name)

1102

1626

interface_names.add(alt_interface)

1103

1627

# Is this a D-Bus signal?

1104

1628

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

1105

1629

# Extract the original non-method undecorated

1106

1630

# function by black magic

1107

nonmethod_func = (dict(

1631

if sys.version_info.major == 2:

1632

nonmethod_func = (dict(

1108

1633

zip(attribute.func_code.co_freevars,

1109

attribute.__closure__))["func"]

1110

.cell_contents)

1634

attribute.__closure__))

1635

["func"].cell_contents)

1636

else:

1637

nonmethod_func = (dict(

1638

zip(attribute.__code__.co_freevars,

1639

attribute.__closure__))

1640

["func"].cell_contents)

1111

1641

# Create a new, but exactly alike, function

1112

1642

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

1113

1643

# with the alternate D-Bus interface name

1114

new_function = (dbus.service.signal

1115

(alt_interface,

1116

attribute._dbus_signature)

1117

(types.FunctionType(

1118

nonmethod_func.func_code,

1119

nonmethod_func.func_globals,

1120

nonmethod_func.func_name,

1121

nonmethod_func.func_defaults,

1122

nonmethod_func.func_closure)))

1644

new_function = copy_function(nonmethod_func)

1645

new_function = (dbus.service.signal(

1646

alt_interface,

1647

attribute._dbus_signature)(new_function))

1123

1648

# Copy annotations, if any

1124

1649

try:

1125

new_function._dbus_annotations = (

1126

dict(attribute._dbus_annotations))

1650

new_function._dbus_annotations = dict(

1651

attribute._dbus_annotations)

1127

1652

except AttributeError:

1128

1653

pass

1654

1129

1655

# Define a creator of a function to call both the

1130

1656

# original and alternate functions, so both the

1131

1657

# original and alternate signals gets sent when

1134

1660

"""This function is a scope container to pass

1135

1661

func1 and func2 to the "call_both" function

1136

1662

outside of its arguments"""

1663

1664

@functools.wraps(func2)

1137

1665

def call_both(*args, **kwargs):

1138

1666

"""This function will emit two D-Bus

1139

1667

signals by calling func1 and func2"""

1140

1668

func1(*args, **kwargs)

1141

1669

func2(*args, **kwargs)

1670

# Make wrapper function look like a D-Bus

1671

# signal

1672

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

1673

if name.startswith("_dbus_"):

1674

setattr(call_both, name, attr)

1675

1142

1676

return call_both

1143

1677

# Create the "call_both" function and add it to

1144

1678

# the class

1149

1683

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

1150

1684

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

1151

1685

# to the class.

1152

attr[attrname] = (dbus.service.method

1153

(alt_interface,

1154

attribute._dbus_in_signature,

1155

attribute._dbus_out_signature)

1156

(types.FunctionType

1157

(attribute.func_code,

1158

attribute.func_globals,

1159

attribute.func_name,

1160

attribute.func_defaults,

1161

attribute.func_closure)))

1686

attr[attrname] = (

1687

dbus.service.method(

1688

alt_interface,

1689

attribute._dbus_in_signature,

1690

attribute._dbus_out_signature)

1691

(copy_function(attribute)))

1162

1692

# Copy annotations, if any

1163

1693

try:

1164

attr[attrname]._dbus_annotations = (

1165

dict(attribute._dbus_annotations))

1694

attr[attrname]._dbus_annotations = dict(

1695

attribute._dbus_annotations)

1166

1696

except AttributeError:

1167

1697

pass

1168

1698

# Is this a D-Bus property?

1171

1701

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

1172

1702

# property with the alternate D-Bus interface

1173

1703

# name. Add it to the class.

1174

attr[attrname] = (dbus_service_property

1175

(alt_interface,

1176

attribute._dbus_signature,

1177

attribute._dbus_access,

1178

attribute

1179

._dbus_get_args_options

1180

["byte_arrays"])

1181

(types.FunctionType

1182

(attribute.func_code,

1183

attribute.func_globals,

1184

attribute.func_name,

1185

attribute.func_defaults,

1186

attribute.func_closure)))

1704

attr[attrname] = (dbus_service_property(

1705

alt_interface, attribute._dbus_signature,

1706

attribute._dbus_access,

1707

attribute._dbus_get_args_options

1708

["byte_arrays"])

1709

(copy_function(attribute)))

1187

1710

# Copy annotations, if any

1188

1711

try:

1189

attr[attrname]._dbus_annotations = (

1190

dict(attribute._dbus_annotations))

1712

attr[attrname]._dbus_annotations = dict(

1713

attribute._dbus_annotations)

1191

1714

except AttributeError:

1192

1715

pass

1193

1716

# Is this a D-Bus interface?

1196

1719

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

1197

1720

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

1198

1721

# to the class.

1199

attr[attrname] = (dbus_interface_annotations

1200

(alt_interface)

1201

(types.FunctionType

1202

(attribute.func_code,

1203

attribute.func_globals,

1204

attribute.func_name,

1205

attribute.func_defaults,

1206

attribute.func_closure)))

1722

attr[attrname] = (

1723

dbus_interface_annotations(alt_interface)

1724

(copy_function(attribute)))

1207

1725

if deprecate:

1208

1726

# Deprecate all alternate interfaces

1209

iname="_AlternateDBusNames_interface_annotation{0}"

1727

iname = "_AlternateDBusNames_interface_annotation{}"

1210

1728

for interface_name in interface_names:

1729

1211

1730

@dbus_interface_annotations(interface_name)

1212

1731

def func(self):

1213

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

1214

"true" }

1732

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

1733

"true"}

1215

1734

# Find an unused name

1216

1735

for aname in (iname.format(i)

1217

1736

for i in itertools.count()):

1221

1740

if interface_names:

1222

1741

# Replace the class with a new subclass of it with

1223

1742

# methods, signals, etc. as created above.

1224

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

1225

(cls,), attr)

1743

if sys.version_info.major == 2:

1744

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

1745

(cls, ), attr)

1746

else:

1747

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

1748

(cls, ), attr)

1226

1749

return cls

1750

1227

1751

return wrapper

1228

1752

1229

1753

1230

1754

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

1231

"se.bsnet.fukt.Mandos"})

1755

"se.bsnet.fukt.Mandos"})

1232

1756

class ClientDBus(Client, DBusObjectWithProperties):

1233

1757

"""A Client class using D-Bus

1234

1758

1235

1759

Attributes:

1236

1760

dbus_object_path: dbus.ObjectPath

1237

1761

bus: dbus.SystemBus()

1238

1762

"""

1239

1763

1240

1764

runtime_expansions = (Client.runtime_expansions

1241

+ ("dbus_object_path",))

1242

1765

+ ("dbus_object_path", ))

1766

1767

_interface = "se.recompile.Mandos.Client"

1768

1243

1769

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

1244

1245

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

1770

1771

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

1246

1772

self.bus = bus

1247

1773

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

1248

1774

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

1249

1775

# the D-Bus

1250

client_object_name = unicode(self.name).translate(

1776

client_object_name = str(self.name).translate(

1251

1777

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

1252

1778

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

1253

self.dbus_object_path = (dbus.ObjectPath

1254

("/clients/" + client_object_name))

1779

self.dbus_object_path = dbus.ObjectPath(

1780

"/clients/" + client_object_name)

1255

1781

DBusObjectWithProperties.__init__(self, self.bus,

1256

1782

self.dbus_object_path)

1257

1258

def notifychangeproperty(transform_func,

1259

dbus_name, type_func=lambda x: x,

1260

variant_level=1):

1783

1784

def notifychangeproperty(transform_func, dbus_name,

1785

type_func=lambda x: x,

1786

variant_level=1,

1787

invalidate_only=False,

1788

_interface=_interface):

1261

1789

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

1262

1790

its changes to DBus.

1263

1791

1264

1792

transform_fun: Function that takes a value and a variant_level

1265

1793

and transforms it to a D-Bus type.

1266

1794

dbus_name: D-Bus name of the variable

1268

1796

to the D-Bus. Default: no transform

1269

1797

variant_level: D-Bus variant level. Default: 1

1270

1798

"""

1271

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

1799

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

1800

1272

1801

def setter(self, value):

1273

1802

if hasattr(self, "dbus_object_path"):

1274

1803

if (not hasattr(self, attrname) or

1275

1804

type_func(getattr(self, attrname, None))

1276

1805

!= type_func(value)):

1277

dbus_value = transform_func(type_func(value),

1278

variant_level

1279

=variant_level)

1280

self.PropertyChanged(dbus.String(dbus_name),

1281

dbus_value)

1806

if invalidate_only:

1807

self.PropertiesChanged(

1808

_interface, dbus.Dictionary(),

1809

dbus.Array((dbus_name, )))

1810

else:

1811

dbus_value = transform_func(

1812

type_func(value),

1813

variant_level=variant_level)

1814

self.PropertyChanged(dbus.String(dbus_name),

1815

dbus_value)

1816

self.PropertiesChanged(

1817

_interface,

1818

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

1819

dbus_value}),

1820

dbus.Array())

1282

1821

setattr(self, attrname, value)

1283

1822

1284

1823

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

1285

1824

1286

1825

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1287

1826

approvals_pending = notifychangeproperty(dbus.Boolean,

1288

1827

"ApprovalPending",

1289

type_func = bool)

1828

type_func=bool)

1290

1829

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

1291

1830

last_enabled = notifychangeproperty(datetime_to_dbus,

1292

1831

"LastEnabled")

1293

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

1294

type_func = lambda checker:

1295

checker is not None)

1832

checker = notifychangeproperty(

1833

dbus.Boolean, "CheckerRunning",

1834

type_func=lambda checker: checker is not None)

1296

1835

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1297

1836

"LastCheckedOK")

1298

1837

last_checker_status = notifychangeproperty(dbus.Int16,

1301

1840

datetime_to_dbus, "LastApprovalRequest")

1302

1841

approved_by_default = notifychangeproperty(dbus.Boolean,

1303

1842

"ApprovedByDefault")

1304

approval_delay = notifychangeproperty(dbus.UInt64,

1305

"ApprovalDelay",

1306

type_func =

1307

timedelta_to_milliseconds)

1843

approval_delay = notifychangeproperty(

1844

dbus.UInt64, "ApprovalDelay",

1845

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

1308

1846

approval_duration = notifychangeproperty(

1309

1847

dbus.UInt64, "ApprovalDuration",

1310

type_func = timedelta_to_milliseconds)

1848

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

1311

1849

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

1312

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

1313

type_func =

1314

timedelta_to_milliseconds)

1850

timeout = notifychangeproperty(

1851

dbus.UInt64, "Timeout",

1852

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

1315

1853

extended_timeout = notifychangeproperty(

1316

1854

dbus.UInt64, "ExtendedTimeout",

1317

type_func = timedelta_to_milliseconds)

1318

interval = notifychangeproperty(dbus.UInt64,

1319

"Interval",

1320

type_func =

1321

timedelta_to_milliseconds)

1855

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

1856

interval = notifychangeproperty(

1857

dbus.UInt64, "Interval",

1858

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

1322

1859

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

1323

1860

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

1861

invalidate_only=True)

1862

1324

1863

del notifychangeproperty

1325

1864

1326

1865

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

1327

1866

try:

1328

1867

self.remove_from_connection()

1331

1870

if hasattr(DBusObjectWithProperties, "__del__"):

1332

1871

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

1333

1872

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

1334

1335

def checker_callback(self, pid, condition, command,

1336

*args, **kwargs):

1337

self.checker_callback_tag = None

1338

self.checker = None

1339

if os.WIFEXITED(condition):

1340

exitstatus = os.WEXITSTATUS(condition)

1873

1874

def checker_callback(self, source, condition,

1875

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

1876

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

1877

connection, command, *args,

1878

**kwargs)

1879

exitstatus = self.last_checker_status

1880

if exitstatus >= 0:

1341

1881

# Emit D-Bus signal

1342

1882

self.CheckerCompleted(dbus.Int16(exitstatus),

1343

dbus.Int64(condition),

1883

# This is specific to GNU libC

1884

dbus.Int64(exitstatus << 8),

1344

1885

dbus.String(command))

1345

1886

else:

1346

1887

# Emit D-Bus signal

1347

1888

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

1348

dbus.Int64(condition),

1889

dbus.Int64(

1890

# This is specific to GNU libC

1891

(exitstatus << 8)

1892

| self.last_checker_signal),

1349

1893

dbus.String(command))

1350

1351

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

1352

*args, **kwargs)

1353

1894

return ret

1895

1354

1896

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

1355

old_checker = self.checker

1356

if self.checker is not None:

1357

old_checker_pid = self.checker.pid

1358

else:

1359

old_checker_pid = None

1897

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

1360

1898

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

1361

1899

# Only if new checker process was started

1362

1900

if (self.checker is not None

1364

1902

# Emit D-Bus signal

1365

1903

self.CheckerStarted(self.current_checker_command)

1366

1904

return r

1367

1905

1368

1906

def _reset_approved(self):

1369

1907

self.approved = None

1370

1908

return False

1371

1909

1372

1910

def approve(self, value=True):

1373

1911

self.approved = value

1374

gobject.timeout_add(timedelta_to_milliseconds

1375

(self.approval_duration),

1376

self._reset_approved)

1912

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

1913

* 1000), self._reset_approved)

1377

1914

self.send_changedstate()

1378

1379

## D-Bus methods, signals & properties

1380

_interface = "se.recompile.Mandos.Client"

1381

1382

## Interfaces

1383

1384

@dbus_interface_annotations(_interface)

1385

def _foo(self):

1386

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

1387

"false"}

1388

1389

## Signals

1390

1915

1916

# D-Bus methods, signals & properties

1917

1918

# Interfaces

1919

1920

# Signals

1921

1391

1922

# CheckerCompleted - signal

1392

1923

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

1393

1924

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

1394

1925

"D-Bus signal"

1395

1926

pass

1396

1927

1397

1928

# CheckerStarted - signal

1398

1929

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

1399

1930

def CheckerStarted(self, command):

1400

1931

"D-Bus signal"

1401

1932

pass

1402

1933

1403

1934

# PropertyChanged - signal

1935

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

1404

1936

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

1405

1937

def PropertyChanged(self, property, value):

1406

1938

"D-Bus signal"

1407

1939

pass

1408

1940

1409

1941

# GotSecret - signal

1410

1942

@dbus.service.signal(_interface)

1411

1943

def GotSecret(self):

1414

1946

server to mandos-client

1415

1947

"""

1416

1948

pass

1417

1949

1418

1950

# Rejected - signal

1419

1951

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

1420

1952

def Rejected(self, reason):

1421

1953

"D-Bus signal"

1422

1954

pass

1423

1955

1424

1956

# NeedApproval - signal

1425

1957

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

1426

1958

def NeedApproval(self, timeout, default):

1427

1959

"D-Bus signal"

1428

1960

return self.need_approval()

1429

1430

## Methods

1431

1961

1962

# Methods

1963

1432

1964

# Approve - method

1433

1965

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

1434

1966

def Approve(self, value):

1435

1967

self.approve(value)

1436

1968

1437

1969

# CheckedOK - method

1438

1970

@dbus.service.method(_interface)

1439

1971

def CheckedOK(self):

1440

1972

self.checked_ok()

1441

1973

1442

1974

# Enable - method

1975

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

1443

1976

@dbus.service.method(_interface)

1444

1977

def Enable(self):

1445

1978

"D-Bus method"

1446

1979

self.enable()

1447

1980

1448

1981

# StartChecker - method

1982

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

1449

1983

@dbus.service.method(_interface)

1450

1984

def StartChecker(self):

1451

1985

"D-Bus method"

1452

1986

self.start_checker()

1453

1987

1454

1988

# Disable - method

1989

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

1455

1990

@dbus.service.method(_interface)

1456

1991

def Disable(self):

1457

1992

"D-Bus method"

1458

1993

self.disable()

1459

1994

1460

1995

# StopChecker - method

1996

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

1461

1997

@dbus.service.method(_interface)

1462

1998

def StopChecker(self):

1463

1999

self.stop_checker()

1464

1465

## Properties

1466

2000

2001

# Properties

2002

1467

2003

# ApprovalPending - property

1468

2004

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

1469

2005

def ApprovalPending_dbus_property(self):

1470

2006

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

1471

2007

1472

2008

# ApprovedByDefault - property

1473

@dbus_service_property(_interface, signature="b",

2009

@dbus_service_property(_interface,

2010

signature="b",

1474

2011

access="readwrite")

1475

2012

def ApprovedByDefault_dbus_property(self, value=None):

1476

2013

if value is None: # get

1477

2014

return dbus.Boolean(self.approved_by_default)

1478

2015

self.approved_by_default = bool(value)

1479

2016

1480

2017

# ApprovalDelay - property

1481

@dbus_service_property(_interface, signature="t",

2018

@dbus_service_property(_interface,

2019

signature="t",

1482

2020

access="readwrite")

1483

2021

def ApprovalDelay_dbus_property(self, value=None):

1484

2022

if value is None: # get

1485

return dbus.UInt64(self.approval_delay_milliseconds())

2023

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

2024

* 1000)

1486

2025

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

1487

2026

1488

2027

# ApprovalDuration - property

1489

@dbus_service_property(_interface, signature="t",

2028

@dbus_service_property(_interface,

2029

signature="t",

1490

2030

access="readwrite")

1491

2031

def ApprovalDuration_dbus_property(self, value=None):

1492

2032

if value is None: # get

1493

return dbus.UInt64(timedelta_to_milliseconds(

1494

self.approval_duration))

2033

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

2034

* 1000)

1495

2035

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

1496

2036

1497

2037

# Name - property

2038

@dbus_annotations(

2039

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

1498

2040

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

1499

2041

def Name_dbus_property(self):

1500

2042

return dbus.String(self.name)

1501

2043

2044

# KeyID - property

2045

@dbus_annotations(

2046

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

2047

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

2048

def KeyID_dbus_property(self):

2049

return dbus.String(self.key_id)

2050

1502

2051

# Fingerprint - property

2052

@dbus_annotations(

2053

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

1503

2054

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

1504

2055

def Fingerprint_dbus_property(self):

1505

2056

return dbus.String(self.fingerprint)

1506

2057

1507

2058

# Host - property

1508

@dbus_service_property(_interface, signature="s",

2059

@dbus_service_property(_interface,

2060

signature="s",

1509

2061

access="readwrite")

1510

2062

def Host_dbus_property(self, value=None):

1511

2063

if value is None: # get

1512

2064

return dbus.String(self.host)

1513

self.host = unicode(value)

1514

2065

self.host = str(value)

2066

1515

2067

# Created - property

2068

@dbus_annotations(

2069

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

1516

2070

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

1517

2071

def Created_dbus_property(self):

1518

2072

return datetime_to_dbus(self.created)

1519

2073

1520

2074

# LastEnabled - property

1521

2075

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

1522

2076

def LastEnabled_dbus_property(self):

1523

2077

return datetime_to_dbus(self.last_enabled)

1524

2078

1525

2079

# Enabled - property

1526

@dbus_service_property(_interface, signature="b",

2080

@dbus_service_property(_interface,

2081

signature="b",

1527

2082

access="readwrite")

1528

2083

def Enabled_dbus_property(self, value=None):

1529

2084

if value is None: # get

1532

2087

self.enable()

1533

2088

else:

1534

2089

self.disable()

1535

2090

1536

2091

# LastCheckedOK - property

1537

@dbus_service_property(_interface, signature="s",

2092

@dbus_service_property(_interface,

2093

signature="s",

1538

2094

access="readwrite")

1539

2095

def LastCheckedOK_dbus_property(self, value=None):

1540

2096

if value is not None:

1541

2097

self.checked_ok()

1542

2098

return

1543

2099

return datetime_to_dbus(self.last_checked_ok)

1544

2100

1545

2101

# LastCheckerStatus - property

1546

@dbus_service_property(_interface, signature="n",

1547

access="read")

2102

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

1548

2103

def LastCheckerStatus_dbus_property(self):

1549

2104

return dbus.Int16(self.last_checker_status)

1550

2105

1551

2106

# Expires - property

1552

2107

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

1553

2108

def Expires_dbus_property(self):

1554

2109

return datetime_to_dbus(self.expires)

1555

2110

1556

2111

# LastApprovalRequest - property

1557

2112

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

1558

2113

def LastApprovalRequest_dbus_property(self):

1559

2114

return datetime_to_dbus(self.last_approval_request)

1560

2115

1561

2116

# Timeout - property

1562

@dbus_service_property(_interface, signature="t",

2117

@dbus_service_property(_interface,

2118

signature="t",

1563

2119

access="readwrite")

1564

2120

def Timeout_dbus_property(self, value=None):

1565

2121

if value is None: # get

1566

return dbus.UInt64(self.timeout_milliseconds())

2122

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

1567

2123

old_timeout = self.timeout

1568

2124

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

1569

2125

# Reschedule disabling

1577

2133

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

1578

2134

is None):

1579

2135

return

1580

gobject.source_remove(self.disable_initiator_tag)

1581

self.disable_initiator_tag = (

1582

gobject.timeout_add(

1583

timedelta_to_milliseconds(self.expires - now),

1584

self.disable))

1585

2136

GLib.source_remove(self.disable_initiator_tag)

2137

self.disable_initiator_tag = GLib.timeout_add(

2138

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

2139

self.disable)

2140

1586

2141

# ExtendedTimeout - property

1587

@dbus_service_property(_interface, signature="t",

2142

@dbus_service_property(_interface,

2143

signature="t",

1588

2144

access="readwrite")

1589

2145

def ExtendedTimeout_dbus_property(self, value=None):

1590

2146

if value is None: # get

1591

return dbus.UInt64(self.extended_timeout_milliseconds())

2147

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

2148

* 1000)

1592

2149

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

1593

2150

1594

2151

# Interval - property

1595

@dbus_service_property(_interface, signature="t",

2152

@dbus_service_property(_interface,

2153

signature="t",

1596

2154

access="readwrite")

1597

2155

def Interval_dbus_property(self, value=None):

1598

2156

if value is None: # get

1599

return dbus.UInt64(self.interval_milliseconds())

2157

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

1600

2158

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

1601

2159

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

1602

2160

return

1603

2161

if self.enabled:

1604

2162

# Reschedule checker run

1605

gobject.source_remove(self.checker_initiator_tag)

1606

self.checker_initiator_tag = (gobject.timeout_add

1607

(value, self.start_checker))

1608

self.start_checker() # Start one now, too

1609

2163

GLib.source_remove(self.checker_initiator_tag)

2164

self.checker_initiator_tag = GLib.timeout_add(

2165

value, self.start_checker)

2166

self.start_checker() # Start one now, too

2167

1610

2168

# Checker - property

1611

@dbus_service_property(_interface, signature="s",

2169

@dbus_service_property(_interface,

2170

signature="s",

1612

2171

access="readwrite")

1613

2172

def Checker_dbus_property(self, value=None):

1614

2173

if value is None: # get

1615

2174

return dbus.String(self.checker_command)

1616

self.checker_command = unicode(value)

1617

2175

self.checker_command = str(value)

2176

1618

2177

# CheckerRunning - property

1619

@dbus_service_property(_interface, signature="b",

2178

@dbus_service_property(_interface,

2179

signature="b",

1620

2180

access="readwrite")

1621

2181

def CheckerRunning_dbus_property(self, value=None):

1622

2182

if value is None: # get

1625

2185

self.start_checker()

1626

2186

else:

1627

2187

self.stop_checker()

1628

2188

1629

2189

# ObjectPath - property

2190

@dbus_annotations(

2191

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

2192

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

1630

2193

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

1631

2194

def ObjectPath_dbus_property(self):

1632

return self.dbus_object_path # is already a dbus.ObjectPath

1633

2195

return self.dbus_object_path # is already a dbus.ObjectPath

2196

1634

2197

# Secret = property

1635

@dbus_service_property(_interface, signature="ay",

1636

access="write", byte_arrays=True)

2198

@dbus_annotations(

2199

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

2200

"invalidates"})

2201

@dbus_service_property(_interface,

2202

signature="ay",

2203

access="write",

2204

byte_arrays=True)

1637

2205

def Secret_dbus_property(self, value):

1638

self.secret = str(value)

1639

2206

self.secret = bytes(value)

2207

1640

2208

del _interface

1641

2209

1642

2210

1643

2211

class ProxyClient(object):

1644

def __init__(self, child_pipe, fpr, address):

2212

def __init__(self, child_pipe, key_id, fpr, address):

1645

2213

self._pipe = child_pipe

1646

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

2214

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

1647

2215

if not self._pipe.recv():

1648

raise KeyError()

1649

2216

raise KeyError(key_id or fpr)

2217

1650

2218

def __getattribute__(self, name):

1651

2219

if name == '_pipe':

1652

2220

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

1655

2223

if data[0] == 'data':

1656

2224

return data[1]

1657

2225

if data[0] == 'function':

2226

1658

2227

def func(*args, **kwargs):

1659

2228

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

1660

2229

return self._pipe.recv()[1]

2230

1661

2231

return func

1662

2232

1663

2233

def __setattr__(self, name, value):

1664

2234

if name == '_pipe':

1665

2235

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

1668

2238

1669

2239

class ClientHandler(socketserver.BaseRequestHandler, object):

1670

2240

"""A class to handle client connections.

1671

2241

1672

2242

Instantiated once for each connection to handle it.

1673

2243

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

1674

2244

1675

2245

def handle(self):

1676

2246

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

1677

2247

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

1678

unicode(self.client_address))

2248

str(self.client_address))

1679

2249

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

1680

2250

self.server.child_pipe.fileno())

1681

1682

session = (gnutls.connection

1683

.ClientSession(self.request,

1684

gnutls.connection

1685

.X509Credentials()))

1686

1687

# Note: gnutls.connection.X509Credentials is really a

1688

# generic GnuTLS certificate credentials object so long as

1689

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

1690

# here despite using OpenPGP certificates.

1691

1692

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

1693

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

1694

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

1695

# "+DHE-DSS"))

2251

2252

session = gnutls.ClientSession(self.request)

2253

2254

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

2255

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

2256

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

2257

# "+DHE-DSS"))

1696

2258

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

1697

2259

priority = self.server.gnutls_priority

1698

2260

if priority is None:

1699

2261

priority = "NORMAL"

1700

(gnutls.library.functions

1701

.gnutls_priority_set_direct(session._c_object,

1702

priority, None))

1703

2262

gnutls.priority_set_direct(session._c_object,

2263

priority.encode("utf-8"),

2264

None)

2265

1704

2266

# Start communication using the Mandos protocol

1705

2267

# Get protocol number

1706

2268

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

1711

2273

except (ValueError, IndexError, RuntimeError) as error:

1712

2274

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

1713

2275

return

1714

2276

1715

2277

# Start GnuTLS connection

1716

2278

try:

1717

2279

session.handshake()

1718

except gnutls.errors.GNUTLSError as error:

2280

except gnutls.Error as error:

1719

2281

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

1720

2282

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

1721

2283

# established. Just abandon the request.

1722

2284

return

1723

2285

logger.debug("Handshake succeeded")

1724

2286

1725

2287

approval_required = False

1726

2288

try:

1727

try:

1728

fpr = self.fingerprint(self.peer_certificate

1729

(session))

1730

except (TypeError,

1731

gnutls.errors.GNUTLSError) as error:

1732

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

1733

return

1734

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

1735

1736

try:

1737

client = ProxyClient(child_pipe, fpr,

2289

if gnutls.has_rawpk:

2290

fpr = ""

2291

try:

2292

key_id = self.key_id(

2293

self.peer_certificate(session))

2294

except (TypeError, gnutls.Error) as error:

2295

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

2296

return

2297

logger.debug("Key ID: %s", key_id)

2298

2299

else:

2300

key_id = ""

2301

try:

2302

fpr = self.fingerprint(

2303

self.peer_certificate(session))

2304

except (TypeError, gnutls.Error) as error:

2305

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

2306

return

2307

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

2308

2309

try:

2310

client = ProxyClient(child_pipe, key_id, fpr,

1738

2311

self.client_address)

1739

2312

except KeyError:

1740

2313

return

1741

2314

1742

2315

if client.approval_delay:

1743

2316

delay = client.approval_delay

1744

2317

client.approvals_pending += 1

1745

2318

approval_required = True

1746

2319

1747

2320

while True:

1748

2321

if not client.enabled:

1749

2322

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

1750

client.name)

2323

client.name)

1751

2324

if self.server.use_dbus:

1752

2325

# Emit D-Bus signal

1753

2326

client.Rejected("Disabled")

1754

2327

return

1755

2328

1756

2329

if client.approved or not client.approval_delay:

1757

#We are approved or approval is disabled

2330

# We are approved or approval is disabled

1758

2331

break

1759

2332

elif client.approved is None:

1760

2333

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

1762

2335

if self.server.use_dbus:

1763

2336

# Emit D-Bus signal

1764

2337

client.NeedApproval(

1765

client.approval_delay_milliseconds(),

1766

client.approved_by_default)

2338

client.approval_delay.total_seconds()

2339

* 1000, client.approved_by_default)

1767

2340

else:

1768

2341

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

1769

2342

client.name)

1771

2344

# Emit D-Bus signal

1772

2345

client.Rejected("Denied")

1773

2346

return

1774

1775

#wait until timeout or approved

2347

2348

# wait until timeout or approved

1776

2349

time = datetime.datetime.now()

1777

2350

client.changedstate.acquire()

1778

client.changedstate.wait(

1779

float(timedelta_to_milliseconds(delay)

1780

/ 1000))

2351

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

1781

2352

client.changedstate.release()

1782

2353

time2 = datetime.datetime.now()

1783

2354

if (time2 - time) >= delay:

1793

2364

break

1794

2365

else:

1795

2366

delay -= time2 - time

1796

1797

sent_size = 0

1798

while sent_size < len(client.secret):

1799

try:

1800

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

1801

except gnutls.errors.GNUTLSError as error:

1802

logger.warning("gnutls send failed",

1803

exc_info=error)

1804

return

1805

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

1806

sent, len(client.secret)

1807

- (sent_size + sent))

1808

sent_size += sent

1809

2367

2368

try:

2369

session.send(client.secret)

2370

except gnutls.Error as error:

2371

logger.warning("gnutls send failed",

2372

exc_info=error)

2373

return

2374

1810

2375

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

1811

2376

# bump the timeout using extended_timeout

1812

2377

client.bump_timeout(client.extended_timeout)

1813

2378

if self.server.use_dbus:

1814

2379

# Emit D-Bus signal

1815

2380

client.GotSecret()

1816

2381

1817

2382

finally:

1818

2383

if approval_required:

1819

2384

client.approvals_pending -= 1

1820

2385

try:

1821

2386

session.bye()

1822

except gnutls.errors.GNUTLSError as error:

2387

except gnutls.Error as error:

1823

2388

logger.warning("GnuTLS bye failed",

1824

2389

exc_info=error)

1825

2390

1826

2391

@staticmethod

1827

2392

def peer_certificate(session):

1828

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

1829

# If not an OpenPGP certificate...

1830

if (gnutls.library.functions

1831

.gnutls_certificate_type_get(session._c_object)

1832

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1833

# ...do the normal thing

1834

return session.peer_certificate

2393

"Return the peer's certificate as a bytestring"

2394

try:

2395

cert_type = gnutls.certificate_type_get2(session._c_object,

2396

gnutls.CTYPE_PEERS)

2397

except AttributeError:

2398

cert_type = gnutls.certificate_type_get(session._c_object)

2399

if gnutls.has_rawpk:

2400

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2401

else:

2402

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2403

# If not a valid certificate type...

2404

if cert_type not in valid_cert_types:

2405

logger.info("Cert type %r not in %r", cert_type,

2406

valid_cert_types)

2407

# ...return invalid data

2408

return b""

1835

2409

list_size = ctypes.c_uint(1)

1836

cert_list = (gnutls.library.functions

1837

.gnutls_certificate_get_peers

2410

cert_list = (gnutls.certificate_get_peers

1838

2411

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

1839

2412

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

1840

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

1841

" certificate")

2413

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

1842

2414

if list_size.value == 0:

1843

2415

return None

1844

2416

cert = cert_list[0]

1845

2417

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

1846

2418

2419

@staticmethod

2420

def key_id(certificate):

2421

"Convert a certificate bytestring to a hexdigit key ID"

2422

# New GnuTLS "datum" with the public key

2423

datum = gnutls.datum_t(

2424

ctypes.cast(ctypes.c_char_p(certificate),

2425

ctypes.POINTER(ctypes.c_ubyte)),

2426

ctypes.c_uint(len(certificate)))

2427

# XXX all these need to be created in the gnutls "module"

2428

# New empty GnuTLS certificate

2429

pubkey = gnutls.pubkey_t()

2430

gnutls.pubkey_init(ctypes.byref(pubkey))

2431

# Import the raw public key into the certificate

2432

gnutls.pubkey_import(pubkey,

2433

ctypes.byref(datum),

2434

gnutls.X509_FMT_DER)

2435

# New buffer for the key ID

2436

buf = ctypes.create_string_buffer(32)

2437

buf_len = ctypes.c_size_t(len(buf))

2438

# Get the key ID from the raw public key into the buffer

2439

gnutls.pubkey_get_key_id(pubkey,

2440

gnutls.KEYID_USE_SHA256,

2441

ctypes.cast(ctypes.byref(buf),

2442

ctypes.POINTER(ctypes.c_ubyte)),

2443

ctypes.byref(buf_len))

2444

# Deinit the certificate

2445

gnutls.pubkey_deinit(pubkey)

2446

2447

# Convert the buffer to a Python bytestring

2448

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

2449

# Convert the bytestring to hexadecimal notation

2450

hex_key_id = binascii.hexlify(key_id).upper()

2451

return hex_key_id

2452

1847

2453

@staticmethod

1848

2454

def fingerprint(openpgp):

1849

2455

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1850

2456

# New GnuTLS "datum" with the OpenPGP public key

1851

datum = (gnutls.library.types

1852

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

1853

ctypes.POINTER

1854

(ctypes.c_ubyte)),

1855

ctypes.c_uint(len(openpgp))))

2457

datum = gnutls.datum_t(

2458

ctypes.cast(ctypes.c_char_p(openpgp),

2459

ctypes.POINTER(ctypes.c_ubyte)),

2460

ctypes.c_uint(len(openpgp)))

1856

2461

# New empty GnuTLS certificate

1857

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1858

(gnutls.library.functions

1859

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2462

crt = gnutls.openpgp_crt_t()

2463

gnutls.openpgp_crt_init(ctypes.byref(crt))

1860

2464

# Import the OpenPGP public key into the certificate

1861

(gnutls.library.functions

1862

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

1863

gnutls.library.constants

1864

.GNUTLS_OPENPGP_FMT_RAW))

2465

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

2466

gnutls.OPENPGP_FMT_RAW)

1865

2467

# Verify the self signature in the key

1866

2468

crtverify = ctypes.c_uint()

1867

(gnutls.library.functions

1868

.gnutls_openpgp_crt_verify_self(crt, 0,

1869

ctypes.byref(crtverify)))

2469

gnutls.openpgp_crt_verify_self(crt, 0,

2470

ctypes.byref(crtverify))

1870

2471

if crtverify.value != 0:

1871

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1872

raise (gnutls.errors.CertificateSecurityError

1873

("Verify failed"))

2472

gnutls.openpgp_crt_deinit(crt)

2473

raise gnutls.CertificateSecurityError(code

2474

=crtverify.value)

1874

2475

# New buffer for the fingerprint

1875

2476

buf = ctypes.create_string_buffer(20)

1876

2477

buf_len = ctypes.c_size_t()

1877

2478

# Get the fingerprint from the certificate into the buffer

1878

(gnutls.library.functions

1879

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

1880

ctypes.byref(buf_len)))

2479

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

2480

ctypes.byref(buf_len))

1881

2481

# Deinit the certificate

1882

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2482

gnutls.openpgp_crt_deinit(crt)

1883

2483

# Convert the buffer to a Python bytestring

1884

2484

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

1885

2485

# Convert the bytestring to hexadecimal notation

1889

2489

1890

2490

class MultiprocessingMixIn(object):

1891

2491

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

2492

1892

2493

def sub_process_main(self, request, address):

1893

2494

try:

1894

2495

self.finish_request(request, address)

1895

2496

except Exception:

1896

2497

self.handle_error(request, address)

1897

2498

self.close_request(request)

1898

2499

1899

2500

def process_request(self, request, address):

1900

2501

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

1901

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

1902

args = (request, address))

2502

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

2503

args=(request, address))

1903

2504

proc.start()

1904

2505

return proc

1905

2506

1906

2507

1907

2508

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1908

2509

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

2510

1909

2511

def process_request(self, request, client_address):

1910

2512

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

1911

2513

1912

2514

This function creates a new pipe in self.pipe

1913

2515

"""

1914

2516

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1915

2517

1916

2518

proc = MultiprocessingMixIn.process_request(self, request,

1917

2519

client_address)

1918

2520

self.child_pipe.close()

1919

2521

self.add_pipe(parent_pipe, proc)

1920

2522

1921

2523

def add_pipe(self, parent_pipe, proc):

1922

2524

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

1923

2525

raise NotImplementedError()

1926

2528

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1927

2529

socketserver.TCPServer, object):

1928

2530

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

1929

2531

1930

2532

Attributes:

1931

2533

enabled: Boolean; whether this server is activated yet

1932

2534

interface: None or a network interface name (string)

1933

2535

use_ipv6: Boolean; to use IPv6 or not

1934

2536

"""

2537

1935

2538

def __init__(self, server_address, RequestHandlerClass,

1936

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

2539

interface=None,

2540

use_ipv6=True,

2541

socketfd=None):

1937

2542

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

1938

2543

creating a new one with socket.socket().

1939

2544

"""

1945

2550

self.socketfd = socketfd

1946

2551

# Save the original socket.socket() function

1947

2552

self.socket_socket = socket.socket

2553

1948

2554

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

1949

#

2555

#

1950

2556

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

1951

2557

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

1952

2558

# patching socket.socket.)

1953

#

2559

#

1954

2560

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

1955

2561

@functools.wraps(socket.socket)

1956

2562

def socket_wrapper(*args, **kwargs):

1968

2574

# socket_wrapper(), if socketfd was set.

1969

2575

socketserver.TCPServer.__init__(self, server_address,

1970

2576

RequestHandlerClass)

1971

2577

1972

2578

def server_bind(self):

1973

2579

"""This overrides the normal server_bind() function

1974

2580

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

1975

2581

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

2582

global SO_BINDTODEVICE

1976

2583

if self.interface is not None:

1977

2584

if SO_BINDTODEVICE is None:

1978

logger.error("SO_BINDTODEVICE does not exist;"

1979

" cannot bind to interface %s",

1980

self.interface)

1981

else:

1982

try:

1983

self.socket.setsockopt(socket.SOL_SOCKET,

1984

SO_BINDTODEVICE,

1985

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

1986

except socket.error as error:

1987

if error.errno == errno.EPERM:

1988

logger.error("No permission to bind to"

1989

" interface %s", self.interface)

1990

elif error.errno == errno.ENOPROTOOPT:

1991

logger.error("SO_BINDTODEVICE not available;"

1992

" cannot bind to interface %s",

1993

self.interface)

1994

elif error.errno == errno.ENODEV:

1995

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

1996

" cannot bind", self.interface)

1997

else:

1998

raise

2585

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

2586

# common enough.

2587

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

2588

SO_BINDTODEVICE = 25

2589

try:

2590

self.socket.setsockopt(

2591

socket.SOL_SOCKET, SO_BINDTODEVICE,

2592

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

2593

except socket.error as error:

2594

if error.errno == errno.EPERM:

2595

logger.error("No permission to bind to"

2596

" interface %s", self.interface)

2597

elif error.errno == errno.ENOPROTOOPT:

2598

logger.error("SO_BINDTODEVICE not available;"

2599

" cannot bind to interface %s",

2600

self.interface)

2601

elif error.errno == errno.ENODEV:

2602

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

2603

" cannot bind", self.interface)

2604

else:

2605

raise

1999

2606

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

2000

2607

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

2001

2608

if not self.server_address[0]:

2002

2609

if self.address_family == socket.AF_INET6:

2003

any_address = "::" # in6addr_any

2610

any_address = "::" # in6addr_any

2004

2611

else:

2005

any_address = "0.0.0.0" # INADDR_ANY

2612

any_address = "0.0.0.0" # INADDR_ANY

2006

2613

self.server_address = (any_address,

2007

2614

self.server_address[1])

2008

2615

elif not self.server_address[1]:

2009

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

2010

0)

2616

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

2011

2617

# if self.interface:

2012

2618

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

2013

2619

# 0, # port

2019

2625

2020

2626

class MandosServer(IPv6_TCPServer):

2021

2627

"""Mandos server.

2022

2628

2023

2629

Attributes:

2024

2630

clients: set of Client objects

2025

2631

gnutls_priority GnuTLS priority string

2026

2632

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

2027

2028

Assumes a gobject.MainLoop event loop.

2633

2634

Assumes a GLib.MainLoop event loop.

2029

2635

"""

2636

2030

2637

def __init__(self, server_address, RequestHandlerClass,

2031

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

2032

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

2638

interface=None,

2639

use_ipv6=True,

2640

clients=None,

2641

gnutls_priority=None,

2642

use_dbus=True,

2643

socketfd=None):

2033

2644

self.enabled = False

2034

2645

self.clients = clients

2035

2646

if self.clients is None:

2038

2649

self.gnutls_priority = gnutls_priority

2039

2650

IPv6_TCPServer.__init__(self, server_address,

2040

2651

RequestHandlerClass,

2041

interface = interface,

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

2652

interface=interface,

2653

use_ipv6=use_ipv6,

2654

socketfd=socketfd)

2655

2044

2656

def server_activate(self):

2045

2657

if self.enabled:

2046

2658

return socketserver.TCPServer.server_activate(self)

2047

2659

2048

2660

def enable(self):

2049

2661

self.enabled = True

2050

2662

2051

2663

def add_pipe(self, parent_pipe, proc):

2052

2664

# Call "handle_ipc" for both data and EOF events

2053

gobject.io_add_watch(parent_pipe.fileno(),

2054

gobject.IO_IN | gobject.IO_HUP,

2055

functools.partial(self.handle_ipc,

2056

parent_pipe =

2057

parent_pipe,

2058

proc = proc))

2059

2060

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

2061

proc = None, client_object=None):

2665

GLib.io_add_watch(

2666

parent_pipe.fileno(),

2667

GLib.IO_IN | GLib.IO_HUP,

2668

functools.partial(self.handle_ipc,

2669

parent_pipe=parent_pipe,

2670

proc=proc))

2671

2672

def handle_ipc(self, source, condition,

2673

parent_pipe=None,

2674

proc=None,

2675

client_object=None):

2062

2676

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

2063

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

2677

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

2064

2678

# Wait for other process to exit

2065

2679

proc.join()

2066

2680

return False

2067

2681

2068

2682

# Read a request from the child

2069

2683

request = parent_pipe.recv()

2070

2684

command = request[0]

2071

2685

2072

2686

if command == 'init':

2073

fpr = request[1]

2074

address = request[2]

2075

2076

for c in self.clients.itervalues():

2077

if c.fingerprint == fpr:

2687

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

2688

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

2689

address = request[3]

2690

2691

for c in self.clients.values():

2692

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2693

continue

2694

if key_id and c.key_id == key_id:

2695

client = c

2696

break

2697

if fpr and c.fingerprint == fpr:

2078

2698

client = c

2079

2699

break

2080

2700

else:

2081

logger.info("Client not found for fingerprint: %s, ad"

2082

"dress: %s", fpr, address)

2701

logger.info("Client not found for key ID: %s, address"

2702

": %s", key_id or fpr, address)

2083

2703

if self.use_dbus:

2084

2704

# Emit D-Bus signal

2085

mandos_dbus_service.ClientNotFound(fpr,

2705

mandos_dbus_service.ClientNotFound(key_id or fpr,

2086

2706

address[0])

2087

2707

parent_pipe.send(False)

2088

2708

return False

2089

2090

gobject.io_add_watch(parent_pipe.fileno(),

2091

gobject.IO_IN | gobject.IO_HUP,

2092

functools.partial(self.handle_ipc,

2093

parent_pipe =

2094

parent_pipe,

2095

proc = proc,

2096

client_object =

2097

client))

2709

2710

GLib.io_add_watch(

2711

parent_pipe.fileno(),

2712

GLib.IO_IN | GLib.IO_HUP,

2713

functools.partial(self.handle_ipc,

2714

parent_pipe=parent_pipe,

2715

proc=proc,

2716

client_object=client))

2098

2717

parent_pipe.send(True)

2099

2718

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

2100

2719

# same fileno

2103

2722

funcname = request[1]

2104

2723

args = request[2]

2105

2724

kwargs = request[3]

2106

2725

2107

2726

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

2108

2727

funcname)(*args,

2109

**kwargs)))

2110

2728

**kwargs)))

2729

2111

2730

if command == 'getattr':

2112

2731

attrname = request[1]

2113

if callable(client_object.__getattribute__(attrname)):

2114

parent_pipe.send(('function',))

2732

if isinstance(client_object.__getattribute__(attrname),

2733

collections.Callable):

2734

parent_pipe.send(('function', ))

2115

2735

else:

2116

parent_pipe.send(('data', client_object

2117

.__getattribute__(attrname)))

2118

2736

parent_pipe.send((

2737

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

2738

2119

2739

if command == 'setattr':

2120

2740

attrname = request[1]

2121

2741

value = request[2]

2122

2742

setattr(client_object, attrname, value)

2123

2743

2124

2744

return True

2125

2745

2126

2746

2127

2747

def rfc3339_duration_to_delta(duration):

2128

2748

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

2129

2749

2130

2750

>>> rfc3339_duration_to_delta("P7D")

2131

2751

datetime.timedelta(7)

2132

2752

>>> rfc3339_duration_to_delta("PT60S")

2142

2762

>>> rfc3339_duration_to_delta("P1DT3M20S")

2143

2763

datetime.timedelta(1, 200)

2144

2764

"""

2145

2765

2146

2766

# Parsing an RFC 3339 duration with regular expressions is not

2147

2767

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

2148

2768

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

2149

2769

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

2150

2770

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

2151

2771

# avoid excessive use of external libraries.

2152

2772

2153

2773

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

2154

Token = collections.namedtuple("Token",

2155

("regexp", # To match token; if

2156

# "value" is not None,

2157

# must have a "group"

2158

# containing digits

2159

"value", # datetime.timedelta or

2160

# None

2161

"followers")) # Tokens valid after

2162

# this token

2774

Token = collections.namedtuple("Token", (

2775

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

2776

# a "group" containing digits

2777

"value", # datetime.timedelta or None

2778

"followers")) # Tokens valid after this token

2163

2779

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

2164

2780

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

2165

2781

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

2166

2782

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

2167

2783

datetime.timedelta(seconds=1),

2168

frozenset((token_end,)))

2784

frozenset((token_end, )))

2169

2785

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

2170

2786

datetime.timedelta(minutes=1),

2171

2787

frozenset((token_second, token_end)))

2187

2803

frozenset((token_month, token_end)))

2188

2804

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

2189

2805

datetime.timedelta(weeks=1),

2190

frozenset((token_end,)))

2806

frozenset((token_end, )))

2191

2807

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

2192

2808

frozenset((token_year, token_month,

2193

2809

token_day, token_time,

2194

token_week))),

2195

# Define starting values

2196

value = datetime.timedelta() # Value so far

2810

token_week)))

2811

# Define starting values:

2812

# Value so far

2813

value = datetime.timedelta()

2197

2814

found_token = None

2198

followers = frozenset(token_duration,) # Following valid tokens

2199

s = duration # String left to parse

2815

# Following valid tokens

2816

followers = frozenset((token_duration, ))

2817

# String left to parse

2818

s = duration

2200

2819

# Loop until end token is found

2201

2820

while found_token is not token_end:

2202

2821

# Search for any currently valid tokens

2218

2837

break

2219

2838

else:

2220

2839

# No currently valid tokens were found

2221

raise ValueError("Invalid RFC 3339 duration")

2840

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

2841

.format(duration))

2222

2842

# End token found

2223

2843

return value

2224

2844

2225

2845

2226

2846

def string_to_delta(interval):

2227

2847

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

2228

2848

2229

2849

>>> string_to_delta('7d')

2230

2850

datetime.timedelta(7)

2231

2851

>>> string_to_delta('60s')

2239

2859

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

2240

2860

datetime.timedelta(0, 330)

2241

2861

"""

2242

2862

2243

2863

try:

2244

2864

return rfc3339_duration_to_delta(interval)

2245

2865

except ValueError:

2246

2866

pass

2247

2867

2248

2868

timevalue = datetime.timedelta(0)

2249

2869

for s in interval.split():

2250

2870

try:

2251

suffix = unicode(s[-1])

2871

suffix = s[-1]

2252

2872

value = int(s[:-1])

2253

2873

if suffix == "d":

2254

2874

delta = datetime.timedelta(value)

2261

2881

elif suffix == "w":

2262

2882

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

2263

2883

else:

2264

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

2265

.format(suffix))

2884

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

2266

2885

except IndexError as e:

2267

2886

raise ValueError(*(e.args))

2268

2887

timevalue += delta

2269

2888

return timevalue

2270

2889

2271

2890

2272

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

2891

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

2273

2892

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

2274

2893

2275

2894

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

2276

2895

if os.fork():

2277

2896

sys.exit()

2285

2904

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

2286

2905

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

2287

2906

raise OSError(errno.ENODEV,

2288

"{0} not a character device"

2907

"{} not a character device"

2289

2908

.format(os.devnull))

2290

2909

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

2291

2910

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

2295

2914

2296

2915

2297

2916

def main():

2298

2917

2299

2918

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

2300

2919

# Parsing of options, both command line and config file

2301

2920

2302

2921

parser = argparse.ArgumentParser()

2303

2922

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

2304

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

2923

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

2305

2924

help="show version number and exit")

2306

2925

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

2307

2926

help="Bind to interface IF")

2340

2959

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

2341

2960

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

2342

2961

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

2343

2962

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

2963

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

2964

default=None)

2965

2344

2966

options = parser.parse_args()

2345

2967

2346

2968

if options.check:

2347

2969

import doctest

2348

2970

fail_count, test_count = doctest.testmod()

2349

2971

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

2350

2972

2351

2973

# Default values for config file for server-global settings

2352

server_defaults = { "interface": "",

2353

"address": "",

2354

"port": "",

2355

"debug": "False",

2356

"priority":

2357

"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",

2358

"servicename": "Mandos",

2359

"use_dbus": "True",

2360

"use_ipv6": "True",

2361

"debuglevel": "",

2362

"restore": "True",

2363

"socket": "",

2364

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

2365

"foreground": "False",

2366

}

2367

2974

if gnutls.has_rawpk:

2975

priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"

2976

":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")

2977

else:

2978

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

2979

":+SIGN-DSA-SHA256")

2980

server_defaults = {"interface": "",

2981

"address": "",

2982

"port": "",

2983

"debug": "False",

2984

"priority": priority,

2985

"servicename": "Mandos",

2986

"use_dbus": "True",

2987

"use_ipv6": "True",

2988

"debuglevel": "",

2989

"restore": "True",

2990

"socket": "",

2991

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

2992

"foreground": "False",

2993

"zeroconf": "True",

2994

}

2995

del priority

2996

2368

2997

# Parse config file for server-global settings

2369

2998

server_config = configparser.SafeConfigParser(server_defaults)

2370

2999

del server_defaults

2371

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

2372

"mandos.conf"))

3000

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

2373

3001

# Convert the SafeConfigParser object to a dict

2374

3002

server_settings = server_config.defaults()

2375

3003

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

2376

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

3004

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

3005

"foreground", "zeroconf"):

2377

3006

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

2378

3007

option)

2379

3008

if server_settings["port"]:

2389

3018

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

2390

3019

["socket"])

2391

3020

del server_config

2392

3021

2393

3022

# Override the settings from the config file with command line

2394

3023

# options, if set.

2395

3024

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

2396

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

2397

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

2398

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

3025

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

3026

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

3027

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

2399

3028

value = getattr(options, option)

2400

3029

if value is not None:

2401

3030

server_settings[option] = value

2402

3031

del options

2403

3032

# Force all strings to be unicode

2404

3033

for option in server_settings.keys():

2405

if type(server_settings[option]) is str:

2406

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

3034

if isinstance(server_settings[option], bytes):

3035

server_settings[option] = (server_settings[option]

3036

.decode("utf-8"))

2407

3037

# Force all boolean options to be boolean

2408

3038

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

2409

"foreground"):

3039

"foreground", "zeroconf"):

2410

3040

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

2411

3041

# Debug implies foreground

2412

3042

if server_settings["debug"]:

2413

3043

server_settings["foreground"] = True

2414

3044

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

2415

3045

2416

3046

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

2417

3047

3048

if (not server_settings["zeroconf"]

3049

and not (server_settings["port"]

3050

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

3051

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

3052

2418

3053

# For convenience

2419

3054

debug = server_settings["debug"]

2420

3055

debuglevel = server_settings["debuglevel"]

2423

3058

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

2424

3059

stored_state_file)

2425

3060

foreground = server_settings["foreground"]

2426

3061

zeroconf = server_settings["zeroconf"]

3062

2427

3063

if debug:

2428

3064

initlogger(debug, logging.DEBUG)

2429

3065

else:

2432

3068

else:

2433

3069

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

2434

3070

initlogger(debug, level)

2435

3071

2436

3072

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

2437

syslogger.setFormatter(logging.Formatter

2438

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

2439

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

2440

.format(server_settings

2441

["servicename"])))

2442

3073

syslogger.setFormatter(

3074

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

3075

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

3076

server_settings["servicename"])))

3077

2443

3078

# Parse config file with clients

2444

3079

client_config = configparser.SafeConfigParser(Client

2445

3080

.client_defaults)

2446

3081

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

2447

3082

"clients.conf"))

2448

3083

2449

3084

global mandos_dbus_service

2450

3085

mandos_dbus_service = None

2451

2452

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

2453

server_settings["port"]),

2454

ClientHandler,

2455

interface=(server_settings["interface"]

2456

or None),

2457

use_ipv6=use_ipv6,

2458

gnutls_priority=

2459

server_settings["priority"],

2460

use_dbus=use_dbus,

2461

socketfd=(server_settings["socket"]

2462

or None))

3086

3087

socketfd = None

3088

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

3089

socketfd = server_settings["socket"]

3090

tcp_server = MandosServer(

3091

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

3092

ClientHandler,

3093

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

3094

use_ipv6=use_ipv6,

3095

gnutls_priority=server_settings["priority"],

3096

use_dbus=use_dbus,

3097

socketfd=socketfd)

2463

3098

if not foreground:

2464

3099

pidfilename = "/run/mandos.pid"

2465

3100

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

2466

3101

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

2467

3102

pidfile = None

2468

3103

try:

2469

pidfile = open(pidfilename, "w")

3104

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

2470

3105

except IOError as e:

2471

3106

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

2472

3107

exc_info=e)

2473

2474

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

3108

3109

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

3110

("mandos", "mandos"),

3111

("nobody", "nogroup")):

2475

3112

try:

2476

3113

uid = pwd.getpwnam(name).pw_uid

2477

gid = pwd.getpwnam(name).pw_gid

3114

gid = pwd.getpwnam(group).pw_gid

2478

3115

break

2479

3116

except KeyError:

2480

3117

continue

2484

3121

try:

2485

3122

os.setgid(gid)

2486

3123

os.setuid(uid)

3124

if debug:

3125

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

3126

gid))

2487

3127

except OSError as error:

3128

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

3129

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

2488

3130

if error.errno != errno.EPERM:

2489

3131

raise

2490

3132

2491

3133

if debug:

2492

3134

# Enable all possible GnuTLS debugging

2493

3135

2494

3136

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

2495

3137

# - GnuTLS manual

2496

gnutls.library.functions.gnutls_global_set_log_level(11)

2497

2498

@gnutls.library.types.gnutls_log_func

3138

gnutls.global_set_log_level(11)

3139

3140

@gnutls.log_func

2499

3141

def debug_gnutls(level, string):

2500

3142

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

2501

2502

(gnutls.library.functions

2503

.gnutls_global_set_log_function(debug_gnutls))

2504

3143

3144

gnutls.global_set_log_function(debug_gnutls)

3145

2505

3146

# Redirect stdin so all checkers get /dev/null

2506

3147

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

2507

3148

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

2508

3149

if null > 2:

2509

3150

os.close(null)

2510

3151

2511

3152

# Need to fork before connecting to D-Bus

2512

3153

if not foreground:

2513

3154

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

2514

3155

daemon()

2515

2516

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

2517

# need to inform gobject that threads will be used.

2518

gobject.threads_init()

2519

3156

3157

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

3158

# to inform GLib that threads will be used.

3159

GLib.threads_init()

3160

2520

3161

global main_loop

2521

3162

# From the Avahi example code

2522

3163

DBusGMainLoop(set_as_default=True)

2523

main_loop = gobject.MainLoop()

3164

main_loop = GLib.MainLoop()

2524

3165

bus = dbus.SystemBus()

2525

3166

# End of Avahi example code

2526

3167

if use_dbus:

2527

3168

try:

2528

3169

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

2529

bus, do_not_queue=True)

2530

old_bus_name = (dbus.service.BusName

2531

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

2532

do_not_queue=True))

2533

except dbus.exceptions.NameExistsException as e:

3170

bus,

3171

do_not_queue=True)

3172

old_bus_name = dbus.service.BusName(

3173

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

3174

do_not_queue=True)

3175

except dbus.exceptions.DBusException as e:

2534

3176

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

2535

3177

use_dbus = False

2536

3178

server_settings["use_dbus"] = False

2537

3179

tcp_server.use_dbus = False

2538

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2539

service = AvahiServiceToSyslog(name =

2540

server_settings["servicename"],

2541

servicetype = "_mandos._tcp",

2542

protocol = protocol, bus = bus)

2543

if server_settings["interface"]:

2544

service.interface = (if_nametoindex

2545

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

2546

3180

if zeroconf:

3181

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3182

service = AvahiServiceToSyslog(

3183

name=server_settings["servicename"],

3184

servicetype="_mandos._tcp",

3185

protocol=protocol,

3186

bus=bus)

3187

if server_settings["interface"]:

3188

service.interface = if_nametoindex(

3189

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

3190

2547

3191

global multiprocessing_manager

2548

3192

multiprocessing_manager = multiprocessing.Manager()

2549

3193

2550

3194

client_class = Client

2551

3195

if use_dbus:

2552

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

2553

3196

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

3197

2554

3198

client_settings = Client.config_parser(client_config)

2555

3199

old_client_settings = {}

2556

3200

clients_data = {}

2557

3201

2558

3202

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

2559

3203

global wnull

2560

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

3204

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

2561

3205

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

2562

3206

# mode

2563

3207

if debug or not foreground:

2564

3208

wnull.close()

2565

3209

2566

3210

# Get client data and settings from last running state.

2567

3211

if server_settings["restore"]:

2568

3212

try:

2569

3213

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

2570

clients_data, old_client_settings = (pickle.load

2571

(stored_state))

3214

if sys.version_info.major == 2:

3215

clients_data, old_client_settings = pickle.load(

3216

stored_state)

3217

else:

3218

bytes_clients_data, bytes_old_client_settings = (

3219

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

3220

# Fix bytes to strings

3221

# clients_data

3222

# .keys()

3223

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

3224

if isinstance(key, bytes)

3225

else key): value

3226

for key, value in

3227

bytes_clients_data.items()}

3228

del bytes_clients_data

3229

for key in clients_data:

3230

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

3231

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

3232

for k, v in

3233

clients_data[key].items()}

3234

clients_data[key] = value

3235

# .client_structure

3236

value["client_structure"] = [

3237

(s.decode("utf-8")

3238

if isinstance(s, bytes)

3239

else s) for s in

3240

value["client_structure"]]

3241

# .name & .host

3242

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

3243

if isinstance(value[k], bytes):

3244

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

3245

if not value.has_key("key_id"):

3246

value["key_id"] = ""

3247

elif not value.has_key("fingerprint"):

3248

value["fingerprint"] = ""

3249

# old_client_settings

3250

# .keys()

3251

old_client_settings = {

3252

(key.decode("utf-8")

3253

if isinstance(key, bytes)

3254

else key): value

3255

for key, value in

3256

bytes_old_client_settings.items()}

3257

del bytes_old_client_settings

3258

# .host

3259

for value in old_client_settings.values():

3260

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

3261

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

3262

.decode("utf-8"))

2572

3263

os.remove(stored_state_path)

2573

3264

except IOError as e:

2574

3265

if e.errno == errno.ENOENT:

2575

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

2576

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

3266

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

3267

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

2577

3268

else:

2578

3269

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

2579

3270

exc_info=e)

2580

3271

raise

2581

3272

except EOFError as e:

2582

3273

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

2583

"EOFError:", exc_info=e)

2584

3274

"EOFError:",

3275

exc_info=e)

3276

2585

3277

with PGPEngine() as pgp:

2586

for client_name, client in clients_data.iteritems():

3278

for client_name, client in clients_data.items():

2587

3279

# Skip removed clients

2588

3280

if client_name not in client_settings:

2589

3281

continue

2590

3282

2591

3283

# Decide which value to use after restoring saved state.

2592

3284

# We have three different values: Old config file,

2593

3285

# new config file, and saved state.

2598

3290

# For each value in new config, check if it

2599

3291

# differs from the old config value (Except for

2600

3292

# the "secret" attribute)

2601

if (name != "secret" and

2602

value != old_client_settings[client_name]

2603

[name]):

3293

if (name != "secret"

3294

and (value !=

3295

old_client_settings[client_name][name])):

2604

3296

client[name] = value

2605

3297

except KeyError:

2606

3298

pass

2607

3299

2608

3300

# Clients who has passed its expire date can still be

2609

# enabled if its last checker was successful. Clients

3301

# enabled if its last checker was successful. A Client

2610

3302

# whose checker succeeded before we stored its state is

2611

3303

# assumed to have successfully run all checkers during

2612

3304

# downtime.

2614

3306

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

2615

3307

if not client["last_checked_ok"]:

2616

3308

logger.warning(

2617

"disabling client {0} - Client never "

2618

"performed a successful checker"

2619

.format(client_name))

3309

"disabling client {} - Client never "

3310

"performed a successful checker".format(

3311

client_name))

2620

3312

client["enabled"] = False

2621

3313

elif client["last_checker_status"] != 0:

2622

3314

logger.warning(

2623

"disabling client {0} - Client "

2624

"last checker failed with error code {1}"

2625

.format(client_name,

2626

client["last_checker_status"]))

3315

"disabling client {} - Client last"

3316

" checker failed with error code"

3317

" {}".format(

3318

client_name,

3319

client["last_checker_status"]))

2627

3320

client["enabled"] = False

2628

3321

else:

2629

client["expires"] = (datetime.datetime

2630

.utcnow()

2631

+ client["timeout"])

3322

client["expires"] = (

3323

datetime.datetime.utcnow()

3324

+ client["timeout"])

2632

3325

logger.debug("Last checker succeeded,"

2633

" keeping {0} enabled"

2634

.format(client_name))

3326

" keeping {} enabled".format(

3327

client_name))

2635

3328

try:

2636

client["secret"] = (

2637

pgp.decrypt(client["encrypted_secret"],

2638

client_settings[client_name]

2639

["secret"]))

3329

client["secret"] = pgp.decrypt(

3330

client["encrypted_secret"],

3331

client_settings[client_name]["secret"])

2640

3332

except PGPError:

2641

3333

# If decryption fails, we use secret from new settings

2642

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

2643

.format(client_name))

2644

client["secret"] = (

2645

client_settings[client_name]["secret"])

2646

3334

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

3335

client_name))

3336

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

3337

["secret"])

3338

2647

3339

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

2648

3340

for client_name in (set(old_client_settings)

2649

3341

- set(client_settings)):

2651

3343

for client_name in (set(client_settings)

2652

3344

- set(old_client_settings)):

2653

3345

clients_data[client_name] = client_settings[client_name]

2654

3346

2655

3347

# Create all client objects

2656

for client_name, client in clients_data.iteritems():

3348

for client_name, client in clients_data.items():

2657

3349

tcp_server.clients[client_name] = client_class(

2658

name = client_name, settings = client,

2659

server_settings = server_settings)

2660

3350

name=client_name,

3351

settings=client,

3352

server_settings=server_settings)

3353

2661

3354

if not tcp_server.clients:

2662

3355

logger.warning("No clients defined")

2663

3356

2664

3357

if not foreground:

2665

3358

if pidfile is not None:

3359

pid = os.getpid()

2666

3360

try:

2667

3361

with pidfile:

2668

pid = os.getpid()

2669

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

3362

print(pid, file=pidfile)

2670

3363

except IOError:

2671

3364

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

2672

3365

pidfilename, pid)

2673

3366

del pidfile

2674

3367

del pidfilename

2675

2676

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

2677

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

2678

3368

3369

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

3370

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3371

lambda: main_loop.quit() and False)

3372

2679

3373

if use_dbus:

2680

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

2681

"se.bsnet.fukt.Mandos"})

2682

class MandosDBusService(DBusObjectWithProperties):

3374

3375

@alternate_dbus_interfaces(

3376

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

3377

class MandosDBusService(DBusObjectWithObjectManager):

2683

3378

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

3379

2684

3380

def __init__(self):

2685

3381

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

3382

2686

3383

_interface = "se.recompile.Mandos"

2687

2688

@dbus_interface_annotations(_interface)

2689

def _foo(self):

2690

return { "org.freedesktop.DBus.Property"

2691

".EmitsChangedSignal":

2692

"false"}

2693

3384

2694

3385

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

2695

3386

def ClientAdded(self, objpath):

2696

3387

"D-Bus signal"

2697

3388

pass

2698

3389

2699

3390

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

2700

def ClientNotFound(self, fingerprint, address):

3391

def ClientNotFound(self, key_id, address):

2701

3392

"D-Bus signal"

2702

3393

pass

2703

3394

3395

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

3396

"true"})

2704

3397

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

2705

3398

def ClientRemoved(self, objpath, name):

2706

3399

"D-Bus signal"

2707

3400

pass

2708

3401

3402

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

3403

"true"})

2709

3404

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

2710

3405

def GetAllClients(self):

2711

3406

"D-Bus method"

2712

return dbus.Array(c.dbus_object_path

2713

for c in

2714

tcp_server.clients.itervalues())

2715

3407

return dbus.Array(c.dbus_object_path for c in

3408

tcp_server.clients.values())

3409

3410

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

3411

"true"})

2716

3412

@dbus.service.method(_interface,

2717

3413

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

2718

3414

def GetAllClientsWithProperties(self):

2719

3415

"D-Bus method"

2720

3416

return dbus.Dictionary(

2721

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

2722

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

3417

{c.dbus_object_path: c.GetAll(

3418

"se.recompile.Mandos.Client")

3419

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

2723

3420

signature="oa{sv}")

2724

3421

2725

3422

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

2726

3423

def RemoveClient(self, object_path):

2727

3424

"D-Bus method"

2728

for c in tcp_server.clients.itervalues():

3425

for c in tcp_server.clients.values():

2729

3426

if c.dbus_object_path == object_path:

2730

3427

del tcp_server.clients[c.name]

2731

3428

c.remove_from_connection()

2732

# Don't signal anything except ClientRemoved

3429

# Don't signal the disabling

2733

3430

c.disable(quiet=True)

2734

# Emit D-Bus signal

2735

self.ClientRemoved(object_path, c.name)

3431

# Emit D-Bus signal for removal

3432

self.client_removed_signal(c)

2736

3433

return

2737

3434

raise KeyError(object_path)

2738

3435

2739

3436

del _interface

2740

3437

3438

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3439

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

3440

def GetManagedObjects(self):

3441

"""D-Bus method"""

3442

return dbus.Dictionary(

3443

{client.dbus_object_path:

3444

dbus.Dictionary(

3445

{interface: client.GetAll(interface)

3446

for interface in

3447

client._get_all_interface_names()})

3448

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

3449

3450

def client_added_signal(self, client):

3451

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

3452

if use_dbus:

3453

# New standard signal

3454

self.InterfacesAdded(

3455

client.dbus_object_path,

3456

dbus.Dictionary(

3457

{interface: client.GetAll(interface)

3458

for interface in

3459

client._get_all_interface_names()}))

3460

# Old signal

3461

self.ClientAdded(client.dbus_object_path)

3462

3463

def client_removed_signal(self, client):

3464

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

3465

if use_dbus:

3466

# New standard signal

3467

self.InterfacesRemoved(

3468

client.dbus_object_path,

3469

client._get_all_interface_names())

3470

# Old signal

3471

self.ClientRemoved(client.dbus_object_path,

3472

client.name)

3473

2741

3474

mandos_dbus_service = MandosDBusService()

2742

3475

3476

# Save modules to variables to exempt the modules from being

3477

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

3478

mp = multiprocessing

3479

wn = wnull

3480

2743

3481

def cleanup():

2744

3482

"Cleanup function; run on exit"

2745

service.cleanup()

2746

2747

multiprocessing.active_children()

2748

wnull.close()

3483

if zeroconf:

3484

service.cleanup()

3485

3486

mp.active_children()

3487

wn.close()

2749

3488

if not (tcp_server.clients or client_settings):

2750

3489

return

2751

3490

2752

3491

# Store client before exiting. Secrets are encrypted with key

2753

3492

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

2754

3493

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

2755

3494

clients = {}

2756

3495

with PGPEngine() as pgp:

2757

for client in tcp_server.clients.itervalues():

3496

for client in tcp_server.clients.values():

2758

3497

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

2759

3498

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

2760

3499

key)

2761

3500

client_dict = {}

2762

3501

2763

3502

# A list of attributes that can not be pickled

2764

3503

# + secret.

2765

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

2766

"checker", "server_settings"))

2767

for name, typ in (inspect.getmembers

2768

(dbus.service.Object)):

3504

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

3505

"checker", "server_settings"}

3506

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

3507

.Object):

2769

3508

exclude.add(name)

2770

3509

2771

3510

client_dict["encrypted_secret"] = (client

2772

3511

.encrypted_secret)

2773

3512

for attr in client.client_structure:

2774

3513

if attr not in exclude:

2775

3514

client_dict[attr] = getattr(client, attr)

2776

3515

2777

3516

clients[client.name] = client_dict

2778

3517

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

2779

3518

2780

3519

try:

2781

with (tempfile.NamedTemporaryFile

2782

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

2783

dir=os.path.dirname(stored_state_path),

2784

delete=False)) as stored_state:

2785

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

2786

tempname=stored_state.name

3520

with tempfile.NamedTemporaryFile(

3521

mode='wb',

3522

suffix=".pickle",

3523

prefix='clients-',

3524

dir=os.path.dirname(stored_state_path),

3525

delete=False) as stored_state:

3526

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

3527

protocol=2)

3528

tempname = stored_state.name

2787

3529

os.rename(tempname, stored_state_path)

2788

3530

except (IOError, OSError) as e:

2789

3531

if not debug:

2792

3534

except NameError:

2793

3535

pass

2794

3536

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

2795

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

3537

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

2796

3538

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

2797

3539

else:

2798

3540

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

2799

3541

exc_info=e)

2800

3542

raise

2801

3543

2802

3544

# Delete all clients, and settings from config

2803

3545

while tcp_server.clients:

2804

3546

name, client = tcp_server.clients.popitem()

2805

3547

if use_dbus:

2806

3548

client.remove_from_connection()

2807

# Don't signal anything except ClientRemoved

3549

# Don't signal the disabling

2808

3550

client.disable(quiet=True)

3551

# Emit D-Bus signal for removal

2809

3552

if use_dbus:

2810

# Emit D-Bus signal

2811

mandos_dbus_service.ClientRemoved(client

2812

.dbus_object_path,

2813

client.name)

3553

mandos_dbus_service.client_removed_signal(client)

2814

3554

client_settings.clear()

2815

3555

2816

3556

atexit.register(cleanup)

2817

2818

for client in tcp_server.clients.itervalues():

3557

3558

for client in tcp_server.clients.values():

2819

3559

if use_dbus:

2820

# Emit D-Bus signal

2821

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3560

# Emit D-Bus signal for adding

3561

mandos_dbus_service.client_added_signal(client)

2822

3562

# Need to initiate checking of clients

2823

3563

if client.enabled:

2824

3564

client.init_checker()

2825

3565

2826

3566

tcp_server.enable()

2827

3567

tcp_server.server_activate()

2828

3568

2829

3569

# Find out what port we got

2830

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

3570

if zeroconf:

3571

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

2831

3572

if use_ipv6:

2832

3573

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

2833

3574

" flowinfo %d, scope_id %d",

2835

3576

else: # IPv4

2836

3577

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

2837

3578

*tcp_server.socket.getsockname())

2838

2839

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

2840

3579

3580

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

3581

2841

3582

try:

2842

# From the Avahi example code

2843

try:

2844

service.activate()

2845

except dbus.exceptions.DBusException as error:

2846

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

2847

cleanup()

2848

sys.exit(1)

2849

# End of Avahi example code

2850

2851

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

2852

lambda *args, **kwargs:

2853

(tcp_server.handle_request

2854

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

2855

3583

if zeroconf:

3584

# From the Avahi example code

3585

try:

3586

service.activate()

3587

except dbus.exceptions.DBusException as error:

3588

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

3589

cleanup()

3590

sys.exit(1)

3591

# End of Avahi example code

3592

3593

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

3594

lambda *args, **kwargs:

3595

(tcp_server.handle_request

3596

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

3597

2856

3598

logger.debug("Starting main loop")

2857

3599

main_loop.run()

2858

3600

except AvahiError as error:

2867

3609

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

2868

3610

cleanup()

2869

3611

3612

2870

3613

if __name__ == '__main__':

2871

3614

main()