/mandos/trunk : revision 1138

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

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

92

119

stored_state_file = "clients.pickle"

93

120

94

121

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

122

syslogger = None

98

123

99

124

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

103

127

except (OSError, AttributeError):

128

104

129

def if_nametoindex(interface):

105

130

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

106

131

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

107

132

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

108

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

134

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

135

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

113

136

return interface_index

114

137

115

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

116

155

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

117

156

"""init logger and add loglevel"""

118

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

119

162

syslogger.setFormatter(logging.Formatter

120

163

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

121

164

' %(message)s'))

122

165

logger.addHandler(syslogger)

123

166

124

167

if debug:

125

168

console = logging.StreamHandler()

126

169

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

138

181

139

182

class PGPEngine(object):

140

183

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

184

141

185

def __init__(self):

142

186

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

143

198

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

199

'--homedir', self.tempdir,

145

200

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

148

201

'--quiet']

202

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

203

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

204

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

205

149

206

def __enter__(self):

150

207

return self

151

208

152

209

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

153

210

self._cleanup()

154

211

return False

155

212

156

213

def __del__(self):

157

214

self._cleanup()

158

215

159

216

def _cleanup(self):

160

217

if self.tempdir is not None:

161

218

# Delete contents of tempdir

162

219

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

163

topdown = False):

220

topdown=False):

164

221

for filename in files:

165

222

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

166

223

for dirname in dirs:

168

225

# Remove tempdir

169

226

os.rmdir(self.tempdir)

170

227

self.tempdir = None

171

228

172

229

def password_encode(self, password):

173

230

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

174

231

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

179

236

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

180

237

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

181

238

return encoded

182

239

183

240

def encrypt(self, data, password):

184

241

passphrase = self.password_encode(password)

185

with tempfile.NamedTemporaryFile(dir=self.tempdir

186

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

187

244

passfile.write(passphrase)

188

245

passfile.flush()

189

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

246

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

190

247

'--passphrase-file',

191

248

passfile.name]

192

249

+ self.gnupgargs,

193

stdin = subprocess.PIPE,

194

stdout = subprocess.PIPE,

195

stderr = subprocess.PIPE)

196

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

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

197

254

if proc.returncode != 0:

198

255

raise PGPError(err)

199

256

return ciphertext

200

257

201

258

def decrypt(self, data, password):

202

259

passphrase = self.password_encode(password)

203

with tempfile.NamedTemporaryFile(dir = self.tempdir

204

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

205

262

passfile.write(passphrase)

206

263

passfile.flush()

207

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

264

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

208

265

'--passphrase-file',

209

266

passfile.name]

210

267

+ self.gnupgargs,

211

stdin = subprocess.PIPE,

212

stdout = subprocess.PIPE,

213

stderr = subprocess.PIPE)

214

decrypted_plaintext, err = proc.communicate(input

215

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

216

272

if proc.returncode != 0:

217

273

raise PGPError(err)

218

274

return decrypted_plaintext

219

275

220

276

277

# Pretend that we have an Avahi module

278

class avahi(object):

279

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

280

IF_UNSPEC = -1 # avahi-common/address.h

281

PROTO_UNSPEC = -1 # avahi-common/address.h

282

PROTO_INET = 0 # avahi-common/address.h

283

PROTO_INET6 = 1 # avahi-common/address.h

284

DBUS_NAME = "org.freedesktop.Avahi"

285

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

286

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

287

DBUS_PATH_SERVER = "/"

288

289

@staticmethod

290

def string_array_to_txt_array(t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

302

221

303

class AvahiError(Exception):

222

304

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

223

305

self.value = value

224

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

225

def __unicode__(self):

226

return unicode(repr(self.value))

306

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

307

**kwargs)

308

227

309

228

310

class AvahiServiceError(AvahiError):

229

311

pass

230

312

313

231

314

class AvahiGroupError(AvahiError):

232

315

pass

233

316

234

317

235

318

class AvahiService(object):

236

319

"""An Avahi (Zeroconf) service.

237

320

238

321

Attributes:

239

322

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

240

323

Used to optionally bind to the specified interface.

252

335

server: D-Bus Server

253

336

bus: dbus.SystemBus()

254

337

"""

255

256

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

257

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

258

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

259

protocol = avahi.PROTO_UNSPEC, bus = None):

338

339

def __init__(self,

340

interface=avahi.IF_UNSPEC,

341

name=None,

342

servicetype=None,

343

port=None,

344

TXT=None,

345

domain="",

346

host="",

347

max_renames=32768,

348

protocol=avahi.PROTO_UNSPEC,

349

bus=None):

260

350

self.interface = interface

261

351

self.name = name

262

352

self.type = servicetype

271

361

self.server = None

272

362

self.bus = bus

273

363

self.entry_group_state_changed_match = None

274

275

def rename(self):

364

365

def rename(self, remove=True):

276

366

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

277

367

if self.rename_count >= self.max_renames:

278

368

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

279

369

" after %i retries, exiting.",

280

370

self.rename_count)

281

371

raise AvahiServiceError("Too many renames")

282

self.name = unicode(self.server

283

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

284

375

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

285

376

self.name)

286

self.remove()

377

if remove:

378

self.remove()

287

379

try:

288

380

self.add()

289

381

except dbus.exceptions.DBusException as error:

290

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

291

self.cleanup()

292

os._exit(1)

293

self.rename_count += 1

294

382

if (error.get_dbus_name()

383

== "org.freedesktop.Avahi.CollisionError"):

384

logger.info("Local Zeroconf service name collision.")

385

return self.rename(remove=False)

386

else:

387

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

388

self.cleanup()

389

os._exit(1)

390

295

391

def remove(self):

296

392

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

297

393

if self.entry_group_state_changed_match is not None:

299

395

self.entry_group_state_changed_match = None

300

396

if self.group is not None:

301

397

self.group.Reset()

302

398

303

399

def add(self):

304

400

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

305

401

self.remove()

322

418

dbus.UInt16(self.port),

323

419

avahi.string_array_to_txt_array(self.TXT))

324

420

self.group.Commit()

325

421

326

422

def entry_group_state_changed(self, state, error):

327

423

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

328

424

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

329

425

330

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

331

427

logger.debug("Zeroconf service established.")

332

428

elif state == avahi.ENTRY_GROUP_COLLISION:

334

430

self.rename()

335

431

elif state == avahi.ENTRY_GROUP_FAILURE:

336

432

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

337

unicode(error))

338

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

339

.format(error))

340

433

str(error))

434

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

435

341

436

def cleanup(self):

342

437

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

343

438

if self.group is not None:

348

443

pass

349

444

self.group = None

350

445

self.remove()

351

446

352

447

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

353

448

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

354

449

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

355

bad_states = { avahi.SERVER_INVALID:

356

"Zeroconf server invalid",

357

avahi.SERVER_REGISTERING: None,

358

avahi.SERVER_COLLISION:

359

"Zeroconf server name collision",

360

avahi.SERVER_FAILURE:

361

"Zeroconf server failure" }

450

bad_states = {

451

avahi.SERVER_INVALID: "Zeroconf server invalid",

452

avahi.SERVER_REGISTERING: None,

453

avahi.SERVER_COLLISION: "Zeroconf server name collision",

454

avahi.SERVER_FAILURE: "Zeroconf server failure",

455

}

362

456

if state in bad_states:

363

457

if bad_states[state] is not None:

364

458

if error is None:

367

461

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

368

462

self.cleanup()

369

463

elif state == avahi.SERVER_RUNNING:

370

self.add()

464

try:

465

self.add()

466

except dbus.exceptions.DBusException as error:

467

if (error.get_dbus_name()

468

== "org.freedesktop.Avahi.CollisionError"):

469

logger.info("Local Zeroconf service name"

470

" collision.")

471

return self.rename(remove=False)

472

else:

473

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

474

self.cleanup()

475

os._exit(1)

371

476

else:

372

477

if error is None:

373

478

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

374

479

else:

375

480

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

376

481

377

482

def activate(self):

378

483

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

379

484

if self.server is None:

383

488

follow_name_owner_changes=True),

384

489

avahi.DBUS_INTERFACE_SERVER)

385

490

self.server.connect_to_signal("StateChanged",

386

self.server_state_changed)

491

self.server_state_changed)

387

492

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

388

493

389

494

390

495

class AvahiServiceToSyslog(AvahiService):

391

def rename(self):

496

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

392

497

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

393

ret = AvahiService.rename(self)

394

syslogger.setFormatter(logging.Formatter

395

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

396

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

397

.format(self.name)))

498

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

499

syslogger.setFormatter(logging.Formatter(

500

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

501

.format(self.name)))

398

502

return ret

399

503

400

504

401

def timedelta_to_milliseconds(td):

402

"Convert a datetime.timedelta() to milliseconds"

403

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

404

+ (td.seconds * 1000)

405

+ (td.microseconds // 1000))

505

# Pretend that we have a GnuTLS module

506

class gnutls(object):

507

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

508

509

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

510

if library is None:

511

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

512

_library = ctypes.cdll.LoadLibrary(library)

513

del library

514

515

# Unless otherwise indicated, the constants and types below are

516

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

517

518

# Constants

519

E_SUCCESS = 0

520

E_INTERRUPTED = -52

521

E_AGAIN = -28

522

CRT_OPENPGP = 2

523

CRT_RAWPK = 3

524

CLIENT = 2

525

SHUT_RDWR = 0

526

CRD_CERTIFICATE = 1

527

E_NO_CERTIFICATE_FOUND = -49

528

X509_FMT_DER = 0

529

NO_TICKETS = 1<<10

530

ENABLE_RAWPK = 1<<18

531

CTYPE_PEERS = 3

532

KEYID_USE_SHA256 = 1 # gnutls/x509.h

533

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

534

535

# Types

536

class session_int(ctypes.Structure):

537

_fields_ = []

538

session_t = ctypes.POINTER(session_int)

539

540

class certificate_credentials_st(ctypes.Structure):

541

_fields_ = []

542

certificate_credentials_t = ctypes.POINTER(

543

certificate_credentials_st)

544

certificate_type_t = ctypes.c_int

545

546

class datum_t(ctypes.Structure):

547

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

548

('size', ctypes.c_uint)]

549

550

class openpgp_crt_int(ctypes.Structure):

551

_fields_ = []

552

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

553

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

554

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

555

credentials_type_t = ctypes.c_int

556

transport_ptr_t = ctypes.c_void_p

557

close_request_t = ctypes.c_int

558

559

# Exceptions

560

class Error(Exception):

561

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

562

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

563

# code is passed, convert it to a string with

564

# gnutls.strerror()

565

self.code = code

566

if message is None and code is not None:

567

message = gnutls.strerror(code)

568

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

569

message, *args)

570

571

class CertificateSecurityError(Error):

572

pass

573

574

# Classes

575

class Credentials(object):

576

def __init__(self):

577

self._c_object = gnutls.certificate_credentials_t()

578

gnutls.certificate_allocate_credentials(

579

ctypes.byref(self._c_object))

580

self.type = gnutls.CRD_CERTIFICATE

581

582

def __del__(self):

583

gnutls.certificate_free_credentials(self._c_object)

584

585

class ClientSession(object):

586

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

587

self._c_object = gnutls.session_t()

588

gnutls_flags = gnutls.CLIENT

589

if gnutls.check_version(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()

406

815

407

816

408

817

class Client(object):

409

818

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

410

819

411

820

Attributes:

412

821

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

413

822

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

414

823

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

415

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

416

to see if the client lives.

417

'None' if no process is running.

418

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

419

828

checker_command: string; External command which is run to check

420

829

if client lives. %() expansions are done at

421

830

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

422

831

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

423

checker_initiator_tag: a gobject event source tag, or None

832

checker_initiator_tag: a GLib event source tag, or None

424

833

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

425

834

client_structure: Object describing what attributes a client has

426

835

and is used for storing the client at exit

427

836

current_checker_command: string; current running checker_command

428

disable_initiator_tag: a gobject event source tag, or None

837

disable_initiator_tag: a GLib event source tag, or None

429

838

enabled: bool()

430

839

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

431

uniquely identify the client

840

uniquely identify an OpenPGP client

841

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

842

a client using raw public keys

432

843

host: string; available for use by the checker command

433

844

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

434

845

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

436

847

last_checker_status: integer between 0 and 255 reflecting exit

437

848

status of last checker. -1 reflects crashed

438

849

checker, -2 means no checker completed yet.

850

last_checker_signal: The signal which killed the last checker, if

851

last_checker_status is -1

439

852

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

440

853

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

441

854

D-Bus identifiers

448

861

disabled, or None

449

862

server_settings: The server_settings dict from main()

450

863

"""

451

864

452

865

runtime_expansions = ("approval_delay", "approval_duration",

453

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

866

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

454

867

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

455

868

"last_approval_request", "last_checked_ok",

456

869

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

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

460

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

461

"host": "",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

464

"approved_by_default": "True",

465

"enabled": "True",

466

}

467

468

def timeout_milliseconds(self):

469

"Return the 'timeout' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.timeout)

471

472

def extended_timeout_milliseconds(self):

473

"Return the 'extended_timeout' attribute in milliseconds"

474

return timedelta_to_milliseconds(self.extended_timeout)

475

476

def interval_milliseconds(self):

477

"Return the 'interval' attribute in milliseconds"

478

return timedelta_to_milliseconds(self.interval)

479

480

def approval_delay_milliseconds(self):

481

return timedelta_to_milliseconds(self.approval_delay)

482

870

client_defaults = {

871

"timeout": "PT5M",

872

"extended_timeout": "PT15M",

873

"interval": "PT2M",

874

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

875

"host": "",

876

"approval_delay": "PT0S",

877

"approval_duration": "PT1S",

878

"approved_by_default": "True",

879

"enabled": "True",

880

}

881

483

882

@staticmethod

484

883

def config_parser(config):

485

884

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

492

891

for client_name in config.sections():

493

892

section = dict(config.items(client_name))

494

893

client = settings[client_name] = {}

495

894

496

895

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

497

896

# Reformat values from string types to Python types

498

897

client["approved_by_default"] = config.getboolean(

499

898

client_name, "approved_by_default")

500

899

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

501

900

"enabled")

502

901

902

# Uppercase and remove spaces from key_id and fingerprint

903

# for later comparison purposes with return value from the

904

# key_id() and fingerprint() functions

905

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

906

.replace(" ", ""))

503

907

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

504

908

.replace(" ", ""))

505

909

if "secret" in section:

506

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

910

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

911

.encode("utf-8"),

912

"base64")

507

913

elif "secfile" in section:

508

914

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

509

915

(section["secfile"])),

510

916

"rb") as secfile:

511

917

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

512

918

else:

513

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

919

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

514

920

.format(section))

515

921

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

516

922

client["extended_timeout"] = string_to_delta(

524

930

client["last_approval_request"] = None

525

931

client["last_checked_ok"] = None

526

932

client["last_checker_status"] = -2

527

933

528

934

return settings

529

530

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

935

936

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

531

937

self.name = name

532

938

if server_settings is None:

533

939

server_settings = {}

534

940

self.server_settings = server_settings

535

941

# adding all client settings

536

for setting, value in settings.iteritems():

942

for setting, value in settings.items():

537

943

setattr(self, setting, value)

538

944

539

945

if self.enabled:

540

946

if not hasattr(self, "last_enabled"):

541

947

self.last_enabled = datetime.datetime.utcnow()

545

951

else:

546

952

self.last_enabled = None

547

953

self.expires = None

548

954

549

955

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

550

# Uppercase and remove spaces from fingerprint for later

551

# comparison purposes with return value from the fingerprint()

552

# function

956

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

553

957

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

554

958

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

555

959

datetime.datetime.utcnow())

556

960

557

961

# attributes specific for this server instance

558

962

self.checker = None

559

963

self.checker_initiator_tag = None

562

966

self.current_checker_command = None

563

967

self.approved = None

564

968

self.approvals_pending = 0

565

self.changedstate = (multiprocessing_manager

566

.Condition(multiprocessing_manager

567

.Lock()))

568

self.client_structure = [attr for attr in

569

self.__dict__.iterkeys()

969

self.changedstate = multiprocessing_manager.Condition(

970

multiprocessing_manager.Lock())

971

self.client_structure = [attr

972

for attr in self.__dict__.keys()

570

973

if not attr.startswith("_")]

571

974

self.client_structure.append("client_structure")

572

573

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

574

lambda obj:

575

isinstance(obj,

576

property)):

975

976

for name, t in inspect.getmembers(

977

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

577

978

if not name.startswith("_"):

578

979

self.client_structure.append(name)

579

980

580

981

# Send notice to process children that client state has changed

581

982

def send_changedstate(self):

582

983

with self.changedstate:

583

984

self.changedstate.notify_all()

584

985

585

986

def enable(self):

586

987

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

587

988

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

592

993

self.last_enabled = datetime.datetime.utcnow()

593

994

self.init_checker()

594

995

self.send_changedstate()

595

996

596

997

def disable(self, quiet=True):

597

998

"""Disable this client."""

598

999

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

600

1001

if not quiet:

601

1002

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

602

1003

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

603

gobject.source_remove(self.disable_initiator_tag)

1004

GLib.source_remove(self.disable_initiator_tag)

604

1005

self.disable_initiator_tag = None

605

1006

self.expires = None

606

1007

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

607

gobject.source_remove(self.checker_initiator_tag)

1008

GLib.source_remove(self.checker_initiator_tag)

608

1009

self.checker_initiator_tag = None

609

1010

self.stop_checker()

610

1011

self.enabled = False

611

1012

if not quiet:

612

1013

self.send_changedstate()

613

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

1014

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

614

1015

return False

615

1016

616

1017

def __del__(self):

617

1018

self.disable()

618

1019

619

1020

def init_checker(self):

620

1021

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

621

1022

# and every interval from then on.

622

1023

if self.checker_initiator_tag is not None:

623

gobject.source_remove(self.checker_initiator_tag)

624

self.checker_initiator_tag = (gobject.timeout_add

625

(self.interval_milliseconds(),

626

self.start_checker))

1024

GLib.source_remove(self.checker_initiator_tag)

1025

self.checker_initiator_tag = GLib.timeout_add(

1026

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

1027

self.start_checker)

627

1028

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

628

1029

if self.disable_initiator_tag is not None:

629

gobject.source_remove(self.disable_initiator_tag)

630

self.disable_initiator_tag = (gobject.timeout_add

631

(self.timeout_milliseconds(),

632

self.disable))

1030

GLib.source_remove(self.disable_initiator_tag)

1031

self.disable_initiator_tag = GLib.timeout_add(

1032

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

633

1033

# Also start a new checker *right now*.

634

1034

self.start_checker()

635

636

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

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

637

1038

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

1039

# Read return code from connection (see call_pipe)

1040

returncode = connection.recv()

1041

connection.close()

1042

self.checker.join()

638

1043

self.checker_callback_tag = None

639

1044

self.checker = None

640

if os.WIFEXITED(condition):

641

self.last_checker_status = os.WEXITSTATUS(condition)

1045

1046

if returncode >= 0:

1047

self.last_checker_status = returncode

1048

self.last_checker_signal = None

642

1049

if self.last_checker_status == 0:

643

1050

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

644

1051

vars(self))

645

1052

self.checked_ok()

646

1053

else:

647

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

648

vars(self))

1054

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

649

1055

else:

650

1056

self.last_checker_status = -1

1057

self.last_checker_signal = -returncode

651

1058

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

652

1059

vars(self))

653

1060

return False

1061

654

1062

def checked_ok(self):

655

1063

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

656

1064

self.last_checked_ok = datetime.datetime.utcnow()

657

1065

self.last_checker_status = 0

1066

self.last_checker_signal = None

658

1067

self.bump_timeout()

659

1068

660

1069

def bump_timeout(self, timeout=None):

661

1070

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

662

1071

if timeout is None:

663

1072

timeout = self.timeout

664

1073

if self.disable_initiator_tag is not None:

665

gobject.source_remove(self.disable_initiator_tag)

1074

GLib.source_remove(self.disable_initiator_tag)

666

1075

self.disable_initiator_tag = None

667

1076

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

668

self.disable_initiator_tag = (gobject.timeout_add

669

(timedelta_to_milliseconds

670

(timeout), self.disable))

1077

self.disable_initiator_tag = GLib.timeout_add(

1078

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

671

1079

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

672

1080

673

1081

def need_approval(self):

674

1082

self.last_approval_request = datetime.datetime.utcnow()

675

1083

676

1084

def start_checker(self):

677

1085

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

678

1086

679

1087

If a checker already exists, leave it running and do

680

1088

nothing."""

681

1089

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

686

1094

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

687

1095

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

688

1096

# should be.

689

690

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

691

try:

692

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

693

except (AttributeError, OSError) as error:

694

if (isinstance(error, OSError)

695

and error.errno != errno.ECHILD):

696

raise error

697

else:

698

if pid:

699

logger.warning("Checker was a zombie")

700

gobject.source_remove(self.checker_callback_tag)

701

self.checker_callback(pid, status,

702

self.current_checker_command)

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

703

1102

# Start a new checker if needed

704

1103

if self.checker is None:

705

1104

# Escape attributes for the shell

706

escaped_attrs = dict(

707

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

708

for attr in

709

self.runtime_expansions)

1105

escaped_attrs = {

1106

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

1107

for attr in self.runtime_expansions}

710

1108

try:

711

1109

command = self.checker_command % escaped_attrs

712

1110

except TypeError as error:

713

1111

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

714

self.checker_command, exc_info=error)

715

return True # Try again later

1112

self.checker_command,

1113

exc_info=error)

1114

return True # Try again later

716

1115

self.current_checker_command = command

717

try:

718

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

719

command, self.name)

720

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

721

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

722

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

723

# always replaced by /dev/null.)

724

# The exception is when not debugging but nevertheless

725

# running in the foreground; use the previously

726

# created wnull.

727

popen_args = {}

728

if (not self.server_settings["debug"]

729

and self.server_settings["foreground"]):

730

popen_args.update({"stdout": wnull,

731

"stderr": wnull })

732

self.checker = subprocess.Popen(command,

733

close_fds=True,

734

shell=True, cwd="/",

735

**popen_args)

736

except OSError as error:

737

logger.error("Failed to start subprocess",

738

exc_info=error)

739

return True

740

self.checker_callback_tag = (gobject.child_watch_add

741

(self.checker.pid,

742

self.checker_callback,

743

data=command))

744

# The checker may have completed before the gobject

745

# watch was added. Check for this.

746

try:

747

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

748

except OSError as error:

749

if error.errno == errno.ECHILD:

750

# This should never happen

751

logger.error("Child process vanished",

752

exc_info=error)

753

return True

754

raise

755

if pid:

756

gobject.source_remove(self.checker_callback_tag)

757

self.checker_callback(pid, status, command)

758

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

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

759

1142

return True

760

1143

761

1144

def stop_checker(self):

762

1145

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

763

1146

if self.checker_callback_tag:

764

gobject.source_remove(self.checker_callback_tag)

1147

GLib.source_remove(self.checker_callback_tag)

765

1148

self.checker_callback_tag = None

766

1149

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

767

1150

return

768

1151

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

769

try:

770

self.checker.terminate()

771

#time.sleep(0.5)

772

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

773

# self.checker.kill()

774

except OSError as error:

775

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

776

raise

1152

self.checker.terminate()

777

1153

self.checker = None

778

1154

779

1155

780

def dbus_service_property(dbus_interface, signature="v",

781

access="readwrite", byte_arrays=False):

1156

def dbus_service_property(dbus_interface,

1157

signature="v",

1158

access="readwrite",

1159

byte_arrays=False):

782

1160

"""Decorators for marking methods of a DBusObjectWithProperties to

783

1161

become properties on the D-Bus.

784

1162

785

1163

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

786

1164

and with one argument by "Set".

787

1165

788

1166

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

789

1167

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

790

1168

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

793

1171

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

794

1172

if byte_arrays and signature != "ay":

795

1173

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

796

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

1174

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

1175

797

1176

def decorator(func):

798

1177

func._dbus_is_property = True

799

1178

func._dbus_interface = dbus_interface

802

1181

func._dbus_name = func.__name__

803

1182

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

804

1183

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

805

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1184

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

806

1185

return func

1186

807

1187

return decorator

808

1188

809

1189

810

1190

def dbus_interface_annotations(dbus_interface):

811

1191

"""Decorator for marking functions returning interface annotations

812

1192

813

1193

Usage:

814

1194

815

1195

@dbus_interface_annotations("org.example.Interface")

816

1196

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

817

1197

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

818

1198

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

819

1199

"false"}

820

1200

"""

1201

821

1202

def decorator(func):

822

1203

func._dbus_is_interface = True

823

1204

func._dbus_interface = dbus_interface

824

1205

func._dbus_name = dbus_interface

825

1206

return func

1207

826

1208

return decorator

827

1209

828

1210

829

1211

def dbus_annotations(annotations):

830

1212

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

831

1213

Usage:

832

1214

1215

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

1216

"org.freedesktop.DBus.Property."

1217

"EmitsChangedSignal": "false"})

833

1218

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

834

1219

access="r")

835

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

836

"org.freedesktop.DBus.Property."

837

"EmitsChangedSignal": "false"})

838

1220

def Property_dbus_property(self):

839

1221

return dbus.Boolean(False)

1222

1223

See also the DBusObjectWithAnnotations class.

840

1224

"""

1225

841

1226

def decorator(func):

842

1227

func._dbus_annotations = annotations

843

1228

return func

1229

844

1230

return decorator

845

1231

846

1232

847

1233

class DBusPropertyException(dbus.exceptions.DBusException):

848

1234

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

849

1235

"""

850

def __unicode__(self):

851

return unicode(str(self))

1236

pass

852

1237

853

1238

854

1239

class DBusPropertyAccessException(DBusPropertyException):

863

1248

pass

864

1249

865

1250

866

class DBusObjectWithProperties(dbus.service.Object):

867

"""A D-Bus object with properties.

868

869

Classes inheriting from this can use the dbus_service_property

870

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

871

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

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.

872

1256

"""

873

1257

874

1258

@staticmethod

875

1259

def _is_dbus_thing(thing):

876

1260

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

877

1261

878

1262

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

879

1263

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

880

1264

"""

881

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

1265

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

882

1266

False)

883

1267

884

1268

def _get_all_dbus_things(self, thing):

885

1269

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

886

1270

"""

887

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

888

name),

1271

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

889

1272

athing.__get__(self))

890

1273

for cls in self.__class__.__mro__

891

1274

for name, athing in

892

inspect.getmembers(cls,

893

self._is_dbus_thing(thing)))

894

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

895

1348

def _get_dbus_property(self, interface_name, property_name):

896

1349

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

897

1350

property with the specified name and interface.

898

1351

"""

899

for cls in self.__class__.__mro__:

900

for name, value in (inspect.getmembers

901

(cls,

902

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

903

1355

if (value._dbus_name == property_name

904

1356

and value._dbus_interface == interface_name):

905

1357

return value.__get__(self)

906

1358

907

1359

# No such property

908

raise DBusPropertyNotFound(self.dbus_object_path + ":"

909

+ interface_name + "."

910

+ property_name)

911

912

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

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

913

1374

out_signature="v")

914

1375

def Get(self, interface_name, property_name):

915

1376

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

921

1382

if not hasattr(value, "variant_level"):

922

1383

return value

923

1384

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

924

1385

925

1386

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

926

1387

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

927

1388

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

933

1394

# The byte_arrays option is not supported yet on

934

1395

# signatures other than "ay".

935

1396

if prop._dbus_signature != "ay":

936

raise ValueError

1397

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

1398

"'ay' signature {!r}"

1399

.format(prop._dbus_signature))

937

1400

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

938

1401

for byte in value))

939

1402

prop(value)

940

941

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

1403

1404

@dbus.service.method(dbus.PROPERTIES_IFACE,

1405

in_signature="s",

942

1406

out_signature="a{sv}")

943

1407

def GetAll(self, interface_name):

944

1408

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

945

1409

standard.

946

1410

947

1411

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

948

1412

"""

949

1413

properties = {}

959

1423

if not hasattr(value, "variant_level"):

960

1424

properties[name] = value

961

1425

continue

962

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

963

value.variant_level+1)

1426

properties[name] = type(value)(

1427

value, variant_level=value.variant_level + 1)

964

1428

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

965

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

966

1438

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

967

1439

out_signature="s",

968

1440

path_keyword='object_path',

969

1441

connection_keyword='connection')

970

1442

def Introspect(self, object_path, connection):

971

1443

"""Overloading of standard D-Bus method.

972

1444

973

1445

Inserts property tags and interface annotation tags.

974

1446

"""

975

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

976

connection)

1447

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1448

object_path,

1449

connection)

977

1450

try:

978

1451

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

1452

979

1453

def make_tag(document, name, prop):

980

1454

e = document.createElement("property")

981

1455

e.setAttribute("name", name)

982

1456

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

983

1457

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

984

1458

return e

1459

985

1460

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

986

1461

# Add property tags

987

1462

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

990

1465

if prop._dbus_interface

991

1466

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

992

1467

if_tag.appendChild(tag)

993

# Add annotation tags

994

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

995

for tag in if_tag.getElementsByTagName(typ):

996

annots = dict()

997

for name, prop in (self.

998

_get_all_dbus_things(typ)):

999

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

1000

and prop._dbus_interface

1001

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

1002

annots.update(getattr

1003

(prop,

1004

"_dbus_annotations",

1005

{}))

1006

for name, value in annots.iteritems():

1007

ann_tag = document.createElement(

1008

"annotation")

1009

ann_tag.setAttribute("name", name)

1010

ann_tag.setAttribute("value", value)

1011

tag.appendChild(ann_tag)

1012

# Add interface annotation tags

1013

for annotation, value in dict(

1014

itertools.chain.from_iterable(

1015

annotations().iteritems()

1016

for name, annotations in

1017

self._get_all_dbus_things("interface")

1018

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

1019

)).iteritems():

1020

ann_tag = document.createElement("annotation")

1021

ann_tag.setAttribute("name", annotation)

1022

ann_tag.setAttribute("value", value)

1023

if_tag.appendChild(ann_tag)

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)

1024

1484

# Add the names to the return values for the

1025

1485

# "org.freedesktop.DBus.Properties" methods

1026

1486

if (if_tag.getAttribute("name")

1045

1505

return xmlstring

1046

1506

1047

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

1048

1579

def datetime_to_dbus(dt, variant_level=0):

1049

1580

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

1050

1581

if dt is None:

1051

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

1052

return dbus.String(dt.isoformat(),

1053

variant_level=variant_level)

1582

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

1583

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

1054

1584

1055

1585

1056

1586

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1058

1588

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

1059

1589

interface names according to the "alt_interface_names" mapping.

1060

1590

Usage:

1061

1591

1062

1592

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

1063

1593

"net.example.AlternateInterface"})

1064

1594

class SampleDBusObject(dbus.service.Object):

1065

1595

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

1066

1596

def SampleDBusMethod():

1067

1597

pass

1068

1598

1069

1599

The above "SampleDBusMethod" on "SampleDBusObject" will be

1070

1600

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

1071

1601

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

1072

1602

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

1073

1603

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

1074

1604

1075

1605

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

1076

1606

(from DBusObjectWithProperties) and interfaces (from the

1077

1607

dbus_interface_annotations decorator).

1078

1608

"""

1609

1079

1610

def wrapper(cls):

1080

1611

for orig_interface_name, alt_interface_name in (

1081

alt_interface_names.iteritems()):

1612

alt_interface_names.items()):

1082

1613

attr = {}

1083

1614

interface_names = set()

1084

1615

# Go though all attributes of the class

1086

1617

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

1087

1618

# with the wrong interface name

1088

1619

if (not hasattr(attribute, "_dbus_interface")

1089

or not attribute._dbus_interface

1090

.startswith(orig_interface_name)):

1620

or not attribute._dbus_interface.startswith(

1621

orig_interface_name)):

1091

1622

continue

1092

1623

# Create an alternate D-Bus interface name based on

1093

1624

# the current name

1094

alt_interface = (attribute._dbus_interface

1095

.replace(orig_interface_name,

1096

alt_interface_name))

1625

alt_interface = attribute._dbus_interface.replace(

1626

orig_interface_name, alt_interface_name)

1097

1627

interface_names.add(alt_interface)

1098

1628

# Is this a D-Bus signal?

1099

1629

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

1100

1630

# Extract the original non-method undecorated

1101

1631

# function by black magic

1102

nonmethod_func = (dict(

1632

if sys.version_info.major == 2:

1633

nonmethod_func = (dict(

1103

1634

zip(attribute.func_code.co_freevars,

1104

attribute.__closure__))["func"]

1105

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

1106

1642

# Create a new, but exactly alike, function

1107

1643

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

1108

1644

# with the alternate D-Bus interface name

1109

new_function = (dbus.service.signal

1110

(alt_interface,

1111

attribute._dbus_signature)

1112

(types.FunctionType(

1113

nonmethod_func.func_code,

1114

nonmethod_func.func_globals,

1115

nonmethod_func.func_name,

1116

nonmethod_func.func_defaults,

1117

nonmethod_func.func_closure)))

1645

new_function = copy_function(nonmethod_func)

1646

new_function = (dbus.service.signal(

1647

alt_interface,

1648

attribute._dbus_signature)(new_function))

1118

1649

# Copy annotations, if any

1119

1650

try:

1120

new_function._dbus_annotations = (

1121

dict(attribute._dbus_annotations))

1651

new_function._dbus_annotations = dict(

1652

attribute._dbus_annotations)

1122

1653

except AttributeError:

1123

1654

pass

1655

1124

1656

# Define a creator of a function to call both the

1125

1657

# original and alternate functions, so both the

1126

1658

# original and alternate signals gets sent when

1129

1661

"""This function is a scope container to pass

1130

1662

func1 and func2 to the "call_both" function

1131

1663

outside of its arguments"""

1664

1665

@functools.wraps(func2)

1132

1666

def call_both(*args, **kwargs):

1133

1667

"""This function will emit two D-Bus

1134

1668

signals by calling func1 and func2"""

1135

1669

func1(*args, **kwargs)

1136

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

1137

1677

return call_both

1138

1678

# Create the "call_both" function and add it to

1139

1679

# the class

1144

1684

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

1145

1685

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

1146

1686

# to the class.

1147

attr[attrname] = (dbus.service.method

1148

(alt_interface,

1149

attribute._dbus_in_signature,

1150

attribute._dbus_out_signature)

1151

(types.FunctionType

1152

(attribute.func_code,

1153

attribute.func_globals,

1154

attribute.func_name,

1155

attribute.func_defaults,

1156

attribute.func_closure)))

1687

attr[attrname] = (

1688

dbus.service.method(

1689

alt_interface,

1690

attribute._dbus_in_signature,

1691

attribute._dbus_out_signature)

1692

(copy_function(attribute)))

1157

1693

# Copy annotations, if any

1158

1694

try:

1159

attr[attrname]._dbus_annotations = (

1160

dict(attribute._dbus_annotations))

1695

attr[attrname]._dbus_annotations = dict(

1696

attribute._dbus_annotations)

1161

1697

except AttributeError:

1162

1698

pass

1163

1699

# Is this a D-Bus property?

1166

1702

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

1167

1703

# property with the alternate D-Bus interface

1168

1704

# name. Add it to the class.

1169

attr[attrname] = (dbus_service_property

1170

(alt_interface,

1171

attribute._dbus_signature,

1172

attribute._dbus_access,

1173

attribute

1174

._dbus_get_args_options

1175

["byte_arrays"])

1176

(types.FunctionType

1177

(attribute.func_code,

1178

attribute.func_globals,

1179

attribute.func_name,

1180

attribute.func_defaults,

1181

attribute.func_closure)))

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

1182

1711

# Copy annotations, if any

1183

1712

try:

1184

attr[attrname]._dbus_annotations = (

1185

dict(attribute._dbus_annotations))

1713

attr[attrname]._dbus_annotations = dict(

1714

attribute._dbus_annotations)

1186

1715

except AttributeError:

1187

1716

pass

1188

1717

# Is this a D-Bus interface?

1191

1720

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

1192

1721

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

1193

1722

# to the class.

1194

attr[attrname] = (dbus_interface_annotations

1195

(alt_interface)

1196

(types.FunctionType

1197

(attribute.func_code,

1198

attribute.func_globals,

1199

attribute.func_name,

1200

attribute.func_defaults,

1201

attribute.func_closure)))

1723

attr[attrname] = (

1724

dbus_interface_annotations(alt_interface)

1725

(copy_function(attribute)))

1202

1726

if deprecate:

1203

1727

# Deprecate all alternate interfaces

1204

iname="_AlternateDBusNames_interface_annotation{0}"

1728

iname = "_AlternateDBusNames_interface_annotation{}"

1205

1729

for interface_name in interface_names:

1730

1206

1731

@dbus_interface_annotations(interface_name)

1207

1732

def func(self):

1208

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

1209

"true" }

1733

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

1734

"true"}

1210

1735

# Find an unused name

1211

1736

for aname in (iname.format(i)

1212

1737

for i in itertools.count()):

1216

1741

if interface_names:

1217

1742

# Replace the class with a new subclass of it with

1218

1743

# methods, signals, etc. as created above.

1219

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

1220

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

1221

1750

return cls

1751

1222

1752

return wrapper

1223

1753

1224

1754

1225

1755

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

1226

"se.bsnet.fukt.Mandos"})

1756

"se.bsnet.fukt.Mandos"})

1227

1757

class ClientDBus(Client, DBusObjectWithProperties):

1228

1758

"""A Client class using D-Bus

1229

1759

1230

1760

Attributes:

1231

1761

dbus_object_path: dbus.ObjectPath

1232

1762

bus: dbus.SystemBus()

1233

1763

"""

1234

1764

1235

1765

runtime_expansions = (Client.runtime_expansions

1236

+ ("dbus_object_path",))

1237

1766

+ ("dbus_object_path", ))

1767

1768

_interface = "se.recompile.Mandos.Client"

1769

1238

1770

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

1239

1240

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

1771

1772

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

1241

1773

self.bus = bus

1242

1774

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

1243

1775

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

1244

1776

# the D-Bus

1245

client_object_name = unicode(self.name).translate(

1777

client_object_name = str(self.name).translate(

1246

1778

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

1247

1779

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

1248

self.dbus_object_path = (dbus.ObjectPath

1249

("/clients/" + client_object_name))

1780

self.dbus_object_path = dbus.ObjectPath(

1781

"/clients/" + client_object_name)

1250

1782

DBusObjectWithProperties.__init__(self, self.bus,

1251

1783

self.dbus_object_path)

1252

1253

def notifychangeproperty(transform_func,

1254

dbus_name, type_func=lambda x: x,

1255

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

1256

1790

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

1257

1791

its changes to DBus.

1258

1792

1259

1793

transform_fun: Function that takes a value and a variant_level

1260

1794

and transforms it to a D-Bus type.

1261

1795

dbus_name: D-Bus name of the variable

1263

1797

to the D-Bus. Default: no transform

1264

1798

variant_level: D-Bus variant level. Default: 1

1265

1799

"""

1266

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

1800

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

1801

1267

1802

def setter(self, value):

1268

1803

if hasattr(self, "dbus_object_path"):

1269

1804

if (not hasattr(self, attrname) or

1270

1805

type_func(getattr(self, attrname, None))

1271

1806

!= type_func(value)):

1272

dbus_value = transform_func(type_func(value),

1273

variant_level

1274

=variant_level)

1275

self.PropertyChanged(dbus.String(dbus_name),

1276

dbus_value)

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

1277

1822

setattr(self, attrname, value)

1278

1823

1279

1824

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

1280

1825

1281

1826

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1282

1827

approvals_pending = notifychangeproperty(dbus.Boolean,

1283

1828

"ApprovalPending",

1284

type_func = bool)

1829

type_func=bool)

1285

1830

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

1286

1831

last_enabled = notifychangeproperty(datetime_to_dbus,

1287

1832

"LastEnabled")

1288

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

1289

type_func = lambda checker:

1290

checker is not None)

1833

checker = notifychangeproperty(

1834

dbus.Boolean, "CheckerRunning",

1835

type_func=lambda checker: checker is not None)

1291

1836

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1292

1837

"LastCheckedOK")

1293

1838

last_checker_status = notifychangeproperty(dbus.Int16,

1296

1841

datetime_to_dbus, "LastApprovalRequest")

1297

1842

approved_by_default = notifychangeproperty(dbus.Boolean,

1298

1843

"ApprovedByDefault")

1299

approval_delay = notifychangeproperty(dbus.UInt64,

1300

"ApprovalDelay",

1301

type_func =

1302

timedelta_to_milliseconds)

1844

approval_delay = notifychangeproperty(

1845

dbus.UInt64, "ApprovalDelay",

1846

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

1303

1847

approval_duration = notifychangeproperty(

1304

1848

dbus.UInt64, "ApprovalDuration",

1305

type_func = timedelta_to_milliseconds)

1849

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

1306

1850

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

1307

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

1308

type_func =

1309

timedelta_to_milliseconds)

1851

timeout = notifychangeproperty(

1852

dbus.UInt64, "Timeout",

1853

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

1310

1854

extended_timeout = notifychangeproperty(

1311

1855

dbus.UInt64, "ExtendedTimeout",

1312

type_func = timedelta_to_milliseconds)

1313

interval = notifychangeproperty(dbus.UInt64,

1314

"Interval",

1315

type_func =

1316

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)

1317

1860

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

1318

1861

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

1862

invalidate_only=True)

1863

1319

1864

del notifychangeproperty

1320

1865

1321

1866

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

1322

1867

try:

1323

1868

self.remove_from_connection()

1326

1871

if hasattr(DBusObjectWithProperties, "__del__"):

1327

1872

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

1328

1873

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

1329

1330

def checker_callback(self, pid, condition, command,

1331

*args, **kwargs):

1332

self.checker_callback_tag = None

1333

self.checker = None

1334

if os.WIFEXITED(condition):

1335

exitstatus = os.WEXITSTATUS(condition)

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:

1336

1882

# Emit D-Bus signal

1337

1883

self.CheckerCompleted(dbus.Int16(exitstatus),

1338

dbus.Int64(condition),

1884

# This is specific to GNU libC

1885

dbus.Int64(exitstatus << 8),

1339

1886

dbus.String(command))

1340

1887

else:

1341

1888

# Emit D-Bus signal

1342

1889

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

1343

dbus.Int64(condition),

1890

dbus.Int64(

1891

# This is specific to GNU libC

1892

(exitstatus << 8)

1893

| self.last_checker_signal),

1344

1894

dbus.String(command))

1345

1346

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

1347

*args, **kwargs)

1348

1895

return ret

1896

1349

1897

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

1350

old_checker = self.checker

1351

if self.checker is not None:

1352

old_checker_pid = self.checker.pid

1353

else:

1354

old_checker_pid = None

1898

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

1355

1899

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

1356

1900

# Only if new checker process was started

1357

1901

if (self.checker is not None

1359

1903

# Emit D-Bus signal

1360

1904

self.CheckerStarted(self.current_checker_command)

1361

1905

return r

1362

1906

1363

1907

def _reset_approved(self):

1364

1908

self.approved = None

1365

1909

return False

1366

1910

1367

1911

def approve(self, value=True):

1368

1912

self.approved = value

1369

gobject.timeout_add(timedelta_to_milliseconds

1370

(self.approval_duration),

1371

self._reset_approved)

1913

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

1914

* 1000), self._reset_approved)

1372

1915

self.send_changedstate()

1373

1374

## D-Bus methods, signals & properties

1375

_interface = "se.recompile.Mandos.Client"

1376

1377

## Interfaces

1378

1379

@dbus_interface_annotations(_interface)

1380

def _foo(self):

1381

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

1382

"false"}

1383

1384

## Signals

1385

1916

1917

# D-Bus methods, signals & properties

1918

1919

# Interfaces

1920

1921

# Signals

1922

1386

1923

# CheckerCompleted - signal

1387

1924

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

1388

1925

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

1389

1926

"D-Bus signal"

1390

1927

pass

1391

1928

1392

1929

# CheckerStarted - signal

1393

1930

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

1394

1931

def CheckerStarted(self, command):

1395

1932

"D-Bus signal"

1396

1933

pass

1397

1934

1398

1935

# PropertyChanged - signal

1936

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

1399

1937

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

1400

1938

def PropertyChanged(self, property, value):

1401

1939

"D-Bus signal"

1402

1940

pass

1403

1941

1404

1942

# GotSecret - signal

1405

1943

@dbus.service.signal(_interface)

1406

1944

def GotSecret(self):

1409

1947

server to mandos-client

1410

1948

"""

1411

1949

pass

1412

1950

1413

1951

# Rejected - signal

1414

1952

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

1415

1953

def Rejected(self, reason):

1416

1954

"D-Bus signal"

1417

1955

pass

1418

1956

1419

1957

# NeedApproval - signal

1420

1958

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

1421

1959

def NeedApproval(self, timeout, default):

1422

1960

"D-Bus signal"

1423

1961

return self.need_approval()

1424

1425

## Methods

1426

1962

1963

# Methods

1964

1427

1965

# Approve - method

1428

1966

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

1429

1967

def Approve(self, value):

1430

1968

self.approve(value)

1431

1969

1432

1970

# CheckedOK - method

1433

1971

@dbus.service.method(_interface)

1434

1972

def CheckedOK(self):

1435

1973

self.checked_ok()

1436

1974

1437

1975

# Enable - method

1976

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

1438

1977

@dbus.service.method(_interface)

1439

1978

def Enable(self):

1440

1979

"D-Bus method"

1441

1980

self.enable()

1442

1981

1443

1982

# StartChecker - method

1983

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

1444

1984

@dbus.service.method(_interface)

1445

1985

def StartChecker(self):

1446

1986

"D-Bus method"

1447

1987

self.start_checker()

1448

1988

1449

1989

# Disable - method

1990

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

1450

1991

@dbus.service.method(_interface)

1451

1992

def Disable(self):

1452

1993

"D-Bus method"

1453

1994

self.disable()

1454

1995

1455

1996

# StopChecker - method

1997

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

1456

1998

@dbus.service.method(_interface)

1457

1999

def StopChecker(self):

1458

2000

self.stop_checker()

1459

1460

## Properties

1461

2001

2002

# Properties

2003

1462

2004

# ApprovalPending - property

1463

2005

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

1464

2006

def ApprovalPending_dbus_property(self):

1465

2007

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

1466

2008

1467

2009

# ApprovedByDefault - property

1468

@dbus_service_property(_interface, signature="b",

2010

@dbus_service_property(_interface,

2011

signature="b",

1469

2012

access="readwrite")

1470

2013

def ApprovedByDefault_dbus_property(self, value=None):

1471

2014

if value is None: # get

1472

2015

return dbus.Boolean(self.approved_by_default)

1473

2016

self.approved_by_default = bool(value)

1474

2017

1475

2018

# ApprovalDelay - property

1476

@dbus_service_property(_interface, signature="t",

2019

@dbus_service_property(_interface,

2020

signature="t",

1477

2021

access="readwrite")

1478

2022

def ApprovalDelay_dbus_property(self, value=None):

1479

2023

if value is None: # get

1480

return dbus.UInt64(self.approval_delay_milliseconds())

2024

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

2025

* 1000)

1481

2026

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

1482

2027

1483

2028

# ApprovalDuration - property

1484

@dbus_service_property(_interface, signature="t",

2029

@dbus_service_property(_interface,

2030

signature="t",

1485

2031

access="readwrite")

1486

2032

def ApprovalDuration_dbus_property(self, value=None):

1487

2033

if value is None: # get

1488

return dbus.UInt64(timedelta_to_milliseconds(

1489

self.approval_duration))

2034

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

2035

* 1000)

1490

2036

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

1491

2037

1492

2038

# Name - property

2039

@dbus_annotations(

2040

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

1493

2041

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

1494

2042

def Name_dbus_property(self):

1495

2043

return dbus.String(self.name)

1496

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

1497

2052

# Fingerprint - property

2053

@dbus_annotations(

2054

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

1498

2055

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

1499

2056

def Fingerprint_dbus_property(self):

1500

2057

return dbus.String(self.fingerprint)

1501

2058

1502

2059

# Host - property

1503

@dbus_service_property(_interface, signature="s",

2060

@dbus_service_property(_interface,

2061

signature="s",

1504

2062

access="readwrite")

1505

2063

def Host_dbus_property(self, value=None):

1506

2064

if value is None: # get

1507

2065

return dbus.String(self.host)

1508

self.host = unicode(value)

1509

2066

self.host = str(value)

2067

1510

2068

# Created - property

2069

@dbus_annotations(

2070

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

1511

2071

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

1512

2072

def Created_dbus_property(self):

1513

2073

return datetime_to_dbus(self.created)

1514

2074

1515

2075

# LastEnabled - property

1516

2076

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

1517

2077

def LastEnabled_dbus_property(self):

1518

2078

return datetime_to_dbus(self.last_enabled)

1519

2079

1520

2080

# Enabled - property

1521

@dbus_service_property(_interface, signature="b",

2081

@dbus_service_property(_interface,

2082

signature="b",

1522

2083

access="readwrite")

1523

2084

def Enabled_dbus_property(self, value=None):

1524

2085

if value is None: # get

1527

2088

self.enable()

1528

2089

else:

1529

2090

self.disable()

1530

2091

1531

2092

# LastCheckedOK - property

1532

@dbus_service_property(_interface, signature="s",

2093

@dbus_service_property(_interface,

2094

signature="s",

1533

2095

access="readwrite")

1534

2096

def LastCheckedOK_dbus_property(self, value=None):

1535

2097

if value is not None:

1536

2098

self.checked_ok()

1537

2099

return

1538

2100

return datetime_to_dbus(self.last_checked_ok)

1539

2101

1540

2102

# LastCheckerStatus - property

1541

@dbus_service_property(_interface, signature="n",

1542

access="read")

2103

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

1543

2104

def LastCheckerStatus_dbus_property(self):

1544

2105

return dbus.Int16(self.last_checker_status)

1545

2106

1546

2107

# Expires - property

1547

2108

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

1548

2109

def Expires_dbus_property(self):

1549

2110

return datetime_to_dbus(self.expires)

1550

2111

1551

2112

# LastApprovalRequest - property

1552

2113

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

1553

2114

def LastApprovalRequest_dbus_property(self):

1554

2115

return datetime_to_dbus(self.last_approval_request)

1555

2116

1556

2117

# Timeout - property

1557

@dbus_service_property(_interface, signature="t",

2118

@dbus_service_property(_interface,

2119

signature="t",

1558

2120

access="readwrite")

1559

2121

def Timeout_dbus_property(self, value=None):

1560

2122

if value is None: # get

1561

return dbus.UInt64(self.timeout_milliseconds())

2123

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

1562

2124

old_timeout = self.timeout

1563

2125

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

1564

2126

# Reschedule disabling

1572

2134

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

1573

2135

is None):

1574

2136

return

1575

gobject.source_remove(self.disable_initiator_tag)

1576

self.disable_initiator_tag = (

1577

gobject.timeout_add(

1578

timedelta_to_milliseconds(self.expires - now),

1579

self.disable))

1580

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

1581

2142

# ExtendedTimeout - property

1582

@dbus_service_property(_interface, signature="t",

2143

@dbus_service_property(_interface,

2144

signature="t",

1583

2145

access="readwrite")

1584

2146

def ExtendedTimeout_dbus_property(self, value=None):

1585

2147

if value is None: # get

1586

return dbus.UInt64(self.extended_timeout_milliseconds())

2148

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

2149

* 1000)

1587

2150

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

1588

2151

1589

2152

# Interval - property

1590

@dbus_service_property(_interface, signature="t",

2153

@dbus_service_property(_interface,

2154

signature="t",

1591

2155

access="readwrite")

1592

2156

def Interval_dbus_property(self, value=None):

1593

2157

if value is None: # get

1594

return dbus.UInt64(self.interval_milliseconds())

2158

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

1595

2159

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

1596

2160

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

1597

2161

return

1598

2162

if self.enabled:

1599

2163

# Reschedule checker run

1600

gobject.source_remove(self.checker_initiator_tag)

1601

self.checker_initiator_tag = (gobject.timeout_add

1602

(value, self.start_checker))

1603

self.start_checker() # Start one now, too

1604

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

1605

2169

# Checker - property

1606

@dbus_service_property(_interface, signature="s",

2170

@dbus_service_property(_interface,

2171

signature="s",

1607

2172

access="readwrite")

1608

2173

def Checker_dbus_property(self, value=None):

1609

2174

if value is None: # get

1610

2175

return dbus.String(self.checker_command)

1611

self.checker_command = unicode(value)

1612

2176

self.checker_command = str(value)

2177

1613

2178

# CheckerRunning - property

1614

@dbus_service_property(_interface, signature="b",

2179

@dbus_service_property(_interface,

2180

signature="b",

1615

2181

access="readwrite")

1616

2182

def CheckerRunning_dbus_property(self, value=None):

1617

2183

if value is None: # get

1620

2186

self.start_checker()

1621

2187

else:

1622

2188

self.stop_checker()

1623

2189

1624

2190

# ObjectPath - property

2191

@dbus_annotations(

2192

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

2193

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

1625

2194

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

1626

2195

def ObjectPath_dbus_property(self):

1627

return self.dbus_object_path # is already a dbus.ObjectPath

1628

2196

return self.dbus_object_path # is already a dbus.ObjectPath

2197

1629

2198

# Secret = property

1630

@dbus_service_property(_interface, signature="ay",

1631

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)

1632

2206

def Secret_dbus_property(self, value):

1633

self.secret = str(value)

1634

2207

self.secret = bytes(value)

2208

1635

2209

del _interface

1636

2210

1637

2211

1638

2212

class ProxyClient(object):

1639

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

2213

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

1640

2214

self._pipe = child_pipe

1641

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

2215

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

1642

2216

if not self._pipe.recv():

1643

raise KeyError()

1644

2217

raise KeyError(key_id or fpr)

2218

1645

2219

def __getattribute__(self, name):

1646

2220

if name == '_pipe':

1647

2221

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

1650

2224

if data[0] == 'data':

1651

2225

return data[1]

1652

2226

if data[0] == 'function':

2227

1653

2228

def func(*args, **kwargs):

1654

2229

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

1655

2230

return self._pipe.recv()[1]

2231

1656

2232

return func

1657

2233

1658

2234

def __setattr__(self, name, value):

1659

2235

if name == '_pipe':

1660

2236

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

1663

2239

1664

2240

class ClientHandler(socketserver.BaseRequestHandler, object):

1665

2241

"""A class to handle client connections.

1666

2242

1667

2243

Instantiated once for each connection to handle it.

1668

2244

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

1669

2245

1670

2246

def handle(self):

1671

2247

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

1672

2248

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

1673

unicode(self.client_address))

2249

str(self.client_address))

1674

2250

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

1675

2251

self.server.child_pipe.fileno())

1676

1677

session = (gnutls.connection

1678

.ClientSession(self.request,

1679

gnutls.connection

1680

.X509Credentials()))

1681

1682

# Note: gnutls.connection.X509Credentials is really a

1683

# generic GnuTLS certificate credentials object so long as

1684

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

1685

# here despite using OpenPGP certificates.

1686

1687

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

1688

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

1689

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

1690

# "+DHE-DSS"))

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

1691

2259

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

1692

2260

priority = self.server.gnutls_priority

1693

2261

if priority is None:

1694

2262

priority = "NORMAL"

1695

(gnutls.library.functions

1696

.gnutls_priority_set_direct(session._c_object,

1697

priority, None))

1698

2263

gnutls.priority_set_direct(session._c_object,

2264

priority.encode("utf-8"),

2265

None)

2266

1699

2267

# Start communication using the Mandos protocol

1700

2268

# Get protocol number

1701

2269

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

1702

2270

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

1703

2271

try:

1704

2272

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

1705

raise RuntimeError

2273

raise RuntimeError(line)

1706

2274

except (ValueError, IndexError, RuntimeError) as error:

1707

2275

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

1708

2276

return

1709

2277

1710

2278

# Start GnuTLS connection

1711

2279

try:

1712

2280

session.handshake()

1713

except gnutls.errors.GNUTLSError as error:

2281

except gnutls.Error as error:

1714

2282

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

1715

2283

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

1716

2284

# established. Just abandon the request.

1717

2285

return

1718

2286

logger.debug("Handshake succeeded")

1719

2287

1720

2288

approval_required = False

1721

2289

try:

1722

try:

1723

fpr = self.fingerprint(self.peer_certificate

1724

(session))

1725

except (TypeError,

1726

gnutls.errors.GNUTLSError) as error:

1727

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

1728

return

1729

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

1730

1731

try:

1732

client = ProxyClient(child_pipe, fpr,

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,

1733

2312

self.client_address)

1734

2313

except KeyError:

1735

2314

return

1736

2315

1737

2316

if client.approval_delay:

1738

2317

delay = client.approval_delay

1739

2318

client.approvals_pending += 1

1740

2319

approval_required = True

1741

2320

1742

2321

while True:

1743

2322

if not client.enabled:

1744

2323

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

1745

client.name)

2324

client.name)

1746

2325

if self.server.use_dbus:

1747

2326

# Emit D-Bus signal

1748

2327

client.Rejected("Disabled")

1749

2328

return

1750

2329

1751

2330

if client.approved or not client.approval_delay:

1752

#We are approved or approval is disabled

2331

# We are approved or approval is disabled

1753

2332

break

1754

2333

elif client.approved is None:

1755

2334

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

1757

2336

if self.server.use_dbus:

1758

2337

# Emit D-Bus signal

1759

2338

client.NeedApproval(

1760

client.approval_delay_milliseconds(),

1761

client.approved_by_default)

2339

client.approval_delay.total_seconds()

2340

* 1000, client.approved_by_default)

1762

2341

else:

1763

2342

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

1764

2343

client.name)

1766

2345

# Emit D-Bus signal

1767

2346

client.Rejected("Denied")

1768

2347

return

1769

1770

#wait until timeout or approved

2348

2349

# wait until timeout or approved

1771

2350

time = datetime.datetime.now()

1772

2351

client.changedstate.acquire()

1773

client.changedstate.wait(

1774

float(timedelta_to_milliseconds(delay)

1775

/ 1000))

2352

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

1776

2353

client.changedstate.release()

1777

2354

time2 = datetime.datetime.now()

1778

2355

if (time2 - time) >= delay:

1788

2365

break

1789

2366

else:

1790

2367

delay -= time2 - time

1791

1792

sent_size = 0

1793

while sent_size < len(client.secret):

1794

try:

1795

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

1796

except gnutls.errors.GNUTLSError as error:

1797

logger.warning("gnutls send failed",

1798

exc_info=error)

1799

return

1800

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

1801

sent, len(client.secret)

1802

- (sent_size + sent))

1803

sent_size += sent

1804

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

1805

2376

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

1806

2377

# bump the timeout using extended_timeout

1807

2378

client.bump_timeout(client.extended_timeout)

1808

2379

if self.server.use_dbus:

1809

2380

# Emit D-Bus signal

1810

2381

client.GotSecret()

1811

2382

1812

2383

finally:

1813

2384

if approval_required:

1814

2385

client.approvals_pending -= 1

1815

2386

try:

1816

2387

session.bye()

1817

except gnutls.errors.GNUTLSError as error:

2388

except gnutls.Error as error:

1818

2389

logger.warning("GnuTLS bye failed",

1819

2390

exc_info=error)

1820

2391

1821

2392

@staticmethod

1822

2393

def peer_certificate(session):

1823

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

1824

# If not an OpenPGP certificate...

1825

if (gnutls.library.functions

1826

.gnutls_certificate_type_get(session._c_object)

1827

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1828

# ...do the normal thing

1829

return session.peer_certificate

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

1830

2410

list_size = ctypes.c_uint(1)

1831

cert_list = (gnutls.library.functions

1832

.gnutls_certificate_get_peers

2411

cert_list = (gnutls.certificate_get_peers

1833

2412

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

1834

2413

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

1835

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

1836

" certificate")

2414

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

1837

2415

if list_size.value == 0:

1838

2416

return None

1839

2417

cert = cert_list[0]

1840

2418

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

1841

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

1842

2454

@staticmethod

1843

2455

def fingerprint(openpgp):

1844

2456

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1845

2457

# New GnuTLS "datum" with the OpenPGP public key

1846

datum = (gnutls.library.types

1847

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

1848

ctypes.POINTER

1849

(ctypes.c_ubyte)),

1850

ctypes.c_uint(len(openpgp))))

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

1851

2462

# New empty GnuTLS certificate

1852

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1853

(gnutls.library.functions

1854

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2463

crt = gnutls.openpgp_crt_t()

2464

gnutls.openpgp_crt_init(ctypes.byref(crt))

1855

2465

# Import the OpenPGP public key into the certificate

1856

(gnutls.library.functions

1857

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

1858

gnutls.library.constants

1859

.GNUTLS_OPENPGP_FMT_RAW))

2466

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

2467

gnutls.OPENPGP_FMT_RAW)

1860

2468

# Verify the self signature in the key

1861

2469

crtverify = ctypes.c_uint()

1862

(gnutls.library.functions

1863

.gnutls_openpgp_crt_verify_self(crt, 0,

1864

ctypes.byref(crtverify)))

2470

gnutls.openpgp_crt_verify_self(crt, 0,

2471

ctypes.byref(crtverify))

1865

2472

if crtverify.value != 0:

1866

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1867

raise (gnutls.errors.CertificateSecurityError

1868

("Verify failed"))

2473

gnutls.openpgp_crt_deinit(crt)

2474

raise gnutls.CertificateSecurityError(code

2475

=crtverify.value)

1869

2476

# New buffer for the fingerprint

1870

2477

buf = ctypes.create_string_buffer(20)

1871

2478

buf_len = ctypes.c_size_t()

1872

2479

# Get the fingerprint from the certificate into the buffer

1873

(gnutls.library.functions

1874

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

1875

ctypes.byref(buf_len)))

2480

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

2481

ctypes.byref(buf_len))

1876

2482

# Deinit the certificate

1877

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2483

gnutls.openpgp_crt_deinit(crt)

1878

2484

# Convert the buffer to a Python bytestring

1879

2485

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

1880

2486

# Convert the bytestring to hexadecimal notation

1884

2490

1885

2491

class MultiprocessingMixIn(object):

1886

2492

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

2493

1887

2494

def sub_process_main(self, request, address):

1888

2495

try:

1889

2496

self.finish_request(request, address)

1890

2497

except Exception:

1891

2498

self.handle_error(request, address)

1892

2499

self.close_request(request)

1893

2500

1894

2501

def process_request(self, request, address):

1895

2502

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

1896

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

1897

args = (request, address))

2503

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

2504

args=(request, address))

1898

2505

proc.start()

1899

2506

return proc

1900

2507

1901

2508

1902

2509

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1903

2510

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

2511

1904

2512

def process_request(self, request, client_address):

1905

2513

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

1906

2514

1907

2515

This function creates a new pipe in self.pipe

1908

2516

"""

1909

2517

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1910

2518

1911

2519

proc = MultiprocessingMixIn.process_request(self, request,

1912

2520

client_address)

1913

2521

self.child_pipe.close()

1914

2522

self.add_pipe(parent_pipe, proc)

1915

2523

1916

2524

def add_pipe(self, parent_pipe, proc):

1917

2525

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

1918

raise NotImplementedError

2526

raise NotImplementedError()

1919

2527

1920

2528

1921

2529

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1922

2530

socketserver.TCPServer, object):

1923

2531

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

1924

2532

1925

2533

Attributes:

1926

2534

enabled: Boolean; whether this server is activated yet

1927

2535

interface: None or a network interface name (string)

1928

2536

use_ipv6: Boolean; to use IPv6 or not

1929

2537

"""

2538

1930

2539

def __init__(self, server_address, RequestHandlerClass,

1931

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

2540

interface=None,

2541

use_ipv6=True,

2542

socketfd=None):

1932

2543

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

1933

2544

creating a new one with socket.socket().

1934

2545

"""

1940

2551

self.socketfd = socketfd

1941

2552

# Save the original socket.socket() function

1942

2553

self.socket_socket = socket.socket

2554

1943

2555

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

1944

#

2556

#

1945

2557

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

1946

2558

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

1947

2559

# patching socket.socket.)

1948

#

2560

#

1949

2561

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

1950

2562

@functools.wraps(socket.socket)

1951

2563

def socket_wrapper(*args, **kwargs):

1963

2575

# socket_wrapper(), if socketfd was set.

1964

2576

socketserver.TCPServer.__init__(self, server_address,

1965

2577

RequestHandlerClass)

1966

2578

1967

2579

def server_bind(self):

1968

2580

"""This overrides the normal server_bind() function

1969

2581

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

1970

2582

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

2583

global SO_BINDTODEVICE

1971

2584

if self.interface is not None:

1972

2585

if SO_BINDTODEVICE is None:

1973

logger.error("SO_BINDTODEVICE does not exist;"

1974

" cannot bind to interface %s",

1975

self.interface)

1976

else:

1977

try:

1978

self.socket.setsockopt(socket.SOL_SOCKET,

1979

SO_BINDTODEVICE,

1980

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

1981

except socket.error as error:

1982

if error.errno == errno.EPERM:

1983

logger.error("No permission to bind to"

1984

" interface %s", self.interface)

1985

elif error.errno == errno.ENOPROTOOPT:

1986

logger.error("SO_BINDTODEVICE not available;"

1987

" cannot bind to interface %s",

1988

self.interface)

1989

elif error.errno == errno.ENODEV:

1990

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

1991

" cannot bind", self.interface)

1992

else:

1993

raise

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

1994

2607

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

1995

2608

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

2609

if self.server_address[1]:

2610

self.allow_reuse_address = True

1996

2611

if not self.server_address[0]:

1997

2612

if self.address_family == socket.AF_INET6:

1998

any_address = "::" # in6addr_any

2613

any_address = "::" # in6addr_any

1999

2614

else:

2000

any_address = "0.0.0.0" # INADDR_ANY

2615

any_address = "0.0.0.0" # INADDR_ANY

2001

2616

self.server_address = (any_address,

2002

2617

self.server_address[1])

2003

2618

elif not self.server_address[1]:

2004

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

2005

0)

2619

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

2006

2620

# if self.interface:

2007

2621

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

2008

2622

# 0, # port

2014

2628

2015

2629

class MandosServer(IPv6_TCPServer):

2016

2630

"""Mandos server.

2017

2631

2018

2632

Attributes:

2019

2633

clients: set of Client objects

2020

2634

gnutls_priority GnuTLS priority string

2021

2635

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

2022

2023

Assumes a gobject.MainLoop event loop.

2636

2637

Assumes a GLib.MainLoop event loop.

2024

2638

"""

2639

2025

2640

def __init__(self, server_address, RequestHandlerClass,

2026

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

2027

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

2028

2647

self.enabled = False

2029

2648

self.clients = clients

2030

2649

if self.clients is None:

2033

2652

self.gnutls_priority = gnutls_priority

2034

2653

IPv6_TCPServer.__init__(self, server_address,

2035

2654

RequestHandlerClass,

2036

interface = interface,

2037

use_ipv6 = use_ipv6,

2038

socketfd = socketfd)

2655

interface=interface,

2656

use_ipv6=use_ipv6,

2657

socketfd=socketfd)

2658

2039

2659

def server_activate(self):

2040

2660

if self.enabled:

2041

2661

return socketserver.TCPServer.server_activate(self)

2042

2662

2043

2663

def enable(self):

2044

2664

self.enabled = True

2045

2665

2046

2666

def add_pipe(self, parent_pipe, proc):

2047

2667

# Call "handle_ipc" for both data and EOF events

2048

gobject.io_add_watch(parent_pipe.fileno(),

2049

gobject.IO_IN | gobject.IO_HUP,

2050

functools.partial(self.handle_ipc,

2051

parent_pipe =

2052

parent_pipe,

2053

proc = proc))

2054

2055

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

2056

proc = None, client_object=None):

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

2057

2679

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

2058

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

2680

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

2059

2681

# Wait for other process to exit

2060

2682

proc.join()

2061

2683

return False

2062

2684

2063

2685

# Read a request from the child

2064

2686

request = parent_pipe.recv()

2065

2687

command = request[0]

2066

2688

2067

2689

if command == 'init':

2068

fpr = request[1]

2069

address = request[2]

2070

2071

for c in self.clients.itervalues():

2072

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:

2073

2701

client = c

2074

2702

break

2075

2703

else:

2076

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

2077

"dress: %s", fpr, address)

2704

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

2705

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

2078

2706

if self.use_dbus:

2079

2707

# Emit D-Bus signal

2080

mandos_dbus_service.ClientNotFound(fpr,

2708

mandos_dbus_service.ClientNotFound(key_id or fpr,

2081

2709

address[0])

2082

2710

parent_pipe.send(False)

2083

2711

return False

2084

2085

gobject.io_add_watch(parent_pipe.fileno(),

2086

gobject.IO_IN | gobject.IO_HUP,

2087

functools.partial(self.handle_ipc,

2088

parent_pipe =

2089

parent_pipe,

2090

proc = proc,

2091

client_object =

2092

client))

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

2093

2720

parent_pipe.send(True)

2094

2721

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

2095

2722

# same fileno

2098

2725

funcname = request[1]

2099

2726

args = request[2]

2100

2727

kwargs = request[3]

2101

2728

2102

2729

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

2103

2730

funcname)(*args,

2104

**kwargs)))

2105

2731

**kwargs)))

2732

2106

2733

if command == 'getattr':

2107

2734

attrname = request[1]

2108

if callable(client_object.__getattribute__(attrname)):

2109

parent_pipe.send(('function',))

2735

if isinstance(client_object.__getattribute__(attrname),

2736

collections.Callable):

2737

parent_pipe.send(('function', ))

2110

2738

else:

2111

parent_pipe.send(('data', client_object

2112

.__getattribute__(attrname)))

2113

2739

parent_pipe.send((

2740

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

2741

2114

2742

if command == 'setattr':

2115

2743

attrname = request[1]

2116

2744

value = request[2]

2117

2745

setattr(client_object, attrname, value)

2118

2746

2119

2747

return True

2120

2748

2121

2749

2122

2750

def rfc3339_duration_to_delta(duration):

2123

2751

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

2124

2752

2125

2753

>>> rfc3339_duration_to_delta("P7D")

2126

2754

datetime.timedelta(7)

2127

2755

>>> rfc3339_duration_to_delta("PT60S")

2137

2765

>>> rfc3339_duration_to_delta("P1DT3M20S")

2138

2766

datetime.timedelta(1, 200)

2139

2767

"""

2140

2768

2141

2769

# Parsing an RFC 3339 duration with regular expressions is not

2142

2770

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

2143

2771

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

2144

2772

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

2145

2773

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

2146

2774

# avoid excessive use of external libraries.

2147

2775

2148

2776

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

2149

Token = collections.namedtuple("Token",

2150

("regexp", # To match token; if

2151

# "value" is not None,

2152

# must have a "group"

2153

# containing digits

2154

"value", # datetime.timedelta or

2155

# None

2156

"followers")) # Tokens valid after

2157

# this token

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

2158

2782

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

2159

2783

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

2160

2784

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

2161

2785

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

2162

2786

datetime.timedelta(seconds=1),

2163

frozenset((token_end,)))

2787

frozenset((token_end, )))

2164

2788

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

2165

2789

datetime.timedelta(minutes=1),

2166

2790

frozenset((token_second, token_end)))

2182

2806

frozenset((token_month, token_end)))

2183

2807

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

2184

2808

datetime.timedelta(weeks=1),

2185

frozenset((token_end,)))

2809

frozenset((token_end, )))

2186

2810

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

2187

2811

frozenset((token_year, token_month,

2188

2812

token_day, token_time,

2189

token_week))),

2190

# Define starting values

2191

value = datetime.timedelta() # Value so far

2813

token_week)))

2814

# Define starting values:

2815

# Value so far

2816

value = datetime.timedelta()

2192

2817

found_token = None

2193

followers = frozenset(token_duration,) # Following valid tokens

2194

s = duration # String left to parse

2818

# Following valid tokens

2819

followers = frozenset((token_duration, ))

2820

# String left to parse

2821

s = duration

2195

2822

# Loop until end token is found

2196

2823

while found_token is not token_end:

2197

2824

# Search for any currently valid tokens

2213

2840

break

2214

2841

else:

2215

2842

# No currently valid tokens were found

2216

raise ValueError("Invalid RFC 3339 duration")

2843

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

2844

.format(duration))

2217

2845

# End token found

2218

2846

return value

2219

2847

2220

2848

2221

2849

def string_to_delta(interval):

2222

2850

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

2223

2851

2224

2852

>>> string_to_delta('7d')

2225

2853

datetime.timedelta(7)

2226

2854

>>> string_to_delta('60s')

2234

2862

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

2235

2863

datetime.timedelta(0, 330)

2236

2864

"""

2237

2865

2238

2866

try:

2239

2867

return rfc3339_duration_to_delta(interval)

2240

2868

except ValueError:

2241

2869

pass

2242

2870

2243

2871

timevalue = datetime.timedelta(0)

2244

2872

for s in interval.split():

2245

2873

try:

2246

suffix = unicode(s[-1])

2874

suffix = s[-1]

2247

2875

value = int(s[:-1])

2248

2876

if suffix == "d":

2249

2877

delta = datetime.timedelta(value)

2256

2884

elif suffix == "w":

2257

2885

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

2258

2886

else:

2259

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

2260

.format(suffix))

2261

except (ValueError, IndexError) as e:

2887

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

2888

except IndexError as e:

2262

2889

raise ValueError(*(e.args))

2263

2890

timevalue += delta

2264

2891

return timevalue

2265

2892

2266

2893

2267

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

2894

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

2268

2895

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

2269

2896

2270

2897

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

2271

2898

if os.fork():

2272

2899

sys.exit()

2280

2907

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

2281

2908

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

2282

2909

raise OSError(errno.ENODEV,

2283

"{0} not a character device"

2910

"{} not a character device"

2284

2911

.format(os.devnull))

2285

2912

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

2286

2913

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

2290

2917

2291

2918

2292

2919

def main():

2293

2920

2294

2921

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

2295

2922

# Parsing of options, both command line and config file

2296

2923

2297

2924

parser = argparse.ArgumentParser()

2298

2925

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

2299

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

2926

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

2300

2927

help="show version number and exit")

2301

2928

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

2302

2929

help="Bind to interface IF")

2335

2962

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

2336

2963

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

2337

2964

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

2338

2965

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

2966

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

2967

default=None)

2968

2339

2969

options = parser.parse_args()

2340

2970

2341

2971

if options.check:

2342

2972

import doctest

2343

doctest.testmod()

2344

sys.exit()

2345

2973

fail_count, test_count = doctest.testmod()

2974

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

2975

2346

2976

# Default values for config file for server-global settings

2347

server_defaults = { "interface": "",

2348

"address": "",

2349

"port": "",

2350

"debug": "False",

2351

"priority":

2352

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

2353

"servicename": "Mandos",

2354

"use_dbus": "True",

2355

"use_ipv6": "True",

2356

"debuglevel": "",

2357

"restore": "True",

2358

"socket": "",

2359

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

2360

"foreground": "False",

2361

}

2362

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

2363

3000

# Parse config file for server-global settings

2364

3001

server_config = configparser.SafeConfigParser(server_defaults)

2365

3002

del server_defaults

2366

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

2367

"mandos.conf"))

3003

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

2368

3004

# Convert the SafeConfigParser object to a dict

2369

3005

server_settings = server_config.defaults()

2370

3006

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

2371

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

3007

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

3008

"foreground", "zeroconf"):

2372

3009

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

2373

3010

option)

2374

3011

if server_settings["port"]:

2384

3021

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

2385

3022

["socket"])

2386

3023

del server_config

2387

3024

2388

3025

# Override the settings from the config file with command line

2389

3026

# options, if set.

2390

3027

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

2391

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

2392

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

2393

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

3028

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

3029

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

3030

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

2394

3031

value = getattr(options, option)

2395

3032

if value is not None:

2396

3033

server_settings[option] = value

2397

3034

del options

2398

3035

# Force all strings to be unicode

2399

3036

for option in server_settings.keys():

2400

if type(server_settings[option]) is str:

2401

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

2402

3040

# Force all boolean options to be boolean

2403

3041

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

2404

"foreground"):

3042

"foreground", "zeroconf"):

2405

3043

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

2406

3044

# Debug implies foreground

2407

3045

if server_settings["debug"]:

2408

3046

server_settings["foreground"] = True

2409

3047

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

2410

3048

2411

3049

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

2412

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

2413

3056

# For convenience

2414

3057

debug = server_settings["debug"]

2415

3058

debuglevel = server_settings["debuglevel"]

2418

3061

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

2419

3062

stored_state_file)

2420

3063

foreground = server_settings["foreground"]

2421

3064

zeroconf = server_settings["zeroconf"]

3065

2422

3066

if debug:

2423

3067

initlogger(debug, logging.DEBUG)

2424

3068

else:

2427

3071

else:

2428

3072

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

2429

3073

initlogger(debug, level)

2430

3074

2431

3075

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

2432

syslogger.setFormatter(logging.Formatter

2433

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

2434

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

2435

.format(server_settings

2436

["servicename"])))

2437

3076

syslogger.setFormatter(

3077

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

3078

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

3079

server_settings["servicename"])))

3080

2438

3081

# Parse config file with clients

2439

3082

client_config = configparser.SafeConfigParser(Client

2440

3083

.client_defaults)

2441

3084

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

2442

3085

"clients.conf"))

2443

3086

2444

3087

global mandos_dbus_service

2445

3088

mandos_dbus_service = None

2446

2447

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

2448

server_settings["port"]),

2449

ClientHandler,

2450

interface=(server_settings["interface"]

2451

or None),

2452

use_ipv6=use_ipv6,

2453

gnutls_priority=

2454

server_settings["priority"],

2455

use_dbus=use_dbus,

2456

socketfd=(server_settings["socket"]

2457

or None))

3089

3090

socketfd = None

3091

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

3092

socketfd = server_settings["socket"]

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)

2458

3101

if not foreground:

2459

3102

pidfilename = "/run/mandos.pid"

3103

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

3104

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

2460

3105

pidfile = None

2461

3106

try:

2462

pidfile = open(pidfilename, "w")

3107

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

2463

3108

except IOError as e:

2464

3109

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

2465

3110

exc_info=e)

2466

2467

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

3111

3112

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

3113

("mandos", "mandos"),

3114

("nobody", "nogroup")):

2468

3115

try:

2469

3116

uid = pwd.getpwnam(name).pw_uid

2470

gid = pwd.getpwnam(name).pw_gid

3117

gid = pwd.getpwnam(group).pw_gid

2471

3118

break

2472

3119

except KeyError:

2473

3120

continue

2477

3124

try:

2478

3125

os.setgid(gid)

2479

3126

os.setuid(uid)

3127

if debug:

3128

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

3129

gid))

2480

3130

except OSError as error:

3131

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

3132

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

2481

3133

if error.errno != errno.EPERM:

2482

raise error

2483

3134

raise

3135

2484

3136

if debug:

2485

3137

# Enable all possible GnuTLS debugging

2486

3138

2487

3139

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

2488

3140

# - GnuTLS manual

2489

gnutls.library.functions.gnutls_global_set_log_level(11)

2490

2491

@gnutls.library.types.gnutls_log_func

3141

gnutls.global_set_log_level(11)

3142

3143

@gnutls.log_func

2492

3144

def debug_gnutls(level, string):

2493

3145

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

2494

2495

(gnutls.library.functions

2496

.gnutls_global_set_log_function(debug_gnutls))

2497

3146

3147

gnutls.global_set_log_function(debug_gnutls)

3148

2498

3149

# Redirect stdin so all checkers get /dev/null

2499

3150

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

2500

3151

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

2501

3152

if null > 2:

2502

3153

os.close(null)

2503

3154

2504

3155

# Need to fork before connecting to D-Bus

2505

3156

if not foreground:

2506

3157

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

2507

3158

daemon()

2508

2509

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

2510

# need to inform gobject that threads will be used.

2511

gobject.threads_init()

2512

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

2513

3164

global main_loop

2514

3165

# From the Avahi example code

2515

3166

DBusGMainLoop(set_as_default=True)

2516

main_loop = gobject.MainLoop()

3167

main_loop = GLib.MainLoop()

2517

3168

bus = dbus.SystemBus()

2518

3169

# End of Avahi example code

2519

3170

if use_dbus:

2520

3171

try:

2521

3172

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

2522

bus, do_not_queue=True)

2523

old_bus_name = (dbus.service.BusName

2524

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

2525

do_not_queue=True))

2526

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:

2527

3179

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

2528

3180

use_dbus = False

2529

3181

server_settings["use_dbus"] = False

2530

3182

tcp_server.use_dbus = False

2531

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2532

service = AvahiServiceToSyslog(name =

2533

server_settings["servicename"],

2534

servicetype = "_mandos._tcp",

2535

protocol = protocol, bus = bus)

2536

if server_settings["interface"]:

2537

service.interface = (if_nametoindex

2538

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

2539

3183

if zeroconf:

3184

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3185

service = AvahiServiceToSyslog(

3186

name=server_settings["servicename"],

3187

servicetype="_mandos._tcp",

3188

protocol=protocol,

3189

bus=bus)

3190

if server_settings["interface"]:

3191

service.interface = if_nametoindex(

3192

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

3193

2540

3194

global multiprocessing_manager

2541

3195

multiprocessing_manager = multiprocessing.Manager()

2542

3196

2543

3197

client_class = Client

2544

3198

if use_dbus:

2545

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

2546

3199

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

3200

2547

3201

client_settings = Client.config_parser(client_config)

2548

3202

old_client_settings = {}

2549

3203

clients_data = {}

2550

3204

2551

3205

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

2552

3206

global wnull

2553

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

3207

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

2554

3208

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

2555

3209

# mode

2556

3210

if debug or not foreground:

2557

3211

wnull.close()

2558

3212

2559

3213

# Get client data and settings from last running state.

2560

3214

if server_settings["restore"]:

2561

3215

try:

2562

3216

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

2563

clients_data, old_client_settings = (pickle.load

2564

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

2565

3266

os.remove(stored_state_path)

2566

3267

except IOError as e:

2567

3268

if e.errno == errno.ENOENT:

2568

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

2569

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

3269

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

3270

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

2570

3271

else:

2571

3272

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

2572

3273

exc_info=e)

2573

3274

raise

2574

3275

except EOFError as e:

2575

3276

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

2576

"EOFError:", exc_info=e)

2577

3277

"EOFError:",

3278

exc_info=e)

3279

2578

3280

with PGPEngine() as pgp:

2579

for client_name, client in clients_data.iteritems():

3281

for client_name, client in clients_data.items():

2580

3282

# Skip removed clients

2581

3283

if client_name not in client_settings:

2582

3284

continue

2583

3285

2584

3286

# Decide which value to use after restoring saved state.

2585

3287

# We have three different values: Old config file,

2586

3288

# new config file, and saved state.

2591

3293

# For each value in new config, check if it

2592

3294

# differs from the old config value (Except for

2593

3295

# the "secret" attribute)

2594

if (name != "secret" and

2595

value != old_client_settings[client_name]

2596

[name]):

3296

if (name != "secret"

3297

and (value !=

3298

old_client_settings[client_name][name])):

2597

3299

client[name] = value

2598

3300

except KeyError:

2599

3301

pass

2600

3302

2601

3303

# Clients who has passed its expire date can still be

2602

# enabled if its last checker was successful. Clients

3304

# enabled if its last checker was successful. A Client

2603

3305

# whose checker succeeded before we stored its state is

2604

3306

# assumed to have successfully run all checkers during

2605

3307

# downtime.

2607

3309

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

2608

3310

if not client["last_checked_ok"]:

2609

3311

logger.warning(

2610

"disabling client {0} - Client never "

2611

"performed a successful checker"

2612

.format(client_name))

3312

"disabling client {} - Client never "

3313

"performed a successful checker".format(

3314

client_name))

2613

3315

client["enabled"] = False

2614

3316

elif client["last_checker_status"] != 0:

2615

3317

logger.warning(

2616

"disabling client {0} - Client "

2617

"last checker failed with error code {1}"

2618

.format(client_name,

2619

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

2620

3323

client["enabled"] = False

2621

3324

else:

2622

client["expires"] = (datetime.datetime

2623

.utcnow()

2624

+ client["timeout"])

3325

client["expires"] = (

3326

datetime.datetime.utcnow()

3327

+ client["timeout"])

2625

3328

logger.debug("Last checker succeeded,"

2626

" keeping {0} enabled"

2627

.format(client_name))

3329

" keeping {} enabled".format(

3330

client_name))

2628

3331

try:

2629

client["secret"] = (

2630

pgp.decrypt(client["encrypted_secret"],

2631

client_settings[client_name]

2632

["secret"]))

3332

client["secret"] = pgp.decrypt(

3333

client["encrypted_secret"],

3334

client_settings[client_name]["secret"])

2633

3335

except PGPError:

2634

3336

# If decryption fails, we use secret from new settings

2635

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

2636

.format(client_name))

2637

client["secret"] = (

2638

client_settings[client_name]["secret"])

2639

3337

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

3338

client_name))

3339

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

3340

["secret"])

3341

2640

3342

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

2641

3343

for client_name in (set(old_client_settings)

2642

3344

- set(client_settings)):

2644

3346

for client_name in (set(client_settings)

2645

3347

- set(old_client_settings)):

2646

3348

clients_data[client_name] = client_settings[client_name]

2647

3349

2648

3350

# Create all client objects

2649

for client_name, client in clients_data.iteritems():

3351

for client_name, client in clients_data.items():

2650

3352

tcp_server.clients[client_name] = client_class(

2651

name = client_name, settings = client,

2652

server_settings = server_settings)

2653

3353

name=client_name,

3354

settings=client,

3355

server_settings=server_settings)

3356

2654

3357

if not tcp_server.clients:

2655

3358

logger.warning("No clients defined")

2656

3359

2657

3360

if not foreground:

2658

3361

if pidfile is not None:

3362

pid = os.getpid()

2659

3363

try:

2660

3364

with pidfile:

2661

pid = os.getpid()

2662

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

3365

print(pid, file=pidfile)

2663

3366

except IOError:

2664

3367

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

2665

3368

pidfilename, pid)

2666

3369

del pidfile

2667

3370

del pidfilename

2668

2669

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

2670

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

2671

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

2672

3376

if use_dbus:

2673

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

2674

"se.bsnet.fukt.Mandos"})

2675

class MandosDBusService(DBusObjectWithProperties):

3377

3378

@alternate_dbus_interfaces(

3379

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

3380

class MandosDBusService(DBusObjectWithObjectManager):

2676

3381

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

3382

2677

3383

def __init__(self):

2678

3384

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

3385

2679

3386

_interface = "se.recompile.Mandos"

2680

2681

@dbus_interface_annotations(_interface)

2682

def _foo(self):

2683

return { "org.freedesktop.DBus.Property"

2684

".EmitsChangedSignal":

2685

"false"}

2686

3387

2687

3388

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

2688

3389

def ClientAdded(self, objpath):

2689

3390

"D-Bus signal"

2690

3391

pass

2691

3392

2692

3393

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

2693

def ClientNotFound(self, fingerprint, address):

3394

def ClientNotFound(self, key_id, address):

2694

3395

"D-Bus signal"

2695

3396

pass

2696

3397

3398

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

3399

"true"})

2697

3400

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

2698

3401

def ClientRemoved(self, objpath, name):

2699

3402

"D-Bus signal"

2700

3403

pass

2701

3404

3405

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

3406

"true"})

2702

3407

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

2703

3408

def GetAllClients(self):

2704

3409

"D-Bus method"

2705

return dbus.Array(c.dbus_object_path

2706

for c in

2707

tcp_server.clients.itervalues())

2708

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

2709

3415

@dbus.service.method(_interface,

2710

3416

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

2711

3417

def GetAllClientsWithProperties(self):

2712

3418

"D-Bus method"

2713

3419

return dbus.Dictionary(

2714

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

2715

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

2716

3423

signature="oa{sv}")

2717

3424

2718

3425

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

2719

3426

def RemoveClient(self, object_path):

2720

3427

"D-Bus method"

2721

for c in tcp_server.clients.itervalues():

3428

for c in tcp_server.clients.values():

2722

3429

if c.dbus_object_path == object_path:

2723

3430

del tcp_server.clients[c.name]

2724

3431

c.remove_from_connection()

2725

# Don't signal anything except ClientRemoved

3432

# Don't signal the disabling

2726

3433

c.disable(quiet=True)

2727

# Emit D-Bus signal

2728

self.ClientRemoved(object_path, c.name)

3434

# Emit D-Bus signal for removal

3435

self.client_removed_signal(c)

2729

3436

return

2730

3437

raise KeyError(object_path)

2731

3438

2732

3439

del _interface

2733

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

2734

3477

mandos_dbus_service = MandosDBusService()

2735

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

2736

3484

def cleanup():

2737

3485

"Cleanup function; run on exit"

2738

service.cleanup()

2739

2740

multiprocessing.active_children()

2741

wnull.close()

3486

if zeroconf:

3487

service.cleanup()

3488

3489

mp.active_children()

3490

wn.close()

2742

3491

if not (tcp_server.clients or client_settings):

2743

3492

return

2744

3493

2745

3494

# Store client before exiting. Secrets are encrypted with key

2746

3495

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

2747

3496

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

2748

3497

clients = {}

2749

3498

with PGPEngine() as pgp:

2750

for client in tcp_server.clients.itervalues():

3499

for client in tcp_server.clients.values():

2751

3500

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

2752

3501

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

2753

3502

key)

2754

3503

client_dict = {}

2755

3504

2756

3505

# A list of attributes that can not be pickled

2757

3506

# + secret.

2758

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

2759

"checker", "server_settings"))

2760

for name, typ in (inspect.getmembers

2761

(dbus.service.Object)):

3507

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

3508

"checker", "server_settings"}

3509

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

3510

.Object):

2762

3511

exclude.add(name)

2763

3512

2764

3513

client_dict["encrypted_secret"] = (client

2765

3514

.encrypted_secret)

2766

3515

for attr in client.client_structure:

2767

3516

if attr not in exclude:

2768

3517

client_dict[attr] = getattr(client, attr)

2769

3518

2770

3519

clients[client.name] = client_dict

2771

3520

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

2772

3521

2773

3522

try:

2774

with (tempfile.NamedTemporaryFile

2775

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

2776

dir=os.path.dirname(stored_state_path),

2777

delete=False)) as stored_state:

2778

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

2779

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

2780

3532

os.rename(tempname, stored_state_path)

2781

3533

except (IOError, OSError) as e:

2782

3534

if not debug:

2785

3537

except NameError:

2786

3538

pass

2787

3539

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

2788

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

3540

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

2789

3541

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

2790

3542

else:

2791

3543

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

2792

3544

exc_info=e)

2793

raise e

2794

3545

raise

3546

2795

3547

# Delete all clients, and settings from config

2796

3548

while tcp_server.clients:

2797

3549

name, client = tcp_server.clients.popitem()

2798

3550

if use_dbus:

2799

3551

client.remove_from_connection()

2800

# Don't signal anything except ClientRemoved

3552

# Don't signal the disabling

2801

3553

client.disable(quiet=True)

3554

# Emit D-Bus signal for removal

2802

3555

if use_dbus:

2803

# Emit D-Bus signal

2804

mandos_dbus_service.ClientRemoved(client

2805

.dbus_object_path,

2806

client.name)

3556

mandos_dbus_service.client_removed_signal(client)

2807

3557

client_settings.clear()

2808

3558

2809

3559

atexit.register(cleanup)

2810

2811

for client in tcp_server.clients.itervalues():

3560

3561

for client in tcp_server.clients.values():

2812

3562

if use_dbus:

2813

# Emit D-Bus signal

2814

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3563

# Emit D-Bus signal for adding

3564

mandos_dbus_service.client_added_signal(client)

2815

3565

# Need to initiate checking of clients

2816

3566

if client.enabled:

2817

3567

client.init_checker()

2818

3568

2819

3569

tcp_server.enable()

2820

3570

tcp_server.server_activate()

2821

3571

2822

3572

# Find out what port we got

2823

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

3573

if zeroconf:

3574

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

2824

3575

if use_ipv6:

2825

3576

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

2826

3577

" flowinfo %d, scope_id %d",

2828

3579

else: # IPv4

2829

3580

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

2830

3581

*tcp_server.socket.getsockname())

2831

2832

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

2833

3582

3583

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

3584

2834

3585

try:

2835

# From the Avahi example code

2836

try:

2837

service.activate()

2838

except dbus.exceptions.DBusException as error:

2839

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

2840

cleanup()

2841

sys.exit(1)

2842

# End of Avahi example code

2843

2844

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

2845

lambda *args, **kwargs:

2846

(tcp_server.handle_request

2847

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

2848

3586

if zeroconf:

3587

# From the Avahi example code

3588

try:

3589

service.activate()

3590

except dbus.exceptions.DBusException as error:

3591

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

3592

cleanup()

3593

sys.exit(1)

3594

# End of Avahi example code

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

2849

3601

logger.debug("Starting main loop")

2850

3602

main_loop.run()

2851

3603

except AvahiError as error:

2860

3612

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

2861

3613

cleanup()

2862

3614

3615

2863

3616

if __name__ == '__main__':

2864

3617

main()