/mandos/trunk : revision 626

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

if sys.version_info.major == 2:

92

__metaclass__ = type

93

94

# Try to find the value of SO_BINDTODEVICE:

95

83

try:

96

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

97

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

98

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

99

85

except AttributeError:

100

86

try:

101

# This is where SO_BINDTODEVICE was up to and including Python

102

# 2.6, and also 3.2:

103

87

from IN import SO_BINDTODEVICE

104

88

except ImportError:

105

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

106

# Try running the C preprocessor:

107

try:

108

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

109

"/dev/stdin"],

110

stdin=subprocess.PIPE,

111

stdout=subprocess.PIPE)

112

stdout = cc.communicate(

113

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

114

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

115

except (OSError, ValueError, IndexError):

116

# No value found

117

SO_BINDTODEVICE = None

118

119

if sys.version_info.major == 2:

120

str = unicode

121

122

if sys.version_info < (3, 2):

123

configparser.Configparser = configparser.SafeConfigParser

124

125

version = "1.8.7"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.1"

126

92

stored_state_file = "clients.pickle"

127

93

128

94

logger = logging.getLogger()

129

syslogger = None

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

130

98

131

99

try:

132

if_nametoindex = ctypes.cdll.LoadLibrary(

133

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

134

103

except (OSError, AttributeError):

135

136

104

def if_nametoindex(interface):

137

105

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

138

106

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

139

107

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

140

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

141

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

142

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]

143

113

return interface_index

144

114

145

115

146

def copy_function(func):

147

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

148

if sys.version_info.major == 2:

149

return types.FunctionType(func.func_code,

150

func.func_globals,

151

func.func_name,

152

func.func_defaults,

153

func.func_closure)

154

else:

155

return types.FunctionType(func.__code__,

156

func.__globals__,

157

func.__name__,

158

func.__defaults__,

159

func.__closure__)

160

161

162

116

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

163

117

"""init logger and add loglevel"""

164

165

global syslogger

166

syslogger = (logging.handlers.SysLogHandler(

167

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

168

address="/dev/log"))

118

169

119

syslogger.setFormatter(logging.Formatter

170

120

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

171

121

' %(message)s'))

172

122

logger.addHandler(syslogger)

173

123

174

124

if debug:

175

125

console = logging.StreamHandler()

176

126

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

186

136

pass

187

137

188

138

189

class PGPEngine:

139

class PGPEngine(object):

190

140

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

191

192

141

def __init__(self):

193

142

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

194

self.gpg = "gpg"

195

try:

196

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

197

for line in output.splitlines():

198

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

199

if name == "gpg":

200

self.gpg = path

201

break

202

except OSError as e:

203

if e.errno != errno.ENOENT:

204

raise

205

143

self.gnupgargs = ['--batch',

206

'--homedir', self.tempdir,

144

'--home', self.tempdir,

207

145

'--force-mdc',

208

'--quiet']

209

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

210

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

211

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

212

146

'--quiet',

147

'--no-use-agent']

148

213

149

def __enter__(self):

214

150

return self

215

151

216

152

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

217

153

self._cleanup()

218

154

return False

219

155

220

156

def __del__(self):

221

157

self._cleanup()

222

158

223

159

def _cleanup(self):

224

160

if self.tempdir is not None:

225

161

# Delete contents of tempdir

226

162

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

227

topdown=False):

163

topdown = False):

228

164

for filename in files:

229

165

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

230

166

for dirname in dirs:

232

168

# Remove tempdir

233

169

os.rmdir(self.tempdir)

234

170

self.tempdir = None

235

171

236

172

def password_encode(self, password):

237

173

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

238

174

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

239

encoded = b"mandos" + binascii.hexlify(password)

240

if len(encoded) > 2048:

241

# GnuPG can't handle long passwords, so encode differently

242

encoded = (b"mandos" + password.replace(b"\\", b"\\\\")

243

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

244

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

245

return encoded

246

175

return b"mandos" + binascii.hexlify(password)

176

247

177

def encrypt(self, data, password):

248

178

passphrase = self.password_encode(password)

249

with tempfile.NamedTemporaryFile(

250

dir=self.tempdir) as passfile:

179

with tempfile.NamedTemporaryFile(dir=self.tempdir

180

) as passfile:

251

181

passfile.write(passphrase)

252

182

passfile.flush()

253

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

183

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

254

184

'--passphrase-file',

255

185

passfile.name]

256

186

+ self.gnupgargs,

257

stdin=subprocess.PIPE,

258

stdout=subprocess.PIPE,

259

stderr=subprocess.PIPE)

260

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

187

stdin = subprocess.PIPE,

188

stdout = subprocess.PIPE,

189

stderr = subprocess.PIPE)

190

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

261

191

if proc.returncode != 0:

262

192

raise PGPError(err)

263

193

return ciphertext

264

194

265

195

def decrypt(self, data, password):

266

196

passphrase = self.password_encode(password)

267

with tempfile.NamedTemporaryFile(

268

dir=self.tempdir) as passfile:

197

with tempfile.NamedTemporaryFile(dir = self.tempdir

198

) as passfile:

269

199

passfile.write(passphrase)

270

200

passfile.flush()

271

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

201

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

272

202

'--passphrase-file',

273

203

passfile.name]

274

204

+ self.gnupgargs,

275

stdin=subprocess.PIPE,

276

stdout=subprocess.PIPE,

277

stderr=subprocess.PIPE)

278

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

205

stdin = subprocess.PIPE,

206

stdout = subprocess.PIPE,

207

stderr = subprocess.PIPE)

208

decrypted_plaintext, err = proc.communicate(input

209

= data)

279

210

if proc.returncode != 0:

280

211

raise PGPError(err)

281

212

return decrypted_plaintext

282

213

283

214

284

# Pretend that we have an Avahi module

285

class avahi:

286

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

287

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

288

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

289

PROTO_INET = 0 # avahi-common/address.h

290

PROTO_INET6 = 1 # avahi-common/address.h

291

DBUS_NAME = "org.freedesktop.Avahi"

292

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

293

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

294

DBUS_PATH_SERVER = "/"

295

296

@staticmethod

297

def string_array_to_txt_array(t):

298

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

299

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

300

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

301

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

302

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

303

SERVER_INVALID = 0 # avahi-common/defs.h

304

SERVER_REGISTERING = 1 # avahi-common/defs.h

305

SERVER_RUNNING = 2 # avahi-common/defs.h

306

SERVER_COLLISION = 3 # avahi-common/defs.h

307

SERVER_FAILURE = 4 # avahi-common/defs.h

308

309

310

215

class AvahiError(Exception):

311

216

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

312

217

self.value = value

313

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

314

**kwargs)

315

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

316

221

317

222

class AvahiServiceError(AvahiError):

318

223

pass

319

224

320

321

225

class AvahiGroupError(AvahiError):

322

226

pass

323

227

324

228

325

class AvahiService:

229

class AvahiService(object):

326

230

"""An Avahi (Zeroconf) service.

327

231

328

232

Attributes:

329

233

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

330

234

Used to optionally bind to the specified interface.

342

246

server: D-Bus Server

343

247

bus: dbus.SystemBus()

344

248

"""

345

346

def __init__(self,

347

interface=avahi.IF_UNSPEC,

348

name=None,

349

servicetype=None,

350

port=None,

351

TXT=None,

352

domain="",

353

host="",

354

max_renames=32768,

355

protocol=avahi.PROTO_UNSPEC,

356

bus=None):

249

250

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

251

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

252

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

253

protocol = avahi.PROTO_UNSPEC, bus = None):

357

254

self.interface = interface

358

255

self.name = name

359

256

self.type = servicetype

368

265

self.server = None

369

266

self.bus = bus

370

267

self.entry_group_state_changed_match = None

371

372

def rename(self, remove=True):

268

269

def rename(self):

373

270

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

374

271

if self.rename_count >= self.max_renames:

375

272

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

376

273

" after %i retries, exiting.",

377

274

self.rename_count)

378

275

raise AvahiServiceError("Too many renames")

379

self.name = str(

380

self.server.GetAlternativeServiceName(self.name))

381

self.rename_count += 1

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

382

278

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

383

279

self.name)

384

if remove:

385

self.remove()

280

self.remove()

386

281

try:

387

282

self.add()

388

283

except dbus.exceptions.DBusException as error:

389

if (error.get_dbus_name()

390

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

391

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

392

return self.rename(remove=False)

393

else:

394

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

395

self.cleanup()

396

os._exit(1)

397

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

288

398

289

def remove(self):

399

290

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

400

291

if self.entry_group_state_changed_match is not None:

402

293

self.entry_group_state_changed_match = None

403

294

if self.group is not None:

404

295

self.group.Reset()

405

296

406

297

def add(self):

407

298

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

408

299

self.remove()

425

316

dbus.UInt16(self.port),

426

317

avahi.string_array_to_txt_array(self.TXT))

427

318

self.group.Commit()

428

319

429

320

def entry_group_state_changed(self, state, error):

430

321

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

431

322

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

432

323

433

324

if state == avahi.ENTRY_GROUP_ESTABLISHED:

434

325

logger.debug("Zeroconf service established.")

435

326

elif state == avahi.ENTRY_GROUP_COLLISION:

437

328

self.rename()

438

329

elif state == avahi.ENTRY_GROUP_FAILURE:

439

330

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

440

str(error))

441

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

442

331

unicode(error))

332

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

333

.format(error))

334

443

335

def cleanup(self):

444

336

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

445

337

if self.group is not None:

450

342

pass

451

343

self.group = None

452

344

self.remove()

453

345

454

346

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

455

347

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

456

348

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

457

bad_states = {

458

avahi.SERVER_INVALID: "Zeroconf server invalid",

459

avahi.SERVER_REGISTERING: None,

460

avahi.SERVER_COLLISION: "Zeroconf server name collision",

461

avahi.SERVER_FAILURE: "Zeroconf server failure",

462

}

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

463

356

if state in bad_states:

464

357

if bad_states[state] is not None:

465

358

if error is None:

468

361

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

469

362

self.cleanup()

470

363

elif state == avahi.SERVER_RUNNING:

471

try:

472

self.add()

473

except dbus.exceptions.DBusException as error:

474

if (error.get_dbus_name()

475

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

476

logger.info("Local Zeroconf service name"

477

" collision.")

478

return self.rename(remove=False)

479

else:

480

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

481

self.cleanup()

482

os._exit(1)

364

self.add()

483

365

else:

484

366

if error is None:

485

367

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

486

368

else:

487

369

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

488

370

489

371

def activate(self):

490

372

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

491

373

if self.server is None:

495

377

follow_name_owner_changes=True),

496

378

avahi.DBUS_INTERFACE_SERVER)

497

379

self.server.connect_to_signal("StateChanged",

498

self.server_state_changed)

380

self.server_state_changed)

499

381

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

500

382

501

383

502

384

class AvahiServiceToSyslog(AvahiService):

503

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

385

def rename(self):

504

386

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

505

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

506

syslogger.setFormatter(logging.Formatter(

507

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

508

.format(self.name)))

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

509

392

return ret

510

393

511

394

512

# Pretend that we have a GnuTLS module

513

class gnutls:

514

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

515

516

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

517

if library is None:

518

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

519

_library = ctypes.cdll.LoadLibrary(library)

520

del library

521

522

# Unless otherwise indicated, the constants and types below are

523

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

524

525

# Constants

526

E_SUCCESS = 0

527

E_INTERRUPTED = -52

528

E_AGAIN = -28

529

CRT_OPENPGP = 2

530

CRT_RAWPK = 3

531

CLIENT = 2

532

SHUT_RDWR = 0

533

CRD_CERTIFICATE = 1

534

E_NO_CERTIFICATE_FOUND = -49

535

X509_FMT_DER = 0

536

NO_TICKETS = 1<<10

537

ENABLE_RAWPK = 1<<18

538

CTYPE_PEERS = 3

539

KEYID_USE_SHA256 = 1 # gnutls/x509.h

540

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

541

542

# Types

543

class session_int(ctypes.Structure):

544

_fields_ = []

545

session_t = ctypes.POINTER(session_int)

546

547

class certificate_credentials_st(ctypes.Structure):

548

_fields_ = []

549

certificate_credentials_t = ctypes.POINTER(

550

certificate_credentials_st)

551

certificate_type_t = ctypes.c_int

552

553

class datum_t(ctypes.Structure):

554

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

555

('size', ctypes.c_uint)]

556

557

class openpgp_crt_int(ctypes.Structure):

558

_fields_ = []

559

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

560

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

561

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

562

credentials_type_t = ctypes.c_int

563

transport_ptr_t = ctypes.c_void_p

564

close_request_t = ctypes.c_int

565

566

# Exceptions

567

class Error(Exception):

568

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

569

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

570

# code is passed, convert it to a string with

571

# gnutls.strerror()

572

self.code = code

573

if message is None and code is not None:

574

message = gnutls.strerror(code)

575

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

576

message, *args)

577

578

class CertificateSecurityError(Error):

579

pass

580

581

# Classes

582

class Credentials:

583

def __init__(self):

584

self._c_object = gnutls.certificate_credentials_t()

585

gnutls.certificate_allocate_credentials(

586

ctypes.byref(self._c_object))

587

self.type = gnutls.CRD_CERTIFICATE

588

589

def __del__(self):

590

gnutls.certificate_free_credentials(self._c_object)

591

592

class ClientSession:

593

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

594

self._c_object = gnutls.session_t()

595

gnutls_flags = gnutls.CLIENT

596

if gnutls.check_version(b"3.5.6"):

597

gnutls_flags |= gnutls.NO_TICKETS

598

if gnutls.has_rawpk:

599

gnutls_flags |= gnutls.ENABLE_RAWPK

600

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

601

del gnutls_flags

602

gnutls.set_default_priority(self._c_object)

603

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

604

gnutls.handshake_set_private_extensions(self._c_object,

605

True)

606

self.socket = socket

607

if credentials is None:

608

credentials = gnutls.Credentials()

609

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

610

ctypes.cast(credentials._c_object,

611

ctypes.c_void_p))

612

self.credentials = credentials

613

614

def __del__(self):

615

gnutls.deinit(self._c_object)

616

617

def handshake(self):

618

return gnutls.handshake(self._c_object)

619

620

def send(self, data):

621

data = bytes(data)

622

data_len = len(data)

623

while data_len > 0:

624

data_len -= gnutls.record_send(self._c_object,

625

data[-data_len:],

626

data_len)

627

628

def bye(self):

629

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

630

631

# Error handling functions

632

def _error_code(result):

633

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

634

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

635

if result >= 0:

636

return result

637

if result == gnutls.E_NO_CERTIFICATE_FOUND:

638

raise gnutls.CertificateSecurityError(code=result)

639

raise gnutls.Error(code=result)

640

641

def _retry_on_error(result, func, arguments):

642

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

643

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

644

while result < 0:

645

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

646

return _error_code(result)

647

result = func(*arguments)

648

return result

649

650

# Unless otherwise indicated, the function declarations below are

651

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

652

653

# Functions

654

priority_set_direct = _library.gnutls_priority_set_direct

655

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

656

ctypes.POINTER(ctypes.c_char_p)]

657

priority_set_direct.restype = _error_code

658

659

init = _library.gnutls_init

660

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

661

init.restype = _error_code

662

663

set_default_priority = _library.gnutls_set_default_priority

664

set_default_priority.argtypes = [session_t]

665

set_default_priority.restype = _error_code

666

667

record_send = _library.gnutls_record_send

668

record_send.argtypes = [session_t, ctypes.c_void_p,

669

ctypes.c_size_t]

670

record_send.restype = ctypes.c_ssize_t

671

record_send.errcheck = _retry_on_error

672

673

certificate_allocate_credentials = (

674

_library.gnutls_certificate_allocate_credentials)

675

certificate_allocate_credentials.argtypes = [

676

ctypes.POINTER(certificate_credentials_t)]

677

certificate_allocate_credentials.restype = _error_code

678

679

certificate_free_credentials = (

680

_library.gnutls_certificate_free_credentials)

681

certificate_free_credentials.argtypes = [

682

certificate_credentials_t]

683

certificate_free_credentials.restype = None

684

685

handshake_set_private_extensions = (

686

_library.gnutls_handshake_set_private_extensions)

687

handshake_set_private_extensions.argtypes = [session_t,

688

ctypes.c_int]

689

handshake_set_private_extensions.restype = None

690

691

credentials_set = _library.gnutls_credentials_set

692

credentials_set.argtypes = [session_t, credentials_type_t,

693

ctypes.c_void_p]

694

credentials_set.restype = _error_code

695

696

strerror = _library.gnutls_strerror

697

strerror.argtypes = [ctypes.c_int]

698

strerror.restype = ctypes.c_char_p

699

700

certificate_type_get = _library.gnutls_certificate_type_get

701

certificate_type_get.argtypes = [session_t]

702

certificate_type_get.restype = _error_code

703

704

certificate_get_peers = _library.gnutls_certificate_get_peers

705

certificate_get_peers.argtypes = [session_t,

706

ctypes.POINTER(ctypes.c_uint)]

707

certificate_get_peers.restype = ctypes.POINTER(datum_t)

708

709

global_set_log_level = _library.gnutls_global_set_log_level

710

global_set_log_level.argtypes = [ctypes.c_int]

711

global_set_log_level.restype = None

712

713

global_set_log_function = _library.gnutls_global_set_log_function

714

global_set_log_function.argtypes = [log_func]

715

global_set_log_function.restype = None

716

717

deinit = _library.gnutls_deinit

718

deinit.argtypes = [session_t]

719

deinit.restype = None

720

721

handshake = _library.gnutls_handshake

722

handshake.argtypes = [session_t]

723

handshake.restype = _error_code

724

handshake.errcheck = _retry_on_error

725

726

transport_set_ptr = _library.gnutls_transport_set_ptr

727

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

728

transport_set_ptr.restype = None

729

730

bye = _library.gnutls_bye

731

bye.argtypes = [session_t, close_request_t]

732

bye.restype = _error_code

733

bye.errcheck = _retry_on_error

734

735

check_version = _library.gnutls_check_version

736

check_version.argtypes = [ctypes.c_char_p]

737

check_version.restype = ctypes.c_char_p

738

739

_need_version = b"3.3.0"

740

if check_version(_need_version) is None:

741

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

742

.format(_need_version))

743

744

_tls_rawpk_version = b"3.6.6"

745

has_rawpk = bool(check_version(_tls_rawpk_version))

746

747

if has_rawpk:

748

# Types

749

class pubkey_st(ctypes.Structure):

750

_fields = []

751

pubkey_t = ctypes.POINTER(pubkey_st)

752

753

x509_crt_fmt_t = ctypes.c_int

754

755

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

756

pubkey_init = _library.gnutls_pubkey_init

757

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

758

pubkey_init.restype = _error_code

759

760

pubkey_import = _library.gnutls_pubkey_import

761

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

762

x509_crt_fmt_t]

763

pubkey_import.restype = _error_code

764

765

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

766

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

767

ctypes.POINTER(ctypes.c_ubyte),

768

ctypes.POINTER(ctypes.c_size_t)]

769

pubkey_get_key_id.restype = _error_code

770

771

pubkey_deinit = _library.gnutls_pubkey_deinit

772

pubkey_deinit.argtypes = [pubkey_t]

773

pubkey_deinit.restype = None

774

else:

775

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

776

777

openpgp_crt_init = _library.gnutls_openpgp_crt_init

778

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

779

openpgp_crt_init.restype = _error_code

780

781

openpgp_crt_import = _library.gnutls_openpgp_crt_import

782

openpgp_crt_import.argtypes = [openpgp_crt_t,

783

ctypes.POINTER(datum_t),

784

openpgp_crt_fmt_t]

785

openpgp_crt_import.restype = _error_code

786

787

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

788

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

789

ctypes.POINTER(ctypes.c_uint)]

790

openpgp_crt_verify_self.restype = _error_code

791

792

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

793

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

794

openpgp_crt_deinit.restype = None

795

796

openpgp_crt_get_fingerprint = (

797

_library.gnutls_openpgp_crt_get_fingerprint)

798

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

799

ctypes.c_void_p,

800

ctypes.POINTER(

801

ctypes.c_size_t)]

802

openpgp_crt_get_fingerprint.restype = _error_code

803

804

if check_version(b"3.6.4"):

805

certificate_type_get2 = _library.gnutls_certificate_type_get2

806

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

807

certificate_type_get2.restype = _error_code

808

809

# Remove non-public functions

810

del _error_code, _retry_on_error

811

812

813

def call_pipe(connection, # : multiprocessing.Connection

814

func, *args, **kwargs):

815

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

816

817

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

818

return value on the provided multiprocessing.Connection.

819

"""

820

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

821

connection.close()

822

823

824

class Client:

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

400

401

402

class Client(object):

825

403

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

826

404

827

405

Attributes:

828

406

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

829

407

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

830

408

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

831

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

832

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

833

running.

834

checker_callback_tag: a GLib event source tag, or None

409

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

410

to see if the client lives.

411

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

835

413

checker_command: string; External command which is run to check

836

414

if client lives. %() expansions are done at

837

415

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

838

416

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

839

checker_initiator_tag: a GLib event source tag, or None

417

checker_initiator_tag: a gobject event source tag, or None

840

418

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

841

419

client_structure: Object describing what attributes a client has

842

420

and is used for storing the client at exit

843

421

current_checker_command: string; current running checker_command

844

disable_initiator_tag: a GLib event source tag, or None

422

disable_initiator_tag: a gobject event source tag, or None

845

423

enabled: bool()

846

424

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

847

uniquely identify an OpenPGP client

848

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

849

a client using raw public keys

425

uniquely identify the client

850

426

host: string; available for use by the checker command

851

427

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

852

428

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

854

430

last_checker_status: integer between 0 and 255 reflecting exit

855

431

status of last checker. -1 reflects crashed

856

432

checker, -2 means no checker completed yet.

857

last_checker_signal: The signal which killed the last checker, if

858

last_checker_status is -1

859

433

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

860

434

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

861

435

D-Bus identifiers

868

442

disabled, or None

869

443

server_settings: The server_settings dict from main()

870

444

"""

871

445

872

446

runtime_expansions = ("approval_delay", "approval_duration",

873

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

447

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

874

448

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

875

449

"last_approval_request", "last_checked_ok",

876

450

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

877

client_defaults = {

878

"timeout": "PT5M",

879

"extended_timeout": "PT15M",

880

"interval": "PT2M",

881

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

882

"host": "",

883

"approval_delay": "PT0S",

884

"approval_duration": "PT1S",

885

"approved_by_default": "True",

886

"enabled": "True",

887

}

888

451

client_defaults = { "timeout": "PT5M",

452

"extended_timeout": "PT15M",

453

"interval": "PT2M",

454

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

455

"host": "",

456

"approval_delay": "PT0S",

457

"approval_duration": "PT1S",

458

"approved_by_default": "True",

459

"enabled": "True",

460

}

461

462

def timeout_milliseconds(self):

463

"Return the 'timeout' attribute in milliseconds"

464

return timedelta_to_milliseconds(self.timeout)

465

466

def extended_timeout_milliseconds(self):

467

"Return the 'extended_timeout' attribute in milliseconds"

468

return timedelta_to_milliseconds(self.extended_timeout)

469

470

def interval_milliseconds(self):

471

"Return the 'interval' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.interval)

473

474

def approval_delay_milliseconds(self):

475

return timedelta_to_milliseconds(self.approval_delay)

476

889

477

@staticmethod

890

478

def config_parser(config):

891

479

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

898

486

for client_name in config.sections():

899

487

section = dict(config.items(client_name))

900

488

client = settings[client_name] = {}

901

489

902

490

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

903

491

# Reformat values from string types to Python types

904

492

client["approved_by_default"] = config.getboolean(

905

493

client_name, "approved_by_default")

906

494

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

907

495

"enabled")

908

909

# Uppercase and remove spaces from key_id and fingerprint

910

# for later comparison purposes with return value from the

911

# key_id() and fingerprint() functions

912

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

913

.replace(" ", ""))

496

914

497

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

915

498

.replace(" ", ""))

916

499

if "secret" in section:

917

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

918

.encode("utf-8"),

919

"base64")

500

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

920

501

elif "secfile" in section:

921

502

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

922

503

(section["secfile"])),

923

504

"rb") as secfile:

924

505

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

925

506

else:

926

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

507

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

927

508

.format(section))

928

509

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

929

510

client["extended_timeout"] = string_to_delta(

937

518

client["last_approval_request"] = None

938

519

client["last_checked_ok"] = None

939

520

client["last_checker_status"] = -2

940

521

941

522

return settings

942

943

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

523

524

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

944

525

self.name = name

945

526

if server_settings is None:

946

527

server_settings = {}

947

528

self.server_settings = server_settings

948

529

# adding all client settings

949

for setting, value in settings.items():

530

for setting, value in settings.iteritems():

950

531

setattr(self, setting, value)

951

532

952

533

if self.enabled:

953

534

if not hasattr(self, "last_enabled"):

954

535

self.last_enabled = datetime.datetime.utcnow()

958

539

else:

959

540

self.last_enabled = None

960

541

self.expires = None

961

542

962

543

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

963

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

544

# Uppercase and remove spaces from fingerprint for later

545

# comparison purposes with return value from the fingerprint()

546

# function

964

547

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

965

548

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

966

549

datetime.datetime.utcnow())

967

550

968

551

# attributes specific for this server instance

969

552

self.checker = None

970

553

self.checker_initiator_tag = None

973

556

self.current_checker_command = None

974

557

self.approved = None

975

558

self.approvals_pending = 0

976

self.changedstate = multiprocessing_manager.Condition(

977

multiprocessing_manager.Lock())

978

self.client_structure = [attr

979

for attr in self.__dict__.keys()

559

self.changedstate = (multiprocessing_manager

560

.Condition(multiprocessing_manager

561

.Lock()))

562

self.client_structure = [attr for attr in

563

self.__dict__.iterkeys()

980

564

if not attr.startswith("_")]

981

565

self.client_structure.append("client_structure")

982

983

for name, t in inspect.getmembers(

984

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

566

567

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

568

lambda obj:

569

isinstance(obj,

570

property)):

985

571

if not name.startswith("_"):

986

572

self.client_structure.append(name)

987

573

988

574

# Send notice to process children that client state has changed

989

575

def send_changedstate(self):

990

576

with self.changedstate:

991

577

self.changedstate.notify_all()

992

578

993

579

def enable(self):

994

580

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

995

581

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

1000

586

self.last_enabled = datetime.datetime.utcnow()

1001

587

self.init_checker()

1002

588

self.send_changedstate()

1003

589

1004

590

def disable(self, quiet=True):

1005

591

"""Disable this client."""

1006

592

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

1008

594

if not quiet:

1009

595

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

1010

596

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

1011

GLib.source_remove(self.disable_initiator_tag)

597

gobject.source_remove(self.disable_initiator_tag)

1012

598

self.disable_initiator_tag = None

1013

599

self.expires = None

1014

600

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

1015

GLib.source_remove(self.checker_initiator_tag)

601

gobject.source_remove(self.checker_initiator_tag)

1016

602

self.checker_initiator_tag = None

1017

603

self.stop_checker()

1018

604

self.enabled = False

1019

605

if not quiet:

1020

606

self.send_changedstate()

1021

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

607

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

1022

608

return False

1023

609

1024

610

def __del__(self):

1025

611

self.disable()

1026

612

1027

613

def init_checker(self):

1028

614

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

1029

615

# and every interval from then on.

1030

616

if self.checker_initiator_tag is not None:

1031

GLib.source_remove(self.checker_initiator_tag)

1032

self.checker_initiator_tag = GLib.timeout_add(

1033

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

1034

self.start_checker)

617

gobject.source_remove(self.checker_initiator_tag)

618

self.checker_initiator_tag = (gobject.timeout_add

619

(self.interval_milliseconds(),

620

self.start_checker))

1035

621

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

1036

622

if self.disable_initiator_tag is not None:

1037

GLib.source_remove(self.disable_initiator_tag)

1038

self.disable_initiator_tag = GLib.timeout_add(

1039

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

623

gobject.source_remove(self.disable_initiator_tag)

624

self.disable_initiator_tag = (gobject.timeout_add

625

(self.timeout_milliseconds(),

626

self.disable))

1040

627

# Also start a new checker *right now*.

1041

628

self.start_checker()

1042

1043

def checker_callback(self, source, condition, connection,

1044

command):

629

630

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

1045

631

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

1046

# Read return code from connection (see call_pipe)

1047

returncode = connection.recv()

1048

connection.close()

1049

self.checker.join()

1050

632

self.checker_callback_tag = None

1051

633

self.checker = None

1052

1053

if returncode >= 0:

1054

self.last_checker_status = returncode

1055

self.last_checker_signal = None

634

if os.WIFEXITED(condition):

635

self.last_checker_status = os.WEXITSTATUS(condition)

1056

636

if self.last_checker_status == 0:

1057

637

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

1058

638

vars(self))

1059

639

self.checked_ok()

1060

640

else:

1061

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

641

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

642

vars(self))

1062

643

else:

1063

644

self.last_checker_status = -1

1064

self.last_checker_signal = -returncode

1065

645

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

1066

646

vars(self))

1067

return False

1068

647

1069

648

def checked_ok(self):

1070

649

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

1071

650

self.last_checked_ok = datetime.datetime.utcnow()

1072

651

self.last_checker_status = 0

1073

self.last_checker_signal = None

1074

652

self.bump_timeout()

1075

653

1076

654

def bump_timeout(self, timeout=None):

1077

655

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

1078

656

if timeout is None:

1079

657

timeout = self.timeout

1080

658

if self.disable_initiator_tag is not None:

1081

GLib.source_remove(self.disable_initiator_tag)

659

gobject.source_remove(self.disable_initiator_tag)

1082

660

self.disable_initiator_tag = None

1083

661

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

1084

self.disable_initiator_tag = GLib.timeout_add(

1085

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

662

self.disable_initiator_tag = (gobject.timeout_add

663

(timedelta_to_milliseconds

664

(timeout), self.disable))

1086

665

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

1087

666

1088

667

def need_approval(self):

1089

668

self.last_approval_request = datetime.datetime.utcnow()

1090

669

1091

670

def start_checker(self):

1092

671

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

1093

672

1094

673

If a checker already exists, leave it running and do

1095

674

nothing."""

1096

675

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

1101

680

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

1102

681

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

1103

682

# should be.

1104

1105

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

1106

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

1107

self.checker.join()

1108

self.checker = None

683

684

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

685

try:

686

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

687

except (AttributeError, OSError) as error:

688

if (isinstance(error, OSError)

689

and error.errno != errno.ECHILD):

690

raise error

691

else:

692

if pid:

693

logger.warning("Checker was a zombie")

694

gobject.source_remove(self.checker_callback_tag)

695

self.checker_callback(pid, status,

696

self.current_checker_command)

1109

697

# Start a new checker if needed

1110

698

if self.checker is None:

1111

699

# Escape attributes for the shell

1112

escaped_attrs = {

1113

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

1114

for attr in self.runtime_expansions}

700

escaped_attrs = dict(

701

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

702

for attr in

703

self.runtime_expansions)

1115

704

try:

1116

705

command = self.checker_command % escaped_attrs

1117

706

except TypeError as error:

1118

707

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

1119

self.checker_command,

708

self.checker_command, exc_info=error)

709

return True # Try again later

710

self.current_checker_command = command

711

try:

712

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

713

command, self.name)

714

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

715

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

716

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

717

# always replaced by /dev/null.)

718

# The exception is when not debugging but nevertheless

719

# running in the foreground; use the previously

720

# created wnull.

721

popen_args = {}

722

if (not self.server_settings["debug"]

723

and self.server_settings["foreground"]):

724

popen_args.update({"stdout": wnull,

725

"stderr": wnull })

726

self.checker = subprocess.Popen(command,

727

close_fds=True,

728

shell=True, cwd="/",

729

**popen_args)

730

except OSError as error:

731

logger.error("Failed to start subprocess",

1120

732

exc_info=error)

1121

return True # Try again later

1122

self.current_checker_command = command

1123

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

1124

self.name)

1125

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

1126

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

1127

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

1128

# always replaced by /dev/null.)

1129

# The exception is when not debugging but nevertheless

1130

# running in the foreground; use the previously

1131

# created wnull.

1132

popen_args = {"close_fds": True,

1133

"shell": True,

1134

"cwd": "/"}

1135

if (not self.server_settings["debug"]

1136

and self.server_settings["foreground"]):

1137

popen_args.update({"stdout": wnull,

1138

"stderr": wnull})

1139

pipe = multiprocessing.Pipe(duplex=False)

1140

self.checker = multiprocessing.Process(

1141

target=call_pipe,

1142

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

1143

kwargs=popen_args)

1144

self.checker.start()

1145

self.checker_callback_tag = GLib.io_add_watch(

1146

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

1147

self.checker_callback, pipe[0], command)

1148

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

733

return True

734

self.checker_callback_tag = (gobject.child_watch_add

735

(self.checker.pid,

736

self.checker_callback,

737

data=command))

738

# The checker may have completed before the gobject

739

# watch was added. Check for this.

740

try:

741

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

742

except OSError as error:

743

if error.errno == errno.ECHILD:

744

# This should never happen

745

logger.error("Child process vanished",

746

exc_info=error)

747

return True

748

raise

749

if pid:

750

gobject.source_remove(self.checker_callback_tag)

751

self.checker_callback(pid, status, command)

752

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

1149

753

return True

1150

754

1151

755

def stop_checker(self):

1152

756

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

1153

757

if self.checker_callback_tag:

1154

GLib.source_remove(self.checker_callback_tag)

758

gobject.source_remove(self.checker_callback_tag)

1155

759

self.checker_callback_tag = None

1156

760

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

1157

761

return

1158

762

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

1159

self.checker.terminate()

763

try:

764

self.checker.terminate()

765

#time.sleep(0.5)

766

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

767

# self.checker.kill()

768

except OSError as error:

769

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

770

raise

1160

771

self.checker = None

1161

772

1162

773

1163

def dbus_service_property(dbus_interface,

1164

signature="v",

1165

access="readwrite",

1166

byte_arrays=False):

774

def dbus_service_property(dbus_interface, signature="v",

775

access="readwrite", byte_arrays=False):

1167

776

"""Decorators for marking methods of a DBusObjectWithProperties to

1168

777

become properties on the D-Bus.

1169

778

1170

779

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

1171

780

and with one argument by "Set".

1172

781

1173

782

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

1174

783

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

1175

784

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

1178

787

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

1179

788

if byte_arrays and signature != "ay":

1180

789

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

1181

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

1182

790

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

1183

791

def decorator(func):

1184

792

func._dbus_is_property = True

1185

793

func._dbus_interface = dbus_interface

1188

796

func._dbus_name = func.__name__

1189

797

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

1190

798

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

1191

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

799

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1192

800

return func

1193

1194

801

return decorator

1195

802

1196

803

1197

804

def dbus_interface_annotations(dbus_interface):

1198

805

"""Decorator for marking functions returning interface annotations

1199

806

1200

807

Usage:

1201

808

1202

809

@dbus_interface_annotations("org.example.Interface")

1203

810

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

1204

811

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

1205

812

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

1206

813

"false"}

1207

814

"""

1208

1209

815

def decorator(func):

1210

816

func._dbus_is_interface = True

1211

817

func._dbus_interface = dbus_interface

1212

818

func._dbus_name = dbus_interface

1213

819

return func

1214

1215

820

return decorator

1216

821

1217

822

1218

823

def dbus_annotations(annotations):

1219

824

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

1220

825

Usage:

1221

1222

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

1223

"org.freedesktop.DBus.Property."

1224

"EmitsChangedSignal": "false"})

826

1225

827

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

1226

828

access="r")

829

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

830

"org.freedesktop.DBus.Property."

831

"EmitsChangedSignal": "false"})

1227

832

def Property_dbus_property(self):

1228

833

return dbus.Boolean(False)

1229

1230

See also the DBusObjectWithAnnotations class.

1231

834

"""

1232

1233

835

def decorator(func):

1234

836

func._dbus_annotations = annotations

1235

837

return func

1236

1237

838

return decorator

1238

839

1239

840

1240

841

class DBusPropertyException(dbus.exceptions.DBusException):

1241

842

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

1242

843

"""

1243

pass

844

def __unicode__(self):

845

return unicode(str(self))

1244

846

1245

847

1246

848

class DBusPropertyAccessException(DBusPropertyException):

1255

857

pass

1256

858

1257

859

1258

class DBusObjectWithAnnotations(dbus.service.Object):

1259

"""A D-Bus object with annotations.

1260

1261

Classes inheriting from this can use the dbus_annotations

1262

decorator to add annotations to methods or signals.

860

class DBusObjectWithProperties(dbus.service.Object):

861

"""A D-Bus object with properties.

862

863

Classes inheriting from this can use the dbus_service_property

864

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

865

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

1263

866

"""

1264

867

1265

868

@staticmethod

1266

869

def _is_dbus_thing(thing):

1267

870

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

1268

871

1269

872

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

1270

873

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

1271

874

"""

1272

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

875

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

1273

876

False)

1274

877

1275

878

def _get_all_dbus_things(self, thing):

1276

879

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

1277

880

"""

1278

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

881

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

882

name),

1279

883

athing.__get__(self))

1280

884

for cls in self.__class__.__mro__

1281

885

for name, athing in

1282

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

1283

1284

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1285

out_signature="s",

1286

path_keyword='object_path',

1287

connection_keyword='connection')

1288

def Introspect(self, object_path, connection):

1289

"""Overloading of standard D-Bus method.

1290

1291

Inserts annotation tags on methods and signals.

1292

"""

1293

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

1294

connection)

1295

try:

1296

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

1297

1298

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

1299

# Add annotation tags

1300

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

1301

for tag in if_tag.getElementsByTagName(typ):

1302

annots = dict()

1303

for name, prop in (self.

1304

_get_all_dbus_things(typ)):

1305

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

1306

and prop._dbus_interface

1307

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

1308

annots.update(getattr(

1309

prop, "_dbus_annotations", {}))

1310

for name, value in annots.items():

1311

ann_tag = document.createElement(

1312

"annotation")

1313

ann_tag.setAttribute("name", name)

1314

ann_tag.setAttribute("value", value)

1315

tag.appendChild(ann_tag)

1316

# Add interface annotation tags

1317

for annotation, value in dict(

1318

itertools.chain.from_iterable(

1319

annotations().items()

1320

for name, annotations

1321

in self._get_all_dbus_things("interface")

1322

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

1323

)).items():

1324

ann_tag = document.createElement("annotation")

1325

ann_tag.setAttribute("name", annotation)

1326

ann_tag.setAttribute("value", value)

1327

if_tag.appendChild(ann_tag)

1328

# Fix argument name for the Introspect method itself

1329

if (if_tag.getAttribute("name")

1330

== dbus.INTROSPECTABLE_IFACE):

1331

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

1332

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

1333

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

1334

if (arg.getAttribute("direction")

1335

== "out"):

1336

arg.setAttribute("name",

1337

"xml_data")

1338

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

1339

document.unlink()

1340

except (AttributeError, xml.dom.DOMException,

1341

xml.parsers.expat.ExpatError) as error:

1342

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

1343

exc_info=error)

1344

return xmlstring

1345

1346

1347

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1348

"""A D-Bus object with properties.

1349

1350

Classes inheriting from this can use the dbus_service_property

1351

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

1352

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

1353

"""

1354

886

inspect.getmembers(cls,

887

self._is_dbus_thing(thing)))

888

1355

889

def _get_dbus_property(self, interface_name, property_name):

1356

890

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

1357

891

property with the specified name and interface.

1358

892

"""

1359

for cls in self.__class__.__mro__:

1360

for name, value in inspect.getmembers(

1361

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

893

for cls in self.__class__.__mro__:

894

for name, value in (inspect.getmembers

895

(cls,

896

self._is_dbus_thing("property"))):

1362

897

if (value._dbus_name == property_name

1363

898

and value._dbus_interface == interface_name):

1364

899

return value.__get__(self)

1365

900

1366

901

# No such property

1367

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

1368

self.dbus_object_path, interface_name, property_name))

1369

1370

@classmethod

1371

def _get_all_interface_names(cls):

1372

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

1373

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

1374

"_dbus_interface", None)

1375

for x in (inspect.getmro(cls))

1376

for attr in dir(x))

1377

if name is not None)

1378

1379

@dbus.service.method(dbus.PROPERTIES_IFACE,

1380

in_signature="ss",

902

raise DBusPropertyNotFound(self.dbus_object_path + ":"

903

+ interface_name + "."

904

+ property_name)

905

906

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

1381

907

out_signature="v")

1382

908

def Get(self, interface_name, property_name):

1383

909

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

1389

915

if not hasattr(value, "variant_level"):

1390

916

return value

1391

917

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

1392

918

1393

919

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

1394

920

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

1395

921

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

1401

927

# The byte_arrays option is not supported yet on

1402

928

# signatures other than "ay".

1403

929

if prop._dbus_signature != "ay":

1404

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

1405

"'ay' signature {!r}"

1406

.format(prop._dbus_signature))

930

raise ValueError

1407

931

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

1408

932

for byte in value))

1409

933

prop(value)

1410

1411

@dbus.service.method(dbus.PROPERTIES_IFACE,

1412

in_signature="s",

934

935

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

1413

936

out_signature="a{sv}")

1414

937

def GetAll(self, interface_name):

1415

938

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

1416

939

standard.

1417

940

1418

941

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

1419

942

"""

1420

943

properties = {}

1430

953

if not hasattr(value, "variant_level"):

1431

954

properties[name] = value

1432

955

continue

1433

properties[name] = type(value)(

1434

value, variant_level=value.variant_level + 1)

956

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

957

value.variant_level+1)

1435

958

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

1436

1437

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

1438

def PropertiesChanged(self, interface_name, changed_properties,

1439

invalidated_properties):

1440

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

1441

standard.

1442

"""

1443

pass

1444

959

1445

960

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1446

961

out_signature="s",

1447

962

path_keyword='object_path',

1448

963

connection_keyword='connection')

1449

964

def Introspect(self, object_path, connection):

1450

965

"""Overloading of standard D-Bus method.

1451

966

1452

967

Inserts property tags and interface annotation tags.

1453

968

"""

1454

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1455

object_path,

1456

connection)

969

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

970

connection)

1457

971

try:

1458

972

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

1459

1460

973

def make_tag(document, name, prop):

1461

974

e = document.createElement("property")

1462

975

e.setAttribute("name", name)

1463

976

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

1464

977

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

1465

978

return e

1466

1467

979

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

1468

980

# Add property tags

1469

981

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

1472

984

if prop._dbus_interface

1473

985

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

1474

986

if_tag.appendChild(tag)

1475

# Add annotation tags for properties

1476

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

1477

annots = dict()

1478

for name, prop in self._get_all_dbus_things(

1479

"property"):

1480

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

1481

and prop._dbus_interface

1482

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

1483

annots.update(getattr(

1484

prop, "_dbus_annotations", {}))

1485

for name, value in annots.items():

1486

ann_tag = document.createElement(

1487

"annotation")

1488

ann_tag.setAttribute("name", name)

1489

ann_tag.setAttribute("value", value)

1490

tag.appendChild(ann_tag)

987

# Add annotation tags

988

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

989

for tag in if_tag.getElementsByTagName(typ):

990

annots = dict()

991

for name, prop in (self.

992

_get_all_dbus_things(typ)):

993

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

994

and prop._dbus_interface

995

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

996

annots.update(getattr

997

(prop,

998

"_dbus_annotations",

999

{}))

1000

for name, value in annots.iteritems():

1001

ann_tag = document.createElement(

1002

"annotation")

1003

ann_tag.setAttribute("name", name)

1004

ann_tag.setAttribute("value", value)

1005

tag.appendChild(ann_tag)

1006

# Add interface annotation tags

1007

for annotation, value in dict(

1008

itertools.chain.from_iterable(

1009

annotations().iteritems()

1010

for name, annotations in

1011

self._get_all_dbus_things("interface")

1012

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

1013

)).iteritems():

1014

ann_tag = document.createElement("annotation")

1015

ann_tag.setAttribute("name", annotation)

1016

ann_tag.setAttribute("value", value)

1017

if_tag.appendChild(ann_tag)

1491

1018

# Add the names to the return values for the

1492

1019

# "org.freedesktop.DBus.Properties" methods

1493

1020

if (if_tag.getAttribute("name")

1512

1039

return xmlstring

1513

1040

1514

1041

1515

try:

1516

dbus.OBJECT_MANAGER_IFACE

1517

except AttributeError:

1518

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

1519

1520

1521

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1522

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

1523

1524

Classes inheriting from this exposes the standard

1525

GetManagedObjects call and the InterfacesAdded and

1526

InterfacesRemoved signals on the standard

1527

"org.freedesktop.DBus.ObjectManager" interface.

1528

1529

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

1530

manually.

1531

"""

1532

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1533

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

1534

def GetManagedObjects(self):

1535

"""This function must be overridden"""

1536

raise NotImplementedError()

1537

1538

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1539

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

1540

def InterfacesAdded(self, object_path, interfaces_and_properties):

1541

pass

1542

1543

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

1544

def InterfacesRemoved(self, object_path, interfaces):

1545

pass

1546

1547

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1548

out_signature="s",

1549

path_keyword='object_path',

1550

connection_keyword='connection')

1551

def Introspect(self, object_path, connection):

1552

"""Overloading of standard D-Bus method.

1553

1554

Override return argument name of GetManagedObjects to be

1555

"objpath_interfaces_and_properties"

1556

"""

1557

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1558

object_path,

1559

connection)

1560

try:

1561

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

1562

1563

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

1564

# Fix argument name for the GetManagedObjects method

1565

if (if_tag.getAttribute("name")

1566

== dbus.OBJECT_MANAGER_IFACE):

1567

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

1568

if (cn.getAttribute("name")

1569

== "GetManagedObjects"):

1570

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

1571

if (arg.getAttribute("direction")

1572

== "out"):

1573

arg.setAttribute(

1574

"name",

1575

"objpath_interfaces"

1576

"_and_properties")

1577

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

1578

document.unlink()

1579

except (AttributeError, xml.dom.DOMException,

1580

xml.parsers.expat.ExpatError) as error:

1581

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

1582

exc_info=error)

1583

return xmlstring

1584

1585

1586

1042

def datetime_to_dbus(dt, variant_level=0):

1587

1043

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

1588

1044

if dt is None:

1589

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

1590

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

1045

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

1046

return dbus.String(dt.isoformat(),

1047

variant_level=variant_level)

1591

1048

1592

1049

1593

1050

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1595

1052

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

1596

1053

interface names according to the "alt_interface_names" mapping.

1597

1054

Usage:

1598

1055

1599

1056

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

1600

1057

"net.example.AlternateInterface"})

1601

1058

class SampleDBusObject(dbus.service.Object):

1602

1059

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

1603

1060

def SampleDBusMethod():

1604

1061

pass

1605

1062

1606

1063

The above "SampleDBusMethod" on "SampleDBusObject" will be

1607

1064

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

1608

1065

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

1609

1066

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

1610

1067

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

1611

1068

1612

1069

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

1613

1070

(from DBusObjectWithProperties) and interfaces (from the

1614

1071

dbus_interface_annotations decorator).

1615

1072

"""

1616

1617

1073

def wrapper(cls):

1618

1074

for orig_interface_name, alt_interface_name in (

1619

alt_interface_names.items()):

1075

alt_interface_names.iteritems()):

1620

1076

attr = {}

1621

1077

interface_names = set()

1622

1078

# Go though all attributes of the class

1624

1080

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

1625

1081

# with the wrong interface name

1626

1082

if (not hasattr(attribute, "_dbus_interface")

1627

or not attribute._dbus_interface.startswith(

1628

orig_interface_name)):

1083

or not attribute._dbus_interface

1084

.startswith(orig_interface_name)):

1629

1085

continue

1630

1086

# Create an alternate D-Bus interface name based on

1631

1087

# the current name

1632

alt_interface = attribute._dbus_interface.replace(

1633

orig_interface_name, alt_interface_name)

1088

alt_interface = (attribute._dbus_interface

1089

.replace(orig_interface_name,

1090

alt_interface_name))

1634

1091

interface_names.add(alt_interface)

1635

1092

# Is this a D-Bus signal?

1636

1093

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

1637

1094

# Extract the original non-method undecorated

1638

1095

# function by black magic

1639

if sys.version_info.major == 2:

1640

nonmethod_func = (dict(

1096

nonmethod_func = (dict(

1641

1097

zip(attribute.func_code.co_freevars,

1642

attribute.__closure__))

1643

["func"].cell_contents)

1644

else:

1645

nonmethod_func = (dict(

1646

zip(attribute.__code__.co_freevars,

1647

attribute.__closure__))

1648

["func"].cell_contents)

1098

attribute.__closure__))["func"]

1099

.cell_contents)

1649

1100

# Create a new, but exactly alike, function

1650

1101

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

1651

1102

# with the alternate D-Bus interface name

1652

new_function = copy_function(nonmethod_func)

1653

new_function = (dbus.service.signal(

1654

alt_interface,

1655

attribute._dbus_signature)(new_function))

1103

new_function = (dbus.service.signal

1104

(alt_interface,

1105

attribute._dbus_signature)

1106

(types.FunctionType(

1107

nonmethod_func.func_code,

1108

nonmethod_func.func_globals,

1109

nonmethod_func.func_name,

1110

nonmethod_func.func_defaults,

1111

nonmethod_func.func_closure)))

1656

1112

# Copy annotations, if any

1657

1113

try:

1658

new_function._dbus_annotations = dict(

1659

attribute._dbus_annotations)

1114

new_function._dbus_annotations = (

1115

dict(attribute._dbus_annotations))

1660

1116

except AttributeError:

1661

1117

pass

1662

1663

1118

# Define a creator of a function to call both the

1664

1119

# original and alternate functions, so both the

1665

1120

# original and alternate signals gets sent when

1668

1123

"""This function is a scope container to pass

1669

1124

func1 and func2 to the "call_both" function

1670

1125

outside of its arguments"""

1671

1672

@functools.wraps(func2)

1673

1126

def call_both(*args, **kwargs):

1674

1127

"""This function will emit two D-Bus

1675

1128

signals by calling func1 and func2"""

1676

1129

func1(*args, **kwargs)

1677

1130

func2(*args, **kwargs)

1678

# Make wrapper function look like a D-Bus

1679

# signal

1680

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

1681

if name.startswith("_dbus_"):

1682

setattr(call_both, name, attr)

1683

1684

1131

return call_both

1685

1132

# Create the "call_both" function and add it to

1686

1133

# the class

1691

1138

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

1692

1139

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

1693

1140

# to the class.

1694

attr[attrname] = (

1695

dbus.service.method(

1696

alt_interface,

1697

attribute._dbus_in_signature,

1698

attribute._dbus_out_signature)

1699

(copy_function(attribute)))

1141

attr[attrname] = (dbus.service.method

1142

(alt_interface,

1143

attribute._dbus_in_signature,

1144

attribute._dbus_out_signature)

1145

(types.FunctionType

1146

(attribute.func_code,

1147

attribute.func_globals,

1148

attribute.func_name,

1149

attribute.func_defaults,

1150

attribute.func_closure)))

1700

1151

# Copy annotations, if any

1701

1152

try:

1702

attr[attrname]._dbus_annotations = dict(

1703

attribute._dbus_annotations)

1153

attr[attrname]._dbus_annotations = (

1154

dict(attribute._dbus_annotations))

1704

1155

except AttributeError:

1705

1156

pass

1706

1157

# Is this a D-Bus property?

1709

1160

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

1710

1161

# property with the alternate D-Bus interface

1711

1162

# name. Add it to the class.

1712

attr[attrname] = (dbus_service_property(

1713

alt_interface, attribute._dbus_signature,

1714

attribute._dbus_access,

1715

attribute._dbus_get_args_options

1716

["byte_arrays"])

1717

(copy_function(attribute)))

1163

attr[attrname] = (dbus_service_property

1164

(alt_interface,

1165

attribute._dbus_signature,

1166

attribute._dbus_access,

1167

attribute

1168

._dbus_get_args_options

1169

["byte_arrays"])

1170

(types.FunctionType

1171

(attribute.func_code,

1172

attribute.func_globals,

1173

attribute.func_name,

1174

attribute.func_defaults,

1175

attribute.func_closure)))

1718

1176

# Copy annotations, if any

1719

1177

try:

1720

attr[attrname]._dbus_annotations = dict(

1721

attribute._dbus_annotations)

1178

attr[attrname]._dbus_annotations = (

1179

dict(attribute._dbus_annotations))

1722

1180

except AttributeError:

1723

1181

pass

1724

1182

# Is this a D-Bus interface?

1727

1185

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

1728

1186

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

1729

1187

# to the class.

1730

attr[attrname] = (

1731

dbus_interface_annotations(alt_interface)

1732

(copy_function(attribute)))

1188

attr[attrname] = (dbus_interface_annotations

1189

(alt_interface)

1190

(types.FunctionType

1191

(attribute.func_code,

1192

attribute.func_globals,

1193

attribute.func_name,

1194

attribute.func_defaults,

1195

attribute.func_closure)))

1733

1196

if deprecate:

1734

1197

# Deprecate all alternate interfaces

1735

iname = "_AlternateDBusNames_interface_annotation{}"

1198

iname="_AlternateDBusNames_interface_annotation{0}"

1736

1199

for interface_name in interface_names:

1737

1738

1200

@dbus_interface_annotations(interface_name)

1739

1201

def func(self):

1740

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

1741

"true"}

1202

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

1203

"true" }

1742

1204

# Find an unused name

1743

1205

for aname in (iname.format(i)

1744

1206

for i in itertools.count()):

1748

1210

if interface_names:

1749

1211

# Replace the class with a new subclass of it with

1750

1212

# methods, signals, etc. as created above.

1751

if sys.version_info.major == 2:

1752

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

1753

(cls, ), attr)

1754

else:

1755

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

1756

(cls, ), attr)

1213

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

1214

(cls,), attr)

1757

1215

return cls

1758

1759

1216

return wrapper

1760

1217

1761

1218

1762

1219

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

1763

"se.bsnet.fukt.Mandos"})

1220

"se.bsnet.fukt.Mandos"})

1764

1221

class ClientDBus(Client, DBusObjectWithProperties):

1765

1222

"""A Client class using D-Bus

1766

1223

1767

1224

Attributes:

1768

1225

dbus_object_path: dbus.ObjectPath

1769

1226

bus: dbus.SystemBus()

1770

1227

"""

1771

1228

1772

1229

runtime_expansions = (Client.runtime_expansions

1773

+ ("dbus_object_path", ))

1774

1775

_interface = "se.recompile.Mandos.Client"

1776

1230

+ ("dbus_object_path",))

1231

1777

1232

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

1778

1779

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

1233

1234

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

1780

1235

self.bus = bus

1781

1236

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

1782

1237

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

1783

1238

# the D-Bus

1784

client_object_name = str(self.name).translate(

1239

client_object_name = unicode(self.name).translate(

1785

1240

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

1786

1241

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

1787

self.dbus_object_path = dbus.ObjectPath(

1788

"/clients/" + client_object_name)

1242

self.dbus_object_path = (dbus.ObjectPath

1243

("/clients/" + client_object_name))

1789

1244

DBusObjectWithProperties.__init__(self, self.bus,

1790

1245

self.dbus_object_path)

1791

1792

def notifychangeproperty(transform_func, dbus_name,

1793

type_func=lambda x: x,

1794

variant_level=1,

1795

invalidate_only=False,

1796

_interface=_interface):

1246

1247

def notifychangeproperty(transform_func,

1248

dbus_name, type_func=lambda x: x,

1249

variant_level=1):

1797

1250

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

1798

1251

its changes to DBus.

1799

1252

1800

1253

transform_fun: Function that takes a value and a variant_level

1801

1254

and transforms it to a D-Bus type.

1802

1255

dbus_name: D-Bus name of the variable

1804

1257

to the D-Bus. Default: no transform

1805

1258

variant_level: D-Bus variant level. Default: 1

1806

1259

"""

1807

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

1808

1260

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

1809

1261

def setter(self, value):

1810

1262

if hasattr(self, "dbus_object_path"):

1811

1263

if (not hasattr(self, attrname) or

1812

1264

type_func(getattr(self, attrname, None))

1813

1265

!= type_func(value)):

1814

if invalidate_only:

1815

self.PropertiesChanged(

1816

_interface, dbus.Dictionary(),

1817

dbus.Array((dbus_name, )))

1818

else:

1819

dbus_value = transform_func(

1820

type_func(value),

1821

variant_level=variant_level)

1822

self.PropertyChanged(dbus.String(dbus_name),

1823

dbus_value)

1824

self.PropertiesChanged(

1825

_interface,

1826

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

1827

dbus_value}),

1828

dbus.Array())

1266

dbus_value = transform_func(type_func(value),

1267

variant_level

1268

=variant_level)

1269

self.PropertyChanged(dbus.String(dbus_name),

1270

dbus_value)

1829

1271

setattr(self, attrname, value)

1830

1272

1831

1273

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

1832

1274

1833

1275

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1834

1276

approvals_pending = notifychangeproperty(dbus.Boolean,

1835

1277

"ApprovalPending",

1836

type_func=bool)

1278

type_func = bool)

1837

1279

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

1838

1280

last_enabled = notifychangeproperty(datetime_to_dbus,

1839

1281

"LastEnabled")

1840

checker = notifychangeproperty(

1841

dbus.Boolean, "CheckerRunning",

1842

type_func=lambda checker: checker is not None)

1282

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

1283

type_func = lambda checker:

1284

checker is not None)

1843

1285

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1844

1286

"LastCheckedOK")

1845

1287

last_checker_status = notifychangeproperty(dbus.Int16,

1848

1290

datetime_to_dbus, "LastApprovalRequest")

1849

1291

approved_by_default = notifychangeproperty(dbus.Boolean,

1850

1292

"ApprovedByDefault")

1851

approval_delay = notifychangeproperty(

1852

dbus.UInt64, "ApprovalDelay",

1853

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

1293

approval_delay = notifychangeproperty(dbus.UInt64,

1294

"ApprovalDelay",

1295

type_func =

1296

timedelta_to_milliseconds)

1854

1297

approval_duration = notifychangeproperty(

1855

1298

dbus.UInt64, "ApprovalDuration",

1856

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

1299

type_func = timedelta_to_milliseconds)

1857

1300

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

1858

timeout = notifychangeproperty(

1859

dbus.UInt64, "Timeout",

1860

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

1301

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

1302

type_func =

1303

timedelta_to_milliseconds)

1861

1304

extended_timeout = notifychangeproperty(

1862

1305

dbus.UInt64, "ExtendedTimeout",

1863

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

1864

interval = notifychangeproperty(

1865

dbus.UInt64, "Interval",

1866

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

1306

type_func = timedelta_to_milliseconds)

1307

interval = notifychangeproperty(dbus.UInt64,

1308

"Interval",

1309

type_func =

1310

timedelta_to_milliseconds)

1867

1311

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

1868

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

1869

invalidate_only=True)

1870

1312

1871

1313

del notifychangeproperty

1872

1314

1873

1315

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

1874

1316

try:

1875

1317

self.remove_from_connection()

1878

1320

if hasattr(DBusObjectWithProperties, "__del__"):

1879

1321

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

1880

1322

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

1881

1882

def checker_callback(self, source, condition,

1883

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

1884

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

1885

connection, command, *args,

1886

**kwargs)

1887

exitstatus = self.last_checker_status

1888

if exitstatus >= 0:

1323

1324

def checker_callback(self, pid, condition, command,

1325

*args, **kwargs):

1326

self.checker_callback_tag = None

1327

self.checker = None

1328

if os.WIFEXITED(condition):

1329

exitstatus = os.WEXITSTATUS(condition)

1889

1330

# Emit D-Bus signal

1890

1331

self.CheckerCompleted(dbus.Int16(exitstatus),

1891

# This is specific to GNU libC

1892

dbus.Int64(exitstatus << 8),

1332

dbus.Int64(condition),

1893

1333

dbus.String(command))

1894

1334

else:

1895

1335

# Emit D-Bus signal

1896

1336

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

1897

dbus.Int64(

1898

# This is specific to GNU libC

1899

(exitstatus << 8)

1900

| self.last_checker_signal),

1337

dbus.Int64(condition),

1901

1338

dbus.String(command))

1902

return ret

1903

1339

1340

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

1341

*args, **kwargs)

1342

1904

1343

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

1905

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

1344

old_checker = self.checker

1345

if self.checker is not None:

1346

old_checker_pid = self.checker.pid

1347

else:

1348

old_checker_pid = None

1906

1349

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

1907

1350

# Only if new checker process was started

1908

1351

if (self.checker is not None

1910

1353

# Emit D-Bus signal

1911

1354

self.CheckerStarted(self.current_checker_command)

1912

1355

return r

1913

1356

1914

1357

def _reset_approved(self):

1915

1358

self.approved = None

1916

1359

return False

1917

1360

1918

1361

def approve(self, value=True):

1919

1362

self.approved = value

1920

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

1921

* 1000), self._reset_approved)

1363

gobject.timeout_add(timedelta_to_milliseconds

1364

(self.approval_duration),

1365

self._reset_approved)

1922

1366

self.send_changedstate()

1923

1924

# D-Bus methods, signals & properties

1925

1926

# Interfaces

1927

1928

# Signals

1929

1367

1368

## D-Bus methods, signals & properties

1369

_interface = "se.recompile.Mandos.Client"

1370

1371

## Interfaces

1372

1373

@dbus_interface_annotations(_interface)

1374

def _foo(self):

1375

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

1376

"false"}

1377

1378

## Signals

1379

1930

1380

# CheckerCompleted - signal

1931

1381

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

1932

1382

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

1933

1383

"D-Bus signal"

1934

1384

pass

1935

1385

1936

1386

# CheckerStarted - signal

1937

1387

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

1938

1388

def CheckerStarted(self, command):

1939

1389

"D-Bus signal"

1940

1390

pass

1941

1391

1942

1392

# PropertyChanged - signal

1943

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

1944

1393

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

1945

1394

def PropertyChanged(self, property, value):

1946

1395

"D-Bus signal"

1947

1396

pass

1948

1397

1949

1398

# GotSecret - signal

1950

1399

@dbus.service.signal(_interface)

1951

1400

def GotSecret(self):

1954

1403

server to mandos-client

1955

1404

"""

1956

1405

pass

1957

1406

1958

1407

# Rejected - signal

1959

1408

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

1960

1409

def Rejected(self, reason):

1961

1410

"D-Bus signal"

1962

1411

pass

1963

1412

1964

1413

# NeedApproval - signal

1965

1414

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

1966

1415

def NeedApproval(self, timeout, default):

1967

1416

"D-Bus signal"

1968

1417

return self.need_approval()

1969

1970

# Methods

1971

1418

1419

## Methods

1420

1972

1421

# Approve - method

1973

1422

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

1974

1423

def Approve(self, value):

1975

1424

self.approve(value)

1976

1425

1977

1426

# CheckedOK - method

1978

1427

@dbus.service.method(_interface)

1979

1428

def CheckedOK(self):

1980

1429

self.checked_ok()

1981

1430

1982

1431

# Enable - method

1983

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

1984

1432

@dbus.service.method(_interface)

1985

1433

def Enable(self):

1986

1434

"D-Bus method"

1987

1435

self.enable()

1988

1436

1989

1437

# StartChecker - method

1990

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

1991

1438

@dbus.service.method(_interface)

1992

1439

def StartChecker(self):

1993

1440

"D-Bus method"

1994

1441

self.start_checker()

1995

1442

1996

1443

# Disable - method

1997

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

1998

1444

@dbus.service.method(_interface)

1999

1445

def Disable(self):

2000

1446

"D-Bus method"

2001

1447

self.disable()

2002

1448

2003

1449

# StopChecker - method

2004

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

2005

1450

@dbus.service.method(_interface)

2006

1451

def StopChecker(self):

2007

1452

self.stop_checker()

2008

2009

# Properties

2010

1453

1454

## Properties

1455

2011

1456

# ApprovalPending - property

2012

1457

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

2013

1458

def ApprovalPending_dbus_property(self):

2014

1459

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

2015

1460

2016

1461

# ApprovedByDefault - property

2017

@dbus_service_property(_interface,

2018

signature="b",

1462

@dbus_service_property(_interface, signature="b",

2019

1463

access="readwrite")

2020

1464

def ApprovedByDefault_dbus_property(self, value=None):

2021

1465

if value is None: # get

2022

1466

return dbus.Boolean(self.approved_by_default)

2023

1467

self.approved_by_default = bool(value)

2024

1468

2025

1469

# ApprovalDelay - property

2026

@dbus_service_property(_interface,

2027

signature="t",

1470

@dbus_service_property(_interface, signature="t",

2028

1471

access="readwrite")

2029

1472

def ApprovalDelay_dbus_property(self, value=None):

2030

1473

if value is None: # get

2031

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

2032

* 1000)

1474

return dbus.UInt64(self.approval_delay_milliseconds())

2033

1475

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

2034

1476

2035

1477

# ApprovalDuration - property

2036

@dbus_service_property(_interface,

2037

signature="t",

1478

@dbus_service_property(_interface, signature="t",

2038

1479

access="readwrite")

2039

1480

def ApprovalDuration_dbus_property(self, value=None):

2040

1481

if value is None: # get

2041

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

2042

* 1000)

1482

return dbus.UInt64(timedelta_to_milliseconds(

1483

self.approval_duration))

2043

1484

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

2044

1485

2045

1486

# Name - property

2046

@dbus_annotations(

2047

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

2048

1487

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

2049

1488

def Name_dbus_property(self):

2050

1489

return dbus.String(self.name)

2051

2052

# KeyID - property

2053

@dbus_annotations(

2054

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

2055

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

2056

def KeyID_dbus_property(self):

2057

return dbus.String(self.key_id)

2058

1490

2059

1491

# Fingerprint - property

2060

@dbus_annotations(

2061

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

2062

1492

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

2063

1493

def Fingerprint_dbus_property(self):

2064

1494

return dbus.String(self.fingerprint)

2065

1495

2066

1496

# Host - property

2067

@dbus_service_property(_interface,

2068

signature="s",

1497

@dbus_service_property(_interface, signature="s",

2069

1498

access="readwrite")

2070

1499

def Host_dbus_property(self, value=None):

2071

1500

if value is None: # get

2072

1501

return dbus.String(self.host)

2073

self.host = str(value)

2074

1502

self.host = unicode(value)

1503

2075

1504

# Created - property

2076

@dbus_annotations(

2077

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

2078

1505

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

2079

1506

def Created_dbus_property(self):

2080

1507

return datetime_to_dbus(self.created)

2081

1508

2082

1509

# LastEnabled - property

2083

1510

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

2084

1511

def LastEnabled_dbus_property(self):

2085

1512

return datetime_to_dbus(self.last_enabled)

2086

1513

2087

1514

# Enabled - property

2088

@dbus_service_property(_interface,

2089

signature="b",

1515

@dbus_service_property(_interface, signature="b",

2090

1516

access="readwrite")

2091

1517

def Enabled_dbus_property(self, value=None):

2092

1518

if value is None: # get

2095

1521

self.enable()

2096

1522

else:

2097

1523

self.disable()

2098

1524

2099

1525

# LastCheckedOK - property

2100

@dbus_service_property(_interface,

2101

signature="s",

1526

@dbus_service_property(_interface, signature="s",

2102

1527

access="readwrite")

2103

1528

def LastCheckedOK_dbus_property(self, value=None):

2104

1529

if value is not None:

2105

1530

self.checked_ok()

2106

1531

return

2107

1532

return datetime_to_dbus(self.last_checked_ok)

2108

1533

2109

1534

# LastCheckerStatus - property

2110

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

1535

@dbus_service_property(_interface, signature="n",

1536

access="read")

2111

1537

def LastCheckerStatus_dbus_property(self):

2112

1538

return dbus.Int16(self.last_checker_status)

2113

1539

2114

1540

# Expires - property

2115

1541

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

2116

1542

def Expires_dbus_property(self):

2117

1543

return datetime_to_dbus(self.expires)

2118

1544

2119

1545

# LastApprovalRequest - property

2120

1546

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

2121

1547

def LastApprovalRequest_dbus_property(self):

2122

1548

return datetime_to_dbus(self.last_approval_request)

2123

1549

2124

1550

# Timeout - property

2125

@dbus_service_property(_interface,

2126

signature="t",

1551

@dbus_service_property(_interface, signature="t",

2127

1552

access="readwrite")

2128

1553

def Timeout_dbus_property(self, value=None):

2129

1554

if value is None: # get

2130

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

1555

return dbus.UInt64(self.timeout_milliseconds())

2131

1556

old_timeout = self.timeout

2132

1557

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

2133

1558

# Reschedule disabling

2141

1566

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

2142

1567

is None):

2143

1568

return

2144

GLib.source_remove(self.disable_initiator_tag)

2145

self.disable_initiator_tag = GLib.timeout_add(

2146

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

2147

self.disable)

2148

1569

gobject.source_remove(self.disable_initiator_tag)

1570

self.disable_initiator_tag = (

1571

gobject.timeout_add(

1572

timedelta_to_milliseconds(self.expires - now),

1573

self.disable))

1574

2149

1575

# ExtendedTimeout - property

2150

@dbus_service_property(_interface,

2151

signature="t",

1576

@dbus_service_property(_interface, signature="t",

2152

1577

access="readwrite")

2153

1578

def ExtendedTimeout_dbus_property(self, value=None):

2154

1579

if value is None: # get

2155

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

2156

* 1000)

1580

return dbus.UInt64(self.extended_timeout_milliseconds())

2157

1581

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

2158

1582

2159

1583

# Interval - property

2160

@dbus_service_property(_interface,

2161

signature="t",

1584

@dbus_service_property(_interface, signature="t",

2162

1585

access="readwrite")

2163

1586

def Interval_dbus_property(self, value=None):

2164

1587

if value is None: # get

2165

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

1588

return dbus.UInt64(self.interval_milliseconds())

2166

1589

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

2167

1590

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

2168

1591

return

2169

1592

if self.enabled:

2170

1593

# Reschedule checker run

2171

GLib.source_remove(self.checker_initiator_tag)

2172

self.checker_initiator_tag = GLib.timeout_add(

2173

value, self.start_checker)

2174

self.start_checker() # Start one now, too

2175

1594

gobject.source_remove(self.checker_initiator_tag)

1595

self.checker_initiator_tag = (gobject.timeout_add

1596

(value, self.start_checker))

1597

self.start_checker() # Start one now, too

1598

2176

1599

# Checker - property

2177

@dbus_service_property(_interface,

2178

signature="s",

1600

@dbus_service_property(_interface, signature="s",

2179

1601

access="readwrite")

2180

1602

def Checker_dbus_property(self, value=None):

2181

1603

if value is None: # get

2182

1604

return dbus.String(self.checker_command)

2183

self.checker_command = str(value)

2184

1605

self.checker_command = unicode(value)

1606

2185

1607

# CheckerRunning - property

2186

@dbus_service_property(_interface,

2187

signature="b",

1608

@dbus_service_property(_interface, signature="b",

2188

1609

access="readwrite")

2189

1610

def CheckerRunning_dbus_property(self, value=None):

2190

1611

if value is None: # get

2193

1614

self.start_checker()

2194

1615

else:

2195

1616

self.stop_checker()

2196

1617

2197

1618

# ObjectPath - property

2198

@dbus_annotations(

2199

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

2200

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

2201

1619

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

2202

1620

def ObjectPath_dbus_property(self):

2203

return self.dbus_object_path # is already a dbus.ObjectPath

2204

1621

return self.dbus_object_path # is already a dbus.ObjectPath

1622

2205

1623

# Secret = property

2206

@dbus_annotations(

2207

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

2208

"invalidates"})

2209

@dbus_service_property(_interface,

2210

signature="ay",

2211

access="write",

2212

byte_arrays=True)

1624

@dbus_service_property(_interface, signature="ay",

1625

access="write", byte_arrays=True)

2213

1626

def Secret_dbus_property(self, value):

2214

self.secret = bytes(value)

2215

1627

self.secret = str(value)

1628

2216

1629

del _interface

2217

1630

2218

1631

2219

class ProxyClient:

2220

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

1632

class ProxyClient(object):

1633

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

2221

1634

self._pipe = child_pipe

2222

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

1635

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

2223

1636

if not self._pipe.recv():

2224

raise KeyError(key_id or fpr)

2225

1637

raise KeyError()

1638

2226

1639

def __getattribute__(self, name):

2227

1640

if name == '_pipe':

2228

1641

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

2231

1644

if data[0] == 'data':

2232

1645

return data[1]

2233

1646

if data[0] == 'function':

2234

2235

1647

def func(*args, **kwargs):

2236

1648

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

2237

1649

return self._pipe.recv()[1]

2238

2239

1650

return func

2240

1651

2241

1652

def __setattr__(self, name, value):

2242

1653

if name == '_pipe':

2243

1654

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

2246

1657

2247

1658

class ClientHandler(socketserver.BaseRequestHandler, object):

2248

1659

"""A class to handle client connections.

2249

1660

2250

1661

Instantiated once for each connection to handle it.

2251

1662

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

2252

1663

2253

1664

def handle(self):

2254

1665

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

2255

1666

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

2256

str(self.client_address))

1667

unicode(self.client_address))

2257

1668

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

2258

1669

self.server.child_pipe.fileno())

2259

2260

session = gnutls.ClientSession(self.request)

2261

2262

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

2263

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

2264

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

2265

# "+DHE-DSS"))

1670

1671

session = (gnutls.connection

1672

.ClientSession(self.request,

1673

gnutls.connection

1674

.X509Credentials()))

1675

1676

# Note: gnutls.connection.X509Credentials is really a

1677

# generic GnuTLS certificate credentials object so long as

1678

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

1679

# here despite using OpenPGP certificates.

1680

1681

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

1682

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

1683

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

1684

# "+DHE-DSS"))

2266

1685

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

2267

1686

priority = self.server.gnutls_priority

2268

1687

if priority is None:

2269

1688

priority = "NORMAL"

2270

gnutls.priority_set_direct(session._c_object,

2271

priority.encode("utf-8"),

2272

None)

2273

1689

(gnutls.library.functions

1690

.gnutls_priority_set_direct(session._c_object,

1691

priority, None))

1692

2274

1693

# Start communication using the Mandos protocol

2275

1694

# Get protocol number

2276

1695

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

2277

1696

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

2278

1697

try:

2279

1698

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

2280

raise RuntimeError(line)

1699

raise RuntimeError

2281

1700

except (ValueError, IndexError, RuntimeError) as error:

2282

1701

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

2283

1702

return

2284

1703

2285

1704

# Start GnuTLS connection

2286

1705

try:

2287

1706

session.handshake()

2288

except gnutls.Error as error:

1707

except gnutls.errors.GNUTLSError as error:

2289

1708

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

2290

1709

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

2291

1710

# established. Just abandon the request.

2292

1711

return

2293

1712

logger.debug("Handshake succeeded")

2294

1713

2295

1714

approval_required = False

2296

1715

try:

2297

if gnutls.has_rawpk:

2298

fpr = b""

2299

try:

2300

key_id = self.key_id(

2301

self.peer_certificate(session))

2302

except (TypeError, gnutls.Error) as error:

2303

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

2304

return

2305

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

2306

2307

else:

2308

key_id = b""

2309

try:

2310

fpr = self.fingerprint(

2311

self.peer_certificate(session))

2312

except (TypeError, gnutls.Error) as error:

2313

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

2314

return

2315

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

2316

2317

try:

2318

client = ProxyClient(child_pipe, key_id, fpr,

1716

try:

1717

fpr = self.fingerprint(self.peer_certificate

1718

(session))

1719

except (TypeError,

1720

gnutls.errors.GNUTLSError) as error:

1721

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

1722

return

1723

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

1724

1725

try:

1726

client = ProxyClient(child_pipe, fpr,

2319

1727

self.client_address)

2320

1728

except KeyError:

2321

1729

return

2322

1730

2323

1731

if client.approval_delay:

2324

1732

delay = client.approval_delay

2325

1733

client.approvals_pending += 1

2326

1734

approval_required = True

2327

1735

2328

1736

while True:

2329

1737

if not client.enabled:

2330

1738

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

2331

client.name)

1739

client.name)

2332

1740

if self.server.use_dbus:

2333

1741

# Emit D-Bus signal

2334

1742

client.Rejected("Disabled")

2335

1743

return

2336

1744

2337

1745

if client.approved or not client.approval_delay:

2338

# We are approved or approval is disabled

1746

#We are approved or approval is disabled

2339

1747

break

2340

1748

elif client.approved is None:

2341

1749

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

2343

1751

if self.server.use_dbus:

2344

1752

# Emit D-Bus signal

2345

1753

client.NeedApproval(

2346

client.approval_delay.total_seconds()

2347

* 1000, client.approved_by_default)

1754

client.approval_delay_milliseconds(),

1755

client.approved_by_default)

2348

1756

else:

2349

1757

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

2350

1758

client.name)

2352

1760

# Emit D-Bus signal

2353

1761

client.Rejected("Denied")

2354

1762

return

2355

2356

# wait until timeout or approved

1763

1764

#wait until timeout or approved

2357

1765

time = datetime.datetime.now()

2358

1766

client.changedstate.acquire()

2359

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

1767

client.changedstate.wait(

1768

float(timedelta_to_milliseconds(delay)

1769

/ 1000))

2360

1770

client.changedstate.release()

2361

1771

time2 = datetime.datetime.now()

2362

1772

if (time2 - time) >= delay:

2372

1782

break

2373

1783

else:

2374

1784

delay -= time2 - time

2375

2376

try:

2377

session.send(client.secret)

2378

except gnutls.Error as error:

2379

logger.warning("gnutls send failed",

2380

exc_info=error)

2381

return

2382

1785

1786

sent_size = 0

1787

while sent_size < len(client.secret):

1788

try:

1789

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

1790

except gnutls.errors.GNUTLSError as error:

1791

logger.warning("gnutls send failed",

1792

exc_info=error)

1793

return

1794

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

1795

sent, len(client.secret)

1796

- (sent_size + sent))

1797

sent_size += sent

1798

2383

1799

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

2384

1800

# bump the timeout using extended_timeout

2385

1801

client.bump_timeout(client.extended_timeout)

2386

1802

if self.server.use_dbus:

2387

1803

# Emit D-Bus signal

2388

1804

client.GotSecret()

2389

1805

2390

1806

finally:

2391

1807

if approval_required:

2392

1808

client.approvals_pending -= 1

2393

1809

try:

2394

1810

session.bye()

2395

except gnutls.Error as error:

1811

except gnutls.errors.GNUTLSError as error:

2396

1812

logger.warning("GnuTLS bye failed",

2397

1813

exc_info=error)

2398

1814

2399

1815

@staticmethod

2400

1816

def peer_certificate(session):

2401

"Return the peer's certificate as a bytestring"

2402

try:

2403

cert_type = gnutls.certificate_type_get2(session._c_object,

2404

gnutls.CTYPE_PEERS)

2405

except AttributeError:

2406

cert_type = gnutls.certificate_type_get(session._c_object)

2407

if gnutls.has_rawpk:

2408

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2409

else:

2410

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2411

# If not a valid certificate type...

2412

if cert_type not in valid_cert_types:

2413

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

2414

valid_cert_types)

2415

# ...return invalid data

2416

return b""

1817

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

1818

# If not an OpenPGP certificate...

1819

if (gnutls.library.functions

1820

.gnutls_certificate_type_get(session._c_object)

1821

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1822

# ...do the normal thing

1823

return session.peer_certificate

2417

1824

list_size = ctypes.c_uint(1)

2418

cert_list = (gnutls.certificate_get_peers

1825

cert_list = (gnutls.library.functions

1826

.gnutls_certificate_get_peers

2419

1827

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

2420

1828

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

2421

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

1829

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

1830

" certificate")

2422

1831

if list_size.value == 0:

2423

1832

return None

2424

1833

cert = cert_list[0]

2425

1834

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

2426

2427

@staticmethod

2428

def key_id(certificate):

2429

"Convert a certificate bytestring to a hexdigit key ID"

2430

# New GnuTLS "datum" with the public key

2431

datum = gnutls.datum_t(

2432

ctypes.cast(ctypes.c_char_p(certificate),

2433

ctypes.POINTER(ctypes.c_ubyte)),

2434

ctypes.c_uint(len(certificate)))

2435

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

2436

# New empty GnuTLS certificate

2437

pubkey = gnutls.pubkey_t()

2438

gnutls.pubkey_init(ctypes.byref(pubkey))

2439

# Import the raw public key into the certificate

2440

gnutls.pubkey_import(pubkey,

2441

ctypes.byref(datum),

2442

gnutls.X509_FMT_DER)

2443

# New buffer for the key ID

2444

buf = ctypes.create_string_buffer(32)

2445

buf_len = ctypes.c_size_t(len(buf))

2446

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

2447

gnutls.pubkey_get_key_id(pubkey,

2448

gnutls.KEYID_USE_SHA256,

2449

ctypes.cast(ctypes.byref(buf),

2450

ctypes.POINTER(ctypes.c_ubyte)),

2451

ctypes.byref(buf_len))

2452

# Deinit the certificate

2453

gnutls.pubkey_deinit(pubkey)

2454

2455

# Convert the buffer to a Python bytestring

2456

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

2457

# Convert the bytestring to hexadecimal notation

2458

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

2459

return hex_key_id

2460

1835

2461

1836

@staticmethod

2462

1837

def fingerprint(openpgp):

2463

1838

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2464

1839

# New GnuTLS "datum" with the OpenPGP public key

2465

datum = gnutls.datum_t(

2466

ctypes.cast(ctypes.c_char_p(openpgp),

2467

ctypes.POINTER(ctypes.c_ubyte)),

2468

ctypes.c_uint(len(openpgp)))

1840

datum = (gnutls.library.types

1841

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

1842

ctypes.POINTER

1843

(ctypes.c_ubyte)),

1844

ctypes.c_uint(len(openpgp))))

2469

1845

# New empty GnuTLS certificate

2470

crt = gnutls.openpgp_crt_t()

2471

gnutls.openpgp_crt_init(ctypes.byref(crt))

1846

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1847

(gnutls.library.functions

1848

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2472

1849

# Import the OpenPGP public key into the certificate

2473

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

2474

gnutls.OPENPGP_FMT_RAW)

1850

(gnutls.library.functions

1851

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

1852

gnutls.library.constants

1853

.GNUTLS_OPENPGP_FMT_RAW))

2475

1854

# Verify the self signature in the key

2476

1855

crtverify = ctypes.c_uint()

2477

gnutls.openpgp_crt_verify_self(crt, 0,

2478

ctypes.byref(crtverify))

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_verify_self(crt, 0,

1858

ctypes.byref(crtverify)))

2479

1859

if crtverify.value != 0:

2480

gnutls.openpgp_crt_deinit(crt)

2481

raise gnutls.CertificateSecurityError(code

2482

=crtverify.value)

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1861

raise (gnutls.errors.CertificateSecurityError

1862

("Verify failed"))

2483

1863

# New buffer for the fingerprint

2484

1864

buf = ctypes.create_string_buffer(20)

2485

1865

buf_len = ctypes.c_size_t()

2486

1866

# Get the fingerprint from the certificate into the buffer

2487

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

2488

ctypes.byref(buf_len))

1867

(gnutls.library.functions

1868

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

1869

ctypes.byref(buf_len)))

2489

1870

# Deinit the certificate

2490

gnutls.openpgp_crt_deinit(crt)

1871

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2491

1872

# Convert the buffer to a Python bytestring

2492

1873

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

2493

1874

# Convert the bytestring to hexadecimal notation

2495

1876

return hex_fpr

2496

1877

2497

1878

2498

class MultiprocessingMixIn:

1879

class MultiprocessingMixIn(object):

2499

1880

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

2500

2501

1881

def sub_process_main(self, request, address):

2502

1882

try:

2503

1883

self.finish_request(request, address)

2504

1884

except Exception:

2505

1885

self.handle_error(request, address)

2506

1886

self.close_request(request)

2507

1887

2508

1888

def process_request(self, request, address):

2509

1889

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

2510

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

2511

args=(request, address))

1890

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

1891

args = (request, address))

2512

1892

proc.start()

2513

1893

return proc

2514

1894

2515

1895

2516

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1896

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2517

1897

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

2518

2519

1898

def process_request(self, request, client_address):

2520

1899

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

2521

1900

2522

1901

This function creates a new pipe in self.pipe

2523

1902

"""

2524

1903

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2525

1904

2526

1905

proc = MultiprocessingMixIn.process_request(self, request,

2527

1906

client_address)

2528

1907

self.child_pipe.close()

2529

1908

self.add_pipe(parent_pipe, proc)

2530

1909

2531

1910

def add_pipe(self, parent_pipe, proc):

2532

1911

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

2533

raise NotImplementedError()

1912

raise NotImplementedError

2534

1913

2535

1914

2536

1915

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2537

socketserver.TCPServer):

1916

socketserver.TCPServer, object):

2538

1917

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

2539

1918

2540

1919

Attributes:

2541

1920

enabled: Boolean; whether this server is activated yet

2542

1921

interface: None or a network interface name (string)

2543

1922

use_ipv6: Boolean; to use IPv6 or not

2544

1923

"""

2545

2546

1924

def __init__(self, server_address, RequestHandlerClass,

2547

interface=None,

2548

use_ipv6=True,

2549

socketfd=None):

1925

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

2550

1926

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

2551

1927

creating a new one with socket.socket().

2552

1928

"""

2558

1934

self.socketfd = socketfd

2559

1935

# Save the original socket.socket() function

2560

1936

self.socket_socket = socket.socket

2561

2562

1937

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

2563

#

1938

#

2564

1939

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

2565

1940

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

2566

1941

# patching socket.socket.)

2567

#

1942

#

2568

1943

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

2569

1944

@functools.wraps(socket.socket)

2570

1945

def socket_wrapper(*args, **kwargs):

2582

1957

# socket_wrapper(), if socketfd was set.

2583

1958

socketserver.TCPServer.__init__(self, server_address,

2584

1959

RequestHandlerClass)

2585

1960

2586

1961

def server_bind(self):

2587

1962

"""This overrides the normal server_bind() function

2588

1963

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

2589

1964

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

2590

global SO_BINDTODEVICE

2591

1965

if self.interface is not None:

2592

1966

if SO_BINDTODEVICE is None:

2593

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

2594

# common enough.

2595

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

2596

SO_BINDTODEVICE = 25

2597

try:

2598

self.socket.setsockopt(

2599

socket.SOL_SOCKET, SO_BINDTODEVICE,

2600

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

2601

except socket.error as error:

2602

if error.errno == errno.EPERM:

2603

logger.error("No permission to bind to"

2604

" interface %s", self.interface)

2605

elif error.errno == errno.ENOPROTOOPT:

2606

logger.error("SO_BINDTODEVICE not available;"

2607

" cannot bind to interface %s",

2608

self.interface)

2609

elif error.errno == errno.ENODEV:

2610

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

2611

" cannot bind", self.interface)

2612

else:

2613

raise

1967

logger.error("SO_BINDTODEVICE does not exist;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

else:

1971

try:

1972

self.socket.setsockopt(socket.SOL_SOCKET,

1973

SO_BINDTODEVICE,

1974

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

1975

except socket.error as error:

1976

if error.errno == errno.EPERM:

1977

logger.error("No permission to bind to"

1978

" interface %s", self.interface)

1979

elif error.errno == errno.ENOPROTOOPT:

1980

logger.error("SO_BINDTODEVICE not available;"

1981

" cannot bind to interface %s",

1982

self.interface)

1983

elif error.errno == errno.ENODEV:

1984

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

1985

" cannot bind", self.interface)

1986

else:

1987

raise

2614

1988

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

2615

1989

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

2616

if self.server_address[1]:

2617

self.allow_reuse_address = True

2618

1990

if not self.server_address[0]:

2619

1991

if self.address_family == socket.AF_INET6:

2620

any_address = "::" # in6addr_any

1992

any_address = "::" # in6addr_any

2621

1993

else:

2622

any_address = "0.0.0.0" # INADDR_ANY

1994

any_address = "0.0.0.0" # INADDR_ANY

2623

1995

self.server_address = (any_address,

2624

1996

self.server_address[1])

2625

1997

elif not self.server_address[1]:

2626

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

1998

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

1999

0)

2627

2000

# if self.interface:

2628

2001

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

2629

2002

# 0, # port

2635

2008

2636

2009

class MandosServer(IPv6_TCPServer):

2637

2010

"""Mandos server.

2638

2011

2639

2012

Attributes:

2640

2013

clients: set of Client objects

2641

2014

gnutls_priority GnuTLS priority string

2642

2015

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

2643

2644

Assumes a GLib.MainLoop event loop.

2016

2017

Assumes a gobject.MainLoop event loop.

2645

2018

"""

2646

2647

2019

def __init__(self, server_address, RequestHandlerClass,

2648

interface=None,

2649

use_ipv6=True,

2650

clients=None,

2651

gnutls_priority=None,

2652

use_dbus=True,

2653

socketfd=None):

2020

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

2021

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

2654

2022

self.enabled = False

2655

2023

self.clients = clients

2656

2024

if self.clients is None:

2659

2027

self.gnutls_priority = gnutls_priority

2660

2028

IPv6_TCPServer.__init__(self, server_address,

2661

2029

RequestHandlerClass,

2662

interface=interface,

2663

use_ipv6=use_ipv6,

2664

socketfd=socketfd)

2665

2030

interface = interface,

2031

use_ipv6 = use_ipv6,

2032

socketfd = socketfd)

2666

2033

def server_activate(self):

2667

2034

if self.enabled:

2668

2035

return socketserver.TCPServer.server_activate(self)

2669

2036

2670

2037

def enable(self):

2671

2038

self.enabled = True

2672

2039

2673

2040

def add_pipe(self, parent_pipe, proc):

2674

2041

# Call "handle_ipc" for both data and EOF events

2675

GLib.io_add_watch(

2676

parent_pipe.fileno(),

2677

GLib.IO_IN | GLib.IO_HUP,

2678

functools.partial(self.handle_ipc,

2679

parent_pipe=parent_pipe,

2680

proc=proc))

2681

2682

def handle_ipc(self, source, condition,

2683

parent_pipe=None,

2684

proc=None,

2685

client_object=None):

2042

gobject.io_add_watch(parent_pipe.fileno(),

2043

gobject.IO_IN | gobject.IO_HUP,

2044

functools.partial(self.handle_ipc,

2045

parent_pipe =

2046

parent_pipe,

2047

proc = proc))

2048

2049

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

2050

proc = None, client_object=None):

2686

2051

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

2687

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

2052

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

2688

2053

# Wait for other process to exit

2689

2054

proc.join()

2690

2055

return False

2691

2056

2692

2057

# Read a request from the child

2693

2058

request = parent_pipe.recv()

2694

2059

command = request[0]

2695

2060

2696

2061

if command == 'init':

2697

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

2698

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

2699

address = request[3]

2700

2701

for c in self.clients.values():

2702

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2703

continue

2704

if key_id and c.key_id == key_id:

2705

client = c

2706

break

2707

if fpr and c.fingerprint == fpr:

2062

fpr = request[1]

2063

address = request[2]

2064

2065

for c in self.clients.itervalues():

2066

if c.fingerprint == fpr:

2708

2067

client = c

2709

2068

break

2710

2069

else:

2711

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

2712

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

2070

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

2071

"dress: %s", fpr, address)

2713

2072

if self.use_dbus:

2714

2073

# Emit D-Bus signal

2715

mandos_dbus_service.ClientNotFound(key_id or fpr,

2074

mandos_dbus_service.ClientNotFound(fpr,

2716

2075

address[0])

2717

2076

parent_pipe.send(False)

2718

2077

return False

2719

2720

GLib.io_add_watch(

2721

parent_pipe.fileno(),

2722

GLib.IO_IN | GLib.IO_HUP,

2723

functools.partial(self.handle_ipc,

2724

parent_pipe=parent_pipe,

2725

proc=proc,

2726

client_object=client))

2078

2079

gobject.io_add_watch(parent_pipe.fileno(),

2080

gobject.IO_IN | gobject.IO_HUP,

2081

functools.partial(self.handle_ipc,

2082

parent_pipe =

2083

parent_pipe,

2084

proc = proc,

2085

client_object =

2086

client))

2727

2087

parent_pipe.send(True)

2728

2088

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

2729

2089

# same fileno

2732

2092

funcname = request[1]

2733

2093

args = request[2]

2734

2094

kwargs = request[3]

2735

2095

2736

2096

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

2737

2097

funcname)(*args,

2738

**kwargs)))

2739

2098

**kwargs)))

2099

2740

2100

if command == 'getattr':

2741

2101

attrname = request[1]

2742

if isinstance(client_object.__getattribute__(attrname),

2743

collections.Callable):

2744

parent_pipe.send(('function', ))

2102

if callable(client_object.__getattribute__(attrname)):

2103

parent_pipe.send(('function',))

2745

2104

else:

2746

parent_pipe.send((

2747

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

2748

2105

parent_pipe.send(('data', client_object

2106

.__getattribute__(attrname)))

2107

2749

2108

if command == 'setattr':

2750

2109

attrname = request[1]

2751

2110

value = request[2]

2752

2111

setattr(client_object, attrname, value)

2753

2112

2754

2113

return True

2755

2114

2756

2115

2757

2116

def rfc3339_duration_to_delta(duration):

2758

2117

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

2759

2118

2760

2119

>>> rfc3339_duration_to_delta("P7D")

2761

2120

datetime.timedelta(7)

2762

2121

>>> rfc3339_duration_to_delta("PT60S")

2772

2131

>>> rfc3339_duration_to_delta("P1DT3M20S")

2773

2132

datetime.timedelta(1, 200)

2774

2133

"""

2775

2134

2776

2135

# Parsing an RFC 3339 duration with regular expressions is not

2777

2136

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

2778

2137

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

2779

2138

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

2780

2139

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

2781

2140

# avoid excessive use of external libraries.

2782

2141

2783

2142

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

2784

Token = collections.namedtuple("Token", (

2785

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

2786

# a "group" containing digits

2787

"value", # datetime.timedelta or None

2788

"followers")) # Tokens valid after this token

2143

Token = collections.namedtuple("Token",

2144

("regexp", # To match token; if

2145

# "value" is not None,

2146

# must have a "group"

2147

# containing digits

2148

"value", # datetime.timedelta or

2149

# None

2150

"followers")) # Tokens valid after

2151

# this token

2789

2152

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

2790

2153

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

2791

2154

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

2792

2155

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

2793

2156

datetime.timedelta(seconds=1),

2794

frozenset((token_end, )))

2157

frozenset((token_end,)))

2795

2158

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

2796

2159

datetime.timedelta(minutes=1),

2797

2160

frozenset((token_second, token_end)))

2813

2176

frozenset((token_month, token_end)))

2814

2177

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

2815

2178

datetime.timedelta(weeks=1),

2816

frozenset((token_end, )))

2179

frozenset((token_end,)))

2817

2180

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

2818

2181

frozenset((token_year, token_month,

2819

2182

token_day, token_time,

2820

token_week)))

2821

# Define starting values:

2822

# Value so far

2823

value = datetime.timedelta()

2183

token_week))),

2184

# Define starting values

2185

value = datetime.timedelta() # Value so far

2824

2186

found_token = None

2825

# Following valid tokens

2826

followers = frozenset((token_duration, ))

2827

# String left to parse

2828

s = duration

2187

followers = frozenset(token_duration,) # Following valid tokens

2188

s = duration # String left to parse

2829

2189

# Loop until end token is found

2830

2190

while found_token is not token_end:

2831

2191

# Search for any currently valid tokens

2847

2207

break

2848

2208

else:

2849

2209

# No currently valid tokens were found

2850

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

2851

.format(duration))

2210

raise ValueError("Invalid RFC 3339 duration")

2852

2211

# End token found

2853

2212

return value

2854

2213

2855

2214

2856

2215

def string_to_delta(interval):

2857

2216

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

2858

2217

2859

2218

>>> string_to_delta('7d')

2860

2219

datetime.timedelta(7)

2861

2220

>>> string_to_delta('60s')

2869

2228

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

2870

2229

datetime.timedelta(0, 330)

2871

2230

"""

2872

2231

2873

2232

try:

2874

2233

return rfc3339_duration_to_delta(interval)

2875

2234

except ValueError:

2876

2235

pass

2877

2236

2878

2237

timevalue = datetime.timedelta(0)

2879

2238

for s in interval.split():

2880

2239

try:

2881

suffix = s[-1]

2240

suffix = unicode(s[-1])

2882

2241

value = int(s[:-1])

2883

2242

if suffix == "d":

2884

2243

delta = datetime.timedelta(value)

2891

2250

elif suffix == "w":

2892

2251

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

2893

2252

else:

2894

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

2895

except IndexError as e:

2253

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

2254

.format(suffix))

2255

except (ValueError, IndexError) as e:

2896

2256

raise ValueError(*(e.args))

2897

2257

timevalue += delta

2898

2258

return timevalue

2899

2259

2900

2260

2901

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

2261

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

2902

2262

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

2903

2263

2904

2264

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

2905

2265

if os.fork():

2906

2266

sys.exit()

2914

2274

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

2915

2275

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

2916

2276

raise OSError(errno.ENODEV,

2917

"{} not a character device"

2277

"{0} not a character device"

2918

2278

.format(os.devnull))

2919

2279

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

2920

2280

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

2924

2284

2925

2285

2926

2286

def main():

2927

2287

2928

2288

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

2929

2289

# Parsing of options, both command line and config file

2930

2290

2931

2291

parser = argparse.ArgumentParser()

2932

2292

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

2933

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

2293

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

2934

2294

help="show version number and exit")

2935

2295

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

2936

2296

help="Bind to interface IF")

2969

2329

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

2970

2330

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

2971

2331

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

2972

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

2973

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

2974

default=None)

2975

2332

2976

2333

options = parser.parse_args()

2977

2334

2978

2335

if options.check:

2979

2336

import doctest

2980

fail_count, test_count = doctest.testmod()

2981

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

2982

2337

doctest.testmod()

2338

sys.exit()

2339

2983

2340

# Default values for config file for server-global settings

2984

if gnutls.has_rawpk:

2985

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

2986

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

2987

else:

2988

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

2989

":+SIGN-DSA-SHA256")

2990

server_defaults = {"interface": "",

2991

"address": "",

2992

"port": "",

2993

"debug": "False",

2994

"priority": priority,

2995

"servicename": "Mandos",

2996

"use_dbus": "True",

2997

"use_ipv6": "True",

2998

"debuglevel": "",

2999

"restore": "True",

3000

"socket": "",

3001

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

3002

"foreground": "False",

3003

"zeroconf": "True",

3004

}

3005

del priority

3006

2341

server_defaults = { "interface": "",

2342

"address": "",

2343

"port": "",

2344

"debug": "False",

2345

"priority":

2346

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

2347

"servicename": "Mandos",

2348

"use_dbus": "True",

2349

"use_ipv6": "True",

2350

"debuglevel": "",

2351

"restore": "True",

2352

"socket": "",

2353

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

2354

"foreground": "False",

2355

}

2356

3007

2357

# Parse config file for server-global settings

3008

server_config = configparser.ConfigParser(server_defaults)

2358

server_config = configparser.SafeConfigParser(server_defaults)

3009

2359

del server_defaults

3010

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

3011

# Convert the ConfigParser object to a dict

2360

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

2361

"mandos.conf"))

2362

# Convert the SafeConfigParser object to a dict

3012

2363

server_settings = server_config.defaults()

3013

2364

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

3014

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

3015

"foreground", "zeroconf"):

2365

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

3016

2366

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

3017

2367

option)

3018

2368

if server_settings["port"]:

3028

2378

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

3029

2379

["socket"])

3030

2380

del server_config

3031

2381

3032

2382

# Override the settings from the config file with command line

3033

2383

# options, if set.

3034

2384

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

3035

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

3036

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

3037

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

2385

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

2386

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

2387

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

3038

2388

value = getattr(options, option)

3039

2389

if value is not None:

3040

2390

server_settings[option] = value

3041

2391

del options

3042

2392

# Force all strings to be unicode

3043

2393

for option in server_settings.keys():

3044

if isinstance(server_settings[option], bytes):

3045

server_settings[option] = (server_settings[option]

3046

.decode("utf-8"))

2394

if type(server_settings[option]) is str:

2395

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

3047

2396

# Force all boolean options to be boolean

3048

2397

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

3049

"foreground", "zeroconf"):

2398

"foreground"):

3050

2399

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

3051

2400

# Debug implies foreground

3052

2401

if server_settings["debug"]:

3053

2402

server_settings["foreground"] = True

3054

2403

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

3055

2404

3056

2405

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

3057

3058

if (not server_settings["zeroconf"]

3059

and not (server_settings["port"]

3060

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

3061

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

3062

2406

3063

2407

# For convenience

3064

2408

debug = server_settings["debug"]

3065

2409

debuglevel = server_settings["debuglevel"]

3068

2412

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

3069

2413

stored_state_file)

3070

2414

foreground = server_settings["foreground"]

3071

zeroconf = server_settings["zeroconf"]

3072

2415

3073

2416

if debug:

3074

2417

initlogger(debug, logging.DEBUG)

3075

2418

else:

3078

2421

else:

3079

2422

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

3080

2423

initlogger(debug, level)

3081

2424

3082

2425

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

3083

syslogger.setFormatter(

3084

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

3085

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

3086

server_settings["servicename"])))

3087

2426

syslogger.setFormatter(logging.Formatter

2427

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

2428

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

2429

.format(server_settings

2430

["servicename"])))

2431

3088

2432

# Parse config file with clients

3089

client_config = configparser.ConfigParser(Client.client_defaults)

2433

client_config = configparser.SafeConfigParser(Client

2434

.client_defaults)

3090

2435

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

3091

2436

"clients.conf"))

3092

2437

3093

2438

global mandos_dbus_service

3094

2439

mandos_dbus_service = None

3095

3096

socketfd = None

3097

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

3098

socketfd = server_settings["socket"]

3099

tcp_server = MandosServer(

3100

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

3101

ClientHandler,

3102

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

3103

use_ipv6=use_ipv6,

3104

gnutls_priority=server_settings["priority"],

3105

use_dbus=use_dbus,

3106

socketfd=socketfd)

2440

2441

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

2442

server_settings["port"]),

2443

ClientHandler,

2444

interface=(server_settings["interface"]

2445

or None),

2446

use_ipv6=use_ipv6,

2447

gnutls_priority=

2448

server_settings["priority"],

2449

use_dbus=use_dbus,

2450

socketfd=(server_settings["socket"]

2451

or None))

3107

2452

if not foreground:

3108

2453

pidfilename = "/run/mandos.pid"

3109

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

3110

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

3111

2454

pidfile = None

3112

2455

try:

3113

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

2456

pidfile = open(pidfilename, "w")

3114

2457

except IOError as e:

3115

2458

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

3116

2459

exc_info=e)

3117

3118

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

3119

("mandos", "mandos"),

3120

("nobody", "nogroup")):

2460

2461

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

3121

2462

try:

3122

2463

uid = pwd.getpwnam(name).pw_uid

3123

gid = pwd.getpwnam(group).pw_gid

2464

gid = pwd.getpwnam(name).pw_gid

3124

2465

break

3125

2466

except KeyError:

3126

2467

continue

3130

2471

try:

3131

2472

os.setgid(gid)

3132

2473

os.setuid(uid)

3133

if debug:

3134

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

3135

gid))

3136

2474

except OSError as error:

3137

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

3138

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

3139

2475

if error.errno != errno.EPERM:

3140

raise

3141

2476

raise error

2477

3142

2478

if debug:

3143

2479

# Enable all possible GnuTLS debugging

3144

2480

3145

2481

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

3146

2482

# - GnuTLS manual

3147

gnutls.global_set_log_level(11)

3148

3149

@gnutls.log_func

2483

gnutls.library.functions.gnutls_global_set_log_level(11)

2484

2485

@gnutls.library.types.gnutls_log_func

3150

2486

def debug_gnutls(level, string):

3151

2487

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

3152

3153

gnutls.global_set_log_function(debug_gnutls)

3154

2488

2489

(gnutls.library.functions

2490

.gnutls_global_set_log_function(debug_gnutls))

2491

3155

2492

# Redirect stdin so all checkers get /dev/null

3156

2493

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

3157

2494

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

3158

2495

if null > 2:

3159

2496

os.close(null)

3160

2497

3161

2498

# Need to fork before connecting to D-Bus

3162

2499

if not foreground:

3163

2500

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

3164

2501

daemon()

3165

3166

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

3167

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

3168

# need to inform GLib that threads will be used.

3169

GLib.threads_init()

3170

2502

2503

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

2504

# need to inform gobject that threads will be used.

2505

gobject.threads_init()

2506

3171

2507

global main_loop

3172

2508

# From the Avahi example code

3173

2509

DBusGMainLoop(set_as_default=True)

3174

main_loop = GLib.MainLoop()

2510

main_loop = gobject.MainLoop()

3175

2511

bus = dbus.SystemBus()

3176

2512

# End of Avahi example code

3177

2513

if use_dbus:

3178

2514

try:

3179

2515

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

3180

bus,

3181

do_not_queue=True)

3182

old_bus_name = dbus.service.BusName(

3183

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

3184

do_not_queue=True)

3185

except dbus.exceptions.DBusException as e:

2516

bus, do_not_queue=True)

2517

old_bus_name = (dbus.service.BusName

2518

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

2519

do_not_queue=True))

2520

except dbus.exceptions.NameExistsException as e:

3186

2521

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

3187

2522

use_dbus = False

3188

2523

server_settings["use_dbus"] = False

3189

2524

tcp_server.use_dbus = False

3190

if zeroconf:

3191

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3192

service = AvahiServiceToSyslog(

3193

name=server_settings["servicename"],

3194

servicetype="_mandos._tcp",

3195

protocol=protocol,

3196

bus=bus)

3197

if server_settings["interface"]:

3198

service.interface = if_nametoindex(

3199

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

3200

2525

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2526

service = AvahiServiceToSyslog(name =

2527

server_settings["servicename"],

2528

servicetype = "_mandos._tcp",

2529

protocol = protocol, bus = bus)

2530

if server_settings["interface"]:

2531

service.interface = (if_nametoindex

2532

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

2533

3201

2534

global multiprocessing_manager

3202

2535

multiprocessing_manager = multiprocessing.Manager()

3203

2536

3204

2537

client_class = Client

3205

2538

if use_dbus:

3206

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

3207

2539

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

2540

3208

2541

client_settings = Client.config_parser(client_config)

3209

2542

old_client_settings = {}

3210

2543

clients_data = {}

3211

2544

3212

2545

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

3213

2546

global wnull

3214

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

2547

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

3215

2548

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

3216

2549

# mode

3217

2550

if debug or not foreground:

3218

2551

wnull.close()

3219

2552

3220

2553

# Get client data and settings from last running state.

3221

2554

if server_settings["restore"]:

3222

2555

try:

3223

2556

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

3224

if sys.version_info.major == 2:

3225

clients_data, old_client_settings = pickle.load(

3226

stored_state)

3227

else:

3228

bytes_clients_data, bytes_old_client_settings = (

3229

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

3230

# Fix bytes to strings

3231

# clients_data

3232

# .keys()

3233

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

3234

if isinstance(key, bytes)

3235

else key): value

3236

for key, value in

3237

bytes_clients_data.items()}

3238

del bytes_clients_data

3239

for key in clients_data:

3240

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

3241

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

3242

for k, v in

3243

clients_data[key].items()}

3244

clients_data[key] = value

3245

# .client_structure

3246

value["client_structure"] = [

3247

(s.decode("utf-8")

3248

if isinstance(s, bytes)

3249

else s) for s in

3250

value["client_structure"]]

3251

# .name & .host

3252

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

3253

if isinstance(value[k], bytes):

3254

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

3255

if "key_id" not in value:

3256

value["key_id"] = ""

3257

elif "fingerprint" not in value:

3258

value["fingerprint"] = ""

3259

# old_client_settings

3260

# .keys()

3261

old_client_settings = {

3262

(key.decode("utf-8")

3263

if isinstance(key, bytes)

3264

else key): value

3265

for key, value in

3266

bytes_old_client_settings.items()}

3267

del bytes_old_client_settings

3268

# .host

3269

for value in old_client_settings.values():

3270

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

3271

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

3272

.decode("utf-8"))

2557

clients_data, old_client_settings = (pickle.load

2558

(stored_state))

3273

2559

os.remove(stored_state_path)

3274

2560

except IOError as e:

3275

2561

if e.errno == errno.ENOENT:

3276

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

3277

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

2562

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

2563

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

3278

2564

else:

3279

2565

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

3280

2566

exc_info=e)

3281

2567

raise

3282

2568

except EOFError as e:

3283

2569

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

3284

"EOFError:",

3285

exc_info=e)

3286

2570

"EOFError:", exc_info=e)

2571

3287

2572

with PGPEngine() as pgp:

3288

for client_name, client in clients_data.items():

2573

for client_name, client in clients_data.iteritems():

3289

2574

# Skip removed clients

3290

2575

if client_name not in client_settings:

3291

2576

continue

3292

2577

3293

2578

# Decide which value to use after restoring saved state.

3294

2579

# We have three different values: Old config file,

3295

2580

# new config file, and saved state.

3300

2585

# For each value in new config, check if it

3301

2586

# differs from the old config value (Except for

3302

2587

# the "secret" attribute)

3303

if (name != "secret"

3304

and (value !=

3305

old_client_settings[client_name][name])):

2588

if (name != "secret" and

2589

value != old_client_settings[client_name]

2590

[name]):

3306

2591

client[name] = value

3307

2592

except KeyError:

3308

2593

pass

3309

2594

3310

2595

# Clients who has passed its expire date can still be

3311

# enabled if its last checker was successful. A Client

2596

# enabled if its last checker was successful. Clients

3312

2597

# whose checker succeeded before we stored its state is

3313

2598

# assumed to have successfully run all checkers during

3314

2599

# downtime.

3316

2601

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

3317

2602

if not client["last_checked_ok"]:

3318

2603

logger.warning(

3319

"disabling client {} - Client never "

3320

"performed a successful checker".format(

3321

client_name))

2604

"disabling client {0} - Client never "

2605

"performed a successful checker"

2606

.format(client_name))

3322

2607

client["enabled"] = False

3323

2608

elif client["last_checker_status"] != 0:

3324

2609

logger.warning(

3325

"disabling client {} - Client last"

3326

" checker failed with error code"

3327

" {}".format(

3328

client_name,

3329

client["last_checker_status"]))

2610

"disabling client {0} - Client "

2611

"last checker failed with error code {1}"

2612

.format(client_name,

2613

client["last_checker_status"]))

3330

2614

client["enabled"] = False

3331

2615

else:

3332

client["expires"] = (

3333

datetime.datetime.utcnow()

3334

+ client["timeout"])

2616

client["expires"] = (datetime.datetime

2617

.utcnow()

2618

+ client["timeout"])

3335

2619

logger.debug("Last checker succeeded,"

3336

" keeping {} enabled".format(

3337

client_name))

2620

" keeping {0} enabled"

2621

.format(client_name))

3338

2622

try:

3339

client["secret"] = pgp.decrypt(

3340

client["encrypted_secret"],

3341

client_settings[client_name]["secret"])

2623

client["secret"] = (

2624

pgp.decrypt(client["encrypted_secret"],

2625

client_settings[client_name]

2626

["secret"]))

3342

2627

except PGPError:

3343

2628

# If decryption fails, we use secret from new settings

3344

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

3345

client_name))

3346

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

3347

["secret"])

3348

2629

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

2630

.format(client_name))

2631

client["secret"] = (

2632

client_settings[client_name]["secret"])

2633

3349

2634

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

3350

2635

for client_name in (set(old_client_settings)

3351

2636

- set(client_settings)):

3353

2638

for client_name in (set(client_settings)

3354

2639

- set(old_client_settings)):

3355

2640

clients_data[client_name] = client_settings[client_name]

3356

2641

3357

2642

# Create all client objects

3358

for client_name, client in clients_data.items():

2643

for client_name, client in clients_data.iteritems():

3359

2644

tcp_server.clients[client_name] = client_class(

3360

name=client_name,

3361

settings=client,

3362

server_settings=server_settings)

3363

2645

name = client_name, settings = client,

2646

server_settings = server_settings)

2647

3364

2648

if not tcp_server.clients:

3365

2649

logger.warning("No clients defined")

3366

2650

3367

2651

if not foreground:

3368

2652

if pidfile is not None:

3369

pid = os.getpid()

3370

2653

try:

3371

2654

with pidfile:

3372

print(pid, file=pidfile)

2655

pid = os.getpid()

2656

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

3373

2657

except IOError:

3374

2658

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

3375

2659

pidfilename, pid)

3376

2660

del pidfile

3377

2661

del pidfilename

3378

3379

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

3380

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3381

lambda: main_loop.quit() and False)

3382

2662

2663

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

2664

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

2665

3383

2666

if use_dbus:

3384

3385

@alternate_dbus_interfaces(

3386

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

3387

class MandosDBusService(DBusObjectWithObjectManager):

2667

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

2668

"se.bsnet.fukt.Mandos"})

2669

class MandosDBusService(DBusObjectWithProperties):

3388

2670

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

3389

3390

2671

def __init__(self):

3391

2672

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

3392

3393

2673

_interface = "se.recompile.Mandos"

3394

2674

2675

@dbus_interface_annotations(_interface)

2676

def _foo(self):

2677

return { "org.freedesktop.DBus.Property"

2678

".EmitsChangedSignal":

2679

"false"}

2680

3395

2681

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

3396

2682

def ClientAdded(self, objpath):

3397

2683

"D-Bus signal"

3398

2684

pass

3399

2685

3400

2686

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

3401

def ClientNotFound(self, key_id, address):

2687

def ClientNotFound(self, fingerprint, address):

3402

2688

"D-Bus signal"

3403

2689

pass

3404

3405

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

3406

"true"})

2690

3407

2691

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

3408

2692

def ClientRemoved(self, objpath, name):

3409

2693

"D-Bus signal"

3410

2694

pass

3411

3412

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

3413

"true"})

2695

3414

2696

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

3415

2697

def GetAllClients(self):

3416

2698

"D-Bus method"

3417

return dbus.Array(c.dbus_object_path for c in

3418

tcp_server.clients.values())

3419

3420

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

3421

"true"})

2699

return dbus.Array(c.dbus_object_path

2700

for c in

2701

tcp_server.clients.itervalues())

2702

3422

2703

@dbus.service.method(_interface,

3423

2704

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

3424

2705

def GetAllClientsWithProperties(self):

3425

2706

"D-Bus method"

3426

2707

return dbus.Dictionary(

3427

{c.dbus_object_path: c.GetAll(

3428

"se.recompile.Mandos.Client")

3429

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

2708

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

2709

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

3430

2710

signature="oa{sv}")

3431

2711

3432

2712

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

3433

2713

def RemoveClient(self, object_path):

3434

2714

"D-Bus method"

3435

for c in tcp_server.clients.values():

2715

for c in tcp_server.clients.itervalues():

3436

2716

if c.dbus_object_path == object_path:

3437

2717

del tcp_server.clients[c.name]

3438

2718

c.remove_from_connection()

3439

# Don't signal the disabling

2719

# Don't signal anything except ClientRemoved

3440

2720

c.disable(quiet=True)

3441

# Emit D-Bus signal for removal

3442

self.client_removed_signal(c)

2721

# Emit D-Bus signal

2722

self.ClientRemoved(object_path, c.name)

3443

2723

return

3444

2724

raise KeyError(object_path)

3445

2725

3446

2726

del _interface

3447

3448

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3449

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

3450

def GetManagedObjects(self):

3451

"""D-Bus method"""

3452

return dbus.Dictionary(

3453

{client.dbus_object_path:

3454

dbus.Dictionary(

3455

{interface: client.GetAll(interface)

3456

for interface in

3457

client._get_all_interface_names()})

3458

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

3459

3460

def client_added_signal(self, client):

3461

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

3462

if use_dbus:

3463

# New standard signal

3464

self.InterfacesAdded(

3465

client.dbus_object_path,

3466

dbus.Dictionary(

3467

{interface: client.GetAll(interface)

3468

for interface in

3469

client._get_all_interface_names()}))

3470

# Old signal

3471

self.ClientAdded(client.dbus_object_path)

3472

3473

def client_removed_signal(self, client):

3474

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

3475

if use_dbus:

3476

# New standard signal

3477

self.InterfacesRemoved(

3478

client.dbus_object_path,

3479

client._get_all_interface_names())

3480

# Old signal

3481

self.ClientRemoved(client.dbus_object_path,

3482

client.name)

3483

2727

3484

2728

mandos_dbus_service = MandosDBusService()

3485

3486

# Save modules to variables to exempt the modules from being

3487

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

3488

mp = multiprocessing

3489

wn = wnull

3490

2729

3491

2730

def cleanup():

3492

2731

"Cleanup function; run on exit"

3493

if zeroconf:

3494

service.cleanup()

3495

3496

mp.active_children()

3497

wn.close()

2732

service.cleanup()

2733

2734

multiprocessing.active_children()

2735

wnull.close()

3498

2736

if not (tcp_server.clients or client_settings):

3499

2737

return

3500

2738

3501

2739

# Store client before exiting. Secrets are encrypted with key

3502

2740

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

3503

2741

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

3504

2742

clients = {}

3505

2743

with PGPEngine() as pgp:

3506

for client in tcp_server.clients.values():

2744

for client in tcp_server.clients.itervalues():

3507

2745

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

3508

2746

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

3509

2747

key)

3510

2748

client_dict = {}

3511

2749

3512

2750

# A list of attributes that can not be pickled

3513

2751

# + secret.

3514

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

3515

"checker", "server_settings"}

3516

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

3517

.Object):

2752

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

2753

"checker", "server_settings"))

2754

for name, typ in (inspect.getmembers

2755

(dbus.service.Object)):

3518

2756

exclude.add(name)

3519

2757

3520

2758

client_dict["encrypted_secret"] = (client

3521

2759

.encrypted_secret)

3522

2760

for attr in client.client_structure:

3523

2761

if attr not in exclude:

3524

2762

client_dict[attr] = getattr(client, attr)

3525

2763

3526

2764

clients[client.name] = client_dict

3527

2765

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

3528

2766

3529

2767

try:

3530

with tempfile.NamedTemporaryFile(

3531

mode='wb',

3532

suffix=".pickle",

3533

prefix='clients-',

3534

dir=os.path.dirname(stored_state_path),

3535

delete=False) as stored_state:

3536

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

3537

protocol=2)

3538

tempname = stored_state.name

2768

with (tempfile.NamedTemporaryFile

2769

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

2770

dir=os.path.dirname(stored_state_path),

2771

delete=False)) as stored_state:

2772

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

2773

tempname=stored_state.name

3539

2774

os.rename(tempname, stored_state_path)

3540

2775

except (IOError, OSError) as e:

3541

2776

if not debug:

3544

2779

except NameError:

3545

2780

pass

3546

2781

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

3547

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

2782

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

3548

2783

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

3549

2784

else:

3550

2785

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

3551

2786

exc_info=e)

3552

raise

3553

2787

raise e

2788

3554

2789

# Delete all clients, and settings from config

3555

2790

while tcp_server.clients:

3556

2791

name, client = tcp_server.clients.popitem()

3557

2792

if use_dbus:

3558

2793

client.remove_from_connection()

3559

# Don't signal the disabling

2794

# Don't signal anything except ClientRemoved

3560

2795

client.disable(quiet=True)

3561

# Emit D-Bus signal for removal

3562

2796

if use_dbus:

3563

mandos_dbus_service.client_removed_signal(client)

2797

# Emit D-Bus signal

2798

mandos_dbus_service.ClientRemoved(client

2799

.dbus_object_path,

2800

client.name)

3564

2801

client_settings.clear()

3565

2802

3566

2803

atexit.register(cleanup)

3567

3568

for client in tcp_server.clients.values():

2804

2805

for client in tcp_server.clients.itervalues():

3569

2806

if use_dbus:

3570

# Emit D-Bus signal for adding

3571

mandos_dbus_service.client_added_signal(client)

2807

# Emit D-Bus signal

2808

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3572

2809

# Need to initiate checking of clients

3573

2810

if client.enabled:

3574

2811

client.init_checker()

3575

2812

3576

2813

tcp_server.enable()

3577

2814

tcp_server.server_activate()

3578

2815

3579

2816

# Find out what port we got

3580

if zeroconf:

3581

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

2817

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

3582

2818

if use_ipv6:

3583

2819

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

3584

2820

" flowinfo %d, scope_id %d",

3586

2822

else: # IPv4

3587

2823

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

3588

2824

*tcp_server.socket.getsockname())

3589

3590

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

3591

2825

2826

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

2827

3592

2828

try:

3593

if zeroconf:

3594

# From the Avahi example code

3595

try:

3596

service.activate()

3597

except dbus.exceptions.DBusException as error:

3598

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

3599

cleanup()

3600

sys.exit(1)

3601

# End of Avahi example code

3602

3603

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

3604

lambda *args, **kwargs:

3605

(tcp_server.handle_request

3606

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

3607

2829

# From the Avahi example code

2830

try:

2831

service.activate()

2832

except dbus.exceptions.DBusException as error:

2833

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

2834

cleanup()

2835

sys.exit(1)

2836

# End of Avahi example code

2837

2838

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

2839

lambda *args, **kwargs:

2840

(tcp_server.handle_request

2841

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

2842

3608

2843

logger.debug("Starting main loop")

3609

2844

main_loop.run()

3610

2845

except AvahiError as error:

3619

2854

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

3620

2855

cleanup()

3621

2856

3622

3623

2857

if __name__ == '__main__':

3624

2858

main()