/mandos/trunk : revision 1121

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

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.8.4"

92

119

stored_state_file = "clients.pickle"

93

120

94

121

logger = logging.getLogger()

95

122

syslogger = None

96

123

97

124

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

101

127

except (OSError, AttributeError):

128

102

129

def if_nametoindex(interface):

103

130

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

104

131

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

105

132

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

106

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

134

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

135

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

111

136

return interface_index

112

137

113

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

114

155

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

115

156

"""init logger and add loglevel"""

116

157

117

158

global syslogger

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

122

162

syslogger.setFormatter(logging.Formatter

123

163

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

124

164

' %(message)s'))

125

165

logger.addHandler(syslogger)

126

166

127

167

if debug:

128

168

console = logging.StreamHandler()

129

169

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

141

181

142

182

class PGPEngine(object):

143

183

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

184

144

185

def __init__(self):

145

186

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

146

198

self.gnupgargs = ['--batch',

147

'--home', self.tempdir,

199

'--homedir', self.tempdir,

148

200

'--force-mdc',

149

'--quiet',

150

'--no-use-agent']

151

201

'--quiet']

202

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

203

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

204

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

205

152

206

def __enter__(self):

153

207

return self

154

208

155

209

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

156

210

self._cleanup()

157

211

return False

158

212

159

213

def __del__(self):

160

214

self._cleanup()

161

215

162

216

def _cleanup(self):

163

217

if self.tempdir is not None:

164

218

# Delete contents of tempdir

165

219

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

166

topdown = False):

220

topdown=False):

167

221

for filename in files:

168

222

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

169

223

for dirname in dirs:

171

225

# Remove tempdir

172

226

os.rmdir(self.tempdir)

173

227

self.tempdir = None

174

228

175

229

def password_encode(self, password):

176

230

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

177

231

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

182

236

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

183

237

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

184

238

return encoded

185

239

186

240

def encrypt(self, data, password):

187

241

passphrase = self.password_encode(password)

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

190

244

passfile.write(passphrase)

191

245

passfile.flush()

192

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

246

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

193

247

'--passphrase-file',

194

248

passfile.name]

195

249

+ self.gnupgargs,

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

200

254

if proc.returncode != 0:

201

255

raise PGPError(err)

202

256

return ciphertext

203

257

204

258

def decrypt(self, data, password):

205

259

passphrase = self.password_encode(password)

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

208

262

passfile.write(passphrase)

209

263

passfile.flush()

210

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

264

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

211

265

'--passphrase-file',

212

266

passfile.name]

213

267

+ self.gnupgargs,

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

219

272

if proc.returncode != 0:

220

273

raise PGPError(err)

221

274

return decrypted_plaintext

222

275

223

276

277

# Pretend that we have an Avahi module

278

class avahi(object):

279

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

280

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

281

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

282

PROTO_INET = 0 # avahi-common/address.h

283

PROTO_INET6 = 1 # avahi-common/address.h

284

DBUS_NAME = "org.freedesktop.Avahi"

285

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

286

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

287

DBUS_PATH_SERVER = "/"

288

289

@staticmethod

290

def string_array_to_txt_array(t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

302

224

303

class AvahiError(Exception):

225

304

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

226

305

self.value = value

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

306

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

307

**kwargs)

308

230

309

231

310

class AvahiServiceError(AvahiError):

232

311

pass

233

312

313

234

314

class AvahiGroupError(AvahiError):

235

315

pass

236

316

237

317

238

318

class AvahiService(object):

239

319

"""An Avahi (Zeroconf) service.

240

320

241

321

Attributes:

242

322

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

243

323

Used to optionally bind to the specified interface.

255

335

server: D-Bus Server

256

336

bus: dbus.SystemBus()

257

337

"""

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

338

339

def __init__(self,

340

interface=avahi.IF_UNSPEC,

341

name=None,

342

servicetype=None,

343

port=None,

344

TXT=None,

345

domain="",

346

host="",

347

max_renames=32768,

348

protocol=avahi.PROTO_UNSPEC,

349

bus=None):

263

350

self.interface = interface

264

351

self.name = name

265

352

self.type = servicetype

274

361

self.server = None

275

362

self.bus = bus

276

363

self.entry_group_state_changed_match = None

277

278

def rename(self):

364

365

def rename(self, remove=True):

279

366

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

280

367

if self.rename_count >= self.max_renames:

281

368

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

282

369

" after %i retries, exiting.",

283

370

self.rename_count)

284

371

raise AvahiServiceError("Too many renames")

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

287

375

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

288

376

self.name)

289

self.remove()

377

if remove:

378

self.remove()

290

379

try:

291

380

self.add()

292

381

except dbus.exceptions.DBusException as error:

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

382

if (error.get_dbus_name()

383

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

384

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

385

return self.rename(remove=False)

386

else:

387

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

388

self.cleanup()

389

os._exit(1)

390

298

391

def remove(self):

299

392

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

300

393

if self.entry_group_state_changed_match is not None:

302

395

self.entry_group_state_changed_match = None

303

396

if self.group is not None:

304

397

self.group.Reset()

305

398

306

399

def add(self):

307

400

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

308

401

self.remove()

325

418

dbus.UInt16(self.port),

326

419

avahi.string_array_to_txt_array(self.TXT))

327

420

self.group.Commit()

328

421

329

422

def entry_group_state_changed(self, state, error):

330

423

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

331

424

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

332

425

333

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

334

427

logger.debug("Zeroconf service established.")

335

428

elif state == avahi.ENTRY_GROUP_COLLISION:

337

430

self.rename()

338

431

elif state == avahi.ENTRY_GROUP_FAILURE:

339

432

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

340

unicode(error))

341

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

342

.format(error))

343

433

str(error))

434

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

435

344

436

def cleanup(self):

345

437

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

346

438

if self.group is not None:

351

443

pass

352

444

self.group = None

353

445

self.remove()

354

446

355

447

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

356

448

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

357

449

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

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"Zeroconf server failure" }

450

bad_states = {

451

avahi.SERVER_INVALID: "Zeroconf server invalid",

452

avahi.SERVER_REGISTERING: None,

453

avahi.SERVER_COLLISION: "Zeroconf server name collision",

454

avahi.SERVER_FAILURE: "Zeroconf server failure",

455

}

365

456

if state in bad_states:

366

457

if bad_states[state] is not None:

367

458

if error is None:

370

461

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

371

462

self.cleanup()

372

463

elif state == avahi.SERVER_RUNNING:

373

self.add()

464

try:

465

self.add()

466

except dbus.exceptions.DBusException as error:

467

if (error.get_dbus_name()

468

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

469

logger.info("Local Zeroconf service name"

470

" collision.")

471

return self.rename(remove=False)

472

else:

473

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

474

self.cleanup()

475

os._exit(1)

374

476

else:

375

477

if error is None:

376

478

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

377

479

else:

378

480

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

379

481

380

482

def activate(self):

381

483

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

382

484

if self.server is None:

386

488

follow_name_owner_changes=True),

387

489

avahi.DBUS_INTERFACE_SERVER)

388

490

self.server.connect_to_signal("StateChanged",

389

self.server_state_changed)

491

self.server_state_changed)

390

492

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

391

493

392

494

393

495

class AvahiServiceToSyslog(AvahiService):

394

def rename(self):

496

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

395

497

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

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

.format(self.name)))

498

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

499

syslogger.setFormatter(logging.Formatter(

500

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

501

.format(self.name)))

401

502

return ret

402

503

403

504

404

def timedelta_to_milliseconds(td):

405

"Convert a datetime.timedelta() to milliseconds"

406

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

407

+ (td.seconds * 1000)

408

+ (td.microseconds // 1000))

505

# Pretend that we have a GnuTLS module

506

class gnutls(object):

507

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

508

509

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

510

if library is None:

511

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

512

_library = ctypes.cdll.LoadLibrary(library)

513

del library

514

515

# Unless otherwise indicated, the constants and types below are

516

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

517

518

# Constants

519

E_SUCCESS = 0

520

E_INTERRUPTED = -52

521

E_AGAIN = -28

522

CRT_OPENPGP = 2

523

CRT_RAWPK = 3

524

CLIENT = 2

525

SHUT_RDWR = 0

526

CRD_CERTIFICATE = 1

527

E_NO_CERTIFICATE_FOUND = -49

528

X509_FMT_DER = 0

529

NO_TICKETS = 1<<10

530

ENABLE_RAWPK = 1<<18

531

CTYPE_PEERS = 3

532

KEYID_USE_SHA256 = 1 # gnutls/x509.h

533

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

534

535

# Types

536

class session_int(ctypes.Structure):

537

_fields_ = []

538

session_t = ctypes.POINTER(session_int)

539

540

class certificate_credentials_st(ctypes.Structure):

541

_fields_ = []

542

certificate_credentials_t = ctypes.POINTER(

543

certificate_credentials_st)

544

certificate_type_t = ctypes.c_int

545

546

class datum_t(ctypes.Structure):

547

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

548

('size', ctypes.c_uint)]

549

550

class openpgp_crt_int(ctypes.Structure):

551

_fields_ = []

552

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

553

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

554

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

555

credentials_type_t = ctypes.c_int

556

transport_ptr_t = ctypes.c_void_p

557

close_request_t = ctypes.c_int

558

559

# Exceptions

560

class Error(Exception):

561

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

562

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

563

# code is passed, convert it to a string with

564

# gnutls.strerror()

565

self.code = code

566

if message is None and code is not None:

567

message = gnutls.strerror(code)

568

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

569

message, *args)

570

571

class CertificateSecurityError(Error):

572

pass

573

574

# Classes

575

class Credentials(object):

576

def __init__(self):

577

self._c_object = gnutls.certificate_credentials_t()

578

gnutls.certificate_allocate_credentials(

579

ctypes.byref(self._c_object))

580

self.type = gnutls.CRD_CERTIFICATE

581

582

def __del__(self):

583

gnutls.certificate_free_credentials(self._c_object)

584

585

class ClientSession(object):

586

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

587

self._c_object = gnutls.session_t()

588

gnutls_flags = gnutls.CLIENT

589

if gnutls.check_version("3.5.6"):

590

gnutls_flags |= gnutls.NO_TICKETS

591

if gnutls.has_rawpk:

592

gnutls_flags |= gnutls.ENABLE_RAWPK

593

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

594

del gnutls_flags

595

gnutls.set_default_priority(self._c_object)

596

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

597

gnutls.handshake_set_private_extensions(self._c_object,

598

True)

599

self.socket = socket

600

if credentials is None:

601

credentials = gnutls.Credentials()

602

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

603

ctypes.cast(credentials._c_object,

604

ctypes.c_void_p))

605

self.credentials = credentials

606

607

def __del__(self):

608

gnutls.deinit(self._c_object)

609

610

def handshake(self):

611

return gnutls.handshake(self._c_object)

612

613

def send(self, data):

614

data = bytes(data)

615

data_len = len(data)

616

while data_len > 0:

617

data_len -= gnutls.record_send(self._c_object,

618

data[-data_len:],

619

data_len)

620

621

def bye(self):

622

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

623

624

# Error handling functions

625

def _error_code(result):

626

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

627

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

628

if result >= 0:

629

return result

630

if result == gnutls.E_NO_CERTIFICATE_FOUND:

631

raise gnutls.CertificateSecurityError(code=result)

632

raise gnutls.Error(code=result)

633

634

def _retry_on_error(result, func, arguments):

635

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

636

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

637

while result < 0:

638

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

639

return _error_code(result)

640

result = func(*arguments)

641

return result

642

643

# Unless otherwise indicated, the function declarations below are

644

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

645

646

# Functions

647

priority_set_direct = _library.gnutls_priority_set_direct

648

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

649

ctypes.POINTER(ctypes.c_char_p)]

650

priority_set_direct.restype = _error_code

651

652

init = _library.gnutls_init

653

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

654

init.restype = _error_code

655

656

set_default_priority = _library.gnutls_set_default_priority

657

set_default_priority.argtypes = [session_t]

658

set_default_priority.restype = _error_code

659

660

record_send = _library.gnutls_record_send

661

record_send.argtypes = [session_t, ctypes.c_void_p,

662

ctypes.c_size_t]

663

record_send.restype = ctypes.c_ssize_t

664

record_send.errcheck = _retry_on_error

665

666

certificate_allocate_credentials = (

667

_library.gnutls_certificate_allocate_credentials)

668

certificate_allocate_credentials.argtypes = [

669

ctypes.POINTER(certificate_credentials_t)]

670

certificate_allocate_credentials.restype = _error_code

671

672

certificate_free_credentials = (

673

_library.gnutls_certificate_free_credentials)

674

certificate_free_credentials.argtypes = [

675

certificate_credentials_t]

676

certificate_free_credentials.restype = None

677

678

handshake_set_private_extensions = (

679

_library.gnutls_handshake_set_private_extensions)

680

handshake_set_private_extensions.argtypes = [session_t,

681

ctypes.c_int]

682

handshake_set_private_extensions.restype = None

683

684

credentials_set = _library.gnutls_credentials_set

685

credentials_set.argtypes = [session_t, credentials_type_t,

686

ctypes.c_void_p]

687

credentials_set.restype = _error_code

688

689

strerror = _library.gnutls_strerror

690

strerror.argtypes = [ctypes.c_int]

691

strerror.restype = ctypes.c_char_p

692

693

certificate_type_get = _library.gnutls_certificate_type_get

694

certificate_type_get.argtypes = [session_t]

695

certificate_type_get.restype = _error_code

696

697

certificate_get_peers = _library.gnutls_certificate_get_peers

698

certificate_get_peers.argtypes = [session_t,

699

ctypes.POINTER(ctypes.c_uint)]

700

certificate_get_peers.restype = ctypes.POINTER(datum_t)

701

702

global_set_log_level = _library.gnutls_global_set_log_level

703

global_set_log_level.argtypes = [ctypes.c_int]

704

global_set_log_level.restype = None

705

706

global_set_log_function = _library.gnutls_global_set_log_function

707

global_set_log_function.argtypes = [log_func]

708

global_set_log_function.restype = None

709

710

deinit = _library.gnutls_deinit

711

deinit.argtypes = [session_t]

712

deinit.restype = None

713

714

handshake = _library.gnutls_handshake

715

handshake.argtypes = [session_t]

716

handshake.restype = _error_code

717

handshake.errcheck = _retry_on_error

718

719

transport_set_ptr = _library.gnutls_transport_set_ptr

720

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

721

transport_set_ptr.restype = None

722

723

bye = _library.gnutls_bye

724

bye.argtypes = [session_t, close_request_t]

725

bye.restype = _error_code

726

bye.errcheck = _retry_on_error

727

728

check_version = _library.gnutls_check_version

729

check_version.argtypes = [ctypes.c_char_p]

730

check_version.restype = ctypes.c_char_p

731

732

_need_version = b"3.3.0"

733

if check_version(_need_version) is None:

734

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

735

.format(_need_version))

736

737

_tls_rawpk_version = b"3.6.6"

738

has_rawpk = bool(check_version(_tls_rawpk_version))

739

740

if has_rawpk:

741

# Types

742

class pubkey_st(ctypes.Structure):

743

_fields = []

744

pubkey_t = ctypes.POINTER(pubkey_st)

745

746

x509_crt_fmt_t = ctypes.c_int

747

748

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

749

pubkey_init = _library.gnutls_pubkey_init

750

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

751

pubkey_init.restype = _error_code

752

753

pubkey_import = _library.gnutls_pubkey_import

754

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

755

x509_crt_fmt_t]

756

pubkey_import.restype = _error_code

757

758

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

759

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

760

ctypes.POINTER(ctypes.c_ubyte),

761

ctypes.POINTER(ctypes.c_size_t)]

762

pubkey_get_key_id.restype = _error_code

763

764

pubkey_deinit = _library.gnutls_pubkey_deinit

765

pubkey_deinit.argtypes = [pubkey_t]

766

pubkey_deinit.restype = None

767

else:

768

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

769

770

openpgp_crt_init = _library.gnutls_openpgp_crt_init

771

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

772

openpgp_crt_init.restype = _error_code

773

774

openpgp_crt_import = _library.gnutls_openpgp_crt_import

775

openpgp_crt_import.argtypes = [openpgp_crt_t,

776

ctypes.POINTER(datum_t),

777

openpgp_crt_fmt_t]

778

openpgp_crt_import.restype = _error_code

779

780

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

781

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

782

ctypes.POINTER(ctypes.c_uint)]

783

openpgp_crt_verify_self.restype = _error_code

784

785

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

786

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

787

openpgp_crt_deinit.restype = None

788

789

openpgp_crt_get_fingerprint = (

790

_library.gnutls_openpgp_crt_get_fingerprint)

791

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

792

ctypes.c_void_p,

793

ctypes.POINTER(

794

ctypes.c_size_t)]

795

openpgp_crt_get_fingerprint.restype = _error_code

796

797

if check_version("3.6.4"):

798

certificate_type_get2 = _library.gnutls_certificate_type_get2

799

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

800

certificate_type_get2.restype = _error_code

801

802

# Remove non-public functions

803

del _error_code, _retry_on_error

804

805

806

def call_pipe(connection, # : multiprocessing.Connection

807

func, *args, **kwargs):

808

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

809

810

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

811

return value on the provided multiprocessing.Connection.

812

"""

813

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

814

connection.close()

409

815

410

816

411

817

class Client(object):

412

818

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

413

819

414

820

Attributes:

415

821

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

416

822

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

418

824

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

419

825

to see if the client lives.

420

826

'None' if no process is running.

421

checker_callback_tag: a gobject event source tag, or None

827

checker_callback_tag: a GLib event source tag, or None

422

828

checker_command: string; External command which is run to check

423

829

if client lives. %() expansions are done at

424

830

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

425

831

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

426

checker_initiator_tag: a gobject event source tag, or None

832

checker_initiator_tag: a GLib event source tag, or None

427

833

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

428

834

client_structure: Object describing what attributes a client has

429

835

and is used for storing the client at exit

430

836

current_checker_command: string; current running checker_command

431

disable_initiator_tag: a gobject event source tag, or None

837

disable_initiator_tag: a GLib event source tag, or None

432

838

enabled: bool()

433

839

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

434

uniquely identify the client

840

uniquely identify an OpenPGP client

841

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

842

a client using raw public keys

435

843

host: string; available for use by the checker command

436

844

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

437

845

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

439

847

last_checker_status: integer between 0 and 255 reflecting exit

440

848

status of last checker. -1 reflects crashed

441

849

checker, -2 means no checker completed yet.

850

last_checker_signal: The signal which killed the last checker, if

851

last_checker_status is -1

442

852

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

443

853

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

444

854

D-Bus identifiers

451

861

disabled, or None

452

862

server_settings: The server_settings dict from main()

453

863

"""

454

864

455

865

runtime_expansions = ("approval_delay", "approval_duration",

456

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

866

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

457

867

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

458

868

"last_approval_request", "last_checked_ok",

459

869

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

460

client_defaults = { "timeout": "PT5M",

461

"extended_timeout": "PT15M",

462

"interval": "PT2M",

463

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

464

"host": "",

465

"approval_delay": "PT0S",

466

"approval_duration": "PT1S",

467

"approved_by_default": "True",

468

"enabled": "True",

469

}

470

471

def timeout_milliseconds(self):

472

"Return the 'timeout' attribute in milliseconds"

473

return timedelta_to_milliseconds(self.timeout)

474

475

def extended_timeout_milliseconds(self):

476

"Return the 'extended_timeout' attribute in milliseconds"

477

return timedelta_to_milliseconds(self.extended_timeout)

478

479

def interval_milliseconds(self):

480

"Return the 'interval' attribute in milliseconds"

481

return timedelta_to_milliseconds(self.interval)

482

483

def approval_delay_milliseconds(self):

484

return timedelta_to_milliseconds(self.approval_delay)

485

870

client_defaults = {

871

"timeout": "PT5M",

872

"extended_timeout": "PT15M",

873

"interval": "PT2M",

874

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

875

"host": "",

876

"approval_delay": "PT0S",

877

"approval_duration": "PT1S",

878

"approved_by_default": "True",

879

"enabled": "True",

880

}

881

486

882

@staticmethod

487

883

def config_parser(config):

488

884

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

495

891

for client_name in config.sections():

496

892

section = dict(config.items(client_name))

497

893

client = settings[client_name] = {}

498

894

499

895

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

500

896

# Reformat values from string types to Python types

501

897

client["approved_by_default"] = config.getboolean(

502

898

client_name, "approved_by_default")

503

899

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

504

900

"enabled")

505

901

902

# Uppercase and remove spaces from key_id and fingerprint

903

# for later comparison purposes with return value from the

904

# key_id() and fingerprint() functions

905

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

906

.replace(" ", ""))

506

907

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

507

908

.replace(" ", ""))

508

909

if "secret" in section:

509

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

910

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

911

.encode("utf-8"),

912

"base64")

510

913

elif "secfile" in section:

511

914

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

512

915

(section["secfile"])),

513

916

"rb") as secfile:

514

917

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

515

918

else:

516

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

919

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

517

920

.format(section))

518

921

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

519

922

client["extended_timeout"] = string_to_delta(

527

930

client["last_approval_request"] = None

528

931

client["last_checked_ok"] = None

529

932

client["last_checker_status"] = -2

530

933

531

934

return settings

532

533

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

935

936

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

534

937

self.name = name

535

938

if server_settings is None:

536

939

server_settings = {}

537

940

self.server_settings = server_settings

538

941

# adding all client settings

539

for setting, value in settings.iteritems():

942

for setting, value in settings.items():

540

943

setattr(self, setting, value)

541

944

542

945

if self.enabled:

543

946

if not hasattr(self, "last_enabled"):

544

947

self.last_enabled = datetime.datetime.utcnow()

548

951

else:

549

952

self.last_enabled = None

550

953

self.expires = None

551

954

552

955

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

553

# Uppercase and remove spaces from fingerprint for later

554

# comparison purposes with return value from the fingerprint()

555

# function

956

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

556

957

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

557

958

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

558

959

datetime.datetime.utcnow())

559

960

560

961

# attributes specific for this server instance

561

962

self.checker = None

562

963

self.checker_initiator_tag = None

565

966

self.current_checker_command = None

566

967

self.approved = None

567

968

self.approvals_pending = 0

568

self.changedstate = (multiprocessing_manager

569

.Condition(multiprocessing_manager

570

.Lock()))

571

self.client_structure = [attr for attr in

572

self.__dict__.iterkeys()

969

self.changedstate = multiprocessing_manager.Condition(

970

multiprocessing_manager.Lock())

971

self.client_structure = [attr

972

for attr in self.__dict__.keys()

573

973

if not attr.startswith("_")]

574

974

self.client_structure.append("client_structure")

575

576

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

577

lambda obj:

578

isinstance(obj,

579

property)):

975

976

for name, t in inspect.getmembers(

977

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

580

978

if not name.startswith("_"):

581

979

self.client_structure.append(name)

582

980

583

981

# Send notice to process children that client state has changed

584

982

def send_changedstate(self):

585

983

with self.changedstate:

586

984

self.changedstate.notify_all()

587

985

588

986

def enable(self):

589

987

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

590

988

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

595

993

self.last_enabled = datetime.datetime.utcnow()

596

994

self.init_checker()

597

995

self.send_changedstate()

598

996

599

997

def disable(self, quiet=True):

600

998

"""Disable this client."""

601

999

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

603

1001

if not quiet:

604

1002

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

605

1003

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

606

gobject.source_remove(self.disable_initiator_tag)

1004

GLib.source_remove(self.disable_initiator_tag)

607

1005

self.disable_initiator_tag = None

608

1006

self.expires = None

609

1007

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

610

gobject.source_remove(self.checker_initiator_tag)

1008

GLib.source_remove(self.checker_initiator_tag)

611

1009

self.checker_initiator_tag = None

612

1010

self.stop_checker()

613

1011

self.enabled = False

614

1012

if not quiet:

615

1013

self.send_changedstate()

616

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

1014

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

617

1015

return False

618

1016

619

1017

def __del__(self):

620

1018

self.disable()

621

1019

622

1020

def init_checker(self):

623

1021

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

624

1022

# and every interval from then on.

625

1023

if self.checker_initiator_tag is not None:

626

gobject.source_remove(self.checker_initiator_tag)

627

self.checker_initiator_tag = (gobject.timeout_add

628

(self.interval_milliseconds(),

629

self.start_checker))

1024

GLib.source_remove(self.checker_initiator_tag)

1025

self.checker_initiator_tag = GLib.timeout_add(

1026

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

1027

self.start_checker)

630

1028

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

631

1029

if self.disable_initiator_tag is not None:

632

gobject.source_remove(self.disable_initiator_tag)

633

self.disable_initiator_tag = (gobject.timeout_add

634

(self.timeout_milliseconds(),

635

self.disable))

1030

GLib.source_remove(self.disable_initiator_tag)

1031

self.disable_initiator_tag = GLib.timeout_add(

1032

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

636

1033

# Also start a new checker *right now*.

637

1034

self.start_checker()

638

639

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

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

640

1038

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

641

1039

self.checker_callback_tag = None

642

1040

self.checker = None

643

if os.WIFEXITED(condition):

644

self.last_checker_status = os.WEXITSTATUS(condition)

1041

# Read return code from connection (see call_pipe)

1042

returncode = connection.recv()

1043

connection.close()

1044

1045

if returncode >= 0:

1046

self.last_checker_status = returncode

1047

self.last_checker_signal = None

645

1048

if self.last_checker_status == 0:

646

1049

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

647

1050

vars(self))

648

1051

self.checked_ok()

649

1052

else:

650

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

651

vars(self))

1053

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

652

1054

else:

653

1055

self.last_checker_status = -1

1056

self.last_checker_signal = -returncode

654

1057

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

655

1058

vars(self))

656

1059

return False

1060

657

1061

def checked_ok(self):

658

1062

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

659

1063

self.last_checked_ok = datetime.datetime.utcnow()

660

1064

self.last_checker_status = 0

1065

self.last_checker_signal = None

661

1066

self.bump_timeout()

662

1067

663

1068

def bump_timeout(self, timeout=None):

664

1069

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

665

1070

if timeout is None:

666

1071

timeout = self.timeout

667

1072

if self.disable_initiator_tag is not None:

668

gobject.source_remove(self.disable_initiator_tag)

1073

GLib.source_remove(self.disable_initiator_tag)

669

1074

self.disable_initiator_tag = None

670

1075

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

671

self.disable_initiator_tag = (gobject.timeout_add

672

(timedelta_to_milliseconds

673

(timeout), self.disable))

1076

self.disable_initiator_tag = GLib.timeout_add(

1077

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

674

1078

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

675

1079

676

1080

def need_approval(self):

677

1081

self.last_approval_request = datetime.datetime.utcnow()

678

1082

679

1083

def start_checker(self):

680

1084

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

681

1085

682

1086

If a checker already exists, leave it running and do

683

1087

nothing."""

684

1088

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

689

1093

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

690

1094

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

691

1095

# should be.

692

693

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

694

try:

695

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

696

except AttributeError:

697

pass

698

except OSError as error:

699

if error.errno != errno.ECHILD:

700

raise

701

else:

702

if pid:

703

logger.warning("Checker was a zombie")

704

gobject.source_remove(self.checker_callback_tag)

705

self.checker_callback(pid, status,

706

self.current_checker_command)

1096

1097

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

1098

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

1099

self.checker.join()

1100

self.checker = None

707

1101

# Start a new checker if needed

708

1102

if self.checker is None:

709

1103

# Escape attributes for the shell

710

escaped_attrs = dict(

711

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

712

for attr in

713

self.runtime_expansions)

1104

escaped_attrs = {

1105

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

1106

for attr in self.runtime_expansions}

714

1107

try:

715

1108

command = self.checker_command % escaped_attrs

716

1109

except TypeError as error:

717

1110

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

718

self.checker_command, exc_info=error)

719

return True # Try again later

1111

self.checker_command,

1112

exc_info=error)

1113

return True # Try again later

720

1114

self.current_checker_command = command

721

try:

722

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

723

command, self.name)

724

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

725

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

726

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

727

# always replaced by /dev/null.)

728

# The exception is when not debugging but nevertheless

729

# running in the foreground; use the previously

730

# created wnull.

731

popen_args = {}

732

if (not self.server_settings["debug"]

733

and self.server_settings["foreground"]):

734

popen_args.update({"stdout": wnull,

735

"stderr": wnull })

736

self.checker = subprocess.Popen(command,

737

close_fds=True,

738

shell=True, cwd="/",

739

**popen_args)

740

except OSError as error:

741

logger.error("Failed to start subprocess",

742

exc_info=error)

743

return True

744

self.checker_callback_tag = (gobject.child_watch_add

745

(self.checker.pid,

746

self.checker_callback,

747

data=command))

748

# The checker may have completed before the gobject

749

# watch was added. Check for this.

750

try:

751

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

752

except OSError as error:

753

if error.errno == errno.ECHILD:

754

# This should never happen

755

logger.error("Child process vanished",

756

exc_info=error)

757

return True

758

raise

759

if pid:

760

gobject.source_remove(self.checker_callback_tag)

761

self.checker_callback(pid, status, command)

762

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

1115

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

1116

self.name)

1117

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

1118

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

1119

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

1120

# always replaced by /dev/null.)

1121

# The exception is when not debugging but nevertheless

1122

# running in the foreground; use the previously

1123

# created wnull.

1124

popen_args = {"close_fds": True,

1125

"shell": True,

1126

"cwd": "/"}

1127

if (not self.server_settings["debug"]

1128

and self.server_settings["foreground"]):

1129

popen_args.update({"stdout": wnull,

1130

"stderr": wnull})

1131

pipe = multiprocessing.Pipe(duplex=False)

1132

self.checker = multiprocessing.Process(

1133

target=call_pipe,

1134

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

1135

kwargs=popen_args)

1136

self.checker.start()

1137

self.checker_callback_tag = GLib.io_add_watch(

1138

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

1139

self.checker_callback, pipe[0], command)

1140

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

763

1141

return True

764

1142

765

1143

def stop_checker(self):

766

1144

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

767

1145

if self.checker_callback_tag:

768

gobject.source_remove(self.checker_callback_tag)

1146

GLib.source_remove(self.checker_callback_tag)

769

1147

self.checker_callback_tag = None

770

1148

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

771

1149

return

772

1150

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

773

try:

774

self.checker.terminate()

775

#time.sleep(0.5)

776

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

777

# self.checker.kill()

778

except OSError as error:

779

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

780

raise

1151

self.checker.terminate()

781

1152

self.checker = None

782

1153

783

1154

784

def dbus_service_property(dbus_interface, signature="v",

785

access="readwrite", byte_arrays=False):

1155

def dbus_service_property(dbus_interface,

1156

signature="v",

1157

access="readwrite",

1158

byte_arrays=False):

786

1159

"""Decorators for marking methods of a DBusObjectWithProperties to

787

1160

become properties on the D-Bus.

788

1161

789

1162

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

790

1163

and with one argument by "Set".

791

1164

792

1165

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

793

1166

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

794

1167

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

797

1170

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

798

1171

if byte_arrays and signature != "ay":

799

1172

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

800

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

1173

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

1174

801

1175

def decorator(func):

802

1176

func._dbus_is_property = True

803

1177

func._dbus_interface = dbus_interface

806

1180

func._dbus_name = func.__name__

807

1181

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

808

1182

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

809

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1183

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

810

1184

return func

1185

811

1186

return decorator

812

1187

813

1188

814

1189

def dbus_interface_annotations(dbus_interface):

815

1190

"""Decorator for marking functions returning interface annotations

816

1191

817

1192

Usage:

818

1193

819

1194

@dbus_interface_annotations("org.example.Interface")

820

1195

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

821

1196

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

822

1197

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

823

1198

"false"}

824

1199

"""

1200

825

1201

def decorator(func):

826

1202

func._dbus_is_interface = True

827

1203

func._dbus_interface = dbus_interface

828

1204

func._dbus_name = dbus_interface

829

1205

return func

1206

830

1207

return decorator

831

1208

832

1209

833

1210

def dbus_annotations(annotations):

834

1211

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

835

1212

Usage:

836

1213

1214

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

1215

"org.freedesktop.DBus.Property."

1216

"EmitsChangedSignal": "false"})

837

1217

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

838

1218

access="r")

839

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

840

"org.freedesktop.DBus.Property."

841

"EmitsChangedSignal": "false"})

842

1219

def Property_dbus_property(self):

843

1220

return dbus.Boolean(False)

1221

1222

See also the DBusObjectWithAnnotations class.

844

1223

"""

1224

845

1225

def decorator(func):

846

1226

func._dbus_annotations = annotations

847

1227

return func

1228

848

1229

return decorator

849

1230

850

1231

851

1232

class DBusPropertyException(dbus.exceptions.DBusException):

852

1233

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

853

1234

"""

854

def __unicode__(self):

855

return unicode(str(self))

1235

pass

856

1236

857

1237

858

1238

class DBusPropertyAccessException(DBusPropertyException):

867

1247

pass

868

1248

869

1249

870

class DBusObjectWithProperties(dbus.service.Object):

871

"""A D-Bus object with properties.

872

873

Classes inheriting from this can use the dbus_service_property

874

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

875

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

1250

class DBusObjectWithAnnotations(dbus.service.Object):

1251

"""A D-Bus object with annotations.

1252

1253

Classes inheriting from this can use the dbus_annotations

1254

decorator to add annotations to methods or signals.

876

1255

"""

877

1256

878

1257

@staticmethod

879

1258

def _is_dbus_thing(thing):

880

1259

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

881

1260

882

1261

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

883

1262

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

884

1263

"""

885

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

1264

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

886

1265

False)

887

1266

888

1267

def _get_all_dbus_things(self, thing):

889

1268

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

890

1269

"""

891

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

892

name),

1270

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

893

1271

athing.__get__(self))

894

1272

for cls in self.__class__.__mro__

895

1273

for name, athing in

896

inspect.getmembers(cls,

897

self._is_dbus_thing(thing)))

898

1274

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

1275

1276

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1277

out_signature="s",

1278

path_keyword='object_path',

1279

connection_keyword='connection')

1280

def Introspect(self, object_path, connection):

1281

"""Overloading of standard D-Bus method.

1282

1283

Inserts annotation tags on methods and signals.

1284

"""

1285

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

1286

connection)

1287

try:

1288

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

1289

1290

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

1291

# Add annotation tags

1292

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

1293

for tag in if_tag.getElementsByTagName(typ):

1294

annots = dict()

1295

for name, prop in (self.

1296

_get_all_dbus_things(typ)):

1297

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

1298

and prop._dbus_interface

1299

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

1300

annots.update(getattr(

1301

prop, "_dbus_annotations", {}))

1302

for name, value in annots.items():

1303

ann_tag = document.createElement(

1304

"annotation")

1305

ann_tag.setAttribute("name", name)

1306

ann_tag.setAttribute("value", value)

1307

tag.appendChild(ann_tag)

1308

# Add interface annotation tags

1309

for annotation, value in dict(

1310

itertools.chain.from_iterable(

1311

annotations().items()

1312

for name, annotations

1313

in self._get_all_dbus_things("interface")

1314

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

1315

)).items():

1316

ann_tag = document.createElement("annotation")

1317

ann_tag.setAttribute("name", annotation)

1318

ann_tag.setAttribute("value", value)

1319

if_tag.appendChild(ann_tag)

1320

# Fix argument name for the Introspect method itself

1321

if (if_tag.getAttribute("name")

1322

== dbus.INTROSPECTABLE_IFACE):

1323

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

1324

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

1325

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

1326

if (arg.getAttribute("direction")

1327

== "out"):

1328

arg.setAttribute("name",

1329

"xml_data")

1330

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

1331

document.unlink()

1332

except (AttributeError, xml.dom.DOMException,

1333

xml.parsers.expat.ExpatError) as error:

1334

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

1335

exc_info=error)

1336

return xmlstring

1337

1338

1339

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1340

"""A D-Bus object with properties.

1341

1342

Classes inheriting from this can use the dbus_service_property

1343

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

1344

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

1345

"""

1346

899

1347

def _get_dbus_property(self, interface_name, property_name):

900

1348

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

901

1349

property with the specified name and interface.

902

1350

"""

903

for cls in self.__class__.__mro__:

904

for name, value in (inspect.getmembers

905

(cls,

906

self._is_dbus_thing("property"))):

1351

for cls in self.__class__.__mro__:

1352

for name, value in inspect.getmembers(

1353

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

907

1354

if (value._dbus_name == property_name

908

1355

and value._dbus_interface == interface_name):

909

1356

return value.__get__(self)

910

1357

911

1358

# No such property

912

raise DBusPropertyNotFound(self.dbus_object_path + ":"

913

+ interface_name + "."

914

+ property_name)

915

916

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

1359

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

1360

self.dbus_object_path, interface_name, property_name))

1361

1362

@classmethod

1363

def _get_all_interface_names(cls):

1364

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

1365

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

1366

"_dbus_interface", None)

1367

for x in (inspect.getmro(cls))

1368

for attr in dir(x))

1369

if name is not None)

1370

1371

@dbus.service.method(dbus.PROPERTIES_IFACE,

1372

in_signature="ss",

917

1373

out_signature="v")

918

1374

def Get(self, interface_name, property_name):

919

1375

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

925

1381

if not hasattr(value, "variant_level"):

926

1382

return value

927

1383

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

928

1384

929

1385

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

930

1386

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

931

1387

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

938

1394

# signatures other than "ay".

939

1395

if prop._dbus_signature != "ay":

940

1396

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

941

"'ay' signature {0!r}"

1397

"'ay' signature {!r}"

942

1398

.format(prop._dbus_signature))

943

1399

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

944

1400

for byte in value))

945

1401

prop(value)

946

947

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

1402

1403

@dbus.service.method(dbus.PROPERTIES_IFACE,

1404

in_signature="s",

948

1405

out_signature="a{sv}")

949

1406

def GetAll(self, interface_name):

950

1407

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

951

1408

standard.

952

1409

953

1410

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

954

1411

"""

955

1412

properties = {}

965

1422

if not hasattr(value, "variant_level"):

966

1423

properties[name] = value

967

1424

continue

968

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

969

value.variant_level+1)

1425

properties[name] = type(value)(

1426

value, variant_level=value.variant_level + 1)

970

1427

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

971

1428

1429

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

1430

def PropertiesChanged(self, interface_name, changed_properties,

1431

invalidated_properties):

1432

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

1433

standard.

1434

"""

1435

pass

1436

972

1437

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

973

1438

out_signature="s",

974

1439

path_keyword='object_path',

975

1440

connection_keyword='connection')

976

1441

def Introspect(self, object_path, connection):

977

1442

"""Overloading of standard D-Bus method.

978

1443

979

1444

Inserts property tags and interface annotation tags.

980

1445

"""

981

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

982

connection)

1446

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1447

object_path,

1448

connection)

983

1449

try:

984

1450

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

1451

985

1452

def make_tag(document, name, prop):

986

1453

e = document.createElement("property")

987

1454

e.setAttribute("name", name)

988

1455

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

989

1456

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

990

1457

return e

1458

991

1459

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

992

1460

# Add property tags

993

1461

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

996

1464

if prop._dbus_interface

997

1465

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

998

1466

if_tag.appendChild(tag)

999

# Add annotation tags

1000

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

1001

for tag in if_tag.getElementsByTagName(typ):

1002

annots = dict()

1003

for name, prop in (self.

1004

_get_all_dbus_things(typ)):

1005

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

1006

and prop._dbus_interface

1007

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

1008

annots.update(getattr

1009

(prop,

1010

"_dbus_annotations",

1011

{}))

1012

for name, value in annots.iteritems():

1013

ann_tag = document.createElement(

1014

"annotation")

1015

ann_tag.setAttribute("name", name)

1016

ann_tag.setAttribute("value", value)

1017

tag.appendChild(ann_tag)

1018

# Add interface annotation tags

1019

for annotation, value in dict(

1020

itertools.chain.from_iterable(

1021

annotations().iteritems()

1022

for name, annotations in

1023

self._get_all_dbus_things("interface")

1024

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

1025

)).iteritems():

1026

ann_tag = document.createElement("annotation")

1027

ann_tag.setAttribute("name", annotation)

1028

ann_tag.setAttribute("value", value)

1029

if_tag.appendChild(ann_tag)

1467

# Add annotation tags for properties

1468

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

1469

annots = dict()

1470

for name, prop in self._get_all_dbus_things(

1471

"property"):

1472

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

1473

and prop._dbus_interface

1474

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

1475

annots.update(getattr(

1476

prop, "_dbus_annotations", {}))

1477

for name, value in annots.items():

1478

ann_tag = document.createElement(

1479

"annotation")

1480

ann_tag.setAttribute("name", name)

1481

ann_tag.setAttribute("value", value)

1482

tag.appendChild(ann_tag)

1030

1483

# Add the names to the return values for the

1031

1484

# "org.freedesktop.DBus.Properties" methods

1032

1485

if (if_tag.getAttribute("name")

1051

1504

return xmlstring

1052

1505

1053

1506

1507

try:

1508

dbus.OBJECT_MANAGER_IFACE

1509

except AttributeError:

1510

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

1511

1512

1513

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1514

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

1515

1516

Classes inheriting from this exposes the standard

1517

GetManagedObjects call and the InterfacesAdded and

1518

InterfacesRemoved signals on the standard

1519

"org.freedesktop.DBus.ObjectManager" interface.

1520

1521

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

1522

manually.

1523

"""

1524

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1525

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

1526

def GetManagedObjects(self):

1527

"""This function must be overridden"""

1528

raise NotImplementedError()

1529

1530

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1531

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

1532

def InterfacesAdded(self, object_path, interfaces_and_properties):

1533

pass

1534

1535

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

1536

def InterfacesRemoved(self, object_path, interfaces):

1537

pass

1538

1539

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1540

out_signature="s",

1541

path_keyword='object_path',

1542

connection_keyword='connection')

1543

def Introspect(self, object_path, connection):

1544

"""Overloading of standard D-Bus method.

1545

1546

Override return argument name of GetManagedObjects to be

1547

"objpath_interfaces_and_properties"

1548

"""

1549

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1550

object_path,

1551

connection)

1552

try:

1553

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

1554

1555

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

1556

# Fix argument name for the GetManagedObjects method

1557

if (if_tag.getAttribute("name")

1558

== dbus.OBJECT_MANAGER_IFACE):

1559

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

1560

if (cn.getAttribute("name")

1561

== "GetManagedObjects"):

1562

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

1563

if (arg.getAttribute("direction")

1564

== "out"):

1565

arg.setAttribute(

1566

"name",

1567

"objpath_interfaces"

1568

"_and_properties")

1569

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

1570

document.unlink()

1571

except (AttributeError, xml.dom.DOMException,

1572

xml.parsers.expat.ExpatError) as error:

1573

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

1574

exc_info=error)

1575

return xmlstring

1576

1577

1054

1578

def datetime_to_dbus(dt, variant_level=0):

1055

1579

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

1056

1580

if dt is None:

1057

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

1058

return dbus.String(dt.isoformat(),

1059

variant_level=variant_level)

1581

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

1582

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

1060

1583

1061

1584

1062

1585

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1064

1587

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

1065

1588

interface names according to the "alt_interface_names" mapping.

1066

1589

Usage:

1067

1590

1068

1591

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

1069

1592

"net.example.AlternateInterface"})

1070

1593

class SampleDBusObject(dbus.service.Object):

1071

1594

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

1072

1595

def SampleDBusMethod():

1073

1596

pass

1074

1597

1075

1598

The above "SampleDBusMethod" on "SampleDBusObject" will be

1076

1599

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

1077

1600

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

1078

1601

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

1079

1602

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

1080

1603

1081

1604

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

1082

1605

(from DBusObjectWithProperties) and interfaces (from the

1083

1606

dbus_interface_annotations decorator).

1084

1607

"""

1608

1085

1609

def wrapper(cls):

1086

1610

for orig_interface_name, alt_interface_name in (

1087

alt_interface_names.iteritems()):

1611

alt_interface_names.items()):

1088

1612

attr = {}

1089

1613

interface_names = set()

1090

1614

# Go though all attributes of the class

1092

1616

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

1093

1617

# with the wrong interface name

1094

1618

if (not hasattr(attribute, "_dbus_interface")

1095

or not attribute._dbus_interface

1096

.startswith(orig_interface_name)):

1619

or not attribute._dbus_interface.startswith(

1620

orig_interface_name)):

1097

1621

continue

1098

1622

# Create an alternate D-Bus interface name based on

1099

1623

# the current name

1100

alt_interface = (attribute._dbus_interface

1101

.replace(orig_interface_name,

1102

alt_interface_name))

1624

alt_interface = attribute._dbus_interface.replace(

1625

orig_interface_name, alt_interface_name)

1103

1626

interface_names.add(alt_interface)

1104

1627

# Is this a D-Bus signal?

1105

1628

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

1106

1629

# Extract the original non-method undecorated

1107

1630

# function by black magic

1108

nonmethod_func = (dict(

1631

if sys.version_info.major == 2:

1632

nonmethod_func = (dict(

1109

1633

zip(attribute.func_code.co_freevars,

1110

attribute.__closure__))["func"]

1111

.cell_contents)

1634

attribute.__closure__))

1635

["func"].cell_contents)

1636

else:

1637

nonmethod_func = (dict(

1638

zip(attribute.__code__.co_freevars,

1639

attribute.__closure__))

1640

["func"].cell_contents)

1112

1641

# Create a new, but exactly alike, function

1113

1642

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

1114

1643

# with the alternate D-Bus interface name

1115

new_function = (dbus.service.signal

1116

(alt_interface,

1117

attribute._dbus_signature)

1118

(types.FunctionType(

1119

nonmethod_func.func_code,

1120

nonmethod_func.func_globals,

1121

nonmethod_func.func_name,

1122

nonmethod_func.func_defaults,

1123

nonmethod_func.func_closure)))

1644

new_function = copy_function(nonmethod_func)

1645

new_function = (dbus.service.signal(

1646

alt_interface,

1647

attribute._dbus_signature)(new_function))

1124

1648

# Copy annotations, if any

1125

1649

try:

1126

new_function._dbus_annotations = (

1127

dict(attribute._dbus_annotations))

1650

new_function._dbus_annotations = dict(

1651

attribute._dbus_annotations)

1128

1652

except AttributeError:

1129

1653

pass

1654

1130

1655

# Define a creator of a function to call both the

1131

1656

# original and alternate functions, so both the

1132

1657

# original and alternate signals gets sent when

1135

1660

"""This function is a scope container to pass

1136

1661

func1 and func2 to the "call_both" function

1137

1662

outside of its arguments"""

1663

1664

@functools.wraps(func2)

1138

1665

def call_both(*args, **kwargs):

1139

1666

"""This function will emit two D-Bus

1140

1667

signals by calling func1 and func2"""

1141

1668

func1(*args, **kwargs)

1142

1669

func2(*args, **kwargs)

1670

# Make wrapper function look like a D-Bus

1671

# signal

1672

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

1673

if name.startswith("_dbus_"):

1674

setattr(call_both, name, attr)

1675

1143

1676

return call_both

1144

1677

# Create the "call_both" function and add it to

1145

1678

# the class

1150

1683

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

1151

1684

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

1152

1685

# to the class.

1153

attr[attrname] = (dbus.service.method

1154

(alt_interface,

1155

attribute._dbus_in_signature,

1156

attribute._dbus_out_signature)

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1686

attr[attrname] = (

1687

dbus.service.method(

1688

alt_interface,

1689

attribute._dbus_in_signature,

1690

attribute._dbus_out_signature)

1691

(copy_function(attribute)))

1163

1692

# Copy annotations, if any

1164

1693

try:

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1694

attr[attrname]._dbus_annotations = dict(

1695

attribute._dbus_annotations)

1167

1696

except AttributeError:

1168

1697

pass

1169

1698

# Is this a D-Bus property?

1172

1701

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

1173

1702

# property with the alternate D-Bus interface

1174

1703

# name. Add it to the class.

1175

attr[attrname] = (dbus_service_property

1176

(alt_interface,

1177

attribute._dbus_signature,

1178

attribute._dbus_access,

1179

attribute

1180

._dbus_get_args_options

1181

["byte_arrays"])

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

attribute.func_closure)))

1704

attr[attrname] = (dbus_service_property(

1705

alt_interface, attribute._dbus_signature,

1706

attribute._dbus_access,

1707

attribute._dbus_get_args_options

1708

["byte_arrays"])

1709

(copy_function(attribute)))

1188

1710

# Copy annotations, if any

1189

1711

try:

1190

attr[attrname]._dbus_annotations = (

1191

dict(attribute._dbus_annotations))

1712

attr[attrname]._dbus_annotations = dict(

1713

attribute._dbus_annotations)

1192

1714

except AttributeError:

1193

1715

pass

1194

1716

# Is this a D-Bus interface?

1197

1719

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

1198

1720

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

1199

1721

# to the class.

1200

attr[attrname] = (dbus_interface_annotations

1201

(alt_interface)

1202

(types.FunctionType

1203

(attribute.func_code,

1204

attribute.func_globals,

1205

attribute.func_name,

1206

attribute.func_defaults,

1207

attribute.func_closure)))

1722

attr[attrname] = (

1723

dbus_interface_annotations(alt_interface)

1724

(copy_function(attribute)))

1208

1725

if deprecate:

1209

1726

# Deprecate all alternate interfaces

1210

iname="_AlternateDBusNames_interface_annotation{0}"

1727

iname = "_AlternateDBusNames_interface_annotation{}"

1211

1728

for interface_name in interface_names:

1729

1212

1730

@dbus_interface_annotations(interface_name)

1213

1731

def func(self):

1214

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

1215

"true" }

1732

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

1733

"true"}

1216

1734

# Find an unused name

1217

1735

for aname in (iname.format(i)

1218

1736

for i in itertools.count()):

1222

1740

if interface_names:

1223

1741

# Replace the class with a new subclass of it with

1224

1742

# methods, signals, etc. as created above.

1225

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

1226

(cls,), attr)

1743

if sys.version_info.major == 2:

1744

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

1745

(cls, ), attr)

1746

else:

1747

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

1748

(cls, ), attr)

1227

1749

return cls

1750

1228

1751

return wrapper

1229

1752

1230

1753

1231

1754

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

1232

"se.bsnet.fukt.Mandos"})

1755

"se.bsnet.fukt.Mandos"})

1233

1756

class ClientDBus(Client, DBusObjectWithProperties):

1234

1757

"""A Client class using D-Bus

1235

1758

1236

1759

Attributes:

1237

1760

dbus_object_path: dbus.ObjectPath

1238

1761

bus: dbus.SystemBus()

1239

1762

"""

1240

1763

1241

1764

runtime_expansions = (Client.runtime_expansions

1242

+ ("dbus_object_path",))

1243

1765

+ ("dbus_object_path", ))

1766

1767

_interface = "se.recompile.Mandos.Client"

1768

1244

1769

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

1245

1246

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

1770

1771

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

1247

1772

self.bus = bus

1248

1773

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

1249

1774

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

1250

1775

# the D-Bus

1251

client_object_name = unicode(self.name).translate(

1776

client_object_name = str(self.name).translate(

1252

1777

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

1253

1778

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

1254

self.dbus_object_path = (dbus.ObjectPath

1255

("/clients/" + client_object_name))

1779

self.dbus_object_path = dbus.ObjectPath(

1780

"/clients/" + client_object_name)

1256

1781

DBusObjectWithProperties.__init__(self, self.bus,

1257

1782

self.dbus_object_path)

1258

1259

def notifychangeproperty(transform_func,

1260

dbus_name, type_func=lambda x: x,

1261

variant_level=1):

1783

1784

def notifychangeproperty(transform_func, dbus_name,

1785

type_func=lambda x: x,

1786

variant_level=1,

1787

invalidate_only=False,

1788

_interface=_interface):

1262

1789

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

1263

1790

its changes to DBus.

1264

1791

1265

1792

transform_fun: Function that takes a value and a variant_level

1266

1793

and transforms it to a D-Bus type.

1267

1794

dbus_name: D-Bus name of the variable

1269

1796

to the D-Bus. Default: no transform

1270

1797

variant_level: D-Bus variant level. Default: 1

1271

1798

"""

1272

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

1799

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

1800

1273

1801

def setter(self, value):

1274

1802

if hasattr(self, "dbus_object_path"):

1275

1803

if (not hasattr(self, attrname) or

1276

1804

type_func(getattr(self, attrname, None))

1277

1805

!= type_func(value)):

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1281

self.PropertyChanged(dbus.String(dbus_name),

1282

dbus_value)

1806

if invalidate_only:

1807

self.PropertiesChanged(

1808

_interface, dbus.Dictionary(),

1809

dbus.Array((dbus_name, )))

1810

else:

1811

dbus_value = transform_func(

1812

type_func(value),

1813

variant_level=variant_level)

1814

self.PropertyChanged(dbus.String(dbus_name),

1815

dbus_value)

1816

self.PropertiesChanged(

1817

_interface,

1818

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

1819

dbus_value}),

1820

dbus.Array())

1283

1821

setattr(self, attrname, value)

1284

1822

1285

1823

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

1286

1824

1287

1825

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1288

1826

approvals_pending = notifychangeproperty(dbus.Boolean,

1289

1827

"ApprovalPending",

1290

type_func = bool)

1828

type_func=bool)

1291

1829

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

1292

1830

last_enabled = notifychangeproperty(datetime_to_dbus,

1293

1831

"LastEnabled")

1294

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

1295

type_func = lambda checker:

1296

checker is not None)

1832

checker = notifychangeproperty(

1833

dbus.Boolean, "CheckerRunning",

1834

type_func=lambda checker: checker is not None)

1297

1835

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1298

1836

"LastCheckedOK")

1299

1837

last_checker_status = notifychangeproperty(dbus.Int16,

1302

1840

datetime_to_dbus, "LastApprovalRequest")

1303

1841

approved_by_default = notifychangeproperty(dbus.Boolean,

1304

1842

"ApprovedByDefault")

1305

approval_delay = notifychangeproperty(dbus.UInt64,

1306

"ApprovalDelay",

1307

type_func =

1308

timedelta_to_milliseconds)

1843

approval_delay = notifychangeproperty(

1844

dbus.UInt64, "ApprovalDelay",

1845

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

1309

1846

approval_duration = notifychangeproperty(

1310

1847

dbus.UInt64, "ApprovalDuration",

1311

type_func = timedelta_to_milliseconds)

1848

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

1312

1849

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

1313

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

1314

type_func =

1315

timedelta_to_milliseconds)

1850

timeout = notifychangeproperty(

1851

dbus.UInt64, "Timeout",

1852

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

1316

1853

extended_timeout = notifychangeproperty(

1317

1854

dbus.UInt64, "ExtendedTimeout",

1318

type_func = timedelta_to_milliseconds)

1319

interval = notifychangeproperty(dbus.UInt64,

1320

"Interval",

1321

type_func =

1322

timedelta_to_milliseconds)

1855

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

1856

interval = notifychangeproperty(

1857

dbus.UInt64, "Interval",

1858

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

1323

1859

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

1324

1860

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

1861

invalidate_only=True)

1862

1325

1863

del notifychangeproperty

1326

1864

1327

1865

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

1328

1866

try:

1329

1867

self.remove_from_connection()

1332

1870

if hasattr(DBusObjectWithProperties, "__del__"):

1333

1871

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

1334

1872

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

1335

1336

def checker_callback(self, pid, condition, command,

1337

*args, **kwargs):

1338

self.checker_callback_tag = None

1339

self.checker = None

1340

if os.WIFEXITED(condition):

1341

exitstatus = os.WEXITSTATUS(condition)

1873

1874

def checker_callback(self, source, condition,

1875

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

1876

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

1877

connection, command, *args,

1878

**kwargs)

1879

exitstatus = self.last_checker_status

1880

if exitstatus >= 0:

1342

1881

# Emit D-Bus signal

1343

1882

self.CheckerCompleted(dbus.Int16(exitstatus),

1344

dbus.Int64(condition),

1883

# This is specific to GNU libC

1884

dbus.Int64(exitstatus << 8),

1345

1885

dbus.String(command))

1346

1886

else:

1347

1887

# Emit D-Bus signal

1348

1888

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

1349

dbus.Int64(condition),

1889

dbus.Int64(

1890

# This is specific to GNU libC

1891

(exitstatus << 8)

1892

| self.last_checker_signal),

1350

1893

dbus.String(command))

1351

1352

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

1353

*args, **kwargs)

1354

1894

return ret

1895

1355

1896

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

1356

1897

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

1357

1898

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

1361

1902

# Emit D-Bus signal

1362

1903

self.CheckerStarted(self.current_checker_command)

1363

1904

return r

1364

1905

1365

1906

def _reset_approved(self):

1366

1907

self.approved = None

1367

1908

return False

1368

1909

1369

1910

def approve(self, value=True):

1370

1911

self.approved = value

1371

gobject.timeout_add(timedelta_to_milliseconds

1372

(self.approval_duration),

1373

self._reset_approved)

1912

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

1913

* 1000), self._reset_approved)

1374

1914

self.send_changedstate()

1375

1376

## D-Bus methods, signals & properties

1377

_interface = "se.recompile.Mandos.Client"

1378

1379

## Interfaces

1380

1381

@dbus_interface_annotations(_interface)

1382

def _foo(self):

1383

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

1384

"false"}

1385

1386

## Signals

1387

1915

1916

# D-Bus methods, signals & properties

1917

1918

# Interfaces

1919

1920

# Signals

1921

1388

1922

# CheckerCompleted - signal

1389

1923

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

1390

1924

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

1391

1925

"D-Bus signal"

1392

1926

pass

1393

1927

1394

1928

# CheckerStarted - signal

1395

1929

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

1396

1930

def CheckerStarted(self, command):

1397

1931

"D-Bus signal"

1398

1932

pass

1399

1933

1400

1934

# PropertyChanged - signal

1935

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

1401

1936

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

1402

1937

def PropertyChanged(self, property, value):

1403

1938

"D-Bus signal"

1404

1939

pass

1405

1940

1406

1941

# GotSecret - signal

1407

1942

@dbus.service.signal(_interface)

1408

1943

def GotSecret(self):

1411

1946

server to mandos-client

1412

1947

"""

1413

1948

pass

1414

1949

1415

1950

# Rejected - signal

1416

1951

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

1417

1952

def Rejected(self, reason):

1418

1953

"D-Bus signal"

1419

1954

pass

1420

1955

1421

1956

# NeedApproval - signal

1422

1957

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

1423

1958

def NeedApproval(self, timeout, default):

1424

1959

"D-Bus signal"

1425

1960

return self.need_approval()

1426

1427

## Methods

1428

1961

1962

# Methods

1963

1429

1964

# Approve - method

1430

1965

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

1431

1966

def Approve(self, value):

1432

1967

self.approve(value)

1433

1968

1434

1969

# CheckedOK - method

1435

1970

@dbus.service.method(_interface)

1436

1971

def CheckedOK(self):

1437

1972

self.checked_ok()

1438

1973

1439

1974

# Enable - method

1975

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

1440

1976

@dbus.service.method(_interface)

1441

1977

def Enable(self):

1442

1978

"D-Bus method"

1443

1979

self.enable()

1444

1980

1445

1981

# StartChecker - method

1982

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

1446

1983

@dbus.service.method(_interface)

1447

1984

def StartChecker(self):

1448

1985

"D-Bus method"

1449

1986

self.start_checker()

1450

1987

1451

1988

# Disable - method

1989

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

1452

1990

@dbus.service.method(_interface)

1453

1991

def Disable(self):

1454

1992

"D-Bus method"

1455

1993

self.disable()

1456

1994

1457

1995

# StopChecker - method

1996

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

1458

1997

@dbus.service.method(_interface)

1459

1998

def StopChecker(self):

1460

1999

self.stop_checker()

1461

1462

## Properties

1463

2000

2001

# Properties

2002

1464

2003

# ApprovalPending - property

1465

2004

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

1466

2005

def ApprovalPending_dbus_property(self):

1467

2006

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

1468

2007

1469

2008

# ApprovedByDefault - property

1470

@dbus_service_property(_interface, signature="b",

2009

@dbus_service_property(_interface,

2010

signature="b",

1471

2011

access="readwrite")

1472

2012

def ApprovedByDefault_dbus_property(self, value=None):

1473

2013

if value is None: # get

1474

2014

return dbus.Boolean(self.approved_by_default)

1475

2015

self.approved_by_default = bool(value)

1476

2016

1477

2017

# ApprovalDelay - property

1478

@dbus_service_property(_interface, signature="t",

2018

@dbus_service_property(_interface,

2019

signature="t",

1479

2020

access="readwrite")

1480

2021

def ApprovalDelay_dbus_property(self, value=None):

1481

2022

if value is None: # get

1482

return dbus.UInt64(self.approval_delay_milliseconds())

2023

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

2024

* 1000)

1483

2025

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

1484

2026

1485

2027

# ApprovalDuration - property

1486

@dbus_service_property(_interface, signature="t",

2028

@dbus_service_property(_interface,

2029

signature="t",

1487

2030

access="readwrite")

1488

2031

def ApprovalDuration_dbus_property(self, value=None):

1489

2032

if value is None: # get

1490

return dbus.UInt64(timedelta_to_milliseconds(

1491

self.approval_duration))

2033

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

2034

* 1000)

1492

2035

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

1493

2036

1494

2037

# Name - property

2038

@dbus_annotations(

2039

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

1495

2040

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

1496

2041

def Name_dbus_property(self):

1497

2042

return dbus.String(self.name)

1498

2043

2044

# KeyID - property

2045

@dbus_annotations(

2046

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

2047

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

2048

def KeyID_dbus_property(self):

2049

return dbus.String(self.key_id)

2050

1499

2051

# Fingerprint - property

2052

@dbus_annotations(

2053

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

1500

2054

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

1501

2055

def Fingerprint_dbus_property(self):

1502

2056

return dbus.String(self.fingerprint)

1503

2057

1504

2058

# Host - property

1505

@dbus_service_property(_interface, signature="s",

2059

@dbus_service_property(_interface,

2060

signature="s",

1506

2061

access="readwrite")

1507

2062

def Host_dbus_property(self, value=None):

1508

2063

if value is None: # get

1509

2064

return dbus.String(self.host)

1510

self.host = unicode(value)

1511

2065

self.host = str(value)

2066

1512

2067

# Created - property

2068

@dbus_annotations(

2069

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

1513

2070

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

1514

2071

def Created_dbus_property(self):

1515

2072

return datetime_to_dbus(self.created)

1516

2073

1517

2074

# LastEnabled - property

1518

2075

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

1519

2076

def LastEnabled_dbus_property(self):

1520

2077

return datetime_to_dbus(self.last_enabled)

1521

2078

1522

2079

# Enabled - property

1523

@dbus_service_property(_interface, signature="b",

2080

@dbus_service_property(_interface,

2081

signature="b",

1524

2082

access="readwrite")

1525

2083

def Enabled_dbus_property(self, value=None):

1526

2084

if value is None: # get

1529

2087

self.enable()

1530

2088

else:

1531

2089

self.disable()

1532

2090

1533

2091

# LastCheckedOK - property

1534

@dbus_service_property(_interface, signature="s",

2092

@dbus_service_property(_interface,

2093

signature="s",

1535

2094

access="readwrite")

1536

2095

def LastCheckedOK_dbus_property(self, value=None):

1537

2096

if value is not None:

1538

2097

self.checked_ok()

1539

2098

return

1540

2099

return datetime_to_dbus(self.last_checked_ok)

1541

2100

1542

2101

# LastCheckerStatus - property

1543

@dbus_service_property(_interface, signature="n",

1544

access="read")

2102

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

1545

2103

def LastCheckerStatus_dbus_property(self):

1546

2104

return dbus.Int16(self.last_checker_status)

1547

2105

1548

2106

# Expires - property

1549

2107

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

1550

2108

def Expires_dbus_property(self):

1551

2109

return datetime_to_dbus(self.expires)

1552

2110

1553

2111

# LastApprovalRequest - property

1554

2112

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

1555

2113

def LastApprovalRequest_dbus_property(self):

1556

2114

return datetime_to_dbus(self.last_approval_request)

1557

2115

1558

2116

# Timeout - property

1559

@dbus_service_property(_interface, signature="t",

2117

@dbus_service_property(_interface,

2118

signature="t",

1560

2119

access="readwrite")

1561

2120

def Timeout_dbus_property(self, value=None):

1562

2121

if value is None: # get

1563

return dbus.UInt64(self.timeout_milliseconds())

2122

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

1564

2123

old_timeout = self.timeout

1565

2124

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

1566

2125

# Reschedule disabling

1574

2133

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

1575

2134

is None):

1576

2135

return

1577

gobject.source_remove(self.disable_initiator_tag)

1578

self.disable_initiator_tag = (

1579

gobject.timeout_add(

1580

timedelta_to_milliseconds(self.expires - now),

1581

self.disable))

1582

2136

GLib.source_remove(self.disable_initiator_tag)

2137

self.disable_initiator_tag = GLib.timeout_add(

2138

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

2139

self.disable)

2140

1583

2141

# ExtendedTimeout - property

1584

@dbus_service_property(_interface, signature="t",

2142

@dbus_service_property(_interface,

2143

signature="t",

1585

2144

access="readwrite")

1586

2145

def ExtendedTimeout_dbus_property(self, value=None):

1587

2146

if value is None: # get

1588

return dbus.UInt64(self.extended_timeout_milliseconds())

2147

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

2148

* 1000)

1589

2149

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

1590

2150

1591

2151

# Interval - property

1592

@dbus_service_property(_interface, signature="t",

2152

@dbus_service_property(_interface,

2153

signature="t",

1593

2154

access="readwrite")

1594

2155

def Interval_dbus_property(self, value=None):

1595

2156

if value is None: # get

1596

return dbus.UInt64(self.interval_milliseconds())

2157

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

1597

2158

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

1598

2159

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

1599

2160

return

1600

2161

if self.enabled:

1601

2162

# Reschedule checker run

1602

gobject.source_remove(self.checker_initiator_tag)

1603

self.checker_initiator_tag = (gobject.timeout_add

1604

(value, self.start_checker))

1605

self.start_checker() # Start one now, too

1606

2163

GLib.source_remove(self.checker_initiator_tag)

2164

self.checker_initiator_tag = GLib.timeout_add(

2165

value, self.start_checker)

2166

self.start_checker() # Start one now, too

2167

1607

2168

# Checker - property

1608

@dbus_service_property(_interface, signature="s",

2169

@dbus_service_property(_interface,

2170

signature="s",

1609

2171

access="readwrite")

1610

2172

def Checker_dbus_property(self, value=None):

1611

2173

if value is None: # get

1612

2174

return dbus.String(self.checker_command)

1613

self.checker_command = unicode(value)

1614

2175

self.checker_command = str(value)

2176

1615

2177

# CheckerRunning - property

1616

@dbus_service_property(_interface, signature="b",

2178

@dbus_service_property(_interface,

2179

signature="b",

1617

2180

access="readwrite")

1618

2181

def CheckerRunning_dbus_property(self, value=None):

1619

2182

if value is None: # get

1622

2185

self.start_checker()

1623

2186

else:

1624

2187

self.stop_checker()

1625

2188

1626

2189

# ObjectPath - property

2190

@dbus_annotations(

2191

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

2192

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

1627

2193

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

1628

2194

def ObjectPath_dbus_property(self):

1629

return self.dbus_object_path # is already a dbus.ObjectPath

1630

2195

return self.dbus_object_path # is already a dbus.ObjectPath

2196

1631

2197

# Secret = property

1632

@dbus_service_property(_interface, signature="ay",

1633

access="write", byte_arrays=True)

2198

@dbus_annotations(

2199

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

2200

"invalidates"})

2201

@dbus_service_property(_interface,

2202

signature="ay",

2203

access="write",

2204

byte_arrays=True)

1634

2205

def Secret_dbus_property(self, value):

1635

self.secret = str(value)

1636

2206

self.secret = bytes(value)

2207

1637

2208

del _interface

1638

2209

1639

2210

1640

2211

class ProxyClient(object):

1641

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

2212

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

1642

2213

self._pipe = child_pipe

1643

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

2214

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

1644

2215

if not self._pipe.recv():

1645

raise KeyError()

1646

2216

raise KeyError(key_id or fpr)

2217

1647

2218

def __getattribute__(self, name):

1648

2219

if name == '_pipe':

1649

2220

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

1652

2223

if data[0] == 'data':

1653

2224

return data[1]

1654

2225

if data[0] == 'function':

2226

1655

2227

def func(*args, **kwargs):

1656

2228

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

1657

2229

return self._pipe.recv()[1]

2230

1658

2231

return func

1659

2232

1660

2233

def __setattr__(self, name, value):

1661

2234

if name == '_pipe':

1662

2235

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

1665

2238

1666

2239

class ClientHandler(socketserver.BaseRequestHandler, object):

1667

2240

"""A class to handle client connections.

1668

2241

1669

2242

Instantiated once for each connection to handle it.

1670

2243

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

1671

2244

1672

2245

def handle(self):

1673

2246

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

1674

2247

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

1675

unicode(self.client_address))

2248

str(self.client_address))

1676

2249

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

1677

2250

self.server.child_pipe.fileno())

1678

1679

session = (gnutls.connection

1680

.ClientSession(self.request,

1681

gnutls.connection

1682

.X509Credentials()))

1683

1684

# Note: gnutls.connection.X509Credentials is really a

1685

# generic GnuTLS certificate credentials object so long as

1686

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

1687

# here despite using OpenPGP certificates.

1688

1689

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

1690

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

1691

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

1692

# "+DHE-DSS"))

2251

2252

session = gnutls.ClientSession(self.request)

2253

2254

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

2255

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

2256

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

2257

# "+DHE-DSS"))

1693

2258

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

1694

2259

priority = self.server.gnutls_priority

1695

2260

if priority is None:

1696

2261

priority = "NORMAL"

1697

(gnutls.library.functions

1698

.gnutls_priority_set_direct(session._c_object,

1699

priority, None))

1700

2262

gnutls.priority_set_direct(session._c_object,

2263

priority.encode("utf-8"),

2264

None)

2265

1701

2266

# Start communication using the Mandos protocol

1702

2267

# Get protocol number

1703

2268

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

1708

2273

except (ValueError, IndexError, RuntimeError) as error:

1709

2274

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

1710

2275

return

1711

2276

1712

2277

# Start GnuTLS connection

1713

2278

try:

1714

2279

session.handshake()

1715

except gnutls.errors.GNUTLSError as error:

2280

except gnutls.Error as error:

1716

2281

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

1717

2282

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

1718

2283

# established. Just abandon the request.

1719

2284

return

1720

2285

logger.debug("Handshake succeeded")

1721

2286

1722

2287

approval_required = False

1723

2288

try:

1724

try:

1725

fpr = self.fingerprint(self.peer_certificate

1726

(session))

1727

except (TypeError,

1728

gnutls.errors.GNUTLSError) as error:

1729

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

1730

return

1731

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

1732

1733

try:

1734

client = ProxyClient(child_pipe, fpr,

2289

if gnutls.has_rawpk:

2290

fpr = ""

2291

try:

2292

key_id = self.key_id(

2293

self.peer_certificate(session))

2294

except (TypeError, gnutls.Error) as error:

2295

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

2296

return

2297

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

2298

2299

else:

2300

key_id = ""

2301

try:

2302

fpr = self.fingerprint(

2303

self.peer_certificate(session))

2304

except (TypeError, gnutls.Error) as error:

2305

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

2306

return

2307

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

2308

2309

try:

2310

client = ProxyClient(child_pipe, key_id, fpr,

1735

2311

self.client_address)

1736

2312

except KeyError:

1737

2313

return

1738

2314

1739

2315

if client.approval_delay:

1740

2316

delay = client.approval_delay

1741

2317

client.approvals_pending += 1

1742

2318

approval_required = True

1743

2319

1744

2320

while True:

1745

2321

if not client.enabled:

1746

2322

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

1747

client.name)

2323

client.name)

1748

2324

if self.server.use_dbus:

1749

2325

# Emit D-Bus signal

1750

2326

client.Rejected("Disabled")

1751

2327

return

1752

2328

1753

2329

if client.approved or not client.approval_delay:

1754

#We are approved or approval is disabled

2330

# We are approved or approval is disabled

1755

2331

break

1756

2332

elif client.approved is None:

1757

2333

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

1759

2335

if self.server.use_dbus:

1760

2336

# Emit D-Bus signal

1761

2337

client.NeedApproval(

1762

client.approval_delay_milliseconds(),

1763

client.approved_by_default)

2338

client.approval_delay.total_seconds()

2339

* 1000, client.approved_by_default)

1764

2340

else:

1765

2341

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

1766

2342

client.name)

1768

2344

# Emit D-Bus signal

1769

2345

client.Rejected("Denied")

1770

2346

return

1771

1772

#wait until timeout or approved

2347

2348

# wait until timeout or approved

1773

2349

time = datetime.datetime.now()

1774

2350

client.changedstate.acquire()

1775

client.changedstate.wait(

1776

float(timedelta_to_milliseconds(delay)

1777

/ 1000))

2351

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

1778

2352

client.changedstate.release()

1779

2353

time2 = datetime.datetime.now()

1780

2354

if (time2 - time) >= delay:

1790

2364

break

1791

2365

else:

1792

2366

delay -= time2 - time

1793

1794

sent_size = 0

1795

while sent_size < len(client.secret):

1796

try:

1797

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

1798

except gnutls.errors.GNUTLSError as error:

1799

logger.warning("gnutls send failed",

1800

exc_info=error)

1801

return

1802

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

1803

sent, len(client.secret)

1804

- (sent_size + sent))

1805

sent_size += sent

1806

2367

2368

try:

2369

session.send(client.secret)

2370

except gnutls.Error as error:

2371

logger.warning("gnutls send failed",

2372

exc_info=error)

2373

return

2374

1807

2375

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

1808

2376

# bump the timeout using extended_timeout

1809

2377

client.bump_timeout(client.extended_timeout)

1810

2378

if self.server.use_dbus:

1811

2379

# Emit D-Bus signal

1812

2380

client.GotSecret()

1813

2381

1814

2382

finally:

1815

2383

if approval_required:

1816

2384

client.approvals_pending -= 1

1817

2385

try:

1818

2386

session.bye()

1819

except gnutls.errors.GNUTLSError as error:

2387

except gnutls.Error as error:

1820

2388

logger.warning("GnuTLS bye failed",

1821

2389

exc_info=error)

1822

2390

1823

2391

@staticmethod

1824

2392

def peer_certificate(session):

1825

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

1826

# If not an OpenPGP certificate...

1827

if (gnutls.library.functions

1828

.gnutls_certificate_type_get(session._c_object)

1829

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1830

# ...do the normal thing

1831

return session.peer_certificate

2393

"Return the peer's certificate as a bytestring"

2394

try:

2395

cert_type = gnutls.certificate_type_get2(session._c_object,

2396

gnutls.CTYPE_PEERS)

2397

except AttributeError:

2398

cert_type = gnutls.certificate_type_get(session._c_object)

2399

if gnutls.has_rawpk:

2400

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2401

else:

2402

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2403

# If not a valid certificate type...

2404

if cert_type not in valid_cert_types:

2405

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

2406

valid_cert_types)

2407

# ...return invalid data

2408

return b""

1832

2409

list_size = ctypes.c_uint(1)

1833

cert_list = (gnutls.library.functions

1834

.gnutls_certificate_get_peers

2410

cert_list = (gnutls.certificate_get_peers

1835

2411

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

1836

2412

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

1837

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

1838

" certificate")

2413

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

1839

2414

if list_size.value == 0:

1840

2415

return None

1841

2416

cert = cert_list[0]

1842

2417

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

1843

2418

2419

@staticmethod

2420

def key_id(certificate):

2421

"Convert a certificate bytestring to a hexdigit key ID"

2422

# New GnuTLS "datum" with the public key

2423

datum = gnutls.datum_t(

2424

ctypes.cast(ctypes.c_char_p(certificate),

2425

ctypes.POINTER(ctypes.c_ubyte)),

2426

ctypes.c_uint(len(certificate)))

2427

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

2428

# New empty GnuTLS certificate

2429

pubkey = gnutls.pubkey_t()

2430

gnutls.pubkey_init(ctypes.byref(pubkey))

2431

# Import the raw public key into the certificate

2432

gnutls.pubkey_import(pubkey,

2433

ctypes.byref(datum),

2434

gnutls.X509_FMT_DER)

2435

# New buffer for the key ID

2436

buf = ctypes.create_string_buffer(32)

2437

buf_len = ctypes.c_size_t(len(buf))

2438

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

2439

gnutls.pubkey_get_key_id(pubkey,

2440

gnutls.KEYID_USE_SHA256,

2441

ctypes.cast(ctypes.byref(buf),

2442

ctypes.POINTER(ctypes.c_ubyte)),

2443

ctypes.byref(buf_len))

2444

# Deinit the certificate

2445

gnutls.pubkey_deinit(pubkey)

2446

2447

# Convert the buffer to a Python bytestring

2448

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

2449

# Convert the bytestring to hexadecimal notation

2450

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

2451

return hex_key_id

2452

1844

2453

@staticmethod

1845

2454

def fingerprint(openpgp):

1846

2455

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1847

2456

# New GnuTLS "datum" with the OpenPGP public key

1848

datum = (gnutls.library.types

1849

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

1850

ctypes.POINTER

1851

(ctypes.c_ubyte)),

1852

ctypes.c_uint(len(openpgp))))

2457

datum = gnutls.datum_t(

2458

ctypes.cast(ctypes.c_char_p(openpgp),

2459

ctypes.POINTER(ctypes.c_ubyte)),

2460

ctypes.c_uint(len(openpgp)))

1853

2461

# New empty GnuTLS certificate

1854

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1855

(gnutls.library.functions

1856

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2462

crt = gnutls.openpgp_crt_t()

2463

gnutls.openpgp_crt_init(ctypes.byref(crt))

1857

2464

# Import the OpenPGP public key into the certificate

1858

(gnutls.library.functions

1859

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

1860

gnutls.library.constants

1861

.GNUTLS_OPENPGP_FMT_RAW))

2465

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

2466

gnutls.OPENPGP_FMT_RAW)

1862

2467

# Verify the self signature in the key

1863

2468

crtverify = ctypes.c_uint()

1864

(gnutls.library.functions

1865

.gnutls_openpgp_crt_verify_self(crt, 0,

1866

ctypes.byref(crtverify)))

2469

gnutls.openpgp_crt_verify_self(crt, 0,

2470

ctypes.byref(crtverify))

1867

2471

if crtverify.value != 0:

1868

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1869

raise (gnutls.errors.CertificateSecurityError

1870

("Verify failed"))

2472

gnutls.openpgp_crt_deinit(crt)

2473

raise gnutls.CertificateSecurityError(code

2474

=crtverify.value)

1871

2475

# New buffer for the fingerprint

1872

2476

buf = ctypes.create_string_buffer(20)

1873

2477

buf_len = ctypes.c_size_t()

1874

2478

# Get the fingerprint from the certificate into the buffer

1875

(gnutls.library.functions

1876

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

1877

ctypes.byref(buf_len)))

2479

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

2480

ctypes.byref(buf_len))

1878

2481

# Deinit the certificate

1879

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2482

gnutls.openpgp_crt_deinit(crt)

1880

2483

# Convert the buffer to a Python bytestring

1881

2484

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

1882

2485

# Convert the bytestring to hexadecimal notation

1886

2489

1887

2490

class MultiprocessingMixIn(object):

1888

2491

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

2492

1889

2493

def sub_process_main(self, request, address):

1890

2494

try:

1891

2495

self.finish_request(request, address)

1892

2496

except Exception:

1893

2497

self.handle_error(request, address)

1894

2498

self.close_request(request)

1895

2499

1896

2500

def process_request(self, request, address):

1897

2501

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

1898

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

1899

args = (request, address))

2502

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

2503

args=(request, address))

1900

2504

proc.start()

1901

2505

return proc

1902

2506

1903

2507

1904

2508

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1905

2509

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

2510

1906

2511

def process_request(self, request, client_address):

1907

2512

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

1908

2513

1909

2514

This function creates a new pipe in self.pipe

1910

2515

"""

1911

2516

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1912

2517

1913

2518

proc = MultiprocessingMixIn.process_request(self, request,

1914

2519

client_address)

1915

2520

self.child_pipe.close()

1916

2521

self.add_pipe(parent_pipe, proc)

1917

2522

1918

2523

def add_pipe(self, parent_pipe, proc):

1919

2524

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

1920

2525

raise NotImplementedError()

1923

2528

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1924

2529

socketserver.TCPServer, object):

1925

2530

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

1926

2531

1927

2532

Attributes:

1928

2533

enabled: Boolean; whether this server is activated yet

1929

2534

interface: None or a network interface name (string)

1930

2535

use_ipv6: Boolean; to use IPv6 or not

1931

2536

"""

2537

1932

2538

def __init__(self, server_address, RequestHandlerClass,

1933

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

2539

interface=None,

2540

use_ipv6=True,

2541

socketfd=None):

1934

2542

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

1935

2543

creating a new one with socket.socket().

1936

2544

"""

1942

2550

self.socketfd = socketfd

1943

2551

# Save the original socket.socket() function

1944

2552

self.socket_socket = socket.socket

2553

1945

2554

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

1946

#

2555

#

1947

2556

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

1948

2557

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

1949

2558

# patching socket.socket.)

1950

#

2559

#

1951

2560

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

1952

2561

@functools.wraps(socket.socket)

1953

2562

def socket_wrapper(*args, **kwargs):

1965

2574

# socket_wrapper(), if socketfd was set.

1966

2575

socketserver.TCPServer.__init__(self, server_address,

1967

2576

RequestHandlerClass)

1968

2577

1969

2578

def server_bind(self):

1970

2579

"""This overrides the normal server_bind() function

1971

2580

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

1972

2581

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

2582

global SO_BINDTODEVICE

1973

2583

if self.interface is not None:

1974

2584

if SO_BINDTODEVICE is None:

1975

logger.error("SO_BINDTODEVICE does not exist;"

1976

" cannot bind to interface %s",

1977

self.interface)

1978

else:

1979

try:

1980

self.socket.setsockopt(socket.SOL_SOCKET,

1981

SO_BINDTODEVICE,

1982

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

1983

except socket.error as error:

1984

if error.errno == errno.EPERM:

1985

logger.error("No permission to bind to"

1986

" interface %s", self.interface)

1987

elif error.errno == errno.ENOPROTOOPT:

1988

logger.error("SO_BINDTODEVICE not available;"

1989

" cannot bind to interface %s",

1990

self.interface)

1991

elif error.errno == errno.ENODEV:

1992

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

1993

" cannot bind", self.interface)

1994

else:

1995

raise

2585

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

2586

# common enough.

2587

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

2588

SO_BINDTODEVICE = 25

2589

try:

2590

self.socket.setsockopt(

2591

socket.SOL_SOCKET, SO_BINDTODEVICE,

2592

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

2593

except socket.error as error:

2594

if error.errno == errno.EPERM:

2595

logger.error("No permission to bind to"

2596

" interface %s", self.interface)

2597

elif error.errno == errno.ENOPROTOOPT:

2598

logger.error("SO_BINDTODEVICE not available;"

2599

" cannot bind to interface %s",

2600

self.interface)

2601

elif error.errno == errno.ENODEV:

2602

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

2603

" cannot bind", self.interface)

2604

else:

2605

raise

1996

2606

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

1997

2607

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

2608

if self.server_address[1]:

2609

self.allow_reuse_address = True

1998

2610

if not self.server_address[0]:

1999

2611

if self.address_family == socket.AF_INET6:

2000

any_address = "::" # in6addr_any

2612

any_address = "::" # in6addr_any

2001

2613

else:

2002

any_address = "0.0.0.0" # INADDR_ANY

2614

any_address = "0.0.0.0" # INADDR_ANY

2003

2615

self.server_address = (any_address,

2004

2616

self.server_address[1])

2005

2617

elif not self.server_address[1]:

2006

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

2007

0)

2618

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

2008

2619

# if self.interface:

2009

2620

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

2010

2621

# 0, # port

2016

2627

2017

2628

class MandosServer(IPv6_TCPServer):

2018

2629

"""Mandos server.

2019

2630

2020

2631

Attributes:

2021

2632

clients: set of Client objects

2022

2633

gnutls_priority GnuTLS priority string

2023

2634

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

2024

2025

Assumes a gobject.MainLoop event loop.

2635

2636

Assumes a GLib.MainLoop event loop.

2026

2637

"""

2638

2027

2639

def __init__(self, server_address, RequestHandlerClass,

2028

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

2029

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

2640

interface=None,

2641

use_ipv6=True,

2642

clients=None,

2643

gnutls_priority=None,

2644

use_dbus=True,

2645

socketfd=None):

2030

2646

self.enabled = False

2031

2647

self.clients = clients

2032

2648

if self.clients is None:

2035

2651

self.gnutls_priority = gnutls_priority

2036

2652

IPv6_TCPServer.__init__(self, server_address,

2037

2653

RequestHandlerClass,

2038

interface = interface,

2039

use_ipv6 = use_ipv6,

2040

socketfd = socketfd)

2654

interface=interface,

2655

use_ipv6=use_ipv6,

2656

socketfd=socketfd)

2657

2041

2658

def server_activate(self):

2042

2659

if self.enabled:

2043

2660

return socketserver.TCPServer.server_activate(self)

2044

2661

2045

2662

def enable(self):

2046

2663

self.enabled = True

2047

2664

2048

2665

def add_pipe(self, parent_pipe, proc):

2049

2666

# Call "handle_ipc" for both data and EOF events

2050

gobject.io_add_watch(parent_pipe.fileno(),

2051

gobject.IO_IN | gobject.IO_HUP,

2052

functools.partial(self.handle_ipc,

2053

parent_pipe =

2054

parent_pipe,

2055

proc = proc))

2056

2057

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

2058

proc = None, client_object=None):

2667

GLib.io_add_watch(

2668

parent_pipe.fileno(),

2669

GLib.IO_IN | GLib.IO_HUP,

2670

functools.partial(self.handle_ipc,

2671

parent_pipe=parent_pipe,

2672

proc=proc))

2673

2674

def handle_ipc(self, source, condition,

2675

parent_pipe=None,

2676

proc=None,

2677

client_object=None):

2059

2678

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

2060

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

2679

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

2061

2680

# Wait for other process to exit

2062

2681

proc.join()

2063

2682

return False

2064

2683

2065

2684

# Read a request from the child

2066

2685

request = parent_pipe.recv()

2067

2686

command = request[0]

2068

2687

2069

2688

if command == 'init':

2070

fpr = request[1]

2071

address = request[2]

2072

2073

for c in self.clients.itervalues():

2074

if c.fingerprint == fpr:

2689

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

2690

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

2691

address = request[3]

2692

2693

for c in self.clients.values():

2694

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2695

continue

2696

if key_id and c.key_id == key_id:

2697

client = c

2698

break

2699

if fpr and c.fingerprint == fpr:

2075

2700

client = c

2076

2701

break

2077

2702

else:

2078

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

2079

"dress: %s", fpr, address)

2703

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

2704

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

2080

2705

if self.use_dbus:

2081

2706

# Emit D-Bus signal

2082

mandos_dbus_service.ClientNotFound(fpr,

2707

mandos_dbus_service.ClientNotFound(key_id or fpr,

2083

2708

address[0])

2084

2709

parent_pipe.send(False)

2085

2710

return False

2086

2087

gobject.io_add_watch(parent_pipe.fileno(),

2088

gobject.IO_IN | gobject.IO_HUP,

2089

functools.partial(self.handle_ipc,

2090

parent_pipe =

2091

parent_pipe,

2092

proc = proc,

2093

client_object =

2094

client))

2711

2712

GLib.io_add_watch(

2713

parent_pipe.fileno(),

2714

GLib.IO_IN | GLib.IO_HUP,

2715

functools.partial(self.handle_ipc,

2716

parent_pipe=parent_pipe,

2717

proc=proc,

2718

client_object=client))

2095

2719

parent_pipe.send(True)

2096

2720

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

2097

2721

# same fileno

2100

2724

funcname = request[1]

2101

2725

args = request[2]

2102

2726

kwargs = request[3]

2103

2727

2104

2728

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

2105

2729

funcname)(*args,

2106

**kwargs)))

2107

2730

**kwargs)))

2731

2108

2732

if command == 'getattr':

2109

2733

attrname = request[1]

2110

if callable(client_object.__getattribute__(attrname)):

2111

parent_pipe.send(('function',))

2734

if isinstance(client_object.__getattribute__(attrname),

2735

collections.Callable):

2736

parent_pipe.send(('function', ))

2112

2737

else:

2113

parent_pipe.send(('data', client_object

2114

.__getattribute__(attrname)))

2115

2738

parent_pipe.send((

2739

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

2740

2116

2741

if command == 'setattr':

2117

2742

attrname = request[1]

2118

2743

value = request[2]

2119

2744

setattr(client_object, attrname, value)

2120

2745

2121

2746

return True

2122

2747

2123

2748

2124

2749

def rfc3339_duration_to_delta(duration):

2125

2750

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

2126

2751

2127

2752

>>> rfc3339_duration_to_delta("P7D")

2128

2753

datetime.timedelta(7)

2129

2754

>>> rfc3339_duration_to_delta("PT60S")

2139

2764

>>> rfc3339_duration_to_delta("P1DT3M20S")

2140

2765

datetime.timedelta(1, 200)

2141

2766

"""

2142

2767

2143

2768

# Parsing an RFC 3339 duration with regular expressions is not

2144

2769

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

2145

2770

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

2146

2771

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

2147

2772

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

2148

2773

# avoid excessive use of external libraries.

2149

2774

2150

2775

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

2151

Token = collections.namedtuple("Token",

2152

("regexp", # To match token; if

2153

# "value" is not None,

2154

# must have a "group"

2155

# containing digits

2156

"value", # datetime.timedelta or

2157

# None

2158

"followers")) # Tokens valid after

2159

# this token

2776

Token = collections.namedtuple("Token", (

2777

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

2778

# a "group" containing digits

2779

"value", # datetime.timedelta or None

2780

"followers")) # Tokens valid after this token

2160

2781

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

2161

2782

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

2162

2783

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

2163

2784

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

2164

2785

datetime.timedelta(seconds=1),

2165

frozenset((token_end,)))

2786

frozenset((token_end, )))

2166

2787

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

2167

2788

datetime.timedelta(minutes=1),

2168

2789

frozenset((token_second, token_end)))

2184

2805

frozenset((token_month, token_end)))

2185

2806

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

2186

2807

datetime.timedelta(weeks=1),

2187

frozenset((token_end,)))

2808

frozenset((token_end, )))

2188

2809

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

2189

2810

frozenset((token_year, token_month,

2190

2811

token_day, token_time,

2191

token_week))),

2192

# Define starting values

2193

value = datetime.timedelta() # Value so far

2812

token_week)))

2813

# Define starting values:

2814

# Value so far

2815

value = datetime.timedelta()

2194

2816

found_token = None

2195

followers = frozenset(token_duration,) # Following valid tokens

2196

s = duration # String left to parse

2817

# Following valid tokens

2818

followers = frozenset((token_duration, ))

2819

# String left to parse

2820

s = duration

2197

2821

# Loop until end token is found

2198

2822

while found_token is not token_end:

2199

2823

# Search for any currently valid tokens

2215

2839

break

2216

2840

else:

2217

2841

# No currently valid tokens were found

2218

raise ValueError("Invalid RFC 3339 duration")

2842

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

2843

.format(duration))

2219

2844

# End token found

2220

2845

return value

2221

2846

2222

2847

2223

2848

def string_to_delta(interval):

2224

2849

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

2225

2850

2226

2851

>>> string_to_delta('7d')

2227

2852

datetime.timedelta(7)

2228

2853

>>> string_to_delta('60s')

2236

2861

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

2237

2862

datetime.timedelta(0, 330)

2238

2863

"""

2239

2864

2240

2865

try:

2241

2866

return rfc3339_duration_to_delta(interval)

2242

2867

except ValueError:

2243

2868

pass

2244

2869

2245

2870

timevalue = datetime.timedelta(0)

2246

2871

for s in interval.split():

2247

2872

try:

2248

suffix = unicode(s[-1])

2873

suffix = s[-1]

2249

2874

value = int(s[:-1])

2250

2875

if suffix == "d":

2251

2876

delta = datetime.timedelta(value)

2258

2883

elif suffix == "w":

2259

2884

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

2260

2885

else:

2261

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

2262

.format(suffix))

2886

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

2263

2887

except IndexError as e:

2264

2888

raise ValueError(*(e.args))

2265

2889

timevalue += delta

2266

2890

return timevalue

2267

2891

2268

2892

2269

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

2893

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

2270

2894

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

2271

2895

2272

2896

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

2273

2897

if os.fork():

2274

2898

sys.exit()

2282

2906

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

2283

2907

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

2284

2908

raise OSError(errno.ENODEV,

2285

"{0} not a character device"

2909

"{} not a character device"

2286

2910

.format(os.devnull))

2287

2911

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

2288

2912

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

2292

2916

2293

2917

2294

2918

def main():

2295

2919

2296

2920

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

2297

2921

# Parsing of options, both command line and config file

2298

2922

2299

2923

parser = argparse.ArgumentParser()

2300

2924

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

2301

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

2925

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

2302

2926

help="show version number and exit")

2303

2927

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

2304

2928

help="Bind to interface IF")

2340

2964

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

2341

2965

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

2342

2966

default=None)

2343

2967

2344

2968

options = parser.parse_args()

2345

2969

2346

2970

if options.check:

2347

2971

import doctest

2348

2972

fail_count, test_count = doctest.testmod()

2349

2973

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

2350

2974

2351

2975

# Default values for config file for server-global settings

2352

server_defaults = { "interface": "",

2353

"address": "",

2354

"port": "",

2355

"debug": "False",

2356

"priority":

2357

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

2358

"servicename": "Mandos",

2359

"use_dbus": "True",

2360

"use_ipv6": "True",

2361

"debuglevel": "",

2362

"restore": "True",

2363

"socket": "",

2364

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

2365

"foreground": "False",

2366

"zeroconf": "True",

2367

}

2368

2976

if gnutls.has_rawpk:

2977

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

2978

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

2979

else:

2980

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

2981

":+SIGN-DSA-SHA256")

2982

server_defaults = {"interface": "",

2983

"address": "",

2984

"port": "",

2985

"debug": "False",

2986

"priority": priority,

2987

"servicename": "Mandos",

2988

"use_dbus": "True",

2989

"use_ipv6": "True",

2990

"debuglevel": "",

2991

"restore": "True",

2992

"socket": "",

2993

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

2994

"foreground": "False",

2995

"zeroconf": "True",

2996

}

2997

del priority

2998

2369

2999

# Parse config file for server-global settings

2370

3000

server_config = configparser.SafeConfigParser(server_defaults)

2371

3001

del server_defaults

2372

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

2373

"mandos.conf"))

3002

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

2374

3003

# Convert the SafeConfigParser object to a dict

2375

3004

server_settings = server_config.defaults()

2376

3005

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

2377

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

3006

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

3007

"foreground", "zeroconf"):

2378

3008

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

2379

3009

option)

2380

3010

if server_settings["port"]:

2390

3020

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

2391

3021

["socket"])

2392

3022

del server_config

2393

3023

2394

3024

# Override the settings from the config file with command line

2395

3025

# options, if set.

2396

3026

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

2397

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

2398

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

2399

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

3027

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

3028

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

3029

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

2400

3030

value = getattr(options, option)

2401

3031

if value is not None:

2402

3032

server_settings[option] = value

2403

3033

del options

2404

3034

# Force all strings to be unicode

2405

3035

for option in server_settings.keys():

2406

if type(server_settings[option]) is str:

2407

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

3036

if isinstance(server_settings[option], bytes):

3037

server_settings[option] = (server_settings[option]

3038

.decode("utf-8"))

2408

3039

# Force all boolean options to be boolean

2409

3040

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

2410

3041

"foreground", "zeroconf"):

2413

3044

if server_settings["debug"]:

2414

3045

server_settings["foreground"] = True

2415

3046

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

2416

3047

2417

3048

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

2418

2419

if (not server_settings["zeroconf"] and

2420

not (server_settings["port"]

2421

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

2422

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

2423

" Zeroconf")

2424

3049

3050

if (not server_settings["zeroconf"]

3051

and not (server_settings["port"]

3052

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

3053

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

3054

2425

3055

# For convenience

2426

3056

debug = server_settings["debug"]

2427

3057

debuglevel = server_settings["debuglevel"]

2431

3061

stored_state_file)

2432

3062

foreground = server_settings["foreground"]

2433

3063

zeroconf = server_settings["zeroconf"]

2434

3064

2435

3065

if debug:

2436

3066

initlogger(debug, logging.DEBUG)

2437

3067

else:

2440

3070

else:

2441

3071

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

2442

3072

initlogger(debug, level)

2443

3073

2444

3074

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

2445

syslogger.setFormatter(logging.Formatter

2446

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

2447

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

2448

.format(server_settings

2449

["servicename"])))

2450

3075

syslogger.setFormatter(

3076

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

3077

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

3078

server_settings["servicename"])))

3079

2451

3080

# Parse config file with clients

2452

3081

client_config = configparser.SafeConfigParser(Client

2453

3082

.client_defaults)

2454

3083

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

2455

3084

"clients.conf"))

2456

3085

2457

3086

global mandos_dbus_service

2458

3087

mandos_dbus_service = None

2459

3088

2460

3089

socketfd = None

2461

3090

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

2462

3091

socketfd = server_settings["socket"]

2463

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

2464

server_settings["port"]),

2465

ClientHandler,

2466

interface=(server_settings["interface"]

2467

or None),

2468

use_ipv6=use_ipv6,

2469

gnutls_priority=

2470

server_settings["priority"],

2471

use_dbus=use_dbus,

2472

socketfd=socketfd)

3092

tcp_server = MandosServer(

3093

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

3094

ClientHandler,

3095

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

3096

use_ipv6=use_ipv6,

3097

gnutls_priority=server_settings["priority"],

3098

use_dbus=use_dbus,

3099

socketfd=socketfd)

2473

3100

if not foreground:

2474

3101

pidfilename = "/run/mandos.pid"

2475

3102

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

2476

3103

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

2477

3104

pidfile = None

2478

3105

try:

2479

pidfile = open(pidfilename, "w")

3106

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

2480

3107

except IOError as e:

2481

3108

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

2482

3109

exc_info=e)

2483

2484

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

3110

3111

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

3112

("mandos", "mandos"),

3113

("nobody", "nogroup")):

2485

3114

try:

2486

3115

uid = pwd.getpwnam(name).pw_uid

2487

gid = pwd.getpwnam(name).pw_gid

3116

gid = pwd.getpwnam(group).pw_gid

2488

3117

break

2489

3118

except KeyError:

2490

3119

continue

2494

3123

try:

2495

3124

os.setgid(gid)

2496

3125

os.setuid(uid)

3126

if debug:

3127

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

3128

gid))

2497

3129

except OSError as error:

3130

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

3131

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

2498

3132

if error.errno != errno.EPERM:

2499

3133

raise

2500

3134

2501

3135

if debug:

2502

3136

# Enable all possible GnuTLS debugging

2503

3137

2504

3138

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

2505

3139

# - GnuTLS manual

2506

gnutls.library.functions.gnutls_global_set_log_level(11)

2507

2508

@gnutls.library.types.gnutls_log_func

3140

gnutls.global_set_log_level(11)

3141

3142

@gnutls.log_func

2509

3143

def debug_gnutls(level, string):

2510

3144

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

2511

2512

(gnutls.library.functions

2513

.gnutls_global_set_log_function(debug_gnutls))

2514

3145

3146

gnutls.global_set_log_function(debug_gnutls)

3147

2515

3148

# Redirect stdin so all checkers get /dev/null

2516

3149

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

2517

3150

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

2518

3151

if null > 2:

2519

3152

os.close(null)

2520

3153

2521

3154

# Need to fork before connecting to D-Bus

2522

3155

if not foreground:

2523

3156

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

2524

3157

daemon()

2525

2526

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

2527

# need to inform gobject that threads will be used.

2528

gobject.threads_init()

2529

3158

3159

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

3160

# to inform GLib that threads will be used.

3161

GLib.threads_init()

3162

2530

3163

global main_loop

2531

3164

# From the Avahi example code

2532

3165

DBusGMainLoop(set_as_default=True)

2533

main_loop = gobject.MainLoop()

3166

main_loop = GLib.MainLoop()

2534

3167

bus = dbus.SystemBus()

2535

3168

# End of Avahi example code

2536

3169

if use_dbus:

2537

3170

try:

2538

3171

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

2539

bus, do_not_queue=True)

2540

old_bus_name = (dbus.service.BusName

2541

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

2542

do_not_queue=True))

2543

except dbus.exceptions.NameExistsException as e:

3172

bus,

3173

do_not_queue=True)

3174

old_bus_name = dbus.service.BusName(

3175

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

3176

do_not_queue=True)

3177

except dbus.exceptions.DBusException as e:

2544

3178

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

2545

3179

use_dbus = False

2546

3180

server_settings["use_dbus"] = False

2547

3181

tcp_server.use_dbus = False

2548

3182

if zeroconf:

2549

3183

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2550

service = AvahiServiceToSyslog(name =

2551

server_settings["servicename"],

2552

servicetype = "_mandos._tcp",

2553

protocol = protocol, bus = bus)

3184

service = AvahiServiceToSyslog(

3185

name=server_settings["servicename"],

3186

servicetype="_mandos._tcp",

3187

protocol=protocol,

3188

bus=bus)

2554

3189

if server_settings["interface"]:

2555

service.interface = (if_nametoindex

2556

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

2557

3190

service.interface = if_nametoindex(

3191

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

3192

2558

3193

global multiprocessing_manager

2559

3194

multiprocessing_manager = multiprocessing.Manager()

2560

3195

2561

3196

client_class = Client

2562

3197

if use_dbus:

2563

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

2564

3198

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

3199

2565

3200

client_settings = Client.config_parser(client_config)

2566

3201

old_client_settings = {}

2567

3202

clients_data = {}

2568

3203

2569

3204

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

2570

3205

global wnull

2571

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

3206

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

2572

3207

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

2573

3208

# mode

2574

3209

if debug or not foreground:

2575

3210

wnull.close()

2576

3211

2577

3212

# Get client data and settings from last running state.

2578

3213

if server_settings["restore"]:

2579

3214

try:

2580

3215

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

2581

clients_data, old_client_settings = (pickle.load

2582

(stored_state))

3216

if sys.version_info.major == 2:

3217

clients_data, old_client_settings = pickle.load(

3218

stored_state)

3219

else:

3220

bytes_clients_data, bytes_old_client_settings = (

3221

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

3222

# Fix bytes to strings

3223

# clients_data

3224

# .keys()

3225

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

3226

if isinstance(key, bytes)

3227

else key): value

3228

for key, value in

3229

bytes_clients_data.items()}

3230

del bytes_clients_data

3231

for key in clients_data:

3232

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

3233

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

3234

for k, v in

3235

clients_data[key].items()}

3236

clients_data[key] = value

3237

# .client_structure

3238

value["client_structure"] = [

3239

(s.decode("utf-8")

3240

if isinstance(s, bytes)

3241

else s) for s in

3242

value["client_structure"]]

3243

# .name & .host

3244

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

3245

if isinstance(value[k], bytes):

3246

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

3247

if not value.has_key("key_id"):

3248

value["key_id"] = ""

3249

elif not value.has_key("fingerprint"):

3250

value["fingerprint"] = ""

3251

# old_client_settings

3252

# .keys()

3253

old_client_settings = {

3254

(key.decode("utf-8")

3255

if isinstance(key, bytes)

3256

else key): value

3257

for key, value in

3258

bytes_old_client_settings.items()}

3259

del bytes_old_client_settings

3260

# .host

3261

for value in old_client_settings.values():

3262

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

3263

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

3264

.decode("utf-8"))

2583

3265

os.remove(stored_state_path)

2584

3266

except IOError as e:

2585

3267

if e.errno == errno.ENOENT:

2586

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

2587

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

3268

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

3269

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

2588

3270

else:

2589

3271

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

2590

3272

exc_info=e)

2591

3273

raise

2592

3274

except EOFError as e:

2593

3275

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

2594

"EOFError:", exc_info=e)

2595

3276

"EOFError:",

3277

exc_info=e)

3278

2596

3279

with PGPEngine() as pgp:

2597

for client_name, client in clients_data.iteritems():

3280

for client_name, client in clients_data.items():

2598

3281

# Skip removed clients

2599

3282

if client_name not in client_settings:

2600

3283

continue

2601

3284

2602

3285

# Decide which value to use after restoring saved state.

2603

3286

# We have three different values: Old config file,

2604

3287

# new config file, and saved state.

2609

3292

# For each value in new config, check if it

2610

3293

# differs from the old config value (Except for

2611

3294

# the "secret" attribute)

2612

if (name != "secret" and

2613

value != old_client_settings[client_name]

2614

[name]):

3295

if (name != "secret"

3296

and (value !=

3297

old_client_settings[client_name][name])):

2615

3298

client[name] = value

2616

3299

except KeyError:

2617

3300

pass

2618

3301

2619

3302

# Clients who has passed its expire date can still be

2620

# enabled if its last checker was successful. Clients

3303

# enabled if its last checker was successful. A Client

2621

3304

# whose checker succeeded before we stored its state is

2622

3305

# assumed to have successfully run all checkers during

2623

3306

# downtime.

2625

3308

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

2626

3309

if not client["last_checked_ok"]:

2627

3310

logger.warning(

2628

"disabling client {0} - Client never "

2629

"performed a successful checker"

2630

.format(client_name))

3311

"disabling client {} - Client never "

3312

"performed a successful checker".format(

3313

client_name))

2631

3314

client["enabled"] = False

2632

3315

elif client["last_checker_status"] != 0:

2633

3316

logger.warning(

2634

"disabling client {0} - Client "

2635

"last checker failed with error code {1}"

2636

.format(client_name,

2637

client["last_checker_status"]))

3317

"disabling client {} - Client last"

3318

" checker failed with error code"

3319

" {}".format(

3320

client_name,

3321

client["last_checker_status"]))

2638

3322

client["enabled"] = False

2639

3323

else:

2640

client["expires"] = (datetime.datetime

2641

.utcnow()

2642

+ client["timeout"])

3324

client["expires"] = (

3325

datetime.datetime.utcnow()

3326

+ client["timeout"])

2643

3327

logger.debug("Last checker succeeded,"

2644

" keeping {0} enabled"

2645

.format(client_name))

3328

" keeping {} enabled".format(

3329

client_name))

2646

3330

try:

2647

client["secret"] = (

2648

pgp.decrypt(client["encrypted_secret"],

2649

client_settings[client_name]

2650

["secret"]))

3331

client["secret"] = pgp.decrypt(

3332

client["encrypted_secret"],

3333

client_settings[client_name]["secret"])

2651

3334

except PGPError:

2652

3335

# If decryption fails, we use secret from new settings

2653

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

2654

.format(client_name))

2655

client["secret"] = (

2656

client_settings[client_name]["secret"])

2657

3336

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

3337

client_name))

3338

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

3339

["secret"])

3340

2658

3341

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

2659

3342

for client_name in (set(old_client_settings)

2660

3343

- set(client_settings)):

2662

3345

for client_name in (set(client_settings)

2663

3346

- set(old_client_settings)):

2664

3347

clients_data[client_name] = client_settings[client_name]

2665

3348

2666

3349

# Create all client objects

2667

for client_name, client in clients_data.iteritems():

3350

for client_name, client in clients_data.items():

2668

3351

tcp_server.clients[client_name] = client_class(

2669

name = client_name, settings = client,

2670

server_settings = server_settings)

2671

3352

name=client_name,

3353

settings=client,

3354

server_settings=server_settings)

3355

2672

3356

if not tcp_server.clients:

2673

3357

logger.warning("No clients defined")

2674

3358

2675

3359

if not foreground:

2676

3360

if pidfile is not None:

3361

pid = os.getpid()

2677

3362

try:

2678

3363

with pidfile:

2679

pid = os.getpid()

2680

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

3364

print(pid, file=pidfile)

2681

3365

except IOError:

2682

3366

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

2683

3367

pidfilename, pid)

2684

3368

del pidfile

2685

3369

del pidfilename

2686

2687

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

2688

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

2689

3370

3371

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

3372

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3373

lambda: main_loop.quit() and False)

3374

2690

3375

if use_dbus:

2691

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

2692

"se.bsnet.fukt.Mandos"})

2693

class MandosDBusService(DBusObjectWithProperties):

3376

3377

@alternate_dbus_interfaces(

3378

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

3379

class MandosDBusService(DBusObjectWithObjectManager):

2694

3380

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

3381

2695

3382

def __init__(self):

2696

3383

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

3384

2697

3385

_interface = "se.recompile.Mandos"

2698

2699

@dbus_interface_annotations(_interface)

2700

def _foo(self):

2701

return { "org.freedesktop.DBus.Property"

2702

".EmitsChangedSignal":

2703

"false"}

2704

3386

2705

3387

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

2706

3388

def ClientAdded(self, objpath):

2707

3389

"D-Bus signal"

2708

3390

pass

2709

3391

2710

3392

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

2711

def ClientNotFound(self, fingerprint, address):

3393

def ClientNotFound(self, key_id, address):

2712

3394

"D-Bus signal"

2713

3395

pass

2714

3396

3397

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

3398

"true"})

2715

3399

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

2716

3400

def ClientRemoved(self, objpath, name):

2717

3401

"D-Bus signal"

2718

3402

pass

2719

3403

3404

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

3405

"true"})

2720

3406

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

2721

3407

def GetAllClients(self):

2722

3408

"D-Bus method"

2723

return dbus.Array(c.dbus_object_path

2724

for c in

2725

tcp_server.clients.itervalues())

2726

3409

return dbus.Array(c.dbus_object_path for c in

3410

tcp_server.clients.values())

3411

3412

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

3413

"true"})

2727

3414

@dbus.service.method(_interface,

2728

3415

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

2729

3416

def GetAllClientsWithProperties(self):

2730

3417

"D-Bus method"

2731

3418

return dbus.Dictionary(

2732

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

2733

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

3419

{c.dbus_object_path: c.GetAll(

3420

"se.recompile.Mandos.Client")

3421

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

2734

3422

signature="oa{sv}")

2735

3423

2736

3424

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

2737

3425

def RemoveClient(self, object_path):

2738

3426

"D-Bus method"

2739

for c in tcp_server.clients.itervalues():

3427

for c in tcp_server.clients.values():

2740

3428

if c.dbus_object_path == object_path:

2741

3429

del tcp_server.clients[c.name]

2742

3430

c.remove_from_connection()

2743

# Don't signal anything except ClientRemoved

3431

# Don't signal the disabling

2744

3432

c.disable(quiet=True)

2745

# Emit D-Bus signal

2746

self.ClientRemoved(object_path, c.name)

3433

# Emit D-Bus signal for removal

3434

self.client_removed_signal(c)

2747

3435

return

2748

3436

raise KeyError(object_path)

2749

3437

2750

3438

del _interface

2751

3439

3440

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3441

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

3442

def GetManagedObjects(self):

3443

"""D-Bus method"""

3444

return dbus.Dictionary(

3445

{client.dbus_object_path:

3446

dbus.Dictionary(

3447

{interface: client.GetAll(interface)

3448

for interface in

3449

client._get_all_interface_names()})

3450

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

3451

3452

def client_added_signal(self, client):

3453

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

3454

if use_dbus:

3455

# New standard signal

3456

self.InterfacesAdded(

3457

client.dbus_object_path,

3458

dbus.Dictionary(

3459

{interface: client.GetAll(interface)

3460

for interface in

3461

client._get_all_interface_names()}))

3462

# Old signal

3463

self.ClientAdded(client.dbus_object_path)

3464

3465

def client_removed_signal(self, client):

3466

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

3467

if use_dbus:

3468

# New standard signal

3469

self.InterfacesRemoved(

3470

client.dbus_object_path,

3471

client._get_all_interface_names())

3472

# Old signal

3473

self.ClientRemoved(client.dbus_object_path,

3474

client.name)

3475

2752

3476

mandos_dbus_service = MandosDBusService()

2753

3477

3478

# Save modules to variables to exempt the modules from being

3479

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

3480

mp = multiprocessing

3481

wn = wnull

3482

2754

3483

def cleanup():

2755

3484

"Cleanup function; run on exit"

2756

3485

if zeroconf:

2757

3486

service.cleanup()

2758

2759

multiprocessing.active_children()

2760

wnull.close()

3487

3488

mp.active_children()

3489

wn.close()

2761

3490

if not (tcp_server.clients or client_settings):

2762

3491

return

2763

3492

2764

3493

# Store client before exiting. Secrets are encrypted with key

2765

3494

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

2766

3495

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

2767

3496

clients = {}

2768

3497

with PGPEngine() as pgp:

2769

for client in tcp_server.clients.itervalues():

3498

for client in tcp_server.clients.values():

2770

3499

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

2771

3500

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

2772

3501

key)

2773

3502

client_dict = {}

2774

3503

2775

3504

# A list of attributes that can not be pickled

2776

3505

# + secret.

2777

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

2778

"checker", "server_settings"))

2779

for name, typ in (inspect.getmembers

2780

(dbus.service.Object)):

3506

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

3507

"checker", "server_settings"}

3508

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

3509

.Object):

2781

3510

exclude.add(name)

2782

3511

2783

3512

client_dict["encrypted_secret"] = (client

2784

3513

.encrypted_secret)

2785

3514

for attr in client.client_structure:

2786

3515

if attr not in exclude:

2787

3516

client_dict[attr] = getattr(client, attr)

2788

3517

2789

3518

clients[client.name] = client_dict

2790

3519

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

2791

3520

2792

3521

try:

2793

with (tempfile.NamedTemporaryFile

2794

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

2795

dir=os.path.dirname(stored_state_path),

2796

delete=False)) as stored_state:

2797

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

2798

tempname=stored_state.name

3522

with tempfile.NamedTemporaryFile(

3523

mode='wb',

3524

suffix=".pickle",

3525

prefix='clients-',

3526

dir=os.path.dirname(stored_state_path),

3527

delete=False) as stored_state:

3528

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

3529

protocol=2)

3530

tempname = stored_state.name

2799

3531

os.rename(tempname, stored_state_path)

2800

3532

except (IOError, OSError) as e:

2801

3533

if not debug:

2804

3536

except NameError:

2805

3537

pass

2806

3538

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

2807

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

3539

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

2808

3540

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

2809

3541

else:

2810

3542

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

2811

3543

exc_info=e)

2812

3544

raise

2813

3545

2814

3546

# Delete all clients, and settings from config

2815

3547

while tcp_server.clients:

2816

3548

name, client = tcp_server.clients.popitem()

2817

3549

if use_dbus:

2818

3550

client.remove_from_connection()

2819

# Don't signal anything except ClientRemoved

3551

# Don't signal the disabling

2820

3552

client.disable(quiet=True)

3553

# Emit D-Bus signal for removal

2821

3554

if use_dbus:

2822

# Emit D-Bus signal

2823

mandos_dbus_service.ClientRemoved(client

2824

.dbus_object_path,

2825

client.name)

3555

mandos_dbus_service.client_removed_signal(client)

2826

3556

client_settings.clear()

2827

3557

2828

3558

atexit.register(cleanup)

2829

2830

for client in tcp_server.clients.itervalues():

3559

3560

for client in tcp_server.clients.values():

2831

3561

if use_dbus:

2832

# Emit D-Bus signal

2833

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3562

# Emit D-Bus signal for adding

3563

mandos_dbus_service.client_added_signal(client)

2834

3564

# Need to initiate checking of clients

2835

3565

if client.enabled:

2836

3566

client.init_checker()

2837

3567

2838

3568

tcp_server.enable()

2839

3569

tcp_server.server_activate()

2840

3570

2841

3571

# Find out what port we got

2842

3572

if zeroconf:

2843

3573

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

2848

3578

else: # IPv4

2849

3579

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

2850

3580

*tcp_server.socket.getsockname())

2851

2852

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

2853

3581

3582

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

3583

2854

3584

try:

2855

3585

if zeroconf:

2856

3586

# From the Avahi example code

2861

3591

cleanup()

2862

3592

sys.exit(1)

2863

3593

# End of Avahi example code

2864

2865

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

2866

lambda *args, **kwargs:

2867

(tcp_server.handle_request

2868

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

2869

3594

3595

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

3596

lambda *args, **kwargs:

3597

(tcp_server.handle_request

3598

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

3599

2870

3600

logger.debug("Starting main loop")

2871

3601

main_loop.run()

2872

3602

except AvahiError as error:

2881

3611

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

2882

3612

cleanup()

2883

3613

3614

2884

3615

if __name__ == '__main__':

2885

3616

main()