/mandos/trunk : revision 237.4.116

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

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.8.5"

92

119

stored_state_file = "clients.pickle"

93

120

94

121

logger = logging.getLogger()

95

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

117

syslogger = (logging.handlers.SysLogHandler

118

(facility =

119

logging.handlers.SysLogHandler.LOG_DAEMON,

120

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

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

121

162

syslogger.setFormatter(logging.Formatter

122

163

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

123

164

' %(message)s'))

124

165

logger.addHandler(syslogger)

125

166

126

167

if debug:

127

168

console = logging.StreamHandler()

128

169

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

140

181

141

182

class PGPEngine(object):

142

183

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

184

143

185

def __init__(self):

144

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

145

198

self.gnupgargs = ['--batch',

146

'--home', self.tempdir,

199

'--homedir', self.tempdir,

147

200

'--force-mdc',

148

'--quiet',

149

'--no-use-agent']

150

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

151

206

def __enter__(self):

152

207

return self

153

208

154

209

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

155

210

self._cleanup()

156

211

return False

157

212

158

213

def __del__(self):

159

214

self._cleanup()

160

215

161

216

def _cleanup(self):

162

217

if self.tempdir is not None:

163

218

# Delete contents of tempdir

164

219

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

165

topdown = False):

220

topdown=False):

166

221

for filename in files:

167

222

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

168

223

for dirname in dirs:

170

225

# Remove tempdir

171

226

os.rmdir(self.tempdir)

172

227

self.tempdir = None

173

228

174

229

def password_encode(self, password):

175

230

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

176

231

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

181

236

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

182

237

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

183

238

return encoded

184

239

185

240

def encrypt(self, data, password):

186

241

passphrase = self.password_encode(password)

187

with tempfile.NamedTemporaryFile(dir=self.tempdir

188

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

189

244

passfile.write(passphrase)

190

245

passfile.flush()

191

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

246

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

192

247

'--passphrase-file',

193

248

passfile.name]

194

249

+ self.gnupgargs,

195

stdin = subprocess.PIPE,

196

stdout = subprocess.PIPE,

197

stderr = subprocess.PIPE)

198

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)

199

254

if proc.returncode != 0:

200

255

raise PGPError(err)

201

256

return ciphertext

202

257

203

258

def decrypt(self, data, password):

204

259

passphrase = self.password_encode(password)

205

with tempfile.NamedTemporaryFile(dir = self.tempdir

206

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

207

262

passfile.write(passphrase)

208

263

passfile.flush()

209

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

264

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

210

265

'--passphrase-file',

211

266

passfile.name]

212

267

+ self.gnupgargs,

213

stdin = subprocess.PIPE,

214

stdout = subprocess.PIPE,

215

stderr = subprocess.PIPE)

216

decrypted_plaintext, err = proc.communicate(input

217

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

218

272

if proc.returncode != 0:

219

273

raise PGPError(err)

220

274

return decrypted_plaintext

221

275

222

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

223

303

class AvahiError(Exception):

224

304

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

225

305

self.value = value

226

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

227

def __unicode__(self):

228

return unicode(repr(self.value))

306

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

307

**kwargs)

308

229

309

230

310

class AvahiServiceError(AvahiError):

231

311

pass

232

312

313

233

314

class AvahiGroupError(AvahiError):

234

315

pass

235

316

236

317

237

318

class AvahiService(object):

238

319

"""An Avahi (Zeroconf) service.

239

320

240

321

Attributes:

241

322

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

242

323

Used to optionally bind to the specified interface.

254

335

server: D-Bus Server

255

336

bus: dbus.SystemBus()

256

337

"""

257

258

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

259

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

260

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

261

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

262

350

self.interface = interface

263

351

self.name = name

264

352

self.type = servicetype

273

361

self.server = None

274

362

self.bus = bus

275

363

self.entry_group_state_changed_match = None

276

277

def rename(self):

364

365

def rename(self, remove=True):

278

366

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

279

367

if self.rename_count >= self.max_renames:

280

368

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

281

369

" after %i retries, exiting.",

282

370

self.rename_count)

283

371

raise AvahiServiceError("Too many renames")

284

self.name = unicode(self.server

285

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

286

375

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

287

376

self.name)

288

self.remove()

377

if remove:

378

self.remove()

289

379

try:

290

380

self.add()

291

381

except dbus.exceptions.DBusException as error:

292

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

293

self.cleanup()

294

os._exit(1)

295

self.rename_count += 1

296

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

297

391

def remove(self):

298

392

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

299

393

if self.entry_group_state_changed_match is not None:

301

395

self.entry_group_state_changed_match = None

302

396

if self.group is not None:

303

397

self.group.Reset()

304

398

305

399

def add(self):

306

400

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

307

401

self.remove()

324

418

dbus.UInt16(self.port),

325

419

avahi.string_array_to_txt_array(self.TXT))

326

420

self.group.Commit()

327

421

328

422

def entry_group_state_changed(self, state, error):

329

423

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

330

424

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

331

425

332

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

333

427

logger.debug("Zeroconf service established.")

334

428

elif state == avahi.ENTRY_GROUP_COLLISION:

336

430

self.rename()

337

431

elif state == avahi.ENTRY_GROUP_FAILURE:

338

432

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

339

unicode(error))

340

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

341

.format(error))

342

433

str(error))

434

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

435

343

436

def cleanup(self):

344

437

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

345

438

if self.group is not None:

350

443

pass

351

444

self.group = None

352

445

self.remove()

353

446

354

447

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

355

448

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

356

449

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

357

bad_states = { avahi.SERVER_INVALID:

358

"Zeroconf server invalid",

359

avahi.SERVER_REGISTERING: None,

360

avahi.SERVER_COLLISION:

361

"Zeroconf server name collision",

362

avahi.SERVER_FAILURE:

363

"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

}

364

456

if state in bad_states:

365

457

if bad_states[state] is not None:

366

458

if error is None:

369

461

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

370

462

self.cleanup()

371

463

elif state == avahi.SERVER_RUNNING:

372

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)

373

476

else:

374

477

if error is None:

375

478

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

376

479

else:

377

480

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

378

481

379

482

def activate(self):

380

483

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

381

484

if self.server is None:

385

488

follow_name_owner_changes=True),

386

489

avahi.DBUS_INTERFACE_SERVER)

387

490

self.server.connect_to_signal("StateChanged",

388

self.server_state_changed)

491

self.server_state_changed)

389

492

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

390

493

391

494

392

495

class AvahiServiceToSyslog(AvahiService):

393

def rename(self):

496

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

394

497

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

395

ret = AvahiService.rename(self)

396

syslogger.setFormatter(logging.Formatter

397

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

398

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

399

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

400

502

return ret

401

503

402

504

403

def timedelta_to_milliseconds(td):

404

"Convert a datetime.timedelta() to milliseconds"

405

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

406

+ (td.seconds * 1000)

407

+ (td.microseconds // 1000))

505

# Pretend that we have a GnuTLS module

506

class gnutls(object):

507

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

508

509

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

510

if library is None:

511

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

512

_library = ctypes.cdll.LoadLibrary(library)

513

del library

514

515

# Unless otherwise indicated, the constants and types below are

516

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

517

518

# Constants

519

E_SUCCESS = 0

520

E_INTERRUPTED = -52

521

E_AGAIN = -28

522

CRT_OPENPGP = 2

523

CRT_RAWPK = 3

524

CLIENT = 2

525

SHUT_RDWR = 0

526

CRD_CERTIFICATE = 1

527

E_NO_CERTIFICATE_FOUND = -49

528

X509_FMT_DER = 0

529

NO_TICKETS = 1<<10

530

ENABLE_RAWPK = 1<<18

531

CTYPE_PEERS = 3

532

KEYID_USE_SHA256 = 1 # gnutls/x509.h

533

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

534

535

# Types

536

class session_int(ctypes.Structure):

537

_fields_ = []

538

session_t = ctypes.POINTER(session_int)

539

540

class certificate_credentials_st(ctypes.Structure):

541

_fields_ = []

542

certificate_credentials_t = ctypes.POINTER(

543

certificate_credentials_st)

544

certificate_type_t = ctypes.c_int

545

546

class datum_t(ctypes.Structure):

547

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

548

('size', ctypes.c_uint)]

549

550

class openpgp_crt_int(ctypes.Structure):

551

_fields_ = []

552

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

553

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

554

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

555

credentials_type_t = ctypes.c_int

556

transport_ptr_t = ctypes.c_void_p

557

close_request_t = ctypes.c_int

558

559

# Exceptions

560

class Error(Exception):

561

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

562

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

563

# code is passed, convert it to a string with

564

# gnutls.strerror()

565

self.code = code

566

if message is None and code is not None:

567

message = gnutls.strerror(code)

568

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

569

message, *args)

570

571

class CertificateSecurityError(Error):

572

pass

573

574

# Classes

575

class Credentials(object):

576

def __init__(self):

577

self._c_object = gnutls.certificate_credentials_t()

578

gnutls.certificate_allocate_credentials(

579

ctypes.byref(self._c_object))

580

self.type = gnutls.CRD_CERTIFICATE

581

582

def __del__(self):

583

gnutls.certificate_free_credentials(self._c_object)

584

585

class ClientSession(object):

586

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

587

self._c_object = gnutls.session_t()

588

gnutls_flags = gnutls.CLIENT

589

if gnutls.check_version(b"3.5.6"):

590

gnutls_flags |= gnutls.NO_TICKETS

591

if gnutls.has_rawpk:

592

gnutls_flags |= gnutls.ENABLE_RAWPK

593

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

594

del gnutls_flags

595

gnutls.set_default_priority(self._c_object)

596

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

597

gnutls.handshake_set_private_extensions(self._c_object,

598

True)

599

self.socket = socket

600

if credentials is None:

601

credentials = gnutls.Credentials()

602

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

603

ctypes.cast(credentials._c_object,

604

ctypes.c_void_p))

605

self.credentials = credentials

606

607

def __del__(self):

608

gnutls.deinit(self._c_object)

609

610

def handshake(self):

611

return gnutls.handshake(self._c_object)

612

613

def send(self, data):

614

data = bytes(data)

615

data_len = len(data)

616

while data_len > 0:

617

data_len -= gnutls.record_send(self._c_object,

618

data[-data_len:],

619

data_len)

620

621

def bye(self):

622

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

623

624

# Error handling functions

625

def _error_code(result):

626

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

627

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

628

if result >= 0:

629

return result

630

if result == gnutls.E_NO_CERTIFICATE_FOUND:

631

raise gnutls.CertificateSecurityError(code=result)

632

raise gnutls.Error(code=result)

633

634

def _retry_on_error(result, func, arguments):

635

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

636

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

637

while result < 0:

638

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

639

return _error_code(result)

640

result = func(*arguments)

641

return result

642

643

# Unless otherwise indicated, the function declarations below are

644

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

645

646

# Functions

647

priority_set_direct = _library.gnutls_priority_set_direct

648

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

649

ctypes.POINTER(ctypes.c_char_p)]

650

priority_set_direct.restype = _error_code

651

652

init = _library.gnutls_init

653

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

654

init.restype = _error_code

655

656

set_default_priority = _library.gnutls_set_default_priority

657

set_default_priority.argtypes = [session_t]

658

set_default_priority.restype = _error_code

659

660

record_send = _library.gnutls_record_send

661

record_send.argtypes = [session_t, ctypes.c_void_p,

662

ctypes.c_size_t]

663

record_send.restype = ctypes.c_ssize_t

664

record_send.errcheck = _retry_on_error

665

666

certificate_allocate_credentials = (

667

_library.gnutls_certificate_allocate_credentials)

668

certificate_allocate_credentials.argtypes = [

669

ctypes.POINTER(certificate_credentials_t)]

670

certificate_allocate_credentials.restype = _error_code

671

672

certificate_free_credentials = (

673

_library.gnutls_certificate_free_credentials)

674

certificate_free_credentials.argtypes = [

675

certificate_credentials_t]

676

certificate_free_credentials.restype = None

677

678

handshake_set_private_extensions = (

679

_library.gnutls_handshake_set_private_extensions)

680

handshake_set_private_extensions.argtypes = [session_t,

681

ctypes.c_int]

682

handshake_set_private_extensions.restype = None

683

684

credentials_set = _library.gnutls_credentials_set

685

credentials_set.argtypes = [session_t, credentials_type_t,

686

ctypes.c_void_p]

687

credentials_set.restype = _error_code

688

689

strerror = _library.gnutls_strerror

690

strerror.argtypes = [ctypes.c_int]

691

strerror.restype = ctypes.c_char_p

692

693

certificate_type_get = _library.gnutls_certificate_type_get

694

certificate_type_get.argtypes = [session_t]

695

certificate_type_get.restype = _error_code

696

697

certificate_get_peers = _library.gnutls_certificate_get_peers

698

certificate_get_peers.argtypes = [session_t,

699

ctypes.POINTER(ctypes.c_uint)]

700

certificate_get_peers.restype = ctypes.POINTER(datum_t)

701

702

global_set_log_level = _library.gnutls_global_set_log_level

703

global_set_log_level.argtypes = [ctypes.c_int]

704

global_set_log_level.restype = None

705

706

global_set_log_function = _library.gnutls_global_set_log_function

707

global_set_log_function.argtypes = [log_func]

708

global_set_log_function.restype = None

709

710

deinit = _library.gnutls_deinit

711

deinit.argtypes = [session_t]

712

deinit.restype = None

713

714

handshake = _library.gnutls_handshake

715

handshake.argtypes = [session_t]

716

handshake.restype = _error_code

717

handshake.errcheck = _retry_on_error

718

719

transport_set_ptr = _library.gnutls_transport_set_ptr

720

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

721

transport_set_ptr.restype = None

722

723

bye = _library.gnutls_bye

724

bye.argtypes = [session_t, close_request_t]

725

bye.restype = _error_code

726

bye.errcheck = _retry_on_error

727

728

check_version = _library.gnutls_check_version

729

check_version.argtypes = [ctypes.c_char_p]

730

check_version.restype = ctypes.c_char_p

731

732

_need_version = b"3.3.0"

733

if check_version(_need_version) is None:

734

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

735

.format(_need_version))

736

737

_tls_rawpk_version = b"3.6.6"

738

has_rawpk = bool(check_version(_tls_rawpk_version))

739

740

if has_rawpk:

741

# Types

742

class pubkey_st(ctypes.Structure):

743

_fields = []

744

pubkey_t = ctypes.POINTER(pubkey_st)

745

746

x509_crt_fmt_t = ctypes.c_int

747

748

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

749

pubkey_init = _library.gnutls_pubkey_init

750

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

751

pubkey_init.restype = _error_code

752

753

pubkey_import = _library.gnutls_pubkey_import

754

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

755

x509_crt_fmt_t]

756

pubkey_import.restype = _error_code

757

758

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

759

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

760

ctypes.POINTER(ctypes.c_ubyte),

761

ctypes.POINTER(ctypes.c_size_t)]

762

pubkey_get_key_id.restype = _error_code

763

764

pubkey_deinit = _library.gnutls_pubkey_deinit

765

pubkey_deinit.argtypes = [pubkey_t]

766

pubkey_deinit.restype = None

767

else:

768

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

769

770

openpgp_crt_init = _library.gnutls_openpgp_crt_init

771

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

772

openpgp_crt_init.restype = _error_code

773

774

openpgp_crt_import = _library.gnutls_openpgp_crt_import

775

openpgp_crt_import.argtypes = [openpgp_crt_t,

776

ctypes.POINTER(datum_t),

777

openpgp_crt_fmt_t]

778

openpgp_crt_import.restype = _error_code

779

780

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

781

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

782

ctypes.POINTER(ctypes.c_uint)]

783

openpgp_crt_verify_self.restype = _error_code

784

785

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

786

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

787

openpgp_crt_deinit.restype = None

788

789

openpgp_crt_get_fingerprint = (

790

_library.gnutls_openpgp_crt_get_fingerprint)

791

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

792

ctypes.c_void_p,

793

ctypes.POINTER(

794

ctypes.c_size_t)]

795

openpgp_crt_get_fingerprint.restype = _error_code

796

797

if check_version(b"3.6.4"):

798

certificate_type_get2 = _library.gnutls_certificate_type_get2

799

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

800

certificate_type_get2.restype = _error_code

801

802

# Remove non-public functions

803

del _error_code, _retry_on_error

804

805

806

def call_pipe(connection, # : multiprocessing.Connection

807

func, *args, **kwargs):

808

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

809

810

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

811

return value on the provided multiprocessing.Connection.

812

"""

813

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

814

connection.close()

408

815

409

816

410

817

class Client(object):

411

818

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

412

819

413

820

Attributes:

414

821

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

415

822

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

416

823

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

417

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

418

to see if the client lives.

419

'None' if no process is running.

420

checker_callback_tag: a gobject event source tag, or None

824

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

825

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

826

running.

827

checker_callback_tag: a GLib event source tag, or None

421

828

checker_command: string; External command which is run to check

422

829

if client lives. %() expansions are done at

423

830

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

424

831

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

425

checker_initiator_tag: a gobject event source tag, or None

832

checker_initiator_tag: a GLib event source tag, or None

426

833

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

427

834

client_structure: Object describing what attributes a client has

428

835

and is used for storing the client at exit

429

836

current_checker_command: string; current running checker_command

430

disable_initiator_tag: a gobject event source tag, or None

837

disable_initiator_tag: a GLib event source tag, or None

431

838

enabled: bool()

432

839

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

433

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

434

843

host: string; available for use by the checker command

435

844

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

436

845

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

438

847

last_checker_status: integer between 0 and 255 reflecting exit

439

848

status of last checker. -1 reflects crashed

440

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

441

852

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

442

853

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

443

854

D-Bus identifiers

450

861

disabled, or None

451

862

server_settings: The server_settings dict from main()

452

863

"""

453

864

454

865

runtime_expansions = ("approval_delay", "approval_duration",

455

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

866

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

456

867

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

457

868

"last_approval_request", "last_checked_ok",

458

869

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

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

462

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

463

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

466

"approved_by_default": "True",

467

"enabled": "True",

468

}

469

470

def timeout_milliseconds(self):

471

"Return the 'timeout' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.timeout)

473

474

def extended_timeout_milliseconds(self):

475

"Return the 'extended_timeout' attribute in milliseconds"

476

return timedelta_to_milliseconds(self.extended_timeout)

477

478

def interval_milliseconds(self):

479

"Return the 'interval' attribute in milliseconds"

480

return timedelta_to_milliseconds(self.interval)

481

482

def approval_delay_milliseconds(self):

483

return timedelta_to_milliseconds(self.approval_delay)

484

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

485

882

@staticmethod

486

883

def config_parser(config):

487

884

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

494

891

for client_name in config.sections():

495

892

section = dict(config.items(client_name))

496

893

client = settings[client_name] = {}

497

894

498

895

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

499

896

# Reformat values from string types to Python types

500

897

client["approved_by_default"] = config.getboolean(

501

898

client_name, "approved_by_default")

502

899

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

503

900

"enabled")

504

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

505

907

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

506

908

.replace(" ", ""))

507

909

if "secret" in section:

508

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

910

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

911

.encode("utf-8"),

912

"base64")

509

913

elif "secfile" in section:

510

914

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

511

915

(section["secfile"])),

512

916

"rb") as secfile:

513

917

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

514

918

else:

515

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

919

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

516

920

.format(section))

517

921

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

518

922

client["extended_timeout"] = string_to_delta(

526

930

client["last_approval_request"] = None

527

931

client["last_checked_ok"] = None

528

932

client["last_checker_status"] = -2

529

933

530

934

return settings

531

532

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

935

936

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

533

937

self.name = name

534

938

if server_settings is None:

535

939

server_settings = {}

536

940

self.server_settings = server_settings

537

941

# adding all client settings

538

for setting, value in settings.iteritems():

942

for setting, value in settings.items():

539

943

setattr(self, setting, value)

540

944

541

945

if self.enabled:

542

946

if not hasattr(self, "last_enabled"):

543

947

self.last_enabled = datetime.datetime.utcnow()

547

951

else:

548

952

self.last_enabled = None

549

953

self.expires = None

550

954

551

955

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

552

# Uppercase and remove spaces from fingerprint for later

553

# comparison purposes with return value from the fingerprint()

554

# function

956

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

555

957

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

556

958

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

557

959

datetime.datetime.utcnow())

558

960

559

961

# attributes specific for this server instance

560

962

self.checker = None

561

963

self.checker_initiator_tag = None

564

966

self.current_checker_command = None

565

967

self.approved = None

566

968

self.approvals_pending = 0

567

self.changedstate = (multiprocessing_manager

568

.Condition(multiprocessing_manager

569

.Lock()))

570

self.client_structure = [attr for attr in

571

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

572

973

if not attr.startswith("_")]

573

974

self.client_structure.append("client_structure")

574

575

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

576

lambda obj:

577

isinstance(obj,

578

property)):

975

976

for name, t in inspect.getmembers(

977

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

579

978

if not name.startswith("_"):

580

979

self.client_structure.append(name)

581

980

582

981

# Send notice to process children that client state has changed

583

982

def send_changedstate(self):

584

983

with self.changedstate:

585

984

self.changedstate.notify_all()

586

985

587

986

def enable(self):

588

987

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

589

988

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

594

993

self.last_enabled = datetime.datetime.utcnow()

595

994

self.init_checker()

596

995

self.send_changedstate()

597

996

598

997

def disable(self, quiet=True):

599

998

"""Disable this client."""

600

999

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

602

1001

if not quiet:

603

1002

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

604

1003

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

605

gobject.source_remove(self.disable_initiator_tag)

1004

GLib.source_remove(self.disable_initiator_tag)

606

1005

self.disable_initiator_tag = None

607

1006

self.expires = None

608

1007

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

609

gobject.source_remove(self.checker_initiator_tag)

1008

GLib.source_remove(self.checker_initiator_tag)

610

1009

self.checker_initiator_tag = None

611

1010

self.stop_checker()

612

1011

self.enabled = False

613

1012

if not quiet:

614

1013

self.send_changedstate()

615

# 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

616

1015

return False

617

1016

618

1017

def __del__(self):

619

1018

self.disable()

620

1019

621

1020

def init_checker(self):

622

1021

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

623

1022

# and every interval from then on.

624

1023

if self.checker_initiator_tag is not None:

625

gobject.source_remove(self.checker_initiator_tag)

626

self.checker_initiator_tag = (gobject.timeout_add

627

(self.interval_milliseconds(),

628

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)

629

1028

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

630

1029

if self.disable_initiator_tag is not None:

631

gobject.source_remove(self.disable_initiator_tag)

632

self.disable_initiator_tag = (gobject.timeout_add

633

(self.timeout_milliseconds(),

634

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)

635

1033

# Also start a new checker *right now*.

636

1034

self.start_checker()

637

638

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

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

639

1038

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

1039

# Read return code from connection (see call_pipe)

1040

returncode = connection.recv()

1041

connection.close()

1042

self.checker.join()

640

1043

self.checker_callback_tag = None

641

1044

self.checker = None

642

if os.WIFEXITED(condition):

643

self.last_checker_status = os.WEXITSTATUS(condition)

1045

1046

if returncode >= 0:

1047

self.last_checker_status = returncode

1048

self.last_checker_signal = None

644

1049

if self.last_checker_status == 0:

645

1050

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

646

1051

vars(self))

647

1052

self.checked_ok()

648

1053

else:

649

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

650

vars(self))

1054

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

651

1055

else:

652

1056

self.last_checker_status = -1

1057

self.last_checker_signal = -returncode

653

1058

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

654

1059

vars(self))

655

1060

return False

1061

656

1062

def checked_ok(self):

657

1063

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

658

1064

self.last_checked_ok = datetime.datetime.utcnow()

659

1065

self.last_checker_status = 0

1066

self.last_checker_signal = None

660

1067

self.bump_timeout()

661

1068

662

1069

def bump_timeout(self, timeout=None):

663

1070

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

664

1071

if timeout is None:

665

1072

timeout = self.timeout

666

1073

if self.disable_initiator_tag is not None:

667

gobject.source_remove(self.disable_initiator_tag)

1074

GLib.source_remove(self.disable_initiator_tag)

668

1075

self.disable_initiator_tag = None

669

1076

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

670

self.disable_initiator_tag = (gobject.timeout_add

671

(timedelta_to_milliseconds

672

(timeout), self.disable))

1077

self.disable_initiator_tag = GLib.timeout_add(

1078

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

673

1079

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

674

1080

675

1081

def need_approval(self):

676

1082

self.last_approval_request = datetime.datetime.utcnow()

677

1083

678

1084

def start_checker(self):

679

1085

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

680

1086

681

1087

If a checker already exists, leave it running and do

682

1088

nothing."""

683

1089

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

688

1094

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

689

1095

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

690

1096

# should be.

691

692

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

693

try:

694

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

695

except AttributeError:

696

pass

697

except OSError as error:

698

if error.errno != errno.ECHILD:

699

raise

700

else:

701

if pid:

702

logger.warning("Checker was a zombie")

703

gobject.source_remove(self.checker_callback_tag)

704

self.checker_callback(pid, status,

705

self.current_checker_command)

1097

1098

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

1099

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

1100

self.checker.join()

1101

self.checker = None

706

1102

# Start a new checker if needed

707

1103

if self.checker is None:

708

1104

# Escape attributes for the shell

709

escaped_attrs = dict(

710

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

711

for attr in

712

self.runtime_expansions)

1105

escaped_attrs = {

1106

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

1107

for attr in self.runtime_expansions}

713

1108

try:

714

1109

command = self.checker_command % escaped_attrs

715

1110

except TypeError as error:

716

1111

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

717

self.checker_command, exc_info=error)

718

return True # Try again later

1112

self.checker_command,

1113

exc_info=error)

1114

return True # Try again later

719

1115

self.current_checker_command = command

720

try:

721

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

722

command, self.name)

723

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

724

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

725

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

726

# always replaced by /dev/null.)

727

# The exception is when not debugging but nevertheless

728

# running in the foreground; use the previously

729

# created wnull.

730

popen_args = {}

731

if (not self.server_settings["debug"]

732

and self.server_settings["foreground"]):

733

popen_args.update({"stdout": wnull,

734

"stderr": wnull })

735

self.checker = subprocess.Popen(command,

736

close_fds=True,

737

shell=True, cwd="/",

738

**popen_args)

739

except OSError as error:

740

logger.error("Failed to start subprocess",

741

exc_info=error)

742

return True

743

self.checker_callback_tag = (gobject.child_watch_add

744

(self.checker.pid,

745

self.checker_callback,

746

data=command))

747

# The checker may have completed before the gobject

748

# watch was added. Check for this.

749

try:

750

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

751

except OSError as error:

752

if error.errno == errno.ECHILD:

753

# This should never happen

754

logger.error("Child process vanished",

755

exc_info=error)

756

return True

757

raise

758

if pid:

759

gobject.source_remove(self.checker_callback_tag)

760

self.checker_callback(pid, status, command)

761

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

1116

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

1117

self.name)

1118

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

1119

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

1120

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

1121

# always replaced by /dev/null.)

1122

# The exception is when not debugging but nevertheless

1123

# running in the foreground; use the previously

1124

# created wnull.

1125

popen_args = {"close_fds": True,

1126

"shell": True,

1127

"cwd": "/"}

1128

if (not self.server_settings["debug"]

1129

and self.server_settings["foreground"]):

1130

popen_args.update({"stdout": wnull,

1131

"stderr": wnull})

1132

pipe = multiprocessing.Pipe(duplex=False)

1133

self.checker = multiprocessing.Process(

1134

target=call_pipe,

1135

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

1136

kwargs=popen_args)

1137

self.checker.start()

1138

self.checker_callback_tag = GLib.io_add_watch(

1139

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

1140

self.checker_callback, pipe[0], command)

1141

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

762

1142

return True

763

1143

764

1144

def stop_checker(self):

765

1145

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

766

1146

if self.checker_callback_tag:

767

gobject.source_remove(self.checker_callback_tag)

1147

GLib.source_remove(self.checker_callback_tag)

768

1148

self.checker_callback_tag = None

769

1149

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

770

1150

return

771

1151

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

772

try:

773

self.checker.terminate()

774

#time.sleep(0.5)

775

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

776

# self.checker.kill()

777

except OSError as error:

778

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

779

raise

1152

self.checker.terminate()

780

1153

self.checker = None

781

1154

782

1155

783

def dbus_service_property(dbus_interface, signature="v",

784

access="readwrite", byte_arrays=False):

1156

def dbus_service_property(dbus_interface,

1157

signature="v",

1158

access="readwrite",

1159

byte_arrays=False):

785

1160

"""Decorators for marking methods of a DBusObjectWithProperties to

786

1161

become properties on the D-Bus.

787

1162

788

1163

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

789

1164

and with one argument by "Set".

790

1165

791

1166

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

792

1167

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

793

1168

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

796

1171

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

797

1172

if byte_arrays and signature != "ay":

798

1173

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

799

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

1174

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

1175

800

1176

def decorator(func):

801

1177

func._dbus_is_property = True

802

1178

func._dbus_interface = dbus_interface

805

1181

func._dbus_name = func.__name__

806

1182

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

807

1183

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

808

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1184

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

809

1185

return func

1186

810

1187

return decorator

811

1188

812

1189

813

1190

def dbus_interface_annotations(dbus_interface):

814

1191

"""Decorator for marking functions returning interface annotations

815

1192

816

1193

Usage:

817

1194

818

1195

@dbus_interface_annotations("org.example.Interface")

819

1196

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

820

1197

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

821

1198

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

822

1199

"false"}

823

1200

"""

1201

824

1202

def decorator(func):

825

1203

func._dbus_is_interface = True

826

1204

func._dbus_interface = dbus_interface

827

1205

func._dbus_name = dbus_interface

828

1206

return func

1207

829

1208

return decorator

830

1209

831

1210

832

1211

def dbus_annotations(annotations):

833

1212

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

834

1213

Usage:

835

1214

1215

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

1216

"org.freedesktop.DBus.Property."

1217

"EmitsChangedSignal": "false"})

836

1218

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

837

1219

access="r")

838

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

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

841

1220

def Property_dbus_property(self):

842

1221

return dbus.Boolean(False)

1222

1223

See also the DBusObjectWithAnnotations class.

843

1224

"""

1225

844

1226

def decorator(func):

845

1227

func._dbus_annotations = annotations

846

1228

return func

1229

847

1230

return decorator

848

1231

849

1232

850

1233

class DBusPropertyException(dbus.exceptions.DBusException):

851

1234

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

852

1235

"""

853

def __unicode__(self):

854

return unicode(str(self))

1236

pass

855

1237

856

1238

857

1239

class DBusPropertyAccessException(DBusPropertyException):

866

1248

pass

867

1249

868

1250

869

class DBusObjectWithProperties(dbus.service.Object):

870

"""A D-Bus object with properties.

871

872

Classes inheriting from this can use the dbus_service_property

873

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

874

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

1251

class DBusObjectWithAnnotations(dbus.service.Object):

1252

"""A D-Bus object with annotations.

1253

1254

Classes inheriting from this can use the dbus_annotations

1255

decorator to add annotations to methods or signals.

875

1256

"""

876

1257

877

1258

@staticmethod

878

1259

def _is_dbus_thing(thing):

879

1260

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

880

1261

881

1262

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

882

1263

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

883

1264

"""

884

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

1265

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

885

1266

False)

886

1267

887

1268

def _get_all_dbus_things(self, thing):

888

1269

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

889

1270

"""

890

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

891

name),

1271

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

892

1272

athing.__get__(self))

893

1273

for cls in self.__class__.__mro__

894

1274

for name, athing in

895

inspect.getmembers(cls,

896

self._is_dbus_thing(thing)))

897

1275

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

1276

1277

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1278

out_signature="s",

1279

path_keyword='object_path',

1280

connection_keyword='connection')

1281

def Introspect(self, object_path, connection):

1282

"""Overloading of standard D-Bus method.

1283

1284

Inserts annotation tags on methods and signals.

1285

"""

1286

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

1287

connection)

1288

try:

1289

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

1290

1291

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

1292

# Add annotation tags

1293

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

1294

for tag in if_tag.getElementsByTagName(typ):

1295

annots = dict()

1296

for name, prop in (self.

1297

_get_all_dbus_things(typ)):

1298

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

1299

and prop._dbus_interface

1300

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

1301

annots.update(getattr(

1302

prop, "_dbus_annotations", {}))

1303

for name, value in annots.items():

1304

ann_tag = document.createElement(

1305

"annotation")

1306

ann_tag.setAttribute("name", name)

1307

ann_tag.setAttribute("value", value)

1308

tag.appendChild(ann_tag)

1309

# Add interface annotation tags

1310

for annotation, value in dict(

1311

itertools.chain.from_iterable(

1312

annotations().items()

1313

for name, annotations

1314

in self._get_all_dbus_things("interface")

1315

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

1316

)).items():

1317

ann_tag = document.createElement("annotation")

1318

ann_tag.setAttribute("name", annotation)

1319

ann_tag.setAttribute("value", value)

1320

if_tag.appendChild(ann_tag)

1321

# Fix argument name for the Introspect method itself

1322

if (if_tag.getAttribute("name")

1323

== dbus.INTROSPECTABLE_IFACE):

1324

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

1325

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

1326

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

1327

if (arg.getAttribute("direction")

1328

== "out"):

1329

arg.setAttribute("name",

1330

"xml_data")

1331

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

1332

document.unlink()

1333

except (AttributeError, xml.dom.DOMException,

1334

xml.parsers.expat.ExpatError) as error:

1335

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

1336

exc_info=error)

1337

return xmlstring

1338

1339

1340

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1341

"""A D-Bus object with properties.

1342

1343

Classes inheriting from this can use the dbus_service_property

1344

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

1345

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

1346

"""

1347

898

1348

def _get_dbus_property(self, interface_name, property_name):

899

1349

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

900

1350

property with the specified name and interface.

901

1351

"""

902

for cls in self.__class__.__mro__:

903

for name, value in (inspect.getmembers

904

(cls,

905

self._is_dbus_thing("property"))):

1352

for cls in self.__class__.__mro__:

1353

for name, value in inspect.getmembers(

1354

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

906

1355

if (value._dbus_name == property_name

907

1356

and value._dbus_interface == interface_name):

908

1357

return value.__get__(self)

909

1358

910

1359

# No such property

911

raise DBusPropertyNotFound(self.dbus_object_path + ":"

912

+ interface_name + "."

913

+ property_name)

914

915

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

1360

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

1361

self.dbus_object_path, interface_name, property_name))

1362

1363

@classmethod

1364

def _get_all_interface_names(cls):

1365

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

1366

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

1367

"_dbus_interface", None)

1368

for x in (inspect.getmro(cls))

1369

for attr in dir(x))

1370

if name is not None)

1371

1372

@dbus.service.method(dbus.PROPERTIES_IFACE,

1373

in_signature="ss",

916

1374

out_signature="v")

917

1375

def Get(self, interface_name, property_name):

918

1376

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

924

1382

if not hasattr(value, "variant_level"):

925

1383

return value

926

1384

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

927

1385

928

1386

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

929

1387

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

930

1388

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

937

1395

# signatures other than "ay".

938

1396

if prop._dbus_signature != "ay":

939

1397

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

940

"'ay' signature {0!r}"

1398

"'ay' signature {!r}"

941

1399

.format(prop._dbus_signature))

942

1400

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

943

1401

for byte in value))

944

1402

prop(value)

945

946

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

1403

1404

@dbus.service.method(dbus.PROPERTIES_IFACE,

1405

in_signature="s",

947

1406

out_signature="a{sv}")

948

1407

def GetAll(self, interface_name):

949

1408

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

950

1409

standard.

951

1410

952

1411

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

953

1412

"""

954

1413

properties = {}

964

1423

if not hasattr(value, "variant_level"):

965

1424

properties[name] = value

966

1425

continue

967

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

968

value.variant_level+1)

1426

properties[name] = type(value)(

1427

value, variant_level=value.variant_level + 1)

969

1428

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

970

1429

1430

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

1431

def PropertiesChanged(self, interface_name, changed_properties,

1432

invalidated_properties):

1433

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

1434

standard.

1435

"""

1436

pass

1437

971

1438

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

972

1439

out_signature="s",

973

1440

path_keyword='object_path',

974

1441

connection_keyword='connection')

975

1442

def Introspect(self, object_path, connection):

976

1443

"""Overloading of standard D-Bus method.

977

1444

978

1445

Inserts property tags and interface annotation tags.

979

1446

"""

980

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

981

connection)

1447

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1448

object_path,

1449

connection)

982

1450

try:

983

1451

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

1452

984

1453

def make_tag(document, name, prop):

985

1454

e = document.createElement("property")

986

1455

e.setAttribute("name", name)

987

1456

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

988

1457

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

989

1458

return e

1459

990

1460

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

991

1461

# Add property tags

992

1462

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

995

1465

if prop._dbus_interface

996

1466

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

997

1467

if_tag.appendChild(tag)

998

# Add annotation tags

999

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

1000

for tag in if_tag.getElementsByTagName(typ):

1001

annots = dict()

1002

for name, prop in (self.

1003

_get_all_dbus_things(typ)):

1004

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

1005

and prop._dbus_interface

1006

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

1007

annots.update(getattr

1008

(prop,

1009

"_dbus_annotations",

1010

{}))

1011

for name, value in annots.iteritems():

1012

ann_tag = document.createElement(

1013

"annotation")

1014

ann_tag.setAttribute("name", name)

1015

ann_tag.setAttribute("value", value)

1016

tag.appendChild(ann_tag)

1017

# Add interface annotation tags

1018

for annotation, value in dict(

1019

itertools.chain.from_iterable(

1020

annotations().iteritems()

1021

for name, annotations in

1022

self._get_all_dbus_things("interface")

1023

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

1024

)).iteritems():

1025

ann_tag = document.createElement("annotation")

1026

ann_tag.setAttribute("name", annotation)

1027

ann_tag.setAttribute("value", value)

1028

if_tag.appendChild(ann_tag)

1468

# Add annotation tags for properties

1469

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

1470

annots = dict()

1471

for name, prop in self._get_all_dbus_things(

1472

"property"):

1473

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

1474

and prop._dbus_interface

1475

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

1476

annots.update(getattr(

1477

prop, "_dbus_annotations", {}))

1478

for name, value in annots.items():

1479

ann_tag = document.createElement(

1480

"annotation")

1481

ann_tag.setAttribute("name", name)

1482

ann_tag.setAttribute("value", value)

1483

tag.appendChild(ann_tag)

1029

1484

# Add the names to the return values for the

1030

1485

# "org.freedesktop.DBus.Properties" methods

1031

1486

if (if_tag.getAttribute("name")

1050

1505

return xmlstring

1051

1506

1052

1507

1508

try:

1509

dbus.OBJECT_MANAGER_IFACE

1510

except AttributeError:

1511

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

1512

1513

1514

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1515

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

1516

1517

Classes inheriting from this exposes the standard

1518

GetManagedObjects call and the InterfacesAdded and

1519

InterfacesRemoved signals on the standard

1520

"org.freedesktop.DBus.ObjectManager" interface.

1521

1522

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

1523

manually.

1524

"""

1525

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1526

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

1527

def GetManagedObjects(self):

1528

"""This function must be overridden"""

1529

raise NotImplementedError()

1530

1531

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1532

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

1533

def InterfacesAdded(self, object_path, interfaces_and_properties):

1534

pass

1535

1536

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

1537

def InterfacesRemoved(self, object_path, interfaces):

1538

pass

1539

1540

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1541

out_signature="s",

1542

path_keyword='object_path',

1543

connection_keyword='connection')

1544

def Introspect(self, object_path, connection):

1545

"""Overloading of standard D-Bus method.

1546

1547

Override return argument name of GetManagedObjects to be

1548

"objpath_interfaces_and_properties"

1549

"""

1550

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1551

object_path,

1552

connection)

1553

try:

1554

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

1555

1556

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

1557

# Fix argument name for the GetManagedObjects method

1558

if (if_tag.getAttribute("name")

1559

== dbus.OBJECT_MANAGER_IFACE):

1560

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

1561

if (cn.getAttribute("name")

1562

== "GetManagedObjects"):

1563

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

1564

if (arg.getAttribute("direction")

1565

== "out"):

1566

arg.setAttribute(

1567

"name",

1568

"objpath_interfaces"

1569

"_and_properties")

1570

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

1571

document.unlink()

1572

except (AttributeError, xml.dom.DOMException,

1573

xml.parsers.expat.ExpatError) as error:

1574

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

1575

exc_info=error)

1576

return xmlstring

1577

1578

1053

1579

def datetime_to_dbus(dt, variant_level=0):

1054

1580

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

1055

1581

if dt is None:

1056

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

1057

return dbus.String(dt.isoformat(),

1058

variant_level=variant_level)

1582

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

1583

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

1059

1584

1060

1585

1061

1586

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1063

1588

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

1064

1589

interface names according to the "alt_interface_names" mapping.

1065

1590

Usage:

1066

1591

1067

1592

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

1068

1593

"net.example.AlternateInterface"})

1069

1594

class SampleDBusObject(dbus.service.Object):

1070

1595

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

1071

1596

def SampleDBusMethod():

1072

1597

pass

1073

1598

1074

1599

The above "SampleDBusMethod" on "SampleDBusObject" will be

1075

1600

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

1076

1601

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

1077

1602

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

1078

1603

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

1079

1604

1080

1605

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

1081

1606

(from DBusObjectWithProperties) and interfaces (from the

1082

1607

dbus_interface_annotations decorator).

1083

1608

"""

1609

1084

1610

def wrapper(cls):

1085

1611

for orig_interface_name, alt_interface_name in (

1086

alt_interface_names.iteritems()):

1612

alt_interface_names.items()):

1087

1613

attr = {}

1088

1614

interface_names = set()

1089

1615

# Go though all attributes of the class

1091

1617

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

1092

1618

# with the wrong interface name

1093

1619

if (not hasattr(attribute, "_dbus_interface")

1094

or not attribute._dbus_interface

1095

.startswith(orig_interface_name)):

1620

or not attribute._dbus_interface.startswith(

1621

orig_interface_name)):

1096

1622

continue

1097

1623

# Create an alternate D-Bus interface name based on

1098

1624

# the current name

1099

alt_interface = (attribute._dbus_interface

1100

.replace(orig_interface_name,

1101

alt_interface_name))

1625

alt_interface = attribute._dbus_interface.replace(

1626

orig_interface_name, alt_interface_name)

1102

1627

interface_names.add(alt_interface)

1103

1628

# Is this a D-Bus signal?

1104

1629

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

1105

1630

# Extract the original non-method undecorated

1106

1631

# function by black magic

1107

nonmethod_func = (dict(

1632

if sys.version_info.major == 2:

1633

nonmethod_func = (dict(

1108

1634

zip(attribute.func_code.co_freevars,

1109

attribute.__closure__))["func"]

1110

.cell_contents)

1635

attribute.__closure__))

1636

["func"].cell_contents)

1637

else:

1638

nonmethod_func = (dict(

1639

zip(attribute.__code__.co_freevars,

1640

attribute.__closure__))

1641

["func"].cell_contents)

1111

1642

# Create a new, but exactly alike, function

1112

1643

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

1113

1644

# with the alternate D-Bus interface name

1114

new_function = (dbus.service.signal

1115

(alt_interface,

1116

attribute._dbus_signature)

1117

(types.FunctionType(

1118

nonmethod_func.func_code,

1119

nonmethod_func.func_globals,

1120

nonmethod_func.func_name,

1121

nonmethod_func.func_defaults,

1122

nonmethod_func.func_closure)))

1645

new_function = copy_function(nonmethod_func)

1646

new_function = (dbus.service.signal(

1647

alt_interface,

1648

attribute._dbus_signature)(new_function))

1123

1649

# Copy annotations, if any

1124

1650

try:

1125

new_function._dbus_annotations = (

1126

dict(attribute._dbus_annotations))

1651

new_function._dbus_annotations = dict(

1652

attribute._dbus_annotations)

1127

1653

except AttributeError:

1128

1654

pass

1655

1129

1656

# Define a creator of a function to call both the

1130

1657

# original and alternate functions, so both the

1131

1658

# original and alternate signals gets sent when

1134

1661

"""This function is a scope container to pass

1135

1662

func1 and func2 to the "call_both" function

1136

1663

outside of its arguments"""

1664

1665

@functools.wraps(func2)

1137

1666

def call_both(*args, **kwargs):

1138

1667

"""This function will emit two D-Bus

1139

1668

signals by calling func1 and func2"""

1140

1669

func1(*args, **kwargs)

1141

1670

func2(*args, **kwargs)

1671

# Make wrapper function look like a D-Bus

1672

# signal

1673

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

1674

if name.startswith("_dbus_"):

1675

setattr(call_both, name, attr)

1676

1142

1677

return call_both

1143

1678

# Create the "call_both" function and add it to

1144

1679

# the class

1149

1684

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

1150

1685

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

1151

1686

# to the class.

1152

attr[attrname] = (dbus.service.method

1153

(alt_interface,

1154

attribute._dbus_in_signature,

1155

attribute._dbus_out_signature)

1156

(types.FunctionType

1157

(attribute.func_code,

1158

attribute.func_globals,

1159

attribute.func_name,

1160

attribute.func_defaults,

1161

attribute.func_closure)))

1687

attr[attrname] = (

1688

dbus.service.method(

1689

alt_interface,

1690

attribute._dbus_in_signature,

1691

attribute._dbus_out_signature)

1692

(copy_function(attribute)))

1162

1693

# Copy annotations, if any

1163

1694

try:

1164

attr[attrname]._dbus_annotations = (

1165

dict(attribute._dbus_annotations))

1695

attr[attrname]._dbus_annotations = dict(

1696

attribute._dbus_annotations)

1166

1697

except AttributeError:

1167

1698

pass

1168

1699

# Is this a D-Bus property?

1171

1702

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

1172

1703

# property with the alternate D-Bus interface

1173

1704

# name. Add it to the class.

1174

attr[attrname] = (dbus_service_property

1175

(alt_interface,

1176

attribute._dbus_signature,

1177

attribute._dbus_access,

1178

attribute

1179

._dbus_get_args_options

1180

["byte_arrays"])

1181

(types.FunctionType

1182

(attribute.func_code,

1183

attribute.func_globals,

1184

attribute.func_name,

1185

attribute.func_defaults,

1186

attribute.func_closure)))

1705

attr[attrname] = (dbus_service_property(

1706

alt_interface, attribute._dbus_signature,

1707

attribute._dbus_access,

1708

attribute._dbus_get_args_options

1709

["byte_arrays"])

1710

(copy_function(attribute)))

1187

1711

# Copy annotations, if any

1188

1712

try:

1189

attr[attrname]._dbus_annotations = (

1190

dict(attribute._dbus_annotations))

1713

attr[attrname]._dbus_annotations = dict(

1714

attribute._dbus_annotations)

1191

1715

except AttributeError:

1192

1716

pass

1193

1717

# Is this a D-Bus interface?

1196

1720

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

1197

1721

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

1198

1722

# to the class.

1199

attr[attrname] = (dbus_interface_annotations

1200

(alt_interface)

1201

(types.FunctionType

1202

(attribute.func_code,

1203

attribute.func_globals,

1204

attribute.func_name,

1205

attribute.func_defaults,

1206

attribute.func_closure)))

1723

attr[attrname] = (

1724

dbus_interface_annotations(alt_interface)

1725

(copy_function(attribute)))

1207

1726

if deprecate:

1208

1727

# Deprecate all alternate interfaces

1209

iname="_AlternateDBusNames_interface_annotation{0}"

1728

iname = "_AlternateDBusNames_interface_annotation{}"

1210

1729

for interface_name in interface_names:

1730

1211

1731

@dbus_interface_annotations(interface_name)

1212

1732

def func(self):

1213

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

1214

"true" }

1733

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

1734

"true"}

1215

1735

# Find an unused name

1216

1736

for aname in (iname.format(i)

1217

1737

for i in itertools.count()):

1221

1741

if interface_names:

1222

1742

# Replace the class with a new subclass of it with

1223

1743

# methods, signals, etc. as created above.

1224

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

1225

(cls,), attr)

1744

if sys.version_info.major == 2:

1745

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

1746

(cls, ), attr)

1747

else:

1748

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

1749

(cls, ), attr)

1226

1750

return cls

1751

1227

1752

return wrapper

1228

1753

1229

1754

1230

1755

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

1231

"se.bsnet.fukt.Mandos"})

1756

"se.bsnet.fukt.Mandos"})

1232

1757

class ClientDBus(Client, DBusObjectWithProperties):

1233

1758

"""A Client class using D-Bus

1234

1759

1235

1760

Attributes:

1236

1761

dbus_object_path: dbus.ObjectPath

1237

1762

bus: dbus.SystemBus()

1238

1763

"""

1239

1764

1240

1765

runtime_expansions = (Client.runtime_expansions

1241

+ ("dbus_object_path",))

1242

1766

+ ("dbus_object_path", ))

1767

1768

_interface = "se.recompile.Mandos.Client"

1769

1243

1770

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

1244

1245

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

1771

1772

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

1246

1773

self.bus = bus

1247

1774

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

1248

1775

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

1249

1776

# the D-Bus

1250

client_object_name = unicode(self.name).translate(

1777

client_object_name = str(self.name).translate(

1251

1778

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

1252

1779

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

1253

self.dbus_object_path = (dbus.ObjectPath

1254

("/clients/" + client_object_name))

1780

self.dbus_object_path = dbus.ObjectPath(

1781

"/clients/" + client_object_name)

1255

1782

DBusObjectWithProperties.__init__(self, self.bus,

1256

1783

self.dbus_object_path)

1257

1258

def notifychangeproperty(transform_func,

1259

dbus_name, type_func=lambda x: x,

1260

variant_level=1):

1784

1785

def notifychangeproperty(transform_func, dbus_name,

1786

type_func=lambda x: x,

1787

variant_level=1,

1788

invalidate_only=False,

1789

_interface=_interface):

1261

1790

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

1262

1791

its changes to DBus.

1263

1792

1264

1793

transform_fun: Function that takes a value and a variant_level

1265

1794

and transforms it to a D-Bus type.

1266

1795

dbus_name: D-Bus name of the variable

1268

1797

to the D-Bus. Default: no transform

1269

1798

variant_level: D-Bus variant level. Default: 1

1270

1799

"""

1271

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

1800

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

1801

1272

1802

def setter(self, value):

1273

1803

if hasattr(self, "dbus_object_path"):

1274

1804

if (not hasattr(self, attrname) or

1275

1805

type_func(getattr(self, attrname, None))

1276

1806

!= type_func(value)):

1277

dbus_value = transform_func(type_func(value),

1278

variant_level

1279

=variant_level)

1280

self.PropertyChanged(dbus.String(dbus_name),

1281

dbus_value)

1807

if invalidate_only:

1808

self.PropertiesChanged(

1809

_interface, dbus.Dictionary(),

1810

dbus.Array((dbus_name, )))

1811

else:

1812

dbus_value = transform_func(

1813

type_func(value),

1814

variant_level=variant_level)

1815

self.PropertyChanged(dbus.String(dbus_name),

1816

dbus_value)

1817

self.PropertiesChanged(

1818

_interface,

1819

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

1820

dbus_value}),

1821

dbus.Array())

1282

1822

setattr(self, attrname, value)

1283

1823

1284

1824

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

1285

1825

1286

1826

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1287

1827

approvals_pending = notifychangeproperty(dbus.Boolean,

1288

1828

"ApprovalPending",

1289

type_func = bool)

1829

type_func=bool)

1290

1830

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

1291

1831

last_enabled = notifychangeproperty(datetime_to_dbus,

1292

1832

"LastEnabled")

1293

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

1294

type_func = lambda checker:

1295

checker is not None)

1833

checker = notifychangeproperty(

1834

dbus.Boolean, "CheckerRunning",

1835

type_func=lambda checker: checker is not None)

1296

1836

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1297

1837

"LastCheckedOK")

1298

1838

last_checker_status = notifychangeproperty(dbus.Int16,

1301

1841

datetime_to_dbus, "LastApprovalRequest")

1302

1842

approved_by_default = notifychangeproperty(dbus.Boolean,

1303

1843

"ApprovedByDefault")

1304

approval_delay = notifychangeproperty(dbus.UInt64,

1305

"ApprovalDelay",

1306

type_func =

1307

timedelta_to_milliseconds)

1844

approval_delay = notifychangeproperty(

1845

dbus.UInt64, "ApprovalDelay",

1846

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

1308

1847

approval_duration = notifychangeproperty(

1309

1848

dbus.UInt64, "ApprovalDuration",

1310

type_func = timedelta_to_milliseconds)

1849

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

1311

1850

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

1312

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

1313

type_func =

1314

timedelta_to_milliseconds)

1851

timeout = notifychangeproperty(

1852

dbus.UInt64, "Timeout",

1853

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

1315

1854

extended_timeout = notifychangeproperty(

1316

1855

dbus.UInt64, "ExtendedTimeout",

1317

type_func = timedelta_to_milliseconds)

1318

interval = notifychangeproperty(dbus.UInt64,

1319

"Interval",

1320

type_func =

1321

timedelta_to_milliseconds)

1856

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

1857

interval = notifychangeproperty(

1858

dbus.UInt64, "Interval",

1859

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

1322

1860

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

1323

1861

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

1862

invalidate_only=True)

1863

1324

1864

del notifychangeproperty

1325

1865

1326

1866

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

1327

1867

try:

1328

1868

self.remove_from_connection()

1331

1871

if hasattr(DBusObjectWithProperties, "__del__"):

1332

1872

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

1333

1873

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

1334

1335

def checker_callback(self, pid, condition, command,

1336

*args, **kwargs):

1337

self.checker_callback_tag = None

1338

self.checker = None

1339

if os.WIFEXITED(condition):

1340

exitstatus = os.WEXITSTATUS(condition)

1874

1875

def checker_callback(self, source, condition,

1876

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

1877

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

1878

connection, command, *args,

1879

**kwargs)

1880

exitstatus = self.last_checker_status

1881

if exitstatus >= 0:

1341

1882

# Emit D-Bus signal

1342

1883

self.CheckerCompleted(dbus.Int16(exitstatus),

1343

dbus.Int64(condition),

1884

# This is specific to GNU libC

1885

dbus.Int64(exitstatus << 8),

1344

1886

dbus.String(command))

1345

1887

else:

1346

1888

# Emit D-Bus signal

1347

1889

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

1348

dbus.Int64(condition),

1890

dbus.Int64(

1891

# This is specific to GNU libC

1892

(exitstatus << 8)

1893

| self.last_checker_signal),

1349

1894

dbus.String(command))

1350

1351

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

1352

*args, **kwargs)

1353

1895

return ret

1896

1354

1897

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

1355

1898

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

1356

1899

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

1360

1903

# Emit D-Bus signal

1361

1904

self.CheckerStarted(self.current_checker_command)

1362

1905

return r

1363

1906

1364

1907

def _reset_approved(self):

1365

1908

self.approved = None

1366

1909

return False

1367

1910

1368

1911

def approve(self, value=True):

1369

1912

self.approved = value

1370

gobject.timeout_add(timedelta_to_milliseconds

1371

(self.approval_duration),

1372

self._reset_approved)

1913

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

1914

* 1000), self._reset_approved)

1373

1915

self.send_changedstate()

1374

1375

## D-Bus methods, signals & properties

1376

_interface = "se.recompile.Mandos.Client"

1377

1378

## Interfaces

1379

1380

@dbus_interface_annotations(_interface)

1381

def _foo(self):

1382

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

1383

"false"}

1384

1385

## Signals

1386

1916

1917

# D-Bus methods, signals & properties

1918

1919

# Interfaces

1920

1921

# Signals

1922

1387

1923

# CheckerCompleted - signal

1388

1924

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

1389

1925

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

1390

1926

"D-Bus signal"

1391

1927

pass

1392

1928

1393

1929

# CheckerStarted - signal

1394

1930

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

1395

1931

def CheckerStarted(self, command):

1396

1932

"D-Bus signal"

1397

1933

pass

1398

1934

1399

1935

# PropertyChanged - signal

1936

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

1400

1937

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

1401

1938

def PropertyChanged(self, property, value):

1402

1939

"D-Bus signal"

1403

1940

pass

1404

1941

1405

1942

# GotSecret - signal

1406

1943

@dbus.service.signal(_interface)

1407

1944

def GotSecret(self):

1410

1947

server to mandos-client

1411

1948

"""

1412

1949

pass

1413

1950

1414

1951

# Rejected - signal

1415

1952

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

1416

1953

def Rejected(self, reason):

1417

1954

"D-Bus signal"

1418

1955

pass

1419

1956

1420

1957

# NeedApproval - signal

1421

1958

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

1422

1959

def NeedApproval(self, timeout, default):

1423

1960

"D-Bus signal"

1424

1961

return self.need_approval()

1425

1426

## Methods

1427

1962

1963

# Methods

1964

1428

1965

# Approve - method

1429

1966

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

1430

1967

def Approve(self, value):

1431

1968

self.approve(value)

1432

1969

1433

1970

# CheckedOK - method

1434

1971

@dbus.service.method(_interface)

1435

1972

def CheckedOK(self):

1436

1973

self.checked_ok()

1437

1974

1438

1975

# Enable - method

1976

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

1439

1977

@dbus.service.method(_interface)

1440

1978

def Enable(self):

1441

1979

"D-Bus method"

1442

1980

self.enable()

1443

1981

1444

1982

# StartChecker - method

1983

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

1445

1984

@dbus.service.method(_interface)

1446

1985

def StartChecker(self):

1447

1986

"D-Bus method"

1448

1987

self.start_checker()

1449

1988

1450

1989

# Disable - method

1990

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

1451

1991

@dbus.service.method(_interface)

1452

1992

def Disable(self):

1453

1993

"D-Bus method"

1454

1994

self.disable()

1455

1995

1456

1996

# StopChecker - method

1997

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

1457

1998

@dbus.service.method(_interface)

1458

1999

def StopChecker(self):

1459

2000

self.stop_checker()

1460

1461

## Properties

1462

2001

2002

# Properties

2003

1463

2004

# ApprovalPending - property

1464

2005

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

1465

2006

def ApprovalPending_dbus_property(self):

1466

2007

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

1467

2008

1468

2009

# ApprovedByDefault - property

1469

@dbus_service_property(_interface, signature="b",

2010

@dbus_service_property(_interface,

2011

signature="b",

1470

2012

access="readwrite")

1471

2013

def ApprovedByDefault_dbus_property(self, value=None):

1472

2014

if value is None: # get

1473

2015

return dbus.Boolean(self.approved_by_default)

1474

2016

self.approved_by_default = bool(value)

1475

2017

1476

2018

# ApprovalDelay - property

1477

@dbus_service_property(_interface, signature="t",

2019

@dbus_service_property(_interface,

2020

signature="t",

1478

2021

access="readwrite")

1479

2022

def ApprovalDelay_dbus_property(self, value=None):

1480

2023

if value is None: # get

1481

return dbus.UInt64(self.approval_delay_milliseconds())

2024

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

2025

* 1000)

1482

2026

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

1483

2027

1484

2028

# ApprovalDuration - property

1485

@dbus_service_property(_interface, signature="t",

2029

@dbus_service_property(_interface,

2030

signature="t",

1486

2031

access="readwrite")

1487

2032

def ApprovalDuration_dbus_property(self, value=None):

1488

2033

if value is None: # get

1489

return dbus.UInt64(timedelta_to_milliseconds(

1490

self.approval_duration))

2034

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

2035

* 1000)

1491

2036

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

1492

2037

1493

2038

# Name - property

2039

@dbus_annotations(

2040

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

1494

2041

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

1495

2042

def Name_dbus_property(self):

1496

2043

return dbus.String(self.name)

1497

2044

2045

# KeyID - property

2046

@dbus_annotations(

2047

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

2048

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

2049

def KeyID_dbus_property(self):

2050

return dbus.String(self.key_id)

2051

1498

2052

# Fingerprint - property

2053

@dbus_annotations(

2054

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

1499

2055

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

1500

2056

def Fingerprint_dbus_property(self):

1501

2057

return dbus.String(self.fingerprint)

1502

2058

1503

2059

# Host - property

1504

@dbus_service_property(_interface, signature="s",

2060

@dbus_service_property(_interface,

2061

signature="s",

1505

2062

access="readwrite")

1506

2063

def Host_dbus_property(self, value=None):

1507

2064

if value is None: # get

1508

2065

return dbus.String(self.host)

1509

self.host = unicode(value)

1510

2066

self.host = str(value)

2067

1511

2068

# Created - property

2069

@dbus_annotations(

2070

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

1512

2071

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

1513

2072

def Created_dbus_property(self):

1514

2073

return datetime_to_dbus(self.created)

1515

2074

1516

2075

# LastEnabled - property

1517

2076

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

1518

2077

def LastEnabled_dbus_property(self):

1519

2078

return datetime_to_dbus(self.last_enabled)

1520

2079

1521

2080

# Enabled - property

1522

@dbus_service_property(_interface, signature="b",

2081

@dbus_service_property(_interface,

2082

signature="b",

1523

2083

access="readwrite")

1524

2084

def Enabled_dbus_property(self, value=None):

1525

2085

if value is None: # get

1528

2088

self.enable()

1529

2089

else:

1530

2090

self.disable()

1531

2091

1532

2092

# LastCheckedOK - property

1533

@dbus_service_property(_interface, signature="s",

2093

@dbus_service_property(_interface,

2094

signature="s",

1534

2095

access="readwrite")

1535

2096

def LastCheckedOK_dbus_property(self, value=None):

1536

2097

if value is not None:

1537

2098

self.checked_ok()

1538

2099

return

1539

2100

return datetime_to_dbus(self.last_checked_ok)

1540

2101

1541

2102

# LastCheckerStatus - property

1542

@dbus_service_property(_interface, signature="n",

1543

access="read")

2103

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

1544

2104

def LastCheckerStatus_dbus_property(self):

1545

2105

return dbus.Int16(self.last_checker_status)

1546

2106

1547

2107

# Expires - property

1548

2108

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

1549

2109

def Expires_dbus_property(self):

1550

2110

return datetime_to_dbus(self.expires)

1551

2111

1552

2112

# LastApprovalRequest - property

1553

2113

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

1554

2114

def LastApprovalRequest_dbus_property(self):

1555

2115

return datetime_to_dbus(self.last_approval_request)

1556

2116

1557

2117

# Timeout - property

1558

@dbus_service_property(_interface, signature="t",

2118

@dbus_service_property(_interface,

2119

signature="t",

1559

2120

access="readwrite")

1560

2121

def Timeout_dbus_property(self, value=None):

1561

2122

if value is None: # get

1562

return dbus.UInt64(self.timeout_milliseconds())

2123

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

1563

2124

old_timeout = self.timeout

1564

2125

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

1565

2126

# Reschedule disabling

1573

2134

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

1574

2135

is None):

1575

2136

return

1576

gobject.source_remove(self.disable_initiator_tag)

1577

self.disable_initiator_tag = (

1578

gobject.timeout_add(

1579

timedelta_to_milliseconds(self.expires - now),

1580

self.disable))

1581

2137

GLib.source_remove(self.disable_initiator_tag)

2138

self.disable_initiator_tag = GLib.timeout_add(

2139

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

2140

self.disable)

2141

1582

2142

# ExtendedTimeout - property

1583

@dbus_service_property(_interface, signature="t",

2143

@dbus_service_property(_interface,

2144

signature="t",

1584

2145

access="readwrite")

1585

2146

def ExtendedTimeout_dbus_property(self, value=None):

1586

2147

if value is None: # get

1587

return dbus.UInt64(self.extended_timeout_milliseconds())

2148

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

2149

* 1000)

1588

2150

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

1589

2151

1590

2152

# Interval - property

1591

@dbus_service_property(_interface, signature="t",

2153

@dbus_service_property(_interface,

2154

signature="t",

1592

2155

access="readwrite")

1593

2156

def Interval_dbus_property(self, value=None):

1594

2157

if value is None: # get

1595

return dbus.UInt64(self.interval_milliseconds())

2158

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

1596

2159

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

1597

2160

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

1598

2161

return

1599

2162

if self.enabled:

1600

2163

# Reschedule checker run

1601

gobject.source_remove(self.checker_initiator_tag)

1602

self.checker_initiator_tag = (gobject.timeout_add

1603

(value, self.start_checker))

1604

self.start_checker() # Start one now, too

1605

2164

GLib.source_remove(self.checker_initiator_tag)

2165

self.checker_initiator_tag = GLib.timeout_add(

2166

value, self.start_checker)

2167

self.start_checker() # Start one now, too

2168

1606

2169

# Checker - property

1607

@dbus_service_property(_interface, signature="s",

2170

@dbus_service_property(_interface,

2171

signature="s",

1608

2172

access="readwrite")

1609

2173

def Checker_dbus_property(self, value=None):

1610

2174

if value is None: # get

1611

2175

return dbus.String(self.checker_command)

1612

self.checker_command = unicode(value)

1613

2176

self.checker_command = str(value)

2177

1614

2178

# CheckerRunning - property

1615

@dbus_service_property(_interface, signature="b",

2179

@dbus_service_property(_interface,

2180

signature="b",

1616

2181

access="readwrite")

1617

2182

def CheckerRunning_dbus_property(self, value=None):

1618

2183

if value is None: # get

1621

2186

self.start_checker()

1622

2187

else:

1623

2188

self.stop_checker()

1624

2189

1625

2190

# ObjectPath - property

2191

@dbus_annotations(

2192

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

2193

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

1626

2194

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

1627

2195

def ObjectPath_dbus_property(self):

1628

return self.dbus_object_path # is already a dbus.ObjectPath

1629

2196

return self.dbus_object_path # is already a dbus.ObjectPath

2197

1630

2198

# Secret = property

1631

@dbus_service_property(_interface, signature="ay",

1632

access="write", byte_arrays=True)

2199

@dbus_annotations(

2200

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

2201

"invalidates"})

2202

@dbus_service_property(_interface,

2203

signature="ay",

2204

access="write",

2205

byte_arrays=True)

1633

2206

def Secret_dbus_property(self, value):

1634

self.secret = str(value)

1635

2207

self.secret = bytes(value)

2208

1636

2209

del _interface

1637

2210

1638

2211

1639

2212

class ProxyClient(object):

1640

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

2213

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

1641

2214

self._pipe = child_pipe

1642

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

2215

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

1643

2216

if not self._pipe.recv():

1644

raise KeyError()

1645

2217

raise KeyError(key_id or fpr)

2218

1646

2219

def __getattribute__(self, name):

1647

2220

if name == '_pipe':

1648

2221

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

1651

2224

if data[0] == 'data':

1652

2225

return data[1]

1653

2226

if data[0] == 'function':

2227

1654

2228

def func(*args, **kwargs):

1655

2229

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

1656

2230

return self._pipe.recv()[1]

2231

1657

2232

return func

1658

2233

1659

2234

def __setattr__(self, name, value):

1660

2235

if name == '_pipe':

1661

2236

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

1664

2239

1665

2240

class ClientHandler(socketserver.BaseRequestHandler, object):

1666

2241

"""A class to handle client connections.

1667

2242

1668

2243

Instantiated once for each connection to handle it.

1669

2244

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

1670

2245

1671

2246

def handle(self):

1672

2247

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

1673

2248

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

1674

unicode(self.client_address))

2249

str(self.client_address))

1675

2250

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

1676

2251

self.server.child_pipe.fileno())

1677

1678

session = (gnutls.connection

1679

.ClientSession(self.request,

1680

gnutls.connection

1681

.X509Credentials()))

1682

1683

# Note: gnutls.connection.X509Credentials is really a

1684

# generic GnuTLS certificate credentials object so long as

1685

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

1686

# here despite using OpenPGP certificates.

1687

1688

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

1689

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

1690

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

1691

# "+DHE-DSS"))

2252

2253

session = gnutls.ClientSession(self.request)

2254

2255

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

2256

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

2257

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

2258

# "+DHE-DSS"))

1692

2259

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

1693

2260

priority = self.server.gnutls_priority

1694

2261

if priority is None:

1695

2262

priority = "NORMAL"

1696

(gnutls.library.functions

1697

.gnutls_priority_set_direct(session._c_object,

1698

priority, None))

1699

2263

gnutls.priority_set_direct(session._c_object,

2264

priority.encode("utf-8"),

2265

None)

2266

1700

2267

# Start communication using the Mandos protocol

1701

2268

# Get protocol number

1702

2269

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

1707

2274

except (ValueError, IndexError, RuntimeError) as error:

1708

2275

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

1709

2276

return

1710

2277

1711

2278

# Start GnuTLS connection

1712

2279

try:

1713

2280

session.handshake()

1714

except gnutls.errors.GNUTLSError as error:

2281

except gnutls.Error as error:

1715

2282

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

1716

2283

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

1717

2284

# established. Just abandon the request.

1718

2285

return

1719

2286

logger.debug("Handshake succeeded")

1720

2287

1721

2288

approval_required = False

1722

2289

try:

1723

try:

1724

fpr = self.fingerprint(self.peer_certificate

1725

(session))

1726

except (TypeError,

1727

gnutls.errors.GNUTLSError) as error:

1728

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

1729

return

1730

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

1731

1732

try:

1733

client = ProxyClient(child_pipe, fpr,

2290

if gnutls.has_rawpk:

2291

fpr = b""

2292

try:

2293

key_id = self.key_id(

2294

self.peer_certificate(session))

2295

except (TypeError, gnutls.Error) as error:

2296

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

2297

return

2298

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

2299

2300

else:

2301

key_id = b""

2302

try:

2303

fpr = self.fingerprint(

2304

self.peer_certificate(session))

2305

except (TypeError, gnutls.Error) as error:

2306

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

2307

return

2308

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

2309

2310

try:

2311

client = ProxyClient(child_pipe, key_id, fpr,

1734

2312

self.client_address)

1735

2313

except KeyError:

1736

2314

return

1737

2315

1738

2316

if client.approval_delay:

1739

2317

delay = client.approval_delay

1740

2318

client.approvals_pending += 1

1741

2319

approval_required = True

1742

2320

1743

2321

while True:

1744

2322

if not client.enabled:

1745

2323

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

1746

client.name)

2324

client.name)

1747

2325

if self.server.use_dbus:

1748

2326

# Emit D-Bus signal

1749

2327

client.Rejected("Disabled")

1750

2328

return

1751

2329

1752

2330

if client.approved or not client.approval_delay:

1753

#We are approved or approval is disabled

2331

# We are approved or approval is disabled

1754

2332

break

1755

2333

elif client.approved is None:

1756

2334

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

1758

2336

if self.server.use_dbus:

1759

2337

# Emit D-Bus signal

1760

2338

client.NeedApproval(

1761

client.approval_delay_milliseconds(),

1762

client.approved_by_default)

2339

client.approval_delay.total_seconds()

2340

* 1000, client.approved_by_default)

1763

2341

else:

1764

2342

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

1765

2343

client.name)

1767

2345

# Emit D-Bus signal

1768

2346

client.Rejected("Denied")

1769

2347

return

1770

1771

#wait until timeout or approved

2348

2349

# wait until timeout or approved

1772

2350

time = datetime.datetime.now()

1773

2351

client.changedstate.acquire()

1774

client.changedstate.wait(

1775

float(timedelta_to_milliseconds(delay)

1776

/ 1000))

2352

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

1777

2353

client.changedstate.release()

1778

2354

time2 = datetime.datetime.now()

1779

2355

if (time2 - time) >= delay:

1789

2365

break

1790

2366

else:

1791

2367

delay -= time2 - time

1792

1793

sent_size = 0

1794

while sent_size < len(client.secret):

1795

try:

1796

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

1797

except gnutls.errors.GNUTLSError as error:

1798

logger.warning("gnutls send failed",

1799

exc_info=error)

1800

return

1801

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

1802

sent, len(client.secret)

1803

- (sent_size + sent))

1804

sent_size += sent

1805

2368

2369

try:

2370

session.send(client.secret)

2371

except gnutls.Error as error:

2372

logger.warning("gnutls send failed",

2373

exc_info=error)

2374

return

2375

1806

2376

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

1807

2377

# bump the timeout using extended_timeout

1808

2378

client.bump_timeout(client.extended_timeout)

1809

2379

if self.server.use_dbus:

1810

2380

# Emit D-Bus signal

1811

2381

client.GotSecret()

1812

2382

1813

2383

finally:

1814

2384

if approval_required:

1815

2385

client.approvals_pending -= 1

1816

2386

try:

1817

2387

session.bye()

1818

except gnutls.errors.GNUTLSError as error:

2388

except gnutls.Error as error:

1819

2389

logger.warning("GnuTLS bye failed",

1820

2390

exc_info=error)

1821

2391

1822

2392

@staticmethod

1823

2393

def peer_certificate(session):

1824

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

1825

# If not an OpenPGP certificate...

1826

if (gnutls.library.functions

1827

.gnutls_certificate_type_get(session._c_object)

1828

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1829

# ...do the normal thing

1830

return session.peer_certificate

2394

"Return the peer's certificate as a bytestring"

2395

try:

2396

cert_type = gnutls.certificate_type_get2(session._c_object,

2397

gnutls.CTYPE_PEERS)

2398

except AttributeError:

2399

cert_type = gnutls.certificate_type_get(session._c_object)

2400

if gnutls.has_rawpk:

2401

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2402

else:

2403

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2404

# If not a valid certificate type...

2405

if cert_type not in valid_cert_types:

2406

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

2407

valid_cert_types)

2408

# ...return invalid data

2409

return b""

1831

2410

list_size = ctypes.c_uint(1)

1832

cert_list = (gnutls.library.functions

1833

.gnutls_certificate_get_peers

2411

cert_list = (gnutls.certificate_get_peers

1834

2412

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

1835

2413

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

1836

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

1837

" certificate")

2414

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

1838

2415

if list_size.value == 0:

1839

2416

return None

1840

2417

cert = cert_list[0]

1841

2418

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

1842

2419

2420

@staticmethod

2421

def key_id(certificate):

2422

"Convert a certificate bytestring to a hexdigit key ID"

2423

# New GnuTLS "datum" with the public key

2424

datum = gnutls.datum_t(

2425

ctypes.cast(ctypes.c_char_p(certificate),

2426

ctypes.POINTER(ctypes.c_ubyte)),

2427

ctypes.c_uint(len(certificate)))

2428

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

2429

# New empty GnuTLS certificate

2430

pubkey = gnutls.pubkey_t()

2431

gnutls.pubkey_init(ctypes.byref(pubkey))

2432

# Import the raw public key into the certificate

2433

gnutls.pubkey_import(pubkey,

2434

ctypes.byref(datum),

2435

gnutls.X509_FMT_DER)

2436

# New buffer for the key ID

2437

buf = ctypes.create_string_buffer(32)

2438

buf_len = ctypes.c_size_t(len(buf))

2439

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

2440

gnutls.pubkey_get_key_id(pubkey,

2441

gnutls.KEYID_USE_SHA256,

2442

ctypes.cast(ctypes.byref(buf),

2443

ctypes.POINTER(ctypes.c_ubyte)),

2444

ctypes.byref(buf_len))

2445

# Deinit the certificate

2446

gnutls.pubkey_deinit(pubkey)

2447

2448

# Convert the buffer to a Python bytestring

2449

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

2450

# Convert the bytestring to hexadecimal notation

2451

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

2452

return hex_key_id

2453

1843

2454

@staticmethod

1844

2455

def fingerprint(openpgp):

1845

2456

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1846

2457

# New GnuTLS "datum" with the OpenPGP public key

1847

datum = (gnutls.library.types

1848

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

1849

ctypes.POINTER

1850

(ctypes.c_ubyte)),

1851

ctypes.c_uint(len(openpgp))))

2458

datum = gnutls.datum_t(

2459

ctypes.cast(ctypes.c_char_p(openpgp),

2460

ctypes.POINTER(ctypes.c_ubyte)),

2461

ctypes.c_uint(len(openpgp)))

1852

2462

# New empty GnuTLS certificate

1853

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1854

(gnutls.library.functions

1855

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2463

crt = gnutls.openpgp_crt_t()

2464

gnutls.openpgp_crt_init(ctypes.byref(crt))

1856

2465

# Import the OpenPGP public key into the certificate

1857

(gnutls.library.functions

1858

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

1859

gnutls.library.constants

1860

.GNUTLS_OPENPGP_FMT_RAW))

2466

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

2467

gnutls.OPENPGP_FMT_RAW)

1861

2468

# Verify the self signature in the key

1862

2469

crtverify = ctypes.c_uint()

1863

(gnutls.library.functions

1864

.gnutls_openpgp_crt_verify_self(crt, 0,

1865

ctypes.byref(crtverify)))

2470

gnutls.openpgp_crt_verify_self(crt, 0,

2471

ctypes.byref(crtverify))

1866

2472

if crtverify.value != 0:

1867

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1868

raise (gnutls.errors.CertificateSecurityError

1869

("Verify failed"))

2473

gnutls.openpgp_crt_deinit(crt)

2474

raise gnutls.CertificateSecurityError(code

2475

=crtverify.value)

1870

2476

# New buffer for the fingerprint

1871

2477

buf = ctypes.create_string_buffer(20)

1872

2478

buf_len = ctypes.c_size_t()

1873

2479

# Get the fingerprint from the certificate into the buffer

1874

(gnutls.library.functions

1875

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

1876

ctypes.byref(buf_len)))

2480

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

2481

ctypes.byref(buf_len))

1877

2482

# Deinit the certificate

1878

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2483

gnutls.openpgp_crt_deinit(crt)

1879

2484

# Convert the buffer to a Python bytestring

1880

2485

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

1881

2486

# Convert the bytestring to hexadecimal notation

1885

2490

1886

2491

class MultiprocessingMixIn(object):

1887

2492

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

2493

1888

2494

def sub_process_main(self, request, address):

1889

2495

try:

1890

2496

self.finish_request(request, address)

1891

2497

except Exception:

1892

2498

self.handle_error(request, address)

1893

2499

self.close_request(request)

1894

2500

1895

2501

def process_request(self, request, address):

1896

2502

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

1897

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

1898

args = (request, address))

2503

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

2504

args=(request, address))

1899

2505

proc.start()

1900

2506

return proc

1901

2507

1902

2508

1903

2509

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1904

2510

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

2511

1905

2512

def process_request(self, request, client_address):

1906

2513

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

1907

2514

1908

2515

This function creates a new pipe in self.pipe

1909

2516

"""

1910

2517

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1911

2518

1912

2519

proc = MultiprocessingMixIn.process_request(self, request,

1913

2520

client_address)

1914

2521

self.child_pipe.close()

1915

2522

self.add_pipe(parent_pipe, proc)

1916

2523

1917

2524

def add_pipe(self, parent_pipe, proc):

1918

2525

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

1919

2526

raise NotImplementedError()

1922

2529

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1923

2530

socketserver.TCPServer, object):

1924

2531

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

1925

2532

1926

2533

Attributes:

1927

2534

enabled: Boolean; whether this server is activated yet

1928

2535

interface: None or a network interface name (string)

1929

2536

use_ipv6: Boolean; to use IPv6 or not

1930

2537

"""

2538

1931

2539

def __init__(self, server_address, RequestHandlerClass,

1932

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

2540

interface=None,

2541

use_ipv6=True,

2542

socketfd=None):

1933

2543

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

1934

2544

creating a new one with socket.socket().

1935

2545

"""

1941

2551

self.socketfd = socketfd

1942

2552

# Save the original socket.socket() function

1943

2553

self.socket_socket = socket.socket

2554

1944

2555

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

1945

#

2556

#

1946

2557

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

1947

2558

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

1948

2559

# patching socket.socket.)

1949

#

2560

#

1950

2561

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

1951

2562

@functools.wraps(socket.socket)

1952

2563

def socket_wrapper(*args, **kwargs):

1964

2575

# socket_wrapper(), if socketfd was set.

1965

2576

socketserver.TCPServer.__init__(self, server_address,

1966

2577

RequestHandlerClass)

1967

2578

1968

2579

def server_bind(self):

1969

2580

"""This overrides the normal server_bind() function

1970

2581

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

1971

2582

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

2583

global SO_BINDTODEVICE

1972

2584

if self.interface is not None:

1973

2585

if SO_BINDTODEVICE is None:

1974

logger.error("SO_BINDTODEVICE does not exist;"

1975

" cannot bind to interface %s",

1976

self.interface)

1977

else:

1978

try:

1979

self.socket.setsockopt(socket.SOL_SOCKET,

1980

SO_BINDTODEVICE,

1981

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

1982

except socket.error as error:

1983

if error.errno == errno.EPERM:

1984

logger.error("No permission to bind to"

1985

" interface %s", self.interface)

1986

elif error.errno == errno.ENOPROTOOPT:

1987

logger.error("SO_BINDTODEVICE not available;"

1988

" cannot bind to interface %s",

1989

self.interface)

1990

elif error.errno == errno.ENODEV:

1991

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

1992

" cannot bind", self.interface)

1993

else:

1994

raise

2586

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

2587

# common enough.

2588

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

2589

SO_BINDTODEVICE = 25

2590

try:

2591

self.socket.setsockopt(

2592

socket.SOL_SOCKET, SO_BINDTODEVICE,

2593

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

2594

except socket.error as error:

2595

if error.errno == errno.EPERM:

2596

logger.error("No permission to bind to"

2597

" interface %s", self.interface)

2598

elif error.errno == errno.ENOPROTOOPT:

2599

logger.error("SO_BINDTODEVICE not available;"

2600

" cannot bind to interface %s",

2601

self.interface)

2602

elif error.errno == errno.ENODEV:

2603

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

2604

" cannot bind", self.interface)

2605

else:

2606

raise

1995

2607

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

1996

2608

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

2609

if self.server_address[1]:

2610

self.allow_reuse_address = True

1997

2611

if not self.server_address[0]:

1998

2612

if self.address_family == socket.AF_INET6:

1999

any_address = "::" # in6addr_any

2613

any_address = "::" # in6addr_any

2000

2614

else:

2001

any_address = "0.0.0.0" # INADDR_ANY

2615

any_address = "0.0.0.0" # INADDR_ANY

2002

2616

self.server_address = (any_address,

2003

2617

self.server_address[1])

2004

2618

elif not self.server_address[1]:

2005

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

2006

0)

2619

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

2007

2620

# if self.interface:

2008

2621

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

2009

2622

# 0, # port

2015

2628

2016

2629

class MandosServer(IPv6_TCPServer):

2017

2630

"""Mandos server.

2018

2631

2019

2632

Attributes:

2020

2633

clients: set of Client objects

2021

2634

gnutls_priority GnuTLS priority string

2022

2635

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

2023

2024

Assumes a gobject.MainLoop event loop.

2636

2637

Assumes a GLib.MainLoop event loop.

2025

2638

"""

2639

2026

2640

def __init__(self, server_address, RequestHandlerClass,

2027

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

2028

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

2641

interface=None,

2642

use_ipv6=True,

2643

clients=None,

2644

gnutls_priority=None,

2645

use_dbus=True,

2646

socketfd=None):

2029

2647

self.enabled = False

2030

2648

self.clients = clients

2031

2649

if self.clients is None:

2034

2652

self.gnutls_priority = gnutls_priority

2035

2653

IPv6_TCPServer.__init__(self, server_address,

2036

2654

RequestHandlerClass,

2037

interface = interface,

2038

use_ipv6 = use_ipv6,

2039

socketfd = socketfd)

2655

interface=interface,

2656

use_ipv6=use_ipv6,

2657

socketfd=socketfd)

2658

2040

2659

def server_activate(self):

2041

2660

if self.enabled:

2042

2661

return socketserver.TCPServer.server_activate(self)

2043

2662

2044

2663

def enable(self):

2045

2664

self.enabled = True

2046

2665

2047

2666

def add_pipe(self, parent_pipe, proc):

2048

2667

# Call "handle_ipc" for both data and EOF events

2049

gobject.io_add_watch(parent_pipe.fileno(),

2050

gobject.IO_IN | gobject.IO_HUP,

2051

functools.partial(self.handle_ipc,

2052

parent_pipe =

2053

parent_pipe,

2054

proc = proc))

2055

2056

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

2057

proc = None, client_object=None):

2668

GLib.io_add_watch(

2669

parent_pipe.fileno(),

2670

GLib.IO_IN | GLib.IO_HUP,

2671

functools.partial(self.handle_ipc,

2672

parent_pipe=parent_pipe,

2673

proc=proc))

2674

2675

def handle_ipc(self, source, condition,

2676

parent_pipe=None,

2677

proc=None,

2678

client_object=None):

2058

2679

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

2059

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

2680

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

2060

2681

# Wait for other process to exit

2061

2682

proc.join()

2062

2683

return False

2063

2684

2064

2685

# Read a request from the child

2065

2686

request = parent_pipe.recv()

2066

2687

command = request[0]

2067

2688

2068

2689

if command == 'init':

2069

fpr = request[1]

2070

address = request[2]

2071

2072

for c in self.clients.itervalues():

2073

if c.fingerprint == fpr:

2690

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

2691

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

2692

address = request[3]

2693

2694

for c in self.clients.values():

2695

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2696

continue

2697

if key_id and c.key_id == key_id:

2698

client = c

2699

break

2700

if fpr and c.fingerprint == fpr:

2074

2701

client = c

2075

2702

break

2076

2703

else:

2077

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

2078

"dress: %s", fpr, address)

2704

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

2705

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

2079

2706

if self.use_dbus:

2080

2707

# Emit D-Bus signal

2081

mandos_dbus_service.ClientNotFound(fpr,

2708

mandos_dbus_service.ClientNotFound(key_id or fpr,

2082

2709

address[0])

2083

2710

parent_pipe.send(False)

2084

2711

return False

2085

2086

gobject.io_add_watch(parent_pipe.fileno(),

2087

gobject.IO_IN | gobject.IO_HUP,

2088

functools.partial(self.handle_ipc,

2089

parent_pipe =

2090

parent_pipe,

2091

proc = proc,

2092

client_object =

2093

client))

2712

2713

GLib.io_add_watch(

2714

parent_pipe.fileno(),

2715

GLib.IO_IN | GLib.IO_HUP,

2716

functools.partial(self.handle_ipc,

2717

parent_pipe=parent_pipe,

2718

proc=proc,

2719

client_object=client))

2094

2720

parent_pipe.send(True)

2095

2721

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

2096

2722

# same fileno

2099

2725

funcname = request[1]

2100

2726

args = request[2]

2101

2727

kwargs = request[3]

2102

2728

2103

2729

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

2104

2730

funcname)(*args,

2105

**kwargs)))

2106

2731

**kwargs)))

2732

2107

2733

if command == 'getattr':

2108

2734

attrname = request[1]

2109

if callable(client_object.__getattribute__(attrname)):

2110

parent_pipe.send(('function',))

2735

if isinstance(client_object.__getattribute__(attrname),

2736

collections.Callable):

2737

parent_pipe.send(('function', ))

2111

2738

else:

2112

parent_pipe.send(('data', client_object

2113

.__getattribute__(attrname)))

2114

2739

parent_pipe.send((

2740

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

2741

2115

2742

if command == 'setattr':

2116

2743

attrname = request[1]

2117

2744

value = request[2]

2118

2745

setattr(client_object, attrname, value)

2119

2746

2120

2747

return True

2121

2748

2122

2749

2123

2750

def rfc3339_duration_to_delta(duration):

2124

2751

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

2125

2752

2126

2753

>>> rfc3339_duration_to_delta("P7D")

2127

2754

datetime.timedelta(7)

2128

2755

>>> rfc3339_duration_to_delta("PT60S")

2138

2765

>>> rfc3339_duration_to_delta("P1DT3M20S")

2139

2766

datetime.timedelta(1, 200)

2140

2767

"""

2141

2768

2142

2769

# Parsing an RFC 3339 duration with regular expressions is not

2143

2770

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

2144

2771

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

2145

2772

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

2146

2773

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

2147

2774

# avoid excessive use of external libraries.

2148

2775

2149

2776

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

2150

Token = collections.namedtuple("Token",

2151

("regexp", # To match token; if

2152

# "value" is not None,

2153

# must have a "group"

2154

# containing digits

2155

"value", # datetime.timedelta or

2156

# None

2157

"followers")) # Tokens valid after

2158

# this token

2777

Token = collections.namedtuple("Token", (

2778

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

2779

# a "group" containing digits

2780

"value", # datetime.timedelta or None

2781

"followers")) # Tokens valid after this token

2159

2782

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

2160

2783

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

2161

2784

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

2162

2785

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

2163

2786

datetime.timedelta(seconds=1),

2164

frozenset((token_end,)))

2787

frozenset((token_end, )))

2165

2788

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

2166

2789

datetime.timedelta(minutes=1),

2167

2790

frozenset((token_second, token_end)))

2183

2806

frozenset((token_month, token_end)))

2184

2807

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

2185

2808

datetime.timedelta(weeks=1),

2186

frozenset((token_end,)))

2809

frozenset((token_end, )))

2187

2810

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

2188

2811

frozenset((token_year, token_month,

2189

2812

token_day, token_time,

2190

token_week))),

2191

# Define starting values

2192

value = datetime.timedelta() # Value so far

2813

token_week)))

2814

# Define starting values:

2815

# Value so far

2816

value = datetime.timedelta()

2193

2817

found_token = None

2194

followers = frozenset(token_duration,) # Following valid tokens

2195

s = duration # String left to parse

2818

# Following valid tokens

2819

followers = frozenset((token_duration, ))

2820

# String left to parse

2821

s = duration

2196

2822

# Loop until end token is found

2197

2823

while found_token is not token_end:

2198

2824

# Search for any currently valid tokens

2214

2840

break

2215

2841

else:

2216

2842

# No currently valid tokens were found

2217

raise ValueError("Invalid RFC 3339 duration")

2843

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

2844

.format(duration))

2218

2845

# End token found

2219

2846

return value

2220

2847

2221

2848

2222

2849

def string_to_delta(interval):

2223

2850

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

2224

2851

2225

2852

>>> string_to_delta('7d')

2226

2853

datetime.timedelta(7)

2227

2854

>>> string_to_delta('60s')

2235

2862

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

2236

2863

datetime.timedelta(0, 330)

2237

2864

"""

2238

2865

2239

2866

try:

2240

2867

return rfc3339_duration_to_delta(interval)

2241

2868

except ValueError:

2242

2869

pass

2243

2870

2244

2871

timevalue = datetime.timedelta(0)

2245

2872

for s in interval.split():

2246

2873

try:

2247

suffix = unicode(s[-1])

2874

suffix = s[-1]

2248

2875

value = int(s[:-1])

2249

2876

if suffix == "d":

2250

2877

delta = datetime.timedelta(value)

2257

2884

elif suffix == "w":

2258

2885

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

2259

2886

else:

2260

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

2261

.format(suffix))

2887

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

2262

2888

except IndexError as e:

2263

2889

raise ValueError(*(e.args))

2264

2890

timevalue += delta

2265

2891

return timevalue

2266

2892

2267

2893

2268

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

2894

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

2269

2895

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

2270

2896

2271

2897

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

2272

2898

if os.fork():

2273

2899

sys.exit()

2281

2907

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

2282

2908

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

2283

2909

raise OSError(errno.ENODEV,

2284

"{0} not a character device"

2910

"{} not a character device"

2285

2911

.format(os.devnull))

2286

2912

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

2287

2913

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

2291

2917

2292

2918

2293

2919

def main():

2294

2920

2295

2921

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

2296

2922

# Parsing of options, both command line and config file

2297

2923

2298

2924

parser = argparse.ArgumentParser()

2299

2925

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

2300

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

2926

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

2301

2927

help="show version number and exit")

2302

2928

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

2303

2929

help="Bind to interface IF")

2336

2962

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

2337

2963

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

2338

2964

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

2339

2965

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

2966

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

2967

default=None)

2968

2340

2969

options = parser.parse_args()

2341

2970

2342

2971

if options.check:

2343

2972

import doctest

2344

2973

fail_count, test_count = doctest.testmod()

2345

2974

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

2346

2975

2347

2976

# Default values for config file for server-global settings

2348

server_defaults = { "interface": "",

2349

"address": "",

2350

"port": "",

2351

"debug": "False",

2352

"priority":

2353

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

2354

"servicename": "Mandos",

2355

"use_dbus": "True",

2356

"use_ipv6": "True",

2357

"debuglevel": "",

2358

"restore": "True",

2359

"socket": "",

2360

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

2361

"foreground": "False",

2362

}

2363

2977

if gnutls.has_rawpk:

2978

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

2979

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

2980

else:

2981

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

2982

":+SIGN-DSA-SHA256")

2983

server_defaults = {"interface": "",

2984

"address": "",

2985

"port": "",

2986

"debug": "False",

2987

"priority": priority,

2988

"servicename": "Mandos",

2989

"use_dbus": "True",

2990

"use_ipv6": "True",

2991

"debuglevel": "",

2992

"restore": "True",

2993

"socket": "",

2994

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

2995

"foreground": "False",

2996

"zeroconf": "True",

2997

}

2998

del priority

2999

2364

3000

# Parse config file for server-global settings

2365

3001

server_config = configparser.SafeConfigParser(server_defaults)

2366

3002

del server_defaults

2367

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

2368

"mandos.conf"))

3003

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

2369

3004

# Convert the SafeConfigParser object to a dict

2370

3005

server_settings = server_config.defaults()

2371

3006

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

2372

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

3007

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

3008

"foreground", "zeroconf"):

2373

3009

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

2374

3010

option)

2375

3011

if server_settings["port"]:

2385

3021

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

2386

3022

["socket"])

2387

3023

del server_config

2388

3024

2389

3025

# Override the settings from the config file with command line

2390

3026

# options, if set.

2391

3027

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

2392

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

2393

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

2394

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

3028

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

3029

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

3030

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

2395

3031

value = getattr(options, option)

2396

3032

if value is not None:

2397

3033

server_settings[option] = value

2398

3034

del options

2399

3035

# Force all strings to be unicode

2400

3036

for option in server_settings.keys():

2401

if type(server_settings[option]) is str:

2402

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

3037

if isinstance(server_settings[option], bytes):

3038

server_settings[option] = (server_settings[option]

3039

.decode("utf-8"))

2403

3040

# Force all boolean options to be boolean

2404

3041

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

2405

"foreground"):

3042

"foreground", "zeroconf"):

2406

3043

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

2407

3044

# Debug implies foreground

2408

3045

if server_settings["debug"]:

2409

3046

server_settings["foreground"] = True

2410

3047

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

2411

3048

2412

3049

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

2413

3050

3051

if (not server_settings["zeroconf"]

3052

and not (server_settings["port"]

3053

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

3054

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

3055

2414

3056

# For convenience

2415

3057

debug = server_settings["debug"]

2416

3058

debuglevel = server_settings["debuglevel"]

2419

3061

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

2420

3062

stored_state_file)

2421

3063

foreground = server_settings["foreground"]

2422

3064

zeroconf = server_settings["zeroconf"]

3065

2423

3066

if debug:

2424

3067

initlogger(debug, logging.DEBUG)

2425

3068

else:

2428

3071

else:

2429

3072

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

2430

3073

initlogger(debug, level)

2431

3074

2432

3075

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

2433

syslogger.setFormatter(logging.Formatter

2434

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

2435

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

2436

.format(server_settings

2437

["servicename"])))

2438

3076

syslogger.setFormatter(

3077

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

3078

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

3079

server_settings["servicename"])))

3080

2439

3081

# Parse config file with clients

2440

3082

client_config = configparser.SafeConfigParser(Client

2441

3083

.client_defaults)

2442

3084

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

2443

3085

"clients.conf"))

2444

3086

2445

3087

global mandos_dbus_service

2446

3088

mandos_dbus_service = None

2447

2448

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

2449

server_settings["port"]),

2450

ClientHandler,

2451

interface=(server_settings["interface"]

2452

or None),

2453

use_ipv6=use_ipv6,

2454

gnutls_priority=

2455

server_settings["priority"],

2456

use_dbus=use_dbus,

2457

socketfd=(server_settings["socket"]

2458

or None))

3089

3090

socketfd = None

3091

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

3092

socketfd = server_settings["socket"]

3093

tcp_server = MandosServer(

3094

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

3095

ClientHandler,

3096

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

3097

use_ipv6=use_ipv6,

3098

gnutls_priority=server_settings["priority"],

3099

use_dbus=use_dbus,

3100

socketfd=socketfd)

2459

3101

if not foreground:

2460

3102

pidfilename = "/run/mandos.pid"

2461

3103

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

2462

3104

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

2463

3105

pidfile = None

2464

3106

try:

2465

pidfile = open(pidfilename, "w")

3107

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

2466

3108

except IOError as e:

2467

3109

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

2468

3110

exc_info=e)

2469

2470

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

3111

3112

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

3113

("mandos", "mandos"),

3114

("nobody", "nogroup")):

2471

3115

try:

2472

3116

uid = pwd.getpwnam(name).pw_uid

2473

gid = pwd.getpwnam(name).pw_gid

3117

gid = pwd.getpwnam(group).pw_gid

2474

3118

break

2475

3119

except KeyError:

2476

3120

continue

2480

3124

try:

2481

3125

os.setgid(gid)

2482

3126

os.setuid(uid)

3127

if debug:

3128

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

3129

gid))

2483

3130

except OSError as error:

3131

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

3132

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

2484

3133

if error.errno != errno.EPERM:

2485

3134

raise

2486

3135

2487

3136

if debug:

2488

3137

# Enable all possible GnuTLS debugging

2489

3138

2490

3139

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

2491

3140

# - GnuTLS manual

2492

gnutls.library.functions.gnutls_global_set_log_level(11)

2493

2494

@gnutls.library.types.gnutls_log_func

3141

gnutls.global_set_log_level(11)

3142

3143

@gnutls.log_func

2495

3144

def debug_gnutls(level, string):

2496

3145

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

2497

2498

(gnutls.library.functions

2499

.gnutls_global_set_log_function(debug_gnutls))

2500

3146

3147

gnutls.global_set_log_function(debug_gnutls)

3148

2501

3149

# Redirect stdin so all checkers get /dev/null

2502

3150

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

2503

3151

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

2504

3152

if null > 2:

2505

3153

os.close(null)

2506

3154

2507

3155

# Need to fork before connecting to D-Bus

2508

3156

if not foreground:

2509

3157

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

2510

3158

daemon()

2511

2512

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

2513

# need to inform gobject that threads will be used.

2514

gobject.threads_init()

2515

3159

3160

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

3161

# to inform GLib that threads will be used.

3162

GLib.threads_init()

3163

2516

3164

global main_loop

2517

3165

# From the Avahi example code

2518

3166

DBusGMainLoop(set_as_default=True)

2519

main_loop = gobject.MainLoop()

3167

main_loop = GLib.MainLoop()

2520

3168

bus = dbus.SystemBus()

2521

3169

# End of Avahi example code

2522

3170

if use_dbus:

2523

3171

try:

2524

3172

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

2525

bus, do_not_queue=True)

2526

old_bus_name = (dbus.service.BusName

2527

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

2528

do_not_queue=True))

2529

except dbus.exceptions.NameExistsException as e:

3173

bus,

3174

do_not_queue=True)

3175

old_bus_name = dbus.service.BusName(

3176

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

3177

do_not_queue=True)

3178

except dbus.exceptions.DBusException as e:

2530

3179

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

2531

3180

use_dbus = False

2532

3181

server_settings["use_dbus"] = False

2533

3182

tcp_server.use_dbus = False

2534

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2535

service = AvahiServiceToSyslog(name =

2536

server_settings["servicename"],

2537

servicetype = "_mandos._tcp",

2538

protocol = protocol, bus = bus)

2539

if server_settings["interface"]:

2540

service.interface = (if_nametoindex

2541

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

2542

3183

if zeroconf:

3184

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3185

service = AvahiServiceToSyslog(

3186

name=server_settings["servicename"],

3187

servicetype="_mandos._tcp",

3188

protocol=protocol,

3189

bus=bus)

3190

if server_settings["interface"]:

3191

service.interface = if_nametoindex(

3192

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

3193

2543

3194

global multiprocessing_manager

2544

3195

multiprocessing_manager = multiprocessing.Manager()

2545

3196

2546

3197

client_class = Client

2547

3198

if use_dbus:

2548

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

2549

3199

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

3200

2550

3201

client_settings = Client.config_parser(client_config)

2551

3202

old_client_settings = {}

2552

3203

clients_data = {}

2553

3204

2554

3205

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

2555

3206

global wnull

2556

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

3207

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

2557

3208

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

2558

3209

# mode

2559

3210

if debug or not foreground:

2560

3211

wnull.close()

2561

3212

2562

3213

# Get client data and settings from last running state.

2563

3214

if server_settings["restore"]:

2564

3215

try:

2565

3216

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

2566

clients_data, old_client_settings = (pickle.load

2567

(stored_state))

3217

if sys.version_info.major == 2:

3218

clients_data, old_client_settings = pickle.load(

3219

stored_state)

3220

else:

3221

bytes_clients_data, bytes_old_client_settings = (

3222

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

3223

# Fix bytes to strings

3224

# clients_data

3225

# .keys()

3226

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

3227

if isinstance(key, bytes)

3228

else key): value

3229

for key, value in

3230

bytes_clients_data.items()}

3231

del bytes_clients_data

3232

for key in clients_data:

3233

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

3234

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

3235

for k, v in

3236

clients_data[key].items()}

3237

clients_data[key] = value

3238

# .client_structure

3239

value["client_structure"] = [

3240

(s.decode("utf-8")

3241

if isinstance(s, bytes)

3242

else s) for s in

3243

value["client_structure"]]

3244

# .name & .host

3245

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

3246

if isinstance(value[k], bytes):

3247

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

3248

if "key_id" not in value:

3249

value["key_id"] = ""

3250

elif "fingerprint" not in value:

3251

value["fingerprint"] = ""

3252

# old_client_settings

3253

# .keys()

3254

old_client_settings = {

3255

(key.decode("utf-8")

3256

if isinstance(key, bytes)

3257

else key): value

3258

for key, value in

3259

bytes_old_client_settings.items()}

3260

del bytes_old_client_settings

3261

# .host

3262

for value in old_client_settings.values():

3263

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

3264

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

3265

.decode("utf-8"))

2568

3266

os.remove(stored_state_path)

2569

3267

except IOError as e:

2570

3268

if e.errno == errno.ENOENT:

2571

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

2572

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

3269

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

3270

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

2573

3271

else:

2574

3272

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

2575

3273

exc_info=e)

2576

3274

raise

2577

3275

except EOFError as e:

2578

3276

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

2579

"EOFError:", exc_info=e)

2580

3277

"EOFError:",

3278

exc_info=e)

3279

2581

3280

with PGPEngine() as pgp:

2582

for client_name, client in clients_data.iteritems():

3281

for client_name, client in clients_data.items():

2583

3282

# Skip removed clients

2584

3283

if client_name not in client_settings:

2585

3284

continue

2586

3285

2587

3286

# Decide which value to use after restoring saved state.

2588

3287

# We have three different values: Old config file,

2589

3288

# new config file, and saved state.

2594

3293

# For each value in new config, check if it

2595

3294

# differs from the old config value (Except for

2596

3295

# the "secret" attribute)

2597

if (name != "secret" and

2598

value != old_client_settings[client_name]

2599

[name]):

3296

if (name != "secret"

3297

and (value !=

3298

old_client_settings[client_name][name])):

2600

3299

client[name] = value

2601

3300

except KeyError:

2602

3301

pass

2603

3302

2604

3303

# Clients who has passed its expire date can still be

2605

# enabled if its last checker was successful. Clients

3304

# enabled if its last checker was successful. A Client

2606

3305

# whose checker succeeded before we stored its state is

2607

3306

# assumed to have successfully run all checkers during

2608

3307

# downtime.

2610

3309

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

2611

3310

if not client["last_checked_ok"]:

2612

3311

logger.warning(

2613

"disabling client {0} - Client never "

2614

"performed a successful checker"

2615

.format(client_name))

3312

"disabling client {} - Client never "

3313

"performed a successful checker".format(

3314

client_name))

2616

3315

client["enabled"] = False

2617

3316

elif client["last_checker_status"] != 0:

2618

3317

logger.warning(

2619

"disabling client {0} - Client "

2620

"last checker failed with error code {1}"

2621

.format(client_name,

2622

client["last_checker_status"]))

3318

"disabling client {} - Client last"

3319

" checker failed with error code"

3320

" {}".format(

3321

client_name,

3322

client["last_checker_status"]))

2623

3323

client["enabled"] = False

2624

3324

else:

2625

client["expires"] = (datetime.datetime

2626

.utcnow()

2627

+ client["timeout"])

3325

client["expires"] = (

3326

datetime.datetime.utcnow()

3327

+ client["timeout"])

2628

3328

logger.debug("Last checker succeeded,"

2629

" keeping {0} enabled"

2630

.format(client_name))

3329

" keeping {} enabled".format(

3330

client_name))

2631

3331

try:

2632

client["secret"] = (

2633

pgp.decrypt(client["encrypted_secret"],

2634

client_settings[client_name]

2635

["secret"]))

3332

client["secret"] = pgp.decrypt(

3333

client["encrypted_secret"],

3334

client_settings[client_name]["secret"])

2636

3335

except PGPError:

2637

3336

# If decryption fails, we use secret from new settings

2638

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

2639

.format(client_name))

2640

client["secret"] = (

2641

client_settings[client_name]["secret"])

2642

3337

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

3338

client_name))

3339

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

3340

["secret"])

3341

2643

3342

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

2644

3343

for client_name in (set(old_client_settings)

2645

3344

- set(client_settings)):

2647

3346

for client_name in (set(client_settings)

2648

3347

- set(old_client_settings)):

2649

3348

clients_data[client_name] = client_settings[client_name]

2650

3349

2651

3350

# Create all client objects

2652

for client_name, client in clients_data.iteritems():

3351

for client_name, client in clients_data.items():

2653

3352

tcp_server.clients[client_name] = client_class(

2654

name = client_name, settings = client,

2655

server_settings = server_settings)

2656

3353

name=client_name,

3354

settings=client,

3355

server_settings=server_settings)

3356

2657

3357

if not tcp_server.clients:

2658

3358

logger.warning("No clients defined")

2659

3359

2660

3360

if not foreground:

2661

3361

if pidfile is not None:

3362

pid = os.getpid()

2662

3363

try:

2663

3364

with pidfile:

2664

pid = os.getpid()

2665

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

3365

print(pid, file=pidfile)

2666

3366

except IOError:

2667

3367

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

2668

3368

pidfilename, pid)

2669

3369

del pidfile

2670

3370

del pidfilename

2671

2672

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

2673

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

2674

3371

3372

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

3373

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3374

lambda: main_loop.quit() and False)

3375

2675

3376

if use_dbus:

2676

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

2677

"se.bsnet.fukt.Mandos"})

2678

class MandosDBusService(DBusObjectWithProperties):

3377

3378

@alternate_dbus_interfaces(

3379

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

3380

class MandosDBusService(DBusObjectWithObjectManager):

2679

3381

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

3382

2680

3383

def __init__(self):

2681

3384

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

3385

2682

3386

_interface = "se.recompile.Mandos"

2683

2684

@dbus_interface_annotations(_interface)

2685

def _foo(self):

2686

return { "org.freedesktop.DBus.Property"

2687

".EmitsChangedSignal":

2688

"false"}

2689

3387

2690

3388

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

2691

3389

def ClientAdded(self, objpath):

2692

3390

"D-Bus signal"

2693

3391

pass

2694

3392

2695

3393

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

2696

def ClientNotFound(self, fingerprint, address):

3394

def ClientNotFound(self, key_id, address):

2697

3395

"D-Bus signal"

2698

3396

pass

2699

3397

3398

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

3399

"true"})

2700

3400

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

2701

3401

def ClientRemoved(self, objpath, name):

2702

3402

"D-Bus signal"

2703

3403

pass

2704

3404

3405

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

3406

"true"})

2705

3407

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

2706

3408

def GetAllClients(self):

2707

3409

"D-Bus method"

2708

return dbus.Array(c.dbus_object_path

2709

for c in

2710

tcp_server.clients.itervalues())

2711

3410

return dbus.Array(c.dbus_object_path for c in

3411

tcp_server.clients.values())

3412

3413

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

3414

"true"})

2712

3415

@dbus.service.method(_interface,

2713

3416

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

2714

3417

def GetAllClientsWithProperties(self):

2715

3418

"D-Bus method"

2716

3419

return dbus.Dictionary(

2717

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

2718

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

3420

{c.dbus_object_path: c.GetAll(

3421

"se.recompile.Mandos.Client")

3422

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

2719

3423

signature="oa{sv}")

2720

3424

2721

3425

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

2722

3426

def RemoveClient(self, object_path):

2723

3427

"D-Bus method"

2724

for c in tcp_server.clients.itervalues():

3428

for c in tcp_server.clients.values():

2725

3429

if c.dbus_object_path == object_path:

2726

3430

del tcp_server.clients[c.name]

2727

3431

c.remove_from_connection()

2728

# Don't signal anything except ClientRemoved

3432

# Don't signal the disabling

2729

3433

c.disable(quiet=True)

2730

# Emit D-Bus signal

2731

self.ClientRemoved(object_path, c.name)

3434

# Emit D-Bus signal for removal

3435

self.client_removed_signal(c)

2732

3436

return

2733

3437

raise KeyError(object_path)

2734

3438

2735

3439

del _interface

2736

3440

3441

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3442

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

3443

def GetManagedObjects(self):

3444

"""D-Bus method"""

3445

return dbus.Dictionary(

3446

{client.dbus_object_path:

3447

dbus.Dictionary(

3448

{interface: client.GetAll(interface)

3449

for interface in

3450

client._get_all_interface_names()})

3451

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

3452

3453

def client_added_signal(self, client):

3454

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

3455

if use_dbus:

3456

# New standard signal

3457

self.InterfacesAdded(

3458

client.dbus_object_path,

3459

dbus.Dictionary(

3460

{interface: client.GetAll(interface)

3461

for interface in

3462

client._get_all_interface_names()}))

3463

# Old signal

3464

self.ClientAdded(client.dbus_object_path)

3465

3466

def client_removed_signal(self, client):

3467

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

3468

if use_dbus:

3469

# New standard signal

3470

self.InterfacesRemoved(

3471

client.dbus_object_path,

3472

client._get_all_interface_names())

3473

# Old signal

3474

self.ClientRemoved(client.dbus_object_path,

3475

client.name)

3476

2737

3477

mandos_dbus_service = MandosDBusService()

2738

3478

3479

# Save modules to variables to exempt the modules from being

3480

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

3481

mp = multiprocessing

3482

wn = wnull

3483

2739

3484

def cleanup():

2740

3485

"Cleanup function; run on exit"

2741

service.cleanup()

2742

2743

multiprocessing.active_children()

2744

wnull.close()

3486

if zeroconf:

3487

service.cleanup()

3488

3489

mp.active_children()

3490

wn.close()

2745

3491

if not (tcp_server.clients or client_settings):

2746

3492

return

2747

3493

2748

3494

# Store client before exiting. Secrets are encrypted with key

2749

3495

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

2750

3496

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

2751

3497

clients = {}

2752

3498

with PGPEngine() as pgp:

2753

for client in tcp_server.clients.itervalues():

3499

for client in tcp_server.clients.values():

2754

3500

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

2755

3501

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

2756

3502

key)

2757

3503

client_dict = {}

2758

3504

2759

3505

# A list of attributes that can not be pickled

2760

3506

# + secret.

2761

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

2762

"checker", "server_settings"))

2763

for name, typ in (inspect.getmembers

2764

(dbus.service.Object)):

3507

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

3508

"checker", "server_settings"}

3509

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

3510

.Object):

2765

3511

exclude.add(name)

2766

3512

2767

3513

client_dict["encrypted_secret"] = (client

2768

3514

.encrypted_secret)

2769

3515

for attr in client.client_structure:

2770

3516

if attr not in exclude:

2771

3517

client_dict[attr] = getattr(client, attr)

2772

3518

2773

3519

clients[client.name] = client_dict

2774

3520

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

2775

3521

2776

3522

try:

2777

with (tempfile.NamedTemporaryFile

2778

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

2779

dir=os.path.dirname(stored_state_path),

2780

delete=False)) as stored_state:

2781

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

2782

tempname=stored_state.name

3523

with tempfile.NamedTemporaryFile(

3524

mode='wb',

3525

suffix=".pickle",

3526

prefix='clients-',

3527

dir=os.path.dirname(stored_state_path),

3528

delete=False) as stored_state:

3529

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

3530

protocol=2)

3531

tempname = stored_state.name

2783

3532

os.rename(tempname, stored_state_path)

2784

3533

except (IOError, OSError) as e:

2785

3534

if not debug:

2788

3537

except NameError:

2789

3538

pass

2790

3539

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

2791

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

3540

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

2792

3541

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

2793

3542

else:

2794

3543

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

2795

3544

exc_info=e)

2796

3545

raise

2797

3546

2798

3547

# Delete all clients, and settings from config

2799

3548

while tcp_server.clients:

2800

3549

name, client = tcp_server.clients.popitem()

2801

3550

if use_dbus:

2802

3551

client.remove_from_connection()

2803

# Don't signal anything except ClientRemoved

3552

# Don't signal the disabling

2804

3553

client.disable(quiet=True)

3554

# Emit D-Bus signal for removal

2805

3555

if use_dbus:

2806

# Emit D-Bus signal

2807

mandos_dbus_service.ClientRemoved(client

2808

.dbus_object_path,

2809

client.name)

3556

mandos_dbus_service.client_removed_signal(client)

2810

3557

client_settings.clear()

2811

3558

2812

3559

atexit.register(cleanup)

2813

2814

for client in tcp_server.clients.itervalues():

3560

3561

for client in tcp_server.clients.values():

2815

3562

if use_dbus:

2816

# Emit D-Bus signal

2817

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3563

# Emit D-Bus signal for adding

3564

mandos_dbus_service.client_added_signal(client)

2818

3565

# Need to initiate checking of clients

2819

3566

if client.enabled:

2820

3567

client.init_checker()

2821

3568

2822

3569

tcp_server.enable()

2823

3570

tcp_server.server_activate()

2824

3571

2825

3572

# Find out what port we got

2826

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

3573

if zeroconf:

3574

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

2827

3575

if use_ipv6:

2828

3576

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

2829

3577

" flowinfo %d, scope_id %d",

2831

3579

else: # IPv4

2832

3580

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

2833

3581

*tcp_server.socket.getsockname())

2834

2835

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

2836

3582

3583

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

3584

2837

3585

try:

2838

# From the Avahi example code

2839

try:

2840

service.activate()

2841

except dbus.exceptions.DBusException as error:

2842

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

2843

cleanup()

2844

sys.exit(1)

2845

# End of Avahi example code

2846

2847

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

2848

lambda *args, **kwargs:

2849

(tcp_server.handle_request

2850

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

2851

3586

if zeroconf:

3587

# From the Avahi example code

3588

try:

3589

service.activate()

3590

except dbus.exceptions.DBusException as error:

3591

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

3592

cleanup()

3593

sys.exit(1)

3594

# End of Avahi example code

3595

3596

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

3597

lambda *args, **kwargs:

3598

(tcp_server.handle_request

3599

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

3600

2852

3601

logger.debug("Starting main loop")

2853

3602

main_loop.run()

2854

3603

except AvahiError as error:

2863

3612

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

2864

3613

cleanup()

2865

3614

3615

2866

3616

if __name__ == '__main__':

2867

3617

main()