/mandos/release : revision 237.7.178

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

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

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

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

72

81

73

import dbus

82

74

import dbus.service

83

import gi

84

from gi.repository import GLib

75

import gobject

76

import avahi

85

77

from dbus.mainloop.glib import DBusGMainLoop

86

78

import ctypes

87

79

import ctypes.util

88

80

import xml.dom.minidom

89

81

import inspect

90

82

91

# Try to find the value of SO_BINDTODEVICE:

92

83

try:

93

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

94

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

95

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

96

85

except AttributeError:

97

86

try:

98

# This is where SO_BINDTODEVICE was up to and including Python

99

# 2.6, and also 3.2:

100

87

from IN import SO_BINDTODEVICE

101

88

except ImportError:

102

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

103

# Try running the C preprocessor:

104

try:

105

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

106

"/dev/stdin"],

107

stdin=subprocess.PIPE,

108

stdout=subprocess.PIPE)

109

stdout = cc.communicate(

110

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

111

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

112

except (OSError, ValueError, IndexError):

113

# No value found

114

SO_BINDTODEVICE = None

115

116

if sys.version_info.major == 2:

117

str = unicode

118

119

if sys.version_info < (3, 2):

120

configparser.Configparser = configparser.SafeConfigParser

121

122

version = "1.8.7"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.1"

123

92

stored_state_file = "clients.pickle"

124

93

125

94

logger = logging.getLogger()

126

syslogger = None

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

127

98

128

99

try:

129

if_nametoindex = ctypes.cdll.LoadLibrary(

130

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

131

103

except (OSError, AttributeError):

132

133

104

def if_nametoindex(interface):

134

105

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

135

106

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

136

107

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

137

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

138

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

139

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

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

140

113

return interface_index

141

114

142

115

143

def copy_function(func):

144

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

145

if sys.version_info.major == 2:

146

return types.FunctionType(func.func_code,

147

func.func_globals,

148

func.func_name,

149

func.func_defaults,

150

func.func_closure)

151

else:

152

return types.FunctionType(func.__code__,

153

func.__globals__,

154

func.__name__,

155

func.__defaults__,

156

func.__closure__)

157

158

159

116

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

160

117

"""init logger and add loglevel"""

161

162

global syslogger

163

syslogger = (logging.handlers.SysLogHandler(

164

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

165

address="/dev/log"))

118

166

119

syslogger.setFormatter(logging.Formatter

167

120

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

168

121

' %(message)s'))

169

122

logger.addHandler(syslogger)

170

123

171

124

if debug:

172

125

console = logging.StreamHandler()

173

126

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

185

138

186

139

class PGPEngine(object):

187

140

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

188

189

141

def __init__(self):

190

142

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

191

self.gpg = "gpg"

192

try:

193

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

194

for line in output.splitlines():

195

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

196

if name == "gpg":

197

self.gpg = path

198

break

199

except OSError as e:

200

if e.errno != errno.ENOENT:

201

raise

202

143

self.gnupgargs = ['--batch',

203

'--homedir', self.tempdir,

144

'--home', self.tempdir,

204

145

'--force-mdc',

205

'--quiet']

206

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

207

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

208

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

209

146

'--quiet',

147

'--no-use-agent']

148

210

149

def __enter__(self):

211

150

return self

212

151

213

152

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

214

153

self._cleanup()

215

154

return False

216

155

217

156

def __del__(self):

218

157

self._cleanup()

219

158

220

159

def _cleanup(self):

221

160

if self.tempdir is not None:

222

161

# Delete contents of tempdir

223

162

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

224

topdown=False):

163

topdown = False):

225

164

for filename in files:

226

165

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

227

166

for dirname in dirs:

229

168

# Remove tempdir

230

169

os.rmdir(self.tempdir)

231

170

self.tempdir = None

232

171

233

172

def password_encode(self, password):

234

173

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

235

174

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

240

179

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

241

180

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

242

181

return encoded

243

182

244

183

def encrypt(self, data, password):

245

184

passphrase = self.password_encode(password)

246

with tempfile.NamedTemporaryFile(

247

dir=self.tempdir) as passfile:

185

with tempfile.NamedTemporaryFile(dir=self.tempdir

186

) as passfile:

248

187

passfile.write(passphrase)

249

188

passfile.flush()

250

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

189

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

251

190

'--passphrase-file',

252

191

passfile.name]

253

192

+ self.gnupgargs,

254

stdin=subprocess.PIPE,

255

stdout=subprocess.PIPE,

256

stderr=subprocess.PIPE)

257

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

193

stdin = subprocess.PIPE,

194

stdout = subprocess.PIPE,

195

stderr = subprocess.PIPE)

196

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

258

197

if proc.returncode != 0:

259

198

raise PGPError(err)

260

199

return ciphertext

261

200

262

201

def decrypt(self, data, password):

263

202

passphrase = self.password_encode(password)

264

with tempfile.NamedTemporaryFile(

265

dir=self.tempdir) as passfile:

203

with tempfile.NamedTemporaryFile(dir = self.tempdir

204

) as passfile:

266

205

passfile.write(passphrase)

267

206

passfile.flush()

268

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

207

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

269

208

'--passphrase-file',

270

209

passfile.name]

271

210

+ self.gnupgargs,

272

stdin=subprocess.PIPE,

273

stdout=subprocess.PIPE,

274

stderr=subprocess.PIPE)

275

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

211

stdin = subprocess.PIPE,

212

stdout = subprocess.PIPE,

213

stderr = subprocess.PIPE)

214

decrypted_plaintext, err = proc.communicate(input

215

= data)

276

216

if proc.returncode != 0:

277

217

raise PGPError(err)

278

218

return decrypted_plaintext

279

219

280

220

281

# Pretend that we have an Avahi module

282

class avahi(object):

283

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

284

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

285

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

286

PROTO_INET = 0 # avahi-common/address.h

287

PROTO_INET6 = 1 # avahi-common/address.h

288

DBUS_NAME = "org.freedesktop.Avahi"

289

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

290

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

291

DBUS_PATH_SERVER = "/"

292

293

@staticmethod

294

def string_array_to_txt_array(t):

295

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

296

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

297

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

298

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

299

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

300

SERVER_INVALID = 0 # avahi-common/defs.h

301

SERVER_REGISTERING = 1 # avahi-common/defs.h

302

SERVER_RUNNING = 2 # avahi-common/defs.h

303

SERVER_COLLISION = 3 # avahi-common/defs.h

304

SERVER_FAILURE = 4 # avahi-common/defs.h

305

306

307

221

class AvahiError(Exception):

308

222

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

309

223

self.value = value

310

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

311

**kwargs)

312

224

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

225

def __unicode__(self):

226

return unicode(repr(self.value))

313

227

314

228

class AvahiServiceError(AvahiError):

315

229

pass

316

230

317

318

231

class AvahiGroupError(AvahiError):

319

232

pass

320

233

321

234

322

235

class AvahiService(object):

323

236

"""An Avahi (Zeroconf) service.

324

237

325

238

Attributes:

326

239

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

327

240

Used to optionally bind to the specified interface.

339

252

server: D-Bus Server

340

253

bus: dbus.SystemBus()

341

254

"""

342

343

def __init__(self,

344

interface=avahi.IF_UNSPEC,

345

name=None,

346

servicetype=None,

347

port=None,

348

TXT=None,

349

domain="",

350

host="",

351

max_renames=32768,

352

protocol=avahi.PROTO_UNSPEC,

353

bus=None):

255

256

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

257

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

258

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

259

protocol = avahi.PROTO_UNSPEC, bus = None):

354

260

self.interface = interface

355

261

self.name = name

356

262

self.type = servicetype

365

271

self.server = None

366

272

self.bus = bus

367

273

self.entry_group_state_changed_match = None

368

369

def rename(self, remove=True):

274

275

def rename(self):

370

276

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

371

277

if self.rename_count >= self.max_renames:

372

278

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

373

279

" after %i retries, exiting.",

374

280

self.rename_count)

375

281

raise AvahiServiceError("Too many renames")

376

self.name = str(

377

self.server.GetAlternativeServiceName(self.name))

378

self.rename_count += 1

282

self.name = unicode(self.server

283

.GetAlternativeServiceName(self.name))

379

284

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

380

285

self.name)

381

if remove:

382

self.remove()

286

self.remove()

383

287

try:

384

288

self.add()

385

289

except dbus.exceptions.DBusException as error:

386

if (error.get_dbus_name()

387

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

388

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

389

return self.rename(remove=False)

390

else:

391

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

392

self.cleanup()

393

os._exit(1)

394

290

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

291

self.cleanup()

292

os._exit(1)

293

self.rename_count += 1

294

395

295

def remove(self):

396

296

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

397

297

if self.entry_group_state_changed_match is not None:

399

299

self.entry_group_state_changed_match = None

400

300

if self.group is not None:

401

301

self.group.Reset()

402

302

403

303

def add(self):

404

304

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

405

305

self.remove()

422

322

dbus.UInt16(self.port),

423

323

avahi.string_array_to_txt_array(self.TXT))

424

324

self.group.Commit()

425

325

426

326

def entry_group_state_changed(self, state, error):

427

327

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

428

328

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

429

329

430

330

if state == avahi.ENTRY_GROUP_ESTABLISHED:

431

331

logger.debug("Zeroconf service established.")

432

332

elif state == avahi.ENTRY_GROUP_COLLISION:

434

334

self.rename()

435

335

elif state == avahi.ENTRY_GROUP_FAILURE:

436

336

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

437

str(error))

438

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

439

337

unicode(error))

338

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

339

.format(error))

340

440

341

def cleanup(self):

441

342

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

442

343

if self.group is not None:

447

348

pass

448

349

self.group = None

449

350

self.remove()

450

351

451

352

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

452

353

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

453

354

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

454

bad_states = {

455

avahi.SERVER_INVALID: "Zeroconf server invalid",

456

avahi.SERVER_REGISTERING: None,

457

avahi.SERVER_COLLISION: "Zeroconf server name collision",

458

avahi.SERVER_FAILURE: "Zeroconf server failure",

459

}

355

bad_states = { avahi.SERVER_INVALID:

356

"Zeroconf server invalid",

357

avahi.SERVER_REGISTERING: None,

358

avahi.SERVER_COLLISION:

359

"Zeroconf server name collision",

360

avahi.SERVER_FAILURE:

361

"Zeroconf server failure" }

460

362

if state in bad_states:

461

363

if bad_states[state] is not None:

462

364

if error is None:

465

367

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

466

368

self.cleanup()

467

369

elif state == avahi.SERVER_RUNNING:

468

try:

469

self.add()

470

except dbus.exceptions.DBusException as error:

471

if (error.get_dbus_name()

472

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

473

logger.info("Local Zeroconf service name"

474

" collision.")

475

return self.rename(remove=False)

476

else:

477

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

478

self.cleanup()

479

os._exit(1)

370

self.add()

480

371

else:

481

372

if error is None:

482

373

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

483

374

else:

484

375

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

485

376

486

377

def activate(self):

487

378

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

488

379

if self.server is None:

492

383

follow_name_owner_changes=True),

493

384

avahi.DBUS_INTERFACE_SERVER)

494

385

self.server.connect_to_signal("StateChanged",

495

self.server_state_changed)

386

self.server_state_changed)

496

387

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

497

388

498

389

499

390

class AvahiServiceToSyslog(AvahiService):

500

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

391

def rename(self):

501

392

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

502

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

503

syslogger.setFormatter(logging.Formatter(

504

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

505

.format(self.name)))

393

ret = AvahiService.rename(self)

394

syslogger.setFormatter(logging.Formatter

395

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

396

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

397

.format(self.name)))

506

398

return ret

507

399

508

400

509

# Pretend that we have a GnuTLS module

510

class gnutls(object):

511

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

512

513

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

514

if library is None:

515

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

516

_library = ctypes.cdll.LoadLibrary(library)

517

del library

518

519

# Unless otherwise indicated, the constants and types below are

520

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

521

522

# Constants

523

E_SUCCESS = 0

524

E_INTERRUPTED = -52

525

E_AGAIN = -28

526

CRT_OPENPGP = 2

527

CRT_RAWPK = 3

528

CLIENT = 2

529

SHUT_RDWR = 0

530

CRD_CERTIFICATE = 1

531

E_NO_CERTIFICATE_FOUND = -49

532

X509_FMT_DER = 0

533

NO_TICKETS = 1<<10

534

ENABLE_RAWPK = 1<<18

535

CTYPE_PEERS = 3

536

KEYID_USE_SHA256 = 1 # gnutls/x509.h

537

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

538

539

# Types

540

class session_int(ctypes.Structure):

541

_fields_ = []

542

session_t = ctypes.POINTER(session_int)

543

544

class certificate_credentials_st(ctypes.Structure):

545

_fields_ = []

546

certificate_credentials_t = ctypes.POINTER(

547

certificate_credentials_st)

548

certificate_type_t = ctypes.c_int

549

550

class datum_t(ctypes.Structure):

551

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

552

('size', ctypes.c_uint)]

553

554

class openpgp_crt_int(ctypes.Structure):

555

_fields_ = []

556

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

557

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

558

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

559

credentials_type_t = ctypes.c_int

560

transport_ptr_t = ctypes.c_void_p

561

close_request_t = ctypes.c_int

562

563

# Exceptions

564

class Error(Exception):

565

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

566

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

567

# code is passed, convert it to a string with

568

# gnutls.strerror()

569

self.code = code

570

if message is None and code is not None:

571

message = gnutls.strerror(code)

572

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

573

message, *args)

574

575

class CertificateSecurityError(Error):

576

pass

577

578

# Classes

579

class Credentials(object):

580

def __init__(self):

581

self._c_object = gnutls.certificate_credentials_t()

582

gnutls.certificate_allocate_credentials(

583

ctypes.byref(self._c_object))

584

self.type = gnutls.CRD_CERTIFICATE

585

586

def __del__(self):

587

gnutls.certificate_free_credentials(self._c_object)

588

589

class ClientSession(object):

590

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

591

self._c_object = gnutls.session_t()

592

gnutls_flags = gnutls.CLIENT

593

if gnutls.check_version(b"3.5.6"):

594

gnutls_flags |= gnutls.NO_TICKETS

595

if gnutls.has_rawpk:

596

gnutls_flags |= gnutls.ENABLE_RAWPK

597

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

598

del gnutls_flags

599

gnutls.set_default_priority(self._c_object)

600

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

601

gnutls.handshake_set_private_extensions(self._c_object,

602

True)

603

self.socket = socket

604

if credentials is None:

605

credentials = gnutls.Credentials()

606

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

607

ctypes.cast(credentials._c_object,

608

ctypes.c_void_p))

609

self.credentials = credentials

610

611

def __del__(self):

612

gnutls.deinit(self._c_object)

613

614

def handshake(self):

615

return gnutls.handshake(self._c_object)

616

617

def send(self, data):

618

data = bytes(data)

619

data_len = len(data)

620

while data_len > 0:

621

data_len -= gnutls.record_send(self._c_object,

622

data[-data_len:],

623

data_len)

624

625

def bye(self):

626

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

627

628

# Error handling functions

629

def _error_code(result):

630

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

631

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

632

if result >= 0:

633

return result

634

if result == gnutls.E_NO_CERTIFICATE_FOUND:

635

raise gnutls.CertificateSecurityError(code=result)

636

raise gnutls.Error(code=result)

637

638

def _retry_on_error(result, func, arguments):

639

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

640

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

641

while result < 0:

642

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

643

return _error_code(result)

644

result = func(*arguments)

645

return result

646

647

# Unless otherwise indicated, the function declarations below are

648

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

649

650

# Functions

651

priority_set_direct = _library.gnutls_priority_set_direct

652

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

653

ctypes.POINTER(ctypes.c_char_p)]

654

priority_set_direct.restype = _error_code

655

656

init = _library.gnutls_init

657

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

658

init.restype = _error_code

659

660

set_default_priority = _library.gnutls_set_default_priority

661

set_default_priority.argtypes = [session_t]

662

set_default_priority.restype = _error_code

663

664

record_send = _library.gnutls_record_send

665

record_send.argtypes = [session_t, ctypes.c_void_p,

666

ctypes.c_size_t]

667

record_send.restype = ctypes.c_ssize_t

668

record_send.errcheck = _retry_on_error

669

670

certificate_allocate_credentials = (

671

_library.gnutls_certificate_allocate_credentials)

672

certificate_allocate_credentials.argtypes = [

673

ctypes.POINTER(certificate_credentials_t)]

674

certificate_allocate_credentials.restype = _error_code

675

676

certificate_free_credentials = (

677

_library.gnutls_certificate_free_credentials)

678

certificate_free_credentials.argtypes = [

679

certificate_credentials_t]

680

certificate_free_credentials.restype = None

681

682

handshake_set_private_extensions = (

683

_library.gnutls_handshake_set_private_extensions)

684

handshake_set_private_extensions.argtypes = [session_t,

685

ctypes.c_int]

686

handshake_set_private_extensions.restype = None

687

688

credentials_set = _library.gnutls_credentials_set

689

credentials_set.argtypes = [session_t, credentials_type_t,

690

ctypes.c_void_p]

691

credentials_set.restype = _error_code

692

693

strerror = _library.gnutls_strerror

694

strerror.argtypes = [ctypes.c_int]

695

strerror.restype = ctypes.c_char_p

696

697

certificate_type_get = _library.gnutls_certificate_type_get

698

certificate_type_get.argtypes = [session_t]

699

certificate_type_get.restype = _error_code

700

701

certificate_get_peers = _library.gnutls_certificate_get_peers

702

certificate_get_peers.argtypes = [session_t,

703

ctypes.POINTER(ctypes.c_uint)]

704

certificate_get_peers.restype = ctypes.POINTER(datum_t)

705

706

global_set_log_level = _library.gnutls_global_set_log_level

707

global_set_log_level.argtypes = [ctypes.c_int]

708

global_set_log_level.restype = None

709

710

global_set_log_function = _library.gnutls_global_set_log_function

711

global_set_log_function.argtypes = [log_func]

712

global_set_log_function.restype = None

713

714

deinit = _library.gnutls_deinit

715

deinit.argtypes = [session_t]

716

deinit.restype = None

717

718

handshake = _library.gnutls_handshake

719

handshake.argtypes = [session_t]

720

handshake.restype = _error_code

721

handshake.errcheck = _retry_on_error

722

723

transport_set_ptr = _library.gnutls_transport_set_ptr

724

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

725

transport_set_ptr.restype = None

726

727

bye = _library.gnutls_bye

728

bye.argtypes = [session_t, close_request_t]

729

bye.restype = _error_code

730

bye.errcheck = _retry_on_error

731

732

check_version = _library.gnutls_check_version

733

check_version.argtypes = [ctypes.c_char_p]

734

check_version.restype = ctypes.c_char_p

735

736

_need_version = b"3.3.0"

737

if check_version(_need_version) is None:

738

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

739

.format(_need_version))

740

741

_tls_rawpk_version = b"3.6.6"

742

has_rawpk = bool(check_version(_tls_rawpk_version))

743

744

if has_rawpk:

745

# Types

746

class pubkey_st(ctypes.Structure):

747

_fields = []

748

pubkey_t = ctypes.POINTER(pubkey_st)

749

750

x509_crt_fmt_t = ctypes.c_int

751

752

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

753

pubkey_init = _library.gnutls_pubkey_init

754

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

755

pubkey_init.restype = _error_code

756

757

pubkey_import = _library.gnutls_pubkey_import

758

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

759

x509_crt_fmt_t]

760

pubkey_import.restype = _error_code

761

762

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

763

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

764

ctypes.POINTER(ctypes.c_ubyte),

765

ctypes.POINTER(ctypes.c_size_t)]

766

pubkey_get_key_id.restype = _error_code

767

768

pubkey_deinit = _library.gnutls_pubkey_deinit

769

pubkey_deinit.argtypes = [pubkey_t]

770

pubkey_deinit.restype = None

771

else:

772

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

773

774

openpgp_crt_init = _library.gnutls_openpgp_crt_init

775

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

776

openpgp_crt_init.restype = _error_code

777

778

openpgp_crt_import = _library.gnutls_openpgp_crt_import

779

openpgp_crt_import.argtypes = [openpgp_crt_t,

780

ctypes.POINTER(datum_t),

781

openpgp_crt_fmt_t]

782

openpgp_crt_import.restype = _error_code

783

784

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

785

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

786

ctypes.POINTER(ctypes.c_uint)]

787

openpgp_crt_verify_self.restype = _error_code

788

789

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

790

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

791

openpgp_crt_deinit.restype = None

792

793

openpgp_crt_get_fingerprint = (

794

_library.gnutls_openpgp_crt_get_fingerprint)

795

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

796

ctypes.c_void_p,

797

ctypes.POINTER(

798

ctypes.c_size_t)]

799

openpgp_crt_get_fingerprint.restype = _error_code

800

801

if check_version(b"3.6.4"):

802

certificate_type_get2 = _library.gnutls_certificate_type_get2

803

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

804

certificate_type_get2.restype = _error_code

805

806

# Remove non-public functions

807

del _error_code, _retry_on_error

808

809

810

def call_pipe(connection, # : multiprocessing.Connection

811

func, *args, **kwargs):

812

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

813

814

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

815

return value on the provided multiprocessing.Connection.

816

"""

817

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

818

connection.close()

401

def timedelta_to_milliseconds(td):

402

"Convert a datetime.timedelta() to milliseconds"

403

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

404

+ (td.seconds * 1000)

405

+ (td.microseconds // 1000))

819

406

820

407

821

408

class Client(object):

822

409

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

823

410

824

411

Attributes:

825

412

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

826

413

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

827

414

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

828

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

829

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

830

running.

831

checker_callback_tag: a GLib event source tag, or None

415

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

416

to see if the client lives.

417

'None' if no process is running.

418

checker_callback_tag: a gobject event source tag, or None

832

419

checker_command: string; External command which is run to check

833

420

if client lives. %() expansions are done at

834

421

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

835

422

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

836

checker_initiator_tag: a GLib event source tag, or None

423

checker_initiator_tag: a gobject event source tag, or None

837

424

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

838

425

client_structure: Object describing what attributes a client has

839

426

and is used for storing the client at exit

840

427

current_checker_command: string; current running checker_command

841

disable_initiator_tag: a GLib event source tag, or None

428

disable_initiator_tag: a gobject event source tag, or None

842

429

enabled: bool()

843

430

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

844

uniquely identify an OpenPGP client

845

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

846

a client using raw public keys

431

uniquely identify the client

847

432

host: string; available for use by the checker command

848

433

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

849

434

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

851

436

last_checker_status: integer between 0 and 255 reflecting exit

852

437

status of last checker. -1 reflects crashed

853

438

checker, -2 means no checker completed yet.

854

last_checker_signal: The signal which killed the last checker, if

855

last_checker_status is -1

856

439

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

857

440

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

858

441

D-Bus identifiers

865

448

disabled, or None

866

449

server_settings: The server_settings dict from main()

867

450

"""

868

451

869

452

runtime_expansions = ("approval_delay", "approval_duration",

870

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

453

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

871

454

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

872

455

"last_approval_request", "last_checked_ok",

873

456

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

874

client_defaults = {

875

"timeout": "PT5M",

876

"extended_timeout": "PT15M",

877

"interval": "PT2M",

878

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

879

"host": "",

880

"approval_delay": "PT0S",

881

"approval_duration": "PT1S",

882

"approved_by_default": "True",

883

"enabled": "True",

884

}

885

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

460

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

461

"host": "",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

464

"approved_by_default": "True",

465

"enabled": "True",

466

}

467

468

def timeout_milliseconds(self):

469

"Return the 'timeout' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.timeout)

471

472

def extended_timeout_milliseconds(self):

473

"Return the 'extended_timeout' attribute in milliseconds"

474

return timedelta_to_milliseconds(self.extended_timeout)

475

476

def interval_milliseconds(self):

477

"Return the 'interval' attribute in milliseconds"

478

return timedelta_to_milliseconds(self.interval)

479

480

def approval_delay_milliseconds(self):

481

return timedelta_to_milliseconds(self.approval_delay)

482

886

483

@staticmethod

887

484

def config_parser(config):

888

485

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

895

492

for client_name in config.sections():

896

493

section = dict(config.items(client_name))

897

494

client = settings[client_name] = {}

898

495

899

496

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

900

497

# Reformat values from string types to Python types

901

498

client["approved_by_default"] = config.getboolean(

902

499

client_name, "approved_by_default")

903

500

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

904

501

"enabled")

905

906

# Uppercase and remove spaces from key_id and fingerprint

907

# for later comparison purposes with return value from the

908

# key_id() and fingerprint() functions

909

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

910

.replace(" ", ""))

502

911

503

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

912

504

.replace(" ", ""))

913

505

if "secret" in section:

914

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

915

.encode("utf-8"),

916

"base64")

506

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

917

507

elif "secfile" in section:

918

508

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

919

509

(section["secfile"])),

920

510

"rb") as secfile:

921

511

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

922

512

else:

923

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

513

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

924

514

.format(section))

925

515

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

926

516

client["extended_timeout"] = string_to_delta(

934

524

client["last_approval_request"] = None

935

525

client["last_checked_ok"] = None

936

526

client["last_checker_status"] = -2

937

527

938

528

return settings

939

940

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

529

530

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

941

531

self.name = name

942

532

if server_settings is None:

943

533

server_settings = {}

944

534

self.server_settings = server_settings

945

535

# adding all client settings

946

for setting, value in settings.items():

536

for setting, value in settings.iteritems():

947

537

setattr(self, setting, value)

948

538

949

539

if self.enabled:

950

540

if not hasattr(self, "last_enabled"):

951

541

self.last_enabled = datetime.datetime.utcnow()

955

545

else:

956

546

self.last_enabled = None

957

547

self.expires = None

958

548

959

549

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

960

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

550

# Uppercase and remove spaces from fingerprint for later

551

# comparison purposes with return value from the fingerprint()

552

# function

961

553

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

962

554

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

963

555

datetime.datetime.utcnow())

964

556

965

557

# attributes specific for this server instance

966

558

self.checker = None

967

559

self.checker_initiator_tag = None

970

562

self.current_checker_command = None

971

563

self.approved = None

972

564

self.approvals_pending = 0

973

self.changedstate = multiprocessing_manager.Condition(

974

multiprocessing_manager.Lock())

975

self.client_structure = [attr

976

for attr in self.__dict__.keys()

565

self.changedstate = (multiprocessing_manager

566

.Condition(multiprocessing_manager

567

.Lock()))

568

self.client_structure = [attr for attr in

569

self.__dict__.iterkeys()

977

570

if not attr.startswith("_")]

978

571

self.client_structure.append("client_structure")

979

980

for name, t in inspect.getmembers(

981

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

572

573

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

574

lambda obj:

575

isinstance(obj,

576

property)):

982

577

if not name.startswith("_"):

983

578

self.client_structure.append(name)

984

579

985

580

# Send notice to process children that client state has changed

986

581

def send_changedstate(self):

987

582

with self.changedstate:

988

583

self.changedstate.notify_all()

989

584

990

585

def enable(self):

991

586

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

992

587

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

997

592

self.last_enabled = datetime.datetime.utcnow()

998

593

self.init_checker()

999

594

self.send_changedstate()

1000

595

1001

596

def disable(self, quiet=True):

1002

597

"""Disable this client."""

1003

598

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

1005

600

if not quiet:

1006

601

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

1007

602

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

1008

GLib.source_remove(self.disable_initiator_tag)

603

gobject.source_remove(self.disable_initiator_tag)

1009

604

self.disable_initiator_tag = None

1010

605

self.expires = None

1011

606

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

1012

GLib.source_remove(self.checker_initiator_tag)

607

gobject.source_remove(self.checker_initiator_tag)

1013

608

self.checker_initiator_tag = None

1014

609

self.stop_checker()

1015

610

self.enabled = False

1016

611

if not quiet:

1017

612

self.send_changedstate()

1018

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

613

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

1019

614

return False

1020

615

1021

616

def __del__(self):

1022

617

self.disable()

1023

618

1024

619

def init_checker(self):

1025

620

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

1026

621

# and every interval from then on.

1027

622

if self.checker_initiator_tag is not None:

1028

GLib.source_remove(self.checker_initiator_tag)

1029

self.checker_initiator_tag = GLib.timeout_add(

1030

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

1031

self.start_checker)

623

gobject.source_remove(self.checker_initiator_tag)

624

self.checker_initiator_tag = (gobject.timeout_add

625

(self.interval_milliseconds(),

626

self.start_checker))

1032

627

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

1033

628

if self.disable_initiator_tag is not None:

1034

GLib.source_remove(self.disable_initiator_tag)

1035

self.disable_initiator_tag = GLib.timeout_add(

1036

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

629

gobject.source_remove(self.disable_initiator_tag)

630

self.disable_initiator_tag = (gobject.timeout_add

631

(self.timeout_milliseconds(),

632

self.disable))

1037

633

# Also start a new checker *right now*.

1038

634

self.start_checker()

1039

1040

def checker_callback(self, source, condition, connection,

1041

command):

635

636

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

1042

637

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

1043

# Read return code from connection (see call_pipe)

1044

returncode = connection.recv()

1045

connection.close()

1046

self.checker.join()

1047

638

self.checker_callback_tag = None

1048

639

self.checker = None

1049

1050

if returncode >= 0:

1051

self.last_checker_status = returncode

1052

self.last_checker_signal = None

640

if os.WIFEXITED(condition):

641

self.last_checker_status = os.WEXITSTATUS(condition)

1053

642

if self.last_checker_status == 0:

1054

643

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

1055

644

vars(self))

1056

645

self.checked_ok()

1057

646

else:

1058

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

647

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

648

vars(self))

1059

649

else:

1060

650

self.last_checker_status = -1

1061

self.last_checker_signal = -returncode

1062

651

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

1063

652

vars(self))

1064

return False

1065

653

1066

654

def checked_ok(self):

1067

655

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

1068

656

self.last_checked_ok = datetime.datetime.utcnow()

1069

657

self.last_checker_status = 0

1070

self.last_checker_signal = None

1071

658

self.bump_timeout()

1072

659

1073

660

def bump_timeout(self, timeout=None):

1074

661

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

1075

662

if timeout is None:

1076

663

timeout = self.timeout

1077

664

if self.disable_initiator_tag is not None:

1078

GLib.source_remove(self.disable_initiator_tag)

665

gobject.source_remove(self.disable_initiator_tag)

1079

666

self.disable_initiator_tag = None

1080

667

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

1081

self.disable_initiator_tag = GLib.timeout_add(

1082

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

668

self.disable_initiator_tag = (gobject.timeout_add

669

(timedelta_to_milliseconds

670

(timeout), self.disable))

1083

671

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

1084

672

1085

673

def need_approval(self):

1086

674

self.last_approval_request = datetime.datetime.utcnow()

1087

675

1088

676

def start_checker(self):

1089

677

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

1090

678

1091

679

If a checker already exists, leave it running and do

1092

680

nothing."""

1093

681

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

1098

686

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

1099

687

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

1100

688

# should be.

1101

1102

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

1103

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

1104

self.checker.join()

1105

self.checker = None

689

690

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

691

try:

692

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

693

except (AttributeError, OSError) as error:

694

if (isinstance(error, OSError)

695

and error.errno != errno.ECHILD):

696

raise error

697

else:

698

if pid:

699

logger.warning("Checker was a zombie")

700

gobject.source_remove(self.checker_callback_tag)

701

self.checker_callback(pid, status,

702

self.current_checker_command)

1106

703

# Start a new checker if needed

1107

704

if self.checker is None:

1108

705

# Escape attributes for the shell

1109

escaped_attrs = {

1110

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

1111

for attr in self.runtime_expansions}

706

escaped_attrs = dict(

707

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

708

for attr in

709

self.runtime_expansions)

1112

710

try:

1113

711

command = self.checker_command % escaped_attrs

1114

712

except TypeError as error:

1115

713

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

1116

self.checker_command,

714

self.checker_command, exc_info=error)

715

return True # Try again later

716

self.current_checker_command = command

717

try:

718

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

719

command, self.name)

720

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

721

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

722

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

723

# always replaced by /dev/null.)

724

# The exception is when not debugging but nevertheless

725

# running in the foreground; use the previously

726

# created wnull.

727

popen_args = {}

728

if (not self.server_settings["debug"]

729

and self.server_settings["foreground"]):

730

popen_args.update({"stdout": wnull,

731

"stderr": wnull })

732

self.checker = subprocess.Popen(command,

733

close_fds=True,

734

shell=True, cwd="/",

735

**popen_args)

736

except OSError as error:

737

logger.error("Failed to start subprocess",

1117

738

exc_info=error)

1118

return True # Try again later

1119

self.current_checker_command = command

1120

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

1121

self.name)

1122

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

1123

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

1124

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

1125

# always replaced by /dev/null.)

1126

# The exception is when not debugging but nevertheless

1127

# running in the foreground; use the previously

1128

# created wnull.

1129

popen_args = {"close_fds": True,

1130

"shell": True,

1131

"cwd": "/"}

1132

if (not self.server_settings["debug"]

1133

and self.server_settings["foreground"]):

1134

popen_args.update({"stdout": wnull,

1135

"stderr": wnull})

1136

pipe = multiprocessing.Pipe(duplex=False)

1137

self.checker = multiprocessing.Process(

1138

target=call_pipe,

1139

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

1140

kwargs=popen_args)

1141

self.checker.start()

1142

self.checker_callback_tag = GLib.io_add_watch(

1143

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

1144

self.checker_callback, pipe[0], command)

1145

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

739

return True

740

self.checker_callback_tag = (gobject.child_watch_add

741

(self.checker.pid,

742

self.checker_callback,

743

data=command))

744

# The checker may have completed before the gobject

745

# watch was added. Check for this.

746

try:

747

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

748

except OSError as error:

749

if error.errno == errno.ECHILD:

750

# This should never happen

751

logger.error("Child process vanished",

752

exc_info=error)

753

return True

754

raise

755

if pid:

756

gobject.source_remove(self.checker_callback_tag)

757

self.checker_callback(pid, status, command)

758

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

1146

759

return True

1147

760

1148

761

def stop_checker(self):

1149

762

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

1150

763

if self.checker_callback_tag:

1151

GLib.source_remove(self.checker_callback_tag)

764

gobject.source_remove(self.checker_callback_tag)

1152

765

self.checker_callback_tag = None

1153

766

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

1154

767

return

1155

768

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

1156

self.checker.terminate()

769

try:

770

self.checker.terminate()

771

#time.sleep(0.5)

772

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

773

# self.checker.kill()

774

except OSError as error:

775

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

776

raise

1157

777

self.checker = None

1158

778

1159

779

1160

def dbus_service_property(dbus_interface,

1161

signature="v",

1162

access="readwrite",

1163

byte_arrays=False):

780

def dbus_service_property(dbus_interface, signature="v",

781

access="readwrite", byte_arrays=False):

1164

782

"""Decorators for marking methods of a DBusObjectWithProperties to

1165

783

become properties on the D-Bus.

1166

784

1167

785

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

1168

786

and with one argument by "Set".

1169

787

1170

788

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

1171

789

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

1172

790

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

1175

793

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

1176

794

if byte_arrays and signature != "ay":

1177

795

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

1178

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

1179

796

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

1180

797

def decorator(func):

1181

798

func._dbus_is_property = True

1182

799

func._dbus_interface = dbus_interface

1185

802

func._dbus_name = func.__name__

1186

803

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

1187

804

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

1188

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

805

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1189

806

return func

1190

1191

807

return decorator

1192

808

1193

809

1194

810

def dbus_interface_annotations(dbus_interface):

1195

811

"""Decorator for marking functions returning interface annotations

1196

812

1197

813

Usage:

1198

814

1199

815

@dbus_interface_annotations("org.example.Interface")

1200

816

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

1201

817

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

1202

818

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

1203

819

"false"}

1204

820

"""

1205

1206

821

def decorator(func):

1207

822

func._dbus_is_interface = True

1208

823

func._dbus_interface = dbus_interface

1209

824

func._dbus_name = dbus_interface

1210

825

return func

1211

1212

826

return decorator

1213

827

1214

828

1215

829

def dbus_annotations(annotations):

1216

830

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

1217

831

Usage:

1218

1219

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

1220

"org.freedesktop.DBus.Property."

1221

"EmitsChangedSignal": "false"})

832

1222

833

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

1223

834

access="r")

835

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

836

"org.freedesktop.DBus.Property."

837

"EmitsChangedSignal": "false"})

1224

838

def Property_dbus_property(self):

1225

839

return dbus.Boolean(False)

1226

1227

See also the DBusObjectWithAnnotations class.

1228

840

"""

1229

1230

841

def decorator(func):

1231

842

func._dbus_annotations = annotations

1232

843

return func

1233

1234

844

return decorator

1235

845

1236

846

1237

847

class DBusPropertyException(dbus.exceptions.DBusException):

1238

848

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

1239

849

"""

1240

pass

850

def __unicode__(self):

851

return unicode(str(self))

1241

852

1242

853

1243

854

class DBusPropertyAccessException(DBusPropertyException):

1252

863

pass

1253

864

1254

865

1255

class DBusObjectWithAnnotations(dbus.service.Object):

1256

"""A D-Bus object with annotations.

1257

1258

Classes inheriting from this can use the dbus_annotations

1259

decorator to add annotations to methods or signals.

866

class DBusObjectWithProperties(dbus.service.Object):

867

"""A D-Bus object with properties.

868

869

Classes inheriting from this can use the dbus_service_property

870

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

871

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

1260

872

"""

1261

873

1262

874

@staticmethod

1263

875

def _is_dbus_thing(thing):

1264

876

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

1265

877

1266

878

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

1267

879

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

1268

880

"""

1269

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

881

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

1270

882

False)

1271

883

1272

884

def _get_all_dbus_things(self, thing):

1273

885

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

1274

886

"""

1275

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

887

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

888

name),

1276

889

athing.__get__(self))

1277

890

for cls in self.__class__.__mro__

1278

891

for name, athing in

1279

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

1280

1281

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1282

out_signature="s",

1283

path_keyword='object_path',

1284

connection_keyword='connection')

1285

def Introspect(self, object_path, connection):

1286

"""Overloading of standard D-Bus method.

1287

1288

Inserts annotation tags on methods and signals.

1289

"""

1290

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

1291

connection)

1292

try:

1293

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

1294

1295

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

1296

# Add annotation tags

1297

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

1298

for tag in if_tag.getElementsByTagName(typ):

1299

annots = dict()

1300

for name, prop in (self.

1301

_get_all_dbus_things(typ)):

1302

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

1303

and prop._dbus_interface

1304

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

1305

annots.update(getattr(

1306

prop, "_dbus_annotations", {}))

1307

for name, value in annots.items():

1308

ann_tag = document.createElement(

1309

"annotation")

1310

ann_tag.setAttribute("name", name)

1311

ann_tag.setAttribute("value", value)

1312

tag.appendChild(ann_tag)

1313

# Add interface annotation tags

1314

for annotation, value in dict(

1315

itertools.chain.from_iterable(

1316

annotations().items()

1317

for name, annotations

1318

in self._get_all_dbus_things("interface")

1319

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

1320

)).items():

1321

ann_tag = document.createElement("annotation")

1322

ann_tag.setAttribute("name", annotation)

1323

ann_tag.setAttribute("value", value)

1324

if_tag.appendChild(ann_tag)

1325

# Fix argument name for the Introspect method itself

1326

if (if_tag.getAttribute("name")

1327

== dbus.INTROSPECTABLE_IFACE):

1328

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

1329

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

1330

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

1331

if (arg.getAttribute("direction")

1332

== "out"):

1333

arg.setAttribute("name",

1334

"xml_data")

1335

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

1336

document.unlink()

1337

except (AttributeError, xml.dom.DOMException,

1338

xml.parsers.expat.ExpatError) as error:

1339

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

1340

exc_info=error)

1341

return xmlstring

1342

1343

1344

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1345

"""A D-Bus object with properties.

1346

1347

Classes inheriting from this can use the dbus_service_property

1348

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

1349

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

1350

"""

1351

892

inspect.getmembers(cls,

893

self._is_dbus_thing(thing)))

894

1352

895

def _get_dbus_property(self, interface_name, property_name):

1353

896

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

1354

897

property with the specified name and interface.

1355

898

"""

1356

for cls in self.__class__.__mro__:

1357

for name, value in inspect.getmembers(

1358

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

899

for cls in self.__class__.__mro__:

900

for name, value in (inspect.getmembers

901

(cls,

902

self._is_dbus_thing("property"))):

1359

903

if (value._dbus_name == property_name

1360

904

and value._dbus_interface == interface_name):

1361

905

return value.__get__(self)

1362

906

1363

907

# No such property

1364

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

1365

self.dbus_object_path, interface_name, property_name))

1366

1367

@classmethod

1368

def _get_all_interface_names(cls):

1369

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

1370

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

1371

"_dbus_interface", None)

1372

for x in (inspect.getmro(cls))

1373

for attr in dir(x))

1374

if name is not None)

1375

1376

@dbus.service.method(dbus.PROPERTIES_IFACE,

1377

in_signature="ss",

908

raise DBusPropertyNotFound(self.dbus_object_path + ":"

909

+ interface_name + "."

910

+ property_name)

911

912

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

1378

913

out_signature="v")

1379

914

def Get(self, interface_name, property_name):

1380

915

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

1386

921

if not hasattr(value, "variant_level"):

1387

922

return value

1388

923

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

1389

924

1390

925

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

1391

926

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

1392

927

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

1398

933

# The byte_arrays option is not supported yet on

1399

934

# signatures other than "ay".

1400

935

if prop._dbus_signature != "ay":

1401

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

1402

"'ay' signature {!r}"

1403

.format(prop._dbus_signature))

936

raise ValueError

1404

937

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

1405

938

for byte in value))

1406

939

prop(value)

1407

1408

@dbus.service.method(dbus.PROPERTIES_IFACE,

1409

in_signature="s",

940

941

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

1410

942

out_signature="a{sv}")

1411

943

def GetAll(self, interface_name):

1412

944

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

1413

945

standard.

1414

946

1415

947

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

1416

948

"""

1417

949

properties = {}

1427

959

if not hasattr(value, "variant_level"):

1428

960

properties[name] = value

1429

961

continue

1430

properties[name] = type(value)(

1431

value, variant_level=value.variant_level + 1)

962

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

963

value.variant_level+1)

1432

964

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

1433

1434

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

1435

def PropertiesChanged(self, interface_name, changed_properties,

1436

invalidated_properties):

1437

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

1438

standard.

1439

"""

1440

pass

1441

965

1442

966

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1443

967

out_signature="s",

1444

968

path_keyword='object_path',

1445

969

connection_keyword='connection')

1446

970

def Introspect(self, object_path, connection):

1447

971

"""Overloading of standard D-Bus method.

1448

972

1449

973

Inserts property tags and interface annotation tags.

1450

974

"""

1451

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1452

object_path,

1453

connection)

975

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

976

connection)

1454

977

try:

1455

978

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

1456

1457

979

def make_tag(document, name, prop):

1458

980

e = document.createElement("property")

1459

981

e.setAttribute("name", name)

1460

982

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

1461

983

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

1462

984

return e

1463

1464

985

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

1465

986

# Add property tags

1466

987

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

1469

990

if prop._dbus_interface

1470

991

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

1471

992

if_tag.appendChild(tag)

1472

# Add annotation tags for properties

1473

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

1474

annots = dict()

1475

for name, prop in self._get_all_dbus_things(

1476

"property"):

1477

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

1478

and prop._dbus_interface

1479

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

1480

annots.update(getattr(

1481

prop, "_dbus_annotations", {}))

1482

for name, value in annots.items():

1483

ann_tag = document.createElement(

1484

"annotation")

1485

ann_tag.setAttribute("name", name)

1486

ann_tag.setAttribute("value", value)

1487

tag.appendChild(ann_tag)

993

# Add annotation tags

994

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

995

for tag in if_tag.getElementsByTagName(typ):

996

annots = dict()

997

for name, prop in (self.

998

_get_all_dbus_things(typ)):

999

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

1000

and prop._dbus_interface

1001

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

1002

annots.update(getattr

1003

(prop,

1004

"_dbus_annotations",

1005

{}))

1006

for name, value in annots.iteritems():

1007

ann_tag = document.createElement(

1008

"annotation")

1009

ann_tag.setAttribute("name", name)

1010

ann_tag.setAttribute("value", value)

1011

tag.appendChild(ann_tag)

1012

# Add interface annotation tags

1013

for annotation, value in dict(

1014

itertools.chain.from_iterable(

1015

annotations().iteritems()

1016

for name, annotations in

1017

self._get_all_dbus_things("interface")

1018

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

1019

)).iteritems():

1020

ann_tag = document.createElement("annotation")

1021

ann_tag.setAttribute("name", annotation)

1022

ann_tag.setAttribute("value", value)

1023

if_tag.appendChild(ann_tag)

1488

1024

# Add the names to the return values for the

1489

1025

# "org.freedesktop.DBus.Properties" methods

1490

1026

if (if_tag.getAttribute("name")

1509

1045

return xmlstring

1510

1046

1511

1047

1512

try:

1513

dbus.OBJECT_MANAGER_IFACE

1514

except AttributeError:

1515

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

1516

1517

1518

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1519

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

1520

1521

Classes inheriting from this exposes the standard

1522

GetManagedObjects call and the InterfacesAdded and

1523

InterfacesRemoved signals on the standard

1524

"org.freedesktop.DBus.ObjectManager" interface.

1525

1526

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

1527

manually.

1528

"""

1529

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1530

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

1531

def GetManagedObjects(self):

1532

"""This function must be overridden"""

1533

raise NotImplementedError()

1534

1535

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1536

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

1537

def InterfacesAdded(self, object_path, interfaces_and_properties):

1538

pass

1539

1540

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

1541

def InterfacesRemoved(self, object_path, interfaces):

1542

pass

1543

1544

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1545

out_signature="s",

1546

path_keyword='object_path',

1547

connection_keyword='connection')

1548

def Introspect(self, object_path, connection):

1549

"""Overloading of standard D-Bus method.

1550

1551

Override return argument name of GetManagedObjects to be

1552

"objpath_interfaces_and_properties"

1553

"""

1554

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1555

object_path,

1556

connection)

1557

try:

1558

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

1559

1560

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

1561

# Fix argument name for the GetManagedObjects method

1562

if (if_tag.getAttribute("name")

1563

== dbus.OBJECT_MANAGER_IFACE):

1564

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

1565

if (cn.getAttribute("name")

1566

== "GetManagedObjects"):

1567

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

1568

if (arg.getAttribute("direction")

1569

== "out"):

1570

arg.setAttribute(

1571

"name",

1572

"objpath_interfaces"

1573

"_and_properties")

1574

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

1575

document.unlink()

1576

except (AttributeError, xml.dom.DOMException,

1577

xml.parsers.expat.ExpatError) as error:

1578

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

1579

exc_info=error)

1580

return xmlstring

1581

1582

1583

1048

def datetime_to_dbus(dt, variant_level=0):

1584

1049

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

1585

1050

if dt is None:

1586

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

1587

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

1051

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

1052

return dbus.String(dt.isoformat(),

1053

variant_level=variant_level)

1588

1054

1589

1055

1590

1056

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1592

1058

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

1593

1059

interface names according to the "alt_interface_names" mapping.

1594

1060

Usage:

1595

1061

1596

1062

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

1597

1063

"net.example.AlternateInterface"})

1598

1064

class SampleDBusObject(dbus.service.Object):

1599

1065

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

1600

1066

def SampleDBusMethod():

1601

1067

pass

1602

1068

1603

1069

The above "SampleDBusMethod" on "SampleDBusObject" will be

1604

1070

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

1605

1071

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

1606

1072

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

1607

1073

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

1608

1074

1609

1075

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

1610

1076

(from DBusObjectWithProperties) and interfaces (from the

1611

1077

dbus_interface_annotations decorator).

1612

1078

"""

1613

1614

1079

def wrapper(cls):

1615

1080

for orig_interface_name, alt_interface_name in (

1616

alt_interface_names.items()):

1081

alt_interface_names.iteritems()):

1617

1082

attr = {}

1618

1083

interface_names = set()

1619

1084

# Go though all attributes of the class

1621

1086

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

1622

1087

# with the wrong interface name

1623

1088

if (not hasattr(attribute, "_dbus_interface")

1624

or not attribute._dbus_interface.startswith(

1625

orig_interface_name)):

1089

or not attribute._dbus_interface

1090

.startswith(orig_interface_name)):

1626

1091

continue

1627

1092

# Create an alternate D-Bus interface name based on

1628

1093

# the current name

1629

alt_interface = attribute._dbus_interface.replace(

1630

orig_interface_name, alt_interface_name)

1094

alt_interface = (attribute._dbus_interface

1095

.replace(orig_interface_name,

1096

alt_interface_name))

1631

1097

interface_names.add(alt_interface)

1632

1098

# Is this a D-Bus signal?

1633

1099

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

1634

1100

# Extract the original non-method undecorated

1635

1101

# function by black magic

1636

if sys.version_info.major == 2:

1637

nonmethod_func = (dict(

1102

nonmethod_func = (dict(

1638

1103

zip(attribute.func_code.co_freevars,

1639

attribute.__closure__))

1640

["func"].cell_contents)

1641

else:

1642

nonmethod_func = (dict(

1643

zip(attribute.__code__.co_freevars,

1644

attribute.__closure__))

1645

["func"].cell_contents)

1104

attribute.__closure__))["func"]

1105

.cell_contents)

1646

1106

# Create a new, but exactly alike, function

1647

1107

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

1648

1108

# with the alternate D-Bus interface name

1649

new_function = copy_function(nonmethod_func)

1650

new_function = (dbus.service.signal(

1651

alt_interface,

1652

attribute._dbus_signature)(new_function))

1109

new_function = (dbus.service.signal

1110

(alt_interface,

1111

attribute._dbus_signature)

1112

(types.FunctionType(

1113

nonmethod_func.func_code,

1114

nonmethod_func.func_globals,

1115

nonmethod_func.func_name,

1116

nonmethod_func.func_defaults,

1117

nonmethod_func.func_closure)))

1653

1118

# Copy annotations, if any

1654

1119

try:

1655

new_function._dbus_annotations = dict(

1656

attribute._dbus_annotations)

1120

new_function._dbus_annotations = (

1121

dict(attribute._dbus_annotations))

1657

1122

except AttributeError:

1658

1123

pass

1659

1660

1124

# Define a creator of a function to call both the

1661

1125

# original and alternate functions, so both the

1662

1126

# original and alternate signals gets sent when

1665

1129

"""This function is a scope container to pass

1666

1130

func1 and func2 to the "call_both" function

1667

1131

outside of its arguments"""

1668

1669

@functools.wraps(func2)

1670

1132

def call_both(*args, **kwargs):

1671

1133

"""This function will emit two D-Bus

1672

1134

signals by calling func1 and func2"""

1673

1135

func1(*args, **kwargs)

1674

1136

func2(*args, **kwargs)

1675

# Make wrapper function look like a D-Bus

1676

# signal

1677

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

1678

if name.startswith("_dbus_"):

1679

setattr(call_both, name, attr)

1680

1681

1137

return call_both

1682

1138

# Create the "call_both" function and add it to

1683

1139

# the class

1688

1144

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

1689

1145

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

1690

1146

# to the class.

1691

attr[attrname] = (

1692

dbus.service.method(

1693

alt_interface,

1694

attribute._dbus_in_signature,

1695

attribute._dbus_out_signature)

1696

(copy_function(attribute)))

1147

attr[attrname] = (dbus.service.method

1148

(alt_interface,

1149

attribute._dbus_in_signature,

1150

attribute._dbus_out_signature)

1151

(types.FunctionType

1152

(attribute.func_code,

1153

attribute.func_globals,

1154

attribute.func_name,

1155

attribute.func_defaults,

1156

attribute.func_closure)))

1697

1157

# Copy annotations, if any

1698

1158

try:

1699

attr[attrname]._dbus_annotations = dict(

1700

attribute._dbus_annotations)

1159

attr[attrname]._dbus_annotations = (

1160

dict(attribute._dbus_annotations))

1701

1161

except AttributeError:

1702

1162

pass

1703

1163

# Is this a D-Bus property?

1706

1166

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

1707

1167

# property with the alternate D-Bus interface

1708

1168

# name. Add it to the class.

1709

attr[attrname] = (dbus_service_property(

1710

alt_interface, attribute._dbus_signature,

1711

attribute._dbus_access,

1712

attribute._dbus_get_args_options

1713

["byte_arrays"])

1714

(copy_function(attribute)))

1169

attr[attrname] = (dbus_service_property

1170

(alt_interface,

1171

attribute._dbus_signature,

1172

attribute._dbus_access,

1173

attribute

1174

._dbus_get_args_options

1175

["byte_arrays"])

1176

(types.FunctionType

1177

(attribute.func_code,

1178

attribute.func_globals,

1179

attribute.func_name,

1180

attribute.func_defaults,

1181

attribute.func_closure)))

1715

1182

# Copy annotations, if any

1716

1183

try:

1717

attr[attrname]._dbus_annotations = dict(

1718

attribute._dbus_annotations)

1184

attr[attrname]._dbus_annotations = (

1185

dict(attribute._dbus_annotations))

1719

1186

except AttributeError:

1720

1187

pass

1721

1188

# Is this a D-Bus interface?

1724

1191

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

1725

1192

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

1726

1193

# to the class.

1727

attr[attrname] = (

1728

dbus_interface_annotations(alt_interface)

1729

(copy_function(attribute)))

1194

attr[attrname] = (dbus_interface_annotations

1195

(alt_interface)

1196

(types.FunctionType

1197

(attribute.func_code,

1198

attribute.func_globals,

1199

attribute.func_name,

1200

attribute.func_defaults,

1201

attribute.func_closure)))

1730

1202

if deprecate:

1731

1203

# Deprecate all alternate interfaces

1732

iname = "_AlternateDBusNames_interface_annotation{}"

1204

iname="_AlternateDBusNames_interface_annotation{0}"

1733

1205

for interface_name in interface_names:

1734

1735

1206

@dbus_interface_annotations(interface_name)

1736

1207

def func(self):

1737

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

1738

"true"}

1208

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

1209

"true" }

1739

1210

# Find an unused name

1740

1211

for aname in (iname.format(i)

1741

1212

for i in itertools.count()):

1745

1216

if interface_names:

1746

1217

# Replace the class with a new subclass of it with

1747

1218

# methods, signals, etc. as created above.

1748

if sys.version_info.major == 2:

1749

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

1750

(cls, ), attr)

1751

else:

1752

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

1753

(cls, ), attr)

1219

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

1220

(cls,), attr)

1754

1221

return cls

1755

1756

1222

return wrapper

1757

1223

1758

1224

1759

1225

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

1760

"se.bsnet.fukt.Mandos"})

1226

"se.bsnet.fukt.Mandos"})

1761

1227

class ClientDBus(Client, DBusObjectWithProperties):

1762

1228

"""A Client class using D-Bus

1763

1229

1764

1230

Attributes:

1765

1231

dbus_object_path: dbus.ObjectPath

1766

1232

bus: dbus.SystemBus()

1767

1233

"""

1768

1234

1769

1235

runtime_expansions = (Client.runtime_expansions

1770

+ ("dbus_object_path", ))

1771

1772

_interface = "se.recompile.Mandos.Client"

1773

1236

+ ("dbus_object_path",))

1237

1774

1238

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

1775

1776

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

1239

1240

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

1777

1241

self.bus = bus

1778

1242

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

1779

1243

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

1780

1244

# the D-Bus

1781

client_object_name = str(self.name).translate(

1245

client_object_name = unicode(self.name).translate(

1782

1246

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

1783

1247

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

1784

self.dbus_object_path = dbus.ObjectPath(

1785

"/clients/" + client_object_name)

1248

self.dbus_object_path = (dbus.ObjectPath

1249

("/clients/" + client_object_name))

1786

1250

DBusObjectWithProperties.__init__(self, self.bus,

1787

1251

self.dbus_object_path)

1788

1789

def notifychangeproperty(transform_func, dbus_name,

1790

type_func=lambda x: x,

1791

variant_level=1,

1792

invalidate_only=False,

1793

_interface=_interface):

1252

1253

def notifychangeproperty(transform_func,

1254

dbus_name, type_func=lambda x: x,

1255

variant_level=1):

1794

1256

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

1795

1257

its changes to DBus.

1796

1258

1797

1259

transform_fun: Function that takes a value and a variant_level

1798

1260

and transforms it to a D-Bus type.

1799

1261

dbus_name: D-Bus name of the variable

1801

1263

to the D-Bus. Default: no transform

1802

1264

variant_level: D-Bus variant level. Default: 1

1803

1265

"""

1804

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

1805

1266

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

1806

1267

def setter(self, value):

1807

1268

if hasattr(self, "dbus_object_path"):

1808

1269

if (not hasattr(self, attrname) or

1809

1270

type_func(getattr(self, attrname, None))

1810

1271

!= type_func(value)):

1811

if invalidate_only:

1812

self.PropertiesChanged(

1813

_interface, dbus.Dictionary(),

1814

dbus.Array((dbus_name, )))

1815

else:

1816

dbus_value = transform_func(

1817

type_func(value),

1818

variant_level=variant_level)

1819

self.PropertyChanged(dbus.String(dbus_name),

1820

dbus_value)

1821

self.PropertiesChanged(

1822

_interface,

1823

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

1824

dbus_value}),

1825

dbus.Array())

1272

dbus_value = transform_func(type_func(value),

1273

variant_level

1274

=variant_level)

1275

self.PropertyChanged(dbus.String(dbus_name),

1276

dbus_value)

1826

1277

setattr(self, attrname, value)

1827

1278

1828

1279

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

1829

1280

1830

1281

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1831

1282

approvals_pending = notifychangeproperty(dbus.Boolean,

1832

1283

"ApprovalPending",

1833

type_func=bool)

1284

type_func = bool)

1834

1285

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

1835

1286

last_enabled = notifychangeproperty(datetime_to_dbus,

1836

1287

"LastEnabled")

1837

checker = notifychangeproperty(

1838

dbus.Boolean, "CheckerRunning",

1839

type_func=lambda checker: checker is not None)

1288

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

1289

type_func = lambda checker:

1290

checker is not None)

1840

1291

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1841

1292

"LastCheckedOK")

1842

1293

last_checker_status = notifychangeproperty(dbus.Int16,

1845

1296

datetime_to_dbus, "LastApprovalRequest")

1846

1297

approved_by_default = notifychangeproperty(dbus.Boolean,

1847

1298

"ApprovedByDefault")

1848

approval_delay = notifychangeproperty(

1849

dbus.UInt64, "ApprovalDelay",

1850

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

1299

approval_delay = notifychangeproperty(dbus.UInt64,

1300

"ApprovalDelay",

1301

type_func =

1302

timedelta_to_milliseconds)

1851

1303

approval_duration = notifychangeproperty(

1852

1304

dbus.UInt64, "ApprovalDuration",

1853

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

1305

type_func = timedelta_to_milliseconds)

1854

1306

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

1855

timeout = notifychangeproperty(

1856

dbus.UInt64, "Timeout",

1857

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

1307

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

1308

type_func =

1309

timedelta_to_milliseconds)

1858

1310

extended_timeout = notifychangeproperty(

1859

1311

dbus.UInt64, "ExtendedTimeout",

1860

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

1861

interval = notifychangeproperty(

1862

dbus.UInt64, "Interval",

1863

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

1312

type_func = timedelta_to_milliseconds)

1313

interval = notifychangeproperty(dbus.UInt64,

1314

"Interval",

1315

type_func =

1316

timedelta_to_milliseconds)

1864

1317

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

1865

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

1866

invalidate_only=True)

1867

1318

1868

1319

del notifychangeproperty

1869

1320

1870

1321

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

1871

1322

try:

1872

1323

self.remove_from_connection()

1875

1326

if hasattr(DBusObjectWithProperties, "__del__"):

1876

1327

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

1877

1328

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

1878

1879

def checker_callback(self, source, condition,

1880

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

1881

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

1882

connection, command, *args,

1883

**kwargs)

1884

exitstatus = self.last_checker_status

1885

if exitstatus >= 0:

1329

1330

def checker_callback(self, pid, condition, command,

1331

*args, **kwargs):

1332

self.checker_callback_tag = None

1333

self.checker = None

1334

if os.WIFEXITED(condition):

1335

exitstatus = os.WEXITSTATUS(condition)

1886

1336

# Emit D-Bus signal

1887

1337

self.CheckerCompleted(dbus.Int16(exitstatus),

1888

# This is specific to GNU libC

1889

dbus.Int64(exitstatus << 8),

1338

dbus.Int64(condition),

1890

1339

dbus.String(command))

1891

1340

else:

1892

1341

# Emit D-Bus signal

1893

1342

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

1894

dbus.Int64(

1895

# This is specific to GNU libC

1896

(exitstatus << 8)

1897

| self.last_checker_signal),

1343

dbus.Int64(condition),

1898

1344

dbus.String(command))

1899

return ret

1900

1345

1346

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

1347

*args, **kwargs)

1348

1901

1349

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

1902

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

1350

old_checker = self.checker

1351

if self.checker is not None:

1352

old_checker_pid = self.checker.pid

1353

else:

1354

old_checker_pid = None

1903

1355

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

1904

1356

# Only if new checker process was started

1905

1357

if (self.checker is not None

1907

1359

# Emit D-Bus signal

1908

1360

self.CheckerStarted(self.current_checker_command)

1909

1361

return r

1910

1362

1911

1363

def _reset_approved(self):

1912

1364

self.approved = None

1913

1365

return False

1914

1366

1915

1367

def approve(self, value=True):

1916

1368

self.approved = value

1917

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

1918

* 1000), self._reset_approved)

1369

gobject.timeout_add(timedelta_to_milliseconds

1370

(self.approval_duration),

1371

self._reset_approved)

1919

1372

self.send_changedstate()

1920

1921

# D-Bus methods, signals & properties

1922

1923

# Interfaces

1924

1925

# Signals

1926

1373

1374

## D-Bus methods, signals & properties

1375

_interface = "se.recompile.Mandos.Client"

1376

1377

## Interfaces

1378

1379

@dbus_interface_annotations(_interface)

1380

def _foo(self):

1381

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

1382

"false"}

1383

1384

## Signals

1385

1927

1386

# CheckerCompleted - signal

1928

1387

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

1929

1388

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

1930

1389

"D-Bus signal"

1931

1390

pass

1932

1391

1933

1392

# CheckerStarted - signal

1934

1393

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

1935

1394

def CheckerStarted(self, command):

1936

1395

"D-Bus signal"

1937

1396

pass

1938

1397

1939

1398

# PropertyChanged - signal

1940

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

1941

1399

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

1942

1400

def PropertyChanged(self, property, value):

1943

1401

"D-Bus signal"

1944

1402

pass

1945

1403

1946

1404

# GotSecret - signal

1947

1405

@dbus.service.signal(_interface)

1948

1406

def GotSecret(self):

1951

1409

server to mandos-client

1952

1410

"""

1953

1411

pass

1954

1412

1955

1413

# Rejected - signal

1956

1414

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

1957

1415

def Rejected(self, reason):

1958

1416

"D-Bus signal"

1959

1417

pass

1960

1418

1961

1419

# NeedApproval - signal

1962

1420

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

1963

1421

def NeedApproval(self, timeout, default):

1964

1422

"D-Bus signal"

1965

1423

return self.need_approval()

1966

1967

# Methods

1968

1424

1425

## Methods

1426

1969

1427

# Approve - method

1970

1428

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

1971

1429

def Approve(self, value):

1972

1430

self.approve(value)

1973

1431

1974

1432

# CheckedOK - method

1975

1433

@dbus.service.method(_interface)

1976

1434

def CheckedOK(self):

1977

1435

self.checked_ok()

1978

1436

1979

1437

# Enable - method

1980

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

1981

1438

@dbus.service.method(_interface)

1982

1439

def Enable(self):

1983

1440

"D-Bus method"

1984

1441

self.enable()

1985

1442

1986

1443

# StartChecker - method

1987

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

1988

1444

@dbus.service.method(_interface)

1989

1445

def StartChecker(self):

1990

1446

"D-Bus method"

1991

1447

self.start_checker()

1992

1448

1993

1449

# Disable - method

1994

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

1995

1450

@dbus.service.method(_interface)

1996

1451

def Disable(self):

1997

1452

"D-Bus method"

1998

1453

self.disable()

1999

1454

2000

1455

# StopChecker - method

2001

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

2002

1456

@dbus.service.method(_interface)

2003

1457

def StopChecker(self):

2004

1458

self.stop_checker()

2005

2006

# Properties

2007

1459

1460

## Properties

1461

2008

1462

# ApprovalPending - property

2009

1463

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

2010

1464

def ApprovalPending_dbus_property(self):

2011

1465

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

2012

1466

2013

1467

# ApprovedByDefault - property

2014

@dbus_service_property(_interface,

2015

signature="b",

1468

@dbus_service_property(_interface, signature="b",

2016

1469

access="readwrite")

2017

1470

def ApprovedByDefault_dbus_property(self, value=None):

2018

1471

if value is None: # get

2019

1472

return dbus.Boolean(self.approved_by_default)

2020

1473

self.approved_by_default = bool(value)

2021

1474

2022

1475

# ApprovalDelay - property

2023

@dbus_service_property(_interface,

2024

signature="t",

1476

@dbus_service_property(_interface, signature="t",

2025

1477

access="readwrite")

2026

1478

def ApprovalDelay_dbus_property(self, value=None):

2027

1479

if value is None: # get

2028

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

2029

* 1000)

1480

return dbus.UInt64(self.approval_delay_milliseconds())

2030

1481

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

2031

1482

2032

1483

# ApprovalDuration - property

2033

@dbus_service_property(_interface,

2034

signature="t",

1484

@dbus_service_property(_interface, signature="t",

2035

1485

access="readwrite")

2036

1486

def ApprovalDuration_dbus_property(self, value=None):

2037

1487

if value is None: # get

2038

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

2039

* 1000)

1488

return dbus.UInt64(timedelta_to_milliseconds(

1489

self.approval_duration))

2040

1490

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

2041

1491

2042

1492

# Name - property

2043

@dbus_annotations(

2044

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

2045

1493

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

2046

1494

def Name_dbus_property(self):

2047

1495

return dbus.String(self.name)

2048

2049

# KeyID - property

2050

@dbus_annotations(

2051

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

2052

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

2053

def KeyID_dbus_property(self):

2054

return dbus.String(self.key_id)

2055

1496

2056

1497

# Fingerprint - property

2057

@dbus_annotations(

2058

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

2059

1498

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

2060

1499

def Fingerprint_dbus_property(self):

2061

1500

return dbus.String(self.fingerprint)

2062

1501

2063

1502

# Host - property

2064

@dbus_service_property(_interface,

2065

signature="s",

1503

@dbus_service_property(_interface, signature="s",

2066

1504

access="readwrite")

2067

1505

def Host_dbus_property(self, value=None):

2068

1506

if value is None: # get

2069

1507

return dbus.String(self.host)

2070

self.host = str(value)

2071

1508

self.host = unicode(value)

1509

2072

1510

# Created - property

2073

@dbus_annotations(

2074

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

2075

1511

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

2076

1512

def Created_dbus_property(self):

2077

1513

return datetime_to_dbus(self.created)

2078

1514

2079

1515

# LastEnabled - property

2080

1516

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

2081

1517

def LastEnabled_dbus_property(self):

2082

1518

return datetime_to_dbus(self.last_enabled)

2083

1519

2084

1520

# Enabled - property

2085

@dbus_service_property(_interface,

2086

signature="b",

1521

@dbus_service_property(_interface, signature="b",

2087

1522

access="readwrite")

2088

1523

def Enabled_dbus_property(self, value=None):

2089

1524

if value is None: # get

2092

1527

self.enable()

2093

1528

else:

2094

1529

self.disable()

2095

1530

2096

1531

# LastCheckedOK - property

2097

@dbus_service_property(_interface,

2098

signature="s",

1532

@dbus_service_property(_interface, signature="s",

2099

1533

access="readwrite")

2100

1534

def LastCheckedOK_dbus_property(self, value=None):

2101

1535

if value is not None:

2102

1536

self.checked_ok()

2103

1537

return

2104

1538

return datetime_to_dbus(self.last_checked_ok)

2105

1539

2106

1540

# LastCheckerStatus - property

2107

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

1541

@dbus_service_property(_interface, signature="n",

1542

access="read")

2108

1543

def LastCheckerStatus_dbus_property(self):

2109

1544

return dbus.Int16(self.last_checker_status)

2110

1545

2111

1546

# Expires - property

2112

1547

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

2113

1548

def Expires_dbus_property(self):

2114

1549

return datetime_to_dbus(self.expires)

2115

1550

2116

1551

# LastApprovalRequest - property

2117

1552

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

2118

1553

def LastApprovalRequest_dbus_property(self):

2119

1554

return datetime_to_dbus(self.last_approval_request)

2120

1555

2121

1556

# Timeout - property

2122

@dbus_service_property(_interface,

2123

signature="t",

1557

@dbus_service_property(_interface, signature="t",

2124

1558

access="readwrite")

2125

1559

def Timeout_dbus_property(self, value=None):

2126

1560

if value is None: # get

2127

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

1561

return dbus.UInt64(self.timeout_milliseconds())

2128

1562

old_timeout = self.timeout

2129

1563

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

2130

1564

# Reschedule disabling

2138

1572

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

2139

1573

is None):

2140

1574

return

2141

GLib.source_remove(self.disable_initiator_tag)

2142

self.disable_initiator_tag = GLib.timeout_add(

2143

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

2144

self.disable)

2145

1575

gobject.source_remove(self.disable_initiator_tag)

1576

self.disable_initiator_tag = (

1577

gobject.timeout_add(

1578

timedelta_to_milliseconds(self.expires - now),

1579

self.disable))

1580

2146

1581

# ExtendedTimeout - property

2147

@dbus_service_property(_interface,

2148

signature="t",

1582

@dbus_service_property(_interface, signature="t",

2149

1583

access="readwrite")

2150

1584

def ExtendedTimeout_dbus_property(self, value=None):

2151

1585

if value is None: # get

2152

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

2153

* 1000)

1586

return dbus.UInt64(self.extended_timeout_milliseconds())

2154

1587

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

2155

1588

2156

1589

# Interval - property

2157

@dbus_service_property(_interface,

2158

signature="t",

1590

@dbus_service_property(_interface, signature="t",

2159

1591

access="readwrite")

2160

1592

def Interval_dbus_property(self, value=None):

2161

1593

if value is None: # get

2162

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

1594

return dbus.UInt64(self.interval_milliseconds())

2163

1595

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

2164

1596

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

2165

1597

return

2166

1598

if self.enabled:

2167

1599

# Reschedule checker run

2168

GLib.source_remove(self.checker_initiator_tag)

2169

self.checker_initiator_tag = GLib.timeout_add(

2170

value, self.start_checker)

2171

self.start_checker() # Start one now, too

2172

1600

gobject.source_remove(self.checker_initiator_tag)

1601

self.checker_initiator_tag = (gobject.timeout_add

1602

(value, self.start_checker))

1603

self.start_checker() # Start one now, too

1604

2173

1605

# Checker - property

2174

@dbus_service_property(_interface,

2175

signature="s",

1606

@dbus_service_property(_interface, signature="s",

2176

1607

access="readwrite")

2177

1608

def Checker_dbus_property(self, value=None):

2178

1609

if value is None: # get

2179

1610

return dbus.String(self.checker_command)

2180

self.checker_command = str(value)

2181

1611

self.checker_command = unicode(value)

1612

2182

1613

# CheckerRunning - property

2183

@dbus_service_property(_interface,

2184

signature="b",

1614

@dbus_service_property(_interface, signature="b",

2185

1615

access="readwrite")

2186

1616

def CheckerRunning_dbus_property(self, value=None):

2187

1617

if value is None: # get

2190

1620

self.start_checker()

2191

1621

else:

2192

1622

self.stop_checker()

2193

1623

2194

1624

# ObjectPath - property

2195

@dbus_annotations(

2196

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

2197

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

2198

1625

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

2199

1626

def ObjectPath_dbus_property(self):

2200

return self.dbus_object_path # is already a dbus.ObjectPath

2201

1627

return self.dbus_object_path # is already a dbus.ObjectPath

1628

2202

1629

# Secret = property

2203

@dbus_annotations(

2204

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

2205

"invalidates"})

2206

@dbus_service_property(_interface,

2207

signature="ay",

2208

access="write",

2209

byte_arrays=True)

1630

@dbus_service_property(_interface, signature="ay",

1631

access="write", byte_arrays=True)

2210

1632

def Secret_dbus_property(self, value):

2211

self.secret = bytes(value)

2212

1633

self.secret = str(value)

1634

2213

1635

del _interface

2214

1636

2215

1637

2216

1638

class ProxyClient(object):

2217

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

1639

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

2218

1640

self._pipe = child_pipe

2219

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

1641

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

2220

1642

if not self._pipe.recv():

2221

raise KeyError(key_id or fpr)

2222

1643

raise KeyError()

1644

2223

1645

def __getattribute__(self, name):

2224

1646

if name == '_pipe':

2225

1647

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

2228

1650

if data[0] == 'data':

2229

1651

return data[1]

2230

1652

if data[0] == 'function':

2231

2232

1653

def func(*args, **kwargs):

2233

1654

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

2234

1655

return self._pipe.recv()[1]

2235

2236

1656

return func

2237

1657

2238

1658

def __setattr__(self, name, value):

2239

1659

if name == '_pipe':

2240

1660

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

2243

1663

2244

1664

class ClientHandler(socketserver.BaseRequestHandler, object):

2245

1665

"""A class to handle client connections.

2246

1666

2247

1667

Instantiated once for each connection to handle it.

2248

1668

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

2249

1669

2250

1670

def handle(self):

2251

1671

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

2252

1672

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

2253

str(self.client_address))

1673

unicode(self.client_address))

2254

1674

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

2255

1675

self.server.child_pipe.fileno())

2256

2257

session = gnutls.ClientSession(self.request)

2258

2259

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

2260

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

2261

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

2262

# "+DHE-DSS"))

1676

1677

session = (gnutls.connection

1678

.ClientSession(self.request,

1679

gnutls.connection

1680

.X509Credentials()))

1681

1682

# Note: gnutls.connection.X509Credentials is really a

1683

# generic GnuTLS certificate credentials object so long as

1684

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

1685

# here despite using OpenPGP certificates.

1686

1687

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

1688

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

1689

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

1690

# "+DHE-DSS"))

2263

1691

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

2264

1692

priority = self.server.gnutls_priority

2265

1693

if priority is None:

2266

1694

priority = "NORMAL"

2267

gnutls.priority_set_direct(session._c_object,

2268

priority.encode("utf-8"),

2269

None)

2270

1695

(gnutls.library.functions

1696

.gnutls_priority_set_direct(session._c_object,

1697

priority, None))

1698

2271

1699

# Start communication using the Mandos protocol

2272

1700

# Get protocol number

2273

1701

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

2274

1702

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

2275

1703

try:

2276

1704

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

2277

raise RuntimeError(line)

1705

raise RuntimeError

2278

1706

except (ValueError, IndexError, RuntimeError) as error:

2279

1707

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

2280

1708

return

2281

1709

2282

1710

# Start GnuTLS connection

2283

1711

try:

2284

1712

session.handshake()

2285

except gnutls.Error as error:

1713

except gnutls.errors.GNUTLSError as error:

2286

1714

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

2287

1715

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

2288

1716

# established. Just abandon the request.

2289

1717

return

2290

1718

logger.debug("Handshake succeeded")

2291

1719

2292

1720

approval_required = False

2293

1721

try:

2294

if gnutls.has_rawpk:

2295

fpr = b""

2296

try:

2297

key_id = self.key_id(

2298

self.peer_certificate(session))

2299

except (TypeError, gnutls.Error) as error:

2300

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

2301

return

2302

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

2303

2304

else:

2305

key_id = b""

2306

try:

2307

fpr = self.fingerprint(

2308

self.peer_certificate(session))

2309

except (TypeError, gnutls.Error) as error:

2310

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

2311

return

2312

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

2313

2314

try:

2315

client = ProxyClient(child_pipe, key_id, fpr,

1722

try:

1723

fpr = self.fingerprint(self.peer_certificate

1724

(session))

1725

except (TypeError,

1726

gnutls.errors.GNUTLSError) as error:

1727

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

1728

return

1729

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

1730

1731

try:

1732

client = ProxyClient(child_pipe, fpr,

2316

1733

self.client_address)

2317

1734

except KeyError:

2318

1735

return

2319

1736

2320

1737

if client.approval_delay:

2321

1738

delay = client.approval_delay

2322

1739

client.approvals_pending += 1

2323

1740

approval_required = True

2324

1741

2325

1742

while True:

2326

1743

if not client.enabled:

2327

1744

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

2328

client.name)

1745

client.name)

2329

1746

if self.server.use_dbus:

2330

1747

# Emit D-Bus signal

2331

1748

client.Rejected("Disabled")

2332

1749

return

2333

1750

2334

1751

if client.approved or not client.approval_delay:

2335

# We are approved or approval is disabled

1752

#We are approved or approval is disabled

2336

1753

break

2337

1754

elif client.approved is None:

2338

1755

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

2340

1757

if self.server.use_dbus:

2341

1758

# Emit D-Bus signal

2342

1759

client.NeedApproval(

2343

client.approval_delay.total_seconds()

2344

* 1000, client.approved_by_default)

1760

client.approval_delay_milliseconds(),

1761

client.approved_by_default)

2345

1762

else:

2346

1763

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

2347

1764

client.name)

2349

1766

# Emit D-Bus signal

2350

1767

client.Rejected("Denied")

2351

1768

return

2352

2353

# wait until timeout or approved

1769

1770

#wait until timeout or approved

2354

1771

time = datetime.datetime.now()

2355

1772

client.changedstate.acquire()

2356

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

1773

client.changedstate.wait(

1774

float(timedelta_to_milliseconds(delay)

1775

/ 1000))

2357

1776

client.changedstate.release()

2358

1777

time2 = datetime.datetime.now()

2359

1778

if (time2 - time) >= delay:

2369

1788

break

2370

1789

else:

2371

1790

delay -= time2 - time

2372

2373

try:

2374

session.send(client.secret)

2375

except gnutls.Error as error:

2376

logger.warning("gnutls send failed",

2377

exc_info=error)

2378

return

2379

1791

1792

sent_size = 0

1793

while sent_size < len(client.secret):

1794

try:

1795

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

1796

except gnutls.errors.GNUTLSError as error:

1797

logger.warning("gnutls send failed",

1798

exc_info=error)

1799

return

1800

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

1801

sent, len(client.secret)

1802

- (sent_size + sent))

1803

sent_size += sent

1804

2380

1805

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

2381

1806

# bump the timeout using extended_timeout

2382

1807

client.bump_timeout(client.extended_timeout)

2383

1808

if self.server.use_dbus:

2384

1809

# Emit D-Bus signal

2385

1810

client.GotSecret()

2386

1811

2387

1812

finally:

2388

1813

if approval_required:

2389

1814

client.approvals_pending -= 1

2390

1815

try:

2391

1816

session.bye()

2392

except gnutls.Error as error:

1817

except gnutls.errors.GNUTLSError as error:

2393

1818

logger.warning("GnuTLS bye failed",

2394

1819

exc_info=error)

2395

1820

2396

1821

@staticmethod

2397

1822

def peer_certificate(session):

2398

"Return the peer's certificate as a bytestring"

2399

try:

2400

cert_type = gnutls.certificate_type_get2(session._c_object,

2401

gnutls.CTYPE_PEERS)

2402

except AttributeError:

2403

cert_type = gnutls.certificate_type_get(session._c_object)

2404

if gnutls.has_rawpk:

2405

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2406

else:

2407

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2408

# If not a valid certificate type...

2409

if cert_type not in valid_cert_types:

2410

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

2411

valid_cert_types)

2412

# ...return invalid data

2413

return b""

1823

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

1824

# If not an OpenPGP certificate...

1825

if (gnutls.library.functions

1826

.gnutls_certificate_type_get(session._c_object)

1827

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1828

# ...do the normal thing

1829

return session.peer_certificate

2414

1830

list_size = ctypes.c_uint(1)

2415

cert_list = (gnutls.certificate_get_peers

1831

cert_list = (gnutls.library.functions

1832

.gnutls_certificate_get_peers

2416

1833

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

2417

1834

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

2418

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

1835

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

1836

" certificate")

2419

1837

if list_size.value == 0:

2420

1838

return None

2421

1839

cert = cert_list[0]

2422

1840

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

2423

2424

@staticmethod

2425

def key_id(certificate):

2426

"Convert a certificate bytestring to a hexdigit key ID"

2427

# New GnuTLS "datum" with the public key

2428

datum = gnutls.datum_t(

2429

ctypes.cast(ctypes.c_char_p(certificate),

2430

ctypes.POINTER(ctypes.c_ubyte)),

2431

ctypes.c_uint(len(certificate)))

2432

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

2433

# New empty GnuTLS certificate

2434

pubkey = gnutls.pubkey_t()

2435

gnutls.pubkey_init(ctypes.byref(pubkey))

2436

# Import the raw public key into the certificate

2437

gnutls.pubkey_import(pubkey,

2438

ctypes.byref(datum),

2439

gnutls.X509_FMT_DER)

2440

# New buffer for the key ID

2441

buf = ctypes.create_string_buffer(32)

2442

buf_len = ctypes.c_size_t(len(buf))

2443

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

2444

gnutls.pubkey_get_key_id(pubkey,

2445

gnutls.KEYID_USE_SHA256,

2446

ctypes.cast(ctypes.byref(buf),

2447

ctypes.POINTER(ctypes.c_ubyte)),

2448

ctypes.byref(buf_len))

2449

# Deinit the certificate

2450

gnutls.pubkey_deinit(pubkey)

2451

2452

# Convert the buffer to a Python bytestring

2453

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

2454

# Convert the bytestring to hexadecimal notation

2455

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

2456

return hex_key_id

2457

1841

2458

1842

@staticmethod

2459

1843

def fingerprint(openpgp):

2460

1844

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2461

1845

# New GnuTLS "datum" with the OpenPGP public key

2462

datum = gnutls.datum_t(

2463

ctypes.cast(ctypes.c_char_p(openpgp),

2464

ctypes.POINTER(ctypes.c_ubyte)),

2465

ctypes.c_uint(len(openpgp)))

1846

datum = (gnutls.library.types

1847

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

1848

ctypes.POINTER

1849

(ctypes.c_ubyte)),

1850

ctypes.c_uint(len(openpgp))))

2466

1851

# New empty GnuTLS certificate

2467

crt = gnutls.openpgp_crt_t()

2468

gnutls.openpgp_crt_init(ctypes.byref(crt))

1852

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1853

(gnutls.library.functions

1854

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2469

1855

# Import the OpenPGP public key into the certificate

2470

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

2471

gnutls.OPENPGP_FMT_RAW)

1856

(gnutls.library.functions

1857

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

1858

gnutls.library.constants

1859

.GNUTLS_OPENPGP_FMT_RAW))

2472

1860

# Verify the self signature in the key

2473

1861

crtverify = ctypes.c_uint()

2474

gnutls.openpgp_crt_verify_self(crt, 0,

2475

ctypes.byref(crtverify))

1862

(gnutls.library.functions

1863

.gnutls_openpgp_crt_verify_self(crt, 0,

1864

ctypes.byref(crtverify)))

2476

1865

if crtverify.value != 0:

2477

gnutls.openpgp_crt_deinit(crt)

2478

raise gnutls.CertificateSecurityError(code

2479

=crtverify.value)

1866

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1867

raise (gnutls.errors.CertificateSecurityError

1868

("Verify failed"))

2480

1869

# New buffer for the fingerprint

2481

1870

buf = ctypes.create_string_buffer(20)

2482

1871

buf_len = ctypes.c_size_t()

2483

1872

# Get the fingerprint from the certificate into the buffer

2484

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

2485

ctypes.byref(buf_len))

1873

(gnutls.library.functions

1874

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

1875

ctypes.byref(buf_len)))

2486

1876

# Deinit the certificate

2487

gnutls.openpgp_crt_deinit(crt)

1877

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2488

1878

# Convert the buffer to a Python bytestring

2489

1879

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

2490

1880

# Convert the bytestring to hexadecimal notation

2494

1884

2495

1885

class MultiprocessingMixIn(object):

2496

1886

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

2497

2498

1887

def sub_process_main(self, request, address):

2499

1888

try:

2500

1889

self.finish_request(request, address)

2501

1890

except Exception:

2502

1891

self.handle_error(request, address)

2503

1892

self.close_request(request)

2504

1893

2505

1894

def process_request(self, request, address):

2506

1895

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

2507

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

2508

args=(request, address))

1896

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

1897

args = (request, address))

2509

1898

proc.start()

2510

1899

return proc

2511

1900

2512

1901

2513

1902

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2514

1903

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

2515

2516

1904

def process_request(self, request, client_address):

2517

1905

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

2518

1906

2519

1907

This function creates a new pipe in self.pipe

2520

1908

"""

2521

1909

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2522

1910

2523

1911

proc = MultiprocessingMixIn.process_request(self, request,

2524

1912

client_address)

2525

1913

self.child_pipe.close()

2526

1914

self.add_pipe(parent_pipe, proc)

2527

1915

2528

1916

def add_pipe(self, parent_pipe, proc):

2529

1917

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

2530

raise NotImplementedError()

1918

raise NotImplementedError

2531

1919

2532

1920

2533

1921

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2534

1922

socketserver.TCPServer, object):

2535

1923

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

2536

1924

2537

1925

Attributes:

2538

1926

enabled: Boolean; whether this server is activated yet

2539

1927

interface: None or a network interface name (string)

2540

1928

use_ipv6: Boolean; to use IPv6 or not

2541

1929

"""

2542

2543

1930

def __init__(self, server_address, RequestHandlerClass,

2544

interface=None,

2545

use_ipv6=True,

2546

socketfd=None):

1931

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

2547

1932

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

2548

1933

creating a new one with socket.socket().

2549

1934

"""

2555

1940

self.socketfd = socketfd

2556

1941

# Save the original socket.socket() function

2557

1942

self.socket_socket = socket.socket

2558

2559

1943

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

2560

#

1944

#

2561

1945

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

2562

1946

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

2563

1947

# patching socket.socket.)

2564

#

1948

#

2565

1949

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

2566

1950

@functools.wraps(socket.socket)

2567

1951

def socket_wrapper(*args, **kwargs):

2579

1963

# socket_wrapper(), if socketfd was set.

2580

1964

socketserver.TCPServer.__init__(self, server_address,

2581

1965

RequestHandlerClass)

2582

1966

2583

1967

def server_bind(self):

2584

1968

"""This overrides the normal server_bind() function

2585

1969

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

2586

1970

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

2587

global SO_BINDTODEVICE

2588

1971

if self.interface is not None:

2589

1972

if SO_BINDTODEVICE is None:

2590

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

2591

# common enough.

2592

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

2593

SO_BINDTODEVICE = 25

2594

try:

2595

self.socket.setsockopt(

2596

socket.SOL_SOCKET, SO_BINDTODEVICE,

2597

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

2598

except socket.error as error:

2599

if error.errno == errno.EPERM:

2600

logger.error("No permission to bind to"

2601

" interface %s", self.interface)

2602

elif error.errno == errno.ENOPROTOOPT:

2603

logger.error("SO_BINDTODEVICE not available;"

2604

" cannot bind to interface %s",

2605

self.interface)

2606

elif error.errno == errno.ENODEV:

2607

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

2608

" cannot bind", self.interface)

2609

else:

2610

raise

1973

logger.error("SO_BINDTODEVICE does not exist;"

1974

" cannot bind to interface %s",

1975

self.interface)

1976

else:

1977

try:

1978

self.socket.setsockopt(socket.SOL_SOCKET,

1979

SO_BINDTODEVICE,

1980

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

1981

except socket.error as error:

1982

if error.errno == errno.EPERM:

1983

logger.error("No permission to bind to"

1984

" interface %s", self.interface)

1985

elif error.errno == errno.ENOPROTOOPT:

1986

logger.error("SO_BINDTODEVICE not available;"

1987

" cannot bind to interface %s",

1988

self.interface)

1989

elif error.errno == errno.ENODEV:

1990

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

1991

" cannot bind", self.interface)

1992

else:

1993

raise

2611

1994

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

2612

1995

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

2613

if self.server_address[1]:

2614

self.allow_reuse_address = True

2615

1996

if not self.server_address[0]:

2616

1997

if self.address_family == socket.AF_INET6:

2617

any_address = "::" # in6addr_any

1998

any_address = "::" # in6addr_any

2618

1999

else:

2619

any_address = "0.0.0.0" # INADDR_ANY

2000

any_address = "0.0.0.0" # INADDR_ANY

2620

2001

self.server_address = (any_address,

2621

2002

self.server_address[1])

2622

2003

elif not self.server_address[1]:

2623

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

2004

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

2005

0)

2624

2006

# if self.interface:

2625

2007

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

2626

2008

# 0, # port

2632

2014

2633

2015

class MandosServer(IPv6_TCPServer):

2634

2016

"""Mandos server.

2635

2017

2636

2018

Attributes:

2637

2019

clients: set of Client objects

2638

2020

gnutls_priority GnuTLS priority string

2639

2021

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

2640

2641

Assumes a GLib.MainLoop event loop.

2022

2023

Assumes a gobject.MainLoop event loop.

2642

2024

"""

2643

2644

2025

def __init__(self, server_address, RequestHandlerClass,

2645

interface=None,

2646

use_ipv6=True,

2647

clients=None,

2648

gnutls_priority=None,

2649

use_dbus=True,

2650

socketfd=None):

2026

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

2027

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

2651

2028

self.enabled = False

2652

2029

self.clients = clients

2653

2030

if self.clients is None:

2656

2033

self.gnutls_priority = gnutls_priority

2657

2034

IPv6_TCPServer.__init__(self, server_address,

2658

2035

RequestHandlerClass,

2659

interface=interface,

2660

use_ipv6=use_ipv6,

2661

socketfd=socketfd)

2662

2036

interface = interface,

2037

use_ipv6 = use_ipv6,

2038

socketfd = socketfd)

2663

2039

def server_activate(self):

2664

2040

if self.enabled:

2665

2041

return socketserver.TCPServer.server_activate(self)

2666

2042

2667

2043

def enable(self):

2668

2044

self.enabled = True

2669

2045

2670

2046

def add_pipe(self, parent_pipe, proc):

2671

2047

# Call "handle_ipc" for both data and EOF events

2672

GLib.io_add_watch(

2673

parent_pipe.fileno(),

2674

GLib.IO_IN | GLib.IO_HUP,

2675

functools.partial(self.handle_ipc,

2676

parent_pipe=parent_pipe,

2677

proc=proc))

2678

2679

def handle_ipc(self, source, condition,

2680

parent_pipe=None,

2681

proc=None,

2682

client_object=None):

2048

gobject.io_add_watch(parent_pipe.fileno(),

2049

gobject.IO_IN | gobject.IO_HUP,

2050

functools.partial(self.handle_ipc,

2051

parent_pipe =

2052

parent_pipe,

2053

proc = proc))

2054

2055

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

2056

proc = None, client_object=None):

2683

2057

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

2684

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

2058

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

2685

2059

# Wait for other process to exit

2686

2060

proc.join()

2687

2061

return False

2688

2062

2689

2063

# Read a request from the child

2690

2064

request = parent_pipe.recv()

2691

2065

command = request[0]

2692

2066

2693

2067

if command == 'init':

2694

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

2695

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

2696

address = request[3]

2697

2698

for c in self.clients.values():

2699

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2700

continue

2701

if key_id and c.key_id == key_id:

2702

client = c

2703

break

2704

if fpr and c.fingerprint == fpr:

2068

fpr = request[1]

2069

address = request[2]

2070

2071

for c in self.clients.itervalues():

2072

if c.fingerprint == fpr:

2705

2073

client = c

2706

2074

break

2707

2075

else:

2708

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

2709

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

2076

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

2077

"dress: %s", fpr, address)

2710

2078

if self.use_dbus:

2711

2079

# Emit D-Bus signal

2712

mandos_dbus_service.ClientNotFound(key_id or fpr,

2080

mandos_dbus_service.ClientNotFound(fpr,

2713

2081

address[0])

2714

2082

parent_pipe.send(False)

2715

2083

return False

2716

2717

GLib.io_add_watch(

2718

parent_pipe.fileno(),

2719

GLib.IO_IN | GLib.IO_HUP,

2720

functools.partial(self.handle_ipc,

2721

parent_pipe=parent_pipe,

2722

proc=proc,

2723

client_object=client))

2084

2085

gobject.io_add_watch(parent_pipe.fileno(),

2086

gobject.IO_IN | gobject.IO_HUP,

2087

functools.partial(self.handle_ipc,

2088

parent_pipe =

2089

parent_pipe,

2090

proc = proc,

2091

client_object =

2092

client))

2724

2093

parent_pipe.send(True)

2725

2094

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

2726

2095

# same fileno

2729

2098

funcname = request[1]

2730

2099

args = request[2]

2731

2100

kwargs = request[3]

2732

2101

2733

2102

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

2734

2103

funcname)(*args,

2735

**kwargs)))

2736

2104

**kwargs)))

2105

2737

2106

if command == 'getattr':

2738

2107

attrname = request[1]

2739

if isinstance(client_object.__getattribute__(attrname),

2740

collections.Callable):

2741

parent_pipe.send(('function', ))

2108

if callable(client_object.__getattribute__(attrname)):

2109

parent_pipe.send(('function',))

2742

2110

else:

2743

parent_pipe.send((

2744

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

2745

2111

parent_pipe.send(('data', client_object

2112

.__getattribute__(attrname)))

2113

2746

2114

if command == 'setattr':

2747

2115

attrname = request[1]

2748

2116

value = request[2]

2749

2117

setattr(client_object, attrname, value)

2750

2118

2751

2119

return True

2752

2120

2753

2121

2754

2122

def rfc3339_duration_to_delta(duration):

2755

2123

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

2756

2124

2757

2125

>>> rfc3339_duration_to_delta("P7D")

2758

2126

datetime.timedelta(7)

2759

2127

>>> rfc3339_duration_to_delta("PT60S")

2769

2137

>>> rfc3339_duration_to_delta("P1DT3M20S")

2770

2138

datetime.timedelta(1, 200)

2771

2139

"""

2772

2140

2773

2141

# Parsing an RFC 3339 duration with regular expressions is not

2774

2142

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

2775

2143

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

2776

2144

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

2777

2145

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

2778

2146

# avoid excessive use of external libraries.

2779

2147

2780

2148

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

2781

Token = collections.namedtuple("Token", (

2782

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

2783

# a "group" containing digits

2784

"value", # datetime.timedelta or None

2785

"followers")) # Tokens valid after this token

2149

Token = collections.namedtuple("Token",

2150

("regexp", # To match token; if

2151

# "value" is not None,

2152

# must have a "group"

2153

# containing digits

2154

"value", # datetime.timedelta or

2155

# None

2156

"followers")) # Tokens valid after

2157

# this token

2786

2158

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

2787

2159

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

2788

2160

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

2789

2161

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

2790

2162

datetime.timedelta(seconds=1),

2791

frozenset((token_end, )))

2163

frozenset((token_end,)))

2792

2164

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

2793

2165

datetime.timedelta(minutes=1),

2794

2166

frozenset((token_second, token_end)))

2810

2182

frozenset((token_month, token_end)))

2811

2183

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

2812

2184

datetime.timedelta(weeks=1),

2813

frozenset((token_end, )))

2185

frozenset((token_end,)))

2814

2186

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

2815

2187

frozenset((token_year, token_month,

2816

2188

token_day, token_time,

2817

token_week)))

2818

# Define starting values:

2819

# Value so far

2820

value = datetime.timedelta()

2189

token_week))),

2190

# Define starting values

2191

value = datetime.timedelta() # Value so far

2821

2192

found_token = None

2822

# Following valid tokens

2823

followers = frozenset((token_duration, ))

2824

# String left to parse

2825

s = duration

2193

followers = frozenset(token_duration,) # Following valid tokens

2194

s = duration # String left to parse

2826

2195

# Loop until end token is found

2827

2196

while found_token is not token_end:

2828

2197

# Search for any currently valid tokens

2844

2213

break

2845

2214

else:

2846

2215

# No currently valid tokens were found

2847

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

2848

.format(duration))

2216

raise ValueError("Invalid RFC 3339 duration")

2849

2217

# End token found

2850

2218

return value

2851

2219

2852

2220

2853

2221

def string_to_delta(interval):

2854

2222

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

2855

2223

2856

2224

>>> string_to_delta('7d')

2857

2225

datetime.timedelta(7)

2858

2226

>>> string_to_delta('60s')

2866

2234

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

2867

2235

datetime.timedelta(0, 330)

2868

2236

"""

2869

2237

2870

2238

try:

2871

2239

return rfc3339_duration_to_delta(interval)

2872

2240

except ValueError:

2873

2241

pass

2874

2242

2875

2243

timevalue = datetime.timedelta(0)

2876

2244

for s in interval.split():

2877

2245

try:

2878

suffix = s[-1]

2246

suffix = unicode(s[-1])

2879

2247

value = int(s[:-1])

2880

2248

if suffix == "d":

2881

2249

delta = datetime.timedelta(value)

2888

2256

elif suffix == "w":

2889

2257

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

2890

2258

else:

2891

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

2892

except IndexError as e:

2259

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

2260

.format(suffix))

2261

except (ValueError, IndexError) as e:

2893

2262

raise ValueError(*(e.args))

2894

2263

timevalue += delta

2895

2264

return timevalue

2896

2265

2897

2266

2898

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

2267

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

2899

2268

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

2900

2269

2901

2270

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

2902

2271

if os.fork():

2903

2272

sys.exit()

2911

2280

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

2912

2281

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

2913

2282

raise OSError(errno.ENODEV,

2914

"{} not a character device"

2283

"{0} not a character device"

2915

2284

.format(os.devnull))

2916

2285

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

2917

2286

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

2921

2290

2922

2291

2923

2292

def main():

2924

2293

2925

2294

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

2926

2295

# Parsing of options, both command line and config file

2927

2296

2928

2297

parser = argparse.ArgumentParser()

2929

2298

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

2930

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

2299

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

2931

2300

help="show version number and exit")

2932

2301

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

2933

2302

help="Bind to interface IF")

2966

2335

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

2967

2336

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

2968

2337

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

2969

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

2970

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

2971

default=None)

2972

2338

2973

2339

options = parser.parse_args()

2974

2340

2975

2341

if options.check:

2976

2342

import doctest

2977

fail_count, test_count = doctest.testmod()

2978

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

2979

2343

doctest.testmod()

2344

sys.exit()

2345

2980

2346

# Default values for config file for server-global settings

2981

if gnutls.has_rawpk:

2982

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

2983

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

2984

else:

2985

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

2986

":+SIGN-DSA-SHA256")

2987

server_defaults = {"interface": "",

2988

"address": "",

2989

"port": "",

2990

"debug": "False",

2991

"priority": priority,

2992

"servicename": "Mandos",

2993

"use_dbus": "True",

2994

"use_ipv6": "True",

2995

"debuglevel": "",

2996

"restore": "True",

2997

"socket": "",

2998

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

2999

"foreground": "False",

3000

"zeroconf": "True",

3001

}

3002

del priority

3003

2347

server_defaults = { "interface": "",

2348

"address": "",

2349

"port": "",

2350

"debug": "False",

2351

"priority":

2352

"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",

2353

"servicename": "Mandos",

2354

"use_dbus": "True",

2355

"use_ipv6": "True",

2356

"debuglevel": "",

2357

"restore": "True",

2358

"socket": "",

2359

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

2360

"foreground": "False",

2361

}

2362

3004

2363

# Parse config file for server-global settings

3005

server_config = configparser.ConfigParser(server_defaults)

2364

server_config = configparser.SafeConfigParser(server_defaults)

3006

2365

del server_defaults

3007

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

3008

# Convert the ConfigParser object to a dict

2366

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

2367

"mandos.conf"))

2368

# Convert the SafeConfigParser object to a dict

3009

2369

server_settings = server_config.defaults()

3010

2370

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

3011

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

3012

"foreground", "zeroconf"):

2371

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

3013

2372

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

3014

2373

option)

3015

2374

if server_settings["port"]:

3025

2384

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

3026

2385

["socket"])

3027

2386

del server_config

3028

2387

3029

2388

# Override the settings from the config file with command line

3030

2389

# options, if set.

3031

2390

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

3032

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

3033

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

3034

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

2391

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

2392

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

2393

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

3035

2394

value = getattr(options, option)

3036

2395

if value is not None:

3037

2396

server_settings[option] = value

3038

2397

del options

3039

2398

# Force all strings to be unicode

3040

2399

for option in server_settings.keys():

3041

if isinstance(server_settings[option], bytes):

3042

server_settings[option] = (server_settings[option]

3043

.decode("utf-8"))

2400

if type(server_settings[option]) is str:

2401

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

3044

2402

# Force all boolean options to be boolean

3045

2403

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

3046

"foreground", "zeroconf"):

2404

"foreground"):

3047

2405

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

3048

2406

# Debug implies foreground

3049

2407

if server_settings["debug"]:

3050

2408

server_settings["foreground"] = True

3051

2409

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

3052

2410

3053

2411

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

3054

3055

if (not server_settings["zeroconf"]

3056

and not (server_settings["port"]

3057

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

3058

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

3059

2412

3060

2413

# For convenience

3061

2414

debug = server_settings["debug"]

3062

2415

debuglevel = server_settings["debuglevel"]

3065

2418

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

3066

2419

stored_state_file)

3067

2420

foreground = server_settings["foreground"]

3068

zeroconf = server_settings["zeroconf"]

3069

2421

3070

2422

if debug:

3071

2423

initlogger(debug, logging.DEBUG)

3072

2424

else:

3075

2427

else:

3076

2428

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

3077

2429

initlogger(debug, level)

3078

2430

3079

2431

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

3080

syslogger.setFormatter(

3081

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

3082

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

3083

server_settings["servicename"])))

3084

2432

syslogger.setFormatter(logging.Formatter

2433

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

2434

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

2435

.format(server_settings

2436

["servicename"])))

2437

3085

2438

# Parse config file with clients

3086

client_config = configparser.ConfigParser(Client.client_defaults)

2439

client_config = configparser.SafeConfigParser(Client

2440

.client_defaults)

3087

2441

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

3088

2442

"clients.conf"))

3089

2443

3090

2444

global mandos_dbus_service

3091

2445

mandos_dbus_service = None

3092

3093

socketfd = None

3094

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

3095

socketfd = server_settings["socket"]

3096

tcp_server = MandosServer(

3097

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

3098

ClientHandler,

3099

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

3100

use_ipv6=use_ipv6,

3101

gnutls_priority=server_settings["priority"],

3102

use_dbus=use_dbus,

3103

socketfd=socketfd)

2446

2447

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

2448

server_settings["port"]),

2449

ClientHandler,

2450

interface=(server_settings["interface"]

2451

or None),

2452

use_ipv6=use_ipv6,

2453

gnutls_priority=

2454

server_settings["priority"],

2455

use_dbus=use_dbus,

2456

socketfd=(server_settings["socket"]

2457

or None))

3104

2458

if not foreground:

3105

2459

pidfilename = "/run/mandos.pid"

3106

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

3107

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

3108

2460

pidfile = None

3109

2461

try:

3110

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

2462

pidfile = open(pidfilename, "w")

3111

2463

except IOError as e:

3112

2464

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

3113

2465

exc_info=e)

3114

3115

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

3116

("mandos", "mandos"),

3117

("nobody", "nogroup")):

2466

2467

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

3118

2468

try:

3119

2469

uid = pwd.getpwnam(name).pw_uid

3120

gid = pwd.getpwnam(group).pw_gid

2470

gid = pwd.getpwnam(name).pw_gid

3121

2471

break

3122

2472

except KeyError:

3123

2473

continue

3127

2477

try:

3128

2478

os.setgid(gid)

3129

2479

os.setuid(uid)

3130

if debug:

3131

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

3132

gid))

3133

2480

except OSError as error:

3134

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

3135

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

3136

2481

if error.errno != errno.EPERM:

3137

raise

3138

2482

raise error

2483

3139

2484

if debug:

3140

2485

# Enable all possible GnuTLS debugging

3141

2486

3142

2487

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

3143

2488

# - GnuTLS manual

3144

gnutls.global_set_log_level(11)

3145

3146

@gnutls.log_func

2489

gnutls.library.functions.gnutls_global_set_log_level(11)

2490

2491

@gnutls.library.types.gnutls_log_func

3147

2492

def debug_gnutls(level, string):

3148

2493

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

3149

3150

gnutls.global_set_log_function(debug_gnutls)

3151

2494

2495

(gnutls.library.functions

2496

.gnutls_global_set_log_function(debug_gnutls))

2497

3152

2498

# Redirect stdin so all checkers get /dev/null

3153

2499

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

3154

2500

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

3155

2501

if null > 2:

3156

2502

os.close(null)

3157

2503

3158

2504

# Need to fork before connecting to D-Bus

3159

2505

if not foreground:

3160

2506

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

3161

2507

daemon()

3162

3163

if gi.version_info < (3, 10, 2):

3164

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

3165

# need to inform GLib that threads will be used.

3166

GLib.threads_init()

3167

2508

2509

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

2510

# need to inform gobject that threads will be used.

2511

gobject.threads_init()

2512

3168

2513

global main_loop

3169

2514

# From the Avahi example code

3170

2515

DBusGMainLoop(set_as_default=True)

3171

main_loop = GLib.MainLoop()

2516

main_loop = gobject.MainLoop()

3172

2517

bus = dbus.SystemBus()

3173

2518

# End of Avahi example code

3174

2519

if use_dbus:

3175

2520

try:

3176

2521

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

3177

bus,

3178

do_not_queue=True)

3179

old_bus_name = dbus.service.BusName(

3180

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

3181

do_not_queue=True)

3182

except dbus.exceptions.DBusException as e:

2522

bus, do_not_queue=True)

2523

old_bus_name = (dbus.service.BusName

2524

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

2525

do_not_queue=True))

2526

except dbus.exceptions.NameExistsException as e:

3183

2527

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

3184

2528

use_dbus = False

3185

2529

server_settings["use_dbus"] = False

3186

2530

tcp_server.use_dbus = False

3187

if zeroconf:

3188

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3189

service = AvahiServiceToSyslog(

3190

name=server_settings["servicename"],

3191

servicetype="_mandos._tcp",

3192

protocol=protocol,

3193

bus=bus)

3194

if server_settings["interface"]:

3195

service.interface = if_nametoindex(

3196

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

3197

2531

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2532

service = AvahiServiceToSyslog(name =

2533

server_settings["servicename"],

2534

servicetype = "_mandos._tcp",

2535

protocol = protocol, bus = bus)

2536

if server_settings["interface"]:

2537

service.interface = (if_nametoindex

2538

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

2539

3198

2540

global multiprocessing_manager

3199

2541

multiprocessing_manager = multiprocessing.Manager()

3200

2542

3201

2543

client_class = Client

3202

2544

if use_dbus:

3203

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

3204

2545

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

2546

3205

2547

client_settings = Client.config_parser(client_config)

3206

2548

old_client_settings = {}

3207

2549

clients_data = {}

3208

2550

3209

2551

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

3210

2552

global wnull

3211

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

2553

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

3212

2554

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

3213

2555

# mode

3214

2556

if debug or not foreground:

3215

2557

wnull.close()

3216

2558

3217

2559

# Get client data and settings from last running state.

3218

2560

if server_settings["restore"]:

3219

2561

try:

3220

2562

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

3221

if sys.version_info.major == 2:

3222

clients_data, old_client_settings = pickle.load(

3223

stored_state)

3224

else:

3225

bytes_clients_data, bytes_old_client_settings = (

3226

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

3227

# Fix bytes to strings

3228

# clients_data

3229

# .keys()

3230

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

3231

if isinstance(key, bytes)

3232

else key): value

3233

for key, value in

3234

bytes_clients_data.items()}

3235

del bytes_clients_data

3236

for key in clients_data:

3237

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

3238

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

3239

for k, v in

3240

clients_data[key].items()}

3241

clients_data[key] = value

3242

# .client_structure

3243

value["client_structure"] = [

3244

(s.decode("utf-8")

3245

if isinstance(s, bytes)

3246

else s) for s in

3247

value["client_structure"]]

3248

# .name & .host

3249

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

3250

if isinstance(value[k], bytes):

3251

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

3252

if "key_id" not in value:

3253

value["key_id"] = ""

3254

elif "fingerprint" not in value:

3255

value["fingerprint"] = ""

3256

# old_client_settings

3257

# .keys()

3258

old_client_settings = {

3259

(key.decode("utf-8")

3260

if isinstance(key, bytes)

3261

else key): value

3262

for key, value in

3263

bytes_old_client_settings.items()}

3264

del bytes_old_client_settings

3265

# .host

3266

for value in old_client_settings.values():

3267

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

3268

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

3269

.decode("utf-8"))

2563

clients_data, old_client_settings = (pickle.load

2564

(stored_state))

3270

2565

os.remove(stored_state_path)

3271

2566

except IOError as e:

3272

2567

if e.errno == errno.ENOENT:

3273

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

3274

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

2568

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

2569

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

3275

2570

else:

3276

2571

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

3277

2572

exc_info=e)

3278

2573

raise

3279

2574

except EOFError as e:

3280

2575

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

3281

"EOFError:",

3282

exc_info=e)

3283

2576

"EOFError:", exc_info=e)

2577

3284

2578

with PGPEngine() as pgp:

3285

for client_name, client in clients_data.items():

2579

for client_name, client in clients_data.iteritems():

3286

2580

# Skip removed clients

3287

2581

if client_name not in client_settings:

3288

2582

continue

3289

2583

3290

2584

# Decide which value to use after restoring saved state.

3291

2585

# We have three different values: Old config file,

3292

2586

# new config file, and saved state.

3297

2591

# For each value in new config, check if it

3298

2592

# differs from the old config value (Except for

3299

2593

# the "secret" attribute)

3300

if (name != "secret"

3301

and (value !=

3302

old_client_settings[client_name][name])):

2594

if (name != "secret" and

2595

value != old_client_settings[client_name]

2596

[name]):

3303

2597

client[name] = value

3304

2598

except KeyError:

3305

2599

pass

3306

2600

3307

2601

# Clients who has passed its expire date can still be

3308

# enabled if its last checker was successful. A Client

2602

# enabled if its last checker was successful. Clients

3309

2603

# whose checker succeeded before we stored its state is

3310

2604

# assumed to have successfully run all checkers during

3311

2605

# downtime.

3313

2607

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

3314

2608

if not client["last_checked_ok"]:

3315

2609

logger.warning(

3316

"disabling client {} - Client never "

3317

"performed a successful checker".format(

3318

client_name))

2610

"disabling client {0} - Client never "

2611

"performed a successful checker"

2612

.format(client_name))

3319

2613

client["enabled"] = False

3320

2614

elif client["last_checker_status"] != 0:

3321

2615

logger.warning(

3322

"disabling client {} - Client last"

3323

" checker failed with error code"

3324

" {}".format(

3325

client_name,

3326

client["last_checker_status"]))

2616

"disabling client {0} - Client "

2617

"last checker failed with error code {1}"

2618

.format(client_name,

2619

client["last_checker_status"]))

3327

2620

client["enabled"] = False

3328

2621

else:

3329

client["expires"] = (

3330

datetime.datetime.utcnow()

3331

+ client["timeout"])

2622

client["expires"] = (datetime.datetime

2623

.utcnow()

2624

+ client["timeout"])

3332

2625

logger.debug("Last checker succeeded,"

3333

" keeping {} enabled".format(

3334

client_name))

2626

" keeping {0} enabled"

2627

.format(client_name))

3335

2628

try:

3336

client["secret"] = pgp.decrypt(

3337

client["encrypted_secret"],

3338

client_settings[client_name]["secret"])

2629

client["secret"] = (

2630

pgp.decrypt(client["encrypted_secret"],

2631

client_settings[client_name]

2632

["secret"]))

3339

2633

except PGPError:

3340

2634

# If decryption fails, we use secret from new settings

3341

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

3342

client_name))

3343

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

3344

["secret"])

3345

2635

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

2636

.format(client_name))

2637

client["secret"] = (

2638

client_settings[client_name]["secret"])

2639

3346

2640

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

3347

2641

for client_name in (set(old_client_settings)

3348

2642

- set(client_settings)):

3350

2644

for client_name in (set(client_settings)

3351

2645

- set(old_client_settings)):

3352

2646

clients_data[client_name] = client_settings[client_name]

3353

2647

3354

2648

# Create all client objects

3355

for client_name, client in clients_data.items():

2649

for client_name, client in clients_data.iteritems():

3356

2650

tcp_server.clients[client_name] = client_class(

3357

name=client_name,

3358

settings=client,

3359

server_settings=server_settings)

3360

2651

name = client_name, settings = client,

2652

server_settings = server_settings)

2653

3361

2654

if not tcp_server.clients:

3362

2655

logger.warning("No clients defined")

3363

2656

3364

2657

if not foreground:

3365

2658

if pidfile is not None:

3366

pid = os.getpid()

3367

2659

try:

3368

2660

with pidfile:

3369

print(pid, file=pidfile)

2661

pid = os.getpid()

2662

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

3370

2663

except IOError:

3371

2664

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

3372

2665

pidfilename, pid)

3373

2666

del pidfile

3374

2667

del pidfilename

3375

3376

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

3377

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3378

lambda: main_loop.quit() and False)

3379

2668

2669

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

2670

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

2671

3380

2672

if use_dbus:

3381

3382

@alternate_dbus_interfaces(

3383

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

3384

class MandosDBusService(DBusObjectWithObjectManager):

2673

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

2674

"se.bsnet.fukt.Mandos"})

2675

class MandosDBusService(DBusObjectWithProperties):

3385

2676

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

3386

3387

2677

def __init__(self):

3388

2678

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

3389

3390

2679

_interface = "se.recompile.Mandos"

3391

2680

2681

@dbus_interface_annotations(_interface)

2682

def _foo(self):

2683

return { "org.freedesktop.DBus.Property"

2684

".EmitsChangedSignal":

2685

"false"}

2686

3392

2687

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

3393

2688

def ClientAdded(self, objpath):

3394

2689

"D-Bus signal"

3395

2690

pass

3396

2691

3397

2692

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

3398

def ClientNotFound(self, key_id, address):

2693

def ClientNotFound(self, fingerprint, address):

3399

2694

"D-Bus signal"

3400

2695

pass

3401

3402

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

3403

"true"})

2696

3404

2697

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

3405

2698

def ClientRemoved(self, objpath, name):

3406

2699

"D-Bus signal"

3407

2700

pass

3408

3409

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

3410

"true"})

2701

3411

2702

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

3412

2703

def GetAllClients(self):

3413

2704

"D-Bus method"

3414

return dbus.Array(c.dbus_object_path for c in

3415

tcp_server.clients.values())

3416

3417

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

3418

"true"})

2705

return dbus.Array(c.dbus_object_path

2706

for c in

2707

tcp_server.clients.itervalues())

2708

3419

2709

@dbus.service.method(_interface,

3420

2710

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

3421

2711

def GetAllClientsWithProperties(self):

3422

2712

"D-Bus method"

3423

2713

return dbus.Dictionary(

3424

{c.dbus_object_path: c.GetAll(

3425

"se.recompile.Mandos.Client")

3426

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

2714

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

2715

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

3427

2716

signature="oa{sv}")

3428

2717

3429

2718

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

3430

2719

def RemoveClient(self, object_path):

3431

2720

"D-Bus method"

3432

for c in tcp_server.clients.values():

2721

for c in tcp_server.clients.itervalues():

3433

2722

if c.dbus_object_path == object_path:

3434

2723

del tcp_server.clients[c.name]

3435

2724

c.remove_from_connection()

3436

# Don't signal the disabling

2725

# Don't signal anything except ClientRemoved

3437

2726

c.disable(quiet=True)

3438

# Emit D-Bus signal for removal

3439

self.client_removed_signal(c)

2727

# Emit D-Bus signal

2728

self.ClientRemoved(object_path, c.name)

3440

2729

return

3441

2730

raise KeyError(object_path)

3442

2731

3443

2732

del _interface

3444

3445

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3446

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

3447

def GetManagedObjects(self):

3448

"""D-Bus method"""

3449

return dbus.Dictionary(

3450

{client.dbus_object_path:

3451

dbus.Dictionary(

3452

{interface: client.GetAll(interface)

3453

for interface in

3454

client._get_all_interface_names()})

3455

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

3456

3457

def client_added_signal(self, client):

3458

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

3459

if use_dbus:

3460

# New standard signal

3461

self.InterfacesAdded(

3462

client.dbus_object_path,

3463

dbus.Dictionary(

3464

{interface: client.GetAll(interface)

3465

for interface in

3466

client._get_all_interface_names()}))

3467

# Old signal

3468

self.ClientAdded(client.dbus_object_path)

3469

3470

def client_removed_signal(self, client):

3471

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

3472

if use_dbus:

3473

# New standard signal

3474

self.InterfacesRemoved(

3475

client.dbus_object_path,

3476

client._get_all_interface_names())

3477

# Old signal

3478

self.ClientRemoved(client.dbus_object_path,

3479

client.name)

3480

2733

3481

2734

mandos_dbus_service = MandosDBusService()

3482

3483

# Save modules to variables to exempt the modules from being

3484

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

3485

mp = multiprocessing

3486

wn = wnull

3487

2735

3488

2736

def cleanup():

3489

2737

"Cleanup function; run on exit"

3490

if zeroconf:

3491

service.cleanup()

3492

3493

mp.active_children()

3494

wn.close()

2738

service.cleanup()

2739

2740

multiprocessing.active_children()

2741

wnull.close()

3495

2742

if not (tcp_server.clients or client_settings):

3496

2743

return

3497

2744

3498

2745

# Store client before exiting. Secrets are encrypted with key

3499

2746

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

3500

2747

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

3501

2748

clients = {}

3502

2749

with PGPEngine() as pgp:

3503

for client in tcp_server.clients.values():

2750

for client in tcp_server.clients.itervalues():

3504

2751

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

3505

2752

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

3506

2753

key)

3507

2754

client_dict = {}

3508

2755

3509

2756

# A list of attributes that can not be pickled

3510

2757

# + secret.

3511

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

3512

"checker", "server_settings"}

3513

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

3514

.Object):

2758

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

2759

"checker", "server_settings"))

2760

for name, typ in (inspect.getmembers

2761

(dbus.service.Object)):

3515

2762

exclude.add(name)

3516

2763

3517

2764

client_dict["encrypted_secret"] = (client

3518

2765

.encrypted_secret)

3519

2766

for attr in client.client_structure:

3520

2767

if attr not in exclude:

3521

2768

client_dict[attr] = getattr(client, attr)

3522

2769

3523

2770

clients[client.name] = client_dict

3524

2771

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

3525

2772

3526

2773

try:

3527

with tempfile.NamedTemporaryFile(

3528

mode='wb',

3529

suffix=".pickle",

3530

prefix='clients-',

3531

dir=os.path.dirname(stored_state_path),

3532

delete=False) as stored_state:

3533

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

3534

protocol=2)

3535

tempname = stored_state.name

2774

with (tempfile.NamedTemporaryFile

2775

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

2776

dir=os.path.dirname(stored_state_path),

2777

delete=False)) as stored_state:

2778

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

2779

tempname=stored_state.name

3536

2780

os.rename(tempname, stored_state_path)

3537

2781

except (IOError, OSError) as e:

3538

2782

if not debug:

3541

2785

except NameError:

3542

2786

pass

3543

2787

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

3544

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

2788

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

3545

2789

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

3546

2790

else:

3547

2791

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

3548

2792

exc_info=e)

3549

raise

3550

2793

raise e

2794

3551

2795

# Delete all clients, and settings from config

3552

2796

while tcp_server.clients:

3553

2797

name, client = tcp_server.clients.popitem()

3554

2798

if use_dbus:

3555

2799

client.remove_from_connection()

3556

# Don't signal the disabling

2800

# Don't signal anything except ClientRemoved

3557

2801

client.disable(quiet=True)

3558

# Emit D-Bus signal for removal

3559

2802

if use_dbus:

3560

mandos_dbus_service.client_removed_signal(client)

2803

# Emit D-Bus signal

2804

mandos_dbus_service.ClientRemoved(client

2805

.dbus_object_path,

2806

client.name)

3561

2807

client_settings.clear()

3562

2808

3563

2809

atexit.register(cleanup)

3564

3565

for client in tcp_server.clients.values():

2810

2811

for client in tcp_server.clients.itervalues():

3566

2812

if use_dbus:

3567

# Emit D-Bus signal for adding

3568

mandos_dbus_service.client_added_signal(client)

2813

# Emit D-Bus signal

2814

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3569

2815

# Need to initiate checking of clients

3570

2816

if client.enabled:

3571

2817

client.init_checker()

3572

2818

3573

2819

tcp_server.enable()

3574

2820

tcp_server.server_activate()

3575

2821

3576

2822

# Find out what port we got

3577

if zeroconf:

3578

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

2823

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

3579

2824

if use_ipv6:

3580

2825

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

3581

2826

" flowinfo %d, scope_id %d",

3583

2828

else: # IPv4

3584

2829

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

3585

2830

*tcp_server.socket.getsockname())

3586

3587

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

3588

2831

2832

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

2833

3589

2834

try:

3590

if zeroconf:

3591

# From the Avahi example code

3592

try:

3593

service.activate()

3594

except dbus.exceptions.DBusException as error:

3595

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

3596

cleanup()

3597

sys.exit(1)

3598

# End of Avahi example code

3599

3600

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

3601

lambda *args, **kwargs:

3602

(tcp_server.handle_request

3603

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

3604

2835

# From the Avahi example code

2836

try:

2837

service.activate()

2838

except dbus.exceptions.DBusException as error:

2839

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

2840

cleanup()

2841

sys.exit(1)

2842

# End of Avahi example code

2843

2844

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

2845

lambda *args, **kwargs:

2846

(tcp_server.handle_request

2847

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

2848

3605

2849

logger.debug("Starting main loop")

3606

2850

main_loop.run()

3607

2851

except AvahiError as error:

3616

2860

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

3617

2861

cleanup()

3618

2862

3619

3620

2863

if __name__ == '__main__':

3621

2864

main()