/mandos/trunk : revision 1106

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

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

92

119

stored_state_file = "clients.pickle"

93

120

94

121

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

122

syslogger = None

98

123

99

124

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

103

127

except (OSError, AttributeError):

128

104

129

def if_nametoindex(interface):

105

130

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

106

131

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

107

132

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

108

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

134

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

135

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

113

136

return interface_index

114

137

115

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

116

155

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

117

156

"""init logger and add loglevel"""

118

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

119

162

syslogger.setFormatter(logging.Formatter

120

163

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

121

164

' %(message)s'))

122

165

logger.addHandler(syslogger)

123

166

124

167

if debug:

125

168

console = logging.StreamHandler()

126

169

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

138

181

139

182

class PGPEngine(object):

140

183

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

184

141

185

def __init__(self):

142

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

143

198

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

199

'--homedir', self.tempdir,

145

200

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

148

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

149

206

def __enter__(self):

150

207

return self

151

208

152

209

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

153

210

self._cleanup()

154

211

return False

155

212

156

213

def __del__(self):

157

214

self._cleanup()

158

215

159

216

def _cleanup(self):

160

217

if self.tempdir is not None:

161

218

# Delete contents of tempdir

162

219

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

163

topdown = False):

220

topdown=False):

164

221

for filename in files:

165

222

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

166

223

for dirname in dirs:

168

225

# Remove tempdir

169

226

os.rmdir(self.tempdir)

170

227

self.tempdir = None

171

228

172

229

def password_encode(self, password):

173

230

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

174

231

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

179

236

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

180

237

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

181

238

return encoded

182

239

183

240

def encrypt(self, data, password):

184

241

passphrase = self.password_encode(password)

185

with tempfile.NamedTemporaryFile(dir=self.tempdir

186

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

187

244

passfile.write(passphrase)

188

245

passfile.flush()

189

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

246

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

190

247

'--passphrase-file',

191

248

passfile.name]

192

249

+ self.gnupgargs,

193

stdin = subprocess.PIPE,

194

stdout = subprocess.PIPE,

195

stderr = subprocess.PIPE)

196

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)

197

254

if proc.returncode != 0:

198

255

raise PGPError(err)

199

256

return ciphertext

200

257

201

258

def decrypt(self, data, password):

202

259

passphrase = self.password_encode(password)

203

with tempfile.NamedTemporaryFile(dir = self.tempdir

204

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

205

262

passfile.write(passphrase)

206

263

passfile.flush()

207

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

264

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

208

265

'--passphrase-file',

209

266

passfile.name]

210

267

+ self.gnupgargs,

211

stdin = subprocess.PIPE,

212

stdout = subprocess.PIPE,

213

stderr = subprocess.PIPE)

214

decrypted_plaintext, err = proc.communicate(input

215

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

216

272

if proc.returncode != 0:

217

273

raise PGPError(err)

218

274

return decrypted_plaintext

219

275

220

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

221

303

class AvahiError(Exception):

222

304

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

223

305

self.value = value

224

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

225

def __unicode__(self):

226

return unicode(repr(self.value))

306

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

307

**kwargs)

308

227

309

228

310

class AvahiServiceError(AvahiError):

229

311

pass

230

312

313

231

314

class AvahiGroupError(AvahiError):

232

315

pass

233

316

234

317

235

318

class AvahiService(object):

236

319

"""An Avahi (Zeroconf) service.

237

320

238

321

Attributes:

239

322

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

240

323

Used to optionally bind to the specified interface.

252

335

server: D-Bus Server

253

336

bus: dbus.SystemBus()

254

337

"""

255

256

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

257

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

258

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

259

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

260

350

self.interface = interface

261

351

self.name = name

262

352

self.type = servicetype

271

361

self.server = None

272

362

self.bus = bus

273

363

self.entry_group_state_changed_match = None

274

275

def rename(self):

364

365

def rename(self, remove=True):

276

366

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

277

367

if self.rename_count >= self.max_renames:

278

368

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

279

369

" after %i retries, exiting.",

280

370

self.rename_count)

281

371

raise AvahiServiceError("Too many renames")

282

self.name = unicode(self.server

283

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

284

375

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

285

376

self.name)

286

self.remove()

377

if remove:

378

self.remove()

287

379

try:

288

380

self.add()

289

381

except dbus.exceptions.DBusException as error:

290

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

291

self.cleanup()

292

os._exit(1)

293

self.rename_count += 1

294

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

295

391

def remove(self):

296

392

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

297

393

if self.entry_group_state_changed_match is not None:

299

395

self.entry_group_state_changed_match = None

300

396

if self.group is not None:

301

397

self.group.Reset()

302

398

303

399

def add(self):

304

400

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

305

401

self.remove()

322

418

dbus.UInt16(self.port),

323

419

avahi.string_array_to_txt_array(self.TXT))

324

420

self.group.Commit()

325

421

326

422

def entry_group_state_changed(self, state, error):

327

423

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

328

424

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

329

425

330

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

331

427

logger.debug("Zeroconf service established.")

332

428

elif state == avahi.ENTRY_GROUP_COLLISION:

334

430

self.rename()

335

431

elif state == avahi.ENTRY_GROUP_FAILURE:

336

432

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

337

unicode(error))

338

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

339

.format(error))

340

433

str(error))

434

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

435

341

436

def cleanup(self):

342

437

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

343

438

if self.group is not None:

348

443

pass

349

444

self.group = None

350

445

self.remove()

351

446

352

447

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

353

448

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

354

449

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

355

bad_states = { avahi.SERVER_INVALID:

356

"Zeroconf server invalid",

357

avahi.SERVER_REGISTERING: None,

358

avahi.SERVER_COLLISION:

359

"Zeroconf server name collision",

360

avahi.SERVER_FAILURE:

361

"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

}

362

456

if state in bad_states:

363

457

if bad_states[state] is not None:

364

458

if error is None:

367

461

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

368

462

self.cleanup()

369

463

elif state == avahi.SERVER_RUNNING:

370

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)

371

476

else:

372

477

if error is None:

373

478

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

374

479

else:

375

480

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

376

481

377

482

def activate(self):

378

483

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

379

484

if self.server is None:

383

488

follow_name_owner_changes=True),

384

489

avahi.DBUS_INTERFACE_SERVER)

385

490

self.server.connect_to_signal("StateChanged",

386

self.server_state_changed)

491

self.server_state_changed)

387

492

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

388

493

389

494

390

495

class AvahiServiceToSyslog(AvahiService):

391

def rename(self):

496

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

392

497

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

393

ret = AvahiService.rename(self)

394

syslogger.setFormatter(logging.Formatter

395

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

396

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

397

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

398

502

return ret

399

503

400

504

401

def timedelta_to_milliseconds(td):

402

"Convert a datetime.timedelta() to milliseconds"

403

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

404

+ (td.seconds * 1000)

405

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

406

815

407

816

408

817

class Client(object):

409

818

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

410

819

411

820

Attributes:

412

821

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

413

822

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

415

824

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

416

825

to see if the client lives.

417

826

'None' if no process is running.

418

checker_callback_tag: a gobject event source tag, or None

827

checker_callback_tag: a GLib event source tag, or None

419

828

checker_command: string; External command which is run to check

420

829

if client lives. %() expansions are done at

421

830

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

422

831

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

423

checker_initiator_tag: a gobject event source tag, or None

832

checker_initiator_tag: a GLib event source tag, or None

424

833

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

425

834

client_structure: Object describing what attributes a client has

426

835

and is used for storing the client at exit

427

836

current_checker_command: string; current running checker_command

428

disable_initiator_tag: a gobject event source tag, or None

837

disable_initiator_tag: a GLib event source tag, or None

429

838

enabled: bool()

430

839

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

431

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

432

843

host: string; available for use by the checker command

433

844

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

434

845

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

436

847

last_checker_status: integer between 0 and 255 reflecting exit

437

848

status of last checker. -1 reflects crashed

438

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

439

852

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

440

853

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

441

854

D-Bus identifiers

448

861

disabled, or None

449

862

server_settings: The server_settings dict from main()

450

863

"""

451

864

452

865

runtime_expansions = ("approval_delay", "approval_duration",

453

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

866

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

454

867

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

455

868

"last_approval_request", "last_checked_ok",

456

869

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

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

460

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

461

"host": "",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

464

"approved_by_default": "True",

465

"enabled": "True",

466

}

467

468

def timeout_milliseconds(self):

469

"Return the 'timeout' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.timeout)

471

472

def extended_timeout_milliseconds(self):

473

"Return the 'extended_timeout' attribute in milliseconds"

474

return timedelta_to_milliseconds(self.extended_timeout)

475

476

def interval_milliseconds(self):

477

"Return the 'interval' attribute in milliseconds"

478

return timedelta_to_milliseconds(self.interval)

479

480

def approval_delay_milliseconds(self):

481

return timedelta_to_milliseconds(self.approval_delay)

482

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

483

882

@staticmethod

484

883

def config_parser(config):

485

884

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

492

891

for client_name in config.sections():

493

892

section = dict(config.items(client_name))

494

893

client = settings[client_name] = {}

495

894

496

895

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

497

896

# Reformat values from string types to Python types

498

897

client["approved_by_default"] = config.getboolean(

499

898

client_name, "approved_by_default")

500

899

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

501

900

"enabled")

502

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

503

907

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

504

908

.replace(" ", ""))

505

909

if "secret" in section:

506

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

910

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

911

.encode("utf-8"),

912

"base64")

507

913

elif "secfile" in section:

508

914

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

509

915

(section["secfile"])),

510

916

"rb") as secfile:

511

917

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

512

918

else:

513

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

919

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

514

920

.format(section))

515

921

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

516

922

client["extended_timeout"] = string_to_delta(

524

930

client["last_approval_request"] = None

525

931

client["last_checked_ok"] = None

526

932

client["last_checker_status"] = -2

527

933

528

934

return settings

529

530

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

935

936

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

531

937

self.name = name

532

938

if server_settings is None:

533

939

server_settings = {}

534

940

self.server_settings = server_settings

535

941

# adding all client settings

536

for setting, value in settings.iteritems():

942

for setting, value in settings.items():

537

943

setattr(self, setting, value)

538

944

539

945

if self.enabled:

540

946

if not hasattr(self, "last_enabled"):

541

947

self.last_enabled = datetime.datetime.utcnow()

545

951

else:

546

952

self.last_enabled = None

547

953

self.expires = None

548

954

549

955

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

550

# Uppercase and remove spaces from fingerprint for later

551

# comparison purposes with return value from the fingerprint()

552

# function

956

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

553

957

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

554

958

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

555

959

datetime.datetime.utcnow())

556

960

557

961

# attributes specific for this server instance

558

962

self.checker = None

559

963

self.checker_initiator_tag = None

562

966

self.current_checker_command = None

563

967

self.approved = None

564

968

self.approvals_pending = 0

565

self.changedstate = (multiprocessing_manager

566

.Condition(multiprocessing_manager

567

.Lock()))

568

self.client_structure = [attr for attr in

569

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

570

973

if not attr.startswith("_")]

571

974

self.client_structure.append("client_structure")

572

573

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

574

lambda obj:

575

isinstance(obj,

576

property)):

975

976

for name, t in inspect.getmembers(

977

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

577

978

if not name.startswith("_"):

578

979

self.client_structure.append(name)

579

980

580

981

# Send notice to process children that client state has changed

581

982

def send_changedstate(self):

582

983

with self.changedstate:

583

984

self.changedstate.notify_all()

584

985

585

986

def enable(self):

586

987

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

587

988

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

592

993

self.last_enabled = datetime.datetime.utcnow()

593

994

self.init_checker()

594

995

self.send_changedstate()

595

996

596

997

def disable(self, quiet=True):

597

998

"""Disable this client."""

598

999

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

600

1001

if not quiet:

601

1002

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

602

1003

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

603

gobject.source_remove(self.disable_initiator_tag)

1004

GLib.source_remove(self.disable_initiator_tag)

604

1005

self.disable_initiator_tag = None

605

1006

self.expires = None

606

1007

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

607

gobject.source_remove(self.checker_initiator_tag)

1008

GLib.source_remove(self.checker_initiator_tag)

608

1009

self.checker_initiator_tag = None

609

1010

self.stop_checker()

610

1011

self.enabled = False

611

1012

if not quiet:

612

1013

self.send_changedstate()

613

# 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

614

1015

return False

615

1016

616

1017

def __del__(self):

617

1018

self.disable()

618

1019

619

1020

def init_checker(self):

620

1021

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

621

1022

# and every interval from then on.

622

1023

if self.checker_initiator_tag is not None:

623

gobject.source_remove(self.checker_initiator_tag)

624

self.checker_initiator_tag = (gobject.timeout_add

625

(self.interval_milliseconds(),

626

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)

627

1028

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

628

1029

if self.disable_initiator_tag is not None:

629

gobject.source_remove(self.disable_initiator_tag)

630

self.disable_initiator_tag = (gobject.timeout_add

631

(self.timeout_milliseconds(),

632

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)

633

1033

# Also start a new checker *right now*.

634

1034

self.start_checker()

635

636

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

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

637

1038

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

638

1039

self.checker_callback_tag = None

639

1040

self.checker = None

640

if os.WIFEXITED(condition):

641

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

642

1048

if self.last_checker_status == 0:

643

1049

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

644

1050

vars(self))

645

1051

self.checked_ok()

646

1052

else:

647

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

648

vars(self))

1053

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

649

1054

else:

650

1055

self.last_checker_status = -1

1056

self.last_checker_signal = -returncode

651

1057

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

652

1058

vars(self))

653

1059

return False

1060

654

1061

def checked_ok(self):

655

1062

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

656

1063

self.last_checked_ok = datetime.datetime.utcnow()

657

1064

self.last_checker_status = 0

1065

self.last_checker_signal = None

658

1066

self.bump_timeout()

659

1067

660

1068

def bump_timeout(self, timeout=None):

661

1069

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

662

1070

if timeout is None:

663

1071

timeout = self.timeout

664

1072

if self.disable_initiator_tag is not None:

665

gobject.source_remove(self.disable_initiator_tag)

1073

GLib.source_remove(self.disable_initiator_tag)

666

1074

self.disable_initiator_tag = None

667

1075

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

668

self.disable_initiator_tag = (gobject.timeout_add

669

(timedelta_to_milliseconds

670

(timeout), self.disable))

1076

self.disable_initiator_tag = GLib.timeout_add(

1077

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

671

1078

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

672

1079

673

1080

def need_approval(self):

674

1081

self.last_approval_request = datetime.datetime.utcnow()

675

1082

676

1083

def start_checker(self):

677

1084

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

678

1085

679

1086

If a checker already exists, leave it running and do

680

1087

nothing."""

681

1088

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

686

1093

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

687

1094

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

688

1095

# should be.

689

690

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

691

try:

692

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

693

except (AttributeError, OSError) as error:

694

if (isinstance(error, OSError)

695

and error.errno != errno.ECHILD):

696

raise error

697

else:

698

if pid:

699

logger.warning("Checker was a zombie")

700

gobject.source_remove(self.checker_callback_tag)

701

self.checker_callback(pid, status,

702

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

703

1101

# Start a new checker if needed

704

1102

if self.checker is None:

705

1103

# Escape attributes for the shell

706

escaped_attrs = dict(

707

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

708

for attr in

709

self.runtime_expansions)

1104

escaped_attrs = {

1105

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

1106

for attr in self.runtime_expansions}

710

1107

try:

711

1108

command = self.checker_command % escaped_attrs

712

1109

except TypeError as error:

713

1110

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

714

self.checker_command, exc_info=error)

715

return True # Try again later

1111

self.checker_command,

1112

exc_info=error)

1113

return True # Try again later

716

1114

self.current_checker_command = command

717

try:

718

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

719

command, self.name)

720

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

721

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

722

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

723

# always replaced by /dev/null.)

724

# The exception is when not debugging but nevertheless

725

# running in the foreground; use the previously

726

# created wnull.

727

popen_args = {}

728

if (not self.server_settings["debug"]

729

and self.server_settings["foreground"]):

730

popen_args.update({"stdout": wnull,

731

"stderr": wnull })

732

self.checker = subprocess.Popen(command,

733

close_fds=True,

734

shell=True, cwd="/",

735

**popen_args)

736

except OSError as error:

737

logger.error("Failed to start subprocess",

738

exc_info=error)

739

return True

740

self.checker_callback_tag = (gobject.child_watch_add

741

(self.checker.pid,

742

self.checker_callback,

743

data=command))

744

# The checker may have completed before the gobject

745

# watch was added. Check for this.

746

try:

747

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

748

except OSError as error:

749

if error.errno == errno.ECHILD:

750

# This should never happen

751

logger.error("Child process vanished",

752

exc_info=error)

753

return True

754

raise

755

if pid:

756

gobject.source_remove(self.checker_callback_tag)

757

self.checker_callback(pid, status, command)

758

# 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

759

1141

return True

760

1142

761

1143

def stop_checker(self):

762

1144

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

763

1145

if self.checker_callback_tag:

764

gobject.source_remove(self.checker_callback_tag)

1146

GLib.source_remove(self.checker_callback_tag)

765

1147

self.checker_callback_tag = None

766

1148

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

767

1149

return

768

1150

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

769

try:

770

self.checker.terminate()

771

#time.sleep(0.5)

772

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

773

# self.checker.kill()

774

except OSError as error:

775

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

776

raise

1151

self.checker.terminate()

777

1152

self.checker = None

778

1153

779

1154

780

def dbus_service_property(dbus_interface, signature="v",

781

access="readwrite", byte_arrays=False):

1155

def dbus_service_property(dbus_interface,

1156

signature="v",

1157

access="readwrite",

1158

byte_arrays=False):

782

1159

"""Decorators for marking methods of a DBusObjectWithProperties to

783

1160

become properties on the D-Bus.

784

1161

785

1162

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

786

1163

and with one argument by "Set".

787

1164

788

1165

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

789

1166

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

790

1167

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

793

1170

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

794

1171

if byte_arrays and signature != "ay":

795

1172

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

796

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

1173

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

1174

797

1175

def decorator(func):

798

1176

func._dbus_is_property = True

799

1177

func._dbus_interface = dbus_interface

802

1180

func._dbus_name = func.__name__

803

1181

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

804

1182

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

805

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1183

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

806

1184

return func

1185

807

1186

return decorator

808

1187

809

1188

810

1189

def dbus_interface_annotations(dbus_interface):

811

1190

"""Decorator for marking functions returning interface annotations

812

1191

813

1192

Usage:

814

1193

815

1194

@dbus_interface_annotations("org.example.Interface")

816

1195

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

817

1196

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

818

1197

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

819

1198

"false"}

820

1199

"""

1200

821

1201

def decorator(func):

822

1202

func._dbus_is_interface = True

823

1203

func._dbus_interface = dbus_interface

824

1204

func._dbus_name = dbus_interface

825

1205

return func

1206

826

1207

return decorator

827

1208

828

1209

829

1210

def dbus_annotations(annotations):

830

1211

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

831

1212

Usage:

832

1213

1214

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

1215

"org.freedesktop.DBus.Property."

1216

"EmitsChangedSignal": "false"})

833

1217

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

834

1218

access="r")

835

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

836

"org.freedesktop.DBus.Property."

837

"EmitsChangedSignal": "false"})

838

1219

def Property_dbus_property(self):

839

1220

return dbus.Boolean(False)

1221

1222

See also the DBusObjectWithAnnotations class.

840

1223

"""

1224

841

1225

def decorator(func):

842

1226

func._dbus_annotations = annotations

843

1227

return func

1228

844

1229

return decorator

845

1230

846

1231

847

1232

class DBusPropertyException(dbus.exceptions.DBusException):

848

1233

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

849

1234

"""

850

def __unicode__(self):

851

return unicode(str(self))

1235

pass

852

1236

853

1237

854

1238

class DBusPropertyAccessException(DBusPropertyException):

863

1247

pass

864

1248

865

1249

866

class DBusObjectWithProperties(dbus.service.Object):

867

"""A D-Bus object with properties.

868

869

Classes inheriting from this can use the dbus_service_property

870

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

871

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.

872

1255

"""

873

1256

874

1257

@staticmethod

875

1258

def _is_dbus_thing(thing):

876

1259

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

877

1260

878

1261

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

879

1262

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

880

1263

"""

881

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

1264

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

882

1265

False)

883

1266

884

1267

def _get_all_dbus_things(self, thing):

885

1268

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

886

1269

"""

887

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

888

name),

1270

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

889

1271

athing.__get__(self))

890

1272

for cls in self.__class__.__mro__

891

1273

for name, athing in

892

inspect.getmembers(cls,

893

self._is_dbus_thing(thing)))

894

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

895

1347

def _get_dbus_property(self, interface_name, property_name):

896

1348

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

897

1349

property with the specified name and interface.

898

1350

"""

899

for cls in self.__class__.__mro__:

900

for name, value in (inspect.getmembers

901

(cls,

902

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

903

1354

if (value._dbus_name == property_name

904

1355

and value._dbus_interface == interface_name):

905

1356

return value.__get__(self)

906

1357

907

1358

# No such property

908

raise DBusPropertyNotFound(self.dbus_object_path + ":"

909

+ interface_name + "."

910

+ property_name)

911

912

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

913

1373

out_signature="v")

914

1374

def Get(self, interface_name, property_name):

915

1375

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

921

1381

if not hasattr(value, "variant_level"):

922

1382

return value

923

1383

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

924

1384

925

1385

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

926

1386

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

927

1387

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

933

1393

# The byte_arrays option is not supported yet on

934

1394

# signatures other than "ay".

935

1395

if prop._dbus_signature != "ay":

936

raise ValueError

1396

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

1397

"'ay' signature {!r}"

1398

.format(prop._dbus_signature))

937

1399

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

938

1400

for byte in value))

939

1401

prop(value)

940

941

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

1402

1403

@dbus.service.method(dbus.PROPERTIES_IFACE,

1404

in_signature="s",

942

1405

out_signature="a{sv}")

943

1406

def GetAll(self, interface_name):

944

1407

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

945

1408

standard.

946

1409

947

1410

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

948

1411

"""

949

1412

properties = {}

959

1422

if not hasattr(value, "variant_level"):

960

1423

properties[name] = value

961

1424

continue

962

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

963

value.variant_level+1)

1425

properties[name] = type(value)(

1426

value, variant_level=value.variant_level + 1)

964

1427

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

965

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

966

1437

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

967

1438

out_signature="s",

968

1439

path_keyword='object_path',

969

1440

connection_keyword='connection')

970

1441

def Introspect(self, object_path, connection):

971

1442

"""Overloading of standard D-Bus method.

972

1443

973

1444

Inserts property tags and interface annotation tags.

974

1445

"""

975

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

976

connection)

1446

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1447

object_path,

1448

connection)

977

1449

try:

978

1450

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

1451

979

1452

def make_tag(document, name, prop):

980

1453

e = document.createElement("property")

981

1454

e.setAttribute("name", name)

982

1455

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

983

1456

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

984

1457

return e

1458

985

1459

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

986

1460

# Add property tags

987

1461

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

990

1464

if prop._dbus_interface

991

1465

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

992

1466

if_tag.appendChild(tag)

993

# Add annotation tags

994

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

995

for tag in if_tag.getElementsByTagName(typ):

996

annots = dict()

997

for name, prop in (self.

998

_get_all_dbus_things(typ)):

999

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

1000

and prop._dbus_interface

1001

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

1002

annots.update(getattr

1003

(prop,

1004

"_dbus_annotations",

1005

{}))

1006

for name, value in annots.iteritems():

1007

ann_tag = document.createElement(

1008

"annotation")

1009

ann_tag.setAttribute("name", name)

1010

ann_tag.setAttribute("value", value)

1011

tag.appendChild(ann_tag)

1012

# Add interface annotation tags

1013

for annotation, value in dict(

1014

itertools.chain.from_iterable(

1015

annotations().iteritems()

1016

for name, annotations in

1017

self._get_all_dbus_things("interface")

1018

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

1019

)).iteritems():

1020

ann_tag = document.createElement("annotation")

1021

ann_tag.setAttribute("name", annotation)

1022

ann_tag.setAttribute("value", value)

1023

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)

1024

1483

# Add the names to the return values for the

1025

1484

# "org.freedesktop.DBus.Properties" methods

1026

1485

if (if_tag.getAttribute("name")

1045

1504

return xmlstring

1046

1505

1047

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

1048

1578

def datetime_to_dbus(dt, variant_level=0):

1049

1579

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

1050

1580

if dt is None:

1051

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

1052

return dbus.String(dt.isoformat(),

1053

variant_level=variant_level)

1581

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

1582

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

1054

1583

1055

1584

1056

1585

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1058

1587

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

1059

1588

interface names according to the "alt_interface_names" mapping.

1060

1589

Usage:

1061

1590

1062

1591

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

1063

1592

"net.example.AlternateInterface"})

1064

1593

class SampleDBusObject(dbus.service.Object):

1065

1594

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

1066

1595

def SampleDBusMethod():

1067

1596

pass

1068

1597

1069

1598

The above "SampleDBusMethod" on "SampleDBusObject" will be

1070

1599

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

1071

1600

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

1072

1601

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

1073

1602

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

1074

1603

1075

1604

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

1076

1605

(from DBusObjectWithProperties) and interfaces (from the

1077

1606

dbus_interface_annotations decorator).

1078

1607

"""

1608

1079

1609

def wrapper(cls):

1080

1610

for orig_interface_name, alt_interface_name in (

1081

alt_interface_names.iteritems()):

1611

alt_interface_names.items()):

1082

1612

attr = {}

1083

1613

interface_names = set()

1084

1614

# Go though all attributes of the class

1086

1616

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

1087

1617

# with the wrong interface name

1088

1618

if (not hasattr(attribute, "_dbus_interface")

1089

or not attribute._dbus_interface

1090

.startswith(orig_interface_name)):

1619

or not attribute._dbus_interface.startswith(

1620

orig_interface_name)):

1091

1621

continue

1092

1622

# Create an alternate D-Bus interface name based on

1093

1623

# the current name

1094

alt_interface = (attribute._dbus_interface

1095

.replace(orig_interface_name,

1096

alt_interface_name))

1624

alt_interface = attribute._dbus_interface.replace(

1625

orig_interface_name, alt_interface_name)

1097

1626

interface_names.add(alt_interface)

1098

1627

# Is this a D-Bus signal?

1099

1628

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

1100

1629

# Extract the original non-method undecorated

1101

1630

# function by black magic

1102

nonmethod_func = (dict(

1631

if sys.version_info.major == 2:

1632

nonmethod_func = (dict(

1103

1633

zip(attribute.func_code.co_freevars,

1104

attribute.__closure__))["func"]

1105

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

1106

1641

# Create a new, but exactly alike, function

1107

1642

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

1108

1643

# with the alternate D-Bus interface name

1109

new_function = (dbus.service.signal

1110

(alt_interface,

1111

attribute._dbus_signature)

1112

(types.FunctionType(

1113

nonmethod_func.func_code,

1114

nonmethod_func.func_globals,

1115

nonmethod_func.func_name,

1116

nonmethod_func.func_defaults,

1117

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

1118

1648

# Copy annotations, if any

1119

1649

try:

1120

new_function._dbus_annotations = (

1121

dict(attribute._dbus_annotations))

1650

new_function._dbus_annotations = dict(

1651

attribute._dbus_annotations)

1122

1652

except AttributeError:

1123

1653

pass

1654

1124

1655

# Define a creator of a function to call both the

1125

1656

# original and alternate functions, so both the

1126

1657

# original and alternate signals gets sent when

1129

1660

"""This function is a scope container to pass

1130

1661

func1 and func2 to the "call_both" function

1131

1662

outside of its arguments"""

1663

1664

@functools.wraps(func2)

1132

1665

def call_both(*args, **kwargs):

1133

1666

"""This function will emit two D-Bus

1134

1667

signals by calling func1 and func2"""

1135

1668

func1(*args, **kwargs)

1136

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

1137

1676

return call_both

1138

1677

# Create the "call_both" function and add it to

1139

1678

# the class

1144

1683

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

1145

1684

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

1146

1685

# to the class.

1147

attr[attrname] = (dbus.service.method

1148

(alt_interface,

1149

attribute._dbus_in_signature,

1150

attribute._dbus_out_signature)

1151

(types.FunctionType

1152

(attribute.func_code,

1153

attribute.func_globals,

1154

attribute.func_name,

1155

attribute.func_defaults,

1156

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

1157

1692

# Copy annotations, if any

1158

1693

try:

1159

attr[attrname]._dbus_annotations = (

1160

dict(attribute._dbus_annotations))

1694

attr[attrname]._dbus_annotations = dict(

1695

attribute._dbus_annotations)

1161

1696

except AttributeError:

1162

1697

pass

1163

1698

# Is this a D-Bus property?

1166

1701

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

1167

1702

# property with the alternate D-Bus interface

1168

1703

# name. Add it to the class.

1169

attr[attrname] = (dbus_service_property

1170

(alt_interface,

1171

attribute._dbus_signature,

1172

attribute._dbus_access,

1173

attribute

1174

._dbus_get_args_options

1175

["byte_arrays"])

1176

(types.FunctionType

1177

(attribute.func_code,

1178

attribute.func_globals,

1179

attribute.func_name,

1180

attribute.func_defaults,

1181

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

1182

1710

# Copy annotations, if any

1183

1711

try:

1184

attr[attrname]._dbus_annotations = (

1185

dict(attribute._dbus_annotations))

1712

attr[attrname]._dbus_annotations = dict(

1713

attribute._dbus_annotations)

1186

1714

except AttributeError:

1187

1715

pass

1188

1716

# Is this a D-Bus interface?

1191

1719

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

1192

1720

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

1193

1721

# to the class.

1194

attr[attrname] = (dbus_interface_annotations

1195

(alt_interface)

1196

(types.FunctionType

1197

(attribute.func_code,

1198

attribute.func_globals,

1199

attribute.func_name,

1200

attribute.func_defaults,

1201

attribute.func_closure)))

1722

attr[attrname] = (

1723

dbus_interface_annotations(alt_interface)

1724

(copy_function(attribute)))

1202

1725

if deprecate:

1203

1726

# Deprecate all alternate interfaces

1204

iname="_AlternateDBusNames_interface_annotation{0}"

1727

iname = "_AlternateDBusNames_interface_annotation{}"

1205

1728

for interface_name in interface_names:

1729

1206

1730

@dbus_interface_annotations(interface_name)

1207

1731

def func(self):

1208

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

1209

"true" }

1732

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

1733

"true"}

1210

1734

# Find an unused name

1211

1735

for aname in (iname.format(i)

1212

1736

for i in itertools.count()):

1216

1740

if interface_names:

1217

1741

# Replace the class with a new subclass of it with

1218

1742

# methods, signals, etc. as created above.

1219

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

1220

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

1221

1749

return cls

1750

1222

1751

return wrapper

1223

1752

1224

1753

1225

1754

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

1226

"se.bsnet.fukt.Mandos"})

1755

"se.bsnet.fukt.Mandos"})

1227

1756

class ClientDBus(Client, DBusObjectWithProperties):

1228

1757

"""A Client class using D-Bus

1229

1758

1230

1759

Attributes:

1231

1760

dbus_object_path: dbus.ObjectPath

1232

1761

bus: dbus.SystemBus()

1233

1762

"""

1234

1763

1235

1764

runtime_expansions = (Client.runtime_expansions

1236

+ ("dbus_object_path",))

1237

1765

+ ("dbus_object_path", ))

1766

1767

_interface = "se.recompile.Mandos.Client"

1768

1238

1769

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

1239

1240

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

1770

1771

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

1241

1772

self.bus = bus

1242

1773

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

1243

1774

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

1244

1775

# the D-Bus

1245

client_object_name = unicode(self.name).translate(

1776

client_object_name = str(self.name).translate(

1246

1777

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

1247

1778

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

1248

self.dbus_object_path = (dbus.ObjectPath

1249

("/clients/" + client_object_name))

1779

self.dbus_object_path = dbus.ObjectPath(

1780

"/clients/" + client_object_name)

1250

1781

DBusObjectWithProperties.__init__(self, self.bus,

1251

1782

self.dbus_object_path)

1252

1253

def notifychangeproperty(transform_func,

1254

dbus_name, type_func=lambda x: x,

1255

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

1256

1789

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

1257

1790

its changes to DBus.

1258

1791

1259

1792

transform_fun: Function that takes a value and a variant_level

1260

1793

and transforms it to a D-Bus type.

1261

1794

dbus_name: D-Bus name of the variable

1263

1796

to the D-Bus. Default: no transform

1264

1797

variant_level: D-Bus variant level. Default: 1

1265

1798

"""

1266

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

1799

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

1800

1267

1801

def setter(self, value):

1268

1802

if hasattr(self, "dbus_object_path"):

1269

1803

if (not hasattr(self, attrname) or

1270

1804

type_func(getattr(self, attrname, None))

1271

1805

!= type_func(value)):

1272

dbus_value = transform_func(type_func(value),

1273

variant_level

1274

=variant_level)

1275

self.PropertyChanged(dbus.String(dbus_name),

1276

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

1277

1821

setattr(self, attrname, value)

1278

1822

1279

1823

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

1280

1824

1281

1825

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1282

1826

approvals_pending = notifychangeproperty(dbus.Boolean,

1283

1827

"ApprovalPending",

1284

type_func = bool)

1828

type_func=bool)

1285

1829

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

1286

1830

last_enabled = notifychangeproperty(datetime_to_dbus,

1287

1831

"LastEnabled")

1288

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

1289

type_func = lambda checker:

1290

checker is not None)

1832

checker = notifychangeproperty(

1833

dbus.Boolean, "CheckerRunning",

1834

type_func=lambda checker: checker is not None)

1291

1835

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1292

1836

"LastCheckedOK")

1293

1837

last_checker_status = notifychangeproperty(dbus.Int16,

1296

1840

datetime_to_dbus, "LastApprovalRequest")

1297

1841

approved_by_default = notifychangeproperty(dbus.Boolean,

1298

1842

"ApprovedByDefault")

1299

approval_delay = notifychangeproperty(dbus.UInt64,

1300

"ApprovalDelay",

1301

type_func =

1302

timedelta_to_milliseconds)

1843

approval_delay = notifychangeproperty(

1844

dbus.UInt64, "ApprovalDelay",

1845

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

1303

1846

approval_duration = notifychangeproperty(

1304

1847

dbus.UInt64, "ApprovalDuration",

1305

type_func = timedelta_to_milliseconds)

1848

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

1306

1849

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

1307

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

1308

type_func =

1309

timedelta_to_milliseconds)

1850

timeout = notifychangeproperty(

1851

dbus.UInt64, "Timeout",

1852

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

1310

1853

extended_timeout = notifychangeproperty(

1311

1854

dbus.UInt64, "ExtendedTimeout",

1312

type_func = timedelta_to_milliseconds)

1313

interval = notifychangeproperty(dbus.UInt64,

1314

"Interval",

1315

type_func =

1316

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)

1317

1859

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

1318

1860

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

1861

invalidate_only=True)

1862

1319

1863

del notifychangeproperty

1320

1864

1321

1865

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

1322

1866

try:

1323

1867

self.remove_from_connection()

1326

1870

if hasattr(DBusObjectWithProperties, "__del__"):

1327

1871

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

1328

1872

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

1329

1330

def checker_callback(self, pid, condition, command,

1331

*args, **kwargs):

1332

self.checker_callback_tag = None

1333

self.checker = None

1334

if os.WIFEXITED(condition):

1335

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:

1336

1881

# Emit D-Bus signal

1337

1882

self.CheckerCompleted(dbus.Int16(exitstatus),

1338

dbus.Int64(condition),

1883

# This is specific to GNU libC

1884

dbus.Int64(exitstatus << 8),

1339

1885

dbus.String(command))

1340

1886

else:

1341

1887

# Emit D-Bus signal

1342

1888

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

1343

dbus.Int64(condition),

1889

dbus.Int64(

1890

# This is specific to GNU libC

1891

(exitstatus << 8)

1892

| self.last_checker_signal),

1344

1893

dbus.String(command))

1345

1346

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

1347

*args, **kwargs)

1348

1894

return ret

1895

1349

1896

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

1350

old_checker = self.checker

1351

if self.checker is not None:

1352

old_checker_pid = self.checker.pid

1353

else:

1354

old_checker_pid = None

1897

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

1355

1898

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

1356

1899

# Only if new checker process was started

1357

1900

if (self.checker is not None

1359

1902

# Emit D-Bus signal

1360

1903

self.CheckerStarted(self.current_checker_command)

1361

1904

return r

1362

1905

1363

1906

def _reset_approved(self):

1364

1907

self.approved = None

1365

1908

return False

1366

1909

1367

1910

def approve(self, value=True):

1368

1911

self.approved = value

1369

gobject.timeout_add(timedelta_to_milliseconds

1370

(self.approval_duration),

1371

self._reset_approved)

1912

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

1913

* 1000), self._reset_approved)

1372

1914

self.send_changedstate()

1373

1374

## D-Bus methods, signals & properties

1375

_interface = "se.recompile.Mandos.Client"

1376

1377

## Interfaces

1378

1379

@dbus_interface_annotations(_interface)

1380

def _foo(self):

1381

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

1382

"false"}

1383

1384

## Signals

1385

1915

1916

# D-Bus methods, signals & properties

1917

1918

# Interfaces

1919

1920

# Signals

1921

1386

1922

# CheckerCompleted - signal

1387

1923

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

1388

1924

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

1389

1925

"D-Bus signal"

1390

1926

pass

1391

1927

1392

1928

# CheckerStarted - signal

1393

1929

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

1394

1930

def CheckerStarted(self, command):

1395

1931

"D-Bus signal"

1396

1932

pass

1397

1933

1398

1934

# PropertyChanged - signal

1935

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

1399

1936

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

1400

1937

def PropertyChanged(self, property, value):

1401

1938

"D-Bus signal"

1402

1939

pass

1403

1940

1404

1941

# GotSecret - signal

1405

1942

@dbus.service.signal(_interface)

1406

1943

def GotSecret(self):

1409

1946

server to mandos-client

1410

1947

"""

1411

1948

pass

1412

1949

1413

1950

# Rejected - signal

1414

1951

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

1415

1952

def Rejected(self, reason):

1416

1953

"D-Bus signal"

1417

1954

pass

1418

1955

1419

1956

# NeedApproval - signal

1420

1957

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

1421

1958

def NeedApproval(self, timeout, default):

1422

1959

"D-Bus signal"

1423

1960

return self.need_approval()

1424

1425

## Methods

1426

1961

1962

# Methods

1963

1427

1964

# Approve - method

1428

1965

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

1429

1966

def Approve(self, value):

1430

1967

self.approve(value)

1431

1968

1432

1969

# CheckedOK - method

1433

1970

@dbus.service.method(_interface)

1434

1971

def CheckedOK(self):

1435

1972

self.checked_ok()

1436

1973

1437

1974

# Enable - method

1975

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

1438

1976

@dbus.service.method(_interface)

1439

1977

def Enable(self):

1440

1978

"D-Bus method"

1441

1979

self.enable()

1442

1980

1443

1981

# StartChecker - method

1982

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

1444

1983

@dbus.service.method(_interface)

1445

1984

def StartChecker(self):

1446

1985

"D-Bus method"

1447

1986

self.start_checker()

1448

1987

1449

1988

# Disable - method

1989

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

1450

1990

@dbus.service.method(_interface)

1451

1991

def Disable(self):

1452

1992

"D-Bus method"

1453

1993

self.disable()

1454

1994

1455

1995

# StopChecker - method

1996

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

1456

1997

@dbus.service.method(_interface)

1457

1998

def StopChecker(self):

1458

1999

self.stop_checker()

1459

1460

## Properties

1461

2000

2001

# Properties

2002

1462

2003

# ApprovalPending - property

1463

2004

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

1464

2005

def ApprovalPending_dbus_property(self):

1465

2006

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

1466

2007

1467

2008

# ApprovedByDefault - property

1468

@dbus_service_property(_interface, signature="b",

2009

@dbus_service_property(_interface,

2010

signature="b",

1469

2011

access="readwrite")

1470

2012

def ApprovedByDefault_dbus_property(self, value=None):

1471

2013

if value is None: # get

1472

2014

return dbus.Boolean(self.approved_by_default)

1473

2015

self.approved_by_default = bool(value)

1474

2016

1475

2017

# ApprovalDelay - property

1476

@dbus_service_property(_interface, signature="t",

2018

@dbus_service_property(_interface,

2019

signature="t",

1477

2020

access="readwrite")

1478

2021

def ApprovalDelay_dbus_property(self, value=None):

1479

2022

if value is None: # get

1480

return dbus.UInt64(self.approval_delay_milliseconds())

2023

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

2024

* 1000)

1481

2025

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

1482

2026

1483

2027

# ApprovalDuration - property

1484

@dbus_service_property(_interface, signature="t",

2028

@dbus_service_property(_interface,

2029

signature="t",

1485

2030

access="readwrite")

1486

2031

def ApprovalDuration_dbus_property(self, value=None):

1487

2032

if value is None: # get

1488

return dbus.UInt64(timedelta_to_milliseconds(

1489

self.approval_duration))

2033

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

2034

* 1000)

1490

2035

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

1491

2036

1492

2037

# Name - property

2038

@dbus_annotations(

2039

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

1493

2040

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

1494

2041

def Name_dbus_property(self):

1495

2042

return dbus.String(self.name)

1496

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

1497

2051

# Fingerprint - property

2052

@dbus_annotations(

2053

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

1498

2054

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

1499

2055

def Fingerprint_dbus_property(self):

1500

2056

return dbus.String(self.fingerprint)

1501

2057

1502

2058

# Host - property

1503

@dbus_service_property(_interface, signature="s",

2059

@dbus_service_property(_interface,

2060

signature="s",

1504

2061

access="readwrite")

1505

2062

def Host_dbus_property(self, value=None):

1506

2063

if value is None: # get

1507

2064

return dbus.String(self.host)

1508

self.host = unicode(value)

1509

2065

self.host = str(value)

2066

1510

2067

# Created - property

2068

@dbus_annotations(

2069

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

1511

2070

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

1512

2071

def Created_dbus_property(self):

1513

2072

return datetime_to_dbus(self.created)

1514

2073

1515

2074

# LastEnabled - property

1516

2075

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

1517

2076

def LastEnabled_dbus_property(self):

1518

2077

return datetime_to_dbus(self.last_enabled)

1519

2078

1520

2079

# Enabled - property

1521

@dbus_service_property(_interface, signature="b",

2080

@dbus_service_property(_interface,

2081

signature="b",

1522

2082

access="readwrite")

1523

2083

def Enabled_dbus_property(self, value=None):

1524

2084

if value is None: # get

1527

2087

self.enable()

1528

2088

else:

1529

2089

self.disable()

1530

2090

1531

2091

# LastCheckedOK - property

1532

@dbus_service_property(_interface, signature="s",

2092

@dbus_service_property(_interface,

2093

signature="s",

1533

2094

access="readwrite")

1534

2095

def LastCheckedOK_dbus_property(self, value=None):

1535

2096

if value is not None:

1536

2097

self.checked_ok()

1537

2098

return

1538

2099

return datetime_to_dbus(self.last_checked_ok)

1539

2100

1540

2101

# LastCheckerStatus - property

1541

@dbus_service_property(_interface, signature="n",

1542

access="read")

2102

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

1543

2103

def LastCheckerStatus_dbus_property(self):

1544

2104

return dbus.Int16(self.last_checker_status)

1545

2105

1546

2106

# Expires - property

1547

2107

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

1548

2108

def Expires_dbus_property(self):

1549

2109

return datetime_to_dbus(self.expires)

1550

2110

1551

2111

# LastApprovalRequest - property

1552

2112

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

1553

2113

def LastApprovalRequest_dbus_property(self):

1554

2114

return datetime_to_dbus(self.last_approval_request)

1555

2115

1556

2116

# Timeout - property

1557

@dbus_service_property(_interface, signature="t",

2117

@dbus_service_property(_interface,

2118

signature="t",

1558

2119

access="readwrite")

1559

2120

def Timeout_dbus_property(self, value=None):

1560

2121

if value is None: # get

1561

return dbus.UInt64(self.timeout_milliseconds())

2122

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

1562

2123

old_timeout = self.timeout

1563

2124

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

1564

2125

# Reschedule disabling

1572

2133

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

1573

2134

is None):

1574

2135

return

1575

gobject.source_remove(self.disable_initiator_tag)

1576

self.disable_initiator_tag = (

1577

gobject.timeout_add(

1578

timedelta_to_milliseconds(self.expires - now),

1579

self.disable))

1580

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

1581

2141

# ExtendedTimeout - property

1582

@dbus_service_property(_interface, signature="t",

2142

@dbus_service_property(_interface,

2143

signature="t",

1583

2144

access="readwrite")

1584

2145

def ExtendedTimeout_dbus_property(self, value=None):

1585

2146

if value is None: # get

1586

return dbus.UInt64(self.extended_timeout_milliseconds())

2147

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

2148

* 1000)

1587

2149

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

1588

2150

1589

2151

# Interval - property

1590

@dbus_service_property(_interface, signature="t",

2152

@dbus_service_property(_interface,

2153

signature="t",

1591

2154

access="readwrite")

1592

2155

def Interval_dbus_property(self, value=None):

1593

2156

if value is None: # get

1594

return dbus.UInt64(self.interval_milliseconds())

2157

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

1595

2158

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

1596

2159

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

1597

2160

return

1598

2161

if self.enabled:

1599

2162

# Reschedule checker run

1600

gobject.source_remove(self.checker_initiator_tag)

1601

self.checker_initiator_tag = (gobject.timeout_add

1602

(value, self.start_checker))

1603

self.start_checker() # Start one now, too

1604

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

1605

2168

# Checker - property

1606

@dbus_service_property(_interface, signature="s",

2169

@dbus_service_property(_interface,

2170

signature="s",

1607

2171

access="readwrite")

1608

2172

def Checker_dbus_property(self, value=None):

1609

2173

if value is None: # get

1610

2174

return dbus.String(self.checker_command)

1611

self.checker_command = unicode(value)

1612

2175

self.checker_command = str(value)

2176

1613

2177

# CheckerRunning - property

1614

@dbus_service_property(_interface, signature="b",

2178

@dbus_service_property(_interface,

2179

signature="b",

1615

2180

access="readwrite")

1616

2181

def CheckerRunning_dbus_property(self, value=None):

1617

2182

if value is None: # get

1620

2185

self.start_checker()

1621

2186

else:

1622

2187

self.stop_checker()

1623

2188

1624

2189

# ObjectPath - property

2190

@dbus_annotations(

2191

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

2192

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

1625

2193

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

1626

2194

def ObjectPath_dbus_property(self):

1627

return self.dbus_object_path # is already a dbus.ObjectPath

1628

2195

return self.dbus_object_path # is already a dbus.ObjectPath

2196

1629

2197

# Secret = property

1630

@dbus_service_property(_interface, signature="ay",

1631

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)

1632

2205

def Secret_dbus_property(self, value):

1633

self.secret = str(value)

1634

2206

self.secret = bytes(value)

2207

1635

2208

del _interface

1636

2209

1637

2210

1638

2211

class ProxyClient(object):

1639

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

2212

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

1640

2213

self._pipe = child_pipe

1641

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

2214

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

1642

2215

if not self._pipe.recv():

1643

raise KeyError()

1644

2216

raise KeyError(key_id or fpr)

2217

1645

2218

def __getattribute__(self, name):

1646

2219

if name == '_pipe':

1647

2220

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

1650

2223

if data[0] == 'data':

1651

2224

return data[1]

1652

2225

if data[0] == 'function':

2226

1653

2227

def func(*args, **kwargs):

1654

2228

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

1655

2229

return self._pipe.recv()[1]

2230

1656

2231

return func

1657

2232

1658

2233

def __setattr__(self, name, value):

1659

2234

if name == '_pipe':

1660

2235

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

1663

2238

1664

2239

class ClientHandler(socketserver.BaseRequestHandler, object):

1665

2240

"""A class to handle client connections.

1666

2241

1667

2242

Instantiated once for each connection to handle it.

1668

2243

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

1669

2244

1670

2245

def handle(self):

1671

2246

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

1672

2247

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

1673

unicode(self.client_address))

2248

str(self.client_address))

1674

2249

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

1675

2250

self.server.child_pipe.fileno())

1676

1677

session = (gnutls.connection

1678

.ClientSession(self.request,

1679

gnutls.connection

1680

.X509Credentials()))

1681

1682

# Note: gnutls.connection.X509Credentials is really a

1683

# generic GnuTLS certificate credentials object so long as

1684

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

1685

# here despite using OpenPGP certificates.

1686

1687

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

1688

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

1689

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

1690

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

1691

2258

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

1692

2259

priority = self.server.gnutls_priority

1693

2260

if priority is None:

1694

2261

priority = "NORMAL"

1695

(gnutls.library.functions

1696

.gnutls_priority_set_direct(session._c_object,

1697

priority, None))

1698

2262

gnutls.priority_set_direct(session._c_object,

2263

priority.encode("utf-8"),

2264

None)

2265

1699

2266

# Start communication using the Mandos protocol

1700

2267

# Get protocol number

1701

2268

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

1702

2269

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

1703

2270

try:

1704

2271

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

1705

raise RuntimeError

2272

raise RuntimeError(line)

1706

2273

except (ValueError, IndexError, RuntimeError) as error:

1707

2274

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

1708

2275

return

1709

2276

1710

2277

# Start GnuTLS connection

1711

2278

try:

1712

2279

session.handshake()

1713

except gnutls.errors.GNUTLSError as error:

2280

except gnutls.Error as error:

1714

2281

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

1715

2282

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

1716

2283

# established. Just abandon the request.

1717

2284

return

1718

2285

logger.debug("Handshake succeeded")

1719

2286

1720

2287

approval_required = False

1721

2288

try:

1722

try:

1723

fpr = self.fingerprint(self.peer_certificate

1724

(session))

1725

except (TypeError,

1726

gnutls.errors.GNUTLSError) as error:

1727

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

1728

return

1729

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

1730

1731

try:

1732

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,

1733

2311

self.client_address)

1734

2312

except KeyError:

1735

2313

return

1736

2314

1737

2315

if client.approval_delay:

1738

2316

delay = client.approval_delay

1739

2317

client.approvals_pending += 1

1740

2318

approval_required = True

1741

2319

1742

2320

while True:

1743

2321

if not client.enabled:

1744

2322

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

1745

client.name)

2323

client.name)

1746

2324

if self.server.use_dbus:

1747

2325

# Emit D-Bus signal

1748

2326

client.Rejected("Disabled")

1749

2327

return

1750

2328

1751

2329

if client.approved or not client.approval_delay:

1752

#We are approved or approval is disabled

2330

# We are approved or approval is disabled

1753

2331

break

1754

2332

elif client.approved is None:

1755

2333

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

1757

2335

if self.server.use_dbus:

1758

2336

# Emit D-Bus signal

1759

2337

client.NeedApproval(

1760

client.approval_delay_milliseconds(),

1761

client.approved_by_default)

2338

client.approval_delay.total_seconds()

2339

* 1000, client.approved_by_default)

1762

2340

else:

1763

2341

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

1764

2342

client.name)

1766

2344

# Emit D-Bus signal

1767

2345

client.Rejected("Denied")

1768

2346

return

1769

1770

#wait until timeout or approved

2347

2348

# wait until timeout or approved

1771

2349

time = datetime.datetime.now()

1772

2350

client.changedstate.acquire()

1773

client.changedstate.wait(

1774

float(timedelta_to_milliseconds(delay)

1775

/ 1000))

2351

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

1776

2352

client.changedstate.release()

1777

2353

time2 = datetime.datetime.now()

1778

2354

if (time2 - time) >= delay:

1788

2364

break

1789

2365

else:

1790

2366

delay -= time2 - time

1791

1792

sent_size = 0

1793

while sent_size < len(client.secret):

1794

try:

1795

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

1796

except gnutls.errors.GNUTLSError as error:

1797

logger.warning("gnutls send failed",

1798

exc_info=error)

1799

return

1800

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

1801

sent, len(client.secret)

1802

- (sent_size + sent))

1803

sent_size += sent

1804

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

1805

2375

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

1806

2376

# bump the timeout using extended_timeout

1807

2377

client.bump_timeout(client.extended_timeout)

1808

2378

if self.server.use_dbus:

1809

2379

# Emit D-Bus signal

1810

2380

client.GotSecret()

1811

2381

1812

2382

finally:

1813

2383

if approval_required:

1814

2384

client.approvals_pending -= 1

1815

2385

try:

1816

2386

session.bye()

1817

except gnutls.errors.GNUTLSError as error:

2387

except gnutls.Error as error:

1818

2388

logger.warning("GnuTLS bye failed",

1819

2389

exc_info=error)

1820

2390

1821

2391

@staticmethod

1822

2392

def peer_certificate(session):

1823

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

1824

# If not an OpenPGP certificate...

1825

if (gnutls.library.functions

1826

.gnutls_certificate_type_get(session._c_object)

1827

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1828

# ...do the normal thing

1829

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

1830

2409

list_size = ctypes.c_uint(1)

1831

cert_list = (gnutls.library.functions

1832

.gnutls_certificate_get_peers

2410

cert_list = (gnutls.certificate_get_peers

1833

2411

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

1834

2412

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

1835

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

1836

" certificate")

2413

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

1837

2414

if list_size.value == 0:

1838

2415

return None

1839

2416

cert = cert_list[0]

1840

2417

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

1841

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

1842

2453

@staticmethod

1843

2454

def fingerprint(openpgp):

1844

2455

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1845

2456

# New GnuTLS "datum" with the OpenPGP public key

1846

datum = (gnutls.library.types

1847

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

1848

ctypes.POINTER

1849

(ctypes.c_ubyte)),

1850

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

1851

2461

# New empty GnuTLS certificate

1852

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1853

(gnutls.library.functions

1854

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2462

crt = gnutls.openpgp_crt_t()

2463

gnutls.openpgp_crt_init(ctypes.byref(crt))

1855

2464

# Import the OpenPGP public key into the certificate

1856

(gnutls.library.functions

1857

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

1858

gnutls.library.constants

1859

.GNUTLS_OPENPGP_FMT_RAW))

2465

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

2466

gnutls.OPENPGP_FMT_RAW)

1860

2467

# Verify the self signature in the key

1861

2468

crtverify = ctypes.c_uint()

1862

(gnutls.library.functions

1863

.gnutls_openpgp_crt_verify_self(crt, 0,

1864

ctypes.byref(crtverify)))

2469

gnutls.openpgp_crt_verify_self(crt, 0,

2470

ctypes.byref(crtverify))

1865

2471

if crtverify.value != 0:

1866

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1867

raise (gnutls.errors.CertificateSecurityError

1868

("Verify failed"))

2472

gnutls.openpgp_crt_deinit(crt)

2473

raise gnutls.CertificateSecurityError(code

2474

=crtverify.value)

1869

2475

# New buffer for the fingerprint

1870

2476

buf = ctypes.create_string_buffer(20)

1871

2477

buf_len = ctypes.c_size_t()

1872

2478

# Get the fingerprint from the certificate into the buffer

1873

(gnutls.library.functions

1874

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

1875

ctypes.byref(buf_len)))

2479

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

2480

ctypes.byref(buf_len))

1876

2481

# Deinit the certificate

1877

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2482

gnutls.openpgp_crt_deinit(crt)

1878

2483

# Convert the buffer to a Python bytestring

1879

2484

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

1880

2485

# Convert the bytestring to hexadecimal notation

1884

2489

1885

2490

class MultiprocessingMixIn(object):

1886

2491

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

2492

1887

2493

def sub_process_main(self, request, address):

1888

2494

try:

1889

2495

self.finish_request(request, address)

1890

2496

except Exception:

1891

2497

self.handle_error(request, address)

1892

2498

self.close_request(request)

1893

2499

1894

2500

def process_request(self, request, address):

1895

2501

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

1896

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

1897

args = (request, address))

2502

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

2503

args=(request, address))

1898

2504

proc.start()

1899

2505

return proc

1900

2506

1901

2507

1902

2508

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1903

2509

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

2510

1904

2511

def process_request(self, request, client_address):

1905

2512

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

1906

2513

1907

2514

This function creates a new pipe in self.pipe

1908

2515

"""

1909

2516

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1910

2517

1911

2518

proc = MultiprocessingMixIn.process_request(self, request,

1912

2519

client_address)

1913

2520

self.child_pipe.close()

1914

2521

self.add_pipe(parent_pipe, proc)

1915

2522

1916

2523

def add_pipe(self, parent_pipe, proc):

1917

2524

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

1918

raise NotImplementedError

2525

raise NotImplementedError()

1919

2526

1920

2527

1921

2528

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1922

2529

socketserver.TCPServer, object):

1923

2530

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

1924

2531

1925

2532

Attributes:

1926

2533

enabled: Boolean; whether this server is activated yet

1927

2534

interface: None or a network interface name (string)

1928

2535

use_ipv6: Boolean; to use IPv6 or not

1929

2536

"""

2537

1930

2538

def __init__(self, server_address, RequestHandlerClass,

1931

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

2539

interface=None,

2540

use_ipv6=True,

2541

socketfd=None):

1932

2542

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

1933

2543

creating a new one with socket.socket().

1934

2544

"""

1940

2550

self.socketfd = socketfd

1941

2551

# Save the original socket.socket() function

1942

2552

self.socket_socket = socket.socket

2553

1943

2554

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

1944

#

2555

#

1945

2556

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

1946

2557

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

1947

2558

# patching socket.socket.)

1948

#

2559

#

1949

2560

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

1950

2561

@functools.wraps(socket.socket)

1951

2562

def socket_wrapper(*args, **kwargs):

1963

2574

# socket_wrapper(), if socketfd was set.

1964

2575

socketserver.TCPServer.__init__(self, server_address,

1965

2576

RequestHandlerClass)

1966

2577

1967

2578

def server_bind(self):

1968

2579

"""This overrides the normal server_bind() function

1969

2580

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

1970

2581

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

2582

global SO_BINDTODEVICE

1971

2583

if self.interface is not None:

1972

2584

if SO_BINDTODEVICE is None:

1973

logger.error("SO_BINDTODEVICE does not exist;"

1974

" cannot bind to interface %s",

1975

self.interface)

1976

else:

1977

try:

1978

self.socket.setsockopt(socket.SOL_SOCKET,

1979

SO_BINDTODEVICE,

1980

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

1981

except socket.error as error:

1982

if error.errno == errno.EPERM:

1983

logger.error("No permission to bind to"

1984

" interface %s", self.interface)

1985

elif error.errno == errno.ENOPROTOOPT:

1986

logger.error("SO_BINDTODEVICE not available;"

1987

" cannot bind to interface %s",

1988

self.interface)

1989

elif error.errno == errno.ENODEV:

1990

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

1991

" cannot bind", self.interface)

1992

else:

1993

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

1994

2606

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

1995

2607

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

1996

2608

if not self.server_address[0]:

1997

2609

if self.address_family == socket.AF_INET6:

1998

any_address = "::" # in6addr_any

2610

any_address = "::" # in6addr_any

1999

2611

else:

2000

any_address = "0.0.0.0" # INADDR_ANY

2612

any_address = "0.0.0.0" # INADDR_ANY

2001

2613

self.server_address = (any_address,

2002

2614

self.server_address[1])

2003

2615

elif not self.server_address[1]:

2004

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

2005

0)

2616

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

2006

2617

# if self.interface:

2007

2618

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

2008

2619

# 0, # port

2014

2625

2015

2626

class MandosServer(IPv6_TCPServer):

2016

2627

"""Mandos server.

2017

2628

2018

2629

Attributes:

2019

2630

clients: set of Client objects

2020

2631

gnutls_priority GnuTLS priority string

2021

2632

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

2022

2023

Assumes a gobject.MainLoop event loop.

2633

2634

Assumes a GLib.MainLoop event loop.

2024

2635

"""

2636

2025

2637

def __init__(self, server_address, RequestHandlerClass,

2026

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

2027

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

2028

2644

self.enabled = False

2029

2645

self.clients = clients

2030

2646

if self.clients is None:

2033

2649

self.gnutls_priority = gnutls_priority

2034

2650

IPv6_TCPServer.__init__(self, server_address,

2035

2651

RequestHandlerClass,

2036

interface = interface,

2037

use_ipv6 = use_ipv6,

2038

socketfd = socketfd)

2652

interface=interface,

2653

use_ipv6=use_ipv6,

2654

socketfd=socketfd)

2655

2039

2656

def server_activate(self):

2040

2657

if self.enabled:

2041

2658

return socketserver.TCPServer.server_activate(self)

2042

2659

2043

2660

def enable(self):

2044

2661

self.enabled = True

2045

2662

2046

2663

def add_pipe(self, parent_pipe, proc):

2047

2664

# Call "handle_ipc" for both data and EOF events

2048

gobject.io_add_watch(parent_pipe.fileno(),

2049

gobject.IO_IN | gobject.IO_HUP,

2050

functools.partial(self.handle_ipc,

2051

parent_pipe =

2052

parent_pipe,

2053

proc = proc))

2054

2055

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

2056

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

2057

2676

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

2058

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

2677

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

2059

2678

# Wait for other process to exit

2060

2679

proc.join()

2061

2680

return False

2062

2681

2063

2682

# Read a request from the child

2064

2683

request = parent_pipe.recv()

2065

2684

command = request[0]

2066

2685

2067

2686

if command == 'init':

2068

fpr = request[1]

2069

address = request[2]

2070

2071

for c in self.clients.itervalues():

2072

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:

2073

2698

client = c

2074

2699

break

2075

2700

else:

2076

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

2077

"dress: %s", fpr, address)

2701

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

2702

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

2078

2703

if self.use_dbus:

2079

2704

# Emit D-Bus signal

2080

mandos_dbus_service.ClientNotFound(fpr,

2705

mandos_dbus_service.ClientNotFound(key_id or fpr,

2081

2706

address[0])

2082

2707

parent_pipe.send(False)

2083

2708

return False

2084

2085

gobject.io_add_watch(parent_pipe.fileno(),

2086

gobject.IO_IN | gobject.IO_HUP,

2087

functools.partial(self.handle_ipc,

2088

parent_pipe =

2089

parent_pipe,

2090

proc = proc,

2091

client_object =

2092

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

2093

2717

parent_pipe.send(True)

2094

2718

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

2095

2719

# same fileno

2098

2722

funcname = request[1]

2099

2723

args = request[2]

2100

2724

kwargs = request[3]

2101

2725

2102

2726

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

2103

2727

funcname)(*args,

2104

**kwargs)))

2105

2728

**kwargs)))

2729

2106

2730

if command == 'getattr':

2107

2731

attrname = request[1]

2108

if callable(client_object.__getattribute__(attrname)):

2109

parent_pipe.send(('function',))

2732

if isinstance(client_object.__getattribute__(attrname),

2733

collections.Callable):

2734

parent_pipe.send(('function', ))

2110

2735

else:

2111

parent_pipe.send(('data', client_object

2112

.__getattribute__(attrname)))

2113

2736

parent_pipe.send((

2737

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

2738

2114

2739

if command == 'setattr':

2115

2740

attrname = request[1]

2116

2741

value = request[2]

2117

2742

setattr(client_object, attrname, value)

2118

2743

2119

2744

return True

2120

2745

2121

2746

2122

2747

def rfc3339_duration_to_delta(duration):

2123

2748

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

2124

2749

2125

2750

>>> rfc3339_duration_to_delta("P7D")

2126

2751

datetime.timedelta(7)

2127

2752

>>> rfc3339_duration_to_delta("PT60S")

2137

2762

>>> rfc3339_duration_to_delta("P1DT3M20S")

2138

2763

datetime.timedelta(1, 200)

2139

2764

"""

2140

2765

2141

2766

# Parsing an RFC 3339 duration with regular expressions is not

2142

2767

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

2143

2768

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

2144

2769

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

2145

2770

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

2146

2771

# avoid excessive use of external libraries.

2147

2772

2148

2773

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

2149

Token = collections.namedtuple("Token",

2150

("regexp", # To match token; if

2151

# "value" is not None,

2152

# must have a "group"

2153

# containing digits

2154

"value", # datetime.timedelta or

2155

# None

2156

"followers")) # Tokens valid after

2157

# 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

2158

2779

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

2159

2780

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

2160

2781

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

2161

2782

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

2162

2783

datetime.timedelta(seconds=1),

2163

frozenset((token_end,)))

2784

frozenset((token_end, )))

2164

2785

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

2165

2786

datetime.timedelta(minutes=1),

2166

2787

frozenset((token_second, token_end)))

2182

2803

frozenset((token_month, token_end)))

2183

2804

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

2184

2805

datetime.timedelta(weeks=1),

2185

frozenset((token_end,)))

2806

frozenset((token_end, )))

2186

2807

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

2187

2808

frozenset((token_year, token_month,

2188

2809

token_day, token_time,

2189

token_week))),

2190

# Define starting values

2191

value = datetime.timedelta() # Value so far

2810

token_week)))

2811

# Define starting values:

2812

# Value so far

2813

value = datetime.timedelta()

2192

2814

found_token = None

2193

followers = frozenset(token_duration,) # Following valid tokens

2194

s = duration # String left to parse

2815

# Following valid tokens

2816

followers = frozenset((token_duration, ))

2817

# String left to parse

2818

s = duration

2195

2819

# Loop until end token is found

2196

2820

while found_token is not token_end:

2197

2821

# Search for any currently valid tokens

2213

2837

break

2214

2838

else:

2215

2839

# No currently valid tokens were found

2216

raise ValueError("Invalid RFC 3339 duration")

2840

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

2841

.format(duration))

2217

2842

# End token found

2218

2843

return value

2219

2844

2220

2845

2221

2846

def string_to_delta(interval):

2222

2847

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

2223

2848

2224

2849

>>> string_to_delta('7d')

2225

2850

datetime.timedelta(7)

2226

2851

>>> string_to_delta('60s')

2234

2859

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

2235

2860

datetime.timedelta(0, 330)

2236

2861

"""

2237

2862

2238

2863

try:

2239

2864

return rfc3339_duration_to_delta(interval)

2240

2865

except ValueError:

2241

2866

pass

2242

2867

2243

2868

timevalue = datetime.timedelta(0)

2244

2869

for s in interval.split():

2245

2870

try:

2246

suffix = unicode(s[-1])

2871

suffix = s[-1]

2247

2872

value = int(s[:-1])

2248

2873

if suffix == "d":

2249

2874

delta = datetime.timedelta(value)

2256

2881

elif suffix == "w":

2257

2882

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

2258

2883

else:

2259

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

2260

.format(suffix))

2261

except (ValueError, IndexError) as e:

2884

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

2885

except IndexError as e:

2262

2886

raise ValueError(*(e.args))

2263

2887

timevalue += delta

2264

2888

return timevalue

2265

2889

2266

2890

2267

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

2891

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

2268

2892

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

2269

2893

2270

2894

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

2271

2895

if os.fork():

2272

2896

sys.exit()

2280

2904

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

2281

2905

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

2282

2906

raise OSError(errno.ENODEV,

2283

"{0} not a character device"

2907

"{} not a character device"

2284

2908

.format(os.devnull))

2285

2909

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

2286

2910

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

2290

2914

2291

2915

2292

2916

def main():

2293

2917

2294

2918

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

2295

2919

# Parsing of options, both command line and config file

2296

2920

2297

2921

parser = argparse.ArgumentParser()

2298

2922

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

2299

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

2923

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

2300

2924

help="show version number and exit")

2301

2925

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

2302

2926

help="Bind to interface IF")

2335

2959

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

2336

2960

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

2337

2961

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

2338

2962

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

2963

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

2964

default=None)

2965

2339

2966

options = parser.parse_args()

2340

2967

2341

2968

if options.check:

2342

2969

import doctest

2343

doctest.testmod()

2344

sys.exit()

2345

2970

fail_count, test_count = doctest.testmod()

2971

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

2972

2346

2973

# Default values for config file for server-global settings

2347

server_defaults = { "interface": "",

2348

"address": "",

2349

"port": "",

2350

"debug": "False",

2351

"priority":

2352

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

2353

"servicename": "Mandos",

2354

"use_dbus": "True",

2355

"use_ipv6": "True",

2356

"debuglevel": "",

2357

"restore": "True",

2358

"socket": "",

2359

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

2360

"foreground": "False",

2361

}

2362

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

2363

2997

# Parse config file for server-global settings

2364

2998

server_config = configparser.SafeConfigParser(server_defaults)

2365

2999

del server_defaults

2366

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

2367

"mandos.conf"))

3000

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

2368

3001

# Convert the SafeConfigParser object to a dict

2369

3002

server_settings = server_config.defaults()

2370

3003

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

2371

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

3004

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

3005

"foreground", "zeroconf"):

2372

3006

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

2373

3007

option)

2374

3008

if server_settings["port"]:

2384

3018

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

2385

3019

["socket"])

2386

3020

del server_config

2387

3021

2388

3022

# Override the settings from the config file with command line

2389

3023

# options, if set.

2390

3024

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

2391

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

2392

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

2393

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

3025

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

3026

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

3027

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

2394

3028

value = getattr(options, option)

2395

3029

if value is not None:

2396

3030

server_settings[option] = value

2397

3031

del options

2398

3032

# Force all strings to be unicode

2399

3033

for option in server_settings.keys():

2400

if type(server_settings[option]) is str:

2401

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

2402

3037

# Force all boolean options to be boolean

2403

3038

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

2404

"foreground"):

3039

"foreground", "zeroconf"):

2405

3040

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

2406

3041

# Debug implies foreground

2407

3042

if server_settings["debug"]:

2408

3043

server_settings["foreground"] = True

2409

3044

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

2410

3045

2411

3046

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

2412

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

2413

3053

# For convenience

2414

3054

debug = server_settings["debug"]

2415

3055

debuglevel = server_settings["debuglevel"]

2418

3058

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

2419

3059

stored_state_file)

2420

3060

foreground = server_settings["foreground"]

2421

3061

zeroconf = server_settings["zeroconf"]

3062

2422

3063

if debug:

2423

3064

initlogger(debug, logging.DEBUG)

2424

3065

else:

2427

3068

else:

2428

3069

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

2429

3070

initlogger(debug, level)

2430

3071

2431

3072

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

2432

syslogger.setFormatter(logging.Formatter

2433

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

2434

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

2435

.format(server_settings

2436

["servicename"])))

2437

3073

syslogger.setFormatter(

3074

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

3075

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

3076

server_settings["servicename"])))

3077

2438

3078

# Parse config file with clients

2439

3079

client_config = configparser.SafeConfigParser(Client

2440

3080

.client_defaults)

2441

3081

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

2442

3082

"clients.conf"))

2443

3083

2444

3084

global mandos_dbus_service

2445

3085

mandos_dbus_service = None

2446

2447

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

2448

server_settings["port"]),

2449

ClientHandler,

2450

interface=(server_settings["interface"]

2451

or None),

2452

use_ipv6=use_ipv6,

2453

gnutls_priority=

2454

server_settings["priority"],

2455

use_dbus=use_dbus,

2456

socketfd=(server_settings["socket"]

2457

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)

2458

3098

if not foreground:

2459

3099

pidfilename = "/run/mandos.pid"

2460

3100

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

2461

3101

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

2462

3102

pidfile = None

2463

3103

try:

2464

pidfile = open(pidfilename, "w")

3104

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

2465

3105

except IOError as e:

2466

3106

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

2467

3107

exc_info=e)

2468

2469

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

3108

3109

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

3110

("mandos", "mandos"),

3111

("nobody", "nogroup")):

2470

3112

try:

2471

3113

uid = pwd.getpwnam(name).pw_uid

2472

gid = pwd.getpwnam(name).pw_gid

3114

gid = pwd.getpwnam(group).pw_gid

2473

3115

break

2474

3116

except KeyError:

2475

3117

continue

2479

3121

try:

2480

3122

os.setgid(gid)

2481

3123

os.setuid(uid)

3124

if debug:

3125

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

3126

gid))

2482

3127

except OSError as error:

3128

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

3129

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

2483

3130

if error.errno != errno.EPERM:

2484

raise error

2485

3131

raise

3132

2486

3133

if debug:

2487

3134

# Enable all possible GnuTLS debugging

2488

3135

2489

3136

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

2490

3137

# - GnuTLS manual

2491

gnutls.library.functions.gnutls_global_set_log_level(11)

2492

2493

@gnutls.library.types.gnutls_log_func

3138

gnutls.global_set_log_level(11)

3139

3140

@gnutls.log_func

2494

3141

def debug_gnutls(level, string):

2495

3142

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

2496

2497

(gnutls.library.functions

2498

.gnutls_global_set_log_function(debug_gnutls))

2499

3143

3144

gnutls.global_set_log_function(debug_gnutls)

3145

2500

3146

# Redirect stdin so all checkers get /dev/null

2501

3147

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

2502

3148

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

2503

3149

if null > 2:

2504

3150

os.close(null)

2505

3151

2506

3152

# Need to fork before connecting to D-Bus

2507

3153

if not foreground:

2508

3154

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

2509

3155

daemon()

2510

2511

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

2512

# need to inform gobject that threads will be used.

2513

gobject.threads_init()

2514

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

2515

3161

global main_loop

2516

3162

# From the Avahi example code

2517

3163

DBusGMainLoop(set_as_default=True)

2518

main_loop = gobject.MainLoop()

3164

main_loop = GLib.MainLoop()

2519

3165

bus = dbus.SystemBus()

2520

3166

# End of Avahi example code

2521

3167

if use_dbus:

2522

3168

try:

2523

3169

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

2524

bus, do_not_queue=True)

2525

old_bus_name = (dbus.service.BusName

2526

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

2527

do_not_queue=True))

2528

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:

2529

3176

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

2530

3177

use_dbus = False

2531

3178

server_settings["use_dbus"] = False

2532

3179

tcp_server.use_dbus = False

2533

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2534

service = AvahiServiceToSyslog(name =

2535

server_settings["servicename"],

2536

servicetype = "_mandos._tcp",

2537

protocol = protocol, bus = bus)

2538

if server_settings["interface"]:

2539

service.interface = (if_nametoindex

2540

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

2541

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

2542

3191

global multiprocessing_manager

2543

3192

multiprocessing_manager = multiprocessing.Manager()

2544

3193

2545

3194

client_class = Client

2546

3195

if use_dbus:

2547

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

2548

3196

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

3197

2549

3198

client_settings = Client.config_parser(client_config)

2550

3199

old_client_settings = {}

2551

3200

clients_data = {}

2552

3201

2553

3202

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

2554

3203

global wnull

2555

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

3204

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

2556

3205

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

2557

3206

# mode

2558

3207

if debug or not foreground:

2559

3208

wnull.close()

2560

3209

2561

3210

# Get client data and settings from last running state.

2562

3211

if server_settings["restore"]:

2563

3212

try:

2564

3213

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

2565

clients_data, old_client_settings = (pickle.load

2566

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

2567

3263

os.remove(stored_state_path)

2568

3264

except IOError as e:

2569

3265

if e.errno == errno.ENOENT:

2570

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

2571

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

3266

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

3267

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

2572

3268

else:

2573

3269

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

2574

3270

exc_info=e)

2575

3271

raise

2576

3272

except EOFError as e:

2577

3273

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

2578

"EOFError:", exc_info=e)

2579

3274

"EOFError:",

3275

exc_info=e)

3276

2580

3277

with PGPEngine() as pgp:

2581

for client_name, client in clients_data.iteritems():

3278

for client_name, client in clients_data.items():

2582

3279

# Skip removed clients

2583

3280

if client_name not in client_settings:

2584

3281

continue

2585

3282

2586

3283

# Decide which value to use after restoring saved state.

2587

3284

# We have three different values: Old config file,

2588

3285

# new config file, and saved state.

2593

3290

# For each value in new config, check if it

2594

3291

# differs from the old config value (Except for

2595

3292

# the "secret" attribute)

2596

if (name != "secret" and

2597

value != old_client_settings[client_name]

2598

[name]):

3293

if (name != "secret"

3294

and (value !=

3295

old_client_settings[client_name][name])):

2599

3296

client[name] = value

2600

3297

except KeyError:

2601

3298

pass

2602

3299

2603

3300

# Clients who has passed its expire date can still be

2604

# enabled if its last checker was successful. Clients

3301

# enabled if its last checker was successful. A Client

2605

3302

# whose checker succeeded before we stored its state is

2606

3303

# assumed to have successfully run all checkers during

2607

3304

# downtime.

2609

3306

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

2610

3307

if not client["last_checked_ok"]:

2611

3308

logger.warning(

2612

"disabling client {0} - Client never "

2613

"performed a successful checker"

2614

.format(client_name))

3309

"disabling client {} - Client never "

3310

"performed a successful checker".format(

3311

client_name))

2615

3312

client["enabled"] = False

2616

3313

elif client["last_checker_status"] != 0:

2617

3314

logger.warning(

2618

"disabling client {0} - Client "

2619

"last checker failed with error code {1}"

2620

.format(client_name,

2621

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

2622

3320

client["enabled"] = False

2623

3321

else:

2624

client["expires"] = (datetime.datetime

2625

.utcnow()

2626

+ client["timeout"])

3322

client["expires"] = (

3323

datetime.datetime.utcnow()

3324

+ client["timeout"])

2627

3325

logger.debug("Last checker succeeded,"

2628

" keeping {0} enabled"

2629

.format(client_name))

3326

" keeping {} enabled".format(

3327

client_name))

2630

3328

try:

2631

client["secret"] = (

2632

pgp.decrypt(client["encrypted_secret"],

2633

client_settings[client_name]

2634

["secret"]))

3329

client["secret"] = pgp.decrypt(

3330

client["encrypted_secret"],

3331

client_settings[client_name]["secret"])

2635

3332

except PGPError:

2636

3333

# If decryption fails, we use secret from new settings

2637

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

2638

.format(client_name))

2639

client["secret"] = (

2640

client_settings[client_name]["secret"])

2641

3334

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

3335

client_name))

3336

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

3337

["secret"])

3338

2642

3339

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

2643

3340

for client_name in (set(old_client_settings)

2644

3341

- set(client_settings)):

2646

3343

for client_name in (set(client_settings)

2647

3344

- set(old_client_settings)):

2648

3345

clients_data[client_name] = client_settings[client_name]

2649

3346

2650

3347

# Create all client objects

2651

for client_name, client in clients_data.iteritems():

3348

for client_name, client in clients_data.items():

2652

3349

tcp_server.clients[client_name] = client_class(

2653

name = client_name, settings = client,

2654

server_settings = server_settings)

2655

3350

name=client_name,

3351

settings=client,

3352

server_settings=server_settings)

3353

2656

3354

if not tcp_server.clients:

2657

3355

logger.warning("No clients defined")

2658

3356

2659

3357

if not foreground:

2660

3358

if pidfile is not None:

3359

pid = os.getpid()

2661

3360

try:

2662

3361

with pidfile:

2663

pid = os.getpid()

2664

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

3362

print(pid, file=pidfile)

2665

3363

except IOError:

2666

3364

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

2667

3365

pidfilename, pid)

2668

3366

del pidfile

2669

3367

del pidfilename

2670

2671

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

2672

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

2673

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

2674

3373

if use_dbus:

2675

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

2676

"se.bsnet.fukt.Mandos"})

2677

class MandosDBusService(DBusObjectWithProperties):

3374

3375

@alternate_dbus_interfaces(

3376

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

3377

class MandosDBusService(DBusObjectWithObjectManager):

2678

3378

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

3379

2679

3380

def __init__(self):

2680

3381

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

3382

2681

3383

_interface = "se.recompile.Mandos"

2682

2683

@dbus_interface_annotations(_interface)

2684

def _foo(self):

2685

return { "org.freedesktop.DBus.Property"

2686

".EmitsChangedSignal":

2687

"false"}

2688

3384

2689

3385

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

2690

3386

def ClientAdded(self, objpath):

2691

3387

"D-Bus signal"

2692

3388

pass

2693

3389

2694

3390

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

2695

def ClientNotFound(self, fingerprint, address):

3391

def ClientNotFound(self, key_id, address):

2696

3392

"D-Bus signal"

2697

3393

pass

2698

3394

3395

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

3396

"true"})

2699

3397

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

2700

3398

def ClientRemoved(self, objpath, name):

2701

3399

"D-Bus signal"

2702

3400

pass

2703

3401

3402

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

3403

"true"})

2704

3404

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

2705

3405

def GetAllClients(self):

2706

3406

"D-Bus method"

2707

return dbus.Array(c.dbus_object_path

2708

for c in

2709

tcp_server.clients.itervalues())

2710

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

2711

3412

@dbus.service.method(_interface,

2712

3413

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

2713

3414

def GetAllClientsWithProperties(self):

2714

3415

"D-Bus method"

2715

3416

return dbus.Dictionary(

2716

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

2717

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

2718

3420

signature="oa{sv}")

2719

3421

2720

3422

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

2721

3423

def RemoveClient(self, object_path):

2722

3424

"D-Bus method"

2723

for c in tcp_server.clients.itervalues():

3425

for c in tcp_server.clients.values():

2724

3426

if c.dbus_object_path == object_path:

2725

3427

del tcp_server.clients[c.name]

2726

3428

c.remove_from_connection()

2727

# Don't signal anything except ClientRemoved

3429

# Don't signal the disabling

2728

3430

c.disable(quiet=True)

2729

# Emit D-Bus signal

2730

self.ClientRemoved(object_path, c.name)

3431

# Emit D-Bus signal for removal

3432

self.client_removed_signal(c)

2731

3433

return

2732

3434

raise KeyError(object_path)

2733

3435

2734

3436

del _interface

2735

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

2736

3474

mandos_dbus_service = MandosDBusService()

2737

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

2738

3481

def cleanup():

2739

3482

"Cleanup function; run on exit"

2740

service.cleanup()

2741

2742

multiprocessing.active_children()

2743

wnull.close()

3483

if zeroconf:

3484

service.cleanup()

3485

3486

mp.active_children()

3487

wn.close()

2744

3488

if not (tcp_server.clients or client_settings):

2745

3489

return

2746

3490

2747

3491

# Store client before exiting. Secrets are encrypted with key

2748

3492

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

2749

3493

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

2750

3494

clients = {}

2751

3495

with PGPEngine() as pgp:

2752

for client in tcp_server.clients.itervalues():

3496

for client in tcp_server.clients.values():

2753

3497

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

2754

3498

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

2755

3499

key)

2756

3500

client_dict = {}

2757

3501

2758

3502

# A list of attributes that can not be pickled

2759

3503

# + secret.

2760

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

2761

"checker", "server_settings"))

2762

for name, typ in (inspect.getmembers

2763

(dbus.service.Object)):

3504

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

3505

"checker", "server_settings"}

3506

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

3507

.Object):

2764

3508

exclude.add(name)

2765

3509

2766

3510

client_dict["encrypted_secret"] = (client

2767

3511

.encrypted_secret)

2768

3512

for attr in client.client_structure:

2769

3513

if attr not in exclude:

2770

3514

client_dict[attr] = getattr(client, attr)

2771

3515

2772

3516

clients[client.name] = client_dict

2773

3517

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

2774

3518

2775

3519

try:

2776

with (tempfile.NamedTemporaryFile

2777

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

2778

dir=os.path.dirname(stored_state_path),

2779

delete=False)) as stored_state:

2780

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

2781

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

2782

3529

os.rename(tempname, stored_state_path)

2783

3530

except (IOError, OSError) as e:

2784

3531

if not debug:

2787

3534

except NameError:

2788

3535

pass

2789

3536

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

2790

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

3537

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

2791

3538

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

2792

3539

else:

2793

3540

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

2794

3541

exc_info=e)

2795

raise e

2796

3542

raise

3543

2797

3544

# Delete all clients, and settings from config

2798

3545

while tcp_server.clients:

2799

3546

name, client = tcp_server.clients.popitem()

2800

3547

if use_dbus:

2801

3548

client.remove_from_connection()

2802

# Don't signal anything except ClientRemoved

3549

# Don't signal the disabling

2803

3550

client.disable(quiet=True)

3551

# Emit D-Bus signal for removal

2804

3552

if use_dbus:

2805

# Emit D-Bus signal

2806

mandos_dbus_service.ClientRemoved(client

2807

.dbus_object_path,

2808

client.name)

3553

mandos_dbus_service.client_removed_signal(client)

2809

3554

client_settings.clear()

2810

3555

2811

3556

atexit.register(cleanup)

2812

2813

for client in tcp_server.clients.itervalues():

3557

3558

for client in tcp_server.clients.values():

2814

3559

if use_dbus:

2815

# Emit D-Bus signal

2816

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3560

# Emit D-Bus signal for adding

3561

mandos_dbus_service.client_added_signal(client)

2817

3562

# Need to initiate checking of clients

2818

3563

if client.enabled:

2819

3564

client.init_checker()

2820

3565

2821

3566

tcp_server.enable()

2822

3567

tcp_server.server_activate()

2823

3568

2824

3569

# Find out what port we got

2825

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

3570

if zeroconf:

3571

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

2826

3572

if use_ipv6:

2827

3573

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

2828

3574

" flowinfo %d, scope_id %d",

2830

3576

else: # IPv4

2831

3577

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

2832

3578

*tcp_server.socket.getsockname())

2833

2834

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

2835

3579

3580

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

3581

2836

3582

try:

2837

# From the Avahi example code

2838

try:

2839

service.activate()

2840

except dbus.exceptions.DBusException as error:

2841

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

2842

cleanup()

2843

sys.exit(1)

2844

# End of Avahi example code

2845

2846

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

2847

lambda *args, **kwargs:

2848

(tcp_server.handle_request

2849

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

2850

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

2851

3598

logger.debug("Starting main loop")

2852

3599

main_loop.run()

2853

3600

except AvahiError as error:

2862

3609

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

2863

3610

cleanup()

2864

3611

3612

2865

3613

if __name__ == '__main__':

2866

3614

main()