/mandos/trunk : revision 1133

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

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

122

syslogger = None

96

123

97

124

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

101

127

except (OSError, AttributeError):

128

102

129

def if_nametoindex(interface):

103

130

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

104

131

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

105

132

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

106

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

134

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

135

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

111

136

return interface_index

112

137

113

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

114

155

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

115

156

"""init logger and add loglevel"""

116

157

117

158

global syslogger

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

122

162

syslogger.setFormatter(logging.Formatter

123

163

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

124

164

' %(message)s'))

125

165

logger.addHandler(syslogger)

126

166

127

167

if debug:

128

168

console = logging.StreamHandler()

129

169

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

141

181

142

182

class PGPEngine(object):

143

183

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

184

144

185

def __init__(self):

145

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

146

198

self.gnupgargs = ['--batch',

147

'--home', self.tempdir,

199

'--homedir', self.tempdir,

148

200

'--force-mdc',

149

'--quiet',

150

'--no-use-agent']

151

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

152

206

def __enter__(self):

153

207

return self

154

208

155

209

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

156

210

self._cleanup()

157

211

return False

158

212

159

213

def __del__(self):

160

214

self._cleanup()

161

215

162

216

def _cleanup(self):

163

217

if self.tempdir is not None:

164

218

# Delete contents of tempdir

165

219

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

166

topdown = False):

220

topdown=False):

167

221

for filename in files:

168

222

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

169

223

for dirname in dirs:

171

225

# Remove tempdir

172

226

os.rmdir(self.tempdir)

173

227

self.tempdir = None

174

228

175

229

def password_encode(self, password):

176

230

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

177

231

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

182

236

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

183

237

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

184

238

return encoded

185

239

186

240

def encrypt(self, data, password):

187

241

passphrase = self.password_encode(password)

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

190

244

passfile.write(passphrase)

191

245

passfile.flush()

192

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

246

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

193

247

'--passphrase-file',

194

248

passfile.name]

195

249

+ self.gnupgargs,

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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)

200

254

if proc.returncode != 0:

201

255

raise PGPError(err)

202

256

return ciphertext

203

257

204

258

def decrypt(self, data, password):

205

259

passphrase = self.password_encode(password)

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

208

262

passfile.write(passphrase)

209

263

passfile.flush()

210

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

264

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

211

265

'--passphrase-file',

212

266

passfile.name]

213

267

+ self.gnupgargs,

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

219

272

if proc.returncode != 0:

220

273

raise PGPError(err)

221

274

return decrypted_plaintext

222

275

223

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

224

303

class AvahiError(Exception):

225

304

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

226

305

self.value = value

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

306

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

307

**kwargs)

308

230

309

231

310

class AvahiServiceError(AvahiError):

232

311

pass

233

312

313

234

314

class AvahiGroupError(AvahiError):

235

315

pass

236

316

237

317

238

318

class AvahiService(object):

239

319

"""An Avahi (Zeroconf) service.

240

320

241

321

Attributes:

242

322

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

243

323

Used to optionally bind to the specified interface.

255

335

server: D-Bus Server

256

336

bus: dbus.SystemBus()

257

337

"""

258

259

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

260

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

261

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

262

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

263

350

self.interface = interface

264

351

self.name = name

265

352

self.type = servicetype

274

361

self.server = None

275

362

self.bus = bus

276

363

self.entry_group_state_changed_match = None

277

278

def rename(self):

364

365

def rename(self, remove=True):

279

366

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

280

367

if self.rename_count >= self.max_renames:

281

368

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

282

369

" after %i retries, exiting.",

283

370

self.rename_count)

284

371

raise AvahiServiceError("Too many renames")

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

287

375

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

288

376

self.name)

289

self.remove()

377

if remove:

378

self.remove()

290

379

try:

291

380

self.add()

292

381

except dbus.exceptions.DBusException as error:

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

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

298

391

def remove(self):

299

392

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

300

393

if self.entry_group_state_changed_match is not None:

302

395

self.entry_group_state_changed_match = None

303

396

if self.group is not None:

304

397

self.group.Reset()

305

398

306

399

def add(self):

307

400

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

308

401

self.remove()

325

418

dbus.UInt16(self.port),

326

419

avahi.string_array_to_txt_array(self.TXT))

327

420

self.group.Commit()

328

421

329

422

def entry_group_state_changed(self, state, error):

330

423

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

331

424

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

332

425

333

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

334

427

logger.debug("Zeroconf service established.")

335

428

elif state == avahi.ENTRY_GROUP_COLLISION:

337

430

self.rename()

338

431

elif state == avahi.ENTRY_GROUP_FAILURE:

339

432

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

340

unicode(error))

341

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

342

.format(error))

343

433

str(error))

434

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

435

344

436

def cleanup(self):

345

437

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

346

438

if self.group is not None:

351

443

pass

352

444

self.group = None

353

445

self.remove()

354

446

355

447

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

356

448

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

357

449

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

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"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

}

365

456

if state in bad_states:

366

457

if bad_states[state] is not None:

367

458

if error is None:

370

461

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

371

462

self.cleanup()

372

463

elif state == avahi.SERVER_RUNNING:

373

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)

374

476

else:

375

477

if error is None:

376

478

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

377

479

else:

378

480

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

379

481

380

482

def activate(self):

381

483

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

382

484

if self.server is None:

386

488

follow_name_owner_changes=True),

387

489

avahi.DBUS_INTERFACE_SERVER)

388

490

self.server.connect_to_signal("StateChanged",

389

self.server_state_changed)

491

self.server_state_changed)

390

492

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

391

493

392

494

393

495

class AvahiServiceToSyslog(AvahiService):

394

def rename(self):

496

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

395

497

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

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

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

401

502

return ret

402

503

403

504

404

def timedelta_to_milliseconds(td):

405

"Convert a datetime.timedelta() to milliseconds"

406

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

407

+ (td.seconds * 1000)

408

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

409

815

410

816

411

817

class Client(object):

412

818

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

413

819

414

820

Attributes:

415

821

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

416

822

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

417

823

approval_duration: datetime.timedelta(); Duration of one approval

418

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

419

to see if the client lives.

420

'None' if no process is running.

421

checker_callback_tag: a gobject event source tag, or None

824

checker: multiprocessing.Process(); a running checker process used

825

to see if the client lives. 'None' if no process is

826

running.

827

checker_callback_tag: a GLib event source tag, or None

422

828

checker_command: string; External command which is run to check

423

829

if client lives. %() expansions are done at

424

830

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

425

831

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

426

checker_initiator_tag: a gobject event source tag, or None

832

checker_initiator_tag: a GLib event source tag, or None

427

833

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

428

834

client_structure: Object describing what attributes a client has

429

835

and is used for storing the client at exit

430

836

current_checker_command: string; current running checker_command

431

disable_initiator_tag: a gobject event source tag, or None

837

disable_initiator_tag: a GLib event source tag, or None

432

838

enabled: bool()

433

839

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

434

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

435

843

host: string; available for use by the checker command

436

844

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

437

845

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

439

847

last_checker_status: integer between 0 and 255 reflecting exit

440

848

status of last checker. -1 reflects crashed

441

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

442

852

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

443

853

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

444

854

D-Bus identifiers

451

861

disabled, or None

452

862

server_settings: The server_settings dict from main()

453

863

"""

454

864

455

865

runtime_expansions = ("approval_delay", "approval_duration",

456

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

866

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

457

867

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

458

868

"last_approval_request", "last_checked_ok",

459

869

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

460

client_defaults = { "timeout": "PT5M",

461

"extended_timeout": "PT15M",

462

"interval": "PT2M",

463

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

464

"host": "",

465

"approval_delay": "PT0S",

466

"approval_duration": "PT1S",

467

"approved_by_default": "True",

468

"enabled": "True",

469

}

470

471

def timeout_milliseconds(self):

472

"Return the 'timeout' attribute in milliseconds"

473

return timedelta_to_milliseconds(self.timeout)

474

475

def extended_timeout_milliseconds(self):

476

"Return the 'extended_timeout' attribute in milliseconds"

477

return timedelta_to_milliseconds(self.extended_timeout)

478

479

def interval_milliseconds(self):

480

"Return the 'interval' attribute in milliseconds"

481

return timedelta_to_milliseconds(self.interval)

482

483

def approval_delay_milliseconds(self):

484

return timedelta_to_milliseconds(self.approval_delay)

485

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

486

882

@staticmethod

487

883

def config_parser(config):

488

884

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

495

891

for client_name in config.sections():

496

892

section = dict(config.items(client_name))

497

893

client = settings[client_name] = {}

498

894

499

895

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

500

896

# Reformat values from string types to Python types

501

897

client["approved_by_default"] = config.getboolean(

502

898

client_name, "approved_by_default")

503

899

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

504

900

"enabled")

505

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

506

907

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

507

908

.replace(" ", ""))

508

909

if "secret" in section:

509

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

910

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

911

.encode("utf-8"),

912

"base64")

510

913

elif "secfile" in section:

511

914

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

512

915

(section["secfile"])),

513

916

"rb") as secfile:

514

917

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

515

918

else:

516

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

919

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

517

920

.format(section))

518

921

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

519

922

client["extended_timeout"] = string_to_delta(

527

930

client["last_approval_request"] = None

528

931

client["last_checked_ok"] = None

529

932

client["last_checker_status"] = -2

530

933

531

934

return settings

532

533

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

935

936

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

534

937

self.name = name

535

938

if server_settings is None:

536

939

server_settings = {}

537

940

self.server_settings = server_settings

538

941

# adding all client settings

539

for setting, value in settings.iteritems():

942

for setting, value in settings.items():

540

943

setattr(self, setting, value)

541

944

542

945

if self.enabled:

543

946

if not hasattr(self, "last_enabled"):

544

947

self.last_enabled = datetime.datetime.utcnow()

548

951

else:

549

952

self.last_enabled = None

550

953

self.expires = None

551

954

552

955

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

553

# Uppercase and remove spaces from fingerprint for later

554

# comparison purposes with return value from the fingerprint()

555

# function

956

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

556

957

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

557

958

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

558

959

datetime.datetime.utcnow())

559

960

560

961

# attributes specific for this server instance

561

962

self.checker = None

562

963

self.checker_initiator_tag = None

565

966

self.current_checker_command = None

566

967

self.approved = None

567

968

self.approvals_pending = 0

568

self.changedstate = (multiprocessing_manager

569

.Condition(multiprocessing_manager

570

.Lock()))

571

self.client_structure = [attr for attr in

572

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

573

973

if not attr.startswith("_")]

574

974

self.client_structure.append("client_structure")

575

576

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

577

lambda obj:

578

isinstance(obj,

579

property)):

975

976

for name, t in inspect.getmembers(

977

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

580

978

if not name.startswith("_"):

581

979

self.client_structure.append(name)

582

980

583

981

# Send notice to process children that client state has changed

584

982

def send_changedstate(self):

585

983

with self.changedstate:

586

984

self.changedstate.notify_all()

587

985

588

986

def enable(self):

589

987

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

590

988

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

595

993

self.last_enabled = datetime.datetime.utcnow()

596

994

self.init_checker()

597

995

self.send_changedstate()

598

996

599

997

def disable(self, quiet=True):

600

998

"""Disable this client."""

601

999

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

603

1001

if not quiet:

604

1002

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

605

1003

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

606

gobject.source_remove(self.disable_initiator_tag)

1004

GLib.source_remove(self.disable_initiator_tag)

607

1005

self.disable_initiator_tag = None

608

1006

self.expires = None

609

1007

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

610

gobject.source_remove(self.checker_initiator_tag)

1008

GLib.source_remove(self.checker_initiator_tag)

611

1009

self.checker_initiator_tag = None

612

1010

self.stop_checker()

613

1011

self.enabled = False

614

1012

if not quiet:

615

1013

self.send_changedstate()

616

# 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

617

1015

return False

618

1016

619

1017

def __del__(self):

620

1018

self.disable()

621

1019

622

1020

def init_checker(self):

623

1021

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

624

1022

# and every interval from then on.

625

1023

if self.checker_initiator_tag is not None:

626

gobject.source_remove(self.checker_initiator_tag)

627

self.checker_initiator_tag = (gobject.timeout_add

628

(self.interval_milliseconds(),

629

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)

630

1028

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

631

1029

if self.disable_initiator_tag is not None:

632

gobject.source_remove(self.disable_initiator_tag)

633

self.disable_initiator_tag = (gobject.timeout_add

634

(self.timeout_milliseconds(),

635

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)

636

1033

# Also start a new checker *right now*.

637

1034

self.start_checker()

638

639

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

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

640

1038

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

1039

# Read return code from connection (see call_pipe)

1040

returncode = connection.recv()

1041

connection.close()

1042

self.checker.join()

641

1043

self.checker_callback_tag = None

642

1044

self.checker = None

643

if os.WIFEXITED(condition):

644

self.last_checker_status = os.WEXITSTATUS(condition)

1045

1046

if returncode >= 0:

1047

self.last_checker_status = returncode

1048

self.last_checker_signal = None

645

1049

if self.last_checker_status == 0:

646

1050

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

647

1051

vars(self))

648

1052

self.checked_ok()

649

1053

else:

650

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

651

vars(self))

1054

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

652

1055

else:

653

1056

self.last_checker_status = -1

1057

self.last_checker_signal = -returncode

654

1058

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

655

1059

vars(self))

656

1060

return False

1061

657

1062

def checked_ok(self):

658

1063

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

659

1064

self.last_checked_ok = datetime.datetime.utcnow()

660

1065

self.last_checker_status = 0

1066

self.last_checker_signal = None

661

1067

self.bump_timeout()

662

1068

663

1069

def bump_timeout(self, timeout=None):

664

1070

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

665

1071

if timeout is None:

666

1072

timeout = self.timeout

667

1073

if self.disable_initiator_tag is not None:

668

gobject.source_remove(self.disable_initiator_tag)

1074

GLib.source_remove(self.disable_initiator_tag)

669

1075

self.disable_initiator_tag = None

670

1076

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

671

self.disable_initiator_tag = (gobject.timeout_add

672

(timedelta_to_milliseconds

673

(timeout), self.disable))

1077

self.disable_initiator_tag = GLib.timeout_add(

1078

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

674

1079

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

675

1080

676

1081

def need_approval(self):

677

1082

self.last_approval_request = datetime.datetime.utcnow()

678

1083

679

1084

def start_checker(self):

680

1085

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

681

1086

682

1087

If a checker already exists, leave it running and do

683

1088

nothing."""

684

1089

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

689

1094

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

690

1095

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

691

1096

# should be.

692

693

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

694

try:

695

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

696

except AttributeError:

697

pass

698

except OSError as error:

699

if error.errno != errno.ECHILD:

700

raise

701

else:

702

if pid:

703

logger.warning("Checker was a zombie")

704

gobject.source_remove(self.checker_callback_tag)

705

self.checker_callback(pid, status,

706

self.current_checker_command)

1097

1098

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

1099

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

1100

self.checker.join()

1101

self.checker = None

707

1102

# Start a new checker if needed

708

1103

if self.checker is None:

709

1104

# Escape attributes for the shell

710

escaped_attrs = dict(

711

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

712

for attr in

713

self.runtime_expansions)

1105

escaped_attrs = {

1106

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

1107

for attr in self.runtime_expansions}

714

1108

try:

715

1109

command = self.checker_command % escaped_attrs

716

1110

except TypeError as error:

717

1111

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

718

self.checker_command, exc_info=error)

719

return True # Try again later

1112

self.checker_command,

1113

exc_info=error)

1114

return True # Try again later

720

1115

self.current_checker_command = command

721

try:

722

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

723

command, self.name)

724

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

725

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

726

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

727

# always replaced by /dev/null.)

728

# The exception is when not debugging but nevertheless

729

# running in the foreground; use the previously

730

# created wnull.

731

popen_args = {}

732

if (not self.server_settings["debug"]

733

and self.server_settings["foreground"]):

734

popen_args.update({"stdout": wnull,

735

"stderr": wnull })

736

self.checker = subprocess.Popen(command,

737

close_fds=True,

738

shell=True, cwd="/",

739

**popen_args)

740

except OSError as error:

741

logger.error("Failed to start subprocess",

742

exc_info=error)

743

return True

744

self.checker_callback_tag = (gobject.child_watch_add

745

(self.checker.pid,

746

self.checker_callback,

747

data=command))

748

# The checker may have completed before the gobject

749

# watch was added. Check for this.

750

try:

751

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

752

except OSError as error:

753

if error.errno == errno.ECHILD:

754

# This should never happen

755

logger.error("Child process vanished",

756

exc_info=error)

757

return True

758

raise

759

if pid:

760

gobject.source_remove(self.checker_callback_tag)

761

self.checker_callback(pid, status, command)

762

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

1116

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

1117

self.name)

1118

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

1119

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

1120

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

1121

# always replaced by /dev/null.)

1122

# The exception is when not debugging but nevertheless

1123

# running in the foreground; use the previously

1124

# created wnull.

1125

popen_args = {"close_fds": True,

1126

"shell": True,

1127

"cwd": "/"}

1128

if (not self.server_settings["debug"]

1129

and self.server_settings["foreground"]):

1130

popen_args.update({"stdout": wnull,

1131

"stderr": wnull})

1132

pipe = multiprocessing.Pipe(duplex=False)

1133

self.checker = multiprocessing.Process(

1134

target=call_pipe,

1135

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

1136

kwargs=popen_args)

1137

self.checker.start()

1138

self.checker_callback_tag = GLib.io_add_watch(

1139

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

1140

self.checker_callback, pipe[0], command)

1141

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

763

1142

return True

764

1143

765

1144

def stop_checker(self):

766

1145

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

767

1146

if self.checker_callback_tag:

768

gobject.source_remove(self.checker_callback_tag)

1147

GLib.source_remove(self.checker_callback_tag)

769

1148

self.checker_callback_tag = None

770

1149

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

771

1150

return

772

1151

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

773

try:

774

self.checker.terminate()

775

#time.sleep(0.5)

776

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

777

# self.checker.kill()

778

except OSError as error:

779

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

780

raise

1152

self.checker.terminate()

781

1153

self.checker = None

782

1154

783

1155

784

def dbus_service_property(dbus_interface, signature="v",

785

access="readwrite", byte_arrays=False):

1156

def dbus_service_property(dbus_interface,

1157

signature="v",

1158

access="readwrite",

1159

byte_arrays=False):

786

1160

"""Decorators for marking methods of a DBusObjectWithProperties to

787

1161

become properties on the D-Bus.

788

1162

789

1163

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

790

1164

and with one argument by "Set".

791

1165

792

1166

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

793

1167

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

794

1168

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

797

1171

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

798

1172

if byte_arrays and signature != "ay":

799

1173

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

800

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

1174

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

1175

801

1176

def decorator(func):

802

1177

func._dbus_is_property = True

803

1178

func._dbus_interface = dbus_interface

806

1181

func._dbus_name = func.__name__

807

1182

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

808

1183

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

809

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1184

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

810

1185

return func

1186

811

1187

return decorator

812

1188

813

1189

814

1190

def dbus_interface_annotations(dbus_interface):

815

1191

"""Decorator for marking functions returning interface annotations

816

1192

817

1193

Usage:

818

1194

819

1195

@dbus_interface_annotations("org.example.Interface")

820

1196

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

821

1197

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

822

1198

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

823

1199

"false"}

824

1200

"""

1201

825

1202

def decorator(func):

826

1203

func._dbus_is_interface = True

827

1204

func._dbus_interface = dbus_interface

828

1205

func._dbus_name = dbus_interface

829

1206

return func

1207

830

1208

return decorator

831

1209

832

1210

833

1211

def dbus_annotations(annotations):

834

1212

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

835

1213

Usage:

836

1214

1215

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

1216

"org.freedesktop.DBus.Property."

1217

"EmitsChangedSignal": "false"})

837

1218

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

838

1219

access="r")

839

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

840

"org.freedesktop.DBus.Property."

841

"EmitsChangedSignal": "false"})

842

1220

def Property_dbus_property(self):

843

1221

return dbus.Boolean(False)

1222

1223

See also the DBusObjectWithAnnotations class.

844

1224

"""

1225

845

1226

def decorator(func):

846

1227

func._dbus_annotations = annotations

847

1228

return func

1229

848

1230

return decorator

849

1231

850

1232

851

1233

class DBusPropertyException(dbus.exceptions.DBusException):

852

1234

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

853

1235

"""

854

def __unicode__(self):

855

return unicode(str(self))

1236

pass

856

1237

857

1238

858

1239

class DBusPropertyAccessException(DBusPropertyException):

867

1248

pass

868

1249

869

1250

870

class DBusObjectWithProperties(dbus.service.Object):

871

"""A D-Bus object with properties.

872

873

Classes inheriting from this can use the dbus_service_property

874

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

875

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

1251

class DBusObjectWithAnnotations(dbus.service.Object):

1252

"""A D-Bus object with annotations.

1253

1254

Classes inheriting from this can use the dbus_annotations

1255

decorator to add annotations to methods or signals.

876

1256

"""

877

1257

878

1258

@staticmethod

879

1259

def _is_dbus_thing(thing):

880

1260

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

881

1261

882

1262

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

883

1263

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

884

1264

"""

885

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

1265

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

886

1266

False)

887

1267

888

1268

def _get_all_dbus_things(self, thing):

889

1269

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

890

1270

"""

891

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

892

name),

1271

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

893

1272

athing.__get__(self))

894

1273

for cls in self.__class__.__mro__

895

1274

for name, athing in

896

inspect.getmembers(cls,

897

self._is_dbus_thing(thing)))

898

1275

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

1276

1277

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1278

out_signature="s",

1279

path_keyword='object_path',

1280

connection_keyword='connection')

1281

def Introspect(self, object_path, connection):

1282

"""Overloading of standard D-Bus method.

1283

1284

Inserts annotation tags on methods and signals.

1285

"""

1286

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

1287

connection)

1288

try:

1289

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

1290

1291

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

1292

# Add annotation tags

1293

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

1294

for tag in if_tag.getElementsByTagName(typ):

1295

annots = dict()

1296

for name, prop in (self.

1297

_get_all_dbus_things(typ)):

1298

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

1299

and prop._dbus_interface

1300

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

1301

annots.update(getattr(

1302

prop, "_dbus_annotations", {}))

1303

for name, value in annots.items():

1304

ann_tag = document.createElement(

1305

"annotation")

1306

ann_tag.setAttribute("name", name)

1307

ann_tag.setAttribute("value", value)

1308

tag.appendChild(ann_tag)

1309

# Add interface annotation tags

1310

for annotation, value in dict(

1311

itertools.chain.from_iterable(

1312

annotations().items()

1313

for name, annotations

1314

in self._get_all_dbus_things("interface")

1315

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

1316

)).items():

1317

ann_tag = document.createElement("annotation")

1318

ann_tag.setAttribute("name", annotation)

1319

ann_tag.setAttribute("value", value)

1320

if_tag.appendChild(ann_tag)

1321

# Fix argument name for the Introspect method itself

1322

if (if_tag.getAttribute("name")

1323

== dbus.INTROSPECTABLE_IFACE):

1324

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

1325

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

1326

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

1327

if (arg.getAttribute("direction")

1328

== "out"):

1329

arg.setAttribute("name",

1330

"xml_data")

1331

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

1332

document.unlink()

1333

except (AttributeError, xml.dom.DOMException,

1334

xml.parsers.expat.ExpatError) as error:

1335

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

1336

exc_info=error)

1337

return xmlstring

1338

1339

1340

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1341

"""A D-Bus object with properties.

1342

1343

Classes inheriting from this can use the dbus_service_property

1344

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

1345

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

1346

"""

1347

899

1348

def _get_dbus_property(self, interface_name, property_name):

900

1349

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

901

1350

property with the specified name and interface.

902

1351

"""

903

for cls in self.__class__.__mro__:

904

for name, value in (inspect.getmembers

905

(cls,

906

self._is_dbus_thing("property"))):

1352

for cls in self.__class__.__mro__:

1353

for name, value in inspect.getmembers(

1354

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

907

1355

if (value._dbus_name == property_name

908

1356

and value._dbus_interface == interface_name):

909

1357

return value.__get__(self)

910

1358

911

1359

# No such property

912

raise DBusPropertyNotFound(self.dbus_object_path + ":"

913

+ interface_name + "."

914

+ property_name)

915

916

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

1360

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

1361

self.dbus_object_path, interface_name, property_name))

1362

1363

@classmethod

1364

def _get_all_interface_names(cls):

1365

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

1366

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

1367

"_dbus_interface", None)

1368

for x in (inspect.getmro(cls))

1369

for attr in dir(x))

1370

if name is not None)

1371

1372

@dbus.service.method(dbus.PROPERTIES_IFACE,

1373

in_signature="ss",

917

1374

out_signature="v")

918

1375

def Get(self, interface_name, property_name):

919

1376

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

925

1382

if not hasattr(value, "variant_level"):

926

1383

return value

927

1384

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

928

1385

929

1386

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

930

1387

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

931

1388

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

938

1395

# signatures other than "ay".

939

1396

if prop._dbus_signature != "ay":

940

1397

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

941

"'ay' signature {0!r}"

1398

"'ay' signature {!r}"

942

1399

.format(prop._dbus_signature))

943

1400

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

944

1401

for byte in value))

945

1402

prop(value)

946

947

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

1403

1404

@dbus.service.method(dbus.PROPERTIES_IFACE,

1405

in_signature="s",

948

1406

out_signature="a{sv}")

949

1407

def GetAll(self, interface_name):

950

1408

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

951

1409

standard.

952

1410

953

1411

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

954

1412

"""

955

1413

properties = {}

965

1423

if not hasattr(value, "variant_level"):

966

1424

properties[name] = value

967

1425

continue

968

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

969

value.variant_level+1)

1426

properties[name] = type(value)(

1427

value, variant_level=value.variant_level + 1)

970

1428

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

971

1429

1430

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

1431

def PropertiesChanged(self, interface_name, changed_properties,

1432

invalidated_properties):

1433

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

1434

standard.

1435

"""

1436

pass

1437

972

1438

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

973

1439

out_signature="s",

974

1440

path_keyword='object_path',

975

1441

connection_keyword='connection')

976

1442

def Introspect(self, object_path, connection):

977

1443

"""Overloading of standard D-Bus method.

978

1444

979

1445

Inserts property tags and interface annotation tags.

980

1446

"""

981

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

982

connection)

1447

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1448

object_path,

1449

connection)

983

1450

try:

984

1451

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

1452

985

1453

def make_tag(document, name, prop):

986

1454

e = document.createElement("property")

987

1455

e.setAttribute("name", name)

988

1456

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

989

1457

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

990

1458

return e

1459

991

1460

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

992

1461

# Add property tags

993

1462

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

996

1465

if prop._dbus_interface

997

1466

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

998

1467

if_tag.appendChild(tag)

999

# Add annotation tags

1000

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

1001

for tag in if_tag.getElementsByTagName(typ):

1002

annots = dict()

1003

for name, prop in (self.

1004

_get_all_dbus_things(typ)):

1005

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

1006

and prop._dbus_interface

1007

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

1008

annots.update(getattr

1009

(prop,

1010

"_dbus_annotations",

1011

{}))

1012

for name, value in annots.iteritems():

1013

ann_tag = document.createElement(

1014

"annotation")

1015

ann_tag.setAttribute("name", name)

1016

ann_tag.setAttribute("value", value)

1017

tag.appendChild(ann_tag)

1018

# Add interface annotation tags

1019

for annotation, value in dict(

1020

itertools.chain.from_iterable(

1021

annotations().iteritems()

1022

for name, annotations in

1023

self._get_all_dbus_things("interface")

1024

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

1025

)).iteritems():

1026

ann_tag = document.createElement("annotation")

1027

ann_tag.setAttribute("name", annotation)

1028

ann_tag.setAttribute("value", value)

1029

if_tag.appendChild(ann_tag)

1468

# Add annotation tags for properties

1469

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

1470

annots = dict()

1471

for name, prop in self._get_all_dbus_things(

1472

"property"):

1473

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

1474

and prop._dbus_interface

1475

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

1476

annots.update(getattr(

1477

prop, "_dbus_annotations", {}))

1478

for name, value in annots.items():

1479

ann_tag = document.createElement(

1480

"annotation")

1481

ann_tag.setAttribute("name", name)

1482

ann_tag.setAttribute("value", value)

1483

tag.appendChild(ann_tag)

1030

1484

# Add the names to the return values for the

1031

1485

# "org.freedesktop.DBus.Properties" methods

1032

1486

if (if_tag.getAttribute("name")

1051

1505

return xmlstring

1052

1506

1053

1507

1508

try:

1509

dbus.OBJECT_MANAGER_IFACE

1510

except AttributeError:

1511

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

1512

1513

1514

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1515

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

1516

1517

Classes inheriting from this exposes the standard

1518

GetManagedObjects call and the InterfacesAdded and

1519

InterfacesRemoved signals on the standard

1520

"org.freedesktop.DBus.ObjectManager" interface.

1521

1522

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

1523

manually.

1524

"""

1525

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1526

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

1527

def GetManagedObjects(self):

1528

"""This function must be overridden"""

1529

raise NotImplementedError()

1530

1531

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1532

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

1533

def InterfacesAdded(self, object_path, interfaces_and_properties):

1534

pass

1535

1536

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

1537

def InterfacesRemoved(self, object_path, interfaces):

1538

pass

1539

1540

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1541

out_signature="s",

1542

path_keyword='object_path',

1543

connection_keyword='connection')

1544

def Introspect(self, object_path, connection):

1545

"""Overloading of standard D-Bus method.

1546

1547

Override return argument name of GetManagedObjects to be

1548

"objpath_interfaces_and_properties"

1549

"""

1550

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1551

object_path,

1552

connection)

1553

try:

1554

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

1555

1556

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

1557

# Fix argument name for the GetManagedObjects method

1558

if (if_tag.getAttribute("name")

1559

== dbus.OBJECT_MANAGER_IFACE):

1560

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

1561

if (cn.getAttribute("name")

1562

== "GetManagedObjects"):

1563

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

1564

if (arg.getAttribute("direction")

1565

== "out"):

1566

arg.setAttribute(

1567

"name",

1568

"objpath_interfaces"

1569

"_and_properties")

1570

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

1571

document.unlink()

1572

except (AttributeError, xml.dom.DOMException,

1573

xml.parsers.expat.ExpatError) as error:

1574

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

1575

exc_info=error)

1576

return xmlstring

1577

1578

1054

1579

def datetime_to_dbus(dt, variant_level=0):

1055

1580

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

1056

1581

if dt is None:

1057

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

1058

return dbus.String(dt.isoformat(),

1059

variant_level=variant_level)

1582

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

1583

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

1060

1584

1061

1585

1062

1586

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1064

1588

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

1065

1589

interface names according to the "alt_interface_names" mapping.

1066

1590

Usage:

1067

1591

1068

1592

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

1069

1593

"net.example.AlternateInterface"})

1070

1594

class SampleDBusObject(dbus.service.Object):

1071

1595

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

1072

1596

def SampleDBusMethod():

1073

1597

pass

1074

1598

1075

1599

The above "SampleDBusMethod" on "SampleDBusObject" will be

1076

1600

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

1077

1601

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

1078

1602

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

1079

1603

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

1080

1604

1081

1605

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

1082

1606

(from DBusObjectWithProperties) and interfaces (from the

1083

1607

dbus_interface_annotations decorator).

1084

1608

"""

1609

1085

1610

def wrapper(cls):

1086

1611

for orig_interface_name, alt_interface_name in (

1087

alt_interface_names.iteritems()):

1612

alt_interface_names.items()):

1088

1613

attr = {}

1089

1614

interface_names = set()

1090

1615

# Go though all attributes of the class

1092

1617

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

1093

1618

# with the wrong interface name

1094

1619

if (not hasattr(attribute, "_dbus_interface")

1095

or not attribute._dbus_interface

1096

.startswith(orig_interface_name)):

1620

or not attribute._dbus_interface.startswith(

1621

orig_interface_name)):

1097

1622

continue

1098

1623

# Create an alternate D-Bus interface name based on

1099

1624

# the current name

1100

alt_interface = (attribute._dbus_interface

1101

.replace(orig_interface_name,

1102

alt_interface_name))

1625

alt_interface = attribute._dbus_interface.replace(

1626

orig_interface_name, alt_interface_name)

1103

1627

interface_names.add(alt_interface)

1104

1628

# Is this a D-Bus signal?

1105

1629

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

1106

1630

# Extract the original non-method undecorated

1107

1631

# function by black magic

1108

nonmethod_func = (dict(

1632

if sys.version_info.major == 2:

1633

nonmethod_func = (dict(

1109

1634

zip(attribute.func_code.co_freevars,

1110

attribute.__closure__))["func"]

1111

.cell_contents)

1635

attribute.__closure__))

1636

["func"].cell_contents)

1637

else:

1638

nonmethod_func = (dict(

1639

zip(attribute.__code__.co_freevars,

1640

attribute.__closure__))

1641

["func"].cell_contents)

1112

1642

# Create a new, but exactly alike, function

1113

1643

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

1114

1644

# with the alternate D-Bus interface name

1115

new_function = (dbus.service.signal

1116

(alt_interface,

1117

attribute._dbus_signature)

1118

(types.FunctionType(

1119

nonmethod_func.func_code,

1120

nonmethod_func.func_globals,

1121

nonmethod_func.func_name,

1122

nonmethod_func.func_defaults,

1123

nonmethod_func.func_closure)))

1645

new_function = copy_function(nonmethod_func)

1646

new_function = (dbus.service.signal(

1647

alt_interface,

1648

attribute._dbus_signature)(new_function))

1124

1649

# Copy annotations, if any

1125

1650

try:

1126

new_function._dbus_annotations = (

1127

dict(attribute._dbus_annotations))

1651

new_function._dbus_annotations = dict(

1652

attribute._dbus_annotations)

1128

1653

except AttributeError:

1129

1654

pass

1655

1130

1656

# Define a creator of a function to call both the

1131

1657

# original and alternate functions, so both the

1132

1658

# original and alternate signals gets sent when

1135

1661

"""This function is a scope container to pass

1136

1662

func1 and func2 to the "call_both" function

1137

1663

outside of its arguments"""

1664

1665

@functools.wraps(func2)

1138

1666

def call_both(*args, **kwargs):

1139

1667

"""This function will emit two D-Bus

1140

1668

signals by calling func1 and func2"""

1141

1669

func1(*args, **kwargs)

1142

1670

func2(*args, **kwargs)

1671

# Make wrapper function look like a D-Bus

1672

# signal

1673

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

1674

if name.startswith("_dbus_"):

1675

setattr(call_both, name, attr)

1676

1143

1677

return call_both

1144

1678

# Create the "call_both" function and add it to

1145

1679

# the class

1150

1684

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

1151

1685

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

1152

1686

# to the class.

1153

attr[attrname] = (dbus.service.method

1154

(alt_interface,

1155

attribute._dbus_in_signature,

1156

attribute._dbus_out_signature)

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1687

attr[attrname] = (

1688

dbus.service.method(

1689

alt_interface,

1690

attribute._dbus_in_signature,

1691

attribute._dbus_out_signature)

1692

(copy_function(attribute)))

1163

1693

# Copy annotations, if any

1164

1694

try:

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1695

attr[attrname]._dbus_annotations = dict(

1696

attribute._dbus_annotations)

1167

1697

except AttributeError:

1168

1698

pass

1169

1699

# Is this a D-Bus property?

1172

1702

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

1173

1703

# property with the alternate D-Bus interface

1174

1704

# name. Add it to the class.

1175

attr[attrname] = (dbus_service_property

1176

(alt_interface,

1177

attribute._dbus_signature,

1178

attribute._dbus_access,

1179

attribute

1180

._dbus_get_args_options

1181

["byte_arrays"])

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

attribute.func_closure)))

1705

attr[attrname] = (dbus_service_property(

1706

alt_interface, attribute._dbus_signature,

1707

attribute._dbus_access,

1708

attribute._dbus_get_args_options

1709

["byte_arrays"])

1710

(copy_function(attribute)))

1188

1711

# Copy annotations, if any

1189

1712

try:

1190

attr[attrname]._dbus_annotations = (

1191

dict(attribute._dbus_annotations))

1713

attr[attrname]._dbus_annotations = dict(

1714

attribute._dbus_annotations)

1192

1715

except AttributeError:

1193

1716

pass

1194

1717

# Is this a D-Bus interface?

1197

1720

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

1198

1721

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

1199

1722

# to the class.

1200

attr[attrname] = (dbus_interface_annotations

1201

(alt_interface)

1202

(types.FunctionType

1203

(attribute.func_code,

1204

attribute.func_globals,

1205

attribute.func_name,

1206

attribute.func_defaults,

1207

attribute.func_closure)))

1723

attr[attrname] = (

1724

dbus_interface_annotations(alt_interface)

1725

(copy_function(attribute)))

1208

1726

if deprecate:

1209

1727

# Deprecate all alternate interfaces

1210

iname="_AlternateDBusNames_interface_annotation{0}"

1728

iname = "_AlternateDBusNames_interface_annotation{}"

1211

1729

for interface_name in interface_names:

1730

1212

1731

@dbus_interface_annotations(interface_name)

1213

1732

def func(self):

1214

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

1215

"true" }

1733

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

1734

"true"}

1216

1735

# Find an unused name

1217

1736

for aname in (iname.format(i)

1218

1737

for i in itertools.count()):

1222

1741

if interface_names:

1223

1742

# Replace the class with a new subclass of it with

1224

1743

# methods, signals, etc. as created above.

1225

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

1226

(cls,), attr)

1744

if sys.version_info.major == 2:

1745

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

1746

(cls, ), attr)

1747

else:

1748

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

1749

(cls, ), attr)

1227

1750

return cls

1751

1228

1752

return wrapper

1229

1753

1230

1754

1231

1755

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

1232

"se.bsnet.fukt.Mandos"})

1756

"se.bsnet.fukt.Mandos"})

1233

1757

class ClientDBus(Client, DBusObjectWithProperties):

1234

1758

"""A Client class using D-Bus

1235

1759

1236

1760

Attributes:

1237

1761

dbus_object_path: dbus.ObjectPath

1238

1762

bus: dbus.SystemBus()

1239

1763

"""

1240

1764

1241

1765

runtime_expansions = (Client.runtime_expansions

1242

+ ("dbus_object_path",))

1243

1766

+ ("dbus_object_path", ))

1767

1768

_interface = "se.recompile.Mandos.Client"

1769

1244

1770

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

1245

1246

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

1771

1772

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

1247

1773

self.bus = bus

1248

1774

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

1249

1775

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

1250

1776

# the D-Bus

1251

client_object_name = unicode(self.name).translate(

1777

client_object_name = str(self.name).translate(

1252

1778

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

1253

1779

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

1254

self.dbus_object_path = (dbus.ObjectPath

1255

("/clients/" + client_object_name))

1780

self.dbus_object_path = dbus.ObjectPath(

1781

"/clients/" + client_object_name)

1256

1782

DBusObjectWithProperties.__init__(self, self.bus,

1257

1783

self.dbus_object_path)

1258

1259

def notifychangeproperty(transform_func,

1260

dbus_name, type_func=lambda x: x,

1261

variant_level=1):

1784

1785

def notifychangeproperty(transform_func, dbus_name,

1786

type_func=lambda x: x,

1787

variant_level=1,

1788

invalidate_only=False,

1789

_interface=_interface):

1262

1790

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

1263

1791

its changes to DBus.

1264

1792

1265

1793

transform_fun: Function that takes a value and a variant_level

1266

1794

and transforms it to a D-Bus type.

1267

1795

dbus_name: D-Bus name of the variable

1269

1797

to the D-Bus. Default: no transform

1270

1798

variant_level: D-Bus variant level. Default: 1

1271

1799

"""

1272

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

1800

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

1801

1273

1802

def setter(self, value):

1274

1803

if hasattr(self, "dbus_object_path"):

1275

1804

if (not hasattr(self, attrname) or

1276

1805

type_func(getattr(self, attrname, None))

1277

1806

!= type_func(value)):

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1281

self.PropertyChanged(dbus.String(dbus_name),

1282

dbus_value)

1807

if invalidate_only:

1808

self.PropertiesChanged(

1809

_interface, dbus.Dictionary(),

1810

dbus.Array((dbus_name, )))

1811

else:

1812

dbus_value = transform_func(

1813

type_func(value),

1814

variant_level=variant_level)

1815

self.PropertyChanged(dbus.String(dbus_name),

1816

dbus_value)

1817

self.PropertiesChanged(

1818

_interface,

1819

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

1820

dbus_value}),

1821

dbus.Array())

1283

1822

setattr(self, attrname, value)

1284

1823

1285

1824

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

1286

1825

1287

1826

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1288

1827

approvals_pending = notifychangeproperty(dbus.Boolean,

1289

1828

"ApprovalPending",

1290

type_func = bool)

1829

type_func=bool)

1291

1830

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

1292

1831

last_enabled = notifychangeproperty(datetime_to_dbus,

1293

1832

"LastEnabled")

1294

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

1295

type_func = lambda checker:

1296

checker is not None)

1833

checker = notifychangeproperty(

1834

dbus.Boolean, "CheckerRunning",

1835

type_func=lambda checker: checker is not None)

1297

1836

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1298

1837

"LastCheckedOK")

1299

1838

last_checker_status = notifychangeproperty(dbus.Int16,

1302

1841

datetime_to_dbus, "LastApprovalRequest")

1303

1842

approved_by_default = notifychangeproperty(dbus.Boolean,

1304

1843

"ApprovedByDefault")

1305

approval_delay = notifychangeproperty(dbus.UInt64,

1306

"ApprovalDelay",

1307

type_func =

1308

timedelta_to_milliseconds)

1844

approval_delay = notifychangeproperty(

1845

dbus.UInt64, "ApprovalDelay",

1846

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

1309

1847

approval_duration = notifychangeproperty(

1310

1848

dbus.UInt64, "ApprovalDuration",

1311

type_func = timedelta_to_milliseconds)

1849

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

1312

1850

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

1313

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

1314

type_func =

1315

timedelta_to_milliseconds)

1851

timeout = notifychangeproperty(

1852

dbus.UInt64, "Timeout",

1853

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

1316

1854

extended_timeout = notifychangeproperty(

1317

1855

dbus.UInt64, "ExtendedTimeout",

1318

type_func = timedelta_to_milliseconds)

1319

interval = notifychangeproperty(dbus.UInt64,

1320

"Interval",

1321

type_func =

1322

timedelta_to_milliseconds)

1856

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

1857

interval = notifychangeproperty(

1858

dbus.UInt64, "Interval",

1859

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

1323

1860

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

1324

1861

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

1862

invalidate_only=True)

1863

1325

1864

del notifychangeproperty

1326

1865

1327

1866

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

1328

1867

try:

1329

1868

self.remove_from_connection()

1332

1871

if hasattr(DBusObjectWithProperties, "__del__"):

1333

1872

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

1334

1873

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

1335

1336

def checker_callback(self, pid, condition, command,

1337

*args, **kwargs):

1338

self.checker_callback_tag = None

1339

self.checker = None

1340

if os.WIFEXITED(condition):

1341

exitstatus = os.WEXITSTATUS(condition)

1874

1875

def checker_callback(self, source, condition,

1876

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

1877

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

1878

connection, command, *args,

1879

**kwargs)

1880

exitstatus = self.last_checker_status

1881

if exitstatus >= 0:

1342

1882

# Emit D-Bus signal

1343

1883

self.CheckerCompleted(dbus.Int16(exitstatus),

1344

dbus.Int64(condition),

1884

# This is specific to GNU libC

1885

dbus.Int64(exitstatus << 8),

1345

1886

dbus.String(command))

1346

1887

else:

1347

1888

# Emit D-Bus signal

1348

1889

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

1349

dbus.Int64(condition),

1890

dbus.Int64(

1891

# This is specific to GNU libC

1892

(exitstatus << 8)

1893

| self.last_checker_signal),

1350

1894

dbus.String(command))

1351

1352

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

1353

*args, **kwargs)

1354

1895

return ret

1896

1355

1897

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

1356

1898

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

1357

1899

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

1361

1903

# Emit D-Bus signal

1362

1904

self.CheckerStarted(self.current_checker_command)

1363

1905

return r

1364

1906

1365

1907

def _reset_approved(self):

1366

1908

self.approved = None

1367

1909

return False

1368

1910

1369

1911

def approve(self, value=True):

1370

1912

self.approved = value

1371

gobject.timeout_add(timedelta_to_milliseconds

1372

(self.approval_duration),

1373

self._reset_approved)

1913

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

1914

* 1000), self._reset_approved)

1374

1915

self.send_changedstate()

1375

1376

## D-Bus methods, signals & properties

1377

_interface = "se.recompile.Mandos.Client"

1378

1379

## Interfaces

1380

1381

@dbus_interface_annotations(_interface)

1382

def _foo(self):

1383

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

1384

"false"}

1385

1386

## Signals

1387

1916

1917

# D-Bus methods, signals & properties

1918

1919

# Interfaces

1920

1921

# Signals

1922

1388

1923

# CheckerCompleted - signal

1389

1924

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

1390

1925

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

1391

1926

"D-Bus signal"

1392

1927

pass

1393

1928

1394

1929

# CheckerStarted - signal

1395

1930

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

1396

1931

def CheckerStarted(self, command):

1397

1932

"D-Bus signal"

1398

1933

pass

1399

1934

1400

1935

# PropertyChanged - signal

1936

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

1401

1937

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

1402

1938

def PropertyChanged(self, property, value):

1403

1939

"D-Bus signal"

1404

1940

pass

1405

1941

1406

1942

# GotSecret - signal

1407

1943

@dbus.service.signal(_interface)

1408

1944

def GotSecret(self):

1411

1947

server to mandos-client

1412

1948

"""

1413

1949

pass

1414

1950

1415

1951

# Rejected - signal

1416

1952

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

1417

1953

def Rejected(self, reason):

1418

1954

"D-Bus signal"

1419

1955

pass

1420

1956

1421

1957

# NeedApproval - signal

1422

1958

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

1423

1959

def NeedApproval(self, timeout, default):

1424

1960

"D-Bus signal"

1425

1961

return self.need_approval()

1426

1427

## Methods

1428

1962

1963

# Methods

1964

1429

1965

# Approve - method

1430

1966

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

1431

1967

def Approve(self, value):

1432

1968

self.approve(value)

1433

1969

1434

1970

# CheckedOK - method

1435

1971

@dbus.service.method(_interface)

1436

1972

def CheckedOK(self):

1437

1973

self.checked_ok()

1438

1974

1439

1975

# Enable - method

1976

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

1440

1977

@dbus.service.method(_interface)

1441

1978

def Enable(self):

1442

1979

"D-Bus method"

1443

1980

self.enable()

1444

1981

1445

1982

# StartChecker - method

1983

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

1446

1984

@dbus.service.method(_interface)

1447

1985

def StartChecker(self):

1448

1986

"D-Bus method"

1449

1987

self.start_checker()

1450

1988

1451

1989

# Disable - method

1990

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

1452

1991

@dbus.service.method(_interface)

1453

1992

def Disable(self):

1454

1993

"D-Bus method"

1455

1994

self.disable()

1456

1995

1457

1996

# StopChecker - method

1997

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

1458

1998

@dbus.service.method(_interface)

1459

1999

def StopChecker(self):

1460

2000

self.stop_checker()

1461

1462

## Properties

1463

2001

2002

# Properties

2003

1464

2004

# ApprovalPending - property

1465

2005

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

1466

2006

def ApprovalPending_dbus_property(self):

1467

2007

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

1468

2008

1469

2009

# ApprovedByDefault - property

1470

@dbus_service_property(_interface, signature="b",

2010

@dbus_service_property(_interface,

2011

signature="b",

1471

2012

access="readwrite")

1472

2013

def ApprovedByDefault_dbus_property(self, value=None):

1473

2014

if value is None: # get

1474

2015

return dbus.Boolean(self.approved_by_default)

1475

2016

self.approved_by_default = bool(value)

1476

2017

1477

2018

# ApprovalDelay - property

1478

@dbus_service_property(_interface, signature="t",

2019

@dbus_service_property(_interface,

2020

signature="t",

1479

2021

access="readwrite")

1480

2022

def ApprovalDelay_dbus_property(self, value=None):

1481

2023

if value is None: # get

1482

return dbus.UInt64(self.approval_delay_milliseconds())

2024

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

2025

* 1000)

1483

2026

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

1484

2027

1485

2028

# ApprovalDuration - property

1486

@dbus_service_property(_interface, signature="t",

2029

@dbus_service_property(_interface,

2030

signature="t",

1487

2031

access="readwrite")

1488

2032

def ApprovalDuration_dbus_property(self, value=None):

1489

2033

if value is None: # get

1490

return dbus.UInt64(timedelta_to_milliseconds(

1491

self.approval_duration))

2034

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

2035

* 1000)

1492

2036

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

1493

2037

1494

2038

# Name - property

2039

@dbus_annotations(

2040

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

1495

2041

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

1496

2042

def Name_dbus_property(self):

1497

2043

return dbus.String(self.name)

1498

2044

2045

# KeyID - property

2046

@dbus_annotations(

2047

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

2048

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

2049

def KeyID_dbus_property(self):

2050

return dbus.String(self.key_id)

2051

1499

2052

# Fingerprint - property

2053

@dbus_annotations(

2054

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

1500

2055

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

1501

2056

def Fingerprint_dbus_property(self):

1502

2057

return dbus.String(self.fingerprint)

1503

2058

1504

2059

# Host - property

1505

@dbus_service_property(_interface, signature="s",

2060

@dbus_service_property(_interface,

2061

signature="s",

1506

2062

access="readwrite")

1507

2063

def Host_dbus_property(self, value=None):

1508

2064

if value is None: # get

1509

2065

return dbus.String(self.host)

1510

self.host = unicode(value)

1511

2066

self.host = str(value)

2067

1512

2068

# Created - property

2069

@dbus_annotations(

2070

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

1513

2071

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

1514

2072

def Created_dbus_property(self):

1515

2073

return datetime_to_dbus(self.created)

1516

2074

1517

2075

# LastEnabled - property

1518

2076

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

1519

2077

def LastEnabled_dbus_property(self):

1520

2078

return datetime_to_dbus(self.last_enabled)

1521

2079

1522

2080

# Enabled - property

1523

@dbus_service_property(_interface, signature="b",

2081

@dbus_service_property(_interface,

2082

signature="b",

1524

2083

access="readwrite")

1525

2084

def Enabled_dbus_property(self, value=None):

1526

2085

if value is None: # get

1529

2088

self.enable()

1530

2089

else:

1531

2090

self.disable()

1532

2091

1533

2092

# LastCheckedOK - property

1534

@dbus_service_property(_interface, signature="s",

2093

@dbus_service_property(_interface,

2094

signature="s",

1535

2095

access="readwrite")

1536

2096

def LastCheckedOK_dbus_property(self, value=None):

1537

2097

if value is not None:

1538

2098

self.checked_ok()

1539

2099

return

1540

2100

return datetime_to_dbus(self.last_checked_ok)

1541

2101

1542

2102

# LastCheckerStatus - property

1543

@dbus_service_property(_interface, signature="n",

1544

access="read")

2103

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

1545

2104

def LastCheckerStatus_dbus_property(self):

1546

2105

return dbus.Int16(self.last_checker_status)

1547

2106

1548

2107

# Expires - property

1549

2108

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

1550

2109

def Expires_dbus_property(self):

1551

2110

return datetime_to_dbus(self.expires)

1552

2111

1553

2112

# LastApprovalRequest - property

1554

2113

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

1555

2114

def LastApprovalRequest_dbus_property(self):

1556

2115

return datetime_to_dbus(self.last_approval_request)

1557

2116

1558

2117

# Timeout - property

1559

@dbus_service_property(_interface, signature="t",

2118

@dbus_service_property(_interface,

2119

signature="t",

1560

2120

access="readwrite")

1561

2121

def Timeout_dbus_property(self, value=None):

1562

2122

if value is None: # get

1563

return dbus.UInt64(self.timeout_milliseconds())

2123

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

1564

2124

old_timeout = self.timeout

1565

2125

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

1566

2126

# Reschedule disabling

1574

2134

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

1575

2135

is None):

1576

2136

return

1577

gobject.source_remove(self.disable_initiator_tag)

1578

self.disable_initiator_tag = (

1579

gobject.timeout_add(

1580

timedelta_to_milliseconds(self.expires - now),

1581

self.disable))

1582

2137

GLib.source_remove(self.disable_initiator_tag)

2138

self.disable_initiator_tag = GLib.timeout_add(

2139

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

2140

self.disable)

2141

1583

2142

# ExtendedTimeout - property

1584

@dbus_service_property(_interface, signature="t",

2143

@dbus_service_property(_interface,

2144

signature="t",

1585

2145

access="readwrite")

1586

2146

def ExtendedTimeout_dbus_property(self, value=None):

1587

2147

if value is None: # get

1588

return dbus.UInt64(self.extended_timeout_milliseconds())

2148

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

2149

* 1000)

1589

2150

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

1590

2151

1591

2152

# Interval - property

1592

@dbus_service_property(_interface, signature="t",

2153

@dbus_service_property(_interface,

2154

signature="t",

1593

2155

access="readwrite")

1594

2156

def Interval_dbus_property(self, value=None):

1595

2157

if value is None: # get

1596

return dbus.UInt64(self.interval_milliseconds())

2158

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

1597

2159

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

1598

2160

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

1599

2161

return

1600

2162

if self.enabled:

1601

2163

# Reschedule checker run

1602

gobject.source_remove(self.checker_initiator_tag)

1603

self.checker_initiator_tag = (gobject.timeout_add

1604

(value, self.start_checker))

1605

self.start_checker() # Start one now, too

1606

2164

GLib.source_remove(self.checker_initiator_tag)

2165

self.checker_initiator_tag = GLib.timeout_add(

2166

value, self.start_checker)

2167

self.start_checker() # Start one now, too

2168

1607

2169

# Checker - property

1608

@dbus_service_property(_interface, signature="s",

2170

@dbus_service_property(_interface,

2171

signature="s",

1609

2172

access="readwrite")

1610

2173

def Checker_dbus_property(self, value=None):

1611

2174

if value is None: # get

1612

2175

return dbus.String(self.checker_command)

1613

self.checker_command = unicode(value)

1614

2176

self.checker_command = str(value)

2177

1615

2178

# CheckerRunning - property

1616

@dbus_service_property(_interface, signature="b",

2179

@dbus_service_property(_interface,

2180

signature="b",

1617

2181

access="readwrite")

1618

2182

def CheckerRunning_dbus_property(self, value=None):

1619

2183

if value is None: # get

1622

2186

self.start_checker()

1623

2187

else:

1624

2188

self.stop_checker()

1625

2189

1626

2190

# ObjectPath - property

2191

@dbus_annotations(

2192

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

2193

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

1627

2194

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

1628

2195

def ObjectPath_dbus_property(self):

1629

return self.dbus_object_path # is already a dbus.ObjectPath

1630

2196

return self.dbus_object_path # is already a dbus.ObjectPath

2197

1631

2198

# Secret = property

1632

@dbus_service_property(_interface, signature="ay",

1633

access="write", byte_arrays=True)

2199

@dbus_annotations(

2200

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

2201

"invalidates"})

2202

@dbus_service_property(_interface,

2203

signature="ay",

2204

access="write",

2205

byte_arrays=True)

1634

2206

def Secret_dbus_property(self, value):

1635

self.secret = str(value)

1636

2207

self.secret = bytes(value)

2208

1637

2209

del _interface

1638

2210

1639

2211

1640

2212

class ProxyClient(object):

1641

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

2213

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

1642

2214

self._pipe = child_pipe

1643

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

2215

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

1644

2216

if not self._pipe.recv():

1645

raise KeyError()

1646

2217

raise KeyError(key_id or fpr)

2218

1647

2219

def __getattribute__(self, name):

1648

2220

if name == '_pipe':

1649

2221

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

1652

2224

if data[0] == 'data':

1653

2225

return data[1]

1654

2226

if data[0] == 'function':

2227

1655

2228

def func(*args, **kwargs):

1656

2229

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

1657

2230

return self._pipe.recv()[1]

2231

1658

2232

return func

1659

2233

1660

2234

def __setattr__(self, name, value):

1661

2235

if name == '_pipe':

1662

2236

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

1665

2239

1666

2240

class ClientHandler(socketserver.BaseRequestHandler, object):

1667

2241

"""A class to handle client connections.

1668

2242

1669

2243

Instantiated once for each connection to handle it.

1670

2244

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

1671

2245

1672

2246

def handle(self):

1673

2247

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

1674

2248

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

1675

unicode(self.client_address))

2249

str(self.client_address))

1676

2250

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

1677

2251

self.server.child_pipe.fileno())

1678

1679

session = (gnutls.connection

1680

.ClientSession(self.request,

1681

gnutls.connection

1682

.X509Credentials()))

1683

1684

# Note: gnutls.connection.X509Credentials is really a

1685

# generic GnuTLS certificate credentials object so long as

1686

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

1687

# here despite using OpenPGP certificates.

1688

1689

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

1690

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

1691

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

1692

# "+DHE-DSS"))

2252

2253

session = gnutls.ClientSession(self.request)

2254

2255

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

2256

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

2257

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

2258

# "+DHE-DSS"))

1693

2259

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

1694

2260

priority = self.server.gnutls_priority

1695

2261

if priority is None:

1696

2262

priority = "NORMAL"

1697

(gnutls.library.functions

1698

.gnutls_priority_set_direct(session._c_object,

1699

priority, None))

1700

2263

gnutls.priority_set_direct(session._c_object,

2264

priority.encode("utf-8"),

2265

None)

2266

1701

2267

# Start communication using the Mandos protocol

1702

2268

# Get protocol number

1703

2269

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

1708

2274

except (ValueError, IndexError, RuntimeError) as error:

1709

2275

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

1710

2276

return

1711

2277

1712

2278

# Start GnuTLS connection

1713

2279

try:

1714

2280

session.handshake()

1715

except gnutls.errors.GNUTLSError as error:

2281

except gnutls.Error as error:

1716

2282

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

1717

2283

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

1718

2284

# established. Just abandon the request.

1719

2285

return

1720

2286

logger.debug("Handshake succeeded")

1721

2287

1722

2288

approval_required = False

1723

2289

try:

1724

try:

1725

fpr = self.fingerprint(self.peer_certificate

1726

(session))

1727

except (TypeError,

1728

gnutls.errors.GNUTLSError) as error:

1729

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

1730

return

1731

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

1732

1733

try:

1734

client = ProxyClient(child_pipe, fpr,

2290

if gnutls.has_rawpk:

2291

fpr = b""

2292

try:

2293

key_id = self.key_id(

2294

self.peer_certificate(session))

2295

except (TypeError, gnutls.Error) as error:

2296

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

2297

return

2298

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

2299

2300

else:

2301

key_id = b""

2302

try:

2303

fpr = self.fingerprint(

2304

self.peer_certificate(session))

2305

except (TypeError, gnutls.Error) as error:

2306

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

2307

return

2308

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

2309

2310

try:

2311

client = ProxyClient(child_pipe, key_id, fpr,

1735

2312

self.client_address)

1736

2313

except KeyError:

1737

2314

return

1738

2315

1739

2316

if client.approval_delay:

1740

2317

delay = client.approval_delay

1741

2318

client.approvals_pending += 1

1742

2319

approval_required = True

1743

2320

1744

2321

while True:

1745

2322

if not client.enabled:

1746

2323

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

1747

client.name)

2324

client.name)

1748

2325

if self.server.use_dbus:

1749

2326

# Emit D-Bus signal

1750

2327

client.Rejected("Disabled")

1751

2328

return

1752

2329

1753

2330

if client.approved or not client.approval_delay:

1754

#We are approved or approval is disabled

2331

# We are approved or approval is disabled

1755

2332

break

1756

2333

elif client.approved is None:

1757

2334

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

1759

2336

if self.server.use_dbus:

1760

2337

# Emit D-Bus signal

1761

2338

client.NeedApproval(

1762

client.approval_delay_milliseconds(),

1763

client.approved_by_default)

2339

client.approval_delay.total_seconds()

2340

* 1000, client.approved_by_default)

1764

2341

else:

1765

2342

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

1766

2343

client.name)

1768

2345

# Emit D-Bus signal

1769

2346

client.Rejected("Denied")

1770

2347

return

1771

1772

#wait until timeout or approved

2348

2349

# wait until timeout or approved

1773

2350

time = datetime.datetime.now()

1774

2351

client.changedstate.acquire()

1775

client.changedstate.wait(

1776

float(timedelta_to_milliseconds(delay)

1777

/ 1000))

2352

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

1778

2353

client.changedstate.release()

1779

2354

time2 = datetime.datetime.now()

1780

2355

if (time2 - time) >= delay:

1790

2365

break

1791

2366

else:

1792

2367

delay -= time2 - time

1793

1794

sent_size = 0

1795

while sent_size < len(client.secret):

1796

try:

1797

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

1798

except gnutls.errors.GNUTLSError as error:

1799

logger.warning("gnutls send failed",

1800

exc_info=error)

1801

return

1802

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

1803

sent, len(client.secret)

1804

- (sent_size + sent))

1805

sent_size += sent

1806

2368

2369

try:

2370

session.send(client.secret)

2371

except gnutls.Error as error:

2372

logger.warning("gnutls send failed",

2373

exc_info=error)

2374

return

2375

1807

2376

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

1808

2377

# bump the timeout using extended_timeout

1809

2378

client.bump_timeout(client.extended_timeout)

1810

2379

if self.server.use_dbus:

1811

2380

# Emit D-Bus signal

1812

2381

client.GotSecret()

1813

2382

1814

2383

finally:

1815

2384

if approval_required:

1816

2385

client.approvals_pending -= 1

1817

2386

try:

1818

2387

session.bye()

1819

except gnutls.errors.GNUTLSError as error:

2388

except gnutls.Error as error:

1820

2389

logger.warning("GnuTLS bye failed",

1821

2390

exc_info=error)

1822

2391

1823

2392

@staticmethod

1824

2393

def peer_certificate(session):

1825

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

1826

# If not an OpenPGP certificate...

1827

if (gnutls.library.functions

1828

.gnutls_certificate_type_get(session._c_object)

1829

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1830

# ...do the normal thing

1831

return session.peer_certificate

2394

"Return the peer's certificate as a bytestring"

2395

try:

2396

cert_type = gnutls.certificate_type_get2(session._c_object,

2397

gnutls.CTYPE_PEERS)

2398

except AttributeError:

2399

cert_type = gnutls.certificate_type_get(session._c_object)

2400

if gnutls.has_rawpk:

2401

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2402

else:

2403

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2404

# If not a valid certificate type...

2405

if cert_type not in valid_cert_types:

2406

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

2407

valid_cert_types)

2408

# ...return invalid data

2409

return b""

1832

2410

list_size = ctypes.c_uint(1)

1833

cert_list = (gnutls.library.functions

1834

.gnutls_certificate_get_peers

2411

cert_list = (gnutls.certificate_get_peers

1835

2412

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

1836

2413

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

1837

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

1838

" certificate")

2414

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

1839

2415

if list_size.value == 0:

1840

2416

return None

1841

2417

cert = cert_list[0]

1842

2418

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

1843

2419

2420

@staticmethod

2421

def key_id(certificate):

2422

"Convert a certificate bytestring to a hexdigit key ID"

2423

# New GnuTLS "datum" with the public key

2424

datum = gnutls.datum_t(

2425

ctypes.cast(ctypes.c_char_p(certificate),

2426

ctypes.POINTER(ctypes.c_ubyte)),

2427

ctypes.c_uint(len(certificate)))

2428

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

2429

# New empty GnuTLS certificate

2430

pubkey = gnutls.pubkey_t()

2431

gnutls.pubkey_init(ctypes.byref(pubkey))

2432

# Import the raw public key into the certificate

2433

gnutls.pubkey_import(pubkey,

2434

ctypes.byref(datum),

2435

gnutls.X509_FMT_DER)

2436

# New buffer for the key ID

2437

buf = ctypes.create_string_buffer(32)

2438

buf_len = ctypes.c_size_t(len(buf))

2439

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

2440

gnutls.pubkey_get_key_id(pubkey,

2441

gnutls.KEYID_USE_SHA256,

2442

ctypes.cast(ctypes.byref(buf),

2443

ctypes.POINTER(ctypes.c_ubyte)),

2444

ctypes.byref(buf_len))

2445

# Deinit the certificate

2446

gnutls.pubkey_deinit(pubkey)

2447

2448

# Convert the buffer to a Python bytestring

2449

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

2450

# Convert the bytestring to hexadecimal notation

2451

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

2452

return hex_key_id

2453

1844

2454

@staticmethod

1845

2455

def fingerprint(openpgp):

1846

2456

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1847

2457

# New GnuTLS "datum" with the OpenPGP public key

1848

datum = (gnutls.library.types

1849

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

1850

ctypes.POINTER

1851

(ctypes.c_ubyte)),

1852

ctypes.c_uint(len(openpgp))))

2458

datum = gnutls.datum_t(

2459

ctypes.cast(ctypes.c_char_p(openpgp),

2460

ctypes.POINTER(ctypes.c_ubyte)),

2461

ctypes.c_uint(len(openpgp)))

1853

2462

# New empty GnuTLS certificate

1854

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1855

(gnutls.library.functions

1856

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2463

crt = gnutls.openpgp_crt_t()

2464

gnutls.openpgp_crt_init(ctypes.byref(crt))

1857

2465

# Import the OpenPGP public key into the certificate

1858

(gnutls.library.functions

1859

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

1860

gnutls.library.constants

1861

.GNUTLS_OPENPGP_FMT_RAW))

2466

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

2467

gnutls.OPENPGP_FMT_RAW)

1862

2468

# Verify the self signature in the key

1863

2469

crtverify = ctypes.c_uint()

1864

(gnutls.library.functions

1865

.gnutls_openpgp_crt_verify_self(crt, 0,

1866

ctypes.byref(crtverify)))

2470

gnutls.openpgp_crt_verify_self(crt, 0,

2471

ctypes.byref(crtverify))

1867

2472

if crtverify.value != 0:

1868

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1869

raise (gnutls.errors.CertificateSecurityError

1870

("Verify failed"))

2473

gnutls.openpgp_crt_deinit(crt)

2474

raise gnutls.CertificateSecurityError(code

2475

=crtverify.value)

1871

2476

# New buffer for the fingerprint

1872

2477

buf = ctypes.create_string_buffer(20)

1873

2478

buf_len = ctypes.c_size_t()

1874

2479

# Get the fingerprint from the certificate into the buffer

1875

(gnutls.library.functions

1876

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

1877

ctypes.byref(buf_len)))

2480

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

2481

ctypes.byref(buf_len))

1878

2482

# Deinit the certificate

1879

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2483

gnutls.openpgp_crt_deinit(crt)

1880

2484

# Convert the buffer to a Python bytestring

1881

2485

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

1882

2486

# Convert the bytestring to hexadecimal notation

1886

2490

1887

2491

class MultiprocessingMixIn(object):

1888

2492

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

2493

1889

2494

def sub_process_main(self, request, address):

1890

2495

try:

1891

2496

self.finish_request(request, address)

1892

2497

except Exception:

1893

2498

self.handle_error(request, address)

1894

2499

self.close_request(request)

1895

2500

1896

2501

def process_request(self, request, address):

1897

2502

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

1898

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

1899

args = (request, address))

2503

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

2504

args=(request, address))

1900

2505

proc.start()

1901

2506

return proc

1902

2507

1903

2508

1904

2509

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1905

2510

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

2511

1906

2512

def process_request(self, request, client_address):

1907

2513

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

1908

2514

1909

2515

This function creates a new pipe in self.pipe

1910

2516

"""

1911

2517

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1912

2518

1913

2519

proc = MultiprocessingMixIn.process_request(self, request,

1914

2520

client_address)

1915

2521

self.child_pipe.close()

1916

2522

self.add_pipe(parent_pipe, proc)

1917

2523

1918

2524

def add_pipe(self, parent_pipe, proc):

1919

2525

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

1920

2526

raise NotImplementedError()

1923

2529

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1924

2530

socketserver.TCPServer, object):

1925

2531

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

1926

2532

1927

2533

Attributes:

1928

2534

enabled: Boolean; whether this server is activated yet

1929

2535

interface: None or a network interface name (string)

1930

2536

use_ipv6: Boolean; to use IPv6 or not

1931

2537

"""

2538

1932

2539

def __init__(self, server_address, RequestHandlerClass,

1933

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

2540

interface=None,

2541

use_ipv6=True,

2542

socketfd=None):

1934

2543

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

1935

2544

creating a new one with socket.socket().

1936

2545

"""

1942

2551

self.socketfd = socketfd

1943

2552

# Save the original socket.socket() function

1944

2553

self.socket_socket = socket.socket

2554

1945

2555

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

1946

#

2556

#

1947

2557

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

1948

2558

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

1949

2559

# patching socket.socket.)

1950

#

2560

#

1951

2561

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

1952

2562

@functools.wraps(socket.socket)

1953

2563

def socket_wrapper(*args, **kwargs):

1965

2575

# socket_wrapper(), if socketfd was set.

1966

2576

socketserver.TCPServer.__init__(self, server_address,

1967

2577

RequestHandlerClass)

1968

2578

1969

2579

def server_bind(self):

1970

2580

"""This overrides the normal server_bind() function

1971

2581

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

1972

2582

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

2583

global SO_BINDTODEVICE

1973

2584

if self.interface is not None:

1974

2585

if SO_BINDTODEVICE is None:

1975

logger.error("SO_BINDTODEVICE does not exist;"

1976

" cannot bind to interface %s",

1977

self.interface)

1978

else:

1979

try:

1980

self.socket.setsockopt(socket.SOL_SOCKET,

1981

SO_BINDTODEVICE,

1982

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

1983

except socket.error as error:

1984

if error.errno == errno.EPERM:

1985

logger.error("No permission to bind to"

1986

" interface %s", self.interface)

1987

elif error.errno == errno.ENOPROTOOPT:

1988

logger.error("SO_BINDTODEVICE not available;"

1989

" cannot bind to interface %s",

1990

self.interface)

1991

elif error.errno == errno.ENODEV:

1992

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

1993

" cannot bind", self.interface)

1994

else:

1995

raise

2586

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

2587

# common enough.

2588

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

2589

SO_BINDTODEVICE = 25

2590

try:

2591

self.socket.setsockopt(

2592

socket.SOL_SOCKET, SO_BINDTODEVICE,

2593

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

2594

except socket.error as error:

2595

if error.errno == errno.EPERM:

2596

logger.error("No permission to bind to"

2597

" interface %s", self.interface)

2598

elif error.errno == errno.ENOPROTOOPT:

2599

logger.error("SO_BINDTODEVICE not available;"

2600

" cannot bind to interface %s",

2601

self.interface)

2602

elif error.errno == errno.ENODEV:

2603

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

2604

" cannot bind", self.interface)

2605

else:

2606

raise

1996

2607

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

1997

2608

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

2609

if self.server_address[1]:

2610

self.allow_reuse_address = True

1998

2611

if not self.server_address[0]:

1999

2612

if self.address_family == socket.AF_INET6:

2000

any_address = "::" # in6addr_any

2613

any_address = "::" # in6addr_any

2001

2614

else:

2002

any_address = "0.0.0.0" # INADDR_ANY

2615

any_address = "0.0.0.0" # INADDR_ANY

2003

2616

self.server_address = (any_address,

2004

2617

self.server_address[1])

2005

2618

elif not self.server_address[1]:

2006

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

2007

0)

2619

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

2008

2620

# if self.interface:

2009

2621

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

2010

2622

# 0, # port

2016

2628

2017

2629

class MandosServer(IPv6_TCPServer):

2018

2630

"""Mandos server.

2019

2631

2020

2632

Attributes:

2021

2633

clients: set of Client objects

2022

2634

gnutls_priority GnuTLS priority string

2023

2635

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

2024

2025

Assumes a gobject.MainLoop event loop.

2636

2637

Assumes a GLib.MainLoop event loop.

2026

2638

"""

2639

2027

2640

def __init__(self, server_address, RequestHandlerClass,

2028

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

2029

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

2641

interface=None,

2642

use_ipv6=True,

2643

clients=None,

2644

gnutls_priority=None,

2645

use_dbus=True,

2646

socketfd=None):

2030

2647

self.enabled = False

2031

2648

self.clients = clients

2032

2649

if self.clients is None:

2035

2652

self.gnutls_priority = gnutls_priority

2036

2653

IPv6_TCPServer.__init__(self, server_address,

2037

2654

RequestHandlerClass,

2038

interface = interface,

2039

use_ipv6 = use_ipv6,

2040

socketfd = socketfd)

2655

interface=interface,

2656

use_ipv6=use_ipv6,

2657

socketfd=socketfd)

2658

2041

2659

def server_activate(self):

2042

2660

if self.enabled:

2043

2661

return socketserver.TCPServer.server_activate(self)

2044

2662

2045

2663

def enable(self):

2046

2664

self.enabled = True

2047

2665

2048

2666

def add_pipe(self, parent_pipe, proc):

2049

2667

# Call "handle_ipc" for both data and EOF events

2050

gobject.io_add_watch(parent_pipe.fileno(),

2051

gobject.IO_IN | gobject.IO_HUP,

2052

functools.partial(self.handle_ipc,

2053

parent_pipe =

2054

parent_pipe,

2055

proc = proc))

2056

2057

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

2058

proc = None, client_object=None):

2668

GLib.io_add_watch(

2669

parent_pipe.fileno(),

2670

GLib.IO_IN | GLib.IO_HUP,

2671

functools.partial(self.handle_ipc,

2672

parent_pipe=parent_pipe,

2673

proc=proc))

2674

2675

def handle_ipc(self, source, condition,

2676

parent_pipe=None,

2677

proc=None,

2678

client_object=None):

2059

2679

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

2060

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

2680

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

2061

2681

# Wait for other process to exit

2062

2682

proc.join()

2063

2683

return False

2064

2684

2065

2685

# Read a request from the child

2066

2686

request = parent_pipe.recv()

2067

2687

command = request[0]

2068

2688

2069

2689

if command == 'init':

2070

fpr = request[1]

2071

address = request[2]

2072

2073

for c in self.clients.itervalues():

2074

if c.fingerprint == fpr:

2690

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

2691

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

2692

address = request[3]

2693

2694

for c in self.clients.values():

2695

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2696

continue

2697

if key_id and c.key_id == key_id:

2698

client = c

2699

break

2700

if fpr and c.fingerprint == fpr:

2075

2701

client = c

2076

2702

break

2077

2703

else:

2078

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

2079

"dress: %s", fpr, address)

2704

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

2705

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

2080

2706

if self.use_dbus:

2081

2707

# Emit D-Bus signal

2082

mandos_dbus_service.ClientNotFound(fpr,

2708

mandos_dbus_service.ClientNotFound(key_id or fpr,

2083

2709

address[0])

2084

2710

parent_pipe.send(False)

2085

2711

return False

2086

2087

gobject.io_add_watch(parent_pipe.fileno(),

2088

gobject.IO_IN | gobject.IO_HUP,

2089

functools.partial(self.handle_ipc,

2090

parent_pipe =

2091

parent_pipe,

2092

proc = proc,

2093

client_object =

2094

client))

2712

2713

GLib.io_add_watch(

2714

parent_pipe.fileno(),

2715

GLib.IO_IN | GLib.IO_HUP,

2716

functools.partial(self.handle_ipc,

2717

parent_pipe=parent_pipe,

2718

proc=proc,

2719

client_object=client))

2095

2720

parent_pipe.send(True)

2096

2721

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

2097

2722

# same fileno

2100

2725

funcname = request[1]

2101

2726

args = request[2]

2102

2727

kwargs = request[3]

2103

2728

2104

2729

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

2105

2730

funcname)(*args,

2106

**kwargs)))

2107

2731

**kwargs)))

2732

2108

2733

if command == 'getattr':

2109

2734

attrname = request[1]

2110

if callable(client_object.__getattribute__(attrname)):

2111

parent_pipe.send(('function',))

2735

if isinstance(client_object.__getattribute__(attrname),

2736

collections.Callable):

2737

parent_pipe.send(('function', ))

2112

2738

else:

2113

parent_pipe.send(('data', client_object

2114

.__getattribute__(attrname)))

2115

2739

parent_pipe.send((

2740

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

2741

2116

2742

if command == 'setattr':

2117

2743

attrname = request[1]

2118

2744

value = request[2]

2119

2745

setattr(client_object, attrname, value)

2120

2746

2121

2747

return True

2122

2748

2123

2749

2124

2750

def rfc3339_duration_to_delta(duration):

2125

2751

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

2126

2752

2127

2753

>>> rfc3339_duration_to_delta("P7D")

2128

2754

datetime.timedelta(7)

2129

2755

>>> rfc3339_duration_to_delta("PT60S")

2139

2765

>>> rfc3339_duration_to_delta("P1DT3M20S")

2140

2766

datetime.timedelta(1, 200)

2141

2767

"""

2142

2768

2143

2769

# Parsing an RFC 3339 duration with regular expressions is not

2144

2770

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

2145

2771

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

2146

2772

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

2147

2773

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

2148

2774

# avoid excessive use of external libraries.

2149

2775

2150

2776

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

2151

Token = collections.namedtuple("Token",

2152

("regexp", # To match token; if

2153

# "value" is not None,

2154

# must have a "group"

2155

# containing digits

2156

"value", # datetime.timedelta or

2157

# None

2158

"followers")) # Tokens valid after

2159

# this token

2777

Token = collections.namedtuple("Token", (

2778

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

2779

# a "group" containing digits

2780

"value", # datetime.timedelta or None

2781

"followers")) # Tokens valid after this token

2160

2782

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

2161

2783

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

2162

2784

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

2163

2785

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

2164

2786

datetime.timedelta(seconds=1),

2165

frozenset((token_end,)))

2787

frozenset((token_end, )))

2166

2788

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

2167

2789

datetime.timedelta(minutes=1),

2168

2790

frozenset((token_second, token_end)))

2184

2806

frozenset((token_month, token_end)))

2185

2807

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

2186

2808

datetime.timedelta(weeks=1),

2187

frozenset((token_end,)))

2809

frozenset((token_end, )))

2188

2810

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

2189

2811

frozenset((token_year, token_month,

2190

2812

token_day, token_time,

2191

token_week))),

2192

# Define starting values

2193

value = datetime.timedelta() # Value so far

2813

token_week)))

2814

# Define starting values:

2815

# Value so far

2816

value = datetime.timedelta()

2194

2817

found_token = None

2195

followers = frozenset(token_duration,) # Following valid tokens

2196

s = duration # String left to parse

2818

# Following valid tokens

2819

followers = frozenset((token_duration, ))

2820

# String left to parse

2821

s = duration

2197

2822

# Loop until end token is found

2198

2823

while found_token is not token_end:

2199

2824

# Search for any currently valid tokens

2215

2840

break

2216

2841

else:

2217

2842

# No currently valid tokens were found

2218

raise ValueError("Invalid RFC 3339 duration")

2843

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

2844

.format(duration))

2219

2845

# End token found

2220

2846

return value

2221

2847

2222

2848

2223

2849

def string_to_delta(interval):

2224

2850

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

2225

2851

2226

2852

>>> string_to_delta('7d')

2227

2853

datetime.timedelta(7)

2228

2854

>>> string_to_delta('60s')

2236

2862

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

2237

2863

datetime.timedelta(0, 330)

2238

2864

"""

2239

2865

2240

2866

try:

2241

2867

return rfc3339_duration_to_delta(interval)

2242

2868

except ValueError:

2243

2869

pass

2244

2870

2245

2871

timevalue = datetime.timedelta(0)

2246

2872

for s in interval.split():

2247

2873

try:

2248

suffix = unicode(s[-1])

2874

suffix = s[-1]

2249

2875

value = int(s[:-1])

2250

2876

if suffix == "d":

2251

2877

delta = datetime.timedelta(value)

2258

2884

elif suffix == "w":

2259

2885

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

2260

2886

else:

2261

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

2262

.format(suffix))

2887

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

2263

2888

except IndexError as e:

2264

2889

raise ValueError(*(e.args))

2265

2890

timevalue += delta

2266

2891

return timevalue

2267

2892

2268

2893

2269

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

2894

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

2270

2895

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

2271

2896

2272

2897

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

2273

2898

if os.fork():

2274

2899

sys.exit()

2282

2907

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

2283

2908

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

2284

2909

raise OSError(errno.ENODEV,

2285

"{0} not a character device"

2910

"{} not a character device"

2286

2911

.format(os.devnull))

2287

2912

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

2288

2913

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

2292

2917

2293

2918

2294

2919

def main():

2295

2920

2296

2921

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

2297

2922

# Parsing of options, both command line and config file

2298

2923

2299

2924

parser = argparse.ArgumentParser()

2300

2925

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

2301

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

2926

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

2302

2927

help="show version number and exit")

2303

2928

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

2304

2929

help="Bind to interface IF")

2340

2965

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

2341

2966

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

2342

2967

default=None)

2343

2968

2344

2969

options = parser.parse_args()

2345

2970

2346

2971

if options.check:

2347

2972

import doctest

2348

2973

fail_count, test_count = doctest.testmod()

2349

2974

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

2350

2975

2351

2976

# Default values for config file for server-global settings

2352

server_defaults = { "interface": "",

2353

"address": "",

2354

"port": "",

2355

"debug": "False",

2356

"priority":

2357

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

2358

"servicename": "Mandos",

2359

"use_dbus": "True",

2360

"use_ipv6": "True",

2361

"debuglevel": "",

2362

"restore": "True",

2363

"socket": "",

2364

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

2365

"foreground": "False",

2366

"zeroconf": "True",

2367

}

2368

2977

if gnutls.has_rawpk:

2978

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

2979

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

2980

else:

2981

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

2982

":+SIGN-DSA-SHA256")

2983

server_defaults = {"interface": "",

2984

"address": "",

2985

"port": "",

2986

"debug": "False",

2987

"priority": priority,

2988

"servicename": "Mandos",

2989

"use_dbus": "True",

2990

"use_ipv6": "True",

2991

"debuglevel": "",

2992

"restore": "True",

2993

"socket": "",

2994

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

2995

"foreground": "False",

2996

"zeroconf": "True",

2997

}

2998

del priority

2999

2369

3000

# Parse config file for server-global settings

2370

3001

server_config = configparser.SafeConfigParser(server_defaults)

2371

3002

del server_defaults

2372

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

2373

"mandos.conf"))

3003

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

2374

3004

# Convert the SafeConfigParser object to a dict

2375

3005

server_settings = server_config.defaults()

2376

3006

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

2377

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

3007

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

3008

"foreground", "zeroconf"):

2378

3009

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

2379

3010

option)

2380

3011

if server_settings["port"]:

2390

3021

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

2391

3022

["socket"])

2392

3023

del server_config

2393

3024

2394

3025

# Override the settings from the config file with command line

2395

3026

# options, if set.

2396

3027

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

2397

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

2398

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

2399

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

3028

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

3029

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

3030

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

2400

3031

value = getattr(options, option)

2401

3032

if value is not None:

2402

3033

server_settings[option] = value

2403

3034

del options

2404

3035

# Force all strings to be unicode

2405

3036

for option in server_settings.keys():

2406

if type(server_settings[option]) is str:

2407

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

3037

if isinstance(server_settings[option], bytes):

3038

server_settings[option] = (server_settings[option]

3039

.decode("utf-8"))

2408

3040

# Force all boolean options to be boolean

2409

3041

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

2410

3042

"foreground", "zeroconf"):

2413

3045

if server_settings["debug"]:

2414

3046

server_settings["foreground"] = True

2415

3047

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

2416

3048

2417

3049

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

2418

2419

if (not server_settings["zeroconf"] and

2420

not (server_settings["port"]

2421

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

2422

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

2423

" Zeroconf")

2424

3050

3051

if (not server_settings["zeroconf"]

3052

and not (server_settings["port"]

3053

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

3054

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

3055

2425

3056

# For convenience

2426

3057

debug = server_settings["debug"]

2427

3058

debuglevel = server_settings["debuglevel"]

2431

3062

stored_state_file)

2432

3063

foreground = server_settings["foreground"]

2433

3064

zeroconf = server_settings["zeroconf"]

2434

3065

2435

3066

if debug:

2436

3067

initlogger(debug, logging.DEBUG)

2437

3068

else:

2440

3071

else:

2441

3072

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

2442

3073

initlogger(debug, level)

2443

3074

2444

3075

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

2445

syslogger.setFormatter(logging.Formatter

2446

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

2447

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

2448

.format(server_settings

2449

["servicename"])))

2450

3076

syslogger.setFormatter(

3077

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

3078

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

3079

server_settings["servicename"])))

3080

2451

3081

# Parse config file with clients

2452

3082

client_config = configparser.SafeConfigParser(Client

2453

3083

.client_defaults)

2454

3084

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

2455

3085

"clients.conf"))

2456

3086

2457

3087

global mandos_dbus_service

2458

3088

mandos_dbus_service = None

2459

3089

2460

3090

socketfd = None

2461

3091

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

2462

3092

socketfd = server_settings["socket"]

2463

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

2464

server_settings["port"]),

2465

ClientHandler,

2466

interface=(server_settings["interface"]

2467

or None),

2468

use_ipv6=use_ipv6,

2469

gnutls_priority=

2470

server_settings["priority"],

2471

use_dbus=use_dbus,

2472

socketfd=socketfd)

3093

tcp_server = MandosServer(

3094

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

3095

ClientHandler,

3096

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

3097

use_ipv6=use_ipv6,

3098

gnutls_priority=server_settings["priority"],

3099

use_dbus=use_dbus,

3100

socketfd=socketfd)

2473

3101

if not foreground:

2474

3102

pidfilename = "/run/mandos.pid"

2475

3103

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

2476

3104

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

2477

3105

pidfile = None

2478

3106

try:

2479

pidfile = open(pidfilename, "w")

3107

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

2480

3108

except IOError as e:

2481

3109

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

2482

3110

exc_info=e)

2483

2484

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

3111

3112

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

3113

("mandos", "mandos"),

3114

("nobody", "nogroup")):

2485

3115

try:

2486

3116

uid = pwd.getpwnam(name).pw_uid

2487

gid = pwd.getpwnam(name).pw_gid

3117

gid = pwd.getpwnam(group).pw_gid

2488

3118

break

2489

3119

except KeyError:

2490

3120

continue

2494

3124

try:

2495

3125

os.setgid(gid)

2496

3126

os.setuid(uid)

3127

if debug:

3128

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

3129

gid))

2497

3130

except OSError as error:

3131

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

3132

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

2498

3133

if error.errno != errno.EPERM:

2499

3134

raise

2500

3135

2501

3136

if debug:

2502

3137

# Enable all possible GnuTLS debugging

2503

3138

2504

3139

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

2505

3140

# - GnuTLS manual

2506

gnutls.library.functions.gnutls_global_set_log_level(11)

2507

2508

@gnutls.library.types.gnutls_log_func

3141

gnutls.global_set_log_level(11)

3142

3143

@gnutls.log_func

2509

3144

def debug_gnutls(level, string):

2510

3145

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

2511

2512

(gnutls.library.functions

2513

.gnutls_global_set_log_function(debug_gnutls))

2514

3146

3147

gnutls.global_set_log_function(debug_gnutls)

3148

2515

3149

# Redirect stdin so all checkers get /dev/null

2516

3150

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

2517

3151

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

2518

3152

if null > 2:

2519

3153

os.close(null)

2520

3154

2521

3155

# Need to fork before connecting to D-Bus

2522

3156

if not foreground:

2523

3157

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

2524

3158

daemon()

2525

2526

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

2527

# need to inform gobject that threads will be used.

2528

gobject.threads_init()

2529

3159

3160

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

3161

# to inform GLib that threads will be used.

3162

GLib.threads_init()

3163

2530

3164

global main_loop

2531

3165

# From the Avahi example code

2532

3166

DBusGMainLoop(set_as_default=True)

2533

main_loop = gobject.MainLoop()

3167

main_loop = GLib.MainLoop()

2534

3168

bus = dbus.SystemBus()

2535

3169

# End of Avahi example code

2536

3170

if use_dbus:

2537

3171

try:

2538

3172

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

2539

bus, do_not_queue=True)

2540

old_bus_name = (dbus.service.BusName

2541

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

2542

do_not_queue=True))

2543

except dbus.exceptions.NameExistsException as e:

3173

bus,

3174

do_not_queue=True)

3175

old_bus_name = dbus.service.BusName(

3176

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

3177

do_not_queue=True)

3178

except dbus.exceptions.DBusException as e:

2544

3179

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

2545

3180

use_dbus = False

2546

3181

server_settings["use_dbus"] = False

2547

3182

tcp_server.use_dbus = False

2548

3183

if zeroconf:

2549

3184

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2550

service = AvahiServiceToSyslog(name =

2551

server_settings["servicename"],

2552

servicetype = "_mandos._tcp",

2553

protocol = protocol, bus = bus)

3185

service = AvahiServiceToSyslog(

3186

name=server_settings["servicename"],

3187

servicetype="_mandos._tcp",

3188

protocol=protocol,

3189

bus=bus)

2554

3190

if server_settings["interface"]:

2555

service.interface = (if_nametoindex

2556

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

2557

3191

service.interface = if_nametoindex(

3192

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

3193

2558

3194

global multiprocessing_manager

2559

3195

multiprocessing_manager = multiprocessing.Manager()

2560

3196

2561

3197

client_class = Client

2562

3198

if use_dbus:

2563

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

2564

3199

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

3200

2565

3201

client_settings = Client.config_parser(client_config)

2566

3202

old_client_settings = {}

2567

3203

clients_data = {}

2568

3204

2569

3205

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

2570

3206

global wnull

2571

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

3207

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

2572

3208

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

2573

3209

# mode

2574

3210

if debug or not foreground:

2575

3211

wnull.close()

2576

3212

2577

3213

# Get client data and settings from last running state.

2578

3214

if server_settings["restore"]:

2579

3215

try:

2580

3216

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

2581

clients_data, old_client_settings = (pickle.load

2582

(stored_state))

3217

if sys.version_info.major == 2:

3218

clients_data, old_client_settings = pickle.load(

3219

stored_state)

3220

else:

3221

bytes_clients_data, bytes_old_client_settings = (

3222

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

3223

# Fix bytes to strings

3224

# clients_data

3225

# .keys()

3226

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

3227

if isinstance(key, bytes)

3228

else key): value

3229

for key, value in

3230

bytes_clients_data.items()}

3231

del bytes_clients_data

3232

for key in clients_data:

3233

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

3234

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

3235

for k, v in

3236

clients_data[key].items()}

3237

clients_data[key] = value

3238

# .client_structure

3239

value["client_structure"] = [

3240

(s.decode("utf-8")

3241

if isinstance(s, bytes)

3242

else s) for s in

3243

value["client_structure"]]

3244

# .name & .host

3245

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

3246

if isinstance(value[k], bytes):

3247

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

3248

if "key_id" not in value:

3249

value["key_id"] = ""

3250

elif "fingerprint" not in value:

3251

value["fingerprint"] = ""

3252

# old_client_settings

3253

# .keys()

3254

old_client_settings = {

3255

(key.decode("utf-8")

3256

if isinstance(key, bytes)

3257

else key): value

3258

for key, value in

3259

bytes_old_client_settings.items()}

3260

del bytes_old_client_settings

3261

# .host

3262

for value in old_client_settings.values():

3263

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

3264

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

3265

.decode("utf-8"))

2583

3266

os.remove(stored_state_path)

2584

3267

except IOError as e:

2585

3268

if e.errno == errno.ENOENT:

2586

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

2587

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

3269

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

3270

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

2588

3271

else:

2589

3272

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

2590

3273

exc_info=e)

2591

3274

raise

2592

3275

except EOFError as e:

2593

3276

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

2594

"EOFError:", exc_info=e)

2595

3277

"EOFError:",

3278

exc_info=e)

3279

2596

3280

with PGPEngine() as pgp:

2597

for client_name, client in clients_data.iteritems():

3281

for client_name, client in clients_data.items():

2598

3282

# Skip removed clients

2599

3283

if client_name not in client_settings:

2600

3284

continue

2601

3285

2602

3286

# Decide which value to use after restoring saved state.

2603

3287

# We have three different values: Old config file,

2604

3288

# new config file, and saved state.

2609

3293

# For each value in new config, check if it

2610

3294

# differs from the old config value (Except for

2611

3295

# the "secret" attribute)

2612

if (name != "secret" and

2613

value != old_client_settings[client_name]

2614

[name]):

3296

if (name != "secret"

3297

and (value !=

3298

old_client_settings[client_name][name])):

2615

3299

client[name] = value

2616

3300

except KeyError:

2617

3301

pass

2618

3302

2619

3303

# Clients who has passed its expire date can still be

2620

# enabled if its last checker was successful. Clients

3304

# enabled if its last checker was successful. A Client

2621

3305

# whose checker succeeded before we stored its state is

2622

3306

# assumed to have successfully run all checkers during

2623

3307

# downtime.

2625

3309

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

2626

3310

if not client["last_checked_ok"]:

2627

3311

logger.warning(

2628

"disabling client {0} - Client never "

2629

"performed a successful checker"

2630

.format(client_name))

3312

"disabling client {} - Client never "

3313

"performed a successful checker".format(

3314

client_name))

2631

3315

client["enabled"] = False

2632

3316

elif client["last_checker_status"] != 0:

2633

3317

logger.warning(

2634

"disabling client {0} - Client "

2635

"last checker failed with error code {1}"

2636

.format(client_name,

2637

client["last_checker_status"]))

3318

"disabling client {} - Client last"

3319

" checker failed with error code"

3320

" {}".format(

3321

client_name,

3322

client["last_checker_status"]))

2638

3323

client["enabled"] = False

2639

3324

else:

2640

client["expires"] = (datetime.datetime

2641

.utcnow()

2642

+ client["timeout"])

3325

client["expires"] = (

3326

datetime.datetime.utcnow()

3327

+ client["timeout"])

2643

3328

logger.debug("Last checker succeeded,"

2644

" keeping {0} enabled"

2645

.format(client_name))

3329

" keeping {} enabled".format(

3330

client_name))

2646

3331

try:

2647

client["secret"] = (

2648

pgp.decrypt(client["encrypted_secret"],

2649

client_settings[client_name]

2650

["secret"]))

3332

client["secret"] = pgp.decrypt(

3333

client["encrypted_secret"],

3334

client_settings[client_name]["secret"])

2651

3335

except PGPError:

2652

3336

# If decryption fails, we use secret from new settings

2653

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

2654

.format(client_name))

2655

client["secret"] = (

2656

client_settings[client_name]["secret"])

2657

3337

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

3338

client_name))

3339

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

3340

["secret"])

3341

2658

3342

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

2659

3343

for client_name in (set(old_client_settings)

2660

3344

- set(client_settings)):

2662

3346

for client_name in (set(client_settings)

2663

3347

- set(old_client_settings)):

2664

3348

clients_data[client_name] = client_settings[client_name]

2665

3349

2666

3350

# Create all client objects

2667

for client_name, client in clients_data.iteritems():

3351

for client_name, client in clients_data.items():

2668

3352

tcp_server.clients[client_name] = client_class(

2669

name = client_name, settings = client,

2670

server_settings = server_settings)

2671

3353

name=client_name,

3354

settings=client,

3355

server_settings=server_settings)

3356

2672

3357

if not tcp_server.clients:

2673

3358

logger.warning("No clients defined")

2674

3359

2675

3360

if not foreground:

2676

3361

if pidfile is not None:

3362

pid = os.getpid()

2677

3363

try:

2678

3364

with pidfile:

2679

pid = os.getpid()

2680

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

3365

print(pid, file=pidfile)

2681

3366

except IOError:

2682

3367

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

2683

3368

pidfilename, pid)

2684

3369

del pidfile

2685

3370

del pidfilename

2686

2687

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

2688

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

2689

3371

3372

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

3373

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3374

lambda: main_loop.quit() and False)

3375

2690

3376

if use_dbus:

2691

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

2692

"se.bsnet.fukt.Mandos"})

2693

class MandosDBusService(DBusObjectWithProperties):

3377

3378

@alternate_dbus_interfaces(

3379

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

3380

class MandosDBusService(DBusObjectWithObjectManager):

2694

3381

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

3382

2695

3383

def __init__(self):

2696

3384

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

3385

2697

3386

_interface = "se.recompile.Mandos"

2698

2699

@dbus_interface_annotations(_interface)

2700

def _foo(self):

2701

return { "org.freedesktop.DBus.Property"

2702

".EmitsChangedSignal":

2703

"false"}

2704

3387

2705

3388

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

2706

3389

def ClientAdded(self, objpath):

2707

3390

"D-Bus signal"

2708

3391

pass

2709

3392

2710

3393

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

2711

def ClientNotFound(self, fingerprint, address):

3394

def ClientNotFound(self, key_id, address):

2712

3395

"D-Bus signal"

2713

3396

pass

2714

3397

3398

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

3399

"true"})

2715

3400

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

2716

3401

def ClientRemoved(self, objpath, name):

2717

3402

"D-Bus signal"

2718

3403

pass

2719

3404

3405

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

3406

"true"})

2720

3407

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

2721

3408

def GetAllClients(self):

2722

3409

"D-Bus method"

2723

return dbus.Array(c.dbus_object_path

2724

for c in

2725

tcp_server.clients.itervalues())

2726

3410

return dbus.Array(c.dbus_object_path for c in

3411

tcp_server.clients.values())

3412

3413

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

3414

"true"})

2727

3415

@dbus.service.method(_interface,

2728

3416

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

2729

3417

def GetAllClientsWithProperties(self):

2730

3418

"D-Bus method"

2731

3419

return dbus.Dictionary(

2732

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

2733

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

3420

{c.dbus_object_path: c.GetAll(

3421

"se.recompile.Mandos.Client")

3422

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

2734

3423

signature="oa{sv}")

2735

3424

2736

3425

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

2737

3426

def RemoveClient(self, object_path):

2738

3427

"D-Bus method"

2739

for c in tcp_server.clients.itervalues():

3428

for c in tcp_server.clients.values():

2740

3429

if c.dbus_object_path == object_path:

2741

3430

del tcp_server.clients[c.name]

2742

3431

c.remove_from_connection()

2743

# Don't signal anything except ClientRemoved

3432

# Don't signal the disabling

2744

3433

c.disable(quiet=True)

2745

# Emit D-Bus signal

2746

self.ClientRemoved(object_path, c.name)

3434

# Emit D-Bus signal for removal

3435

self.client_removed_signal(c)

2747

3436

return

2748

3437

raise KeyError(object_path)

2749

3438

2750

3439

del _interface

2751

3440

3441

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3442

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

3443

def GetManagedObjects(self):

3444

"""D-Bus method"""

3445

return dbus.Dictionary(

3446

{client.dbus_object_path:

3447

dbus.Dictionary(

3448

{interface: client.GetAll(interface)

3449

for interface in

3450

client._get_all_interface_names()})

3451

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

3452

3453

def client_added_signal(self, client):

3454

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

3455

if use_dbus:

3456

# New standard signal

3457

self.InterfacesAdded(

3458

client.dbus_object_path,

3459

dbus.Dictionary(

3460

{interface: client.GetAll(interface)

3461

for interface in

3462

client._get_all_interface_names()}))

3463

# Old signal

3464

self.ClientAdded(client.dbus_object_path)

3465

3466

def client_removed_signal(self, client):

3467

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

3468

if use_dbus:

3469

# New standard signal

3470

self.InterfacesRemoved(

3471

client.dbus_object_path,

3472

client._get_all_interface_names())

3473

# Old signal

3474

self.ClientRemoved(client.dbus_object_path,

3475

client.name)

3476

2752

3477

mandos_dbus_service = MandosDBusService()

2753

3478

3479

# Save modules to variables to exempt the modules from being

3480

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

3481

mp = multiprocessing

3482

wn = wnull

3483

2754

3484

def cleanup():

2755

3485

"Cleanup function; run on exit"

2756

3486

if zeroconf:

2757

3487

service.cleanup()

2758

2759

multiprocessing.active_children()

2760

wnull.close()

3488

3489

mp.active_children()

3490

wn.close()

2761

3491

if not (tcp_server.clients or client_settings):

2762

3492

return

2763

3493

2764

3494

# Store client before exiting. Secrets are encrypted with key

2765

3495

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

2766

3496

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

2767

3497

clients = {}

2768

3498

with PGPEngine() as pgp:

2769

for client in tcp_server.clients.itervalues():

3499

for client in tcp_server.clients.values():

2770

3500

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

2771

3501

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

2772

3502

key)

2773

3503

client_dict = {}

2774

3504

2775

3505

# A list of attributes that can not be pickled

2776

3506

# + secret.

2777

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

2778

"checker", "server_settings"))

2779

for name, typ in (inspect.getmembers

2780

(dbus.service.Object)):

3507

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

3508

"checker", "server_settings"}

3509

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

3510

.Object):

2781

3511

exclude.add(name)

2782

3512

2783

3513

client_dict["encrypted_secret"] = (client

2784

3514

.encrypted_secret)

2785

3515

for attr in client.client_structure:

2786

3516

if attr not in exclude:

2787

3517

client_dict[attr] = getattr(client, attr)

2788

3518

2789

3519

clients[client.name] = client_dict

2790

3520

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

2791

3521

2792

3522

try:

2793

with (tempfile.NamedTemporaryFile

2794

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

2795

dir=os.path.dirname(stored_state_path),

2796

delete=False)) as stored_state:

2797

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

2798

tempname=stored_state.name

3523

with tempfile.NamedTemporaryFile(

3524

mode='wb',

3525

suffix=".pickle",

3526

prefix='clients-',

3527

dir=os.path.dirname(stored_state_path),

3528

delete=False) as stored_state:

3529

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

3530

protocol=2)

3531

tempname = stored_state.name

2799

3532

os.rename(tempname, stored_state_path)

2800

3533

except (IOError, OSError) as e:

2801

3534

if not debug:

2804

3537

except NameError:

2805

3538

pass

2806

3539

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

2807

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

3540

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

2808

3541

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

2809

3542

else:

2810

3543

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

2811

3544

exc_info=e)

2812

3545

raise

2813

3546

2814

3547

# Delete all clients, and settings from config

2815

3548

while tcp_server.clients:

2816

3549

name, client = tcp_server.clients.popitem()

2817

3550

if use_dbus:

2818

3551

client.remove_from_connection()

2819

# Don't signal anything except ClientRemoved

3552

# Don't signal the disabling

2820

3553

client.disable(quiet=True)

3554

# Emit D-Bus signal for removal

2821

3555

if use_dbus:

2822

# Emit D-Bus signal

2823

mandos_dbus_service.ClientRemoved(client

2824

.dbus_object_path,

2825

client.name)

3556

mandos_dbus_service.client_removed_signal(client)

2826

3557

client_settings.clear()

2827

3558

2828

3559

atexit.register(cleanup)

2829

2830

for client in tcp_server.clients.itervalues():

3560

3561

for client in tcp_server.clients.values():

2831

3562

if use_dbus:

2832

# Emit D-Bus signal

2833

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3563

# Emit D-Bus signal for adding

3564

mandos_dbus_service.client_added_signal(client)

2834

3565

# Need to initiate checking of clients

2835

3566

if client.enabled:

2836

3567

client.init_checker()

2837

3568

2838

3569

tcp_server.enable()

2839

3570

tcp_server.server_activate()

2840

3571

2841

3572

# Find out what port we got

2842

3573

if zeroconf:

2843

3574

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

2848

3579

else: # IPv4

2849

3580

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

2850

3581

*tcp_server.socket.getsockname())

2851

2852

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

2853

3582

3583

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

3584

2854

3585

try:

2855

3586

if zeroconf:

2856

3587

# From the Avahi example code

2861

3592

cleanup()

2862

3593

sys.exit(1)

2863

3594

# End of Avahi example code

2864

2865

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

2866

lambda *args, **kwargs:

2867

(tcp_server.handle_request

2868

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

2869

3595

3596

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

3597

lambda *args, **kwargs:

3598

(tcp_server.handle_request

3599

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

3600

2870

3601

logger.debug("Starting main loop")

2871

3602

main_loop.run()

2872

3603

except AvahiError as error:

2881

3612

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

2882

3613

cleanup()

2883

3614

3615

2884

3616

if __name__ == '__main__':

2885

3617

main()