/mandos/trunk : revision 975

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

72

80

73

81

import dbus

74

82

import dbus.service

75

import gobject

76

import avahi

83

from gi.repository import GLib

77

84

from dbus.mainloop.glib import DBusGMainLoop

78

85

import ctypes

79

86

import ctypes.util

80

87

import xml.dom.minidom

81

88

import inspect

82

89

90

# Try to find the value of SO_BINDTODEVICE:

83

91

try:

92

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

93

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

84

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

95

except AttributeError:

86

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

87

99

from IN import SO_BINDTODEVICE

88

100

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.2"

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.8.2"

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

It is instantiated once, and simulates having an Avahi module."""

281

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

282

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

283

PROTO_INET = 0 # avahi-common/address.h

284

PROTO_INET6 = 1 # avahi-common/address.h

285

DBUS_NAME = "org.freedesktop.Avahi"

286

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

287

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

288

DBUS_PATH_SERVER = "/"

289

290

def string_array_to_txt_array(self, 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

avahi = Avahi()

302

303

221

304

class AvahiError(Exception):

222

305

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

223

306

self.value = value

224

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

225

def __unicode__(self):

226

return unicode(repr(self.value))

307

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

308

**kwargs)

309

227

310

228

311

class AvahiServiceError(AvahiError):

229

312

pass

230

313

314

231

315

class AvahiGroupError(AvahiError):

232

316

pass

233

317

234

318

235

319

class AvahiService(object):

236

320

"""An Avahi (Zeroconf) service.

237

321

238

322

Attributes:

239

323

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

240

324

Used to optionally bind to the specified interface.

252

336

server: D-Bus Server

253

337

bus: dbus.SystemBus()

254

338

"""

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

339

340

def __init__(self,

341

interface=avahi.IF_UNSPEC,

342

name=None,

343

servicetype=None,

344

port=None,

345

TXT=None,

346

domain="",

347

host="",

348

max_renames=32768,

349

protocol=avahi.PROTO_UNSPEC,

350

bus=None):

260

351

self.interface = interface

261

352

self.name = name

262

353

self.type = servicetype

271

362

self.server = None

272

363

self.bus = bus

273

364

self.entry_group_state_changed_match = None

274

275

def rename(self):

365

366

def rename(self, remove=True):

276

367

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

277

368

if self.rename_count >= self.max_renames:

278

369

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

279

370

" after %i retries, exiting.",

280

371

self.rename_count)

281

372

raise AvahiServiceError("Too many renames")

282

self.name = unicode(self.server

283

.GetAlternativeServiceName(self.name))

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

284

376

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

285

377

self.name)

286

self.remove()

378

if remove:

379

self.remove()

287

380

try:

288

381

self.add()

289

382

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

383

if (error.get_dbus_name()

384

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

385

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

386

return self.rename(remove=False)

387

else:

388

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

389

self.cleanup()

390

os._exit(1)

391

295

392

def remove(self):

296

393

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

297

394

if self.entry_group_state_changed_match is not None:

299

396

self.entry_group_state_changed_match = None

300

397

if self.group is not None:

301

398

self.group.Reset()

302

399

303

400

def add(self):

304

401

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

305

402

self.remove()

322

419

dbus.UInt16(self.port),

323

420

avahi.string_array_to_txt_array(self.TXT))

324

421

self.group.Commit()

325

422

326

423

def entry_group_state_changed(self, state, error):

327

424

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

328

425

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

329

426

330

427

if state == avahi.ENTRY_GROUP_ESTABLISHED:

331

428

logger.debug("Zeroconf service established.")

332

429

elif state == avahi.ENTRY_GROUP_COLLISION:

334

431

self.rename()

335

432

elif state == avahi.ENTRY_GROUP_FAILURE:

336

433

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

337

unicode(error))

338

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

339

.format(error))

340

434

str(error))

435

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

436

341

437

def cleanup(self):

342

438

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

343

439

if self.group is not None:

348

444

pass

349

445

self.group = None

350

446

self.remove()

351

447

352

448

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

353

449

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

354

450

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

451

bad_states = {

452

avahi.SERVER_INVALID: "Zeroconf server invalid",

453

avahi.SERVER_REGISTERING: None,

454

avahi.SERVER_COLLISION: "Zeroconf server name collision",

455

avahi.SERVER_FAILURE: "Zeroconf server failure",

456

}

362

457

if state in bad_states:

363

458

if bad_states[state] is not None:

364

459

if error is None:

367

462

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

368

463

self.cleanup()

369

464

elif state == avahi.SERVER_RUNNING:

370

self.add()

465

try:

466

self.add()

467

except dbus.exceptions.DBusException as error:

468

if (error.get_dbus_name()

469

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

470

logger.info("Local Zeroconf service name"

471

" collision.")

472

return self.rename(remove=False)

473

else:

474

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

475

self.cleanup()

476

os._exit(1)

371

477

else:

372

478

if error is None:

373

479

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

374

480

else:

375

481

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

376

482

377

483

def activate(self):

378

484

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

379

485

if self.server is None:

383

489

follow_name_owner_changes=True),

384

490

avahi.DBUS_INTERFACE_SERVER)

385

491

self.server.connect_to_signal("StateChanged",

386

self.server_state_changed)

492

self.server_state_changed)

387

493

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

388

494

389

495

390

496

class AvahiServiceToSyslog(AvahiService):

391

def rename(self):

497

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

392

498

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

499

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

500

syslogger.setFormatter(logging.Formatter(

501

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

502

.format(self.name)))

398

503

return ret

399

504

400

505

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

506

# Pretend that we have a GnuTLS module

507

class GnuTLS(object):

508

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

509

It is instantiated once, and simulates having a GnuTLS module."""

510

511

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

512

if library is None:

513

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

514

_library = ctypes.cdll.LoadLibrary(library)

515

del library

516

_need_version = b"3.3.0"

517

_tls_rawpk_version = b"3.6.6"

518

519

def __init__(self):

520

# Need to use "self" here, since this method is called before

521

# the assignment to the "gnutls" global variable happens.

522

if self.check_version(self._need_version) is None:

523

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

524

.format(self._need_version))

525

526

# Unless otherwise indicated, the constants and types below are

527

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

528

529

# Constants

530

E_SUCCESS = 0

531

E_INTERRUPTED = -52

532

E_AGAIN = -28

533

CRT_OPENPGP = 2

534

CRT_RAWPK = 3

535

CLIENT = 2

536

SHUT_RDWR = 0

537

CRD_CERTIFICATE = 1

538

E_NO_CERTIFICATE_FOUND = -49

539

X509_FMT_DER = 0

540

NO_TICKETS = 1<<10

541

ENABLE_RAWPK = 1<<18

542

CTYPE_PEERS = 3

543

KEYID_USE_SHA256 = 1 # gnutls/x509.h

544

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

545

546

# Types

547

class session_int(ctypes.Structure):

548

_fields_ = []

549

session_t = ctypes.POINTER(session_int)

550

551

class certificate_credentials_st(ctypes.Structure):

552

_fields_ = []

553

certificate_credentials_t = ctypes.POINTER(

554

certificate_credentials_st)

555

certificate_type_t = ctypes.c_int

556

557

class datum_t(ctypes.Structure):

558

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

559

('size', ctypes.c_uint)]

560

561

class openpgp_crt_int(ctypes.Structure):

562

_fields_ = []

563

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

564

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

565

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

566

credentials_type_t = ctypes.c_int

567

transport_ptr_t = ctypes.c_void_p

568

close_request_t = ctypes.c_int

569

570

# Exceptions

571

class Error(Exception):

572

# We need to use the class name "GnuTLS" here, since this

573

# exception might be raised from within GnuTLS.__init__,

574

# which is called before the assignment to the "gnutls"

575

# global variable has happened.

576

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

577

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

578

# code is passed, convert it to a string with

579

# gnutls.strerror()

580

self.code = code

581

if message is None and code is not None:

582

message = GnuTLS.strerror(code)

583

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

584

message, *args)

585

586

class CertificateSecurityError(Error):

587

pass

588

589

# Classes

590

class Credentials(object):

591

def __init__(self):

592

self._c_object = gnutls.certificate_credentials_t()

593

gnutls.certificate_allocate_credentials(

594

ctypes.byref(self._c_object))

595

self.type = gnutls.CRD_CERTIFICATE

596

597

def __del__(self):

598

gnutls.certificate_free_credentials(self._c_object)

599

600

class ClientSession(object):

601

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

602

self._c_object = gnutls.session_t()

603

gnutls_flags = gnutls.CLIENT

604

if gnutls.check_version("3.5.6"):

605

gnutls_flags |= gnutls.NO_TICKETS

606

if gnutls.has_rawpk:

607

gnutls_flags |= gnutls.ENABLE_RAWPK

608

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

609

del gnutls_flags

610

gnutls.set_default_priority(self._c_object)

611

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

612

gnutls.handshake_set_private_extensions(self._c_object,

613

True)

614

self.socket = socket

615

if credentials is None:

616

credentials = gnutls.Credentials()

617

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

618

ctypes.cast(credentials._c_object,

619

ctypes.c_void_p))

620

self.credentials = credentials

621

622

def __del__(self):

623

gnutls.deinit(self._c_object)

624

625

def handshake(self):

626

return gnutls.handshake(self._c_object)

627

628

def send(self, data):

629

data = bytes(data)

630

data_len = len(data)

631

while data_len > 0:

632

data_len -= gnutls.record_send(self._c_object,

633

data[-data_len:],

634

data_len)

635

636

def bye(self):

637

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

638

639

# Error handling functions

640

def _error_code(result):

641

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

642

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

643

if result >= 0:

644

return result

645

if result == gnutls.E_NO_CERTIFICATE_FOUND:

646

raise gnutls.CertificateSecurityError(code=result)

647

raise gnutls.Error(code=result)

648

649

def _retry_on_error(result, func, arguments):

650

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

651

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

652

while result < 0:

653

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

654

return _error_code(result)

655

result = func(*arguments)

656

return result

657

658

# Unless otherwise indicated, the function declarations below are

659

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

660

661

# Functions

662

priority_set_direct = _library.gnutls_priority_set_direct

663

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

664

ctypes.POINTER(ctypes.c_char_p)]

665

priority_set_direct.restype = _error_code

666

667

init = _library.gnutls_init

668

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

669

init.restype = _error_code

670

671

set_default_priority = _library.gnutls_set_default_priority

672

set_default_priority.argtypes = [session_t]

673

set_default_priority.restype = _error_code

674

675

record_send = _library.gnutls_record_send

676

record_send.argtypes = [session_t, ctypes.c_void_p,

677

ctypes.c_size_t]

678

record_send.restype = ctypes.c_ssize_t

679

record_send.errcheck = _retry_on_error

680

681

certificate_allocate_credentials = (

682

_library.gnutls_certificate_allocate_credentials)

683

certificate_allocate_credentials.argtypes = [

684

ctypes.POINTER(certificate_credentials_t)]

685

certificate_allocate_credentials.restype = _error_code

686

687

certificate_free_credentials = (

688

_library.gnutls_certificate_free_credentials)

689

certificate_free_credentials.argtypes = [

690

certificate_credentials_t]

691

certificate_free_credentials.restype = None

692

693

handshake_set_private_extensions = (

694

_library.gnutls_handshake_set_private_extensions)

695

handshake_set_private_extensions.argtypes = [session_t,

696

ctypes.c_int]

697

handshake_set_private_extensions.restype = None

698

699

credentials_set = _library.gnutls_credentials_set

700

credentials_set.argtypes = [session_t, credentials_type_t,

701

ctypes.c_void_p]

702

credentials_set.restype = _error_code

703

704

strerror = _library.gnutls_strerror

705

strerror.argtypes = [ctypes.c_int]

706

strerror.restype = ctypes.c_char_p

707

708

certificate_type_get = _library.gnutls_certificate_type_get

709

certificate_type_get.argtypes = [session_t]

710

certificate_type_get.restype = _error_code

711

712

certificate_get_peers = _library.gnutls_certificate_get_peers

713

certificate_get_peers.argtypes = [session_t,

714

ctypes.POINTER(ctypes.c_uint)]

715

certificate_get_peers.restype = ctypes.POINTER(datum_t)

716

717

global_set_log_level = _library.gnutls_global_set_log_level

718

global_set_log_level.argtypes = [ctypes.c_int]

719

global_set_log_level.restype = None

720

721

global_set_log_function = _library.gnutls_global_set_log_function

722

global_set_log_function.argtypes = [log_func]

723

global_set_log_function.restype = None

724

725

deinit = _library.gnutls_deinit

726

deinit.argtypes = [session_t]

727

deinit.restype = None

728

729

handshake = _library.gnutls_handshake

730

handshake.argtypes = [session_t]

731

handshake.restype = _error_code

732

handshake.errcheck = _retry_on_error

733

734

transport_set_ptr = _library.gnutls_transport_set_ptr

735

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

736

transport_set_ptr.restype = None

737

738

bye = _library.gnutls_bye

739

bye.argtypes = [session_t, close_request_t]

740

bye.restype = _error_code

741

bye.errcheck = _retry_on_error

742

743

check_version = _library.gnutls_check_version

744

check_version.argtypes = [ctypes.c_char_p]

745

check_version.restype = ctypes.c_char_p

746

747

has_rawpk = bool(check_version(_tls_rawpk_version))

748

749

if has_rawpk:

750

# Types

751

class pubkey_st(ctypes.Structure):

752

_fields = []

753

pubkey_t = ctypes.POINTER(pubkey_st)

754

755

x509_crt_fmt_t = ctypes.c_int

756

757

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

758

pubkey_init = _library.gnutls_pubkey_init

759

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

760

pubkey_init.restype = _error_code

761

762

pubkey_import = _library.gnutls_pubkey_import

763

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

764

x509_crt_fmt_t]

765

pubkey_import.restype = _error_code

766

767

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

768

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

769

ctypes.POINTER(ctypes.c_ubyte),

770

ctypes.POINTER(ctypes.c_size_t)]

771

pubkey_get_key_id.restype = _error_code

772

773

pubkey_deinit = _library.gnutls_pubkey_deinit

774

pubkey_deinit.argtypes = [pubkey_t]

775

pubkey_deinit.restype = None

776

else:

777

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

778

779

openpgp_crt_init = _library.gnutls_openpgp_crt_init

780

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

781

openpgp_crt_init.restype = _error_code

782

783

openpgp_crt_import = _library.gnutls_openpgp_crt_import

784

openpgp_crt_import.argtypes = [openpgp_crt_t,

785

ctypes.POINTER(datum_t),

786

openpgp_crt_fmt_t]

787

openpgp_crt_import.restype = _error_code

788

789

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

790

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

791

ctypes.POINTER(ctypes.c_uint)]

792

openpgp_crt_verify_self.restype = _error_code

793

794

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

795

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

796

openpgp_crt_deinit.restype = None

797

798

openpgp_crt_get_fingerprint = (

799

_library.gnutls_openpgp_crt_get_fingerprint)

800

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

801

ctypes.c_void_p,

802

ctypes.POINTER(

803

ctypes.c_size_t)]

804

openpgp_crt_get_fingerprint.restype = _error_code

805

806

if check_version("3.6.4"):

807

certificate_type_get2 = _library.gnutls_certificate_type_get2

808

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

809

certificate_type_get2.restype = _error_code

810

811

# Remove non-public functions

812

del _error_code, _retry_on_error

813

# Create the global "gnutls" object, simulating a module

814

gnutls = GnuTLS()

815

816

817

def call_pipe(connection, # : multiprocessing.Connection

818

func, *args, **kwargs):

819

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

820

821

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

822

return value on the provided multiprocessing.Connection.

823

"""

824

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

825

connection.close()

406

826

407

827

408

828

class Client(object):

409

829

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

410

830

411

831

Attributes:

412

832

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

413

833

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

415

835

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

416

836

to see if the client lives.

417

837

'None' if no process is running.

418

checker_callback_tag: a gobject event source tag, or None

838

checker_callback_tag: a GLib event source tag, or None

419

839

checker_command: string; External command which is run to check

420

840

if client lives. %() expansions are done at

421

841

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

422

842

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

423

checker_initiator_tag: a gobject event source tag, or None

843

checker_initiator_tag: a GLib event source tag, or None

424

844

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

425

845

client_structure: Object describing what attributes a client has

426

846

and is used for storing the client at exit

427

847

current_checker_command: string; current running checker_command

428

disable_initiator_tag: a gobject event source tag, or None

848

disable_initiator_tag: a GLib event source tag, or None

429

849

enabled: bool()

430

850

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

431

uniquely identify the client

851

uniquely identify an OpenPGP client

852

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

853

a client using raw public keys

432

854

host: string; available for use by the checker command

433

855

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

434

856

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

436

858

last_checker_status: integer between 0 and 255 reflecting exit

437

859

status of last checker. -1 reflects crashed

438

860

checker, -2 means no checker completed yet.

861

last_checker_signal: The signal which killed the last checker, if

862

last_checker_status is -1

439

863

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

440

864

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

441

865

D-Bus identifiers

448

872

disabled, or None

449

873

server_settings: The server_settings dict from main()

450

874

"""

451

875

452

876

runtime_expansions = ("approval_delay", "approval_duration",

453

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

877

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

454

878

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

455

879

"last_approval_request", "last_checked_ok",

456

880

"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

881

client_defaults = {

882

"timeout": "PT5M",

883

"extended_timeout": "PT15M",

884

"interval": "PT2M",

885

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

886

"host": "",

887

"approval_delay": "PT0S",

888

"approval_duration": "PT1S",

889

"approved_by_default": "True",

890

"enabled": "True",

891

}

892

483

893

@staticmethod

484

894

def config_parser(config):

485

895

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

492

902

for client_name in config.sections():

493

903

section = dict(config.items(client_name))

494

904

client = settings[client_name] = {}

495

905

496

906

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

497

907

# Reformat values from string types to Python types

498

908

client["approved_by_default"] = config.getboolean(

499

909

client_name, "approved_by_default")

500

910

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

501

911

"enabled")

502

912

913

# Uppercase and remove spaces from key_id and fingerprint

914

# for later comparison purposes with return value from the

915

# key_id() and fingerprint() functions

916

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

917

.replace(" ", ""))

503

918

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

504

919

.replace(" ", ""))

505

920

if "secret" in section:

506

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

921

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

922

.encode("utf-8"),

923

"base64")

507

924

elif "secfile" in section:

508

925

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

509

926

(section["secfile"])),

510

927

"rb") as secfile:

511

928

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

512

929

else:

513

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

930

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

514

931

.format(section))

515

932

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

516

933

client["extended_timeout"] = string_to_delta(

524

941

client["last_approval_request"] = None

525

942

client["last_checked_ok"] = None

526

943

client["last_checker_status"] = -2

527

944

528

945

return settings

529

530

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

946

947

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

531

948

self.name = name

532

949

if server_settings is None:

533

950

server_settings = {}

534

951

self.server_settings = server_settings

535

952

# adding all client settings

536

for setting, value in settings.iteritems():

953

for setting, value in settings.items():

537

954

setattr(self, setting, value)

538

955

539

956

if self.enabled:

540

957

if not hasattr(self, "last_enabled"):

541

958

self.last_enabled = datetime.datetime.utcnow()

545

962

else:

546

963

self.last_enabled = None

547

964

self.expires = None

548

965

549

966

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

967

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

553

968

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

554

969

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

555

970

datetime.datetime.utcnow())

556

971

557

972

# attributes specific for this server instance

558

973

self.checker = None

559

974

self.checker_initiator_tag = None

562

977

self.current_checker_command = None

563

978

self.approved = None

564

979

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

980

self.changedstate = multiprocessing_manager.Condition(

981

multiprocessing_manager.Lock())

982

self.client_structure = [attr

983

for attr in self.__dict__.keys()

570

984

if not attr.startswith("_")]

571

985

self.client_structure.append("client_structure")

572

573

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

574

lambda obj:

575

isinstance(obj,

576

property)):

986

987

for name, t in inspect.getmembers(

988

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

577

989

if not name.startswith("_"):

578

990

self.client_structure.append(name)

579

991

580

992

# Send notice to process children that client state has changed

581

993

def send_changedstate(self):

582

994

with self.changedstate:

583

995

self.changedstate.notify_all()

584

996

585

997

def enable(self):

586

998

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

587

999

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

592

1004

self.last_enabled = datetime.datetime.utcnow()

593

1005

self.init_checker()

594

1006

self.send_changedstate()

595

1007

596

1008

def disable(self, quiet=True):

597

1009

"""Disable this client."""

598

1010

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

600

1012

if not quiet:

601

1013

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

602

1014

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

603

gobject.source_remove(self.disable_initiator_tag)

1015

GLib.source_remove(self.disable_initiator_tag)

604

1016

self.disable_initiator_tag = None

605

1017

self.expires = None

606

1018

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

607

gobject.source_remove(self.checker_initiator_tag)

1019

GLib.source_remove(self.checker_initiator_tag)

608

1020

self.checker_initiator_tag = None

609

1021

self.stop_checker()

610

1022

self.enabled = False

611

1023

if not quiet:

612

1024

self.send_changedstate()

613

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

1025

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

614

1026

return False

615

1027

616

1028

def __del__(self):

617

1029

self.disable()

618

1030

619

1031

def init_checker(self):

620

1032

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

621

1033

# and every interval from then on.

622

1034

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

1035

GLib.source_remove(self.checker_initiator_tag)

1036

self.checker_initiator_tag = GLib.timeout_add(

1037

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

1038

self.start_checker)

627

1039

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

628

1040

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

1041

GLib.source_remove(self.disable_initiator_tag)

1042

self.disable_initiator_tag = GLib.timeout_add(

1043

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

633

1044

# Also start a new checker *right now*.

634

1045

self.start_checker()

635

636

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

1046

1047

def checker_callback(self, source, condition, connection,

1048

command):

637

1049

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

638

1050

self.checker_callback_tag = None

639

1051

self.checker = None

640

if os.WIFEXITED(condition):

641

self.last_checker_status = os.WEXITSTATUS(condition)

1052

# Read return code from connection (see call_pipe)

1053

returncode = connection.recv()

1054

connection.close()

1055

1056

if returncode >= 0:

1057

self.last_checker_status = returncode

1058

self.last_checker_signal = None

642

1059

if self.last_checker_status == 0:

643

1060

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

644

1061

vars(self))

645

1062

self.checked_ok()

646

1063

else:

647

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

648

vars(self))

1064

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

649

1065

else:

650

1066

self.last_checker_status = -1

1067

self.last_checker_signal = -returncode

651

1068

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

652

1069

vars(self))

653

1070

return False

1071

654

1072

def checked_ok(self):

655

1073

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

656

1074

self.last_checked_ok = datetime.datetime.utcnow()

657

1075

self.last_checker_status = 0

1076

self.last_checker_signal = None

658

1077

self.bump_timeout()

659

1078

660

1079

def bump_timeout(self, timeout=None):

661

1080

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

662

1081

if timeout is None:

663

1082

timeout = self.timeout

664

1083

if self.disable_initiator_tag is not None:

665

gobject.source_remove(self.disable_initiator_tag)

1084

GLib.source_remove(self.disable_initiator_tag)

666

1085

self.disable_initiator_tag = None

667

1086

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

668

self.disable_initiator_tag = (gobject.timeout_add

669

(timedelta_to_milliseconds

670

(timeout), self.disable))

1087

self.disable_initiator_tag = GLib.timeout_add(

1088

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

671

1089

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

672

1090

673

1091

def need_approval(self):

674

1092

self.last_approval_request = datetime.datetime.utcnow()

675

1093

676

1094

def start_checker(self):

677

1095

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

678

1096

679

1097

If a checker already exists, leave it running and do

680

1098

nothing."""

681

1099

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

686

1104

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

687

1105

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

688

1106

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

694

pass

695

except OSError as error:

696

if error.errno != errno.ECHILD:

697

raise

698

else:

699

if pid:

700

logger.warning("Checker was a zombie")

701

gobject.source_remove(self.checker_callback_tag)

702

self.checker_callback(pid, status,

703

self.current_checker_command)

1107

1108

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

1109

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

1110

self.checker.join()

1111

self.checker = None

704

1112

# Start a new checker if needed

705

1113

if self.checker is None:

706

1114

# Escape attributes for the shell

707

escaped_attrs = dict(

708

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

709

for attr in

710

self.runtime_expansions)

1115

escaped_attrs = {

1116

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

1117

for attr in self.runtime_expansions}

711

1118

try:

712

1119

command = self.checker_command % escaped_attrs

713

1120

except TypeError as error:

714

1121

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

715

self.checker_command, exc_info=error)

716

return True # Try again later

1122

self.checker_command,

1123

exc_info=error)

1124

return True # Try again later

717

1125

self.current_checker_command = command

718

try:

719

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

720

command, self.name)

721

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

722

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

723

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

724

# always replaced by /dev/null.)

725

# The exception is when not debugging but nevertheless

726

# running in the foreground; use the previously

727

# created wnull.

728

popen_args = {}

729

if (not self.server_settings["debug"]

730

and self.server_settings["foreground"]):

731

popen_args.update({"stdout": wnull,

732

"stderr": wnull })

733

self.checker = subprocess.Popen(command,

734

close_fds=True,

735

shell=True, cwd="/",

736

**popen_args)

737

except OSError as error:

738

logger.error("Failed to start subprocess",

739

exc_info=error)

740

return True

741

self.checker_callback_tag = (gobject.child_watch_add

742

(self.checker.pid,

743

self.checker_callback,

744

data=command))

745

# The checker may have completed before the gobject

746

# watch was added. Check for this.

747

try:

748

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

749

except OSError as error:

750

if error.errno == errno.ECHILD:

751

# This should never happen

752

logger.error("Child process vanished",

753

exc_info=error)

754

return True

755

raise

756

if pid:

757

gobject.source_remove(self.checker_callback_tag)

758

self.checker_callback(pid, status, command)

759

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

1126

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

1127

self.name)

1128

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

1129

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

1130

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

1131

# always replaced by /dev/null.)

1132

# The exception is when not debugging but nevertheless

1133

# running in the foreground; use the previously

1134

# created wnull.

1135

popen_args = {"close_fds": True,

1136

"shell": True,

1137

"cwd": "/"}

1138

if (not self.server_settings["debug"]

1139

and self.server_settings["foreground"]):

1140

popen_args.update({"stdout": wnull,

1141

"stderr": wnull})

1142

pipe = multiprocessing.Pipe(duplex=False)

1143

self.checker = multiprocessing.Process(

1144

target=call_pipe,

1145

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

1146

kwargs=popen_args)

1147

self.checker.start()

1148

self.checker_callback_tag = GLib.io_add_watch(

1149

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

1150

self.checker_callback, pipe[0], command)

1151

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

760

1152

return True

761

1153

762

1154

def stop_checker(self):

763

1155

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

764

1156

if self.checker_callback_tag:

765

gobject.source_remove(self.checker_callback_tag)

1157

GLib.source_remove(self.checker_callback_tag)

766

1158

self.checker_callback_tag = None

767

1159

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

768

1160

return

769

1161

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

770

try:

771

self.checker.terminate()

772

#time.sleep(0.5)

773

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

774

# self.checker.kill()

775

except OSError as error:

776

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

777

raise

1162

self.checker.terminate()

778

1163

self.checker = None

779

1164

780

1165

781

def dbus_service_property(dbus_interface, signature="v",

782

access="readwrite", byte_arrays=False):

1166

def dbus_service_property(dbus_interface,

1167

signature="v",

1168

access="readwrite",

1169

byte_arrays=False):

783

1170

"""Decorators for marking methods of a DBusObjectWithProperties to

784

1171

become properties on the D-Bus.

785

1172

786

1173

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

787

1174

and with one argument by "Set".

788

1175

789

1176

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

790

1177

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

791

1178

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

794

1181

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

795

1182

if byte_arrays and signature != "ay":

796

1183

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

797

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

1184

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

1185

798

1186

def decorator(func):

799

1187

func._dbus_is_property = True

800

1188

func._dbus_interface = dbus_interface

803

1191

func._dbus_name = func.__name__

804

1192

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

805

1193

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

806

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1194

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

807

1195

return func

1196

808

1197

return decorator

809

1198

810

1199

811

1200

def dbus_interface_annotations(dbus_interface):

812

1201

"""Decorator for marking functions returning interface annotations

813

1202

814

1203

Usage:

815

1204

816

1205

@dbus_interface_annotations("org.example.Interface")

817

1206

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

818

1207

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

819

1208

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

820

1209

"false"}

821

1210

"""

1211

822

1212

def decorator(func):

823

1213

func._dbus_is_interface = True

824

1214

func._dbus_interface = dbus_interface

825

1215

func._dbus_name = dbus_interface

826

1216

return func

1217

827

1218

return decorator

828

1219

829

1220

830

1221

def dbus_annotations(annotations):

831

1222

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

832

1223

Usage:

833

1224

1225

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

1226

"org.freedesktop.DBus.Property."

1227

"EmitsChangedSignal": "false"})

834

1228

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

835

1229

access="r")

836

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

837

"org.freedesktop.DBus.Property."

838

"EmitsChangedSignal": "false"})

839

1230

def Property_dbus_property(self):

840

1231

return dbus.Boolean(False)

1232

1233

See also the DBusObjectWithAnnotations class.

841

1234

"""

1235

842

1236

def decorator(func):

843

1237

func._dbus_annotations = annotations

844

1238

return func

1239

845

1240

return decorator

846

1241

847

1242

848

1243

class DBusPropertyException(dbus.exceptions.DBusException):

849

1244

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

850

1245

"""

851

def __unicode__(self):

852

return unicode(str(self))

1246

pass

853

1247

854

1248

855

1249

class DBusPropertyAccessException(DBusPropertyException):

864

1258

pass

865

1259

866

1260

867

class DBusObjectWithProperties(dbus.service.Object):

868

"""A D-Bus object with properties.

869

870

Classes inheriting from this can use the dbus_service_property

871

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

872

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

1261

class DBusObjectWithAnnotations(dbus.service.Object):

1262

"""A D-Bus object with annotations.

1263

1264

Classes inheriting from this can use the dbus_annotations

1265

decorator to add annotations to methods or signals.

873

1266

"""

874

1267

875

1268

@staticmethod

876

1269

def _is_dbus_thing(thing):

877

1270

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

878

1271

879

1272

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

880

1273

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

881

1274

"""

882

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

1275

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

883

1276

False)

884

1277

885

1278

def _get_all_dbus_things(self, thing):

886

1279

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

887

1280

"""

888

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

889

name),

1281

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

890

1282

athing.__get__(self))

891

1283

for cls in self.__class__.__mro__

892

1284

for name, athing in

893

inspect.getmembers(cls,

894

self._is_dbus_thing(thing)))

895

1285

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

1286

1287

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1288

out_signature="s",

1289

path_keyword='object_path',

1290

connection_keyword='connection')

1291

def Introspect(self, object_path, connection):

1292

"""Overloading of standard D-Bus method.

1293

1294

Inserts annotation tags on methods and signals.

1295

"""

1296

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

1297

connection)

1298

try:

1299

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

1300

1301

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

1302

# Add annotation tags

1303

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

1304

for tag in if_tag.getElementsByTagName(typ):

1305

annots = dict()

1306

for name, prop in (self.

1307

_get_all_dbus_things(typ)):

1308

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

1309

and prop._dbus_interface

1310

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

1311

annots.update(getattr(

1312

prop, "_dbus_annotations", {}))

1313

for name, value in annots.items():

1314

ann_tag = document.createElement(

1315

"annotation")

1316

ann_tag.setAttribute("name", name)

1317

ann_tag.setAttribute("value", value)

1318

tag.appendChild(ann_tag)

1319

# Add interface annotation tags

1320

for annotation, value in dict(

1321

itertools.chain.from_iterable(

1322

annotations().items()

1323

for name, annotations

1324

in self._get_all_dbus_things("interface")

1325

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

1326

)).items():

1327

ann_tag = document.createElement("annotation")

1328

ann_tag.setAttribute("name", annotation)

1329

ann_tag.setAttribute("value", value)

1330

if_tag.appendChild(ann_tag)

1331

# Fix argument name for the Introspect method itself

1332

if (if_tag.getAttribute("name")

1333

== dbus.INTROSPECTABLE_IFACE):

1334

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

1335

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

1336

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

1337

if (arg.getAttribute("direction")

1338

== "out"):

1339

arg.setAttribute("name",

1340

"xml_data")

1341

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

1342

document.unlink()

1343

except (AttributeError, xml.dom.DOMException,

1344

xml.parsers.expat.ExpatError) as error:

1345

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

1346

exc_info=error)

1347

return xmlstring

1348

1349

1350

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1351

"""A D-Bus object with properties.

1352

1353

Classes inheriting from this can use the dbus_service_property

1354

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

1355

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

1356

"""

1357

896

1358

def _get_dbus_property(self, interface_name, property_name):

897

1359

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

898

1360

property with the specified name and interface.

899

1361

"""

900

for cls in self.__class__.__mro__:

901

for name, value in (inspect.getmembers

902

(cls,

903

self._is_dbus_thing("property"))):

1362

for cls in self.__class__.__mro__:

1363

for name, value in inspect.getmembers(

1364

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

904

1365

if (value._dbus_name == property_name

905

1366

and value._dbus_interface == interface_name):

906

1367

return value.__get__(self)

907

1368

908

1369

# No such property

909

raise DBusPropertyNotFound(self.dbus_object_path + ":"

910

+ interface_name + "."

911

+ property_name)

912

913

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

1370

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

1371

self.dbus_object_path, interface_name, property_name))

1372

1373

@classmethod

1374

def _get_all_interface_names(cls):

1375

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

1376

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

1377

"_dbus_interface", None)

1378

for x in (inspect.getmro(cls))

1379

for attr in dir(x))

1380

if name is not None)

1381

1382

@dbus.service.method(dbus.PROPERTIES_IFACE,

1383

in_signature="ss",

914

1384

out_signature="v")

915

1385

def Get(self, interface_name, property_name):

916

1386

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

922

1392

if not hasattr(value, "variant_level"):

923

1393

return value

924

1394

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

925

1395

926

1396

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

927

1397

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

928

1398

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

935

1405

# signatures other than "ay".

936

1406

if prop._dbus_signature != "ay":

937

1407

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

938

"'ay' signature {0!r}"

1408

"'ay' signature {!r}"

939

1409

.format(prop._dbus_signature))

940

1410

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

941

1411

for byte in value))

942

1412

prop(value)

943

944

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

1413

1414

@dbus.service.method(dbus.PROPERTIES_IFACE,

1415

in_signature="s",

945

1416

out_signature="a{sv}")

946

1417

def GetAll(self, interface_name):

947

1418

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

948

1419

standard.

949

1420

950

1421

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

951

1422

"""

952

1423

properties = {}

962

1433

if not hasattr(value, "variant_level"):

963

1434

properties[name] = value

964

1435

continue

965

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

966

value.variant_level+1)

1436

properties[name] = type(value)(

1437

value, variant_level=value.variant_level + 1)

967

1438

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

968

1439

1440

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

1441

def PropertiesChanged(self, interface_name, changed_properties,

1442

invalidated_properties):

1443

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

1444

standard.

1445

"""

1446

pass

1447

969

1448

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

970

1449

out_signature="s",

971

1450

path_keyword='object_path',

972

1451

connection_keyword='connection')

973

1452

def Introspect(self, object_path, connection):

974

1453

"""Overloading of standard D-Bus method.

975

1454

976

1455

Inserts property tags and interface annotation tags.

977

1456

"""

978

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

979

connection)

1457

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1458

object_path,

1459

connection)

980

1460

try:

981

1461

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

1462

982

1463

def make_tag(document, name, prop):

983

1464

e = document.createElement("property")

984

1465

e.setAttribute("name", name)

985

1466

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

986

1467

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

987

1468

return e

1469

988

1470

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

989

1471

# Add property tags

990

1472

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

993

1475

if prop._dbus_interface

994

1476

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

995

1477

if_tag.appendChild(tag)

996

# Add annotation tags

997

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

998

for tag in if_tag.getElementsByTagName(typ):

999

annots = dict()

1000

for name, prop in (self.

1001

_get_all_dbus_things(typ)):

1002

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

1003

and prop._dbus_interface

1004

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

1005

annots.update(getattr

1006

(prop,

1007

"_dbus_annotations",

1008

{}))

1009

for name, value in annots.iteritems():

1010

ann_tag = document.createElement(

1011

"annotation")

1012

ann_tag.setAttribute("name", name)

1013

ann_tag.setAttribute("value", value)

1014

tag.appendChild(ann_tag)

1015

# Add interface annotation tags

1016

for annotation, value in dict(

1017

itertools.chain.from_iterable(

1018

annotations().iteritems()

1019

for name, annotations in

1020

self._get_all_dbus_things("interface")

1021

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

1022

)).iteritems():

1023

ann_tag = document.createElement("annotation")

1024

ann_tag.setAttribute("name", annotation)

1025

ann_tag.setAttribute("value", value)

1026

if_tag.appendChild(ann_tag)

1478

# Add annotation tags for properties

1479

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

1480

annots = dict()

1481

for name, prop in self._get_all_dbus_things(

1482

"property"):

1483

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

1484

and prop._dbus_interface

1485

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

1486

annots.update(getattr(

1487

prop, "_dbus_annotations", {}))

1488

for name, value in annots.items():

1489

ann_tag = document.createElement(

1490

"annotation")

1491

ann_tag.setAttribute("name", name)

1492

ann_tag.setAttribute("value", value)

1493

tag.appendChild(ann_tag)

1027

1494

# Add the names to the return values for the

1028

1495

# "org.freedesktop.DBus.Properties" methods

1029

1496

if (if_tag.getAttribute("name")

1048

1515

return xmlstring

1049

1516

1050

1517

1518

try:

1519

dbus.OBJECT_MANAGER_IFACE

1520

except AttributeError:

1521

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

1522

1523

1524

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1525

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

1526

1527

Classes inheriting from this exposes the standard

1528

GetManagedObjects call and the InterfacesAdded and

1529

InterfacesRemoved signals on the standard

1530

"org.freedesktop.DBus.ObjectManager" interface.

1531

1532

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

1533

manually.

1534

"""

1535

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1536

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

1537

def GetManagedObjects(self):

1538

"""This function must be overridden"""

1539

raise NotImplementedError()

1540

1541

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1542

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

1543

def InterfacesAdded(self, object_path, interfaces_and_properties):

1544

pass

1545

1546

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

1547

def InterfacesRemoved(self, object_path, interfaces):

1548

pass

1549

1550

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1551

out_signature="s",

1552

path_keyword='object_path',

1553

connection_keyword='connection')

1554

def Introspect(self, object_path, connection):

1555

"""Overloading of standard D-Bus method.

1556

1557

Override return argument name of GetManagedObjects to be

1558

"objpath_interfaces_and_properties"

1559

"""

1560

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1561

object_path,

1562

connection)

1563

try:

1564

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

1565

1566

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

1567

# Fix argument name for the GetManagedObjects method

1568

if (if_tag.getAttribute("name")

1569

== dbus.OBJECT_MANAGER_IFACE):

1570

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

1571

if (cn.getAttribute("name")

1572

== "GetManagedObjects"):

1573

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

1574

if (arg.getAttribute("direction")

1575

== "out"):

1576

arg.setAttribute(

1577

"name",

1578

"objpath_interfaces"

1579

"_and_properties")

1580

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

1581

document.unlink()

1582

except (AttributeError, xml.dom.DOMException,

1583

xml.parsers.expat.ExpatError) as error:

1584

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

1585

exc_info=error)

1586

return xmlstring

1587

1588

1051

1589

def datetime_to_dbus(dt, variant_level=0):

1052

1590

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

1053

1591

if dt is None:

1054

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

1055

return dbus.String(dt.isoformat(),

1056

variant_level=variant_level)

1592

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

1593

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

1057

1594

1058

1595

1059

1596

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1061

1598

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

1062

1599

interface names according to the "alt_interface_names" mapping.

1063

1600

Usage:

1064

1601

1065

1602

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

1066

1603

"net.example.AlternateInterface"})

1067

1604

class SampleDBusObject(dbus.service.Object):

1068

1605

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

1069

1606

def SampleDBusMethod():

1070

1607

pass

1071

1608

1072

1609

The above "SampleDBusMethod" on "SampleDBusObject" will be

1073

1610

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

1074

1611

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

1075

1612

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

1076

1613

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

1077

1614

1078

1615

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

1079

1616

(from DBusObjectWithProperties) and interfaces (from the

1080

1617

dbus_interface_annotations decorator).

1081

1618

"""

1619

1082

1620

def wrapper(cls):

1083

1621

for orig_interface_name, alt_interface_name in (

1084

alt_interface_names.iteritems()):

1622

alt_interface_names.items()):

1085

1623

attr = {}

1086

1624

interface_names = set()

1087

1625

# Go though all attributes of the class

1089

1627

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

1090

1628

# with the wrong interface name

1091

1629

if (not hasattr(attribute, "_dbus_interface")

1092

or not attribute._dbus_interface

1093

.startswith(orig_interface_name)):

1630

or not attribute._dbus_interface.startswith(

1631

orig_interface_name)):

1094

1632

continue

1095

1633

# Create an alternate D-Bus interface name based on

1096

1634

# the current name

1097

alt_interface = (attribute._dbus_interface

1098

.replace(orig_interface_name,

1099

alt_interface_name))

1635

alt_interface = attribute._dbus_interface.replace(

1636

orig_interface_name, alt_interface_name)

1100

1637

interface_names.add(alt_interface)

1101

1638

# Is this a D-Bus signal?

1102

1639

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

1103

1640

# Extract the original non-method undecorated

1104

1641

# function by black magic

1105

nonmethod_func = (dict(

1642

if sys.version_info.major == 2:

1643

nonmethod_func = (dict(

1106

1644

zip(attribute.func_code.co_freevars,

1107

attribute.__closure__))["func"]

1108

.cell_contents)

1645

attribute.__closure__))

1646

["func"].cell_contents)

1647

else:

1648

nonmethod_func = (dict(

1649

zip(attribute.__code__.co_freevars,

1650

attribute.__closure__))

1651

["func"].cell_contents)

1109

1652

# Create a new, but exactly alike, function

1110

1653

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

1111

1654

# with the alternate D-Bus interface name

1112

new_function = (dbus.service.signal

1113

(alt_interface,

1114

attribute._dbus_signature)

1115

(types.FunctionType(

1116

nonmethod_func.func_code,

1117

nonmethod_func.func_globals,

1118

nonmethod_func.func_name,

1119

nonmethod_func.func_defaults,

1120

nonmethod_func.func_closure)))

1655

new_function = copy_function(nonmethod_func)

1656

new_function = (dbus.service.signal(

1657

alt_interface,

1658

attribute._dbus_signature)(new_function))

1121

1659

# Copy annotations, if any

1122

1660

try:

1123

new_function._dbus_annotations = (

1124

dict(attribute._dbus_annotations))

1661

new_function._dbus_annotations = dict(

1662

attribute._dbus_annotations)

1125

1663

except AttributeError:

1126

1664

pass

1665

1127

1666

# Define a creator of a function to call both the

1128

1667

# original and alternate functions, so both the

1129

1668

# original and alternate signals gets sent when

1132

1671

"""This function is a scope container to pass

1133

1672

func1 and func2 to the "call_both" function

1134

1673

outside of its arguments"""

1674

1675

@functools.wraps(func2)

1135

1676

def call_both(*args, **kwargs):

1136

1677

"""This function will emit two D-Bus

1137

1678

signals by calling func1 and func2"""

1138

1679

func1(*args, **kwargs)

1139

1680

func2(*args, **kwargs)

1681

# Make wrapper function look like a D-Bus

1682

# signal

1683

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

1684

if name.startswith("_dbus_"):

1685

setattr(call_both, name, attr)

1686

1140

1687

return call_both

1141

1688

# Create the "call_both" function and add it to

1142

1689

# the class

1147

1694

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

1148

1695

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

1149

1696

# to the class.

1150

attr[attrname] = (dbus.service.method

1151

(alt_interface,

1152

attribute._dbus_in_signature,

1153

attribute._dbus_out_signature)

1154

(types.FunctionType

1155

(attribute.func_code,

1156

attribute.func_globals,

1157

attribute.func_name,

1158

attribute.func_defaults,

1159

attribute.func_closure)))

1697

attr[attrname] = (

1698

dbus.service.method(

1699

alt_interface,

1700

attribute._dbus_in_signature,

1701

attribute._dbus_out_signature)

1702

(copy_function(attribute)))

1160

1703

# Copy annotations, if any

1161

1704

try:

1162

attr[attrname]._dbus_annotations = (

1163

dict(attribute._dbus_annotations))

1705

attr[attrname]._dbus_annotations = dict(

1706

attribute._dbus_annotations)

1164

1707

except AttributeError:

1165

1708

pass

1166

1709

# Is this a D-Bus property?

1169

1712

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

1170

1713

# property with the alternate D-Bus interface

1171

1714

# name. Add it to the class.

1172

attr[attrname] = (dbus_service_property

1173

(alt_interface,

1174

attribute._dbus_signature,

1175

attribute._dbus_access,

1176

attribute

1177

._dbus_get_args_options

1178

["byte_arrays"])

1179

(types.FunctionType

1180

(attribute.func_code,

1181

attribute.func_globals,

1182

attribute.func_name,

1183

attribute.func_defaults,

1184

attribute.func_closure)))

1715

attr[attrname] = (dbus_service_property(

1716

alt_interface, attribute._dbus_signature,

1717

attribute._dbus_access,

1718

attribute._dbus_get_args_options

1719

["byte_arrays"])

1720

(copy_function(attribute)))

1185

1721

# Copy annotations, if any

1186

1722

try:

1187

attr[attrname]._dbus_annotations = (

1188

dict(attribute._dbus_annotations))

1723

attr[attrname]._dbus_annotations = dict(

1724

attribute._dbus_annotations)

1189

1725

except AttributeError:

1190

1726

pass

1191

1727

# Is this a D-Bus interface?

1194

1730

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

1195

1731

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

1196

1732

# to the class.

1197

attr[attrname] = (dbus_interface_annotations

1198

(alt_interface)

1199

(types.FunctionType

1200

(attribute.func_code,

1201

attribute.func_globals,

1202

attribute.func_name,

1203

attribute.func_defaults,

1204

attribute.func_closure)))

1733

attr[attrname] = (

1734

dbus_interface_annotations(alt_interface)

1735

(copy_function(attribute)))

1205

1736

if deprecate:

1206

1737

# Deprecate all alternate interfaces

1207

iname="_AlternateDBusNames_interface_annotation{0}"

1738

iname = "_AlternateDBusNames_interface_annotation{}"

1208

1739

for interface_name in interface_names:

1740

1209

1741

@dbus_interface_annotations(interface_name)

1210

1742

def func(self):

1211

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

1212

"true" }

1743

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

1744

"true"}

1213

1745

# Find an unused name

1214

1746

for aname in (iname.format(i)

1215

1747

for i in itertools.count()):

1219

1751

if interface_names:

1220

1752

# Replace the class with a new subclass of it with

1221

1753

# methods, signals, etc. as created above.

1222

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

1223

(cls,), attr)

1754

if sys.version_info.major == 2:

1755

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

1756

(cls, ), attr)

1757

else:

1758

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

1759

(cls, ), attr)

1224

1760

return cls

1761

1225

1762

return wrapper

1226

1763

1227

1764

1228

1765

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

1229

"se.bsnet.fukt.Mandos"})

1766

"se.bsnet.fukt.Mandos"})

1230

1767

class ClientDBus(Client, DBusObjectWithProperties):

1231

1768

"""A Client class using D-Bus

1232

1769

1233

1770

Attributes:

1234

1771

dbus_object_path: dbus.ObjectPath

1235

1772

bus: dbus.SystemBus()

1236

1773

"""

1237

1774

1238

1775

runtime_expansions = (Client.runtime_expansions

1239

+ ("dbus_object_path",))

1240

1776

+ ("dbus_object_path", ))

1777

1778

_interface = "se.recompile.Mandos.Client"

1779

1241

1780

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

1242

1243

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

1781

1782

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

1244

1783

self.bus = bus

1245

1784

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

1246

1785

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

1247

1786

# the D-Bus

1248

client_object_name = unicode(self.name).translate(

1787

client_object_name = str(self.name).translate(

1249

1788

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

1250

1789

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

1251

self.dbus_object_path = (dbus.ObjectPath

1252

("/clients/" + client_object_name))

1790

self.dbus_object_path = dbus.ObjectPath(

1791

"/clients/" + client_object_name)

1253

1792

DBusObjectWithProperties.__init__(self, self.bus,

1254

1793

self.dbus_object_path)

1255

1256

def notifychangeproperty(transform_func,

1257

dbus_name, type_func=lambda x: x,

1258

variant_level=1):

1794

1795

def notifychangeproperty(transform_func, dbus_name,

1796

type_func=lambda x: x,

1797

variant_level=1,

1798

invalidate_only=False,

1799

_interface=_interface):

1259

1800

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

1260

1801

its changes to DBus.

1261

1802

1262

1803

transform_fun: Function that takes a value and a variant_level

1263

1804

and transforms it to a D-Bus type.

1264

1805

dbus_name: D-Bus name of the variable

1266

1807

to the D-Bus. Default: no transform

1267

1808

variant_level: D-Bus variant level. Default: 1

1268

1809

"""

1269

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

1810

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

1811

1270

1812

def setter(self, value):

1271

1813

if hasattr(self, "dbus_object_path"):

1272

1814

if (not hasattr(self, attrname) or

1273

1815

type_func(getattr(self, attrname, None))

1274

1816

!= type_func(value)):

1275

dbus_value = transform_func(type_func(value),

1276

variant_level

1277

=variant_level)

1278

self.PropertyChanged(dbus.String(dbus_name),

1279

dbus_value)

1817

if invalidate_only:

1818

self.PropertiesChanged(

1819

_interface, dbus.Dictionary(),

1820

dbus.Array((dbus_name, )))

1821

else:

1822

dbus_value = transform_func(

1823

type_func(value),

1824

variant_level=variant_level)

1825

self.PropertyChanged(dbus.String(dbus_name),

1826

dbus_value)

1827

self.PropertiesChanged(

1828

_interface,

1829

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

1830

dbus_value}),

1831

dbus.Array())

1280

1832

setattr(self, attrname, value)

1281

1833

1282

1834

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

1283

1835

1284

1836

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1285

1837

approvals_pending = notifychangeproperty(dbus.Boolean,

1286

1838

"ApprovalPending",

1287

type_func = bool)

1839

type_func=bool)

1288

1840

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

1289

1841

last_enabled = notifychangeproperty(datetime_to_dbus,

1290

1842

"LastEnabled")

1291

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

1292

type_func = lambda checker:

1293

checker is not None)

1843

checker = notifychangeproperty(

1844

dbus.Boolean, "CheckerRunning",

1845

type_func=lambda checker: checker is not None)

1294

1846

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1295

1847

"LastCheckedOK")

1296

1848

last_checker_status = notifychangeproperty(dbus.Int16,

1299

1851

datetime_to_dbus, "LastApprovalRequest")

1300

1852

approved_by_default = notifychangeproperty(dbus.Boolean,

1301

1853

"ApprovedByDefault")

1302

approval_delay = notifychangeproperty(dbus.UInt64,

1303

"ApprovalDelay",

1304

type_func =

1305

timedelta_to_milliseconds)

1854

approval_delay = notifychangeproperty(

1855

dbus.UInt64, "ApprovalDelay",

1856

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

1306

1857

approval_duration = notifychangeproperty(

1307

1858

dbus.UInt64, "ApprovalDuration",

1308

type_func = timedelta_to_milliseconds)

1859

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

1309

1860

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

1310

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

1311

type_func =

1312

timedelta_to_milliseconds)

1861

timeout = notifychangeproperty(

1862

dbus.UInt64, "Timeout",

1863

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

1313

1864

extended_timeout = notifychangeproperty(

1314

1865

dbus.UInt64, "ExtendedTimeout",

1315

type_func = timedelta_to_milliseconds)

1316

interval = notifychangeproperty(dbus.UInt64,

1317

"Interval",

1318

type_func =

1319

timedelta_to_milliseconds)

1866

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

1867

interval = notifychangeproperty(

1868

dbus.UInt64, "Interval",

1869

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

1320

1870

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

1321

1871

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

1872

invalidate_only=True)

1873

1322

1874

del notifychangeproperty

1323

1875

1324

1876

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

1325

1877

try:

1326

1878

self.remove_from_connection()

1329

1881

if hasattr(DBusObjectWithProperties, "__del__"):

1330

1882

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

1331

1883

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

1332

1333

def checker_callback(self, pid, condition, command,

1334

*args, **kwargs):

1335

self.checker_callback_tag = None

1336

self.checker = None

1337

if os.WIFEXITED(condition):

1338

exitstatus = os.WEXITSTATUS(condition)

1884

1885

def checker_callback(self, source, condition,

1886

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

1887

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

1888

connection, command, *args,

1889

**kwargs)

1890

exitstatus = self.last_checker_status

1891

if exitstatus >= 0:

1339

1892

# Emit D-Bus signal

1340

1893

self.CheckerCompleted(dbus.Int16(exitstatus),

1341

dbus.Int64(condition),

1894

# This is specific to GNU libC

1895

dbus.Int64(exitstatus << 8),

1342

1896

dbus.String(command))

1343

1897

else:

1344

1898

# Emit D-Bus signal

1345

1899

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

1346

dbus.Int64(condition),

1900

dbus.Int64(

1901

# This is specific to GNU libC

1902

(exitstatus << 8)

1903

| self.last_checker_signal),

1347

1904

dbus.String(command))

1348

1349

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

1350

*args, **kwargs)

1351

1905

return ret

1906

1352

1907

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

1353

old_checker = self.checker

1354

if self.checker is not None:

1355

old_checker_pid = self.checker.pid

1356

else:

1357

old_checker_pid = None

1908

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

1358

1909

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

1359

1910

# Only if new checker process was started

1360

1911

if (self.checker is not None

1362

1913

# Emit D-Bus signal

1363

1914

self.CheckerStarted(self.current_checker_command)

1364

1915

return r

1365

1916

1366

1917

def _reset_approved(self):

1367

1918

self.approved = None

1368

1919

return False

1369

1920

1370

1921

def approve(self, value=True):

1371

1922

self.approved = value

1372

gobject.timeout_add(timedelta_to_milliseconds

1373

(self.approval_duration),

1374

self._reset_approved)

1923

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

1924

* 1000), self._reset_approved)

1375

1925

self.send_changedstate()

1376

1377

## D-Bus methods, signals & properties

1378

_interface = "se.recompile.Mandos.Client"

1379

1380

## Interfaces

1381

1382

@dbus_interface_annotations(_interface)

1383

def _foo(self):

1384

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

1385

"false"}

1386

1387

## Signals

1388

1926

1927

# D-Bus methods, signals & properties

1928

1929

# Interfaces

1930

1931

# Signals

1932

1389

1933

# CheckerCompleted - signal

1390

1934

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

1391

1935

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

1392

1936

"D-Bus signal"

1393

1937

pass

1394

1938

1395

1939

# CheckerStarted - signal

1396

1940

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

1397

1941

def CheckerStarted(self, command):

1398

1942

"D-Bus signal"

1399

1943

pass

1400

1944

1401

1945

# PropertyChanged - signal

1946

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

1402

1947

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

1403

1948

def PropertyChanged(self, property, value):

1404

1949

"D-Bus signal"

1405

1950

pass

1406

1951

1407

1952

# GotSecret - signal

1408

1953

@dbus.service.signal(_interface)

1409

1954

def GotSecret(self):

1412

1957

server to mandos-client

1413

1958

"""

1414

1959

pass

1415

1960

1416

1961

# Rejected - signal

1417

1962

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

1418

1963

def Rejected(self, reason):

1419

1964

"D-Bus signal"

1420

1965

pass

1421

1966

1422

1967

# NeedApproval - signal

1423

1968

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

1424

1969

def NeedApproval(self, timeout, default):

1425

1970

"D-Bus signal"

1426

1971

return self.need_approval()

1427

1428

## Methods

1429

1972

1973

# Methods

1974

1430

1975

# Approve - method

1431

1976

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

1432

1977

def Approve(self, value):

1433

1978

self.approve(value)

1434

1979

1435

1980

# CheckedOK - method

1436

1981

@dbus.service.method(_interface)

1437

1982

def CheckedOK(self):

1438

1983

self.checked_ok()

1439

1984

1440

1985

# Enable - method

1986

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

1441

1987

@dbus.service.method(_interface)

1442

1988

def Enable(self):

1443

1989

"D-Bus method"

1444

1990

self.enable()

1445

1991

1446

1992

# StartChecker - method

1993

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

1447

1994

@dbus.service.method(_interface)

1448

1995

def StartChecker(self):

1449

1996

"D-Bus method"

1450

1997

self.start_checker()

1451

1998

1452

1999

# Disable - method

2000

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

1453

2001

@dbus.service.method(_interface)

1454

2002

def Disable(self):

1455

2003

"D-Bus method"

1456

2004

self.disable()

1457

2005

1458

2006

# StopChecker - method

2007

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

1459

2008

@dbus.service.method(_interface)

1460

2009

def StopChecker(self):

1461

2010

self.stop_checker()

1462

1463

## Properties

1464

2011

2012

# Properties

2013

1465

2014

# ApprovalPending - property

1466

2015

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

1467

2016

def ApprovalPending_dbus_property(self):

1468

2017

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

1469

2018

1470

2019

# ApprovedByDefault - property

1471

@dbus_service_property(_interface, signature="b",

2020

@dbus_service_property(_interface,

2021

signature="b",

1472

2022

access="readwrite")

1473

2023

def ApprovedByDefault_dbus_property(self, value=None):

1474

2024

if value is None: # get

1475

2025

return dbus.Boolean(self.approved_by_default)

1476

2026

self.approved_by_default = bool(value)

1477

2027

1478

2028

# ApprovalDelay - property

1479

@dbus_service_property(_interface, signature="t",

2029

@dbus_service_property(_interface,

2030

signature="t",

1480

2031

access="readwrite")

1481

2032

def ApprovalDelay_dbus_property(self, value=None):

1482

2033

if value is None: # get

1483

return dbus.UInt64(self.approval_delay_milliseconds())

2034

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

2035

* 1000)

1484

2036

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

1485

2037

1486

2038

# ApprovalDuration - property

1487

@dbus_service_property(_interface, signature="t",

2039

@dbus_service_property(_interface,

2040

signature="t",

1488

2041

access="readwrite")

1489

2042

def ApprovalDuration_dbus_property(self, value=None):

1490

2043

if value is None: # get

1491

return dbus.UInt64(timedelta_to_milliseconds(

1492

self.approval_duration))

2044

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

2045

* 1000)

1493

2046

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

1494

2047

1495

2048

# Name - property

2049

@dbus_annotations(

2050

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

1496

2051

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

1497

2052

def Name_dbus_property(self):

1498

2053

return dbus.String(self.name)

1499

2054

2055

# KeyID - property

2056

@dbus_annotations(

2057

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

2058

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

2059

def KeyID_dbus_property(self):

2060

return dbus.String(self.key_id)

2061

1500

2062

# Fingerprint - property

2063

@dbus_annotations(

2064

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

1501

2065

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

1502

2066

def Fingerprint_dbus_property(self):

1503

2067

return dbus.String(self.fingerprint)

1504

2068

1505

2069

# Host - property

1506

@dbus_service_property(_interface, signature="s",

2070

@dbus_service_property(_interface,

2071

signature="s",

1507

2072

access="readwrite")

1508

2073

def Host_dbus_property(self, value=None):

1509

2074

if value is None: # get

1510

2075

return dbus.String(self.host)

1511

self.host = unicode(value)

1512

2076

self.host = str(value)

2077

1513

2078

# Created - property

2079

@dbus_annotations(

2080

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

1514

2081

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

1515

2082

def Created_dbus_property(self):

1516

2083

return datetime_to_dbus(self.created)

1517

2084

1518

2085

# LastEnabled - property

1519

2086

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

1520

2087

def LastEnabled_dbus_property(self):

1521

2088

return datetime_to_dbus(self.last_enabled)

1522

2089

1523

2090

# Enabled - property

1524

@dbus_service_property(_interface, signature="b",

2091

@dbus_service_property(_interface,

2092

signature="b",

1525

2093

access="readwrite")

1526

2094

def Enabled_dbus_property(self, value=None):

1527

2095

if value is None: # get

1530

2098

self.enable()

1531

2099

else:

1532

2100

self.disable()

1533

2101

1534

2102

# LastCheckedOK - property

1535

@dbus_service_property(_interface, signature="s",

2103

@dbus_service_property(_interface,

2104

signature="s",

1536

2105

access="readwrite")

1537

2106

def LastCheckedOK_dbus_property(self, value=None):

1538

2107

if value is not None:

1539

2108

self.checked_ok()

1540

2109

return

1541

2110

return datetime_to_dbus(self.last_checked_ok)

1542

2111

1543

2112

# LastCheckerStatus - property

1544

@dbus_service_property(_interface, signature="n",

1545

access="read")

2113

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

1546

2114

def LastCheckerStatus_dbus_property(self):

1547

2115

return dbus.Int16(self.last_checker_status)

1548

2116

1549

2117

# Expires - property

1550

2118

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

1551

2119

def Expires_dbus_property(self):

1552

2120

return datetime_to_dbus(self.expires)

1553

2121

1554

2122

# LastApprovalRequest - property

1555

2123

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

1556

2124

def LastApprovalRequest_dbus_property(self):

1557

2125

return datetime_to_dbus(self.last_approval_request)

1558

2126

1559

2127

# Timeout - property

1560

@dbus_service_property(_interface, signature="t",

2128

@dbus_service_property(_interface,

2129

signature="t",

1561

2130

access="readwrite")

1562

2131

def Timeout_dbus_property(self, value=None):

1563

2132

if value is None: # get

1564

return dbus.UInt64(self.timeout_milliseconds())

2133

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

1565

2134

old_timeout = self.timeout

1566

2135

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

1567

2136

# Reschedule disabling

1575

2144

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

1576

2145

is None):

1577

2146

return

1578

gobject.source_remove(self.disable_initiator_tag)

1579

self.disable_initiator_tag = (

1580

gobject.timeout_add(

1581

timedelta_to_milliseconds(self.expires - now),

1582

self.disable))

1583

2147

GLib.source_remove(self.disable_initiator_tag)

2148

self.disable_initiator_tag = GLib.timeout_add(

2149

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

2150

self.disable)

2151

1584

2152

# ExtendedTimeout - property

1585

@dbus_service_property(_interface, signature="t",

2153

@dbus_service_property(_interface,

2154

signature="t",

1586

2155

access="readwrite")

1587

2156

def ExtendedTimeout_dbus_property(self, value=None):

1588

2157

if value is None: # get

1589

return dbus.UInt64(self.extended_timeout_milliseconds())

2158

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

2159

* 1000)

1590

2160

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

1591

2161

1592

2162

# Interval - property

1593

@dbus_service_property(_interface, signature="t",

2163

@dbus_service_property(_interface,

2164

signature="t",

1594

2165

access="readwrite")

1595

2166

def Interval_dbus_property(self, value=None):

1596

2167

if value is None: # get

1597

return dbus.UInt64(self.interval_milliseconds())

2168

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

1598

2169

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

1599

2170

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

1600

2171

return

1601

2172

if self.enabled:

1602

2173

# Reschedule checker run

1603

gobject.source_remove(self.checker_initiator_tag)

1604

self.checker_initiator_tag = (gobject.timeout_add

1605

(value, self.start_checker))

1606

self.start_checker() # Start one now, too

1607

2174

GLib.source_remove(self.checker_initiator_tag)

2175

self.checker_initiator_tag = GLib.timeout_add(

2176

value, self.start_checker)

2177

self.start_checker() # Start one now, too

2178

1608

2179

# Checker - property

1609

@dbus_service_property(_interface, signature="s",

2180

@dbus_service_property(_interface,

2181

signature="s",

1610

2182

access="readwrite")

1611

2183

def Checker_dbus_property(self, value=None):

1612

2184

if value is None: # get

1613

2185

return dbus.String(self.checker_command)

1614

self.checker_command = unicode(value)

1615

2186

self.checker_command = str(value)

2187

1616

2188

# CheckerRunning - property

1617

@dbus_service_property(_interface, signature="b",

2189

@dbus_service_property(_interface,

2190

signature="b",

1618

2191

access="readwrite")

1619

2192

def CheckerRunning_dbus_property(self, value=None):

1620

2193

if value is None: # get

1623

2196

self.start_checker()

1624

2197

else:

1625

2198

self.stop_checker()

1626

2199

1627

2200

# ObjectPath - property

2201

@dbus_annotations(

2202

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

2203

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

1628

2204

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

1629

2205

def ObjectPath_dbus_property(self):

1630

return self.dbus_object_path # is already a dbus.ObjectPath

1631

2206

return self.dbus_object_path # is already a dbus.ObjectPath

2207

1632

2208

# Secret = property

1633

@dbus_service_property(_interface, signature="ay",

1634

access="write", byte_arrays=True)

2209

@dbus_annotations(

2210

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

2211

"invalidates"})

2212

@dbus_service_property(_interface,

2213

signature="ay",

2214

access="write",

2215

byte_arrays=True)

1635

2216

def Secret_dbus_property(self, value):

1636

self.secret = str(value)

1637

2217

self.secret = bytes(value)

2218

1638

2219

del _interface

1639

2220

1640

2221

1641

2222

class ProxyClient(object):

1642

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

2223

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

1643

2224

self._pipe = child_pipe

1644

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

2225

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

1645

2226

if not self._pipe.recv():

1646

raise KeyError()

1647

2227

raise KeyError(key_id or fpr)

2228

1648

2229

def __getattribute__(self, name):

1649

2230

if name == '_pipe':

1650

2231

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

1653

2234

if data[0] == 'data':

1654

2235

return data[1]

1655

2236

if data[0] == 'function':

2237

1656

2238

def func(*args, **kwargs):

1657

2239

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

1658

2240

return self._pipe.recv()[1]

2241

1659

2242

return func

1660

2243

1661

2244

def __setattr__(self, name, value):

1662

2245

if name == '_pipe':

1663

2246

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

1666

2249

1667

2250

class ClientHandler(socketserver.BaseRequestHandler, object):

1668

2251

"""A class to handle client connections.

1669

2252

1670

2253

Instantiated once for each connection to handle it.

1671

2254

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

1672

2255

1673

2256

def handle(self):

1674

2257

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

1675

2258

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

1676

unicode(self.client_address))

2259

str(self.client_address))

1677

2260

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

1678

2261

self.server.child_pipe.fileno())

1679

1680

session = (gnutls.connection

1681

.ClientSession(self.request,

1682

gnutls.connection

1683

.X509Credentials()))

1684

1685

# Note: gnutls.connection.X509Credentials is really a

1686

# generic GnuTLS certificate credentials object so long as

1687

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

1688

# here despite using OpenPGP certificates.

1689

1690

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

1691

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

1692

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

1693

# "+DHE-DSS"))

2262

2263

session = gnutls.ClientSession(self.request)

2264

2265

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

2266

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

2267

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

2268

# "+DHE-DSS"))

1694

2269

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

1695

2270

priority = self.server.gnutls_priority

1696

2271

if priority is None:

1697

2272

priority = "NORMAL"

1698

(gnutls.library.functions

1699

.gnutls_priority_set_direct(session._c_object,

1700

priority, None))

1701

2273

gnutls.priority_set_direct(session._c_object,

2274

priority.encode("utf-8"),

2275

None)

2276

1702

2277

# Start communication using the Mandos protocol

1703

2278

# Get protocol number

1704

2279

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

1709

2284

except (ValueError, IndexError, RuntimeError) as error:

1710

2285

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

1711

2286

return

1712

2287

1713

2288

# Start GnuTLS connection

1714

2289

try:

1715

2290

session.handshake()

1716

except gnutls.errors.GNUTLSError as error:

2291

except gnutls.Error as error:

1717

2292

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

1718

2293

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

1719

2294

# established. Just abandon the request.

1720

2295

return

1721

2296

logger.debug("Handshake succeeded")

1722

2297

1723

2298

approval_required = False

1724

2299

try:

1725

try:

1726

fpr = self.fingerprint(self.peer_certificate

1727

(session))

1728

except (TypeError,

1729

gnutls.errors.GNUTLSError) as error:

1730

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

1731

return

1732

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

1733

1734

try:

1735

client = ProxyClient(child_pipe, fpr,

2300

if gnutls.has_rawpk:

2301

fpr = ""

2302

try:

2303

key_id = self.key_id(

2304

self.peer_certificate(session))

2305

except (TypeError, gnutls.Error) as error:

2306

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

2307

return

2308

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

2309

2310

else:

2311

key_id = ""

2312

try:

2313

fpr = self.fingerprint(

2314

self.peer_certificate(session))

2315

except (TypeError, gnutls.Error) as error:

2316

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

2317

return

2318

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

2319

2320

try:

2321

client = ProxyClient(child_pipe, key_id, fpr,

1736

2322

self.client_address)

1737

2323

except KeyError:

1738

2324

return

1739

2325

1740

2326

if client.approval_delay:

1741

2327

delay = client.approval_delay

1742

2328

client.approvals_pending += 1

1743

2329

approval_required = True

1744

2330

1745

2331

while True:

1746

2332

if not client.enabled:

1747

2333

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

1748

client.name)

2334

client.name)

1749

2335

if self.server.use_dbus:

1750

2336

# Emit D-Bus signal

1751

2337

client.Rejected("Disabled")

1752

2338

return

1753

2339

1754

2340

if client.approved or not client.approval_delay:

1755

#We are approved or approval is disabled

2341

# We are approved or approval is disabled

1756

2342

break

1757

2343

elif client.approved is None:

1758

2344

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

1760

2346

if self.server.use_dbus:

1761

2347

# Emit D-Bus signal

1762

2348

client.NeedApproval(

1763

client.approval_delay_milliseconds(),

1764

client.approved_by_default)

2349

client.approval_delay.total_seconds()

2350

* 1000, client.approved_by_default)

1765

2351

else:

1766

2352

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

1767

2353

client.name)

1769

2355

# Emit D-Bus signal

1770

2356

client.Rejected("Denied")

1771

2357

return

1772

1773

#wait until timeout or approved

2358

2359

# wait until timeout or approved

1774

2360

time = datetime.datetime.now()

1775

2361

client.changedstate.acquire()

1776

client.changedstate.wait(

1777

float(timedelta_to_milliseconds(delay)

1778

/ 1000))

2362

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

1779

2363

client.changedstate.release()

1780

2364

time2 = datetime.datetime.now()

1781

2365

if (time2 - time) >= delay:

1791

2375

break

1792

2376

else:

1793

2377

delay -= time2 - time

1794

1795

sent_size = 0

1796

while sent_size < len(client.secret):

1797

try:

1798

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

1799

except gnutls.errors.GNUTLSError as error:

1800

logger.warning("gnutls send failed",

1801

exc_info=error)

1802

return

1803

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

1804

sent, len(client.secret)

1805

- (sent_size + sent))

1806

sent_size += sent

1807

2378

2379

try:

2380

session.send(client.secret)

2381

except gnutls.Error as error:

2382

logger.warning("gnutls send failed",

2383

exc_info=error)

2384

return

2385

1808

2386

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

1809

2387

# bump the timeout using extended_timeout

1810

2388

client.bump_timeout(client.extended_timeout)

1811

2389

if self.server.use_dbus:

1812

2390

# Emit D-Bus signal

1813

2391

client.GotSecret()

1814

2392

1815

2393

finally:

1816

2394

if approval_required:

1817

2395

client.approvals_pending -= 1

1818

2396

try:

1819

2397

session.bye()

1820

except gnutls.errors.GNUTLSError as error:

2398

except gnutls.Error as error:

1821

2399

logger.warning("GnuTLS bye failed",

1822

2400

exc_info=error)

1823

2401

1824

2402

@staticmethod

1825

2403

def peer_certificate(session):

1826

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

1827

# If not an OpenPGP certificate...

1828

if (gnutls.library.functions

1829

.gnutls_certificate_type_get(session._c_object)

1830

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1831

# ...do the normal thing

1832

return session.peer_certificate

2404

"Return the peer's certificate as a bytestring"

2405

try:

2406

cert_type = gnutls.certificate_type_get2(session._c_object,

2407

gnutls.CTYPE_PEERS)

2408

except AttributeError:

2409

cert_type = gnutls.certificate_type_get(session._c_object)

2410

if gnutls.has_rawpk:

2411

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2412

else:

2413

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2414

# If not a valid certificate type...

2415

if cert_type not in valid_cert_types:

2416

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

2417

valid_cert_types)

2418

# ...return invalid data

2419

return b""

1833

2420

list_size = ctypes.c_uint(1)

1834

cert_list = (gnutls.library.functions

1835

.gnutls_certificate_get_peers

2421

cert_list = (gnutls.certificate_get_peers

1836

2422

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

1837

2423

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

1838

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

1839

" certificate")

2424

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

1840

2425

if list_size.value == 0:

1841

2426

return None

1842

2427

cert = cert_list[0]

1843

2428

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

1844

2429

2430

@staticmethod

2431

def key_id(certificate):

2432

"Convert a certificate bytestring to a hexdigit key ID"

2433

# New GnuTLS "datum" with the public key

2434

datum = gnutls.datum_t(

2435

ctypes.cast(ctypes.c_char_p(certificate),

2436

ctypes.POINTER(ctypes.c_ubyte)),

2437

ctypes.c_uint(len(certificate)))

2438

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

2439

# New empty GnuTLS certificate

2440

pubkey = gnutls.pubkey_t()

2441

gnutls.pubkey_init(ctypes.byref(pubkey))

2442

# Import the raw public key into the certificate

2443

gnutls.pubkey_import(pubkey,

2444

ctypes.byref(datum),

2445

gnutls.X509_FMT_DER)

2446

# New buffer for the key ID

2447

buf = ctypes.create_string_buffer(32)

2448

buf_len = ctypes.c_size_t(len(buf))

2449

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

2450

gnutls.pubkey_get_key_id(pubkey,

2451

gnutls.KEYID_USE_SHA256,

2452

ctypes.cast(ctypes.byref(buf),

2453

ctypes.POINTER(ctypes.c_ubyte)),

2454

ctypes.byref(buf_len))

2455

# Deinit the certificate

2456

gnutls.pubkey_deinit(pubkey)

2457

2458

# Convert the buffer to a Python bytestring

2459

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

2460

# Convert the bytestring to hexadecimal notation

2461

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

2462

return hex_key_id

2463

1845

2464

@staticmethod

1846

2465

def fingerprint(openpgp):

1847

2466

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1848

2467

# New GnuTLS "datum" with the OpenPGP public key

1849

datum = (gnutls.library.types

1850

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

1851

ctypes.POINTER

1852

(ctypes.c_ubyte)),

1853

ctypes.c_uint(len(openpgp))))

2468

datum = gnutls.datum_t(

2469

ctypes.cast(ctypes.c_char_p(openpgp),

2470

ctypes.POINTER(ctypes.c_ubyte)),

2471

ctypes.c_uint(len(openpgp)))

1854

2472

# New empty GnuTLS certificate

1855

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2473

crt = gnutls.openpgp_crt_t()

2474

gnutls.openpgp_crt_init(ctypes.byref(crt))

1858

2475

# Import the OpenPGP public key into the certificate

1859

(gnutls.library.functions

1860

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

1861

gnutls.library.constants

1862

.GNUTLS_OPENPGP_FMT_RAW))

2476

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

2477

gnutls.OPENPGP_FMT_RAW)

1863

2478

# Verify the self signature in the key

1864

2479

crtverify = ctypes.c_uint()

1865

(gnutls.library.functions

1866

.gnutls_openpgp_crt_verify_self(crt, 0,

1867

ctypes.byref(crtverify)))

2480

gnutls.openpgp_crt_verify_self(crt, 0,

2481

ctypes.byref(crtverify))

1868

2482

if crtverify.value != 0:

1869

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1870

raise (gnutls.errors.CertificateSecurityError

1871

("Verify failed"))

2483

gnutls.openpgp_crt_deinit(crt)

2484

raise gnutls.CertificateSecurityError(code

2485

=crtverify.value)

1872

2486

# New buffer for the fingerprint

1873

2487

buf = ctypes.create_string_buffer(20)

1874

2488

buf_len = ctypes.c_size_t()

1875

2489

# Get the fingerprint from the certificate into the buffer

1876

(gnutls.library.functions

1877

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

1878

ctypes.byref(buf_len)))

2490

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

2491

ctypes.byref(buf_len))

1879

2492

# Deinit the certificate

1880

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2493

gnutls.openpgp_crt_deinit(crt)

1881

2494

# Convert the buffer to a Python bytestring

1882

2495

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

1883

2496

# Convert the bytestring to hexadecimal notation

1887

2500

1888

2501

class MultiprocessingMixIn(object):

1889

2502

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

2503

1890

2504

def sub_process_main(self, request, address):

1891

2505

try:

1892

2506

self.finish_request(request, address)

1893

2507

except Exception:

1894

2508

self.handle_error(request, address)

1895

2509

self.close_request(request)

1896

2510

1897

2511

def process_request(self, request, address):

1898

2512

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

1899

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

1900

args = (request, address))

2513

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

2514

args=(request, address))

1901

2515

proc.start()

1902

2516

return proc

1903

2517

1904

2518

1905

2519

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1906

2520

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

2521

1907

2522

def process_request(self, request, client_address):

1908

2523

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

1909

2524

1910

2525

This function creates a new pipe in self.pipe

1911

2526

"""

1912

2527

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1913

2528

1914

2529

proc = MultiprocessingMixIn.process_request(self, request,

1915

2530

client_address)

1916

2531

self.child_pipe.close()

1917

2532

self.add_pipe(parent_pipe, proc)

1918

2533

1919

2534

def add_pipe(self, parent_pipe, proc):

1920

2535

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

1921

2536

raise NotImplementedError()

1924

2539

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1925

2540

socketserver.TCPServer, object):

1926

2541

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

1927

2542

1928

2543

Attributes:

1929

2544

enabled: Boolean; whether this server is activated yet

1930

2545

interface: None or a network interface name (string)

1931

2546

use_ipv6: Boolean; to use IPv6 or not

1932

2547

"""

2548

1933

2549

def __init__(self, server_address, RequestHandlerClass,

1934

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

2550

interface=None,

2551

use_ipv6=True,

2552

socketfd=None):

1935

2553

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

1936

2554

creating a new one with socket.socket().

1937

2555

"""

1943

2561

self.socketfd = socketfd

1944

2562

# Save the original socket.socket() function

1945

2563

self.socket_socket = socket.socket

2564

1946

2565

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

1947

#

2566

#

1948

2567

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

1949

2568

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

1950

2569

# patching socket.socket.)

1951

#

2570

#

1952

2571

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

1953

2572

@functools.wraps(socket.socket)

1954

2573

def socket_wrapper(*args, **kwargs):

1966

2585

# socket_wrapper(), if socketfd was set.

1967

2586

socketserver.TCPServer.__init__(self, server_address,

1968

2587

RequestHandlerClass)

1969

2588

1970

2589

def server_bind(self):

1971

2590

"""This overrides the normal server_bind() function

1972

2591

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

1973

2592

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

2593

global SO_BINDTODEVICE

1974

2594

if self.interface is not None:

1975

2595

if SO_BINDTODEVICE is None:

1976

logger.error("SO_BINDTODEVICE does not exist;"

1977

" cannot bind to interface %s",

1978

self.interface)

1979

else:

1980

try:

1981

self.socket.setsockopt(socket.SOL_SOCKET,

1982

SO_BINDTODEVICE,

1983

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

1984

except socket.error as error:

1985

if error.errno == errno.EPERM:

1986

logger.error("No permission to bind to"

1987

" interface %s", self.interface)

1988

elif error.errno == errno.ENOPROTOOPT:

1989

logger.error("SO_BINDTODEVICE not available;"

1990

" cannot bind to interface %s",

1991

self.interface)

1992

elif error.errno == errno.ENODEV:

1993

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

1994

" cannot bind", self.interface)

1995

else:

1996

raise

2596

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

2597

# common enough.

2598

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

2599

SO_BINDTODEVICE = 25

2600

try:

2601

self.socket.setsockopt(

2602

socket.SOL_SOCKET, SO_BINDTODEVICE,

2603

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

2604

except socket.error as error:

2605

if error.errno == errno.EPERM:

2606

logger.error("No permission to bind to"

2607

" interface %s", self.interface)

2608

elif error.errno == errno.ENOPROTOOPT:

2609

logger.error("SO_BINDTODEVICE not available;"

2610

" cannot bind to interface %s",

2611

self.interface)

2612

elif error.errno == errno.ENODEV:

2613

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

2614

" cannot bind", self.interface)

2615

else:

2616

raise

1997

2617

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

1998

2618

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

1999

2619

if not self.server_address[0]:

2000

2620

if self.address_family == socket.AF_INET6:

2001

any_address = "::" # in6addr_any

2621

any_address = "::" # in6addr_any

2002

2622

else:

2003

any_address = "0.0.0.0" # INADDR_ANY

2623

any_address = "0.0.0.0" # INADDR_ANY

2004

2624

self.server_address = (any_address,

2005

2625

self.server_address[1])

2006

2626

elif not self.server_address[1]:

2007

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

2008

0)

2627

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

2009

2628

# if self.interface:

2010

2629

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

2011

2630

# 0, # port

2017

2636

2018

2637

class MandosServer(IPv6_TCPServer):

2019

2638

"""Mandos server.

2020

2639

2021

2640

Attributes:

2022

2641

clients: set of Client objects

2023

2642

gnutls_priority GnuTLS priority string

2024

2643

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

2025

2026

Assumes a gobject.MainLoop event loop.

2644

2645

Assumes a GLib.MainLoop event loop.

2027

2646

"""

2647

2028

2648

def __init__(self, server_address, RequestHandlerClass,

2029

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

2030

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

2649

interface=None,

2650

use_ipv6=True,

2651

clients=None,

2652

gnutls_priority=None,

2653

use_dbus=True,

2654

socketfd=None):

2031

2655

self.enabled = False

2032

2656

self.clients = clients

2033

2657

if self.clients is None:

2036

2660

self.gnutls_priority = gnutls_priority

2037

2661

IPv6_TCPServer.__init__(self, server_address,

2038

2662

RequestHandlerClass,

2039

interface = interface,

2040

use_ipv6 = use_ipv6,

2041

socketfd = socketfd)

2663

interface=interface,

2664

use_ipv6=use_ipv6,

2665

socketfd=socketfd)

2666

2042

2667

def server_activate(self):

2043

2668

if self.enabled:

2044

2669

return socketserver.TCPServer.server_activate(self)

2045

2670

2046

2671

def enable(self):

2047

2672

self.enabled = True

2048

2673

2049

2674

def add_pipe(self, parent_pipe, proc):

2050

2675

# Call "handle_ipc" for both data and EOF events

2051

gobject.io_add_watch(parent_pipe.fileno(),

2052

gobject.IO_IN | gobject.IO_HUP,

2053

functools.partial(self.handle_ipc,

2054

parent_pipe =

2055

parent_pipe,

2056

proc = proc))

2057

2058

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

2059

proc = None, client_object=None):

2676

GLib.io_add_watch(

2677

parent_pipe.fileno(),

2678

GLib.IO_IN | GLib.IO_HUP,

2679

functools.partial(self.handle_ipc,

2680

parent_pipe=parent_pipe,

2681

proc=proc))

2682

2683

def handle_ipc(self, source, condition,

2684

parent_pipe=None,

2685

proc=None,

2686

client_object=None):

2060

2687

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

2061

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

2688

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

2062

2689

# Wait for other process to exit

2063

2690

proc.join()

2064

2691

return False

2065

2692

2066

2693

# Read a request from the child

2067

2694

request = parent_pipe.recv()

2068

2695

command = request[0]

2069

2696

2070

2697

if command == 'init':

2071

fpr = request[1]

2072

address = request[2]

2073

2074

for c in self.clients.itervalues():

2075

if c.fingerprint == fpr:

2698

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

2699

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

2700

address = request[3]

2701

2702

for c in self.clients.values():

2703

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2704

continue

2705

if key_id and c.key_id == key_id:

2706

client = c

2707

break

2708

if fpr and c.fingerprint == fpr:

2076

2709

client = c

2077

2710

break

2078

2711

else:

2079

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

2080

"dress: %s", fpr, address)

2712

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

2713

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

2081

2714

if self.use_dbus:

2082

2715

# Emit D-Bus signal

2083

mandos_dbus_service.ClientNotFound(fpr,

2716

mandos_dbus_service.ClientNotFound(key_id or fpr,

2084

2717

address[0])

2085

2718

parent_pipe.send(False)

2086

2719

return False

2087

2088

gobject.io_add_watch(parent_pipe.fileno(),

2089

gobject.IO_IN | gobject.IO_HUP,

2090

functools.partial(self.handle_ipc,

2091

parent_pipe =

2092

parent_pipe,

2093

proc = proc,

2094

client_object =

2095

client))

2720

2721

GLib.io_add_watch(

2722

parent_pipe.fileno(),

2723

GLib.IO_IN | GLib.IO_HUP,

2724

functools.partial(self.handle_ipc,

2725

parent_pipe=parent_pipe,

2726

proc=proc,

2727

client_object=client))

2096

2728

parent_pipe.send(True)

2097

2729

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

2098

2730

# same fileno

2101

2733

funcname = request[1]

2102

2734

args = request[2]

2103

2735

kwargs = request[3]

2104

2736

2105

2737

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

2106

2738

funcname)(*args,

2107

**kwargs)))

2108

2739

**kwargs)))

2740

2109

2741

if command == 'getattr':

2110

2742

attrname = request[1]

2111

if callable(client_object.__getattribute__(attrname)):

2112

parent_pipe.send(('function',))

2743

if isinstance(client_object.__getattribute__(attrname),

2744

collections.Callable):

2745

parent_pipe.send(('function', ))

2113

2746

else:

2114

parent_pipe.send(('data', client_object

2115

.__getattribute__(attrname)))

2116

2747

parent_pipe.send((

2748

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

2749

2117

2750

if command == 'setattr':

2118

2751

attrname = request[1]

2119

2752

value = request[2]

2120

2753

setattr(client_object, attrname, value)

2121

2754

2122

2755

return True

2123

2756

2124

2757

2125

2758

def rfc3339_duration_to_delta(duration):

2126

2759

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

2127

2760

2128

2761

>>> rfc3339_duration_to_delta("P7D")

2129

2762

datetime.timedelta(7)

2130

2763

>>> rfc3339_duration_to_delta("PT60S")

2140

2773

>>> rfc3339_duration_to_delta("P1DT3M20S")

2141

2774

datetime.timedelta(1, 200)

2142

2775

"""

2143

2776

2144

2777

# Parsing an RFC 3339 duration with regular expressions is not

2145

2778

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

2146

2779

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

2147

2780

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

2148

2781

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

2149

2782

# avoid excessive use of external libraries.

2150

2783

2151

2784

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

2152

Token = collections.namedtuple("Token",

2153

("regexp", # To match token; if

2154

# "value" is not None,

2155

# must have a "group"

2156

# containing digits

2157

"value", # datetime.timedelta or

2158

# None

2159

"followers")) # Tokens valid after

2160

# this token

2785

Token = collections.namedtuple("Token", (

2786

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

2787

# a "group" containing digits

2788

"value", # datetime.timedelta or None

2789

"followers")) # Tokens valid after this token

2161

2790

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

2162

2791

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

2163

2792

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

2164

2793

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

2165

2794

datetime.timedelta(seconds=1),

2166

frozenset((token_end,)))

2795

frozenset((token_end, )))

2167

2796

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

2168

2797

datetime.timedelta(minutes=1),

2169

2798

frozenset((token_second, token_end)))

2185

2814

frozenset((token_month, token_end)))

2186

2815

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

2187

2816

datetime.timedelta(weeks=1),

2188

frozenset((token_end,)))

2817

frozenset((token_end, )))

2189

2818

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

2190

2819

frozenset((token_year, token_month,

2191

2820

token_day, token_time,

2192

token_week))),

2193

# Define starting values

2194

value = datetime.timedelta() # Value so far

2821

token_week)))

2822

# Define starting values:

2823

# Value so far

2824

value = datetime.timedelta()

2195

2825

found_token = None

2196

followers = frozenset(token_duration,) # Following valid tokens

2197

s = duration # String left to parse

2826

# Following valid tokens

2827

followers = frozenset((token_duration, ))

2828

# String left to parse

2829

s = duration

2198

2830

# Loop until end token is found

2199

2831

while found_token is not token_end:

2200

2832

# Search for any currently valid tokens

2216

2848

break

2217

2849

else:

2218

2850

# No currently valid tokens were found

2219

raise ValueError("Invalid RFC 3339 duration")

2851

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

2852

.format(duration))

2220

2853

# End token found

2221

2854

return value

2222

2855

2223

2856

2224

2857

def string_to_delta(interval):

2225

2858

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

2226

2859

2227

2860

>>> string_to_delta('7d')

2228

2861

datetime.timedelta(7)

2229

2862

>>> string_to_delta('60s')

2237

2870

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

2238

2871

datetime.timedelta(0, 330)

2239

2872

"""

2240

2873

2241

2874

try:

2242

2875

return rfc3339_duration_to_delta(interval)

2243

2876

except ValueError:

2244

2877

pass

2245

2878

2246

2879

timevalue = datetime.timedelta(0)

2247

2880

for s in interval.split():

2248

2881

try:

2249

suffix = unicode(s[-1])

2882

suffix = s[-1]

2250

2883

value = int(s[:-1])

2251

2884

if suffix == "d":

2252

2885

delta = datetime.timedelta(value)

2259

2892

elif suffix == "w":

2260

2893

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

2261

2894

else:

2262

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

2263

.format(suffix))

2895

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

2264

2896

except IndexError as e:

2265

2897

raise ValueError(*(e.args))

2266

2898

timevalue += delta

2267

2899

return timevalue

2268

2900

2269

2901

2270

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

2902

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

2271

2903

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

2272

2904

2273

2905

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

2274

2906

if os.fork():

2275

2907

sys.exit()

2283

2915

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

2284

2916

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

2285

2917

raise OSError(errno.ENODEV,

2286

"{0} not a character device"

2918

"{} not a character device"

2287

2919

.format(os.devnull))

2288

2920

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

2289

2921

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

2293

2925

2294

2926

2295

2927

def main():

2296

2928

2297

2929

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

2298

2930

# Parsing of options, both command line and config file

2299

2931

2300

2932

parser = argparse.ArgumentParser()

2301

2933

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

2302

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

2934

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

2303

2935

help="show version number and exit")

2304

2936

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

2305

2937

help="Bind to interface IF")

2338

2970

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

2339

2971

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

2340

2972

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

2341

2973

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

2974

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

2975

default=None)

2976

2342

2977

options = parser.parse_args()

2343

2978

2344

2979

if options.check:

2345

2980

import doctest

2346

doctest.testmod()

2347

sys.exit()

2348

2981

fail_count, test_count = doctest.testmod()

2982

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

2983

2349

2984

# Default values for config file for server-global settings

2350

server_defaults = { "interface": "",

2351

"address": "",

2352

"port": "",

2353

"debug": "False",

2354

"priority":

2355

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

2356

"servicename": "Mandos",

2357

"use_dbus": "True",

2358

"use_ipv6": "True",

2359

"debuglevel": "",

2360

"restore": "True",

2361

"socket": "",

2362

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

2363

"foreground": "False",

2364

}

2365

2985

if gnutls.has_rawpk:

2986

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

2987

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

2988

else:

2989

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

2990

":+SIGN-DSA-SHA256")

2991

server_defaults = {"interface": "",

2992

"address": "",

2993

"port": "",

2994

"debug": "False",

2995

"priority": priority,

2996

"servicename": "Mandos",

2997

"use_dbus": "True",

2998

"use_ipv6": "True",

2999

"debuglevel": "",

3000

"restore": "True",

3001

"socket": "",

3002

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

3003

"foreground": "False",

3004

"zeroconf": "True",

3005

}

3006

del priority

3007

2366

3008

# Parse config file for server-global settings

2367

3009

server_config = configparser.SafeConfigParser(server_defaults)

2368

3010

del server_defaults

2369

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

2370

"mandos.conf"))

3011

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

2371

3012

# Convert the SafeConfigParser object to a dict

2372

3013

server_settings = server_config.defaults()

2373

3014

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

2374

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

3015

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

3016

"foreground", "zeroconf"):

2375

3017

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

2376

3018

option)

2377

3019

if server_settings["port"]:

2387

3029

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

2388

3030

["socket"])

2389

3031

del server_config

2390

3032

2391

3033

# Override the settings from the config file with command line

2392

3034

# options, if set.

2393

3035

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

2394

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

2395

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

2396

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

3036

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

3037

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

3038

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

2397

3039

value = getattr(options, option)

2398

3040

if value is not None:

2399

3041

server_settings[option] = value

2400

3042

del options

2401

3043

# Force all strings to be unicode

2402

3044

for option in server_settings.keys():

2403

if type(server_settings[option]) is str:

2404

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

3045

if isinstance(server_settings[option], bytes):

3046

server_settings[option] = (server_settings[option]

3047

.decode("utf-8"))

2405

3048

# Force all boolean options to be boolean

2406

3049

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

2407

"foreground"):

3050

"foreground", "zeroconf"):

2408

3051

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

2409

3052

# Debug implies foreground

2410

3053

if server_settings["debug"]:

2411

3054

server_settings["foreground"] = True

2412

3055

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

2413

3056

2414

3057

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

2415

3058

3059

if (not server_settings["zeroconf"]

3060

and not (server_settings["port"]

3061

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

3062

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

3063

2416

3064

# For convenience

2417

3065

debug = server_settings["debug"]

2418

3066

debuglevel = server_settings["debuglevel"]

2421

3069

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

2422

3070

stored_state_file)

2423

3071

foreground = server_settings["foreground"]

2424

3072

zeroconf = server_settings["zeroconf"]

3073

2425

3074

if debug:

2426

3075

initlogger(debug, logging.DEBUG)

2427

3076

else:

2430

3079

else:

2431

3080

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

2432

3081

initlogger(debug, level)

2433

3082

2434

3083

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

2435

syslogger.setFormatter(logging.Formatter

2436

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

2437

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

2438

.format(server_settings

2439

["servicename"])))

2440

3084

syslogger.setFormatter(

3085

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

3086

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

3087

server_settings["servicename"])))

3088

2441

3089

# Parse config file with clients

2442

3090

client_config = configparser.SafeConfigParser(Client

2443

3091

.client_defaults)

2444

3092

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

2445

3093

"clients.conf"))

2446

3094

2447

3095

global mandos_dbus_service

2448

3096

mandos_dbus_service = None

2449

2450

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

2451

server_settings["port"]),

2452

ClientHandler,

2453

interface=(server_settings["interface"]

2454

or None),

2455

use_ipv6=use_ipv6,

2456

gnutls_priority=

2457

server_settings["priority"],

2458

use_dbus=use_dbus,

2459

socketfd=(server_settings["socket"]

2460

or None))

3097

3098

socketfd = None

3099

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

3100

socketfd = server_settings["socket"]

3101

tcp_server = MandosServer(

3102

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

3103

ClientHandler,

3104

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

3105

use_ipv6=use_ipv6,

3106

gnutls_priority=server_settings["priority"],

3107

use_dbus=use_dbus,

3108

socketfd=socketfd)

2461

3109

if not foreground:

2462

3110

pidfilename = "/run/mandos.pid"

2463

3111

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

2464

3112

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

2465

3113

pidfile = None

2466

3114

try:

2467

pidfile = open(pidfilename, "w")

3115

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

2468

3116

except IOError as e:

2469

3117

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

2470

3118

exc_info=e)

2471

2472

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

3119

3120

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

3121

("mandos", "mandos"),

3122

("nobody", "nogroup")):

2473

3123

try:

2474

3124

uid = pwd.getpwnam(name).pw_uid

2475

gid = pwd.getpwnam(name).pw_gid

3125

gid = pwd.getpwnam(group).pw_gid

2476

3126

break

2477

3127

except KeyError:

2478

3128

continue

2482

3132

try:

2483

3133

os.setgid(gid)

2484

3134

os.setuid(uid)

3135

if debug:

3136

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

3137

gid))

2485

3138

except OSError as error:

3139

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

3140

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

2486

3141

if error.errno != errno.EPERM:

2487

3142

raise

2488

3143

2489

3144

if debug:

2490

3145

# Enable all possible GnuTLS debugging

2491

3146

2492

3147

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

2493

3148

# - GnuTLS manual

2494

gnutls.library.functions.gnutls_global_set_log_level(11)

2495

2496

@gnutls.library.types.gnutls_log_func

3149

gnutls.global_set_log_level(11)

3150

3151

@gnutls.log_func

2497

3152

def debug_gnutls(level, string):

2498

3153

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

2499

2500

(gnutls.library.functions

2501

.gnutls_global_set_log_function(debug_gnutls))

2502

3154

3155

gnutls.global_set_log_function(debug_gnutls)

3156

2503

3157

# Redirect stdin so all checkers get /dev/null

2504

3158

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

2505

3159

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

2506

3160

if null > 2:

2507

3161

os.close(null)

2508

3162

2509

3163

# Need to fork before connecting to D-Bus

2510

3164

if not foreground:

2511

3165

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

2512

3166

daemon()

2513

2514

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

2515

# need to inform gobject that threads will be used.

2516

gobject.threads_init()

2517

3167

3168

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

3169

# to inform GLib that threads will be used.

3170

GLib.threads_init()

3171

2518

3172

global main_loop

2519

3173

# From the Avahi example code

2520

3174

DBusGMainLoop(set_as_default=True)

2521

main_loop = gobject.MainLoop()

3175

main_loop = GLib.MainLoop()

2522

3176

bus = dbus.SystemBus()

2523

3177

# End of Avahi example code

2524

3178

if use_dbus:

2525

3179

try:

2526

3180

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

2527

bus, do_not_queue=True)

2528

old_bus_name = (dbus.service.BusName

2529

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

2530

do_not_queue=True))

2531

except dbus.exceptions.NameExistsException as e:

3181

bus,

3182

do_not_queue=True)

3183

old_bus_name = dbus.service.BusName(

3184

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

3185

do_not_queue=True)

3186

except dbus.exceptions.DBusException as e:

2532

3187

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

2533

3188

use_dbus = False

2534

3189

server_settings["use_dbus"] = False

2535

3190

tcp_server.use_dbus = False

2536

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2537

service = AvahiServiceToSyslog(name =

2538

server_settings["servicename"],

2539

servicetype = "_mandos._tcp",

2540

protocol = protocol, bus = bus)

2541

if server_settings["interface"]:

2542

service.interface = (if_nametoindex

2543

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

2544

3191

if zeroconf:

3192

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3193

service = AvahiServiceToSyslog(

3194

name=server_settings["servicename"],

3195

servicetype="_mandos._tcp",

3196

protocol=protocol,

3197

bus=bus)

3198

if server_settings["interface"]:

3199

service.interface = if_nametoindex(

3200

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

3201

2545

3202

global multiprocessing_manager

2546

3203

multiprocessing_manager = multiprocessing.Manager()

2547

3204

2548

3205

client_class = Client

2549

3206

if use_dbus:

2550

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

2551

3207

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

3208

2552

3209

client_settings = Client.config_parser(client_config)

2553

3210

old_client_settings = {}

2554

3211

clients_data = {}

2555

3212

2556

3213

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

2557

3214

global wnull

2558

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

3215

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

2559

3216

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

2560

3217

# mode

2561

3218

if debug or not foreground:

2562

3219

wnull.close()

2563

3220

2564

3221

# Get client data and settings from last running state.

2565

3222

if server_settings["restore"]:

2566

3223

try:

2567

3224

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

2568

clients_data, old_client_settings = (pickle.load

2569

(stored_state))

3225

if sys.version_info.major == 2:

3226

clients_data, old_client_settings = pickle.load(

3227

stored_state)

3228

else:

3229

bytes_clients_data, bytes_old_client_settings = (

3230

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

3231

# Fix bytes to strings

3232

# clients_data

3233

# .keys()

3234

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

3235

if isinstance(key, bytes)

3236

else key): value

3237

for key, value in

3238

bytes_clients_data.items()}

3239

del bytes_clients_data

3240

for key in clients_data:

3241

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

3242

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

3243

for k, v in

3244

clients_data[key].items()}

3245

clients_data[key] = value

3246

# .client_structure

3247

value["client_structure"] = [

3248

(s.decode("utf-8")

3249

if isinstance(s, bytes)

3250

else s) for s in

3251

value["client_structure"]]

3252

# .name & .host

3253

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

3254

if isinstance(value[k], bytes):

3255

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

3256

if not value.has_key("key_id"):

3257

value["key_id"] = ""

3258

elif not value.has_key("fingerprint"):

3259

value["fingerprint"] = ""

3260

# old_client_settings

3261

# .keys()

3262

old_client_settings = {

3263

(key.decode("utf-8")

3264

if isinstance(key, bytes)

3265

else key): value

3266

for key, value in

3267

bytes_old_client_settings.items()}

3268

del bytes_old_client_settings

3269

# .host

3270

for value in old_client_settings.values():

3271

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

3272

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

3273

.decode("utf-8"))

2570

3274

os.remove(stored_state_path)

2571

3275

except IOError as e:

2572

3276

if e.errno == errno.ENOENT:

2573

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

2574

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

3277

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

3278

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

2575

3279

else:

2576

3280

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

2577

3281

exc_info=e)

2578

3282

raise

2579

3283

except EOFError as e:

2580

3284

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

2581

"EOFError:", exc_info=e)

2582

3285

"EOFError:",

3286

exc_info=e)

3287

2583

3288

with PGPEngine() as pgp:

2584

for client_name, client in clients_data.iteritems():

3289

for client_name, client in clients_data.items():

2585

3290

# Skip removed clients

2586

3291

if client_name not in client_settings:

2587

3292

continue

2588

3293

2589

3294

# Decide which value to use after restoring saved state.

2590

3295

# We have three different values: Old config file,

2591

3296

# new config file, and saved state.

2596

3301

# For each value in new config, check if it

2597

3302

# differs from the old config value (Except for

2598

3303

# the "secret" attribute)

2599

if (name != "secret" and

2600

value != old_client_settings[client_name]

2601

[name]):

3304

if (name != "secret"

3305

and (value !=

3306

old_client_settings[client_name][name])):

2602

3307

client[name] = value

2603

3308

except KeyError:

2604

3309

pass

2605

3310

2606

3311

# Clients who has passed its expire date can still be

2607

# enabled if its last checker was successful. Clients

3312

# enabled if its last checker was successful. A Client

2608

3313

# whose checker succeeded before we stored its state is

2609

3314

# assumed to have successfully run all checkers during

2610

3315

# downtime.

2612

3317

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

2613

3318

if not client["last_checked_ok"]:

2614

3319

logger.warning(

2615

"disabling client {0} - Client never "

2616

"performed a successful checker"

2617

.format(client_name))

3320

"disabling client {} - Client never "

3321

"performed a successful checker".format(

3322

client_name))

2618

3323

client["enabled"] = False

2619

3324

elif client["last_checker_status"] != 0:

2620

3325

logger.warning(

2621

"disabling client {0} - Client "

2622

"last checker failed with error code {1}"

2623

.format(client_name,

2624

client["last_checker_status"]))

3326

"disabling client {} - Client last"

3327

" checker failed with error code"

3328

" {}".format(

3329

client_name,

3330

client["last_checker_status"]))

2625

3331

client["enabled"] = False

2626

3332

else:

2627

client["expires"] = (datetime.datetime

2628

.utcnow()

2629

+ client["timeout"])

3333

client["expires"] = (

3334

datetime.datetime.utcnow()

3335

+ client["timeout"])

2630

3336

logger.debug("Last checker succeeded,"

2631

" keeping {0} enabled"

2632

.format(client_name))

3337

" keeping {} enabled".format(

3338

client_name))

2633

3339

try:

2634

client["secret"] = (

2635

pgp.decrypt(client["encrypted_secret"],

2636

client_settings[client_name]

2637

["secret"]))

3340

client["secret"] = pgp.decrypt(

3341

client["encrypted_secret"],

3342

client_settings[client_name]["secret"])

2638

3343

except PGPError:

2639

3344

# If decryption fails, we use secret from new settings

2640

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

2641

.format(client_name))

2642

client["secret"] = (

2643

client_settings[client_name]["secret"])

2644

3345

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

3346

client_name))

3347

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

3348

["secret"])

3349

2645

3350

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

2646

3351

for client_name in (set(old_client_settings)

2647

3352

- set(client_settings)):

2649

3354

for client_name in (set(client_settings)

2650

3355

- set(old_client_settings)):

2651

3356

clients_data[client_name] = client_settings[client_name]

2652

3357

2653

3358

# Create all client objects

2654

for client_name, client in clients_data.iteritems():

3359

for client_name, client in clients_data.items():

2655

3360

tcp_server.clients[client_name] = client_class(

2656

name = client_name, settings = client,

2657

server_settings = server_settings)

2658

3361

name=client_name,

3362

settings=client,

3363

server_settings=server_settings)

3364

2659

3365

if not tcp_server.clients:

2660

3366

logger.warning("No clients defined")

2661

3367

2662

3368

if not foreground:

2663

3369

if pidfile is not None:

3370

pid = os.getpid()

2664

3371

try:

2665

3372

with pidfile:

2666

pid = os.getpid()

2667

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

3373

print(pid, file=pidfile)

2668

3374

except IOError:

2669

3375

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

2670

3376

pidfilename, pid)

2671

3377

del pidfile

2672

3378

del pidfilename

2673

2674

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

2675

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

2676

3379

3380

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

3381

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3382

lambda: main_loop.quit() and False)

3383

2677

3384

if use_dbus:

2678

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

2679

"se.bsnet.fukt.Mandos"})

2680

class MandosDBusService(DBusObjectWithProperties):

3385

3386

@alternate_dbus_interfaces(

3387

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

3388

class MandosDBusService(DBusObjectWithObjectManager):

2681

3389

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

3390

2682

3391

def __init__(self):

2683

3392

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

3393

2684

3394

_interface = "se.recompile.Mandos"

2685

2686

@dbus_interface_annotations(_interface)

2687

def _foo(self):

2688

return { "org.freedesktop.DBus.Property"

2689

".EmitsChangedSignal":

2690

"false"}

2691

3395

2692

3396

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

2693

3397

def ClientAdded(self, objpath):

2694

3398

"D-Bus signal"

2695

3399

pass

2696

3400

2697

3401

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

2698

def ClientNotFound(self, fingerprint, address):

3402

def ClientNotFound(self, key_id, address):

2699

3403

"D-Bus signal"

2700

3404

pass

2701

3405

3406

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

3407

"true"})

2702

3408

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

2703

3409

def ClientRemoved(self, objpath, name):

2704

3410

"D-Bus signal"

2705

3411

pass

2706

3412

3413

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

3414

"true"})

2707

3415

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

2708

3416

def GetAllClients(self):

2709

3417

"D-Bus method"

2710

return dbus.Array(c.dbus_object_path

2711

for c in

2712

tcp_server.clients.itervalues())

2713

3418

return dbus.Array(c.dbus_object_path for c in

3419

tcp_server.clients.values())

3420

3421

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

3422

"true"})

2714

3423

@dbus.service.method(_interface,

2715

3424

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

2716

3425

def GetAllClientsWithProperties(self):

2717

3426

"D-Bus method"

2718

3427

return dbus.Dictionary(

2719

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

2720

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

3428

{c.dbus_object_path: c.GetAll(

3429

"se.recompile.Mandos.Client")

3430

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

2721

3431

signature="oa{sv}")

2722

3432

2723

3433

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

2724

3434

def RemoveClient(self, object_path):

2725

3435

"D-Bus method"

2726

for c in tcp_server.clients.itervalues():

3436

for c in tcp_server.clients.values():

2727

3437

if c.dbus_object_path == object_path:

2728

3438

del tcp_server.clients[c.name]

2729

3439

c.remove_from_connection()

2730

# Don't signal anything except ClientRemoved

3440

# Don't signal the disabling

2731

3441

c.disable(quiet=True)

2732

# Emit D-Bus signal

2733

self.ClientRemoved(object_path, c.name)

3442

# Emit D-Bus signal for removal

3443

self.client_removed_signal(c)

2734

3444

return

2735

3445

raise KeyError(object_path)

2736

3446

2737

3447

del _interface

2738

3448

3449

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3450

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

3451

def GetManagedObjects(self):

3452

"""D-Bus method"""

3453

return dbus.Dictionary(

3454

{client.dbus_object_path:

3455

dbus.Dictionary(

3456

{interface: client.GetAll(interface)

3457

for interface in

3458

client._get_all_interface_names()})

3459

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

3460

3461

def client_added_signal(self, client):

3462

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

3463

if use_dbus:

3464

# New standard signal

3465

self.InterfacesAdded(

3466

client.dbus_object_path,

3467

dbus.Dictionary(

3468

{interface: client.GetAll(interface)

3469

for interface in

3470

client._get_all_interface_names()}))

3471

# Old signal

3472

self.ClientAdded(client.dbus_object_path)

3473

3474

def client_removed_signal(self, client):

3475

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

3476

if use_dbus:

3477

# New standard signal

3478

self.InterfacesRemoved(

3479

client.dbus_object_path,

3480

client._get_all_interface_names())

3481

# Old signal

3482

self.ClientRemoved(client.dbus_object_path,

3483

client.name)

3484

2739

3485

mandos_dbus_service = MandosDBusService()

2740

3486

3487

# Save modules to variables to exempt the modules from being

3488

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

3489

mp = multiprocessing

3490

wn = wnull

3491

2741

3492

def cleanup():

2742

3493

"Cleanup function; run on exit"

2743

service.cleanup()

2744

2745

multiprocessing.active_children()

2746

wnull.close()

3494

if zeroconf:

3495

service.cleanup()

3496

3497

mp.active_children()

3498

wn.close()

2747

3499

if not (tcp_server.clients or client_settings):

2748

3500

return

2749

3501

2750

3502

# Store client before exiting. Secrets are encrypted with key

2751

3503

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

2752

3504

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

2753

3505

clients = {}

2754

3506

with PGPEngine() as pgp:

2755

for client in tcp_server.clients.itervalues():

3507

for client in tcp_server.clients.values():

2756

3508

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

2757

3509

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

2758

3510

key)

2759

3511

client_dict = {}

2760

3512

2761

3513

# A list of attributes that can not be pickled

2762

3514

# + secret.

2763

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

2764

"checker", "server_settings"))

2765

for name, typ in (inspect.getmembers

2766

(dbus.service.Object)):

3515

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

3516

"checker", "server_settings"}

3517

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

3518

.Object):

2767

3519

exclude.add(name)

2768

3520

2769

3521

client_dict["encrypted_secret"] = (client

2770

3522

.encrypted_secret)

2771

3523

for attr in client.client_structure:

2772

3524

if attr not in exclude:

2773

3525

client_dict[attr] = getattr(client, attr)

2774

3526

2775

3527

clients[client.name] = client_dict

2776

3528

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

2777

3529

2778

3530

try:

2779

with (tempfile.NamedTemporaryFile

2780

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

2781

dir=os.path.dirname(stored_state_path),

2782

delete=False)) as stored_state:

2783

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

2784

tempname=stored_state.name

3531

with tempfile.NamedTemporaryFile(

3532

mode='wb',

3533

suffix=".pickle",

3534

prefix='clients-',

3535

dir=os.path.dirname(stored_state_path),

3536

delete=False) as stored_state:

3537

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

3538

protocol=2)

3539

tempname = stored_state.name

2785

3540

os.rename(tempname, stored_state_path)

2786

3541

except (IOError, OSError) as e:

2787

3542

if not debug:

2790

3545

except NameError:

2791

3546

pass

2792

3547

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

2793

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

3548

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

2794

3549

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

2795

3550

else:

2796

3551

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

2797

3552

exc_info=e)

2798

3553

raise

2799

3554

2800

3555

# Delete all clients, and settings from config

2801

3556

while tcp_server.clients:

2802

3557

name, client = tcp_server.clients.popitem()

2803

3558

if use_dbus:

2804

3559

client.remove_from_connection()

2805

# Don't signal anything except ClientRemoved

3560

# Don't signal the disabling

2806

3561

client.disable(quiet=True)

3562

# Emit D-Bus signal for removal

2807

3563

if use_dbus:

2808

# Emit D-Bus signal

2809

mandos_dbus_service.ClientRemoved(client

2810

.dbus_object_path,

2811

client.name)

3564

mandos_dbus_service.client_removed_signal(client)

2812

3565

client_settings.clear()

2813

3566

2814

3567

atexit.register(cleanup)

2815

2816

for client in tcp_server.clients.itervalues():

3568

3569

for client in tcp_server.clients.values():

2817

3570

if use_dbus:

2818

# Emit D-Bus signal

2819

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3571

# Emit D-Bus signal for adding

3572

mandos_dbus_service.client_added_signal(client)

2820

3573

# Need to initiate checking of clients

2821

3574

if client.enabled:

2822

3575

client.init_checker()

2823

3576

2824

3577

tcp_server.enable()

2825

3578

tcp_server.server_activate()

2826

3579

2827

3580

# Find out what port we got

2828

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

3581

if zeroconf:

3582

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

2829

3583

if use_ipv6:

2830

3584

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

2831

3585

" flowinfo %d, scope_id %d",

2833

3587

else: # IPv4

2834

3588

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

2835

3589

*tcp_server.socket.getsockname())

2836

2837

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

2838

3590

3591

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

3592

2839

3593

try:

2840

# From the Avahi example code

2841

try:

2842

service.activate()

2843

except dbus.exceptions.DBusException as error:

2844

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

2845

cleanup()

2846

sys.exit(1)

2847

# End of Avahi example code

2848

2849

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

2850

lambda *args, **kwargs:

2851

(tcp_server.handle_request

2852

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

2853

3594

if zeroconf:

3595

# From the Avahi example code

3596

try:

3597

service.activate()

3598

except dbus.exceptions.DBusException as error:

3599

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

3600

cleanup()

3601

sys.exit(1)

3602

# End of Avahi example code

3603

3604

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

3605

lambda *args, **kwargs:

3606

(tcp_server.handle_request

3607

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

3608

2854

3609

logger.debug("Starting main loop")

2855

3610

main_loop.run()

2856

3611

except AvahiError as error:

2865

3620

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

2866

3621

cleanup()

2867

3622

3623

2868

3624

if __name__ == '__main__':

2869

3625

main()