/mandos/trunk : revision 1099

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

72

80

73

81

import dbus

74

82

import dbus.service

75

import gobject

76

import avahi

83

from gi.repository import GLib

77

84

from dbus.mainloop.glib import DBusGMainLoop

78

85

import ctypes

79

86

import ctypes.util

80

87

import xml.dom.minidom

81

88

import inspect

82

89

90

# Try to find the value of SO_BINDTODEVICE:

83

91

try:

92

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

93

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

84

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

95

except AttributeError:

86

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

87

99

from IN import SO_BINDTODEVICE

88

100

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.0"

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.8.3"

92

119

stored_state_file = "clients.pickle"

93

120

94

121

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

122

syslogger = None

98

123

99

124

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

103

127

except (OSError, AttributeError):

128

104

129

def if_nametoindex(interface):

105

130

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

106

131

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

107

132

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

108

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

134

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

135

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

113

136

return interface_index

114

137

115

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

116

155

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

117

156

"""init logger and add loglevel"""

118

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

119

162

syslogger.setFormatter(logging.Formatter

120

163

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

121

164

' %(message)s'))

122

165

logger.addHandler(syslogger)

123

166

124

167

if debug:

125

168

console = logging.StreamHandler()

126

169

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

138

181

139

182

class PGPEngine(object):

140

183

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

184

141

185

def __init__(self):

142

186

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

143

198

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

199

'--homedir', self.tempdir,

145

200

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

148

201

'--quiet']

202

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

203

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

204

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

205

149

206

def __enter__(self):

150

207

return self

151

208

152

209

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

153

210

self._cleanup()

154

211

return False

155

212

156

213

def __del__(self):

157

214

self._cleanup()

158

215

159

216

def _cleanup(self):

160

217

if self.tempdir is not None:

161

218

# Delete contents of tempdir

162

219

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

163

topdown = False):

220

topdown=False):

164

221

for filename in files:

165

222

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

166

223

for dirname in dirs:

168

225

# Remove tempdir

169

226

os.rmdir(self.tempdir)

170

227

self.tempdir = None

171

228

172

229

def password_encode(self, password):

173

230

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

174

231

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

175

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

176

232

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

233

if len(encoded) > 2048:

234

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

235

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

236

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

237

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

238

return encoded

239

177

240

def encrypt(self, data, password):

178

241

passphrase = self.password_encode(password)

179

with tempfile.NamedTemporaryFile(dir=self.tempdir

180

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

181

244

passfile.write(passphrase)

182

245

passfile.flush()

183

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

246

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

184

247

'--passphrase-file',

185

248

passfile.name]

186

249

+ self.gnupgargs,

187

stdin = subprocess.PIPE,

188

stdout = subprocess.PIPE,

189

stderr = subprocess.PIPE)

190

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

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

191

254

if proc.returncode != 0:

192

255

raise PGPError(err)

193

256

return ciphertext

194

257

195

258

def decrypt(self, data, password):

196

259

passphrase = self.password_encode(password)

197

with tempfile.NamedTemporaryFile(dir = self.tempdir

198

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

199

262

passfile.write(passphrase)

200

263

passfile.flush()

201

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

264

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

202

265

'--passphrase-file',

203

266

passfile.name]

204

267

+ self.gnupgargs,

205

stdin = subprocess.PIPE,

206

stdout = subprocess.PIPE,

207

stderr = subprocess.PIPE)

208

decrypted_plaintext, err = proc.communicate(input

209

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

210

272

if proc.returncode != 0:

211

273

raise PGPError(err)

212

274

return decrypted_plaintext

213

275

214

276

277

# Pretend that we have an Avahi module

278

class avahi(object):

279

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

280

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

281

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

282

PROTO_INET = 0 # avahi-common/address.h

283

PROTO_INET6 = 1 # avahi-common/address.h

284

DBUS_NAME = "org.freedesktop.Avahi"

285

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

286

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

287

DBUS_PATH_SERVER = "/"

288

289

@staticmethod

290

def string_array_to_txt_array(t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

302

215

303

class AvahiError(Exception):

216

304

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

217

305

self.value = value

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

306

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

307

**kwargs)

308

221

309

222

310

class AvahiServiceError(AvahiError):

223

311

pass

224

312

313

225

314

class AvahiGroupError(AvahiError):

226

315

pass

227

316

228

317

229

318

class AvahiService(object):

230

319

"""An Avahi (Zeroconf) service.

231

320

232

321

Attributes:

233

322

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

234

323

Used to optionally bind to the specified interface.

246

335

server: D-Bus Server

247

336

bus: dbus.SystemBus()

248

337

"""

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

338

339

def __init__(self,

340

interface=avahi.IF_UNSPEC,

341

name=None,

342

servicetype=None,

343

port=None,

344

TXT=None,

345

domain="",

346

host="",

347

max_renames=32768,

348

protocol=avahi.PROTO_UNSPEC,

349

bus=None):

254

350

self.interface = interface

255

351

self.name = name

256

352

self.type = servicetype

265

361

self.server = None

266

362

self.bus = bus

267

363

self.entry_group_state_changed_match = None

268

269

def rename(self):

364

365

def rename(self, remove=True):

270

366

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

271

367

if self.rename_count >= self.max_renames:

272

368

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

273

369

" after %i retries, exiting.",

274

370

self.rename_count)

275

371

raise AvahiServiceError("Too many renames")

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

278

375

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

279

376

self.name)

280

self.remove()

377

if remove:

378

self.remove()

281

379

try:

282

380

self.add()

283

381

except dbus.exceptions.DBusException as error:

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

288

382

if (error.get_dbus_name()

383

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

384

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

385

return self.rename(remove=False)

386

else:

387

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

388

self.cleanup()

389

os._exit(1)

390

289

391

def remove(self):

290

392

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

291

393

if self.entry_group_state_changed_match is not None:

293

395

self.entry_group_state_changed_match = None

294

396

if self.group is not None:

295

397

self.group.Reset()

296

398

297

399

def add(self):

298

400

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

299

401

self.remove()

316

418

dbus.UInt16(self.port),

317

419

avahi.string_array_to_txt_array(self.TXT))

318

420

self.group.Commit()

319

421

320

422

def entry_group_state_changed(self, state, error):

321

423

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

322

424

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

323

425

324

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

325

427

logger.debug("Zeroconf service established.")

326

428

elif state == avahi.ENTRY_GROUP_COLLISION:

328

430

self.rename()

329

431

elif state == avahi.ENTRY_GROUP_FAILURE:

330

432

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

331

unicode(error))

332

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

333

.format(error))

334

433

str(error))

434

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

435

335

436

def cleanup(self):

336

437

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

337

438

if self.group is not None:

342

443

pass

343

444

self.group = None

344

445

self.remove()

345

446

346

447

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

347

448

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

348

449

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

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

450

bad_states = {

451

avahi.SERVER_INVALID: "Zeroconf server invalid",

452

avahi.SERVER_REGISTERING: None,

453

avahi.SERVER_COLLISION: "Zeroconf server name collision",

454

avahi.SERVER_FAILURE: "Zeroconf server failure",

455

}

356

456

if state in bad_states:

357

457

if bad_states[state] is not None:

358

458

if error is None:

361

461

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

362

462

self.cleanup()

363

463

elif state == avahi.SERVER_RUNNING:

364

self.add()

464

try:

465

self.add()

466

except dbus.exceptions.DBusException as error:

467

if (error.get_dbus_name()

468

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

469

logger.info("Local Zeroconf service name"

470

" collision.")

471

return self.rename(remove=False)

472

else:

473

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

474

self.cleanup()

475

os._exit(1)

365

476

else:

366

477

if error is None:

367

478

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

368

479

else:

369

480

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

370

481

371

482

def activate(self):

372

483

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

373

484

if self.server is None:

377

488

follow_name_owner_changes=True),

378

489

avahi.DBUS_INTERFACE_SERVER)

379

490

self.server.connect_to_signal("StateChanged",

380

self.server_state_changed)

491

self.server_state_changed)

381

492

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

382

493

383

494

384

495

class AvahiServiceToSyslog(AvahiService):

385

def rename(self):

496

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

386

497

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

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

498

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

499

syslogger.setFormatter(logging.Formatter(

500

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

501

.format(self.name)))

392

502

return ret

393

503

394

504

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

505

# Pretend that we have a GnuTLS module

506

class gnutls(object):

507

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

508

509

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

510

if library is None:

511

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

512

_library = ctypes.cdll.LoadLibrary(library)

513

del library

514

515

# Unless otherwise indicated, the constants and types below are

516

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

517

518

# Constants

519

E_SUCCESS = 0

520

E_INTERRUPTED = -52

521

E_AGAIN = -28

522

CRT_OPENPGP = 2

523

CRT_RAWPK = 3

524

CLIENT = 2

525

SHUT_RDWR = 0

526

CRD_CERTIFICATE = 1

527

E_NO_CERTIFICATE_FOUND = -49

528

X509_FMT_DER = 0

529

NO_TICKETS = 1<<10

530

ENABLE_RAWPK = 1<<18

531

CTYPE_PEERS = 3

532

KEYID_USE_SHA256 = 1 # gnutls/x509.h

533

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

534

535

# Types

536

class session_int(ctypes.Structure):

537

_fields_ = []

538

session_t = ctypes.POINTER(session_int)

539

540

class certificate_credentials_st(ctypes.Structure):

541

_fields_ = []

542

certificate_credentials_t = ctypes.POINTER(

543

certificate_credentials_st)

544

certificate_type_t = ctypes.c_int

545

546

class datum_t(ctypes.Structure):

547

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

548

('size', ctypes.c_uint)]

549

550

class openpgp_crt_int(ctypes.Structure):

551

_fields_ = []

552

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

553

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

554

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

555

credentials_type_t = ctypes.c_int

556

transport_ptr_t = ctypes.c_void_p

557

close_request_t = ctypes.c_int

558

559

# Exceptions

560

class Error(Exception):

561

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

562

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

563

# code is passed, convert it to a string with

564

# gnutls.strerror()

565

self.code = code

566

if message is None and code is not None:

567

message = gnutls.strerror(code)

568

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

569

message, *args)

570

571

class CertificateSecurityError(Error):

572

pass

573

574

# Classes

575

class Credentials(object):

576

def __init__(self):

577

self._c_object = gnutls.certificate_credentials_t()

578

gnutls.certificate_allocate_credentials(

579

ctypes.byref(self._c_object))

580

self.type = gnutls.CRD_CERTIFICATE

581

582

def __del__(self):

583

gnutls.certificate_free_credentials(self._c_object)

584

585

class ClientSession(object):

586

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

587

self._c_object = gnutls.session_t()

588

gnutls_flags = gnutls.CLIENT

589

if gnutls.check_version("3.5.6"):

590

gnutls_flags |= gnutls.NO_TICKETS

591

if gnutls.has_rawpk:

592

gnutls_flags |= gnutls.ENABLE_RAWPK

593

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

594

del gnutls_flags

595

gnutls.set_default_priority(self._c_object)

596

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

597

gnutls.handshake_set_private_extensions(self._c_object,

598

True)

599

self.socket = socket

600

if credentials is None:

601

credentials = gnutls.Credentials()

602

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

603

ctypes.cast(credentials._c_object,

604

ctypes.c_void_p))

605

self.credentials = credentials

606

607

def __del__(self):

608

gnutls.deinit(self._c_object)

609

610

def handshake(self):

611

return gnutls.handshake(self._c_object)

612

613

def send(self, data):

614

data = bytes(data)

615

data_len = len(data)

616

while data_len > 0:

617

data_len -= gnutls.record_send(self._c_object,

618

data[-data_len:],

619

data_len)

620

621

def bye(self):

622

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

623

624

# Error handling functions

625

def _error_code(result):

626

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

627

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

628

if result >= 0:

629

return result

630

if result == gnutls.E_NO_CERTIFICATE_FOUND:

631

raise gnutls.CertificateSecurityError(code=result)

632

raise gnutls.Error(code=result)

633

634

def _retry_on_error(result, func, arguments):

635

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

636

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

637

while result < 0:

638

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

639

return _error_code(result)

640

result = func(*arguments)

641

return result

642

643

# Unless otherwise indicated, the function declarations below are

644

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

645

646

# Functions

647

priority_set_direct = _library.gnutls_priority_set_direct

648

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

649

ctypes.POINTER(ctypes.c_char_p)]

650

priority_set_direct.restype = _error_code

651

652

init = _library.gnutls_init

653

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

654

init.restype = _error_code

655

656

set_default_priority = _library.gnutls_set_default_priority

657

set_default_priority.argtypes = [session_t]

658

set_default_priority.restype = _error_code

659

660

record_send = _library.gnutls_record_send

661

record_send.argtypes = [session_t, ctypes.c_void_p,

662

ctypes.c_size_t]

663

record_send.restype = ctypes.c_ssize_t

664

record_send.errcheck = _retry_on_error

665

666

certificate_allocate_credentials = (

667

_library.gnutls_certificate_allocate_credentials)

668

certificate_allocate_credentials.argtypes = [

669

ctypes.POINTER(certificate_credentials_t)]

670

certificate_allocate_credentials.restype = _error_code

671

672

certificate_free_credentials = (

673

_library.gnutls_certificate_free_credentials)

674

certificate_free_credentials.argtypes = [

675

certificate_credentials_t]

676

certificate_free_credentials.restype = None

677

678

handshake_set_private_extensions = (

679

_library.gnutls_handshake_set_private_extensions)

680

handshake_set_private_extensions.argtypes = [session_t,

681

ctypes.c_int]

682

handshake_set_private_extensions.restype = None

683

684

credentials_set = _library.gnutls_credentials_set

685

credentials_set.argtypes = [session_t, credentials_type_t,

686

ctypes.c_void_p]

687

credentials_set.restype = _error_code

688

689

strerror = _library.gnutls_strerror

690

strerror.argtypes = [ctypes.c_int]

691

strerror.restype = ctypes.c_char_p

692

693

certificate_type_get = _library.gnutls_certificate_type_get

694

certificate_type_get.argtypes = [session_t]

695

certificate_type_get.restype = _error_code

696

697

certificate_get_peers = _library.gnutls_certificate_get_peers

698

certificate_get_peers.argtypes = [session_t,

699

ctypes.POINTER(ctypes.c_uint)]

700

certificate_get_peers.restype = ctypes.POINTER(datum_t)

701

702

global_set_log_level = _library.gnutls_global_set_log_level

703

global_set_log_level.argtypes = [ctypes.c_int]

704

global_set_log_level.restype = None

705

706

global_set_log_function = _library.gnutls_global_set_log_function

707

global_set_log_function.argtypes = [log_func]

708

global_set_log_function.restype = None

709

710

deinit = _library.gnutls_deinit

711

deinit.argtypes = [session_t]

712

deinit.restype = None

713

714

handshake = _library.gnutls_handshake

715

handshake.argtypes = [session_t]

716

handshake.restype = _error_code

717

handshake.errcheck = _retry_on_error

718

719

transport_set_ptr = _library.gnutls_transport_set_ptr

720

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

721

transport_set_ptr.restype = None

722

723

bye = _library.gnutls_bye

724

bye.argtypes = [session_t, close_request_t]

725

bye.restype = _error_code

726

bye.errcheck = _retry_on_error

727

728

check_version = _library.gnutls_check_version

729

check_version.argtypes = [ctypes.c_char_p]

730

check_version.restype = ctypes.c_char_p

731

732

_need_version = b"3.3.0"

733

if check_version(_need_version) is None:

734

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

735

.format(_need_version))

736

737

_tls_rawpk_version = b"3.6.6"

738

has_rawpk = bool(check_version(_tls_rawpk_version))

739

740

if has_rawpk:

741

# Types

742

class pubkey_st(ctypes.Structure):

743

_fields = []

744

pubkey_t = ctypes.POINTER(pubkey_st)

745

746

x509_crt_fmt_t = ctypes.c_int

747

748

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

749

pubkey_init = _library.gnutls_pubkey_init

750

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

751

pubkey_init.restype = _error_code

752

753

pubkey_import = _library.gnutls_pubkey_import

754

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

755

x509_crt_fmt_t]

756

pubkey_import.restype = _error_code

757

758

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

759

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

760

ctypes.POINTER(ctypes.c_ubyte),

761

ctypes.POINTER(ctypes.c_size_t)]

762

pubkey_get_key_id.restype = _error_code

763

764

pubkey_deinit = _library.gnutls_pubkey_deinit

765

pubkey_deinit.argtypes = [pubkey_t]

766

pubkey_deinit.restype = None

767

else:

768

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

769

770

openpgp_crt_init = _library.gnutls_openpgp_crt_init

771

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

772

openpgp_crt_init.restype = _error_code

773

774

openpgp_crt_import = _library.gnutls_openpgp_crt_import

775

openpgp_crt_import.argtypes = [openpgp_crt_t,

776

ctypes.POINTER(datum_t),

777

openpgp_crt_fmt_t]

778

openpgp_crt_import.restype = _error_code

779

780

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

781

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

782

ctypes.POINTER(ctypes.c_uint)]

783

openpgp_crt_verify_self.restype = _error_code

784

785

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

786

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

787

openpgp_crt_deinit.restype = None

788

789

openpgp_crt_get_fingerprint = (

790

_library.gnutls_openpgp_crt_get_fingerprint)

791

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

792

ctypes.c_void_p,

793

ctypes.POINTER(

794

ctypes.c_size_t)]

795

openpgp_crt_get_fingerprint.restype = _error_code

796

797

if check_version("3.6.4"):

798

certificate_type_get2 = _library.gnutls_certificate_type_get2

799

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

800

certificate_type_get2.restype = _error_code

801

802

# Remove non-public functions

803

del _error_code, _retry_on_error

804

805

806

def call_pipe(connection, # : multiprocessing.Connection

807

func, *args, **kwargs):

808

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

809

810

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

811

return value on the provided multiprocessing.Connection.

812

"""

813

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

814

connection.close()

400

815

401

816

402

817

class Client(object):

403

818

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

404

819

405

820

Attributes:

406

821

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

407

822

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

409

824

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

410

825

to see if the client lives.

411

826

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

827

checker_callback_tag: a GLib event source tag, or None

413

828

checker_command: string; External command which is run to check

414

829

if client lives. %() expansions are done at

415

830

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

416

831

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

417

checker_initiator_tag: a gobject event source tag, or None

832

checker_initiator_tag: a GLib event source tag, or None

418

833

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

419

834

client_structure: Object describing what attributes a client has

420

835

and is used for storing the client at exit

421

836

current_checker_command: string; current running checker_command

422

disable_initiator_tag: a gobject event source tag, or None

837

disable_initiator_tag: a GLib event source tag, or None

423

838

enabled: bool()

424

839

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

425

uniquely identify the client

840

uniquely identify an OpenPGP client

841

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

842

a client using raw public keys

426

843

host: string; available for use by the checker command

427

844

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

428

845

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

430

847

last_checker_status: integer between 0 and 255 reflecting exit

431

848

status of last checker. -1 reflects crashed

432

849

checker, -2 means no checker completed yet.

850

last_checker_signal: The signal which killed the last checker, if

851

last_checker_status is -1

433

852

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

434

853

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

435

854

D-Bus identifiers

440

859

runtime_expansions: Allowed attributes for runtime expansion.

441

860

expires: datetime.datetime(); time (UTC) when a client will be

442

861

disabled, or None

862

server_settings: The server_settings dict from main()

443

863

"""

444

864

445

865

runtime_expansions = ("approval_delay", "approval_duration",

446

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

866

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

447

867

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

448

868

"last_approval_request", "last_checked_ok",

449

869

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

450

client_defaults = { "timeout": "PT5M",

451

"extended_timeout": "PT15M",

452

"interval": "PT2M",

453

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

454

"host": "",

455

"approval_delay": "PT0S",

456

"approval_duration": "PT1S",

457

"approved_by_default": "True",

458

"enabled": "True",

459

}

460

461

def timeout_milliseconds(self):

462

"Return the 'timeout' attribute in milliseconds"

463

return timedelta_to_milliseconds(self.timeout)

464

465

def extended_timeout_milliseconds(self):

466

"Return the 'extended_timeout' attribute in milliseconds"

467

return timedelta_to_milliseconds(self.extended_timeout)

468

469

def interval_milliseconds(self):

470

"Return the 'interval' attribute in milliseconds"

471

return timedelta_to_milliseconds(self.interval)

472

473

def approval_delay_milliseconds(self):

474

return timedelta_to_milliseconds(self.approval_delay)

475

870

client_defaults = {

871

"timeout": "PT5M",

872

"extended_timeout": "PT15M",

873

"interval": "PT2M",

874

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

875

"host": "",

876

"approval_delay": "PT0S",

877

"approval_duration": "PT1S",

878

"approved_by_default": "True",

879

"enabled": "True",

880

}

881

476

882

@staticmethod

477

883

def config_parser(config):

478

884

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

485

891

for client_name in config.sections():

486

892

section = dict(config.items(client_name))

487

893

client = settings[client_name] = {}

488

894

489

895

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

490

896

# Reformat values from string types to Python types

491

897

client["approved_by_default"] = config.getboolean(

492

898

client_name, "approved_by_default")

493

899

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

494

900

"enabled")

495

901

902

# Uppercase and remove spaces from key_id and fingerprint

903

# for later comparison purposes with return value from the

904

# key_id() and fingerprint() functions

905

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

906

.replace(" ", ""))

496

907

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

497

908

.replace(" ", ""))

498

909

if "secret" in section:

499

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

910

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

911

.encode("utf-8"),

912

"base64")

500

913

elif "secfile" in section:

501

914

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

502

915

(section["secfile"])),

503

916

"rb") as secfile:

504

917

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

505

918

else:

506

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

919

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

507

920

.format(section))

508

921

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

509

922

client["extended_timeout"] = string_to_delta(

517

930

client["last_approval_request"] = None

518

931

client["last_checked_ok"] = None

519

932

client["last_checker_status"] = -2

520

933

521

934

return settings

522

523

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

935

936

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

524

937

self.name = name

938

if server_settings is None:

939

server_settings = {}

940

self.server_settings = server_settings

525

941

# adding all client settings

526

for setting, value in settings.iteritems():

942

for setting, value in settings.items():

527

943

setattr(self, setting, value)

528

944

529

945

if self.enabled:

530

946

if not hasattr(self, "last_enabled"):

531

947

self.last_enabled = datetime.datetime.utcnow()

535

951

else:

536

952

self.last_enabled = None

537

953

self.expires = None

538

954

539

955

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

540

# Uppercase and remove spaces from fingerprint for later

541

# comparison purposes with return value from the fingerprint()

542

# function

956

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

543

957

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

544

958

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

545

959

datetime.datetime.utcnow())

546

960

547

961

# attributes specific for this server instance

548

962

self.checker = None

549

963

self.checker_initiator_tag = None

552

966

self.current_checker_command = None

553

967

self.approved = None

554

968

self.approvals_pending = 0

555

self.changedstate = (multiprocessing_manager

556

.Condition(multiprocessing_manager

557

.Lock()))

558

self.client_structure = [attr for attr in

559

self.__dict__.iterkeys()

969

self.changedstate = multiprocessing_manager.Condition(

970

multiprocessing_manager.Lock())

971

self.client_structure = [attr

972

for attr in self.__dict__.keys()

560

973

if not attr.startswith("_")]

561

974

self.client_structure.append("client_structure")

562

563

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

564

lambda obj:

565

isinstance(obj,

566

property)):

975

976

for name, t in inspect.getmembers(

977

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

567

978

if not name.startswith("_"):

568

979

self.client_structure.append(name)

569

980

570

981

# Send notice to process children that client state has changed

571

982

def send_changedstate(self):

572

983

with self.changedstate:

573

984

self.changedstate.notify_all()

574

985

575

986

def enable(self):

576

987

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

577

988

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

582

993

self.last_enabled = datetime.datetime.utcnow()

583

994

self.init_checker()

584

995

self.send_changedstate()

585

996

586

997

def disable(self, quiet=True):

587

998

"""Disable this client."""

588

999

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

590

1001

if not quiet:

591

1002

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

592

1003

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

593

gobject.source_remove(self.disable_initiator_tag)

1004

GLib.source_remove(self.disable_initiator_tag)

594

1005

self.disable_initiator_tag = None

595

1006

self.expires = None

596

1007

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

597

gobject.source_remove(self.checker_initiator_tag)

1008

GLib.source_remove(self.checker_initiator_tag)

598

1009

self.checker_initiator_tag = None

599

1010

self.stop_checker()

600

1011

self.enabled = False

601

1012

if not quiet:

602

1013

self.send_changedstate()

603

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

1014

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

604

1015

return False

605

1016

606

1017

def __del__(self):

607

1018

self.disable()

608

1019

609

1020

def init_checker(self):

610

1021

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

611

1022

# and every interval from then on.

612

1023

if self.checker_initiator_tag is not None:

613

gobject.source_remove(self.checker_initiator_tag)

614

self.checker_initiator_tag = (gobject.timeout_add

615

(self.interval_milliseconds(),

616

self.start_checker))

1024

GLib.source_remove(self.checker_initiator_tag)

1025

self.checker_initiator_tag = GLib.timeout_add(

1026

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

1027

self.start_checker)

617

1028

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

618

1029

if self.disable_initiator_tag is not None:

619

gobject.source_remove(self.disable_initiator_tag)

620

self.disable_initiator_tag = (gobject.timeout_add

621

(self.timeout_milliseconds(),

622

self.disable))

1030

GLib.source_remove(self.disable_initiator_tag)

1031

self.disable_initiator_tag = GLib.timeout_add(

1032

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

623

1033

# Also start a new checker *right now*.

624

1034

self.start_checker()

625

626

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

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

627

1038

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

628

1039

self.checker_callback_tag = None

629

1040

self.checker = None

630

if os.WIFEXITED(condition):

631

self.last_checker_status = os.WEXITSTATUS(condition)

1041

# Read return code from connection (see call_pipe)

1042

returncode = connection.recv()

1043

connection.close()

1044

1045

if returncode >= 0:

1046

self.last_checker_status = returncode

1047

self.last_checker_signal = None

632

1048

if self.last_checker_status == 0:

633

1049

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

634

1050

vars(self))

635

1051

self.checked_ok()

636

1052

else:

637

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

638

vars(self))

1053

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

639

1054

else:

640

1055

self.last_checker_status = -1

1056

self.last_checker_signal = -returncode

641

1057

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

642

1058

vars(self))

643

1059

return False

1060

644

1061

def checked_ok(self):

645

1062

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

646

1063

self.last_checked_ok = datetime.datetime.utcnow()

647

1064

self.last_checker_status = 0

1065

self.last_checker_signal = None

648

1066

self.bump_timeout()

649

1067

650

1068

def bump_timeout(self, timeout=None):

651

1069

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

652

1070

if timeout is None:

653

1071

timeout = self.timeout

654

1072

if self.disable_initiator_tag is not None:

655

gobject.source_remove(self.disable_initiator_tag)

1073

GLib.source_remove(self.disable_initiator_tag)

656

1074

self.disable_initiator_tag = None

657

1075

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

658

self.disable_initiator_tag = (gobject.timeout_add

659

(timedelta_to_milliseconds

660

(timeout), self.disable))

1076

self.disable_initiator_tag = GLib.timeout_add(

1077

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

661

1078

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

662

1079

663

1080

def need_approval(self):

664

1081

self.last_approval_request = datetime.datetime.utcnow()

665

1082

666

1083

def start_checker(self):

667

1084

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

668

1085

669

1086

If a checker already exists, leave it running and do

670

1087

nothing."""

671

1088

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

676

1093

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

677

1094

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

678

1095

# should be.

679

680

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

681

try:

682

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

683

except (AttributeError, OSError) as error:

684

if (isinstance(error, OSError)

685

and error.errno != errno.ECHILD):

686

raise error

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

1096

1097

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

1098

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

1099

self.checker.join()

1100

self.checker = None

693

1101

# Start a new checker if needed

694

1102

if self.checker is None:

695

1103

# Escape attributes for the shell

696

escaped_attrs = dict(

697

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

698

for attr in

699

self.runtime_expansions)

1104

escaped_attrs = {

1105

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

1106

for attr in self.runtime_expansions}

700

1107

try:

701

1108

command = self.checker_command % escaped_attrs

702

1109

except TypeError as error:

703

1110

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

704

self.checker_command, exc_info=error)

705

return True # Try again later

1111

self.checker_command,

1112

exc_info=error)

1113

return True # Try again later

706

1114

self.current_checker_command = command

707

try:

708

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

709

command, self.name)

710

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

711

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

712

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

713

# always replaced by /dev/null.)

714

self.checker = subprocess.Popen(command,

715

close_fds=True,

716

shell=True, cwd="/")

717

except OSError as error:

718

logger.error("Failed to start subprocess",

719

exc_info=error)

720

return True

721

self.checker_callback_tag = (gobject.child_watch_add

722

(self.checker.pid,

723

self.checker_callback,

724

data=command))

725

# The checker may have completed before the gobject

726

# watch was added. Check for this.

727

try:

728

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

729

except OSError as error:

730

if error.errno == errno.ECHILD:

731

# This should never happen

732

logger.error("Child process vanished",

733

exc_info=error)

734

return True

735

raise

736

if pid:

737

gobject.source_remove(self.checker_callback_tag)

738

self.checker_callback(pid, status, command)

739

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

1115

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

1116

self.name)

1117

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

1118

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

1119

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

1120

# always replaced by /dev/null.)

1121

# The exception is when not debugging but nevertheless

1122

# running in the foreground; use the previously

1123

# created wnull.

1124

popen_args = {"close_fds": True,

1125

"shell": True,

1126

"cwd": "/"}

1127

if (not self.server_settings["debug"]

1128

and self.server_settings["foreground"]):

1129

popen_args.update({"stdout": wnull,

1130

"stderr": wnull})

1131

pipe = multiprocessing.Pipe(duplex=False)

1132

self.checker = multiprocessing.Process(

1133

target=call_pipe,

1134

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

1135

kwargs=popen_args)

1136

self.checker.start()

1137

self.checker_callback_tag = GLib.io_add_watch(

1138

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

1139

self.checker_callback, pipe[0], command)

1140

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

740

1141

return True

741

1142

742

1143

def stop_checker(self):

743

1144

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

744

1145

if self.checker_callback_tag:

745

gobject.source_remove(self.checker_callback_tag)

1146

GLib.source_remove(self.checker_callback_tag)

746

1147

self.checker_callback_tag = None

747

1148

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

748

1149

return

749

1150

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

750

try:

751

self.checker.terminate()

752

#time.sleep(0.5)

753

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

754

# self.checker.kill()

755

except OSError as error:

756

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

757

raise

1151

self.checker.terminate()

758

1152

self.checker = None

759

1153

760

1154

761

def dbus_service_property(dbus_interface, signature="v",

762

access="readwrite", byte_arrays=False):

1155

def dbus_service_property(dbus_interface,

1156

signature="v",

1157

access="readwrite",

1158

byte_arrays=False):

763

1159

"""Decorators for marking methods of a DBusObjectWithProperties to

764

1160

become properties on the D-Bus.

765

1161

766

1162

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

767

1163

and with one argument by "Set".

768

1164

769

1165

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

770

1166

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

771

1167

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

774

1170

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

775

1171

if byte_arrays and signature != "ay":

776

1172

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

777

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

1173

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

1174

778

1175

def decorator(func):

779

1176

func._dbus_is_property = True

780

1177

func._dbus_interface = dbus_interface

783

1180

func._dbus_name = func.__name__

784

1181

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

785

1182

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

786

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1183

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

787

1184

return func

1185

788

1186

return decorator

789

1187

790

1188

791

1189

def dbus_interface_annotations(dbus_interface):

792

1190

"""Decorator for marking functions returning interface annotations

793

1191

794

1192

Usage:

795

1193

796

1194

@dbus_interface_annotations("org.example.Interface")

797

1195

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

798

1196

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

799

1197

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

800

1198

"false"}

801

1199

"""

1200

802

1201

def decorator(func):

803

1202

func._dbus_is_interface = True

804

1203

func._dbus_interface = dbus_interface

805

1204

func._dbus_name = dbus_interface

806

1205

return func

1206

807

1207

return decorator

808

1208

809

1209

810

1210

def dbus_annotations(annotations):

811

1211

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

812

1212

Usage:

813

1213

1214

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

1215

"org.freedesktop.DBus.Property."

1216

"EmitsChangedSignal": "false"})

814

1217

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

815

1218

access="r")

816

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

817

"org.freedesktop.DBus.Property."

818

"EmitsChangedSignal": "false"})

819

1219

def Property_dbus_property(self):

820

1220

return dbus.Boolean(False)

1221

1222

See also the DBusObjectWithAnnotations class.

821

1223

"""

1224

822

1225

def decorator(func):

823

1226

func._dbus_annotations = annotations

824

1227

return func

1228

825

1229

return decorator

826

1230

827

1231

828

1232

class DBusPropertyException(dbus.exceptions.DBusException):

829

1233

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

830

1234

"""

831

def __unicode__(self):

832

return unicode(str(self))

1235

pass

833

1236

834

1237

835

1238

class DBusPropertyAccessException(DBusPropertyException):

844

1247

pass

845

1248

846

1249

847

class DBusObjectWithProperties(dbus.service.Object):

848

"""A D-Bus object with properties.

849

850

Classes inheriting from this can use the dbus_service_property

851

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

852

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

1250

class DBusObjectWithAnnotations(dbus.service.Object):

1251

"""A D-Bus object with annotations.

1252

1253

Classes inheriting from this can use the dbus_annotations

1254

decorator to add annotations to methods or signals.

853

1255

"""

854

1256

855

1257

@staticmethod

856

1258

def _is_dbus_thing(thing):

857

1259

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

858

1260

859

1261

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

860

1262

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

861

1263

"""

862

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

1264

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

863

1265

False)

864

1266

865

1267

def _get_all_dbus_things(self, thing):

866

1268

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

867

1269

"""

868

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

869

name),

1270

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

870

1271

athing.__get__(self))

871

1272

for cls in self.__class__.__mro__

872

1273

for name, athing in

873

inspect.getmembers(cls,

874

self._is_dbus_thing(thing)))

875

1274

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

1275

1276

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1277

out_signature="s",

1278

path_keyword='object_path',

1279

connection_keyword='connection')

1280

def Introspect(self, object_path, connection):

1281

"""Overloading of standard D-Bus method.

1282

1283

Inserts annotation tags on methods and signals.

1284

"""

1285

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

1286

connection)

1287

try:

1288

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

1289

1290

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

1291

# Add annotation tags

1292

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

1293

for tag in if_tag.getElementsByTagName(typ):

1294

annots = dict()

1295

for name, prop in (self.

1296

_get_all_dbus_things(typ)):

1297

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

1298

and prop._dbus_interface

1299

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

1300

annots.update(getattr(

1301

prop, "_dbus_annotations", {}))

1302

for name, value in annots.items():

1303

ann_tag = document.createElement(

1304

"annotation")

1305

ann_tag.setAttribute("name", name)

1306

ann_tag.setAttribute("value", value)

1307

tag.appendChild(ann_tag)

1308

# Add interface annotation tags

1309

for annotation, value in dict(

1310

itertools.chain.from_iterable(

1311

annotations().items()

1312

for name, annotations

1313

in self._get_all_dbus_things("interface")

1314

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

1315

)).items():

1316

ann_tag = document.createElement("annotation")

1317

ann_tag.setAttribute("name", annotation)

1318

ann_tag.setAttribute("value", value)

1319

if_tag.appendChild(ann_tag)

1320

# Fix argument name for the Introspect method itself

1321

if (if_tag.getAttribute("name")

1322

== dbus.INTROSPECTABLE_IFACE):

1323

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

1324

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

1325

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

1326

if (arg.getAttribute("direction")

1327

== "out"):

1328

arg.setAttribute("name",

1329

"xml_data")

1330

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

1331

document.unlink()

1332

except (AttributeError, xml.dom.DOMException,

1333

xml.parsers.expat.ExpatError) as error:

1334

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

1335

exc_info=error)

1336

return xmlstring

1337

1338

1339

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1340

"""A D-Bus object with properties.

1341

1342

Classes inheriting from this can use the dbus_service_property

1343

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

1344

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

1345

"""

1346

876

1347

def _get_dbus_property(self, interface_name, property_name):

877

1348

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

878

1349

property with the specified name and interface.

879

1350

"""

880

for cls in self.__class__.__mro__:

881

for name, value in (inspect.getmembers

882

(cls,

883

self._is_dbus_thing("property"))):

1351

for cls in self.__class__.__mro__:

1352

for name, value in inspect.getmembers(

1353

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

884

1354

if (value._dbus_name == property_name

885

1355

and value._dbus_interface == interface_name):

886

1356

return value.__get__(self)

887

1357

888

1358

# No such property

889

raise DBusPropertyNotFound(self.dbus_object_path + ":"

890

+ interface_name + "."

891

+ property_name)

892

893

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

1359

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

1360

self.dbus_object_path, interface_name, property_name))

1361

1362

@classmethod

1363

def _get_all_interface_names(cls):

1364

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

1365

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

1366

"_dbus_interface", None)

1367

for x in (inspect.getmro(cls))

1368

for attr in dir(x))

1369

if name is not None)

1370

1371

@dbus.service.method(dbus.PROPERTIES_IFACE,

1372

in_signature="ss",

894

1373

out_signature="v")

895

1374

def Get(self, interface_name, property_name):

896

1375

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

902

1381

if not hasattr(value, "variant_level"):

903

1382

return value

904

1383

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

905

1384

906

1385

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

907

1386

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

908

1387

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

914

1393

# The byte_arrays option is not supported yet on

915

1394

# signatures other than "ay".

916

1395

if prop._dbus_signature != "ay":

917

raise ValueError

1396

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

1397

"'ay' signature {!r}"

1398

.format(prop._dbus_signature))

918

1399

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

919

1400

for byte in value))

920

1401

prop(value)

921

922

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

1402

1403

@dbus.service.method(dbus.PROPERTIES_IFACE,

1404

in_signature="s",

923

1405

out_signature="a{sv}")

924

1406

def GetAll(self, interface_name):

925

1407

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

926

1408

standard.

927

1409

928

1410

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

929

1411

"""

930

1412

properties = {}

940

1422

if not hasattr(value, "variant_level"):

941

1423

properties[name] = value

942

1424

continue

943

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

944

value.variant_level+1)

1425

properties[name] = type(value)(

1426

value, variant_level=value.variant_level + 1)

945

1427

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

946

1428

1429

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

1430

def PropertiesChanged(self, interface_name, changed_properties,

1431

invalidated_properties):

1432

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

1433

standard.

1434

"""

1435

pass

1436

947

1437

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

948

1438

out_signature="s",

949

1439

path_keyword='object_path',

950

1440

connection_keyword='connection')

951

1441

def Introspect(self, object_path, connection):

952

1442

"""Overloading of standard D-Bus method.

953

1443

954

1444

Inserts property tags and interface annotation tags.

955

1445

"""

956

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

957

connection)

1446

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1447

object_path,

1448

connection)

958

1449

try:

959

1450

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

1451

960

1452

def make_tag(document, name, prop):

961

1453

e = document.createElement("property")

962

1454

e.setAttribute("name", name)

963

1455

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

964

1456

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

965

1457

return e

1458

966

1459

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

967

1460

# Add property tags

968

1461

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

971

1464

if prop._dbus_interface

972

1465

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

973

1466

if_tag.appendChild(tag)

974

# Add annotation tags

975

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

976

for tag in if_tag.getElementsByTagName(typ):

977

annots = dict()

978

for name, prop in (self.

979

_get_all_dbus_things(typ)):

980

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

981

and prop._dbus_interface

982

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

983

annots.update(getattr

984

(prop,

985

"_dbus_annotations",

986

{}))

987

for name, value in annots.iteritems():

988

ann_tag = document.createElement(

989

"annotation")

990

ann_tag.setAttribute("name", name)

991

ann_tag.setAttribute("value", value)

992

tag.appendChild(ann_tag)

993

# Add interface annotation tags

994

for annotation, value in dict(

995

itertools.chain.from_iterable(

996

annotations().iteritems()

997

for name, annotations in

998

self._get_all_dbus_things("interface")

999

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

1000

)).iteritems():

1001

ann_tag = document.createElement("annotation")

1002

ann_tag.setAttribute("name", annotation)

1003

ann_tag.setAttribute("value", value)

1004

if_tag.appendChild(ann_tag)

1467

# Add annotation tags for properties

1468

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

1469

annots = dict()

1470

for name, prop in self._get_all_dbus_things(

1471

"property"):

1472

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

1473

and prop._dbus_interface

1474

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

1475

annots.update(getattr(

1476

prop, "_dbus_annotations", {}))

1477

for name, value in annots.items():

1478

ann_tag = document.createElement(

1479

"annotation")

1480

ann_tag.setAttribute("name", name)

1481

ann_tag.setAttribute("value", value)

1482

tag.appendChild(ann_tag)

1005

1483

# Add the names to the return values for the

1006

1484

# "org.freedesktop.DBus.Properties" methods

1007

1485

if (if_tag.getAttribute("name")

1026

1504

return xmlstring

1027

1505

1028

1506

1507

try:

1508

dbus.OBJECT_MANAGER_IFACE

1509

except AttributeError:

1510

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

1511

1512

1513

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1514

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

1515

1516

Classes inheriting from this exposes the standard

1517

GetManagedObjects call and the InterfacesAdded and

1518

InterfacesRemoved signals on the standard

1519

"org.freedesktop.DBus.ObjectManager" interface.

1520

1521

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

1522

manually.

1523

"""

1524

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1525

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

1526

def GetManagedObjects(self):

1527

"""This function must be overridden"""

1528

raise NotImplementedError()

1529

1530

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1531

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

1532

def InterfacesAdded(self, object_path, interfaces_and_properties):

1533

pass

1534

1535

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

1536

def InterfacesRemoved(self, object_path, interfaces):

1537

pass

1538

1539

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1540

out_signature="s",

1541

path_keyword='object_path',

1542

connection_keyword='connection')

1543

def Introspect(self, object_path, connection):

1544

"""Overloading of standard D-Bus method.

1545

1546

Override return argument name of GetManagedObjects to be

1547

"objpath_interfaces_and_properties"

1548

"""

1549

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1550

object_path,

1551

connection)

1552

try:

1553

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

1554

1555

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

1556

# Fix argument name for the GetManagedObjects method

1557

if (if_tag.getAttribute("name")

1558

== dbus.OBJECT_MANAGER_IFACE):

1559

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

1560

if (cn.getAttribute("name")

1561

== "GetManagedObjects"):

1562

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

1563

if (arg.getAttribute("direction")

1564

== "out"):

1565

arg.setAttribute(

1566

"name",

1567

"objpath_interfaces"

1568

"_and_properties")

1569

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

1570

document.unlink()

1571

except (AttributeError, xml.dom.DOMException,

1572

xml.parsers.expat.ExpatError) as error:

1573

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

1574

exc_info=error)

1575

return xmlstring

1576

1577

1029

1578

def datetime_to_dbus(dt, variant_level=0):

1030

1579

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

1031

1580

if dt is None:

1032

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

1033

return dbus.String(dt.isoformat(),

1034

variant_level=variant_level)

1581

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

1582

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

1035

1583

1036

1584

1037

1585

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1039

1587

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

1040

1588

interface names according to the "alt_interface_names" mapping.

1041

1589

Usage:

1042

1590

1043

1591

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

1044

1592

"net.example.AlternateInterface"})

1045

1593

class SampleDBusObject(dbus.service.Object):

1046

1594

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

1047

1595

def SampleDBusMethod():

1048

1596

pass

1049

1597

1050

1598

The above "SampleDBusMethod" on "SampleDBusObject" will be

1051

1599

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

1052

1600

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

1053

1601

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

1054

1602

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

1055

1603

1056

1604

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

1057

1605

(from DBusObjectWithProperties) and interfaces (from the

1058

1606

dbus_interface_annotations decorator).

1059

1607

"""

1608

1060

1609

def wrapper(cls):

1061

1610

for orig_interface_name, alt_interface_name in (

1062

alt_interface_names.iteritems()):

1611

alt_interface_names.items()):

1063

1612

attr = {}

1064

1613

interface_names = set()

1065

1614

# Go though all attributes of the class

1067

1616

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

1068

1617

# with the wrong interface name

1069

1618

if (not hasattr(attribute, "_dbus_interface")

1070

or not attribute._dbus_interface

1071

.startswith(orig_interface_name)):

1619

or not attribute._dbus_interface.startswith(

1620

orig_interface_name)):

1072

1621

continue

1073

1622

# Create an alternate D-Bus interface name based on

1074

1623

# the current name

1075

alt_interface = (attribute._dbus_interface

1076

.replace(orig_interface_name,

1077

alt_interface_name))

1624

alt_interface = attribute._dbus_interface.replace(

1625

orig_interface_name, alt_interface_name)

1078

1626

interface_names.add(alt_interface)

1079

1627

# Is this a D-Bus signal?

1080

1628

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

1081

1629

# Extract the original non-method undecorated

1082

1630

# function by black magic

1083

nonmethod_func = (dict(

1631

if sys.version_info.major == 2:

1632

nonmethod_func = (dict(

1084

1633

zip(attribute.func_code.co_freevars,

1085

attribute.__closure__))["func"]

1086

.cell_contents)

1634

attribute.__closure__))

1635

["func"].cell_contents)

1636

else:

1637

nonmethod_func = (dict(

1638

zip(attribute.__code__.co_freevars,

1639

attribute.__closure__))

1640

["func"].cell_contents)

1087

1641

# Create a new, but exactly alike, function

1088

1642

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

1089

1643

# with the alternate D-Bus interface name

1090

new_function = (dbus.service.signal

1091

(alt_interface,

1092

attribute._dbus_signature)

1093

(types.FunctionType(

1094

nonmethod_func.func_code,

1095

nonmethod_func.func_globals,

1096

nonmethod_func.func_name,

1097

nonmethod_func.func_defaults,

1098

nonmethod_func.func_closure)))

1644

new_function = copy_function(nonmethod_func)

1645

new_function = (dbus.service.signal(

1646

alt_interface,

1647

attribute._dbus_signature)(new_function))

1099

1648

# Copy annotations, if any

1100

1649

try:

1101

new_function._dbus_annotations = (

1102

dict(attribute._dbus_annotations))

1650

new_function._dbus_annotations = dict(

1651

attribute._dbus_annotations)

1103

1652

except AttributeError:

1104

1653

pass

1654

1105

1655

# Define a creator of a function to call both the

1106

1656

# original and alternate functions, so both the

1107

1657

# original and alternate signals gets sent when

1110

1660

"""This function is a scope container to pass

1111

1661

func1 and func2 to the "call_both" function

1112

1662

outside of its arguments"""

1663

1664

@functools.wraps(func2)

1113

1665

def call_both(*args, **kwargs):

1114

1666

"""This function will emit two D-Bus

1115

1667

signals by calling func1 and func2"""

1116

1668

func1(*args, **kwargs)

1117

1669

func2(*args, **kwargs)

1670

# Make wrapper function look like a D-Bus

1671

# signal

1672

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

1673

if name.startswith("_dbus_"):

1674

setattr(call_both, name, attr)

1675

1118

1676

return call_both

1119

1677

# Create the "call_both" function and add it to

1120

1678

# the class

1125

1683

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

1126

1684

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

1127

1685

# to the class.

1128

attr[attrname] = (dbus.service.method

1129

(alt_interface,

1130

attribute._dbus_in_signature,

1131

attribute._dbus_out_signature)

1132

(types.FunctionType

1133

(attribute.func_code,

1134

attribute.func_globals,

1135

attribute.func_name,

1136

attribute.func_defaults,

1137

attribute.func_closure)))

1686

attr[attrname] = (

1687

dbus.service.method(

1688

alt_interface,

1689

attribute._dbus_in_signature,

1690

attribute._dbus_out_signature)

1691

(copy_function(attribute)))

1138

1692

# Copy annotations, if any

1139

1693

try:

1140

attr[attrname]._dbus_annotations = (

1141

dict(attribute._dbus_annotations))

1694

attr[attrname]._dbus_annotations = dict(

1695

attribute._dbus_annotations)

1142

1696

except AttributeError:

1143

1697

pass

1144

1698

# Is this a D-Bus property?

1147

1701

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

1148

1702

# property with the alternate D-Bus interface

1149

1703

# name. Add it to the class.

1150

attr[attrname] = (dbus_service_property

1151

(alt_interface,

1152

attribute._dbus_signature,

1153

attribute._dbus_access,

1154

attribute

1155

._dbus_get_args_options

1156

["byte_arrays"])

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1704

attr[attrname] = (dbus_service_property(

1705

alt_interface, attribute._dbus_signature,

1706

attribute._dbus_access,

1707

attribute._dbus_get_args_options

1708

["byte_arrays"])

1709

(copy_function(attribute)))

1163

1710

# Copy annotations, if any

1164

1711

try:

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1712

attr[attrname]._dbus_annotations = dict(

1713

attribute._dbus_annotations)

1167

1714

except AttributeError:

1168

1715

pass

1169

1716

# Is this a D-Bus interface?

1172

1719

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

1173

1720

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

1174

1721

# to the class.

1175

attr[attrname] = (dbus_interface_annotations

1176

(alt_interface)

1177

(types.FunctionType

1178

(attribute.func_code,

1179

attribute.func_globals,

1180

attribute.func_name,

1181

attribute.func_defaults,

1182

attribute.func_closure)))

1722

attr[attrname] = (

1723

dbus_interface_annotations(alt_interface)

1724

(copy_function(attribute)))

1183

1725

if deprecate:

1184

1726

# Deprecate all alternate interfaces

1185

iname="_AlternateDBusNames_interface_annotation{0}"

1727

iname = "_AlternateDBusNames_interface_annotation{}"

1186

1728

for interface_name in interface_names:

1729

1187

1730

@dbus_interface_annotations(interface_name)

1188

1731

def func(self):

1189

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

1190

"true" }

1732

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

1733

"true"}

1191

1734

# Find an unused name

1192

1735

for aname in (iname.format(i)

1193

1736

for i in itertools.count()):

1197

1740

if interface_names:

1198

1741

# Replace the class with a new subclass of it with

1199

1742

# methods, signals, etc. as created above.

1200

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

1201

(cls,), attr)

1743

if sys.version_info.major == 2:

1744

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

1745

(cls, ), attr)

1746

else:

1747

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

1748

(cls, ), attr)

1202

1749

return cls

1750

1203

1751

return wrapper

1204

1752

1205

1753

1206

1754

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

1207

"se.bsnet.fukt.Mandos"})

1755

"se.bsnet.fukt.Mandos"})

1208

1756

class ClientDBus(Client, DBusObjectWithProperties):

1209

1757

"""A Client class using D-Bus

1210

1758

1211

1759

Attributes:

1212

1760

dbus_object_path: dbus.ObjectPath

1213

1761

bus: dbus.SystemBus()

1214

1762

"""

1215

1763

1216

1764

runtime_expansions = (Client.runtime_expansions

1217

+ ("dbus_object_path",))

1218

1765

+ ("dbus_object_path", ))

1766

1767

_interface = "se.recompile.Mandos.Client"

1768

1219

1769

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

1220

1221

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

1770

1771

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

1222

1772

self.bus = bus

1223

1773

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

1224

1774

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

1225

1775

# the D-Bus

1226

client_object_name = unicode(self.name).translate(

1776

client_object_name = str(self.name).translate(

1227

1777

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

1228

1778

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

1229

self.dbus_object_path = (dbus.ObjectPath

1230

("/clients/" + client_object_name))

1779

self.dbus_object_path = dbus.ObjectPath(

1780

"/clients/" + client_object_name)

1231

1781

DBusObjectWithProperties.__init__(self, self.bus,

1232

1782

self.dbus_object_path)

1233

1234

def notifychangeproperty(transform_func,

1235

dbus_name, type_func=lambda x: x,

1236

variant_level=1):

1783

1784

def notifychangeproperty(transform_func, dbus_name,

1785

type_func=lambda x: x,

1786

variant_level=1,

1787

invalidate_only=False,

1788

_interface=_interface):

1237

1789

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

1238

1790

its changes to DBus.

1239

1791

1240

1792

transform_fun: Function that takes a value and a variant_level

1241

1793

and transforms it to a D-Bus type.

1242

1794

dbus_name: D-Bus name of the variable

1244

1796

to the D-Bus. Default: no transform

1245

1797

variant_level: D-Bus variant level. Default: 1

1246

1798

"""

1247

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

1799

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

1800

1248

1801

def setter(self, value):

1249

1802

if hasattr(self, "dbus_object_path"):

1250

1803

if (not hasattr(self, attrname) or

1251

1804

type_func(getattr(self, attrname, None))

1252

1805

!= type_func(value)):

1253

dbus_value = transform_func(type_func(value),

1254

variant_level

1255

=variant_level)

1256

self.PropertyChanged(dbus.String(dbus_name),

1257

dbus_value)

1806

if invalidate_only:

1807

self.PropertiesChanged(

1808

_interface, dbus.Dictionary(),

1809

dbus.Array((dbus_name, )))

1810

else:

1811

dbus_value = transform_func(

1812

type_func(value),

1813

variant_level=variant_level)

1814

self.PropertyChanged(dbus.String(dbus_name),

1815

dbus_value)

1816

self.PropertiesChanged(

1817

_interface,

1818

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

1819

dbus_value}),

1820

dbus.Array())

1258

1821

setattr(self, attrname, value)

1259

1822

1260

1823

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

1261

1824

1262

1825

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1263

1826

approvals_pending = notifychangeproperty(dbus.Boolean,

1264

1827

"ApprovalPending",

1265

type_func = bool)

1828

type_func=bool)

1266

1829

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

1267

1830

last_enabled = notifychangeproperty(datetime_to_dbus,

1268

1831

"LastEnabled")

1269

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

1270

type_func = lambda checker:

1271

checker is not None)

1832

checker = notifychangeproperty(

1833

dbus.Boolean, "CheckerRunning",

1834

type_func=lambda checker: checker is not None)

1272

1835

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1273

1836

"LastCheckedOK")

1274

1837

last_checker_status = notifychangeproperty(dbus.Int16,

1277

1840

datetime_to_dbus, "LastApprovalRequest")

1278

1841

approved_by_default = notifychangeproperty(dbus.Boolean,

1279

1842

"ApprovedByDefault")

1280

approval_delay = notifychangeproperty(dbus.UInt64,

1281

"ApprovalDelay",

1282

type_func =

1283

timedelta_to_milliseconds)

1843

approval_delay = notifychangeproperty(

1844

dbus.UInt64, "ApprovalDelay",

1845

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

1284

1846

approval_duration = notifychangeproperty(

1285

1847

dbus.UInt64, "ApprovalDuration",

1286

type_func = timedelta_to_milliseconds)

1848

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

1287

1849

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

1288

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

1289

type_func =

1290

timedelta_to_milliseconds)

1850

timeout = notifychangeproperty(

1851

dbus.UInt64, "Timeout",

1852

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

1291

1853

extended_timeout = notifychangeproperty(

1292

1854

dbus.UInt64, "ExtendedTimeout",

1293

type_func = timedelta_to_milliseconds)

1294

interval = notifychangeproperty(dbus.UInt64,

1295

"Interval",

1296

type_func =

1297

timedelta_to_milliseconds)

1855

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

1856

interval = notifychangeproperty(

1857

dbus.UInt64, "Interval",

1858

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

1298

1859

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

1299

1860

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

1861

invalidate_only=True)

1862

1300

1863

del notifychangeproperty

1301

1864

1302

1865

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

1303

1866

try:

1304

1867

self.remove_from_connection()

1307

1870

if hasattr(DBusObjectWithProperties, "__del__"):

1308

1871

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

1309

1872

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

1310

1311

def checker_callback(self, pid, condition, command,

1312

*args, **kwargs):

1313

self.checker_callback_tag = None

1314

self.checker = None

1315

if os.WIFEXITED(condition):

1316

exitstatus = os.WEXITSTATUS(condition)

1873

1874

def checker_callback(self, source, condition,

1875

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

1876

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

1877

connection, command, *args,

1878

**kwargs)

1879

exitstatus = self.last_checker_status

1880

if exitstatus >= 0:

1317

1881

# Emit D-Bus signal

1318

1882

self.CheckerCompleted(dbus.Int16(exitstatus),

1319

dbus.Int64(condition),

1883

# This is specific to GNU libC

1884

dbus.Int64(exitstatus << 8),

1320

1885

dbus.String(command))

1321

1886

else:

1322

1887

# Emit D-Bus signal

1323

1888

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

1324

dbus.Int64(condition),

1889

dbus.Int64(

1890

# This is specific to GNU libC

1891

(exitstatus << 8)

1892

| self.last_checker_signal),

1325

1893

dbus.String(command))

1326

1327

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

1328

*args, **kwargs)

1329

1894

return ret

1895

1330

1896

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

1331

old_checker = self.checker

1332

if self.checker is not None:

1333

old_checker_pid = self.checker.pid

1334

else:

1335

old_checker_pid = None

1897

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

1336

1898

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

1337

1899

# Only if new checker process was started

1338

1900

if (self.checker is not None

1340

1902

# Emit D-Bus signal

1341

1903

self.CheckerStarted(self.current_checker_command)

1342

1904

return r

1343

1905

1344

1906

def _reset_approved(self):

1345

1907

self.approved = None

1346

1908

return False

1347

1909

1348

1910

def approve(self, value=True):

1349

1911

self.approved = value

1350

gobject.timeout_add(timedelta_to_milliseconds

1351

(self.approval_duration),

1352

self._reset_approved)

1912

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

1913

* 1000), self._reset_approved)

1353

1914

self.send_changedstate()

1354

1355

## D-Bus methods, signals & properties

1356

_interface = "se.recompile.Mandos.Client"

1357

1358

## Interfaces

1359

1360

@dbus_interface_annotations(_interface)

1361

def _foo(self):

1362

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

1363

"false"}

1364

1365

## Signals

1366

1915

1916

# D-Bus methods, signals & properties

1917

1918

# Interfaces

1919

1920

# Signals

1921

1367

1922

# CheckerCompleted - signal

1368

1923

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

1369

1924

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

1370

1925

"D-Bus signal"

1371

1926

pass

1372

1927

1373

1928

# CheckerStarted - signal

1374

1929

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

1375

1930

def CheckerStarted(self, command):

1376

1931

"D-Bus signal"

1377

1932

pass

1378

1933

1379

1934

# PropertyChanged - signal

1935

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

1380

1936

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

1381

1937

def PropertyChanged(self, property, value):

1382

1938

"D-Bus signal"

1383

1939

pass

1384

1940

1385

1941

# GotSecret - signal

1386

1942

@dbus.service.signal(_interface)

1387

1943

def GotSecret(self):

1390

1946

server to mandos-client

1391

1947

"""

1392

1948

pass

1393

1949

1394

1950

# Rejected - signal

1395

1951

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

1396

1952

def Rejected(self, reason):

1397

1953

"D-Bus signal"

1398

1954

pass

1399

1955

1400

1956

# NeedApproval - signal

1401

1957

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

1402

1958

def NeedApproval(self, timeout, default):

1403

1959

"D-Bus signal"

1404

1960

return self.need_approval()

1405

1406

## Methods

1407

1961

1962

# Methods

1963

1408

1964

# Approve - method

1409

1965

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

1410

1966

def Approve(self, value):

1411

1967

self.approve(value)

1412

1968

1413

1969

# CheckedOK - method

1414

1970

@dbus.service.method(_interface)

1415

1971

def CheckedOK(self):

1416

1972

self.checked_ok()

1417

1973

1418

1974

# Enable - method

1975

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

1419

1976

@dbus.service.method(_interface)

1420

1977

def Enable(self):

1421

1978

"D-Bus method"

1422

1979

self.enable()

1423

1980

1424

1981

# StartChecker - method

1982

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

1425

1983

@dbus.service.method(_interface)

1426

1984

def StartChecker(self):

1427

1985

"D-Bus method"

1428

1986

self.start_checker()

1429

1987

1430

1988

# Disable - method

1989

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

1431

1990

@dbus.service.method(_interface)

1432

1991

def Disable(self):

1433

1992

"D-Bus method"

1434

1993

self.disable()

1435

1994

1436

1995

# StopChecker - method

1996

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

1437

1997

@dbus.service.method(_interface)

1438

1998

def StopChecker(self):

1439

1999

self.stop_checker()

1440

1441

## Properties

1442

2000

2001

# Properties

2002

1443

2003

# ApprovalPending - property

1444

2004

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

1445

2005

def ApprovalPending_dbus_property(self):

1446

2006

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

1447

2007

1448

2008

# ApprovedByDefault - property

1449

@dbus_service_property(_interface, signature="b",

2009

@dbus_service_property(_interface,

2010

signature="b",

1450

2011

access="readwrite")

1451

2012

def ApprovedByDefault_dbus_property(self, value=None):

1452

2013

if value is None: # get

1453

2014

return dbus.Boolean(self.approved_by_default)

1454

2015

self.approved_by_default = bool(value)

1455

2016

1456

2017

# ApprovalDelay - property

1457

@dbus_service_property(_interface, signature="t",

2018

@dbus_service_property(_interface,

2019

signature="t",

1458

2020

access="readwrite")

1459

2021

def ApprovalDelay_dbus_property(self, value=None):

1460

2022

if value is None: # get

1461

return dbus.UInt64(self.approval_delay_milliseconds())

2023

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

2024

* 1000)

1462

2025

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

1463

2026

1464

2027

# ApprovalDuration - property

1465

@dbus_service_property(_interface, signature="t",

2028

@dbus_service_property(_interface,

2029

signature="t",

1466

2030

access="readwrite")

1467

2031

def ApprovalDuration_dbus_property(self, value=None):

1468

2032

if value is None: # get

1469

return dbus.UInt64(timedelta_to_milliseconds(

1470

self.approval_duration))

2033

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

2034

* 1000)

1471

2035

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

1472

2036

1473

2037

# Name - property

2038

@dbus_annotations(

2039

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

1474

2040

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

1475

2041

def Name_dbus_property(self):

1476

2042

return dbus.String(self.name)

1477

2043

2044

# KeyID - property

2045

@dbus_annotations(

2046

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

2047

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

2048

def KeyID_dbus_property(self):

2049

return dbus.String(self.key_id)

2050

1478

2051

# Fingerprint - property

2052

@dbus_annotations(

2053

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

1479

2054

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

1480

2055

def Fingerprint_dbus_property(self):

1481

2056

return dbus.String(self.fingerprint)

1482

2057

1483

2058

# Host - property

1484

@dbus_service_property(_interface, signature="s",

2059

@dbus_service_property(_interface,

2060

signature="s",

1485

2061

access="readwrite")

1486

2062

def Host_dbus_property(self, value=None):

1487

2063

if value is None: # get

1488

2064

return dbus.String(self.host)

1489

self.host = unicode(value)

1490

2065

self.host = str(value)

2066

1491

2067

# Created - property

2068

@dbus_annotations(

2069

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

1492

2070

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

1493

2071

def Created_dbus_property(self):

1494

2072

return datetime_to_dbus(self.created)

1495

2073

1496

2074

# LastEnabled - property

1497

2075

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

1498

2076

def LastEnabled_dbus_property(self):

1499

2077

return datetime_to_dbus(self.last_enabled)

1500

2078

1501

2079

# Enabled - property

1502

@dbus_service_property(_interface, signature="b",

2080

@dbus_service_property(_interface,

2081

signature="b",

1503

2082

access="readwrite")

1504

2083

def Enabled_dbus_property(self, value=None):

1505

2084

if value is None: # get

1508

2087

self.enable()

1509

2088

else:

1510

2089

self.disable()

1511

2090

1512

2091

# LastCheckedOK - property

1513

@dbus_service_property(_interface, signature="s",

2092

@dbus_service_property(_interface,

2093

signature="s",

1514

2094

access="readwrite")

1515

2095

def LastCheckedOK_dbus_property(self, value=None):

1516

2096

if value is not None:

1517

2097

self.checked_ok()

1518

2098

return

1519

2099

return datetime_to_dbus(self.last_checked_ok)

1520

2100

1521

2101

# LastCheckerStatus - property

1522

@dbus_service_property(_interface, signature="n",

1523

access="read")

2102

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

1524

2103

def LastCheckerStatus_dbus_property(self):

1525

2104

return dbus.Int16(self.last_checker_status)

1526

2105

1527

2106

# Expires - property

1528

2107

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

1529

2108

def Expires_dbus_property(self):

1530

2109

return datetime_to_dbus(self.expires)

1531

2110

1532

2111

# LastApprovalRequest - property

1533

2112

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

1534

2113

def LastApprovalRequest_dbus_property(self):

1535

2114

return datetime_to_dbus(self.last_approval_request)

1536

2115

1537

2116

# Timeout - property

1538

@dbus_service_property(_interface, signature="t",

2117

@dbus_service_property(_interface,

2118

signature="t",

1539

2119

access="readwrite")

1540

2120

def Timeout_dbus_property(self, value=None):

1541

2121

if value is None: # get

1542

return dbus.UInt64(self.timeout_milliseconds())

2122

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

1543

2123

old_timeout = self.timeout

1544

2124

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

1545

2125

# Reschedule disabling

1553

2133

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

1554

2134

is None):

1555

2135

return

1556

gobject.source_remove(self.disable_initiator_tag)

1557

self.disable_initiator_tag = (

1558

gobject.timeout_add(

1559

timedelta_to_milliseconds(self.expires - now),

1560

self.disable))

1561

2136

GLib.source_remove(self.disable_initiator_tag)

2137

self.disable_initiator_tag = GLib.timeout_add(

2138

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

2139

self.disable)

2140

1562

2141

# ExtendedTimeout - property

1563

@dbus_service_property(_interface, signature="t",

2142

@dbus_service_property(_interface,

2143

signature="t",

1564

2144

access="readwrite")

1565

2145

def ExtendedTimeout_dbus_property(self, value=None):

1566

2146

if value is None: # get

1567

return dbus.UInt64(self.extended_timeout_milliseconds())

2147

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

2148

* 1000)

1568

2149

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

1569

2150

1570

2151

# Interval - property

1571

@dbus_service_property(_interface, signature="t",

2152

@dbus_service_property(_interface,

2153

signature="t",

1572

2154

access="readwrite")

1573

2155

def Interval_dbus_property(self, value=None):

1574

2156

if value is None: # get

1575

return dbus.UInt64(self.interval_milliseconds())

2157

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

1576

2158

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

1577

2159

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

1578

2160

return

1579

2161

if self.enabled:

1580

2162

# Reschedule checker run

1581

gobject.source_remove(self.checker_initiator_tag)

1582

self.checker_initiator_tag = (gobject.timeout_add

1583

(value, self.start_checker))

1584

self.start_checker() # Start one now, too

1585

2163

GLib.source_remove(self.checker_initiator_tag)

2164

self.checker_initiator_tag = GLib.timeout_add(

2165

value, self.start_checker)

2166

self.start_checker() # Start one now, too

2167

1586

2168

# Checker - property

1587

@dbus_service_property(_interface, signature="s",

2169

@dbus_service_property(_interface,

2170

signature="s",

1588

2171

access="readwrite")

1589

2172

def Checker_dbus_property(self, value=None):

1590

2173

if value is None: # get

1591

2174

return dbus.String(self.checker_command)

1592

self.checker_command = unicode(value)

1593

2175

self.checker_command = str(value)

2176

1594

2177

# CheckerRunning - property

1595

@dbus_service_property(_interface, signature="b",

2178

@dbus_service_property(_interface,

2179

signature="b",

1596

2180

access="readwrite")

1597

2181

def CheckerRunning_dbus_property(self, value=None):

1598

2182

if value is None: # get

1601

2185

self.start_checker()

1602

2186

else:

1603

2187

self.stop_checker()

1604

2188

1605

2189

# ObjectPath - property

2190

@dbus_annotations(

2191

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

2192

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

1606

2193

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

1607

2194

def ObjectPath_dbus_property(self):

1608

return self.dbus_object_path # is already a dbus.ObjectPath

1609

2195

return self.dbus_object_path # is already a dbus.ObjectPath

2196

1610

2197

# Secret = property

1611

@dbus_service_property(_interface, signature="ay",

1612

access="write", byte_arrays=True)

2198

@dbus_annotations(

2199

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

2200

"invalidates"})

2201

@dbus_service_property(_interface,

2202

signature="ay",

2203

access="write",

2204

byte_arrays=True)

1613

2205

def Secret_dbus_property(self, value):

1614

self.secret = str(value)

1615

2206

self.secret = bytes(value)

2207

1616

2208

del _interface

1617

2209

1618

2210

1619

2211

class ProxyClient(object):

1620

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

2212

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

1621

2213

self._pipe = child_pipe

1622

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

2214

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

1623

2215

if not self._pipe.recv():

1624

raise KeyError()

1625

2216

raise KeyError(key_id or fpr)

2217

1626

2218

def __getattribute__(self, name):

1627

2219

if name == '_pipe':

1628

2220

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

1631

2223

if data[0] == 'data':

1632

2224

return data[1]

1633

2225

if data[0] == 'function':

2226

1634

2227

def func(*args, **kwargs):

1635

2228

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

1636

2229

return self._pipe.recv()[1]

2230

1637

2231

return func

1638

2232

1639

2233

def __setattr__(self, name, value):

1640

2234

if name == '_pipe':

1641

2235

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

1644

2238

1645

2239

class ClientHandler(socketserver.BaseRequestHandler, object):

1646

2240

"""A class to handle client connections.

1647

2241

1648

2242

Instantiated once for each connection to handle it.

1649

2243

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

1650

2244

1651

2245

def handle(self):

1652

2246

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

1653

2247

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

1654

unicode(self.client_address))

2248

str(self.client_address))

1655

2249

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

1656

2250

self.server.child_pipe.fileno())

1657

1658

session = (gnutls.connection

1659

.ClientSession(self.request,

1660

gnutls.connection

1661

.X509Credentials()))

1662

1663

# Note: gnutls.connection.X509Credentials is really a

1664

# generic GnuTLS certificate credentials object so long as

1665

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

1666

# here despite using OpenPGP certificates.

1667

1668

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

1669

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

1670

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

1671

# "+DHE-DSS"))

2251

2252

session = gnutls.ClientSession(self.request)

2253

2254

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

2255

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

2256

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

2257

# "+DHE-DSS"))

1672

2258

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

1673

2259

priority = self.server.gnutls_priority

1674

2260

if priority is None:

1675

2261

priority = "NORMAL"

1676

(gnutls.library.functions

1677

.gnutls_priority_set_direct(session._c_object,

1678

priority, None))

1679

2262

gnutls.priority_set_direct(session._c_object,

2263

priority.encode("utf-8"),

2264

None)

2265

1680

2266

# Start communication using the Mandos protocol

1681

2267

# Get protocol number

1682

2268

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

1683

2269

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

1684

2270

try:

1685

2271

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

1686

raise RuntimeError

2272

raise RuntimeError(line)

1687

2273

except (ValueError, IndexError, RuntimeError) as error:

1688

2274

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

1689

2275

return

1690

2276

1691

2277

# Start GnuTLS connection

1692

2278

try:

1693

2279

session.handshake()

1694

except gnutls.errors.GNUTLSError as error:

2280

except gnutls.Error as error:

1695

2281

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

1696

2282

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

1697

2283

# established. Just abandon the request.

1698

2284

return

1699

2285

logger.debug("Handshake succeeded")

1700

2286

1701

2287

approval_required = False

1702

2288

try:

1703

try:

1704

fpr = self.fingerprint(self.peer_certificate

1705

(session))

1706

except (TypeError,

1707

gnutls.errors.GNUTLSError) as error:

1708

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

1709

return

1710

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

1711

1712

try:

1713

client = ProxyClient(child_pipe, fpr,

2289

if gnutls.has_rawpk:

2290

fpr = ""

2291

try:

2292

key_id = self.key_id(

2293

self.peer_certificate(session))

2294

except (TypeError, gnutls.Error) as error:

2295

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

2296

return

2297

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

2298

2299

else:

2300

key_id = ""

2301

try:

2302

fpr = self.fingerprint(

2303

self.peer_certificate(session))

2304

except (TypeError, gnutls.Error) as error:

2305

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

2306

return

2307

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

2308

2309

try:

2310

client = ProxyClient(child_pipe, key_id, fpr,

1714

2311

self.client_address)

1715

2312

except KeyError:

1716

2313

return

1717

2314

1718

2315

if client.approval_delay:

1719

2316

delay = client.approval_delay

1720

2317

client.approvals_pending += 1

1721

2318

approval_required = True

1722

2319

1723

2320

while True:

1724

2321

if not client.enabled:

1725

2322

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

1726

client.name)

2323

client.name)

1727

2324

if self.server.use_dbus:

1728

2325

# Emit D-Bus signal

1729

2326

client.Rejected("Disabled")

1730

2327

return

1731

2328

1732

2329

if client.approved or not client.approval_delay:

1733

#We are approved or approval is disabled

2330

# We are approved or approval is disabled

1734

2331

break

1735

2332

elif client.approved is None:

1736

2333

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

1738

2335

if self.server.use_dbus:

1739

2336

# Emit D-Bus signal

1740

2337

client.NeedApproval(

1741

client.approval_delay_milliseconds(),

1742

client.approved_by_default)

2338

client.approval_delay.total_seconds()

2339

* 1000, client.approved_by_default)

1743

2340

else:

1744

2341

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

1745

2342

client.name)

1747

2344

# Emit D-Bus signal

1748

2345

client.Rejected("Denied")

1749

2346

return

1750

1751

#wait until timeout or approved

2347

2348

# wait until timeout or approved

1752

2349

time = datetime.datetime.now()

1753

2350

client.changedstate.acquire()

1754

client.changedstate.wait(

1755

float(timedelta_to_milliseconds(delay)

1756

/ 1000))

2351

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

1757

2352

client.changedstate.release()

1758

2353

time2 = datetime.datetime.now()

1759

2354

if (time2 - time) >= delay:

1769

2364

break

1770

2365

else:

1771

2366

delay -= time2 - time

1772

1773

sent_size = 0

1774

while sent_size < len(client.secret):

1775

try:

1776

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

1777

except gnutls.errors.GNUTLSError as error:

1778

logger.warning("gnutls send failed",

1779

exc_info=error)

1780

return

1781

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

1782

sent, len(client.secret)

1783

- (sent_size + sent))

1784

sent_size += sent

1785

2367

2368

try:

2369

session.send(client.secret)

2370

except gnutls.Error as error:

2371

logger.warning("gnutls send failed",

2372

exc_info=error)

2373

return

2374

1786

2375

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

1787

2376

# bump the timeout using extended_timeout

1788

2377

client.bump_timeout(client.extended_timeout)

1789

2378

if self.server.use_dbus:

1790

2379

# Emit D-Bus signal

1791

2380

client.GotSecret()

1792

2381

1793

2382

finally:

1794

2383

if approval_required:

1795

2384

client.approvals_pending -= 1

1796

2385

try:

1797

2386

session.bye()

1798

except gnutls.errors.GNUTLSError as error:

2387

except gnutls.Error as error:

1799

2388

logger.warning("GnuTLS bye failed",

1800

2389

exc_info=error)

1801

2390

1802

2391

@staticmethod

1803

2392

def peer_certificate(session):

1804

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

1805

# If not an OpenPGP certificate...

1806

if (gnutls.library.functions

1807

.gnutls_certificate_type_get(session._c_object)

1808

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1809

# ...do the normal thing

1810

return session.peer_certificate

2393

"Return the peer's certificate as a bytestring"

2394

try:

2395

cert_type = gnutls.certificate_type_get2(session._c_object,

2396

gnutls.CTYPE_PEERS)

2397

except AttributeError:

2398

cert_type = gnutls.certificate_type_get(session._c_object)

2399

if gnutls.has_rawpk:

2400

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2401

else:

2402

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2403

# If not a valid certificate type...

2404

if cert_type not in valid_cert_types:

2405

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

2406

valid_cert_types)

2407

# ...return invalid data

2408

return b""

1811

2409

list_size = ctypes.c_uint(1)

1812

cert_list = (gnutls.library.functions

1813

.gnutls_certificate_get_peers

2410

cert_list = (gnutls.certificate_get_peers

1814

2411

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

1815

2412

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

1816

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

1817

" certificate")

2413

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

1818

2414

if list_size.value == 0:

1819

2415

return None

1820

2416

cert = cert_list[0]

1821

2417

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

1822

2418

2419

@staticmethod

2420

def key_id(certificate):

2421

"Convert a certificate bytestring to a hexdigit key ID"

2422

# New GnuTLS "datum" with the public key

2423

datum = gnutls.datum_t(

2424

ctypes.cast(ctypes.c_char_p(certificate),

2425

ctypes.POINTER(ctypes.c_ubyte)),

2426

ctypes.c_uint(len(certificate)))

2427

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

2428

# New empty GnuTLS certificate

2429

pubkey = gnutls.pubkey_t()

2430

gnutls.pubkey_init(ctypes.byref(pubkey))

2431

# Import the raw public key into the certificate

2432

gnutls.pubkey_import(pubkey,

2433

ctypes.byref(datum),

2434

gnutls.X509_FMT_DER)

2435

# New buffer for the key ID

2436

buf = ctypes.create_string_buffer(32)

2437

buf_len = ctypes.c_size_t(len(buf))

2438

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

2439

gnutls.pubkey_get_key_id(pubkey,

2440

gnutls.KEYID_USE_SHA256,

2441

ctypes.cast(ctypes.byref(buf),

2442

ctypes.POINTER(ctypes.c_ubyte)),

2443

ctypes.byref(buf_len))

2444

# Deinit the certificate

2445

gnutls.pubkey_deinit(pubkey)

2446

2447

# Convert the buffer to a Python bytestring

2448

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

2449

# Convert the bytestring to hexadecimal notation

2450

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

2451

return hex_key_id

2452

1823

2453

@staticmethod

1824

2454

def fingerprint(openpgp):

1825

2455

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1826

2456

# New GnuTLS "datum" with the OpenPGP public key

1827

datum = (gnutls.library.types

1828

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

1829

ctypes.POINTER

1830

(ctypes.c_ubyte)),

1831

ctypes.c_uint(len(openpgp))))

2457

datum = gnutls.datum_t(

2458

ctypes.cast(ctypes.c_char_p(openpgp),

2459

ctypes.POINTER(ctypes.c_ubyte)),

2460

ctypes.c_uint(len(openpgp)))

1832

2461

# New empty GnuTLS certificate

1833

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2462

crt = gnutls.openpgp_crt_t()

2463

gnutls.openpgp_crt_init(ctypes.byref(crt))

1836

2464

# Import the OpenPGP public key into the certificate

1837

(gnutls.library.functions

1838

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

1839

gnutls.library.constants

1840

.GNUTLS_OPENPGP_FMT_RAW))

2465

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

2466

gnutls.OPENPGP_FMT_RAW)

1841

2467

# Verify the self signature in the key

1842

2468

crtverify = ctypes.c_uint()

1843

(gnutls.library.functions

1844

.gnutls_openpgp_crt_verify_self(crt, 0,

1845

ctypes.byref(crtverify)))

2469

gnutls.openpgp_crt_verify_self(crt, 0,

2470

ctypes.byref(crtverify))

1846

2471

if crtverify.value != 0:

1847

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1848

raise (gnutls.errors.CertificateSecurityError

1849

("Verify failed"))

2472

gnutls.openpgp_crt_deinit(crt)

2473

raise gnutls.CertificateSecurityError(code

2474

=crtverify.value)

1850

2475

# New buffer for the fingerprint

1851

2476

buf = ctypes.create_string_buffer(20)

1852

2477

buf_len = ctypes.c_size_t()

1853

2478

# Get the fingerprint from the certificate into the buffer

1854

(gnutls.library.functions

1855

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

1856

ctypes.byref(buf_len)))

2479

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

2480

ctypes.byref(buf_len))

1857

2481

# Deinit the certificate

1858

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2482

gnutls.openpgp_crt_deinit(crt)

1859

2483

# Convert the buffer to a Python bytestring

1860

2484

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

1861

2485

# Convert the bytestring to hexadecimal notation

1865

2489

1866

2490

class MultiprocessingMixIn(object):

1867

2491

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

2492

1868

2493

def sub_process_main(self, request, address):

1869

2494

try:

1870

2495

self.finish_request(request, address)

1871

2496

except Exception:

1872

2497

self.handle_error(request, address)

1873

2498

self.close_request(request)

1874

2499

1875

2500

def process_request(self, request, address):

1876

2501

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

1877

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

1878

args = (request, address))

2502

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

2503

args=(request, address))

1879

2504

proc.start()

1880

2505

return proc

1881

2506

1882

2507

1883

2508

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1884

2509

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

2510

1885

2511

def process_request(self, request, client_address):

1886

2512

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

1887

2513

1888

2514

This function creates a new pipe in self.pipe

1889

2515

"""

1890

2516

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1891

2517

1892

2518

proc = MultiprocessingMixIn.process_request(self, request,

1893

2519

client_address)

1894

2520

self.child_pipe.close()

1895

2521

self.add_pipe(parent_pipe, proc)

1896

2522

1897

2523

def add_pipe(self, parent_pipe, proc):

1898

2524

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

1899

raise NotImplementedError

2525

raise NotImplementedError()

1900

2526

1901

2527

1902

2528

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1903

2529

socketserver.TCPServer, object):

1904

2530

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

1905

2531

1906

2532

Attributes:

1907

2533

enabled: Boolean; whether this server is activated yet

1908

2534

interface: None or a network interface name (string)

1909

2535

use_ipv6: Boolean; to use IPv6 or not

1910

2536

"""

2537

1911

2538

def __init__(self, server_address, RequestHandlerClass,

1912

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

2539

interface=None,

2540

use_ipv6=True,

2541

socketfd=None):

1913

2542

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

1914

2543

creating a new one with socket.socket().

1915

2544

"""

1921

2550

self.socketfd = socketfd

1922

2551

# Save the original socket.socket() function

1923

2552

self.socket_socket = socket.socket

2553

1924

2554

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

1925

#

2555

#

1926

2556

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

1927

2557

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

1928

2558

# patching socket.socket.)

1929

#

2559

#

1930

2560

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

1931

2561

@functools.wraps(socket.socket)

1932

2562

def socket_wrapper(*args, **kwargs):

1944

2574

# socket_wrapper(), if socketfd was set.

1945

2575

socketserver.TCPServer.__init__(self, server_address,

1946

2576

RequestHandlerClass)

1947

2577

1948

2578

def server_bind(self):

1949

2579

"""This overrides the normal server_bind() function

1950

2580

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

1951

2581

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

2582

global SO_BINDTODEVICE

1952

2583

if self.interface is not None:

1953

2584

if SO_BINDTODEVICE is None:

1954

logger.error("SO_BINDTODEVICE does not exist;"

1955

" cannot bind to interface %s",

1956

self.interface)

1957

else:

1958

try:

1959

self.socket.setsockopt(socket.SOL_SOCKET,

1960

SO_BINDTODEVICE,

1961

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

1962

except socket.error as error:

1963

if error.errno == errno.EPERM:

1964

logger.error("No permission to bind to"

1965

" interface %s", self.interface)

1966

elif error.errno == errno.ENOPROTOOPT:

1967

logger.error("SO_BINDTODEVICE not available;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

elif error.errno == errno.ENODEV:

1971

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

1972

" cannot bind", self.interface)

1973

else:

1974

raise

2585

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

2586

# common enough.

2587

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

2588

SO_BINDTODEVICE = 25

2589

try:

2590

self.socket.setsockopt(

2591

socket.SOL_SOCKET, SO_BINDTODEVICE,

2592

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

2593

except socket.error as error:

2594

if error.errno == errno.EPERM:

2595

logger.error("No permission to bind to"

2596

" interface %s", self.interface)

2597

elif error.errno == errno.ENOPROTOOPT:

2598

logger.error("SO_BINDTODEVICE not available;"

2599

" cannot bind to interface %s",

2600

self.interface)

2601

elif error.errno == errno.ENODEV:

2602

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

2603

" cannot bind", self.interface)

2604

else:

2605

raise

1975

2606

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

1976

2607

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

1977

2608

if not self.server_address[0]:

1978

2609

if self.address_family == socket.AF_INET6:

1979

any_address = "::" # in6addr_any

2610

any_address = "::" # in6addr_any

1980

2611

else:

1981

any_address = socket.INADDR_ANY

2612

any_address = "0.0.0.0" # INADDR_ANY

1982

2613

self.server_address = (any_address,

1983

2614

self.server_address[1])

1984

2615

elif not self.server_address[1]:

1985

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

1986

0)

2616

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

1987

2617

# if self.interface:

1988

2618

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

1989

2619

# 0, # port

1995

2625

1996

2626

class MandosServer(IPv6_TCPServer):

1997

2627

"""Mandos server.

1998

2628

1999

2629

Attributes:

2000

2630

clients: set of Client objects

2001

2631

gnutls_priority GnuTLS priority string

2002

2632

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

2003

2004

Assumes a gobject.MainLoop event loop.

2633

2634

Assumes a GLib.MainLoop event loop.

2005

2635

"""

2636

2006

2637

def __init__(self, server_address, RequestHandlerClass,

2007

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

2008

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

2638

interface=None,

2639

use_ipv6=True,

2640

clients=None,

2641

gnutls_priority=None,

2642

use_dbus=True,

2643

socketfd=None):

2009

2644

self.enabled = False

2010

2645

self.clients = clients

2011

2646

if self.clients is None:

2014

2649

self.gnutls_priority = gnutls_priority

2015

2650

IPv6_TCPServer.__init__(self, server_address,

2016

2651

RequestHandlerClass,

2017

interface = interface,

2018

use_ipv6 = use_ipv6,

2019

socketfd = socketfd)

2652

interface=interface,

2653

use_ipv6=use_ipv6,

2654

socketfd=socketfd)

2655

2020

2656

def server_activate(self):

2021

2657

if self.enabled:

2022

2658

return socketserver.TCPServer.server_activate(self)

2023

2659

2024

2660

def enable(self):

2025

2661

self.enabled = True

2026

2662

2027

2663

def add_pipe(self, parent_pipe, proc):

2028

2664

# Call "handle_ipc" for both data and EOF events

2029

gobject.io_add_watch(parent_pipe.fileno(),

2030

gobject.IO_IN | gobject.IO_HUP,

2031

functools.partial(self.handle_ipc,

2032

parent_pipe =

2033

parent_pipe,

2034

proc = proc))

2035

2036

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

2037

proc = None, client_object=None):

2665

GLib.io_add_watch(

2666

parent_pipe.fileno(),

2667

GLib.IO_IN | GLib.IO_HUP,

2668

functools.partial(self.handle_ipc,

2669

parent_pipe=parent_pipe,

2670

proc=proc))

2671

2672

def handle_ipc(self, source, condition,

2673

parent_pipe=None,

2674

proc=None,

2675

client_object=None):

2038

2676

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

2039

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

2677

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

2040

2678

# Wait for other process to exit

2041

2679

proc.join()

2042

2680

return False

2043

2681

2044

2682

# Read a request from the child

2045

2683

request = parent_pipe.recv()

2046

2684

command = request[0]

2047

2685

2048

2686

if command == 'init':

2049

fpr = request[1]

2050

address = request[2]

2051

2052

for c in self.clients.itervalues():

2053

if c.fingerprint == fpr:

2687

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

2688

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

2689

address = request[3]

2690

2691

for c in self.clients.values():

2692

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2693

continue

2694

if key_id and c.key_id == key_id:

2695

client = c

2696

break

2697

if fpr and c.fingerprint == fpr:

2054

2698

client = c

2055

2699

break

2056

2700

else:

2057

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

2058

"dress: %s", fpr, address)

2701

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

2702

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

2059

2703

if self.use_dbus:

2060

2704

# Emit D-Bus signal

2061

mandos_dbus_service.ClientNotFound(fpr,

2705

mandos_dbus_service.ClientNotFound(key_id or fpr,

2062

2706

address[0])

2063

2707

parent_pipe.send(False)

2064

2708

return False

2065

2066

gobject.io_add_watch(parent_pipe.fileno(),

2067

gobject.IO_IN | gobject.IO_HUP,

2068

functools.partial(self.handle_ipc,

2069

parent_pipe =

2070

parent_pipe,

2071

proc = proc,

2072

client_object =

2073

client))

2709

2710

GLib.io_add_watch(

2711

parent_pipe.fileno(),

2712

GLib.IO_IN | GLib.IO_HUP,

2713

functools.partial(self.handle_ipc,

2714

parent_pipe=parent_pipe,

2715

proc=proc,

2716

client_object=client))

2074

2717

parent_pipe.send(True)

2075

2718

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

2076

2719

# same fileno

2079

2722

funcname = request[1]

2080

2723

args = request[2]

2081

2724

kwargs = request[3]

2082

2725

2083

2726

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

2084

2727

funcname)(*args,

2085

**kwargs)))

2086

2728

**kwargs)))

2729

2087

2730

if command == 'getattr':

2088

2731

attrname = request[1]

2089

if callable(client_object.__getattribute__(attrname)):

2090

parent_pipe.send(('function',))

2732

if isinstance(client_object.__getattribute__(attrname),

2733

collections.Callable):

2734

parent_pipe.send(('function', ))

2091

2735

else:

2092

parent_pipe.send(('data', client_object

2093

.__getattribute__(attrname)))

2094

2736

parent_pipe.send((

2737

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

2738

2095

2739

if command == 'setattr':

2096

2740

attrname = request[1]

2097

2741

value = request[2]

2098

2742

setattr(client_object, attrname, value)

2099

2743

2100

2744

return True

2101

2745

2102

2746

2103

2747

def rfc3339_duration_to_delta(duration):

2104

2748

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

2105

2749

2106

2750

>>> rfc3339_duration_to_delta("P7D")

2107

2751

datetime.timedelta(7)

2108

2752

>>> rfc3339_duration_to_delta("PT60S")

2118

2762

>>> rfc3339_duration_to_delta("P1DT3M20S")

2119

2763

datetime.timedelta(1, 200)

2120

2764

"""

2121

2765

2122

2766

# Parsing an RFC 3339 duration with regular expressions is not

2123

2767

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

2124

2768

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

2125

2769

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

2126

2770

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

2127

2771

# avoid excessive use of external libraries.

2128

2772

2129

2773

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

2130

Token = collections.namedtuple("Token",

2131

("regexp", # To match token; if

2132

# "value" is not None,

2133

# must have a "group"

2134

# containing digits

2135

"value", # datetime.timedelta or

2136

# None

2137

"followers")) # Tokens valid after

2138

# this token

2774

Token = collections.namedtuple("Token", (

2775

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

2776

# a "group" containing digits

2777

"value", # datetime.timedelta or None

2778

"followers")) # Tokens valid after this token

2139

2779

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

2140

2780

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

2141

2781

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

2142

2782

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

2143

2783

datetime.timedelta(seconds=1),

2144

frozenset((token_end,)))

2784

frozenset((token_end, )))

2145

2785

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

2146

2786

datetime.timedelta(minutes=1),

2147

2787

frozenset((token_second, token_end)))

2163

2803

frozenset((token_month, token_end)))

2164

2804

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

2165

2805

datetime.timedelta(weeks=1),

2166

frozenset((token_end,)))

2806

frozenset((token_end, )))

2167

2807

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

2168

2808

frozenset((token_year, token_month,

2169

2809

token_day, token_time,

2170

token_week))),

2171

# Define starting values

2172

value = datetime.timedelta() # Value so far

2810

token_week)))

2811

# Define starting values:

2812

# Value so far

2813

value = datetime.timedelta()

2173

2814

found_token = None

2174

followers = frozenset(token_duration,) # Following valid tokens

2175

s = duration # String left to parse

2815

# Following valid tokens

2816

followers = frozenset((token_duration, ))

2817

# String left to parse

2818

s = duration

2176

2819

# Loop until end token is found

2177

2820

while found_token is not token_end:

2178

2821

# Search for any currently valid tokens

2194

2837

break

2195

2838

else:

2196

2839

# No currently valid tokens were found

2197

raise ValueError("Invalid RFC 3339 duration")

2840

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

2841

.format(duration))

2198

2842

# End token found

2199

2843

return value

2200

2844

2201

2845

2202

2846

def string_to_delta(interval):

2203

2847

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

2204

2848

2205

2849

>>> string_to_delta('7d')

2206

2850

datetime.timedelta(7)

2207

2851

>>> string_to_delta('60s')

2215

2859

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

2216

2860

datetime.timedelta(0, 330)

2217

2861

"""

2218

2862

2219

2863

try:

2220

2864

return rfc3339_duration_to_delta(interval)

2221

2865

except ValueError:

2222

2866

pass

2223

2867

2224

2868

timevalue = datetime.timedelta(0)

2225

2869

for s in interval.split():

2226

2870

try:

2227

suffix = unicode(s[-1])

2871

suffix = s[-1]

2228

2872

value = int(s[:-1])

2229

2873

if suffix == "d":

2230

2874

delta = datetime.timedelta(value)

2237

2881

elif suffix == "w":

2238

2882

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

2239

2883

else:

2240

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

2241

.format(suffix))

2242

except (ValueError, IndexError) as e:

2884

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

2885

except IndexError as e:

2243

2886

raise ValueError(*(e.args))

2244

2887

timevalue += delta

2245

2888

return timevalue

2246

2889

2247

2890

2248

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

2891

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

2249

2892

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

2250

2893

2251

2894

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

2252

2895

if os.fork():

2253

2896

sys.exit()

2261

2904

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

2262

2905

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

2263

2906

raise OSError(errno.ENODEV,

2264

"{0} not a character device"

2907

"{} not a character device"

2265

2908

.format(os.devnull))

2266

2909

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

2267

2910

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

2271

2914

2272

2915

2273

2916

def main():

2274

2917

2275

2918

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

2276

2919

# Parsing of options, both command line and config file

2277

2920

2278

2921

parser = argparse.ArgumentParser()

2279

2922

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

2280

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

2923

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

2281

2924

help="show version number and exit")

2282

2925

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

2283

2926

help="Bind to interface IF")

2289

2932

help="Run self-test")

2290

2933

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

2291

2934

help="Debug mode; run in foreground and log"

2292

" to terminal")

2935

" to terminal", default=None)

2293

2936

parser.add_argument("--debuglevel", metavar="LEVEL",

2294

2937

help="Debug level for stdout output")

2295

2938

parser.add_argument("--priority", help="GnuTLS"

2302

2945

" files")

2303

2946

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

2304

2947

dest="use_dbus", help="Do not provide D-Bus"

2305

" system bus interface")

2948

" system bus interface", default=None)

2306

2949

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

2307

dest="use_ipv6", help="Do not use IPv6")

2950

dest="use_ipv6", help="Do not use IPv6",

2951

default=None)

2308

2952

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

2309

2953

dest="restore", help="Do not restore stored"

2310

" state")

2954

" state", default=None)

2311

2955

parser.add_argument("--socket", type=int,

2312

2956

help="Specify a file descriptor to a network"

2313

2957

" socket to use instead of creating one")

2314

2958

parser.add_argument("--statedir", metavar="DIR",

2315

2959

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

2316

2960

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

2317

help="Run in foreground")

2318

2961

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

2962

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

2963

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

2964

default=None)

2965

2319

2966

options = parser.parse_args()

2320

2967

2321

2968

if options.check:

2322

2969

import doctest

2323

doctest.testmod()

2324

sys.exit()

2325

2970

fail_count, test_count = doctest.testmod()

2971

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

2972

2326

2973

# Default values for config file for server-global settings

2327

server_defaults = { "interface": "",

2328

"address": "",

2329

"port": "",

2330

"debug": "False",

2331

"priority":

2332

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

2333

"servicename": "Mandos",

2334

"use_dbus": "True",

2335

"use_ipv6": "True",

2336

"debuglevel": "",

2337

"restore": "True",

2338

"socket": "",

2339

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

2340

"foreground": "False",

2341

}

2342

2974

if gnutls.has_rawpk:

2975

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

2976

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

2977

else:

2978

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

2979

":+SIGN-DSA-SHA256")

2980

server_defaults = {"interface": "",

2981

"address": "",

2982

"port": "",

2983

"debug": "False",

2984

"priority": priority,

2985

"servicename": "Mandos",

2986

"use_dbus": "True",

2987

"use_ipv6": "True",

2988

"debuglevel": "",

2989

"restore": "True",

2990

"socket": "",

2991

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

2992

"foreground": "False",

2993

"zeroconf": "True",

2994

}

2995

del priority

2996

2343

2997

# Parse config file for server-global settings

2344

2998

server_config = configparser.SafeConfigParser(server_defaults)

2345

2999

del server_defaults

2346

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

2347

"mandos.conf"))

3000

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

2348

3001

# Convert the SafeConfigParser object to a dict

2349

3002

server_settings = server_config.defaults()

2350

3003

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

2351

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

3004

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

3005

"foreground", "zeroconf"):

2352

3006

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

2353

3007

option)

2354

3008

if server_settings["port"]:

2364

3018

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

2365

3019

["socket"])

2366

3020

del server_config

2367

3021

2368

3022

# Override the settings from the config file with command line

2369

3023

# options, if set.

2370

3024

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

2371

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

2372

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

2373

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

3025

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

3026

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

3027

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

2374

3028

value = getattr(options, option)

2375

3029

if value is not None:

2376

3030

server_settings[option] = value

2377

3031

del options

2378

3032

# Force all strings to be unicode

2379

3033

for option in server_settings.keys():

2380

if type(server_settings[option]) is str:

2381

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

3034

if isinstance(server_settings[option], bytes):

3035

server_settings[option] = (server_settings[option]

3036

.decode("utf-8"))

3037

# Force all boolean options to be boolean

3038

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

3039

"foreground", "zeroconf"):

3040

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

2382

3041

# Debug implies foreground

2383

3042

if server_settings["debug"]:

2384

3043

server_settings["foreground"] = True

2385

3044

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

2386

3045

2387

3046

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

2388

3047

3048

if (not server_settings["zeroconf"]

3049

and not (server_settings["port"]

3050

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

3051

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

3052

2389

3053

# For convenience

2390

3054

debug = server_settings["debug"]

2391

3055

debuglevel = server_settings["debuglevel"]

2394

3058

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

2395

3059

stored_state_file)

2396

3060

foreground = server_settings["foreground"]

2397

3061

zeroconf = server_settings["zeroconf"]

3062

2398

3063

if debug:

2399

3064

initlogger(debug, logging.DEBUG)

2400

3065

else:

2403

3068

else:

2404

3069

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

2405

3070

initlogger(debug, level)

2406

3071

2407

3072

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

2408

syslogger.setFormatter(logging.Formatter

2409

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

2410

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

2411

.format(server_settings

2412

["servicename"])))

2413

3073

syslogger.setFormatter(

3074

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

3075

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

3076

server_settings["servicename"])))

3077

2414

3078

# Parse config file with clients

2415

3079

client_config = configparser.SafeConfigParser(Client

2416

3080

.client_defaults)

2417

3081

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

2418

3082

"clients.conf"))

2419

3083

2420

3084

global mandos_dbus_service

2421

3085

mandos_dbus_service = None

2422

2423

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

2424

server_settings["port"]),

2425

ClientHandler,

2426

interface=(server_settings["interface"]

2427

or None),

2428

use_ipv6=use_ipv6,

2429

gnutls_priority=

2430

server_settings["priority"],

2431

use_dbus=use_dbus,

2432

socketfd=(server_settings["socket"]

2433

or None))

3086

3087

socketfd = None

3088

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

3089

socketfd = server_settings["socket"]

3090

tcp_server = MandosServer(

3091

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

3092

ClientHandler,

3093

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

3094

use_ipv6=use_ipv6,

3095

gnutls_priority=server_settings["priority"],

3096

use_dbus=use_dbus,

3097

socketfd=socketfd)

2434

3098

if not foreground:

2435

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

3099

pidfilename = "/run/mandos.pid"

3100

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

3101

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

2436

3102

pidfile = None

2437

3103

try:

2438

pidfile = open(pidfilename, "w")

3104

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

2439

3105

except IOError as e:

2440

3106

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

2441

3107

exc_info=e)

2442

2443

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

3108

3109

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

3110

("mandos", "mandos"),

3111

("nobody", "nogroup")):

2444

3112

try:

2445

3113

uid = pwd.getpwnam(name).pw_uid

2446

gid = pwd.getpwnam(name).pw_gid

3114

gid = pwd.getpwnam(group).pw_gid

2447

3115

break

2448

3116

except KeyError:

2449

3117

continue

2453

3121

try:

2454

3122

os.setgid(gid)

2455

3123

os.setuid(uid)

3124

if debug:

3125

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

3126

gid))

2456

3127

except OSError as error:

3128

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

3129

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

2457

3130

if error.errno != errno.EPERM:

2458

raise error

2459

3131

raise

3132

2460

3133

if debug:

2461

3134

# Enable all possible GnuTLS debugging

2462

3135

2463

3136

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

2464

3137

# - GnuTLS manual

2465

gnutls.library.functions.gnutls_global_set_log_level(11)

2466

2467

@gnutls.library.types.gnutls_log_func

3138

gnutls.global_set_log_level(11)

3139

3140

@gnutls.log_func

2468

3141

def debug_gnutls(level, string):

2469

3142

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

2470

2471

(gnutls.library.functions

2472

.gnutls_global_set_log_function(debug_gnutls))

2473

3143

3144

gnutls.global_set_log_function(debug_gnutls)

3145

2474

3146

# Redirect stdin so all checkers get /dev/null

2475

3147

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

2476

3148

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

2477

3149

if null > 2:

2478

3150

os.close(null)

2479

3151

2480

3152

# Need to fork before connecting to D-Bus

2481

3153

if not foreground:

2482

3154

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

2483

3155

daemon()

2484

2485

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

2486

# need to inform gobject that threads will be used.

2487

gobject.threads_init()

2488

3156

3157

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

3158

# to inform GLib that threads will be used.

3159

GLib.threads_init()

3160

2489

3161

global main_loop

2490

3162

# From the Avahi example code

2491

3163

DBusGMainLoop(set_as_default=True)

2492

main_loop = gobject.MainLoop()

3164

main_loop = GLib.MainLoop()

2493

3165

bus = dbus.SystemBus()

2494

3166

# End of Avahi example code

2495

3167

if use_dbus:

2496

3168

try:

2497

3169

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

2498

bus, do_not_queue=True)

2499

old_bus_name = (dbus.service.BusName

2500

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

2501

do_not_queue=True))

2502

except dbus.exceptions.NameExistsException as e:

3170

bus,

3171

do_not_queue=True)

3172

old_bus_name = dbus.service.BusName(

3173

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

3174

do_not_queue=True)

3175

except dbus.exceptions.DBusException as e:

2503

3176

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

2504

3177

use_dbus = False

2505

3178

server_settings["use_dbus"] = False

2506

3179

tcp_server.use_dbus = False

2507

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2508

service = AvahiServiceToSyslog(name =

2509

server_settings["servicename"],

2510

servicetype = "_mandos._tcp",

2511

protocol = protocol, bus = bus)

2512

if server_settings["interface"]:

2513

service.interface = (if_nametoindex

2514

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

2515

3180

if zeroconf:

3181

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3182

service = AvahiServiceToSyslog(

3183

name=server_settings["servicename"],

3184

servicetype="_mandos._tcp",

3185

protocol=protocol,

3186

bus=bus)

3187

if server_settings["interface"]:

3188

service.interface = if_nametoindex(

3189

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

3190

2516

3191

global multiprocessing_manager

2517

3192

multiprocessing_manager = multiprocessing.Manager()

2518

3193

2519

3194

client_class = Client

2520

3195

if use_dbus:

2521

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

2522

3196

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

3197

2523

3198

client_settings = Client.config_parser(client_config)

2524

3199

old_client_settings = {}

2525

3200

clients_data = {}

2526

3201

3202

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

3203

global wnull

3204

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

3205

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

3206

# mode

3207

if debug or not foreground:

3208

wnull.close()

3209

2527

3210

# Get client data and settings from last running state.

2528

3211

if server_settings["restore"]:

2529

3212

try:

2530

3213

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

2531

clients_data, old_client_settings = (pickle.load

2532

(stored_state))

3214

if sys.version_info.major == 2:

3215

clients_data, old_client_settings = pickle.load(

3216

stored_state)

3217

else:

3218

bytes_clients_data, bytes_old_client_settings = (

3219

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

3220

# Fix bytes to strings

3221

# clients_data

3222

# .keys()

3223

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

3224

if isinstance(key, bytes)

3225

else key): value

3226

for key, value in

3227

bytes_clients_data.items()}

3228

del bytes_clients_data

3229

for key in clients_data:

3230

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

3231

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

3232

for k, v in

3233

clients_data[key].items()}

3234

clients_data[key] = value

3235

# .client_structure

3236

value["client_structure"] = [

3237

(s.decode("utf-8")

3238

if isinstance(s, bytes)

3239

else s) for s in

3240

value["client_structure"]]

3241

# .name & .host

3242

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

3243

if isinstance(value[k], bytes):

3244

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

3245

if not value.has_key("key_id"):

3246

value["key_id"] = ""

3247

elif not value.has_key("fingerprint"):

3248

value["fingerprint"] = ""

3249

# old_client_settings

3250

# .keys()

3251

old_client_settings = {

3252

(key.decode("utf-8")

3253

if isinstance(key, bytes)

3254

else key): value

3255

for key, value in

3256

bytes_old_client_settings.items()}

3257

del bytes_old_client_settings

3258

# .host

3259

for value in old_client_settings.values():

3260

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

3261

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

3262

.decode("utf-8"))

2533

3263

os.remove(stored_state_path)

2534

3264

except IOError as e:

2535

3265

if e.errno == errno.ENOENT:

2536

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

2537

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

3266

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

3267

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

2538

3268

else:

2539

3269

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

2540

3270

exc_info=e)

2541

3271

raise

2542

3272

except EOFError as e:

2543

3273

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

2544

"EOFError:", exc_info=e)

2545

3274

"EOFError:",

3275

exc_info=e)

3276

2546

3277

with PGPEngine() as pgp:

2547

for client_name, client in clients_data.iteritems():

3278

for client_name, client in clients_data.items():

3279

# Skip removed clients

3280

if client_name not in client_settings:

3281

continue

3282

2548

3283

# Decide which value to use after restoring saved state.

2549

3284

# We have three different values: Old config file,

2550

3285

# new config file, and saved state.

2555

3290

# For each value in new config, check if it

2556

3291

# differs from the old config value (Except for

2557

3292

# the "secret" attribute)

2558

if (name != "secret" and

2559

value != old_client_settings[client_name]

2560

[name]):

3293

if (name != "secret"

3294

and (value !=

3295

old_client_settings[client_name][name])):

2561

3296

client[name] = value

2562

3297

except KeyError:

2563

3298

pass

2564

3299

2565

3300

# Clients who has passed its expire date can still be

2566

# enabled if its last checker was successful. Clients

3301

# enabled if its last checker was successful. A Client

2567

3302

# whose checker succeeded before we stored its state is

2568

3303

# assumed to have successfully run all checkers during

2569

3304

# downtime.

2571

3306

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

2572

3307

if not client["last_checked_ok"]:

2573

3308

logger.warning(

2574

"disabling client {0} - Client never "

2575

"performed a successful checker"

2576

.format(client_name))

3309

"disabling client {} - Client never "

3310

"performed a successful checker".format(

3311

client_name))

2577

3312

client["enabled"] = False

2578

3313

elif client["last_checker_status"] != 0:

2579

3314

logger.warning(

2580

"disabling client {0} - Client "

2581

"last checker failed with error code {1}"

2582

.format(client_name,

2583

client["last_checker_status"]))

3315

"disabling client {} - Client last"

3316

" checker failed with error code"

3317

" {}".format(

3318

client_name,

3319

client["last_checker_status"]))

2584

3320

client["enabled"] = False

2585

3321

else:

2586

client["expires"] = (datetime.datetime

2587

.utcnow()

2588

+ client["timeout"])

3322

client["expires"] = (

3323

datetime.datetime.utcnow()

3324

+ client["timeout"])

2589

3325

logger.debug("Last checker succeeded,"

2590

" keeping {0} enabled"

2591

.format(client_name))

3326

" keeping {} enabled".format(

3327

client_name))

2592

3328

try:

2593

client["secret"] = (

2594

pgp.decrypt(client["encrypted_secret"],

2595

client_settings[client_name]

2596

["secret"]))

3329

client["secret"] = pgp.decrypt(

3330

client["encrypted_secret"],

3331

client_settings[client_name]["secret"])

2597

3332

except PGPError:

2598

3333

# If decryption fails, we use secret from new settings

2599

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

2600

.format(client_name))

2601

client["secret"] = (

2602

client_settings[client_name]["secret"])

2603

3334

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

3335

client_name))

3336

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

3337

["secret"])

3338

2604

3339

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

2605

3340

for client_name in (set(old_client_settings)

2606

3341

- set(client_settings)):

2608

3343

for client_name in (set(client_settings)

2609

3344

- set(old_client_settings)):

2610

3345

clients_data[client_name] = client_settings[client_name]

2611

3346

2612

3347

# Create all client objects

2613

for client_name, client in clients_data.iteritems():

3348

for client_name, client in clients_data.items():

2614

3349

tcp_server.clients[client_name] = client_class(

2615

name = client_name, settings = client)

2616

3350

name=client_name,

3351

settings=client,

3352

server_settings=server_settings)

3353

2617

3354

if not tcp_server.clients:

2618

3355

logger.warning("No clients defined")

2619

3356

2620

3357

if not foreground:

2621

3358

if pidfile is not None:

3359

pid = os.getpid()

2622

3360

try:

2623

3361

with pidfile:

2624

pid = os.getpid()

2625

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

3362

print(pid, file=pidfile)

2626

3363

except IOError:

2627

3364

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

2628

3365

pidfilename, pid)

2629

3366

del pidfile

2630

3367

del pidfilename

2631

2632

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

2633

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

2634

3368

3369

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

3370

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3371

lambda: main_loop.quit() and False)

3372

2635

3373

if use_dbus:

2636

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

2637

"se.bsnet.fukt.Mandos"})

2638

class MandosDBusService(DBusObjectWithProperties):

3374

3375

@alternate_dbus_interfaces(

3376

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

3377

class MandosDBusService(DBusObjectWithObjectManager):

2639

3378

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

3379

2640

3380

def __init__(self):

2641

3381

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

3382

2642

3383

_interface = "se.recompile.Mandos"

2643

2644

@dbus_interface_annotations(_interface)

2645

def _foo(self):

2646

return { "org.freedesktop.DBus.Property"

2647

".EmitsChangedSignal":

2648

"false"}

2649

3384

2650

3385

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

2651

3386

def ClientAdded(self, objpath):

2652

3387

"D-Bus signal"

2653

3388

pass

2654

3389

2655

3390

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

2656

def ClientNotFound(self, fingerprint, address):

3391

def ClientNotFound(self, key_id, address):

2657

3392

"D-Bus signal"

2658

3393

pass

2659

3394

3395

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

3396

"true"})

2660

3397

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

2661

3398

def ClientRemoved(self, objpath, name):

2662

3399

"D-Bus signal"

2663

3400

pass

2664

3401

3402

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

3403

"true"})

2665

3404

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

2666

3405

def GetAllClients(self):

2667

3406

"D-Bus method"

2668

return dbus.Array(c.dbus_object_path

2669

for c in

2670

tcp_server.clients.itervalues())

2671

3407

return dbus.Array(c.dbus_object_path for c in

3408

tcp_server.clients.values())

3409

3410

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

3411

"true"})

2672

3412

@dbus.service.method(_interface,

2673

3413

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

2674

3414

def GetAllClientsWithProperties(self):

2675

3415

"D-Bus method"

2676

3416

return dbus.Dictionary(

2677

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

2678

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

3417

{c.dbus_object_path: c.GetAll(

3418

"se.recompile.Mandos.Client")

3419

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

2679

3420

signature="oa{sv}")

2680

3421

2681

3422

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

2682

3423

def RemoveClient(self, object_path):

2683

3424

"D-Bus method"

2684

for c in tcp_server.clients.itervalues():

3425

for c in tcp_server.clients.values():

2685

3426

if c.dbus_object_path == object_path:

2686

3427

del tcp_server.clients[c.name]

2687

3428

c.remove_from_connection()

2688

# Don't signal anything except ClientRemoved

3429

# Don't signal the disabling

2689

3430

c.disable(quiet=True)

2690

# Emit D-Bus signal

2691

self.ClientRemoved(object_path, c.name)

3431

# Emit D-Bus signal for removal

3432

self.client_removed_signal(c)

2692

3433

return

2693

3434

raise KeyError(object_path)

2694

3435

2695

3436

del _interface

2696

3437

3438

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3439

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

3440

def GetManagedObjects(self):

3441

"""D-Bus method"""

3442

return dbus.Dictionary(

3443

{client.dbus_object_path:

3444

dbus.Dictionary(

3445

{interface: client.GetAll(interface)

3446

for interface in

3447

client._get_all_interface_names()})

3448

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

3449

3450

def client_added_signal(self, client):

3451

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

3452

if use_dbus:

3453

# New standard signal

3454

self.InterfacesAdded(

3455

client.dbus_object_path,

3456

dbus.Dictionary(

3457

{interface: client.GetAll(interface)

3458

for interface in

3459

client._get_all_interface_names()}))

3460

# Old signal

3461

self.ClientAdded(client.dbus_object_path)

3462

3463

def client_removed_signal(self, client):

3464

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

3465

if use_dbus:

3466

# New standard signal

3467

self.InterfacesRemoved(

3468

client.dbus_object_path,

3469

client._get_all_interface_names())

3470

# Old signal

3471

self.ClientRemoved(client.dbus_object_path,

3472

client.name)

3473

2697

3474

mandos_dbus_service = MandosDBusService()

2698

3475

3476

# Save modules to variables to exempt the modules from being

3477

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

3478

mp = multiprocessing

3479

wn = wnull

3480

2699

3481

def cleanup():

2700

3482

"Cleanup function; run on exit"

2701

service.cleanup()

2702

2703

multiprocessing.active_children()

3483

if zeroconf:

3484

service.cleanup()

3485

3486

mp.active_children()

3487

wn.close()

2704

3488

if not (tcp_server.clients or client_settings):

2705

3489

return

2706

3490

2707

3491

# Store client before exiting. Secrets are encrypted with key

2708

3492

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

2709

3493

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

2710

3494

clients = {}

2711

3495

with PGPEngine() as pgp:

2712

for client in tcp_server.clients.itervalues():

3496

for client in tcp_server.clients.values():

2713

3497

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

2714

3498

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

2715

3499

key)

2716

3500

client_dict = {}

2717

3501

2718

3502

# A list of attributes that can not be pickled

2719

3503

# + secret.

2720

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

2721

"checker"))

2722

for name, typ in (inspect.getmembers

2723

(dbus.service.Object)):

3504

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

3505

"checker", "server_settings"}

3506

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

3507

.Object):

2724

3508

exclude.add(name)

2725

3509

2726

3510

client_dict["encrypted_secret"] = (client

2727

3511

.encrypted_secret)

2728

3512

for attr in client.client_structure:

2729

3513

if attr not in exclude:

2730

3514

client_dict[attr] = getattr(client, attr)

2731

3515

2732

3516

clients[client.name] = client_dict

2733

3517

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

2734

3518

2735

3519

try:

2736

with (tempfile.NamedTemporaryFile

2737

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

2738

dir=os.path.dirname(stored_state_path),

2739

delete=False)) as stored_state:

2740

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

2741

tempname=stored_state.name

3520

with tempfile.NamedTemporaryFile(

3521

mode='wb',

3522

suffix=".pickle",

3523

prefix='clients-',

3524

dir=os.path.dirname(stored_state_path),

3525

delete=False) as stored_state:

3526

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

3527

protocol=2)

3528

tempname = stored_state.name

2742

3529

os.rename(tempname, stored_state_path)

2743

3530

except (IOError, OSError) as e:

2744

3531

if not debug:

2747

3534

except NameError:

2748

3535

pass

2749

3536

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

2750

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

3537

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

2751

3538

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

2752

3539

else:

2753

3540

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

2754

3541

exc_info=e)

2755

raise e

2756

3542

raise

3543

2757

3544

# Delete all clients, and settings from config

2758

3545

while tcp_server.clients:

2759

3546

name, client = tcp_server.clients.popitem()

2760

3547

if use_dbus:

2761

3548

client.remove_from_connection()

2762

# Don't signal anything except ClientRemoved

3549

# Don't signal the disabling

2763

3550

client.disable(quiet=True)

3551

# Emit D-Bus signal for removal

2764

3552

if use_dbus:

2765

# Emit D-Bus signal

2766

mandos_dbus_service.ClientRemoved(client

2767

.dbus_object_path,

2768

client.name)

3553

mandos_dbus_service.client_removed_signal(client)

2769

3554

client_settings.clear()

2770

3555

2771

3556

atexit.register(cleanup)

2772

2773

for client in tcp_server.clients.itervalues():

3557

3558

for client in tcp_server.clients.values():

2774

3559

if use_dbus:

2775

# Emit D-Bus signal

2776

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3560

# Emit D-Bus signal for adding

3561

mandos_dbus_service.client_added_signal(client)

2777

3562

# Need to initiate checking of clients

2778

3563

if client.enabled:

2779

3564

client.init_checker()

2780

3565

2781

3566

tcp_server.enable()

2782

3567

tcp_server.server_activate()

2783

3568

2784

3569

# Find out what port we got

2785

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

3570

if zeroconf:

3571

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

2786

3572

if use_ipv6:

2787

3573

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

2788

3574

" flowinfo %d, scope_id %d",

2790

3576

else: # IPv4

2791

3577

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

2792

3578

*tcp_server.socket.getsockname())

2793

2794

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

2795

3579

3580

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

3581

2796

3582

try:

2797

# From the Avahi example code

2798

try:

2799

service.activate()

2800

except dbus.exceptions.DBusException as error:

2801

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

2802

cleanup()

2803

sys.exit(1)

2804

# End of Avahi example code

2805

2806

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

2807

lambda *args, **kwargs:

2808

(tcp_server.handle_request

2809

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

2810

3583

if zeroconf:

3584

# From the Avahi example code

3585

try:

3586

service.activate()

3587

except dbus.exceptions.DBusException as error:

3588

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

3589

cleanup()

3590

sys.exit(1)

3591

# End of Avahi example code

3592

3593

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

3594

lambda *args, **kwargs:

3595

(tcp_server.handle_request

3596

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

3597

2811

3598

logger.debug("Starting main loop")

2812

3599

main_loop.run()

2813

3600

except AvahiError as error:

2822

3609

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

2823

3610

cleanup()

2824

3611

3612

2825

3613

if __name__ == '__main__':

2826

3614

main()