/mandos/trunk : revision 636

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

72

81

73

import dbus

82

74

import dbus.service

83

from gi.repository import GLib

75

import gobject

76

import avahi

84

77

from dbus.mainloop.glib import DBusGMainLoop

85

78

import ctypes

86

79

import ctypes.util

87

80

import xml.dom.minidom

88

81

import inspect

89

82

90

# Try to find the value of SO_BINDTODEVICE:

91

83

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:

94

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

95

85

except AttributeError:

96

86

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

99

87

from IN import SO_BINDTODEVICE

100

88

except ImportError:

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"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.2"

119

92

stored_state_file = "clients.pickle"

120

93

121

94

logger = logging.getLogger()

122

syslogger = None

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

123

98

124

99

try:

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

127

103

except (OSError, AttributeError):

128

129

104

def if_nametoindex(interface):

130

105

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

131

106

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

132

107

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

133

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

134

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

135

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

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

136

113

return interface_index

137

114

138

115

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

155

116

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

156

117

"""init logger and add loglevel"""

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

118

162

119

syslogger.setFormatter(logging.Formatter

163

120

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

164

121

' %(message)s'))

165

122

logger.addHandler(syslogger)

166

123

167

124

if debug:

168

125

console = logging.StreamHandler()

169

126

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

181

138

182

139

class PGPEngine(object):

183

140

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

184

185

141

def __init__(self):

186

142

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

198

143

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

144

'--home', self.tempdir,

200

145

'--force-mdc',

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

146

'--quiet',

147

'--no-use-agent']

148

206

149

def __enter__(self):

207

150

return self

208

151

209

152

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

210

153

self._cleanup()

211

154

return False

212

155

213

156

def __del__(self):

214

157

self._cleanup()

215

158

216

159

def _cleanup(self):

217

160

if self.tempdir is not None:

218

161

# Delete contents of tempdir

219

162

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

220

topdown=False):

163

topdown = False):

221

164

for filename in files:

222

165

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

223

166

for dirname in dirs:

225

168

# Remove tempdir

226

169

os.rmdir(self.tempdir)

227

170

self.tempdir = None

228

171

229

172

def password_encode(self, password):

230

173

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

231

174

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

236

179

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

237

180

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

238

181

return encoded

239

182

240

183

def encrypt(self, data, password):

241

184

passphrase = self.password_encode(password)

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

185

with tempfile.NamedTemporaryFile(dir=self.tempdir

186

) as passfile:

244

187

passfile.write(passphrase)

245

188

passfile.flush()

246

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

189

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

247

190

'--passphrase-file',

248

191

passfile.name]

249

192

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

193

stdin = subprocess.PIPE,

194

stdout = subprocess.PIPE,

195

stderr = subprocess.PIPE)

196

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

254

197

if proc.returncode != 0:

255

198

raise PGPError(err)

256

199

return ciphertext

257

200

258

201

def decrypt(self, data, password):

259

202

passphrase = self.password_encode(password)

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

203

with tempfile.NamedTemporaryFile(dir = self.tempdir

204

) as passfile:

262

205

passfile.write(passphrase)

263

206

passfile.flush()

264

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

207

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

265

208

'--passphrase-file',

266

209

passfile.name]

267

210

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

211

stdin = subprocess.PIPE,

212

stdout = subprocess.PIPE,

213

stderr = subprocess.PIPE)

214

decrypted_plaintext, err = proc.communicate(input

215

= data)

272

216

if proc.returncode != 0:

273

217

raise PGPError(err)

274

218

return decrypted_plaintext

275

219

276

220

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

It is instantiated once, and simulates having an Avahi module."""

281

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

282

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

283

PROTO_INET = 0 # avahi-common/address.h

284

PROTO_INET6 = 1 # avahi-common/address.h

285

DBUS_NAME = "org.freedesktop.Avahi"

286

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

287

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

288

DBUS_PATH_SERVER = "/"

289

290

def string_array_to_txt_array(self, 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

avahi = Avahi()

302

303

304

221

class AvahiError(Exception):

305

222

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

306

223

self.value = value

307

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

308

**kwargs)

309

224

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

225

def __unicode__(self):

226

return unicode(repr(self.value))

310

227

311

228

class AvahiServiceError(AvahiError):

312

229

pass

313

230

314

315

231

class AvahiGroupError(AvahiError):

316

232

pass

317

233

318

234

319

235

class AvahiService(object):

320

236

"""An Avahi (Zeroconf) service.

321

237

322

238

Attributes:

323

239

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

324

240

Used to optionally bind to the specified interface.

336

252

server: D-Bus Server

337

253

bus: dbus.SystemBus()

338

254

"""

339

340

def __init__(self,

341

interface=avahi.IF_UNSPEC,

342

name=None,

343

servicetype=None,

344

port=None,

345

TXT=None,

346

domain="",

347

host="",

348

max_renames=32768,

349

protocol=avahi.PROTO_UNSPEC,

350

bus=None):

255

256

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

257

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

258

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

259

protocol = avahi.PROTO_UNSPEC, bus = None):

351

260

self.interface = interface

352

261

self.name = name

353

262

self.type = servicetype

362

271

self.server = None

363

272

self.bus = bus

364

273

self.entry_group_state_changed_match = None

365

366

def rename(self, remove=True):

274

275

def rename(self):

367

276

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

368

277

if self.rename_count >= self.max_renames:

369

278

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

370

279

" after %i retries, exiting.",

371

280

self.rename_count)

372

281

raise AvahiServiceError("Too many renames")

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

282

self.name = unicode(self.server

283

.GetAlternativeServiceName(self.name))

376

284

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

377

285

self.name)

378

if remove:

379

self.remove()

286

self.remove()

380

287

try:

381

288

self.add()

382

289

except dbus.exceptions.DBusException as error:

383

if (error.get_dbus_name()

384

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

385

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

386

return self.rename(remove=False)

387

else:

388

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

389

self.cleanup()

390

os._exit(1)

391

290

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

291

self.cleanup()

292

os._exit(1)

293

self.rename_count += 1

294

392

295

def remove(self):

393

296

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

394

297

if self.entry_group_state_changed_match is not None:

396

299

self.entry_group_state_changed_match = None

397

300

if self.group is not None:

398

301

self.group.Reset()

399

302

400

303

def add(self):

401

304

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

402

305

self.remove()

419

322

dbus.UInt16(self.port),

420

323

avahi.string_array_to_txt_array(self.TXT))

421

324

self.group.Commit()

422

325

423

326

def entry_group_state_changed(self, state, error):

424

327

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

425

328

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

426

329

427

330

if state == avahi.ENTRY_GROUP_ESTABLISHED:

428

331

logger.debug("Zeroconf service established.")

429

332

elif state == avahi.ENTRY_GROUP_COLLISION:

431

334

self.rename()

432

335

elif state == avahi.ENTRY_GROUP_FAILURE:

433

336

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

434

str(error))

435

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

436

337

unicode(error))

338

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

339

.format(error))

340

437

341

def cleanup(self):

438

342

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

439

343

if self.group is not None:

444

348

pass

445

349

self.group = None

446

350

self.remove()

447

351

448

352

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

449

353

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

450

354

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

451

bad_states = {

452

avahi.SERVER_INVALID: "Zeroconf server invalid",

453

avahi.SERVER_REGISTERING: None,

454

avahi.SERVER_COLLISION: "Zeroconf server name collision",

455

avahi.SERVER_FAILURE: "Zeroconf server failure",

456

}

355

bad_states = { avahi.SERVER_INVALID:

356

"Zeroconf server invalid",

357

avahi.SERVER_REGISTERING: None,

358

avahi.SERVER_COLLISION:

359

"Zeroconf server name collision",

360

avahi.SERVER_FAILURE:

361

"Zeroconf server failure" }

457

362

if state in bad_states:

458

363

if bad_states[state] is not None:

459

364

if error is None:

462

367

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

463

368

self.cleanup()

464

369

elif state == avahi.SERVER_RUNNING:

465

try:

466

self.add()

467

except dbus.exceptions.DBusException as error:

468

if (error.get_dbus_name()

469

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

470

logger.info("Local Zeroconf service name"

471

" collision.")

472

return self.rename(remove=False)

473

else:

474

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

475

self.cleanup()

476

os._exit(1)

370

self.add()

477

371

else:

478

372

if error is None:

479

373

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

480

374

else:

481

375

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

482

376

483

377

def activate(self):

484

378

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

485

379

if self.server is None:

489

383

follow_name_owner_changes=True),

490

384

avahi.DBUS_INTERFACE_SERVER)

491

385

self.server.connect_to_signal("StateChanged",

492

self.server_state_changed)

386

self.server_state_changed)

493

387

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

494

388

495

389

496

390

class AvahiServiceToSyslog(AvahiService):

497

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

391

def rename(self):

498

392

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

499

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

500

syslogger.setFormatter(logging.Formatter(

501

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

502

.format(self.name)))

393

ret = AvahiService.rename(self)

394

syslogger.setFormatter(logging.Formatter

395

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

396

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

397

.format(self.name)))

503

398

return ret

504

399

505

400

506

# Pretend that we have a GnuTLS module

507

class GnuTLS(object):

508

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

509

It is instantiated once, and simulates having a GnuTLS module."""

510

511

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

512

if library is None:

513

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

514

_library = ctypes.cdll.LoadLibrary(library)

515

del library

516

_need_version = b"3.3.0"

517

_tls_rawpk_version = b"3.6.6"

518

519

def __init__(self):

520

# Need to use "self" here, since this method is called before

521

# the assignment to the "gnutls" global variable happens.

522

if self.check_version(self._need_version) is None:

523

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

524

.format(self._need_version))

525

526

# Unless otherwise indicated, the constants and types below are

527

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

528

529

# Constants

530

E_SUCCESS = 0

531

E_INTERRUPTED = -52

532

E_AGAIN = -28

533

CRT_OPENPGP = 2

534

CRT_RAWPK = 3

535

CLIENT = 2

536

SHUT_RDWR = 0

537

CRD_CERTIFICATE = 1

538

E_NO_CERTIFICATE_FOUND = -49

539

X509_FMT_DER = 0

540

NO_TICKETS = 1<<10

541

ENABLE_RAWPK = 1<<18

542

CTYPE_PEERS = 3

543

KEYID_USE_SHA256 = 1 # gnutls/x509.h

544

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

545

546

# Types

547

class session_int(ctypes.Structure):

548

_fields_ = []

549

session_t = ctypes.POINTER(session_int)

550

551

class certificate_credentials_st(ctypes.Structure):

552

_fields_ = []

553

certificate_credentials_t = ctypes.POINTER(

554

certificate_credentials_st)

555

certificate_type_t = ctypes.c_int

556

557

class datum_t(ctypes.Structure):

558

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

559

('size', ctypes.c_uint)]

560

561

class openpgp_crt_int(ctypes.Structure):

562

_fields_ = []

563

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

564

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

565

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

566

credentials_type_t = ctypes.c_int

567

transport_ptr_t = ctypes.c_void_p

568

close_request_t = ctypes.c_int

569

570

# Exceptions

571

class Error(Exception):

572

# We need to use the class name "GnuTLS" here, since this

573

# exception might be raised from within GnuTLS.__init__,

574

# which is called before the assignment to the "gnutls"

575

# global variable has happened.

576

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

577

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

578

# code is passed, convert it to a string with

579

# gnutls.strerror()

580

self.code = code

581

if message is None and code is not None:

582

message = GnuTLS.strerror(code)

583

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

584

message, *args)

585

586

class CertificateSecurityError(Error):

587

pass

588

589

# Classes

590

class Credentials(object):

591

def __init__(self):

592

self._c_object = gnutls.certificate_credentials_t()

593

gnutls.certificate_allocate_credentials(

594

ctypes.byref(self._c_object))

595

self.type = gnutls.CRD_CERTIFICATE

596

597

def __del__(self):

598

gnutls.certificate_free_credentials(self._c_object)

599

600

class ClientSession(object):

601

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

602

self._c_object = gnutls.session_t()

603

gnutls_flags = gnutls.CLIENT

604

if gnutls.check_version("3.5.6"):

605

gnutls_flags |= gnutls.NO_TICKETS

606

if gnutls.has_rawpk:

607

gnutls_flags |= gnutls.ENABLE_RAWPK

608

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

609

del gnutls_flags

610

gnutls.set_default_priority(self._c_object)

611

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

612

gnutls.handshake_set_private_extensions(self._c_object,

613

True)

614

self.socket = socket

615

if credentials is None:

616

credentials = gnutls.Credentials()

617

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

618

ctypes.cast(credentials._c_object,

619

ctypes.c_void_p))

620

self.credentials = credentials

621

622

def __del__(self):

623

gnutls.deinit(self._c_object)

624

625

def handshake(self):

626

return gnutls.handshake(self._c_object)

627

628

def send(self, data):

629

data = bytes(data)

630

data_len = len(data)

631

while data_len > 0:

632

data_len -= gnutls.record_send(self._c_object,

633

data[-data_len:],

634

data_len)

635

636

def bye(self):

637

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

638

639

# Error handling functions

640

def _error_code(result):

641

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

642

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

643

if result >= 0:

644

return result

645

if result == gnutls.E_NO_CERTIFICATE_FOUND:

646

raise gnutls.CertificateSecurityError(code=result)

647

raise gnutls.Error(code=result)

648

649

def _retry_on_error(result, func, arguments):

650

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

651

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

652

while result < 0:

653

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

654

return _error_code(result)

655

result = func(*arguments)

656

return result

657

658

# Unless otherwise indicated, the function declarations below are

659

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

660

661

# Functions

662

priority_set_direct = _library.gnutls_priority_set_direct

663

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

664

ctypes.POINTER(ctypes.c_char_p)]

665

priority_set_direct.restype = _error_code

666

667

init = _library.gnutls_init

668

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

669

init.restype = _error_code

670

671

set_default_priority = _library.gnutls_set_default_priority

672

set_default_priority.argtypes = [session_t]

673

set_default_priority.restype = _error_code

674

675

record_send = _library.gnutls_record_send

676

record_send.argtypes = [session_t, ctypes.c_void_p,

677

ctypes.c_size_t]

678

record_send.restype = ctypes.c_ssize_t

679

record_send.errcheck = _retry_on_error

680

681

certificate_allocate_credentials = (

682

_library.gnutls_certificate_allocate_credentials)

683

certificate_allocate_credentials.argtypes = [

684

ctypes.POINTER(certificate_credentials_t)]

685

certificate_allocate_credentials.restype = _error_code

686

687

certificate_free_credentials = (

688

_library.gnutls_certificate_free_credentials)

689

certificate_free_credentials.argtypes = [

690

certificate_credentials_t]

691

certificate_free_credentials.restype = None

692

693

handshake_set_private_extensions = (

694

_library.gnutls_handshake_set_private_extensions)

695

handshake_set_private_extensions.argtypes = [session_t,

696

ctypes.c_int]

697

handshake_set_private_extensions.restype = None

698

699

credentials_set = _library.gnutls_credentials_set

700

credentials_set.argtypes = [session_t, credentials_type_t,

701

ctypes.c_void_p]

702

credentials_set.restype = _error_code

703

704

strerror = _library.gnutls_strerror

705

strerror.argtypes = [ctypes.c_int]

706

strerror.restype = ctypes.c_char_p

707

708

certificate_type_get = _library.gnutls_certificate_type_get

709

certificate_type_get.argtypes = [session_t]

710

certificate_type_get.restype = _error_code

711

712

certificate_get_peers = _library.gnutls_certificate_get_peers

713

certificate_get_peers.argtypes = [session_t,

714

ctypes.POINTER(ctypes.c_uint)]

715

certificate_get_peers.restype = ctypes.POINTER(datum_t)

716

717

global_set_log_level = _library.gnutls_global_set_log_level

718

global_set_log_level.argtypes = [ctypes.c_int]

719

global_set_log_level.restype = None

720

721

global_set_log_function = _library.gnutls_global_set_log_function

722

global_set_log_function.argtypes = [log_func]

723

global_set_log_function.restype = None

724

725

deinit = _library.gnutls_deinit

726

deinit.argtypes = [session_t]

727

deinit.restype = None

728

729

handshake = _library.gnutls_handshake

730

handshake.argtypes = [session_t]

731

handshake.restype = _error_code

732

handshake.errcheck = _retry_on_error

733

734

transport_set_ptr = _library.gnutls_transport_set_ptr

735

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

736

transport_set_ptr.restype = None

737

738

bye = _library.gnutls_bye

739

bye.argtypes = [session_t, close_request_t]

740

bye.restype = _error_code

741

bye.errcheck = _retry_on_error

742

743

check_version = _library.gnutls_check_version

744

check_version.argtypes = [ctypes.c_char_p]

745

check_version.restype = ctypes.c_char_p

746

747

has_rawpk = bool(check_version(_tls_rawpk_version))

748

749

if has_rawpk:

750

# Types

751

class pubkey_st(ctypes.Structure):

752

_fields = []

753

pubkey_t = ctypes.POINTER(pubkey_st)

754

755

x509_crt_fmt_t = ctypes.c_int

756

757

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

758

pubkey_init = _library.gnutls_pubkey_init

759

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

760

pubkey_init.restype = _error_code

761

762

pubkey_import = _library.gnutls_pubkey_import

763

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

764

x509_crt_fmt_t]

765

pubkey_import.restype = _error_code

766

767

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

768

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

769

ctypes.POINTER(ctypes.c_ubyte),

770

ctypes.POINTER(ctypes.c_size_t)]

771

pubkey_get_key_id.restype = _error_code

772

773

pubkey_deinit = _library.gnutls_pubkey_deinit

774

pubkey_deinit.argtypes = [pubkey_t]

775

pubkey_deinit.restype = None

776

else:

777

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

778

779

openpgp_crt_init = _library.gnutls_openpgp_crt_init

780

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

781

openpgp_crt_init.restype = _error_code

782

783

openpgp_crt_import = _library.gnutls_openpgp_crt_import

784

openpgp_crt_import.argtypes = [openpgp_crt_t,

785

ctypes.POINTER(datum_t),

786

openpgp_crt_fmt_t]

787

openpgp_crt_import.restype = _error_code

788

789

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

790

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

791

ctypes.POINTER(ctypes.c_uint)]

792

openpgp_crt_verify_self.restype = _error_code

793

794

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

795

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

796

openpgp_crt_deinit.restype = None

797

798

openpgp_crt_get_fingerprint = (

799

_library.gnutls_openpgp_crt_get_fingerprint)

800

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

801

ctypes.c_void_p,

802

ctypes.POINTER(

803

ctypes.c_size_t)]

804

openpgp_crt_get_fingerprint.restype = _error_code

805

806

if check_version("3.6.4"):

807

certificate_type_get2 = _library.gnutls_certificate_type_get2

808

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

809

certificate_type_get2.restype = _error_code

810

811

# Remove non-public functions

812

del _error_code, _retry_on_error

813

# Create the global "gnutls" object, simulating a module

814

gnutls = GnuTLS()

815

816

817

def call_pipe(connection, # : multiprocessing.Connection

818

func, *args, **kwargs):

819

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

820

821

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

822

return value on the provided multiprocessing.Connection.

823

"""

824

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

825

connection.close()

401

def timedelta_to_milliseconds(td):

402

"Convert a datetime.timedelta() to milliseconds"

403

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

404

+ (td.seconds * 1000)

405

+ (td.microseconds // 1000))

826

406

827

407

828

408

class Client(object):

829

409

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

830

410

831

411

Attributes:

832

412

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

833

413

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

835

415

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

836

416

to see if the client lives.

837

417

'None' if no process is running.

838

checker_callback_tag: a GLib event source tag, or None

418

checker_callback_tag: a gobject event source tag, or None

839

419

checker_command: string; External command which is run to check

840

420

if client lives. %() expansions are done at

841

421

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

842

422

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

843

checker_initiator_tag: a GLib event source tag, or None

423

checker_initiator_tag: a gobject event source tag, or None

844

424

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

845

425

client_structure: Object describing what attributes a client has

846

426

and is used for storing the client at exit

847

427

current_checker_command: string; current running checker_command

848

disable_initiator_tag: a GLib event source tag, or None

428

disable_initiator_tag: a gobject event source tag, or None

849

429

enabled: bool()

850

430

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

851

uniquely identify an OpenPGP client

852

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

853

a client using raw public keys

431

uniquely identify the client

854

432

host: string; available for use by the checker command

855

433

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

856

434

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

858

436

last_checker_status: integer between 0 and 255 reflecting exit

859

437

status of last checker. -1 reflects crashed

860

438

checker, -2 means no checker completed yet.

861

last_checker_signal: The signal which killed the last checker, if

862

last_checker_status is -1

863

439

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

864

440

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

865

441

D-Bus identifiers

872

448

disabled, or None

873

449

server_settings: The server_settings dict from main()

874

450

"""

875

451

876

452

runtime_expansions = ("approval_delay", "approval_duration",

877

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

453

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

878

454

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

879

455

"last_approval_request", "last_checked_ok",

880

456

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

881

client_defaults = {

882

"timeout": "PT5M",

883

"extended_timeout": "PT15M",

884

"interval": "PT2M",

885

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

886

"host": "",

887

"approval_delay": "PT0S",

888

"approval_duration": "PT1S",

889

"approved_by_default": "True",

890

"enabled": "True",

891

}

892

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

460

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

461

"host": "",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

464

"approved_by_default": "True",

465

"enabled": "True",

466

}

467

468

def timeout_milliseconds(self):

469

"Return the 'timeout' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.timeout)

471

472

def extended_timeout_milliseconds(self):

473

"Return the 'extended_timeout' attribute in milliseconds"

474

return timedelta_to_milliseconds(self.extended_timeout)

475

476

def interval_milliseconds(self):

477

"Return the 'interval' attribute in milliseconds"

478

return timedelta_to_milliseconds(self.interval)

479

480

def approval_delay_milliseconds(self):

481

return timedelta_to_milliseconds(self.approval_delay)

482

893

483

@staticmethod

894

484

def config_parser(config):

895

485

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

902

492

for client_name in config.sections():

903

493

section = dict(config.items(client_name))

904

494

client = settings[client_name] = {}

905

495

906

496

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

907

497

# Reformat values from string types to Python types

908

498

client["approved_by_default"] = config.getboolean(

909

499

client_name, "approved_by_default")

910

500

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

911

501

"enabled")

912

913

# Uppercase and remove spaces from key_id and fingerprint

914

# for later comparison purposes with return value from the

915

# key_id() and fingerprint() functions

916

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

917

.replace(" ", ""))

502

918

503

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

919

504

.replace(" ", ""))

920

505

if "secret" in section:

921

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

922

.encode("utf-8"),

923

"base64")

506

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

924

507

elif "secfile" in section:

925

508

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

926

509

(section["secfile"])),

927

510

"rb") as secfile:

928

511

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

929

512

else:

930

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

513

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

931

514

.format(section))

932

515

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

933

516

client["extended_timeout"] = string_to_delta(

941

524

client["last_approval_request"] = None

942

525

client["last_checked_ok"] = None

943

526

client["last_checker_status"] = -2

944

527

945

528

return settings

946

947

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

529

530

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

948

531

self.name = name

949

532

if server_settings is None:

950

533

server_settings = {}

951

534

self.server_settings = server_settings

952

535

# adding all client settings

953

for setting, value in settings.items():

536

for setting, value in settings.iteritems():

954

537

setattr(self, setting, value)

955

538

956

539

if self.enabled:

957

540

if not hasattr(self, "last_enabled"):

958

541

self.last_enabled = datetime.datetime.utcnow()

962

545

else:

963

546

self.last_enabled = None

964

547

self.expires = None

965

548

966

549

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

967

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

550

# Uppercase and remove spaces from fingerprint for later

551

# comparison purposes with return value from the fingerprint()

552

# function

968

553

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

969

554

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

970

555

datetime.datetime.utcnow())

971

556

972

557

# attributes specific for this server instance

973

558

self.checker = None

974

559

self.checker_initiator_tag = None

977

562

self.current_checker_command = None

978

563

self.approved = None

979

564

self.approvals_pending = 0

980

self.changedstate = multiprocessing_manager.Condition(

981

multiprocessing_manager.Lock())

982

self.client_structure = [attr

983

for attr in self.__dict__.keys()

565

self.changedstate = (multiprocessing_manager

566

.Condition(multiprocessing_manager

567

.Lock()))

568

self.client_structure = [attr for attr in

569

self.__dict__.iterkeys()

984

570

if not attr.startswith("_")]

985

571

self.client_structure.append("client_structure")

986

987

for name, t in inspect.getmembers(

988

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

572

573

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

574

lambda obj:

575

isinstance(obj,

576

property)):

989

577

if not name.startswith("_"):

990

578

self.client_structure.append(name)

991

579

992

580

# Send notice to process children that client state has changed

993

581

def send_changedstate(self):

994

582

with self.changedstate:

995

583

self.changedstate.notify_all()

996

584

997

585

def enable(self):

998

586

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

999

587

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

1004

592

self.last_enabled = datetime.datetime.utcnow()

1005

593

self.init_checker()

1006

594

self.send_changedstate()

1007

595

1008

596

def disable(self, quiet=True):

1009

597

"""Disable this client."""

1010

598

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

1012

600

if not quiet:

1013

601

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

1014

602

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

1015

GLib.source_remove(self.disable_initiator_tag)

603

gobject.source_remove(self.disable_initiator_tag)

1016

604

self.disable_initiator_tag = None

1017

605

self.expires = None

1018

606

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

1019

GLib.source_remove(self.checker_initiator_tag)

607

gobject.source_remove(self.checker_initiator_tag)

1020

608

self.checker_initiator_tag = None

1021

609

self.stop_checker()

1022

610

self.enabled = False

1023

611

if not quiet:

1024

612

self.send_changedstate()

1025

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

613

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

1026

614

return False

1027

615

1028

616

def __del__(self):

1029

617

self.disable()

1030

618

1031

619

def init_checker(self):

1032

620

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

1033

621

# and every interval from then on.

1034

622

if self.checker_initiator_tag is not None:

1035

GLib.source_remove(self.checker_initiator_tag)

1036

self.checker_initiator_tag = GLib.timeout_add(

1037

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

1038

self.start_checker)

623

gobject.source_remove(self.checker_initiator_tag)

624

self.checker_initiator_tag = (gobject.timeout_add

625

(self.interval_milliseconds(),

626

self.start_checker))

1039

627

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

1040

628

if self.disable_initiator_tag is not None:

1041

GLib.source_remove(self.disable_initiator_tag)

1042

self.disable_initiator_tag = GLib.timeout_add(

1043

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

629

gobject.source_remove(self.disable_initiator_tag)

630

self.disable_initiator_tag = (gobject.timeout_add

631

(self.timeout_milliseconds(),

632

self.disable))

1044

633

# Also start a new checker *right now*.

1045

634

self.start_checker()

1046

1047

def checker_callback(self, source, condition, connection,

1048

command):

635

636

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

1049

637

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

1050

638

self.checker_callback_tag = None

1051

639

self.checker = None

1052

# Read return code from connection (see call_pipe)

1053

returncode = connection.recv()

1054

connection.close()

1055

1056

if returncode >= 0:

1057

self.last_checker_status = returncode

1058

self.last_checker_signal = None

640

if os.WIFEXITED(condition):

641

self.last_checker_status = os.WEXITSTATUS(condition)

1059

642

if self.last_checker_status == 0:

1060

643

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

1061

644

vars(self))

1062

645

self.checked_ok()

1063

646

else:

1064

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

647

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

648

vars(self))

1065

649

else:

1066

650

self.last_checker_status = -1

1067

self.last_checker_signal = -returncode

1068

651

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

1069

652

vars(self))

1070

return False

1071

653

1072

654

def checked_ok(self):

1073

655

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

1074

656

self.last_checked_ok = datetime.datetime.utcnow()

1075

657

self.last_checker_status = 0

1076

self.last_checker_signal = None

1077

658

self.bump_timeout()

1078

659

1079

660

def bump_timeout(self, timeout=None):

1080

661

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

1081

662

if timeout is None:

1082

663

timeout = self.timeout

1083

664

if self.disable_initiator_tag is not None:

1084

GLib.source_remove(self.disable_initiator_tag)

665

gobject.source_remove(self.disable_initiator_tag)

1085

666

self.disable_initiator_tag = None

1086

667

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

1087

self.disable_initiator_tag = GLib.timeout_add(

1088

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

668

self.disable_initiator_tag = (gobject.timeout_add

669

(timedelta_to_milliseconds

670

(timeout), self.disable))

1089

671

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

1090

672

1091

673

def need_approval(self):

1092

674

self.last_approval_request = datetime.datetime.utcnow()

1093

675

1094

676

def start_checker(self):

1095

677

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

1096

678

1097

679

If a checker already exists, leave it running and do

1098

680

nothing."""

1099

681

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

1104

686

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

1105

687

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

1106

688

# should be.

1107

1108

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

1109

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

1110

self.checker.join()

1111

self.checker = None

689

690

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

691

try:

692

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

693

except (AttributeError, OSError) as error:

694

if (isinstance(error, OSError)

695

and error.errno != errno.ECHILD):

696

raise error

697

else:

698

if pid:

699

logger.warning("Checker was a zombie")

700

gobject.source_remove(self.checker_callback_tag)

701

self.checker_callback(pid, status,

702

self.current_checker_command)

1112

703

# Start a new checker if needed

1113

704

if self.checker is None:

1114

705

# Escape attributes for the shell

1115

escaped_attrs = {

1116

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

1117

for attr in self.runtime_expansions}

706

escaped_attrs = dict(

707

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

708

for attr in

709

self.runtime_expansions)

1118

710

try:

1119

711

command = self.checker_command % escaped_attrs

1120

712

except TypeError as error:

1121

713

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

1122

self.checker_command,

714

self.checker_command, exc_info=error)

715

return True # Try again later

716

self.current_checker_command = command

717

try:

718

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

719

command, self.name)

720

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

721

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

722

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

723

# always replaced by /dev/null.)

724

# The exception is when not debugging but nevertheless

725

# running in the foreground; use the previously

726

# created wnull.

727

popen_args = {}

728

if (not self.server_settings["debug"]

729

and self.server_settings["foreground"]):

730

popen_args.update({"stdout": wnull,

731

"stderr": wnull })

732

self.checker = subprocess.Popen(command,

733

close_fds=True,

734

shell=True, cwd="/",

735

**popen_args)

736

except OSError as error:

737

logger.error("Failed to start subprocess",

1123

738

exc_info=error)

1124

return True # Try again later

1125

self.current_checker_command = command

1126

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

1127

self.name)

1128

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

1129

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

1130

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

1131

# always replaced by /dev/null.)

1132

# The exception is when not debugging but nevertheless

1133

# running in the foreground; use the previously

1134

# created wnull.

1135

popen_args = {"close_fds": True,

1136

"shell": True,

1137

"cwd": "/"}

1138

if (not self.server_settings["debug"]

1139

and self.server_settings["foreground"]):

1140

popen_args.update({"stdout": wnull,

1141

"stderr": wnull})

1142

pipe = multiprocessing.Pipe(duplex=False)

1143

self.checker = multiprocessing.Process(

1144

target=call_pipe,

1145

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

1146

kwargs=popen_args)

1147

self.checker.start()

1148

self.checker_callback_tag = GLib.io_add_watch(

1149

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

1150

self.checker_callback, pipe[0], command)

1151

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

739

return True

740

self.checker_callback_tag = (gobject.child_watch_add

741

(self.checker.pid,

742

self.checker_callback,

743

data=command))

744

# The checker may have completed before the gobject

745

# watch was added. Check for this.

746

try:

747

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

748

except OSError as error:

749

if error.errno == errno.ECHILD:

750

# This should never happen

751

logger.error("Child process vanished",

752

exc_info=error)

753

return True

754

raise

755

if pid:

756

gobject.source_remove(self.checker_callback_tag)

757

self.checker_callback(pid, status, command)

758

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

1152

759

return True

1153

760

1154

761

def stop_checker(self):

1155

762

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

1156

763

if self.checker_callback_tag:

1157

GLib.source_remove(self.checker_callback_tag)

764

gobject.source_remove(self.checker_callback_tag)

1158

765

self.checker_callback_tag = None

1159

766

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

1160

767

return

1161

768

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

1162

self.checker.terminate()

769

try:

770

self.checker.terminate()

771

#time.sleep(0.5)

772

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

773

# self.checker.kill()

774

except OSError as error:

775

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

776

raise

1163

777

self.checker = None

1164

778

1165

779

1166

def dbus_service_property(dbus_interface,

1167

signature="v",

1168

access="readwrite",

1169

byte_arrays=False):

780

def dbus_service_property(dbus_interface, signature="v",

781

access="readwrite", byte_arrays=False):

1170

782

"""Decorators for marking methods of a DBusObjectWithProperties to

1171

783

become properties on the D-Bus.

1172

784

1173

785

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

1174

786

and with one argument by "Set".

1175

787

1176

788

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

1177

789

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

1178

790

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

1181

793

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

1182

794

if byte_arrays and signature != "ay":

1183

795

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

1184

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

1185

796

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

1186

797

def decorator(func):

1187

798

func._dbus_is_property = True

1188

799

func._dbus_interface = dbus_interface

1191

802

func._dbus_name = func.__name__

1192

803

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

1193

804

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

1194

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

805

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1195

806

return func

1196

1197

807

return decorator

1198

808

1199

809

1200

810

def dbus_interface_annotations(dbus_interface):

1201

811

"""Decorator for marking functions returning interface annotations

1202

812

1203

813

Usage:

1204

814

1205

815

@dbus_interface_annotations("org.example.Interface")

1206

816

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

1207

817

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

1208

818

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

1209

819

"false"}

1210

820

"""

1211

1212

821

def decorator(func):

1213

822

func._dbus_is_interface = True

1214

823

func._dbus_interface = dbus_interface

1215

824

func._dbus_name = dbus_interface

1216

825

return func

1217

1218

826

return decorator

1219

827

1220

828

1221

829

def dbus_annotations(annotations):

1222

830

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

1223

831

Usage:

1224

1225

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

1226

"org.freedesktop.DBus.Property."

1227

"EmitsChangedSignal": "false"})

832

1228

833

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

1229

834

access="r")

835

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

836

"org.freedesktop.DBus.Property."

837

"EmitsChangedSignal": "false"})

1230

838

def Property_dbus_property(self):

1231

839

return dbus.Boolean(False)

1232

1233

See also the DBusObjectWithAnnotations class.

1234

840

"""

1235

1236

841

def decorator(func):

1237

842

func._dbus_annotations = annotations

1238

843

return func

1239

1240

844

return decorator

1241

845

1242

846

1243

847

class DBusPropertyException(dbus.exceptions.DBusException):

1244

848

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

1245

849

"""

1246

pass

850

def __unicode__(self):

851

return unicode(str(self))

1247

852

1248

853

1249

854

class DBusPropertyAccessException(DBusPropertyException):

1258

863

pass

1259

864

1260

865

1261

class DBusObjectWithAnnotations(dbus.service.Object):

1262

"""A D-Bus object with annotations.

1263

1264

Classes inheriting from this can use the dbus_annotations

1265

decorator to add annotations to methods or signals.

866

class DBusObjectWithProperties(dbus.service.Object):

867

"""A D-Bus object with properties.

868

869

Classes inheriting from this can use the dbus_service_property

870

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

871

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

1266

872

"""

1267

873

1268

874

@staticmethod

1269

875

def _is_dbus_thing(thing):

1270

876

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

1271

877

1272

878

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

1273

879

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

1274

880

"""

1275

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

881

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

1276

882

False)

1277

883

1278

884

def _get_all_dbus_things(self, thing):

1279

885

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

1280

886

"""

1281

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

887

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

888

name),

1282

889

athing.__get__(self))

1283

890

for cls in self.__class__.__mro__

1284

891

for name, athing in

1285

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

1286

1287

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1288

out_signature="s",

1289

path_keyword='object_path',

1290

connection_keyword='connection')

1291

def Introspect(self, object_path, connection):

1292

"""Overloading of standard D-Bus method.

1293

1294

Inserts annotation tags on methods and signals.

1295

"""

1296

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

1297

connection)

1298

try:

1299

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

1300

1301

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

1302

# Add annotation tags

1303

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

1304

for tag in if_tag.getElementsByTagName(typ):

1305

annots = dict()

1306

for name, prop in (self.

1307

_get_all_dbus_things(typ)):

1308

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

1309

and prop._dbus_interface

1310

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

1311

annots.update(getattr(

1312

prop, "_dbus_annotations", {}))

1313

for name, value in annots.items():

1314

ann_tag = document.createElement(

1315

"annotation")

1316

ann_tag.setAttribute("name", name)

1317

ann_tag.setAttribute("value", value)

1318

tag.appendChild(ann_tag)

1319

# Add interface annotation tags

1320

for annotation, value in dict(

1321

itertools.chain.from_iterable(

1322

annotations().items()

1323

for name, annotations

1324

in self._get_all_dbus_things("interface")

1325

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

1326

)).items():

1327

ann_tag = document.createElement("annotation")

1328

ann_tag.setAttribute("name", annotation)

1329

ann_tag.setAttribute("value", value)

1330

if_tag.appendChild(ann_tag)

1331

# Fix argument name for the Introspect method itself

1332

if (if_tag.getAttribute("name")

1333

== dbus.INTROSPECTABLE_IFACE):

1334

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

1335

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

1336

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

1337

if (arg.getAttribute("direction")

1338

== "out"):

1339

arg.setAttribute("name",

1340

"xml_data")

1341

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

1342

document.unlink()

1343

except (AttributeError, xml.dom.DOMException,

1344

xml.parsers.expat.ExpatError) as error:

1345

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

1346

exc_info=error)

1347

return xmlstring

1348

1349

1350

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1351

"""A D-Bus object with properties.

1352

1353

Classes inheriting from this can use the dbus_service_property

1354

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

1355

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

1356

"""

1357

892

inspect.getmembers(cls,

893

self._is_dbus_thing(thing)))

894

1358

895

def _get_dbus_property(self, interface_name, property_name):

1359

896

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

1360

897

property with the specified name and interface.

1361

898

"""

1362

for cls in self.__class__.__mro__:

1363

for name, value in inspect.getmembers(

1364

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

899

for cls in self.__class__.__mro__:

900

for name, value in (inspect.getmembers

901

(cls,

902

self._is_dbus_thing("property"))):

1365

903

if (value._dbus_name == property_name

1366

904

and value._dbus_interface == interface_name):

1367

905

return value.__get__(self)

1368

906

1369

907

# No such property

1370

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

1371

self.dbus_object_path, interface_name, property_name))

1372

1373

@classmethod

1374

def _get_all_interface_names(cls):

1375

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

1376

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

1377

"_dbus_interface", None)

1378

for x in (inspect.getmro(cls))

1379

for attr in dir(x))

1380

if name is not None)

1381

1382

@dbus.service.method(dbus.PROPERTIES_IFACE,

1383

in_signature="ss",

908

raise DBusPropertyNotFound(self.dbus_object_path + ":"

909

+ interface_name + "."

910

+ property_name)

911

912

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

1384

913

out_signature="v")

1385

914

def Get(self, interface_name, property_name):

1386

915

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

1392

921

if not hasattr(value, "variant_level"):

1393

922

return value

1394

923

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

1395

924

1396

925

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

1397

926

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

1398

927

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

1404

933

# The byte_arrays option is not supported yet on

1405

934

# signatures other than "ay".

1406

935

if prop._dbus_signature != "ay":

1407

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

1408

"'ay' signature {!r}"

1409

.format(prop._dbus_signature))

936

raise ValueError

1410

937

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

1411

938

for byte in value))

1412

939

prop(value)

1413

1414

@dbus.service.method(dbus.PROPERTIES_IFACE,

1415

in_signature="s",

940

941

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

1416

942

out_signature="a{sv}")

1417

943

def GetAll(self, interface_name):

1418

944

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

1419

945

standard.

1420

946

1421

947

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

1422

948

"""

1423

949

properties = {}

1433

959

if not hasattr(value, "variant_level"):

1434

960

properties[name] = value

1435

961

continue

1436

properties[name] = type(value)(

1437

value, variant_level=value.variant_level + 1)

962

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

963

value.variant_level+1)

1438

964

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

1439

1440

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

1441

def PropertiesChanged(self, interface_name, changed_properties,

1442

invalidated_properties):

1443

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

1444

standard.

1445

"""

1446

pass

1447

965

1448

966

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1449

967

out_signature="s",

1450

968

path_keyword='object_path',

1451

969

connection_keyword='connection')

1452

970

def Introspect(self, object_path, connection):

1453

971

"""Overloading of standard D-Bus method.

1454

972

1455

973

Inserts property tags and interface annotation tags.

1456

974

"""

1457

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1458

object_path,

1459

connection)

975

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

976

connection)

1460

977

try:

1461

978

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

1462

1463

979

def make_tag(document, name, prop):

1464

980

e = document.createElement("property")

1465

981

e.setAttribute("name", name)

1466

982

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

1467

983

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

1468

984

return e

1469

1470

985

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

1471

986

# Add property tags

1472

987

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

1475

990

if prop._dbus_interface

1476

991

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

1477

992

if_tag.appendChild(tag)

1478

# Add annotation tags for properties

1479

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

1480

annots = dict()

1481

for name, prop in self._get_all_dbus_things(

1482

"property"):

1483

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

1484

and prop._dbus_interface

1485

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

1486

annots.update(getattr(

1487

prop, "_dbus_annotations", {}))

1488

for name, value in annots.items():

1489

ann_tag = document.createElement(

1490

"annotation")

1491

ann_tag.setAttribute("name", name)

1492

ann_tag.setAttribute("value", value)

1493

tag.appendChild(ann_tag)

993

# Add annotation tags

994

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

995

for tag in if_tag.getElementsByTagName(typ):

996

annots = dict()

997

for name, prop in (self.

998

_get_all_dbus_things(typ)):

999

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

1000

and prop._dbus_interface

1001

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

1002

annots.update(getattr

1003

(prop,

1004

"_dbus_annotations",

1005

{}))

1006

for name, value in annots.iteritems():

1007

ann_tag = document.createElement(

1008

"annotation")

1009

ann_tag.setAttribute("name", name)

1010

ann_tag.setAttribute("value", value)

1011

tag.appendChild(ann_tag)

1012

# Add interface annotation tags

1013

for annotation, value in dict(

1014

itertools.chain.from_iterable(

1015

annotations().iteritems()

1016

for name, annotations in

1017

self._get_all_dbus_things("interface")

1018

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

1019

)).iteritems():

1020

ann_tag = document.createElement("annotation")

1021

ann_tag.setAttribute("name", annotation)

1022

ann_tag.setAttribute("value", value)

1023

if_tag.appendChild(ann_tag)

1494

1024

# Add the names to the return values for the

1495

1025

# "org.freedesktop.DBus.Properties" methods

1496

1026

if (if_tag.getAttribute("name")

1515

1045

return xmlstring

1516

1046

1517

1047

1518

try:

1519

dbus.OBJECT_MANAGER_IFACE

1520

except AttributeError:

1521

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

1522

1523

1524

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1525

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

1526

1527

Classes inheriting from this exposes the standard

1528

GetManagedObjects call and the InterfacesAdded and

1529

InterfacesRemoved signals on the standard

1530

"org.freedesktop.DBus.ObjectManager" interface.

1531

1532

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

1533

manually.

1534

"""

1535

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1536

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

1537

def GetManagedObjects(self):

1538

"""This function must be overridden"""

1539

raise NotImplementedError()

1540

1541

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1542

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

1543

def InterfacesAdded(self, object_path, interfaces_and_properties):

1544

pass

1545

1546

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

1547

def InterfacesRemoved(self, object_path, interfaces):

1548

pass

1549

1550

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1551

out_signature="s",

1552

path_keyword='object_path',

1553

connection_keyword='connection')

1554

def Introspect(self, object_path, connection):

1555

"""Overloading of standard D-Bus method.

1556

1557

Override return argument name of GetManagedObjects to be

1558

"objpath_interfaces_and_properties"

1559

"""

1560

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1561

object_path,

1562

connection)

1563

try:

1564

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

1565

1566

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

1567

# Fix argument name for the GetManagedObjects method

1568

if (if_tag.getAttribute("name")

1569

== dbus.OBJECT_MANAGER_IFACE):

1570

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

1571

if (cn.getAttribute("name")

1572

== "GetManagedObjects"):

1573

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

1574

if (arg.getAttribute("direction")

1575

== "out"):

1576

arg.setAttribute(

1577

"name",

1578

"objpath_interfaces"

1579

"_and_properties")

1580

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

1581

document.unlink()

1582

except (AttributeError, xml.dom.DOMException,

1583

xml.parsers.expat.ExpatError) as error:

1584

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

1585

exc_info=error)

1586

return xmlstring

1587

1588

1589

1048

def datetime_to_dbus(dt, variant_level=0):

1590

1049

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

1591

1050

if dt is None:

1592

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

1593

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

1051

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

1052

return dbus.String(dt.isoformat(),

1053

variant_level=variant_level)

1594

1054

1595

1055

1596

1056

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1598

1058

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

1599

1059

interface names according to the "alt_interface_names" mapping.

1600

1060

Usage:

1601

1061

1602

1062

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

1603

1063

"net.example.AlternateInterface"})

1604

1064

class SampleDBusObject(dbus.service.Object):

1605

1065

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

1606

1066

def SampleDBusMethod():

1607

1067

pass

1608

1068

1609

1069

The above "SampleDBusMethod" on "SampleDBusObject" will be

1610

1070

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

1611

1071

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

1612

1072

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

1613

1073

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

1614

1074

1615

1075

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

1616

1076

(from DBusObjectWithProperties) and interfaces (from the

1617

1077

dbus_interface_annotations decorator).

1618

1078

"""

1619

1620

1079

def wrapper(cls):

1621

1080

for orig_interface_name, alt_interface_name in (

1622

alt_interface_names.items()):

1081

alt_interface_names.iteritems()):

1623

1082

attr = {}

1624

1083

interface_names = set()

1625

1084

# Go though all attributes of the class

1627

1086

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

1628

1087

# with the wrong interface name

1629

1088

if (not hasattr(attribute, "_dbus_interface")

1630

or not attribute._dbus_interface.startswith(

1631

orig_interface_name)):

1089

or not attribute._dbus_interface

1090

.startswith(orig_interface_name)):

1632

1091

continue

1633

1092

# Create an alternate D-Bus interface name based on

1634

1093

# the current name

1635

alt_interface = attribute._dbus_interface.replace(

1636

orig_interface_name, alt_interface_name)

1094

alt_interface = (attribute._dbus_interface

1095

.replace(orig_interface_name,

1096

alt_interface_name))

1637

1097

interface_names.add(alt_interface)

1638

1098

# Is this a D-Bus signal?

1639

1099

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

1640

1100

# Extract the original non-method undecorated

1641

1101

# function by black magic

1642

if sys.version_info.major == 2:

1643

nonmethod_func = (dict(

1102

nonmethod_func = (dict(

1644

1103

zip(attribute.func_code.co_freevars,

1645

attribute.__closure__))

1646

["func"].cell_contents)

1647

else:

1648

nonmethod_func = (dict(

1649

zip(attribute.__code__.co_freevars,

1650

attribute.__closure__))

1651

["func"].cell_contents)

1104

attribute.__closure__))["func"]

1105

.cell_contents)

1652

1106

# Create a new, but exactly alike, function

1653

1107

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

1654

1108

# with the alternate D-Bus interface name

1655

new_function = copy_function(nonmethod_func)

1656

new_function = (dbus.service.signal(

1657

alt_interface,

1658

attribute._dbus_signature)(new_function))

1109

new_function = (dbus.service.signal

1110

(alt_interface,

1111

attribute._dbus_signature)

1112

(types.FunctionType(

1113

nonmethod_func.func_code,

1114

nonmethod_func.func_globals,

1115

nonmethod_func.func_name,

1116

nonmethod_func.func_defaults,

1117

nonmethod_func.func_closure)))

1659

1118

# Copy annotations, if any

1660

1119

try:

1661

new_function._dbus_annotations = dict(

1662

attribute._dbus_annotations)

1120

new_function._dbus_annotations = (

1121

dict(attribute._dbus_annotations))

1663

1122

except AttributeError:

1664

1123

pass

1665

1666

1124

# Define a creator of a function to call both the

1667

1125

# original and alternate functions, so both the

1668

1126

# original and alternate signals gets sent when

1671

1129

"""This function is a scope container to pass

1672

1130

func1 and func2 to the "call_both" function

1673

1131

outside of its arguments"""

1674

1675

@functools.wraps(func2)

1676

1132

def call_both(*args, **kwargs):

1677

1133

"""This function will emit two D-Bus

1678

1134

signals by calling func1 and func2"""

1679

1135

func1(*args, **kwargs)

1680

1136

func2(*args, **kwargs)

1681

# Make wrapper function look like a D-Bus

1682

# signal

1683

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

1684

if name.startswith("_dbus_"):

1685

setattr(call_both, name, attr)

1686

1687

1137

return call_both

1688

1138

# Create the "call_both" function and add it to

1689

1139

# the class

1694

1144

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

1695

1145

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

1696

1146

# to the class.

1697

attr[attrname] = (

1698

dbus.service.method(

1699

alt_interface,

1700

attribute._dbus_in_signature,

1701

attribute._dbus_out_signature)

1702

(copy_function(attribute)))

1147

attr[attrname] = (dbus.service.method

1148

(alt_interface,

1149

attribute._dbus_in_signature,

1150

attribute._dbus_out_signature)

1151

(types.FunctionType

1152

(attribute.func_code,

1153

attribute.func_globals,

1154

attribute.func_name,

1155

attribute.func_defaults,

1156

attribute.func_closure)))

1703

1157

# Copy annotations, if any

1704

1158

try:

1705

attr[attrname]._dbus_annotations = dict(

1706

attribute._dbus_annotations)

1159

attr[attrname]._dbus_annotations = (

1160

dict(attribute._dbus_annotations))

1707

1161

except AttributeError:

1708

1162

pass

1709

1163

# Is this a D-Bus property?

1712

1166

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

1713

1167

# property with the alternate D-Bus interface

1714

1168

# name. Add it to the class.

1715

attr[attrname] = (dbus_service_property(

1716

alt_interface, attribute._dbus_signature,

1717

attribute._dbus_access,

1718

attribute._dbus_get_args_options

1719

["byte_arrays"])

1720

(copy_function(attribute)))

1169

attr[attrname] = (dbus_service_property

1170

(alt_interface,

1171

attribute._dbus_signature,

1172

attribute._dbus_access,

1173

attribute

1174

._dbus_get_args_options

1175

["byte_arrays"])

1176

(types.FunctionType

1177

(attribute.func_code,

1178

attribute.func_globals,

1179

attribute.func_name,

1180

attribute.func_defaults,

1181

attribute.func_closure)))

1721

1182

# Copy annotations, if any

1722

1183

try:

1723

attr[attrname]._dbus_annotations = dict(

1724

attribute._dbus_annotations)

1184

attr[attrname]._dbus_annotations = (

1185

dict(attribute._dbus_annotations))

1725

1186

except AttributeError:

1726

1187

pass

1727

1188

# Is this a D-Bus interface?

1730

1191

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

1731

1192

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

1732

1193

# to the class.

1733

attr[attrname] = (

1734

dbus_interface_annotations(alt_interface)

1735

(copy_function(attribute)))

1194

attr[attrname] = (dbus_interface_annotations

1195

(alt_interface)

1196

(types.FunctionType

1197

(attribute.func_code,

1198

attribute.func_globals,

1199

attribute.func_name,

1200

attribute.func_defaults,

1201

attribute.func_closure)))

1736

1202

if deprecate:

1737

1203

# Deprecate all alternate interfaces

1738

iname = "_AlternateDBusNames_interface_annotation{}"

1204

iname="_AlternateDBusNames_interface_annotation{0}"

1739

1205

for interface_name in interface_names:

1740

1741

1206

@dbus_interface_annotations(interface_name)

1742

1207

def func(self):

1743

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

1744

"true"}

1208

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

1209

"true" }

1745

1210

# Find an unused name

1746

1211

for aname in (iname.format(i)

1747

1212

for i in itertools.count()):

1751

1216

if interface_names:

1752

1217

# Replace the class with a new subclass of it with

1753

1218

# methods, signals, etc. as created above.

1754

if sys.version_info.major == 2:

1755

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

1756

(cls, ), attr)

1757

else:

1758

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

1759

(cls, ), attr)

1219

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

1220

(cls,), attr)

1760

1221

return cls

1761

1762

1222

return wrapper

1763

1223

1764

1224

1765

1225

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

1766

"se.bsnet.fukt.Mandos"})

1226

"se.bsnet.fukt.Mandos"})

1767

1227

class ClientDBus(Client, DBusObjectWithProperties):

1768

1228

"""A Client class using D-Bus

1769

1229

1770

1230

Attributes:

1771

1231

dbus_object_path: dbus.ObjectPath

1772

1232

bus: dbus.SystemBus()

1773

1233

"""

1774

1234

1775

1235

runtime_expansions = (Client.runtime_expansions

1776

+ ("dbus_object_path", ))

1777

1778

_interface = "se.recompile.Mandos.Client"

1779

1236

+ ("dbus_object_path",))

1237

1780

1238

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

1781

1782

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

1239

1240

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

1783

1241

self.bus = bus

1784

1242

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

1785

1243

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

1786

1244

# the D-Bus

1787

client_object_name = str(self.name).translate(

1245

client_object_name = unicode(self.name).translate(

1788

1246

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

1789

1247

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

1790

self.dbus_object_path = dbus.ObjectPath(

1791

"/clients/" + client_object_name)

1248

self.dbus_object_path = (dbus.ObjectPath

1249

("/clients/" + client_object_name))

1792

1250

DBusObjectWithProperties.__init__(self, self.bus,

1793

1251

self.dbus_object_path)

1794

1795

def notifychangeproperty(transform_func, dbus_name,

1796

type_func=lambda x: x,

1797

variant_level=1,

1798

invalidate_only=False,

1799

_interface=_interface):

1252

1253

def notifychangeproperty(transform_func,

1254

dbus_name, type_func=lambda x: x,

1255

variant_level=1):

1800

1256

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

1801

1257

its changes to DBus.

1802

1258

1803

1259

transform_fun: Function that takes a value and a variant_level

1804

1260

and transforms it to a D-Bus type.

1805

1261

dbus_name: D-Bus name of the variable

1807

1263

to the D-Bus. Default: no transform

1808

1264

variant_level: D-Bus variant level. Default: 1

1809

1265

"""

1810

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

1811

1266

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

1812

1267

def setter(self, value):

1813

1268

if hasattr(self, "dbus_object_path"):

1814

1269

if (not hasattr(self, attrname) or

1815

1270

type_func(getattr(self, attrname, None))

1816

1271

!= type_func(value)):

1817

if invalidate_only:

1818

self.PropertiesChanged(

1819

_interface, dbus.Dictionary(),

1820

dbus.Array((dbus_name, )))

1821

else:

1822

dbus_value = transform_func(

1823

type_func(value),

1824

variant_level=variant_level)

1825

self.PropertyChanged(dbus.String(dbus_name),

1826

dbus_value)

1827

self.PropertiesChanged(

1828

_interface,

1829

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

1830

dbus_value}),

1831

dbus.Array())

1272

dbus_value = transform_func(type_func(value),

1273

variant_level

1274

=variant_level)

1275

self.PropertyChanged(dbus.String(dbus_name),

1276

dbus_value)

1832

1277

setattr(self, attrname, value)

1833

1278

1834

1279

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

1835

1280

1836

1281

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1837

1282

approvals_pending = notifychangeproperty(dbus.Boolean,

1838

1283

"ApprovalPending",

1839

type_func=bool)

1284

type_func = bool)

1840

1285

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

1841

1286

last_enabled = notifychangeproperty(datetime_to_dbus,

1842

1287

"LastEnabled")

1843

checker = notifychangeproperty(

1844

dbus.Boolean, "CheckerRunning",

1845

type_func=lambda checker: checker is not None)

1288

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

1289

type_func = lambda checker:

1290

checker is not None)

1846

1291

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1847

1292

"LastCheckedOK")

1848

1293

last_checker_status = notifychangeproperty(dbus.Int16,

1851

1296

datetime_to_dbus, "LastApprovalRequest")

1852

1297

approved_by_default = notifychangeproperty(dbus.Boolean,

1853

1298

"ApprovedByDefault")

1854

approval_delay = notifychangeproperty(

1855

dbus.UInt64, "ApprovalDelay",

1856

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

1299

approval_delay = notifychangeproperty(dbus.UInt64,

1300

"ApprovalDelay",

1301

type_func =

1302

timedelta_to_milliseconds)

1857

1303

approval_duration = notifychangeproperty(

1858

1304

dbus.UInt64, "ApprovalDuration",

1859

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

1305

type_func = timedelta_to_milliseconds)

1860

1306

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

1861

timeout = notifychangeproperty(

1862

dbus.UInt64, "Timeout",

1863

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

1307

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

1308

type_func =

1309

timedelta_to_milliseconds)

1864

1310

extended_timeout = notifychangeproperty(

1865

1311

dbus.UInt64, "ExtendedTimeout",

1866

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

1867

interval = notifychangeproperty(

1868

dbus.UInt64, "Interval",

1869

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

1312

type_func = timedelta_to_milliseconds)

1313

interval = notifychangeproperty(dbus.UInt64,

1314

"Interval",

1315

type_func =

1316

timedelta_to_milliseconds)

1870

1317

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

1871

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

1872

invalidate_only=True)

1873

1318

1874

1319

del notifychangeproperty

1875

1320

1876

1321

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

1877

1322

try:

1878

1323

self.remove_from_connection()

1881

1326

if hasattr(DBusObjectWithProperties, "__del__"):

1882

1327

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

1883

1328

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

1884

1885

def checker_callback(self, source, condition,

1886

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

1887

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

1888

connection, command, *args,

1889

**kwargs)

1890

exitstatus = self.last_checker_status

1891

if exitstatus >= 0:

1329

1330

def checker_callback(self, pid, condition, command,

1331

*args, **kwargs):

1332

self.checker_callback_tag = None

1333

self.checker = None

1334

if os.WIFEXITED(condition):

1335

exitstatus = os.WEXITSTATUS(condition)

1892

1336

# Emit D-Bus signal

1893

1337

self.CheckerCompleted(dbus.Int16(exitstatus),

1894

# This is specific to GNU libC

1895

dbus.Int64(exitstatus << 8),

1338

dbus.Int64(condition),

1896

1339

dbus.String(command))

1897

1340

else:

1898

1341

# Emit D-Bus signal

1899

1342

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

1900

dbus.Int64(

1901

# This is specific to GNU libC

1902

(exitstatus << 8)

1903

| self.last_checker_signal),

1343

dbus.Int64(condition),

1904

1344

dbus.String(command))

1905

return ret

1906

1345

1346

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

1347

*args, **kwargs)

1348

1907

1349

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

1908

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

1350

old_checker = self.checker

1351

if self.checker is not None:

1352

old_checker_pid = self.checker.pid

1353

else:

1354

old_checker_pid = None

1909

1355

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

1910

1356

# Only if new checker process was started

1911

1357

if (self.checker is not None

1913

1359

# Emit D-Bus signal

1914

1360

self.CheckerStarted(self.current_checker_command)

1915

1361

return r

1916

1362

1917

1363

def _reset_approved(self):

1918

1364

self.approved = None

1919

1365

return False

1920

1366

1921

1367

def approve(self, value=True):

1922

1368

self.approved = value

1923

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

1924

* 1000), self._reset_approved)

1369

gobject.timeout_add(timedelta_to_milliseconds

1370

(self.approval_duration),

1371

self._reset_approved)

1925

1372

self.send_changedstate()

1926

1927

# D-Bus methods, signals & properties

1928

1929

# Interfaces

1930

1931

# Signals

1932

1373

1374

## D-Bus methods, signals & properties

1375

_interface = "se.recompile.Mandos.Client"

1376

1377

## Interfaces

1378

1379

@dbus_interface_annotations(_interface)

1380

def _foo(self):

1381

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

1382

"false"}

1383

1384

## Signals

1385

1933

1386

# CheckerCompleted - signal

1934

1387

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

1935

1388

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

1936

1389

"D-Bus signal"

1937

1390

pass

1938

1391

1939

1392

# CheckerStarted - signal

1940

1393

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

1941

1394

def CheckerStarted(self, command):

1942

1395

"D-Bus signal"

1943

1396

pass

1944

1397

1945

1398

# PropertyChanged - signal

1946

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

1947

1399

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

1948

1400

def PropertyChanged(self, property, value):

1949

1401

"D-Bus signal"

1950

1402

pass

1951

1403

1952

1404

# GotSecret - signal

1953

1405

@dbus.service.signal(_interface)

1954

1406

def GotSecret(self):

1957

1409

server to mandos-client

1958

1410

"""

1959

1411

pass

1960

1412

1961

1413

# Rejected - signal

1962

1414

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

1963

1415

def Rejected(self, reason):

1964

1416

"D-Bus signal"

1965

1417

pass

1966

1418

1967

1419

# NeedApproval - signal

1968

1420

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

1969

1421

def NeedApproval(self, timeout, default):

1970

1422

"D-Bus signal"

1971

1423

return self.need_approval()

1972

1973

# Methods

1974

1424

1425

## Methods

1426

1975

1427

# Approve - method

1976

1428

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

1977

1429

def Approve(self, value):

1978

1430

self.approve(value)

1979

1431

1980

1432

# CheckedOK - method

1981

1433

@dbus.service.method(_interface)

1982

1434

def CheckedOK(self):

1983

1435

self.checked_ok()

1984

1436

1985

1437

# Enable - method

1986

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

1987

1438

@dbus.service.method(_interface)

1988

1439

def Enable(self):

1989

1440

"D-Bus method"

1990

1441

self.enable()

1991

1442

1992

1443

# StartChecker - method

1993

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

1994

1444

@dbus.service.method(_interface)

1995

1445

def StartChecker(self):

1996

1446

"D-Bus method"

1997

1447

self.start_checker()

1998

1448

1999

1449

# Disable - method

2000

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

2001

1450

@dbus.service.method(_interface)

2002

1451

def Disable(self):

2003

1452

"D-Bus method"

2004

1453

self.disable()

2005

1454

2006

1455

# StopChecker - method

2007

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

2008

1456

@dbus.service.method(_interface)

2009

1457

def StopChecker(self):

2010

1458

self.stop_checker()

2011

2012

# Properties

2013

1459

1460

## Properties

1461

2014

1462

# ApprovalPending - property

2015

1463

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

2016

1464

def ApprovalPending_dbus_property(self):

2017

1465

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

2018

1466

2019

1467

# ApprovedByDefault - property

2020

@dbus_service_property(_interface,

2021

signature="b",

1468

@dbus_service_property(_interface, signature="b",

2022

1469

access="readwrite")

2023

1470

def ApprovedByDefault_dbus_property(self, value=None):

2024

1471

if value is None: # get

2025

1472

return dbus.Boolean(self.approved_by_default)

2026

1473

self.approved_by_default = bool(value)

2027

1474

2028

1475

# ApprovalDelay - property

2029

@dbus_service_property(_interface,

2030

signature="t",

1476

@dbus_service_property(_interface, signature="t",

2031

1477

access="readwrite")

2032

1478

def ApprovalDelay_dbus_property(self, value=None):

2033

1479

if value is None: # get

2034

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

2035

* 1000)

1480

return dbus.UInt64(self.approval_delay_milliseconds())

2036

1481

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

2037

1482

2038

1483

# ApprovalDuration - property

2039

@dbus_service_property(_interface,

2040

signature="t",

1484

@dbus_service_property(_interface, signature="t",

2041

1485

access="readwrite")

2042

1486

def ApprovalDuration_dbus_property(self, value=None):

2043

1487

if value is None: # get

2044

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

2045

* 1000)

1488

return dbus.UInt64(timedelta_to_milliseconds(

1489

self.approval_duration))

2046

1490

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

2047

1491

2048

1492

# Name - property

2049

@dbus_annotations(

2050

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

2051

1493

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

2052

1494

def Name_dbus_property(self):

2053

1495

return dbus.String(self.name)

2054

2055

# KeyID - property

2056

@dbus_annotations(

2057

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

2058

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

2059

def KeyID_dbus_property(self):

2060

return dbus.String(self.key_id)

2061

1496

2062

1497

# Fingerprint - property

2063

@dbus_annotations(

2064

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

2065

1498

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

2066

1499

def Fingerprint_dbus_property(self):

2067

1500

return dbus.String(self.fingerprint)

2068

1501

2069

1502

# Host - property

2070

@dbus_service_property(_interface,

2071

signature="s",

1503

@dbus_service_property(_interface, signature="s",

2072

1504

access="readwrite")

2073

1505

def Host_dbus_property(self, value=None):

2074

1506

if value is None: # get

2075

1507

return dbus.String(self.host)

2076

self.host = str(value)

2077

1508

self.host = unicode(value)

1509

2078

1510

# Created - property

2079

@dbus_annotations(

2080

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

2081

1511

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

2082

1512

def Created_dbus_property(self):

2083

1513

return datetime_to_dbus(self.created)

2084

1514

2085

1515

# LastEnabled - property

2086

1516

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

2087

1517

def LastEnabled_dbus_property(self):

2088

1518

return datetime_to_dbus(self.last_enabled)

2089

1519

2090

1520

# Enabled - property

2091

@dbus_service_property(_interface,

2092

signature="b",

1521

@dbus_service_property(_interface, signature="b",

2093

1522

access="readwrite")

2094

1523

def Enabled_dbus_property(self, value=None):

2095

1524

if value is None: # get

2098

1527

self.enable()

2099

1528

else:

2100

1529

self.disable()

2101

1530

2102

1531

# LastCheckedOK - property

2103

@dbus_service_property(_interface,

2104

signature="s",

1532

@dbus_service_property(_interface, signature="s",

2105

1533

access="readwrite")

2106

1534

def LastCheckedOK_dbus_property(self, value=None):

2107

1535

if value is not None:

2108

1536

self.checked_ok()

2109

1537

return

2110

1538

return datetime_to_dbus(self.last_checked_ok)

2111

1539

2112

1540

# LastCheckerStatus - property

2113

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

1541

@dbus_service_property(_interface, signature="n",

1542

access="read")

2114

1543

def LastCheckerStatus_dbus_property(self):

2115

1544

return dbus.Int16(self.last_checker_status)

2116

1545

2117

1546

# Expires - property

2118

1547

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

2119

1548

def Expires_dbus_property(self):

2120

1549

return datetime_to_dbus(self.expires)

2121

1550

2122

1551

# LastApprovalRequest - property

2123

1552

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

2124

1553

def LastApprovalRequest_dbus_property(self):

2125

1554

return datetime_to_dbus(self.last_approval_request)

2126

1555

2127

1556

# Timeout - property

2128

@dbus_service_property(_interface,

2129

signature="t",

1557

@dbus_service_property(_interface, signature="t",

2130

1558

access="readwrite")

2131

1559

def Timeout_dbus_property(self, value=None):

2132

1560

if value is None: # get

2133

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

1561

return dbus.UInt64(self.timeout_milliseconds())

2134

1562

old_timeout = self.timeout

2135

1563

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

2136

1564

# Reschedule disabling

2144

1572

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

2145

1573

is None):

2146

1574

return

2147

GLib.source_remove(self.disable_initiator_tag)

2148

self.disable_initiator_tag = GLib.timeout_add(

2149

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

2150

self.disable)

2151

1575

gobject.source_remove(self.disable_initiator_tag)

1576

self.disable_initiator_tag = (

1577

gobject.timeout_add(

1578

timedelta_to_milliseconds(self.expires - now),

1579

self.disable))

1580

2152

1581

# ExtendedTimeout - property

2153

@dbus_service_property(_interface,

2154

signature="t",

1582

@dbus_service_property(_interface, signature="t",

2155

1583

access="readwrite")

2156

1584

def ExtendedTimeout_dbus_property(self, value=None):

2157

1585

if value is None: # get

2158

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

2159

* 1000)

1586

return dbus.UInt64(self.extended_timeout_milliseconds())

2160

1587

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

2161

1588

2162

1589

# Interval - property

2163

@dbus_service_property(_interface,

2164

signature="t",

1590

@dbus_service_property(_interface, signature="t",

2165

1591

access="readwrite")

2166

1592

def Interval_dbus_property(self, value=None):

2167

1593

if value is None: # get

2168

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

1594

return dbus.UInt64(self.interval_milliseconds())

2169

1595

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

2170

1596

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

2171

1597

return

2172

1598

if self.enabled:

2173

1599

# Reschedule checker run

2174

GLib.source_remove(self.checker_initiator_tag)

2175

self.checker_initiator_tag = GLib.timeout_add(

2176

value, self.start_checker)

2177

self.start_checker() # Start one now, too

2178

1600

gobject.source_remove(self.checker_initiator_tag)

1601

self.checker_initiator_tag = (gobject.timeout_add

1602

(value, self.start_checker))

1603

self.start_checker() # Start one now, too

1604

2179

1605

# Checker - property

2180

@dbus_service_property(_interface,

2181

signature="s",

1606

@dbus_service_property(_interface, signature="s",

2182

1607

access="readwrite")

2183

1608

def Checker_dbus_property(self, value=None):

2184

1609

if value is None: # get

2185

1610

return dbus.String(self.checker_command)

2186

self.checker_command = str(value)

2187

1611

self.checker_command = unicode(value)

1612

2188

1613

# CheckerRunning - property

2189

@dbus_service_property(_interface,

2190

signature="b",

1614

@dbus_service_property(_interface, signature="b",

2191

1615

access="readwrite")

2192

1616

def CheckerRunning_dbus_property(self, value=None):

2193

1617

if value is None: # get

2196

1620

self.start_checker()

2197

1621

else:

2198

1622

self.stop_checker()

2199

1623

2200

1624

# ObjectPath - property

2201

@dbus_annotations(

2202

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

2203

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

2204

1625

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

2205

1626

def ObjectPath_dbus_property(self):

2206

return self.dbus_object_path # is already a dbus.ObjectPath

2207

1627

return self.dbus_object_path # is already a dbus.ObjectPath

1628

2208

1629

# Secret = property

2209

@dbus_annotations(

2210

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

2211

"invalidates"})

2212

@dbus_service_property(_interface,

2213

signature="ay",

2214

access="write",

2215

byte_arrays=True)

1630

@dbus_service_property(_interface, signature="ay",

1631

access="write", byte_arrays=True)

2216

1632

def Secret_dbus_property(self, value):

2217

self.secret = bytes(value)

2218

1633

self.secret = str(value)

1634

2219

1635

del _interface

2220

1636

2221

1637

2222

1638

class ProxyClient(object):

2223

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

1639

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

2224

1640

self._pipe = child_pipe

2225

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

1641

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

2226

1642

if not self._pipe.recv():

2227

raise KeyError(key_id or fpr)

2228

1643

raise KeyError()

1644

2229

1645

def __getattribute__(self, name):

2230

1646

if name == '_pipe':

2231

1647

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

2234

1650

if data[0] == 'data':

2235

1651

return data[1]

2236

1652

if data[0] == 'function':

2237

2238

1653

def func(*args, **kwargs):

2239

1654

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

2240

1655

return self._pipe.recv()[1]

2241

2242

1656

return func

2243

1657

2244

1658

def __setattr__(self, name, value):

2245

1659

if name == '_pipe':

2246

1660

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

2249

1663

2250

1664

class ClientHandler(socketserver.BaseRequestHandler, object):

2251

1665

"""A class to handle client connections.

2252

1666

2253

1667

Instantiated once for each connection to handle it.

2254

1668

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

2255

1669

2256

1670

def handle(self):

2257

1671

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

2258

1672

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

2259

str(self.client_address))

1673

unicode(self.client_address))

2260

1674

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

2261

1675

self.server.child_pipe.fileno())

2262

2263

session = gnutls.ClientSession(self.request)

2264

2265

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

2266

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

2267

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

2268

# "+DHE-DSS"))

1676

1677

session = (gnutls.connection

1678

.ClientSession(self.request,

1679

gnutls.connection

1680

.X509Credentials()))

1681

1682

# Note: gnutls.connection.X509Credentials is really a

1683

# generic GnuTLS certificate credentials object so long as

1684

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

1685

# here despite using OpenPGP certificates.

1686

1687

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

1688

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

1689

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

1690

# "+DHE-DSS"))

2269

1691

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

2270

1692

priority = self.server.gnutls_priority

2271

1693

if priority is None:

2272

1694

priority = "NORMAL"

2273

gnutls.priority_set_direct(session._c_object,

2274

priority.encode("utf-8"),

2275

None)

2276

1695

(gnutls.library.functions

1696

.gnutls_priority_set_direct(session._c_object,

1697

priority, None))

1698

2277

1699

# Start communication using the Mandos protocol

2278

1700

# Get protocol number

2279

1701

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

2280

1702

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

2281

1703

try:

2282

1704

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

2283

raise RuntimeError(line)

1705

raise RuntimeError

2284

1706

except (ValueError, IndexError, RuntimeError) as error:

2285

1707

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

2286

1708

return

2287

1709

2288

1710

# Start GnuTLS connection

2289

1711

try:

2290

1712

session.handshake()

2291

except gnutls.Error as error:

1713

except gnutls.errors.GNUTLSError as error:

2292

1714

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

2293

1715

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

2294

1716

# established. Just abandon the request.

2295

1717

return

2296

1718

logger.debug("Handshake succeeded")

2297

1719

2298

1720

approval_required = False

2299

1721

try:

2300

if gnutls.has_rawpk:

2301

fpr = ""

2302

try:

2303

key_id = self.key_id(

2304

self.peer_certificate(session))

2305

except (TypeError, gnutls.Error) as error:

2306

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

2307

return

2308

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

2309

2310

else:

2311

key_id = ""

2312

try:

2313

fpr = self.fingerprint(

2314

self.peer_certificate(session))

2315

except (TypeError, gnutls.Error) as error:

2316

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

2317

return

2318

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

2319

2320

try:

2321

client = ProxyClient(child_pipe, key_id, fpr,

1722

try:

1723

fpr = self.fingerprint(self.peer_certificate

1724

(session))

1725

except (TypeError,

1726

gnutls.errors.GNUTLSError) as error:

1727

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

1728

return

1729

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

1730

1731

try:

1732

client = ProxyClient(child_pipe, fpr,

2322

1733

self.client_address)

2323

1734

except KeyError:

2324

1735

return

2325

1736

2326

1737

if client.approval_delay:

2327

1738

delay = client.approval_delay

2328

1739

client.approvals_pending += 1

2329

1740

approval_required = True

2330

1741

2331

1742

while True:

2332

1743

if not client.enabled:

2333

1744

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

2334

client.name)

1745

client.name)

2335

1746

if self.server.use_dbus:

2336

1747

# Emit D-Bus signal

2337

1748

client.Rejected("Disabled")

2338

1749

return

2339

1750

2340

1751

if client.approved or not client.approval_delay:

2341

# We are approved or approval is disabled

1752

#We are approved or approval is disabled

2342

1753

break

2343

1754

elif client.approved is None:

2344

1755

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

2346

1757

if self.server.use_dbus:

2347

1758

# Emit D-Bus signal

2348

1759

client.NeedApproval(

2349

client.approval_delay.total_seconds()

2350

* 1000, client.approved_by_default)

1760

client.approval_delay_milliseconds(),

1761

client.approved_by_default)

2351

1762

else:

2352

1763

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

2353

1764

client.name)

2355

1766

# Emit D-Bus signal

2356

1767

client.Rejected("Denied")

2357

1768

return

2358

2359

# wait until timeout or approved

1769

1770

#wait until timeout or approved

2360

1771

time = datetime.datetime.now()

2361

1772

client.changedstate.acquire()

2362

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

1773

client.changedstate.wait(

1774

float(timedelta_to_milliseconds(delay)

1775

/ 1000))

2363

1776

client.changedstate.release()

2364

1777

time2 = datetime.datetime.now()

2365

1778

if (time2 - time) >= delay:

2375

1788

break

2376

1789

else:

2377

1790

delay -= time2 - time

2378

2379

try:

2380

session.send(client.secret)

2381

except gnutls.Error as error:

2382

logger.warning("gnutls send failed",

2383

exc_info=error)

2384

return

2385

1791

1792

sent_size = 0

1793

while sent_size < len(client.secret):

1794

try:

1795

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

1796

except gnutls.errors.GNUTLSError as error:

1797

logger.warning("gnutls send failed",

1798

exc_info=error)

1799

return

1800

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

1801

sent, len(client.secret)

1802

- (sent_size + sent))

1803

sent_size += sent

1804

2386

1805

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

2387

1806

# bump the timeout using extended_timeout

2388

1807

client.bump_timeout(client.extended_timeout)

2389

1808

if self.server.use_dbus:

2390

1809

# Emit D-Bus signal

2391

1810

client.GotSecret()

2392

1811

2393

1812

finally:

2394

1813

if approval_required:

2395

1814

client.approvals_pending -= 1

2396

1815

try:

2397

1816

session.bye()

2398

except gnutls.Error as error:

1817

except gnutls.errors.GNUTLSError as error:

2399

1818

logger.warning("GnuTLS bye failed",

2400

1819

exc_info=error)

2401

1820

2402

1821

@staticmethod

2403

1822

def peer_certificate(session):

2404

"Return the peer's certificate as a bytestring"

2405

try:

2406

cert_type = gnutls.certificate_type_get2(session._c_object,

2407

gnutls.CTYPE_PEERS)

2408

except AttributeError:

2409

cert_type = gnutls.certificate_type_get(session._c_object)

2410

if gnutls.has_rawpk:

2411

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2412

else:

2413

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2414

# If not a valid certificate type...

2415

if cert_type not in valid_cert_types:

2416

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

2417

valid_cert_types)

2418

# ...return invalid data

2419

return b""

1823

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

1824

# If not an OpenPGP certificate...

1825

if (gnutls.library.functions

1826

.gnutls_certificate_type_get(session._c_object)

1827

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1828

# ...do the normal thing

1829

return session.peer_certificate

2420

1830

list_size = ctypes.c_uint(1)

2421

cert_list = (gnutls.certificate_get_peers

1831

cert_list = (gnutls.library.functions

1832

.gnutls_certificate_get_peers

2422

1833

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

2423

1834

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

2424

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

1835

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

1836

" certificate")

2425

1837

if list_size.value == 0:

2426

1838

return None

2427

1839

cert = cert_list[0]

2428

1840

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

2429

2430

@staticmethod

2431

def key_id(certificate):

2432

"Convert a certificate bytestring to a hexdigit key ID"

2433

# New GnuTLS "datum" with the public key

2434

datum = gnutls.datum_t(

2435

ctypes.cast(ctypes.c_char_p(certificate),

2436

ctypes.POINTER(ctypes.c_ubyte)),

2437

ctypes.c_uint(len(certificate)))

2438

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

2439

# New empty GnuTLS certificate

2440

pubkey = gnutls.pubkey_t()

2441

gnutls.pubkey_init(ctypes.byref(pubkey))

2442

# Import the raw public key into the certificate

2443

gnutls.pubkey_import(pubkey,

2444

ctypes.byref(datum),

2445

gnutls.X509_FMT_DER)

2446

# New buffer for the key ID

2447

buf = ctypes.create_string_buffer(32)

2448

buf_len = ctypes.c_size_t(len(buf))

2449

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

2450

gnutls.pubkey_get_key_id(pubkey,

2451

gnutls.KEYID_USE_SHA256,

2452

ctypes.cast(ctypes.byref(buf),

2453

ctypes.POINTER(ctypes.c_ubyte)),

2454

ctypes.byref(buf_len))

2455

# Deinit the certificate

2456

gnutls.pubkey_deinit(pubkey)

2457

2458

# Convert the buffer to a Python bytestring

2459

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

2460

# Convert the bytestring to hexadecimal notation

2461

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

2462

return hex_key_id

2463

1841

2464

1842

@staticmethod

2465

1843

def fingerprint(openpgp):

2466

1844

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2467

1845

# New GnuTLS "datum" with the OpenPGP public key

2468

datum = gnutls.datum_t(

2469

ctypes.cast(ctypes.c_char_p(openpgp),

2470

ctypes.POINTER(ctypes.c_ubyte)),

2471

ctypes.c_uint(len(openpgp)))

1846

datum = (gnutls.library.types

1847

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

1848

ctypes.POINTER

1849

(ctypes.c_ubyte)),

1850

ctypes.c_uint(len(openpgp))))

2472

1851

# New empty GnuTLS certificate

2473

crt = gnutls.openpgp_crt_t()

2474

gnutls.openpgp_crt_init(ctypes.byref(crt))

1852

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1853

(gnutls.library.functions

1854

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2475

1855

# Import the OpenPGP public key into the certificate

2476

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

2477

gnutls.OPENPGP_FMT_RAW)

1856

(gnutls.library.functions

1857

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

1858

gnutls.library.constants

1859

.GNUTLS_OPENPGP_FMT_RAW))

2478

1860

# Verify the self signature in the key

2479

1861

crtverify = ctypes.c_uint()

2480

gnutls.openpgp_crt_verify_self(crt, 0,

2481

ctypes.byref(crtverify))

1862

(gnutls.library.functions

1863

.gnutls_openpgp_crt_verify_self(crt, 0,

1864

ctypes.byref(crtverify)))

2482

1865

if crtverify.value != 0:

2483

gnutls.openpgp_crt_deinit(crt)

2484

raise gnutls.CertificateSecurityError(code

2485

=crtverify.value)

1866

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1867

raise (gnutls.errors.CertificateSecurityError

1868

("Verify failed"))

2486

1869

# New buffer for the fingerprint

2487

1870

buf = ctypes.create_string_buffer(20)

2488

1871

buf_len = ctypes.c_size_t()

2489

1872

# Get the fingerprint from the certificate into the buffer

2490

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

2491

ctypes.byref(buf_len))

1873

(gnutls.library.functions

1874

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

1875

ctypes.byref(buf_len)))

2492

1876

# Deinit the certificate

2493

gnutls.openpgp_crt_deinit(crt)

1877

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2494

1878

# Convert the buffer to a Python bytestring

2495

1879

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

2496

1880

# Convert the bytestring to hexadecimal notation

2500

1884

2501

1885

class MultiprocessingMixIn(object):

2502

1886

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

2503

2504

1887

def sub_process_main(self, request, address):

2505

1888

try:

2506

1889

self.finish_request(request, address)

2507

1890

except Exception:

2508

1891

self.handle_error(request, address)

2509

1892

self.close_request(request)

2510

1893

2511

1894

def process_request(self, request, address):

2512

1895

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

2513

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

2514

args=(request, address))

1896

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

1897

args = (request, address))

2515

1898

proc.start()

2516

1899

return proc

2517

1900

2518

1901

2519

1902

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2520

1903

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

2521

2522

1904

def process_request(self, request, client_address):

2523

1905

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

2524

1906

2525

1907

This function creates a new pipe in self.pipe

2526

1908

"""

2527

1909

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2528

1910

2529

1911

proc = MultiprocessingMixIn.process_request(self, request,

2530

1912

client_address)

2531

1913

self.child_pipe.close()

2532

1914

self.add_pipe(parent_pipe, proc)

2533

1915

2534

1916

def add_pipe(self, parent_pipe, proc):

2535

1917

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

2536

raise NotImplementedError()

1918

raise NotImplementedError

2537

1919

2538

1920

2539

1921

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2540

1922

socketserver.TCPServer, object):

2541

1923

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

2542

1924

2543

1925

Attributes:

2544

1926

enabled: Boolean; whether this server is activated yet

2545

1927

interface: None or a network interface name (string)

2546

1928

use_ipv6: Boolean; to use IPv6 or not

2547

1929

"""

2548

2549

1930

def __init__(self, server_address, RequestHandlerClass,

2550

interface=None,

2551

use_ipv6=True,

2552

socketfd=None):

1931

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

2553

1932

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

2554

1933

creating a new one with socket.socket().

2555

1934

"""

2561

1940

self.socketfd = socketfd

2562

1941

# Save the original socket.socket() function

2563

1942

self.socket_socket = socket.socket

2564

2565

1943

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

2566

#

1944

#

2567

1945

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

2568

1946

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

2569

1947

# patching socket.socket.)

2570

#

1948

#

2571

1949

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

2572

1950

@functools.wraps(socket.socket)

2573

1951

def socket_wrapper(*args, **kwargs):

2585

1963

# socket_wrapper(), if socketfd was set.

2586

1964

socketserver.TCPServer.__init__(self, server_address,

2587

1965

RequestHandlerClass)

2588

1966

2589

1967

def server_bind(self):

2590

1968

"""This overrides the normal server_bind() function

2591

1969

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

2592

1970

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

2593

global SO_BINDTODEVICE

2594

1971

if self.interface is not None:

2595

1972

if SO_BINDTODEVICE is None:

2596

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

2597

# common enough.

2598

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

2599

SO_BINDTODEVICE = 25

2600

try:

2601

self.socket.setsockopt(

2602

socket.SOL_SOCKET, SO_BINDTODEVICE,

2603

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

2604

except socket.error as error:

2605

if error.errno == errno.EPERM:

2606

logger.error("No permission to bind to"

2607

" interface %s", self.interface)

2608

elif error.errno == errno.ENOPROTOOPT:

2609

logger.error("SO_BINDTODEVICE not available;"

2610

" cannot bind to interface %s",

2611

self.interface)

2612

elif error.errno == errno.ENODEV:

2613

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

2614

" cannot bind", self.interface)

2615

else:

2616

raise

1973

logger.error("SO_BINDTODEVICE does not exist;"

1974

" cannot bind to interface %s",

1975

self.interface)

1976

else:

1977

try:

1978

self.socket.setsockopt(socket.SOL_SOCKET,

1979

SO_BINDTODEVICE,

1980

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

1981

except socket.error as error:

1982

if error.errno == errno.EPERM:

1983

logger.error("No permission to bind to"

1984

" interface %s", self.interface)

1985

elif error.errno == errno.ENOPROTOOPT:

1986

logger.error("SO_BINDTODEVICE not available;"

1987

" cannot bind to interface %s",

1988

self.interface)

1989

elif error.errno == errno.ENODEV:

1990

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

1991

" cannot bind", self.interface)

1992

else:

1993

raise

2617

1994

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

2618

1995

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

2619

1996

if not self.server_address[0]:

2620

1997

if self.address_family == socket.AF_INET6:

2621

any_address = "::" # in6addr_any

1998

any_address = "::" # in6addr_any

2622

1999

else:

2623

any_address = "0.0.0.0" # INADDR_ANY

2000

any_address = "0.0.0.0" # INADDR_ANY

2624

2001

self.server_address = (any_address,

2625

2002

self.server_address[1])

2626

2003

elif not self.server_address[1]:

2627

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

2004

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

2005

0)

2628

2006

# if self.interface:

2629

2007

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

2630

2008

# 0, # port

2636

2014

2637

2015

class MandosServer(IPv6_TCPServer):

2638

2016

"""Mandos server.

2639

2017

2640

2018

Attributes:

2641

2019

clients: set of Client objects

2642

2020

gnutls_priority GnuTLS priority string

2643

2021

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

2644

2645

Assumes a GLib.MainLoop event loop.

2022

2023

Assumes a gobject.MainLoop event loop.

2646

2024

"""

2647

2648

2025

def __init__(self, server_address, RequestHandlerClass,

2649

interface=None,

2650

use_ipv6=True,

2651

clients=None,

2652

gnutls_priority=None,

2653

use_dbus=True,

2654

socketfd=None):

2026

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

2027

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

2655

2028

self.enabled = False

2656

2029

self.clients = clients

2657

2030

if self.clients is None:

2660

2033

self.gnutls_priority = gnutls_priority

2661

2034

IPv6_TCPServer.__init__(self, server_address,

2662

2035

RequestHandlerClass,

2663

interface=interface,

2664

use_ipv6=use_ipv6,

2665

socketfd=socketfd)

2666

2036

interface = interface,

2037

use_ipv6 = use_ipv6,

2038

socketfd = socketfd)

2667

2039

def server_activate(self):

2668

2040

if self.enabled:

2669

2041

return socketserver.TCPServer.server_activate(self)

2670

2042

2671

2043

def enable(self):

2672

2044

self.enabled = True

2673

2045

2674

2046

def add_pipe(self, parent_pipe, proc):

2675

2047

# Call "handle_ipc" for both data and EOF events

2676

GLib.io_add_watch(

2677

parent_pipe.fileno(),

2678

GLib.IO_IN | GLib.IO_HUP,

2679

functools.partial(self.handle_ipc,

2680

parent_pipe=parent_pipe,

2681

proc=proc))

2682

2683

def handle_ipc(self, source, condition,

2684

parent_pipe=None,

2685

proc=None,

2686

client_object=None):

2048

gobject.io_add_watch(parent_pipe.fileno(),

2049

gobject.IO_IN | gobject.IO_HUP,

2050

functools.partial(self.handle_ipc,

2051

parent_pipe =

2052

parent_pipe,

2053

proc = proc))

2054

2055

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

2056

proc = None, client_object=None):

2687

2057

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

2688

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

2058

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

2689

2059

# Wait for other process to exit

2690

2060

proc.join()

2691

2061

return False

2692

2062

2693

2063

# Read a request from the child

2694

2064

request = parent_pipe.recv()

2695

2065

command = request[0]

2696

2066

2697

2067

if command == 'init':

2698

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

2699

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

2700

address = request[3]

2701

2702

for c in self.clients.values():

2703

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2704

continue

2705

if key_id and c.key_id == key_id:

2706

client = c

2707

break

2708

if fpr and c.fingerprint == fpr:

2068

fpr = request[1]

2069

address = request[2]

2070

2071

for c in self.clients.itervalues():

2072

if c.fingerprint == fpr:

2709

2073

client = c

2710

2074

break

2711

2075

else:

2712

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

2713

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

2076

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

2077

"dress: %s", fpr, address)

2714

2078

if self.use_dbus:

2715

2079

# Emit D-Bus signal

2716

mandos_dbus_service.ClientNotFound(key_id or fpr,

2080

mandos_dbus_service.ClientNotFound(fpr,

2717

2081

address[0])

2718

2082

parent_pipe.send(False)

2719

2083

return False

2720

2721

GLib.io_add_watch(

2722

parent_pipe.fileno(),

2723

GLib.IO_IN | GLib.IO_HUP,

2724

functools.partial(self.handle_ipc,

2725

parent_pipe=parent_pipe,

2726

proc=proc,

2727

client_object=client))

2084

2085

gobject.io_add_watch(parent_pipe.fileno(),

2086

gobject.IO_IN | gobject.IO_HUP,

2087

functools.partial(self.handle_ipc,

2088

parent_pipe =

2089

parent_pipe,

2090

proc = proc,

2091

client_object =

2092

client))

2728

2093

parent_pipe.send(True)

2729

2094

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

2730

2095

# same fileno

2733

2098

funcname = request[1]

2734

2099

args = request[2]

2735

2100

kwargs = request[3]

2736

2101

2737

2102

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

2738

2103

funcname)(*args,

2739

**kwargs)))

2740

2104

**kwargs)))

2105

2741

2106

if command == 'getattr':

2742

2107

attrname = request[1]

2743

if isinstance(client_object.__getattribute__(attrname),

2744

collections.Callable):

2745

parent_pipe.send(('function', ))

2108

if callable(client_object.__getattribute__(attrname)):

2109

parent_pipe.send(('function',))

2746

2110

else:

2747

parent_pipe.send((

2748

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

2749

2111

parent_pipe.send(('data', client_object

2112

.__getattribute__(attrname)))

2113

2750

2114

if command == 'setattr':

2751

2115

attrname = request[1]

2752

2116

value = request[2]

2753

2117

setattr(client_object, attrname, value)

2754

2118

2755

2119

return True

2756

2120

2757

2121

2758

2122

def rfc3339_duration_to_delta(duration):

2759

2123

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

2760

2124

2761

2125

>>> rfc3339_duration_to_delta("P7D")

2762

2126

datetime.timedelta(7)

2763

2127

>>> rfc3339_duration_to_delta("PT60S")

2773

2137

>>> rfc3339_duration_to_delta("P1DT3M20S")

2774

2138

datetime.timedelta(1, 200)

2775

2139

"""

2776

2140

2777

2141

# Parsing an RFC 3339 duration with regular expressions is not

2778

2142

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

2779

2143

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

2780

2144

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

2781

2145

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

2782

2146

# avoid excessive use of external libraries.

2783

2147

2784

2148

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

2785

Token = collections.namedtuple("Token", (

2786

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

2787

# a "group" containing digits

2788

"value", # datetime.timedelta or None

2789

"followers")) # Tokens valid after this token

2149

Token = collections.namedtuple("Token",

2150

("regexp", # To match token; if

2151

# "value" is not None,

2152

# must have a "group"

2153

# containing digits

2154

"value", # datetime.timedelta or

2155

# None

2156

"followers")) # Tokens valid after

2157

# this token

2790

2158

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

2791

2159

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

2792

2160

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

2793

2161

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

2794

2162

datetime.timedelta(seconds=1),

2795

frozenset((token_end, )))

2163

frozenset((token_end,)))

2796

2164

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

2797

2165

datetime.timedelta(minutes=1),

2798

2166

frozenset((token_second, token_end)))

2814

2182

frozenset((token_month, token_end)))

2815

2183

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

2816

2184

datetime.timedelta(weeks=1),

2817

frozenset((token_end, )))

2185

frozenset((token_end,)))

2818

2186

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

2819

2187

frozenset((token_year, token_month,

2820

2188

token_day, token_time,

2821

token_week)))

2822

# Define starting values:

2823

# Value so far

2824

value = datetime.timedelta()

2189

token_week))),

2190

# Define starting values

2191

value = datetime.timedelta() # Value so far

2825

2192

found_token = None

2826

# Following valid tokens

2827

followers = frozenset((token_duration, ))

2828

# String left to parse

2829

s = duration

2193

followers = frozenset(token_duration,) # Following valid tokens

2194

s = duration # String left to parse

2830

2195

# Loop until end token is found

2831

2196

while found_token is not token_end:

2832

2197

# Search for any currently valid tokens

2848

2213

break

2849

2214

else:

2850

2215

# No currently valid tokens were found

2851

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

2852

.format(duration))

2216

raise ValueError("Invalid RFC 3339 duration")

2853

2217

# End token found

2854

2218

return value

2855

2219

2856

2220

2857

2221

def string_to_delta(interval):

2858

2222

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

2859

2223

2860

2224

>>> string_to_delta('7d')

2861

2225

datetime.timedelta(7)

2862

2226

>>> string_to_delta('60s')

2870

2234

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

2871

2235

datetime.timedelta(0, 330)

2872

2236

"""

2873

2237

2874

2238

try:

2875

2239

return rfc3339_duration_to_delta(interval)

2876

2240

except ValueError:

2877

2241

pass

2878

2242

2879

2243

timevalue = datetime.timedelta(0)

2880

2244

for s in interval.split():

2881

2245

try:

2882

suffix = s[-1]

2246

suffix = unicode(s[-1])

2883

2247

value = int(s[:-1])

2884

2248

if suffix == "d":

2885

2249

delta = datetime.timedelta(value)

2892

2256

elif suffix == "w":

2893

2257

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

2894

2258

else:

2895

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

2896

except IndexError as e:

2259

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

2260

.format(suffix))

2261

except (ValueError, IndexError) as e:

2897

2262

raise ValueError(*(e.args))

2898

2263

timevalue += delta

2899

2264

return timevalue

2900

2265

2901

2266

2902

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

2267

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

2903

2268

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

2904

2269

2905

2270

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

2906

2271

if os.fork():

2907

2272

sys.exit()

2915

2280

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

2916

2281

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

2917

2282

raise OSError(errno.ENODEV,

2918

"{} not a character device"

2283

"{0} not a character device"

2919

2284

.format(os.devnull))

2920

2285

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

2921

2286

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

2925

2290

2926

2291

2927

2292

def main():

2928

2293

2929

2294

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

2930

2295

# Parsing of options, both command line and config file

2931

2296

2932

2297

parser = argparse.ArgumentParser()

2933

2298

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

2934

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

2299

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

2935

2300

help="show version number and exit")

2936

2301

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

2937

2302

help="Bind to interface IF")

2970

2335

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

2971

2336

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

2972

2337

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

2973

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

2974

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

2975

default=None)

2976

2338

2977

2339

options = parser.parse_args()

2978

2340

2979

2341

if options.check:

2980

2342

import doctest

2981

fail_count, test_count = doctest.testmod()

2982

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

2983

2343

doctest.testmod()

2344

sys.exit()

2345

2984

2346

# Default values for config file for server-global settings

2985

if gnutls.has_rawpk:

2986

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

2987

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

2988

else:

2989

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

2990

":+SIGN-DSA-SHA256")

2991

server_defaults = {"interface": "",

2992

"address": "",

2993

"port": "",

2994

"debug": "False",

2995

"priority": priority,

2996

"servicename": "Mandos",

2997

"use_dbus": "True",

2998

"use_ipv6": "True",

2999

"debuglevel": "",

3000

"restore": "True",

3001

"socket": "",

3002

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

3003

"foreground": "False",

3004

"zeroconf": "True",

3005

}

3006

del priority

3007

2347

server_defaults = { "interface": "",

2348

"address": "",

2349

"port": "",

2350

"debug": "False",

2351

"priority":

2352

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

2353

"servicename": "Mandos",

2354

"use_dbus": "True",

2355

"use_ipv6": "True",

2356

"debuglevel": "",

2357

"restore": "True",

2358

"socket": "",

2359

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

2360

"foreground": "False",

2361

}

2362

3008

2363

# Parse config file for server-global settings

3009

2364

server_config = configparser.SafeConfigParser(server_defaults)

3010

2365

del server_defaults

3011

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

2366

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

2367

"mandos.conf"))

3012

2368

# Convert the SafeConfigParser object to a dict

3013

2369

server_settings = server_config.defaults()

3014

2370

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

3015

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

3016

"foreground", "zeroconf"):

2371

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

3017

2372

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

3018

2373

option)

3019

2374

if server_settings["port"]:

3029

2384

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

3030

2385

["socket"])

3031

2386

del server_config

3032

2387

3033

2388

# Override the settings from the config file with command line

3034

2389

# options, if set.

3035

2390

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

3036

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

3037

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

3038

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

2391

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

2392

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

2393

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

3039

2394

value = getattr(options, option)

3040

2395

if value is not None:

3041

2396

server_settings[option] = value

3042

2397

del options

3043

2398

# Force all strings to be unicode

3044

2399

for option in server_settings.keys():

3045

if isinstance(server_settings[option], bytes):

3046

server_settings[option] = (server_settings[option]

3047

.decode("utf-8"))

2400

if type(server_settings[option]) is str:

2401

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

3048

2402

# Force all boolean options to be boolean

3049

2403

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

3050

"foreground", "zeroconf"):

2404

"foreground"):

3051

2405

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

3052

2406

# Debug implies foreground

3053

2407

if server_settings["debug"]:

3054

2408

server_settings["foreground"] = True

3055

2409

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

3056

2410

3057

2411

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

3058

3059

if (not server_settings["zeroconf"]

3060

and not (server_settings["port"]

3061

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

3062

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

3063

2412

3064

2413

# For convenience

3065

2414

debug = server_settings["debug"]

3066

2415

debuglevel = server_settings["debuglevel"]

3069

2418

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

3070

2419

stored_state_file)

3071

2420

foreground = server_settings["foreground"]

3072

zeroconf = server_settings["zeroconf"]

3073

2421

3074

2422

if debug:

3075

2423

initlogger(debug, logging.DEBUG)

3076

2424

else:

3079

2427

else:

3080

2428

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

3081

2429

initlogger(debug, level)

3082

2430

3083

2431

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

3084

syslogger.setFormatter(

3085

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

3086

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

3087

server_settings["servicename"])))

3088

2432

syslogger.setFormatter(logging.Formatter

2433

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

2434

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

2435

.format(server_settings

2436

["servicename"])))

2437

3089

2438

# Parse config file with clients

3090

2439

client_config = configparser.SafeConfigParser(Client

3091

2440

.client_defaults)

3092

2441

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

3093

2442

"clients.conf"))

3094

2443

3095

2444

global mandos_dbus_service

3096

2445

mandos_dbus_service = None

3097

3098

socketfd = None

3099

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

3100

socketfd = server_settings["socket"]

3101

tcp_server = MandosServer(

3102

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

3103

ClientHandler,

3104

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

3105

use_ipv6=use_ipv6,

3106

gnutls_priority=server_settings["priority"],

3107

use_dbus=use_dbus,

3108

socketfd=socketfd)

2446

2447

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

2448

server_settings["port"]),

2449

ClientHandler,

2450

interface=(server_settings["interface"]

2451

or None),

2452

use_ipv6=use_ipv6,

2453

gnutls_priority=

2454

server_settings["priority"],

2455

use_dbus=use_dbus,

2456

socketfd=(server_settings["socket"]

2457

or None))

3109

2458

if not foreground:

3110

2459

pidfilename = "/run/mandos.pid"

3111

2460

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

3112

2461

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

3113

2462

pidfile = None

3114

2463

try:

3115

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

2464

pidfile = open(pidfilename, "w")

3116

2465

except IOError as e:

3117

2466

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

3118

2467

exc_info=e)

3119

3120

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

3121

("mandos", "mandos"),

3122

("nobody", "nogroup")):

2468

2469

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

3123

2470

try:

3124

2471

uid = pwd.getpwnam(name).pw_uid

3125

gid = pwd.getpwnam(group).pw_gid

2472

gid = pwd.getpwnam(name).pw_gid

3126

2473

break

3127

2474

except KeyError:

3128

2475

continue

3132

2479

try:

3133

2480

os.setgid(gid)

3134

2481

os.setuid(uid)

3135

if debug:

3136

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

3137

gid))

3138

2482

except OSError as error:

3139

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

3140

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

3141

2483

if error.errno != errno.EPERM:

3142

raise

3143

2484

raise error

2485

3144

2486

if debug:

3145

2487

# Enable all possible GnuTLS debugging

3146

2488

3147

2489

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

3148

2490

# - GnuTLS manual

3149

gnutls.global_set_log_level(11)

3150

3151

@gnutls.log_func

2491

gnutls.library.functions.gnutls_global_set_log_level(11)

2492

2493

@gnutls.library.types.gnutls_log_func

3152

2494

def debug_gnutls(level, string):

3153

2495

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

3154

3155

gnutls.global_set_log_function(debug_gnutls)

3156

2496

2497

(gnutls.library.functions

2498

.gnutls_global_set_log_function(debug_gnutls))

2499

3157

2500

# Redirect stdin so all checkers get /dev/null

3158

2501

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

3159

2502

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

3160

2503

if null > 2:

3161

2504

os.close(null)

3162

2505

3163

2506

# Need to fork before connecting to D-Bus

3164

2507

if not foreground:

3165

2508

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

3166

2509

daemon()

3167

3168

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

3169

# to inform GLib that threads will be used.

3170

GLib.threads_init()

3171

2510

2511

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

2512

# need to inform gobject that threads will be used.

2513

gobject.threads_init()

2514

3172

2515

global main_loop

3173

2516

# From the Avahi example code

3174

2517

DBusGMainLoop(set_as_default=True)

3175

main_loop = GLib.MainLoop()

2518

main_loop = gobject.MainLoop()

3176

2519

bus = dbus.SystemBus()

3177

2520

# End of Avahi example code

3178

2521

if use_dbus:

3179

2522

try:

3180

2523

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

3181

bus,

3182

do_not_queue=True)

3183

old_bus_name = dbus.service.BusName(

3184

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

3185

do_not_queue=True)

3186

except dbus.exceptions.DBusException as e:

2524

bus, do_not_queue=True)

2525

old_bus_name = (dbus.service.BusName

2526

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

2527

do_not_queue=True))

2528

except dbus.exceptions.NameExistsException as e:

3187

2529

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

3188

2530

use_dbus = False

3189

2531

server_settings["use_dbus"] = False

3190

2532

tcp_server.use_dbus = False

3191

if zeroconf:

3192

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3193

service = AvahiServiceToSyslog(

3194

name=server_settings["servicename"],

3195

servicetype="_mandos._tcp",

3196

protocol=protocol,

3197

bus=bus)

3198

if server_settings["interface"]:

3199

service.interface = if_nametoindex(

3200

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

3201

2533

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2534

service = AvahiServiceToSyslog(name =

2535

server_settings["servicename"],

2536

servicetype = "_mandos._tcp",

2537

protocol = protocol, bus = bus)

2538

if server_settings["interface"]:

2539

service.interface = (if_nametoindex

2540

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

2541

3202

2542

global multiprocessing_manager

3203

2543

multiprocessing_manager = multiprocessing.Manager()

3204

2544

3205

2545

client_class = Client

3206

2546

if use_dbus:

3207

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

3208

2547

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

2548

3209

2549

client_settings = Client.config_parser(client_config)

3210

2550

old_client_settings = {}

3211

2551

clients_data = {}

3212

2552

3213

2553

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

3214

2554

global wnull

3215

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

2555

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

3216

2556

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

3217

2557

# mode

3218

2558

if debug or not foreground:

3219

2559

wnull.close()

3220

2560

3221

2561

# Get client data and settings from last running state.

3222

2562

if server_settings["restore"]:

3223

2563

try:

3224

2564

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

3225

if sys.version_info.major == 2:

3226

clients_data, old_client_settings = pickle.load(

3227

stored_state)

3228

else:

3229

bytes_clients_data, bytes_old_client_settings = (

3230

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

3231

# Fix bytes to strings

3232

# clients_data

3233

# .keys()

3234

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

3235

if isinstance(key, bytes)

3236

else key): value

3237

for key, value in

3238

bytes_clients_data.items()}

3239

del bytes_clients_data

3240

for key in clients_data:

3241

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

3242

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

3243

for k, v in

3244

clients_data[key].items()}

3245

clients_data[key] = value

3246

# .client_structure

3247

value["client_structure"] = [

3248

(s.decode("utf-8")

3249

if isinstance(s, bytes)

3250

else s) for s in

3251

value["client_structure"]]

3252

# .name & .host

3253

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

3254

if isinstance(value[k], bytes):

3255

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

3256

if not value.has_key("key_id"):

3257

value["key_id"] = ""

3258

elif not value.has_key("fingerprint"):

3259

value["fingerprint"] = ""

3260

# old_client_settings

3261

# .keys()

3262

old_client_settings = {

3263

(key.decode("utf-8")

3264

if isinstance(key, bytes)

3265

else key): value

3266

for key, value in

3267

bytes_old_client_settings.items()}

3268

del bytes_old_client_settings

3269

# .host

3270

for value in old_client_settings.values():

3271

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

3272

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

3273

.decode("utf-8"))

2565

clients_data, old_client_settings = (pickle.load

2566

(stored_state))

3274

2567

os.remove(stored_state_path)

3275

2568

except IOError as e:

3276

2569

if e.errno == errno.ENOENT:

3277

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

3278

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

2570

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

2571

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

3279

2572

else:

3280

2573

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

3281

2574

exc_info=e)

3282

2575

raise

3283

2576

except EOFError as e:

3284

2577

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

3285

"EOFError:",

3286

exc_info=e)

3287

2578

"EOFError:", exc_info=e)

2579

3288

2580

with PGPEngine() as pgp:

3289

for client_name, client in clients_data.items():

2581

for client_name, client in clients_data.iteritems():

3290

2582

# Skip removed clients

3291

2583

if client_name not in client_settings:

3292

2584

continue

3293

2585

3294

2586

# Decide which value to use after restoring saved state.

3295

2587

# We have three different values: Old config file,

3296

2588

# new config file, and saved state.

3301

2593

# For each value in new config, check if it

3302

2594

# differs from the old config value (Except for

3303

2595

# the "secret" attribute)

3304

if (name != "secret"

3305

and (value !=

3306

old_client_settings[client_name][name])):

2596

if (name != "secret" and

2597

value != old_client_settings[client_name]

2598

[name]):

3307

2599

client[name] = value

3308

2600

except KeyError:

3309

2601

pass

3310

2602

3311

2603

# Clients who has passed its expire date can still be

3312

# enabled if its last checker was successful. A Client

2604

# enabled if its last checker was successful. Clients

3313

2605

# whose checker succeeded before we stored its state is

3314

2606

# assumed to have successfully run all checkers during

3315

2607

# downtime.

3317

2609

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

3318

2610

if not client["last_checked_ok"]:

3319

2611

logger.warning(

3320

"disabling client {} - Client never "

3321

"performed a successful checker".format(

3322

client_name))

2612

"disabling client {0} - Client never "

2613

"performed a successful checker"

2614

.format(client_name))

3323

2615

client["enabled"] = False

3324

2616

elif client["last_checker_status"] != 0:

3325

2617

logger.warning(

3326

"disabling client {} - Client last"

3327

" checker failed with error code"

3328

" {}".format(

3329

client_name,

3330

client["last_checker_status"]))

2618

"disabling client {0} - Client "

2619

"last checker failed with error code {1}"

2620

.format(client_name,

2621

client["last_checker_status"]))

3331

2622

client["enabled"] = False

3332

2623

else:

3333

client["expires"] = (

3334

datetime.datetime.utcnow()

3335

+ client["timeout"])

2624

client["expires"] = (datetime.datetime

2625

.utcnow()

2626

+ client["timeout"])

3336

2627

logger.debug("Last checker succeeded,"

3337

" keeping {} enabled".format(

3338

client_name))

2628

" keeping {0} enabled"

2629

.format(client_name))

3339

2630

try:

3340

client["secret"] = pgp.decrypt(

3341

client["encrypted_secret"],

3342

client_settings[client_name]["secret"])

2631

client["secret"] = (

2632

pgp.decrypt(client["encrypted_secret"],

2633

client_settings[client_name]

2634

["secret"]))

3343

2635

except PGPError:

3344

2636

# If decryption fails, we use secret from new settings

3345

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

3346

client_name))

3347

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

3348

["secret"])

3349

2637

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

2638

.format(client_name))

2639

client["secret"] = (

2640

client_settings[client_name]["secret"])

2641

3350

2642

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

3351

2643

for client_name in (set(old_client_settings)

3352

2644

- set(client_settings)):

3354

2646

for client_name in (set(client_settings)

3355

2647

- set(old_client_settings)):

3356

2648

clients_data[client_name] = client_settings[client_name]

3357

2649

3358

2650

# Create all client objects

3359

for client_name, client in clients_data.items():

2651

for client_name, client in clients_data.iteritems():

3360

2652

tcp_server.clients[client_name] = client_class(

3361

name=client_name,

3362

settings=client,

3363

server_settings=server_settings)

3364

2653

name = client_name, settings = client,

2654

server_settings = server_settings)

2655

3365

2656

if not tcp_server.clients:

3366

2657

logger.warning("No clients defined")

3367

2658

3368

2659

if not foreground:

3369

2660

if pidfile is not None:

3370

pid = os.getpid()

3371

2661

try:

3372

2662

with pidfile:

3373

print(pid, file=pidfile)

2663

pid = os.getpid()

2664

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

3374

2665

except IOError:

3375

2666

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

3376

2667

pidfilename, pid)

3377

2668

del pidfile

3378

2669

del pidfilename

3379

3380

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

3381

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3382

lambda: main_loop.quit() and False)

3383

2670

2671

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

2672

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

2673

3384

2674

if use_dbus:

3385

3386

@alternate_dbus_interfaces(

3387

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

3388

class MandosDBusService(DBusObjectWithObjectManager):

2675

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

2676

"se.bsnet.fukt.Mandos"})

2677

class MandosDBusService(DBusObjectWithProperties):

3389

2678

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

3390

3391

2679

def __init__(self):

3392

2680

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

3393

3394

2681

_interface = "se.recompile.Mandos"

3395

2682

2683

@dbus_interface_annotations(_interface)

2684

def _foo(self):

2685

return { "org.freedesktop.DBus.Property"

2686

".EmitsChangedSignal":

2687

"false"}

2688

3396

2689

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

3397

2690

def ClientAdded(self, objpath):

3398

2691

"D-Bus signal"

3399

2692

pass

3400

2693

3401

2694

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

3402

def ClientNotFound(self, key_id, address):

2695

def ClientNotFound(self, fingerprint, address):

3403

2696

"D-Bus signal"

3404

2697

pass

3405

3406

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

3407

"true"})

2698

3408

2699

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

3409

2700

def ClientRemoved(self, objpath, name):

3410

2701

"D-Bus signal"

3411

2702

pass

3412

3413

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

3414

"true"})

2703

3415

2704

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

3416

2705

def GetAllClients(self):

3417

2706

"D-Bus method"

3418

return dbus.Array(c.dbus_object_path for c in

3419

tcp_server.clients.values())

3420

3421

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

3422

"true"})

2707

return dbus.Array(c.dbus_object_path

2708

for c in

2709

tcp_server.clients.itervalues())

2710

3423

2711

@dbus.service.method(_interface,

3424

2712

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

3425

2713

def GetAllClientsWithProperties(self):

3426

2714

"D-Bus method"

3427

2715

return dbus.Dictionary(

3428

{c.dbus_object_path: c.GetAll(

3429

"se.recompile.Mandos.Client")

3430

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

2716

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

2717

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

3431

2718

signature="oa{sv}")

3432

2719

3433

2720

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

3434

2721

def RemoveClient(self, object_path):

3435

2722

"D-Bus method"

3436

for c in tcp_server.clients.values():

2723

for c in tcp_server.clients.itervalues():

3437

2724

if c.dbus_object_path == object_path:

3438

2725

del tcp_server.clients[c.name]

3439

2726

c.remove_from_connection()

3440

# Don't signal the disabling

2727

# Don't signal anything except ClientRemoved

3441

2728

c.disable(quiet=True)

3442

# Emit D-Bus signal for removal

3443

self.client_removed_signal(c)

2729

# Emit D-Bus signal

2730

self.ClientRemoved(object_path, c.name)

3444

2731

return

3445

2732

raise KeyError(object_path)

3446

2733

3447

2734

del _interface

3448

3449

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3450

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

3451

def GetManagedObjects(self):

3452

"""D-Bus method"""

3453

return dbus.Dictionary(

3454

{client.dbus_object_path:

3455

dbus.Dictionary(

3456

{interface: client.GetAll(interface)

3457

for interface in

3458

client._get_all_interface_names()})

3459

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

3460

3461

def client_added_signal(self, client):

3462

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

3463

if use_dbus:

3464

# New standard signal

3465

self.InterfacesAdded(

3466

client.dbus_object_path,

3467

dbus.Dictionary(

3468

{interface: client.GetAll(interface)

3469

for interface in

3470

client._get_all_interface_names()}))

3471

# Old signal

3472

self.ClientAdded(client.dbus_object_path)

3473

3474

def client_removed_signal(self, client):

3475

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

3476

if use_dbus:

3477

# New standard signal

3478

self.InterfacesRemoved(

3479

client.dbus_object_path,

3480

client._get_all_interface_names())

3481

# Old signal

3482

self.ClientRemoved(client.dbus_object_path,

3483

client.name)

3484

2735

3485

2736

mandos_dbus_service = MandosDBusService()

3486

3487

# Save modules to variables to exempt the modules from being

3488

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

3489

mp = multiprocessing

3490

wn = wnull

3491

2737

3492

2738

def cleanup():

3493

2739

"Cleanup function; run on exit"

3494

if zeroconf:

3495

service.cleanup()

3496

3497

mp.active_children()

3498

wn.close()

2740

service.cleanup()

2741

2742

multiprocessing.active_children()

2743

wnull.close()

3499

2744

if not (tcp_server.clients or client_settings):

3500

2745

return

3501

2746

3502

2747

# Store client before exiting. Secrets are encrypted with key

3503

2748

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

3504

2749

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

3505

2750

clients = {}

3506

2751

with PGPEngine() as pgp:

3507

for client in tcp_server.clients.values():

2752

for client in tcp_server.clients.itervalues():

3508

2753

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

3509

2754

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

3510

2755

key)

3511

2756

client_dict = {}

3512

2757

3513

2758

# A list of attributes that can not be pickled

3514

2759

# + secret.

3515

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

3516

"checker", "server_settings"}

3517

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

3518

.Object):

2760

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

2761

"checker", "server_settings"))

2762

for name, typ in (inspect.getmembers

2763

(dbus.service.Object)):

3519

2764

exclude.add(name)

3520

2765

3521

2766

client_dict["encrypted_secret"] = (client

3522

2767

.encrypted_secret)

3523

2768

for attr in client.client_structure:

3524

2769

if attr not in exclude:

3525

2770

client_dict[attr] = getattr(client, attr)

3526

2771

3527

2772

clients[client.name] = client_dict

3528

2773

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

3529

2774

3530

2775

try:

3531

with tempfile.NamedTemporaryFile(

3532

mode='wb',

3533

suffix=".pickle",

3534

prefix='clients-',

3535

dir=os.path.dirname(stored_state_path),

3536

delete=False) as stored_state:

3537

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

3538

protocol=2)

3539

tempname = stored_state.name

2776

with (tempfile.NamedTemporaryFile

2777

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

2778

dir=os.path.dirname(stored_state_path),

2779

delete=False)) as stored_state:

2780

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

2781

tempname=stored_state.name

3540

2782

os.rename(tempname, stored_state_path)

3541

2783

except (IOError, OSError) as e:

3542

2784

if not debug:

3545

2787

except NameError:

3546

2788

pass

3547

2789

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

3548

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

2790

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

3549

2791

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

3550

2792

else:

3551

2793

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

3552

2794

exc_info=e)

3553

raise

3554

2795

raise e

2796

3555

2797

# Delete all clients, and settings from config

3556

2798

while tcp_server.clients:

3557

2799

name, client = tcp_server.clients.popitem()

3558

2800

if use_dbus:

3559

2801

client.remove_from_connection()

3560

# Don't signal the disabling

2802

# Don't signal anything except ClientRemoved

3561

2803

client.disable(quiet=True)

3562

# Emit D-Bus signal for removal

3563

2804

if use_dbus:

3564

mandos_dbus_service.client_removed_signal(client)

2805

# Emit D-Bus signal

2806

mandos_dbus_service.ClientRemoved(client

2807

.dbus_object_path,

2808

client.name)

3565

2809

client_settings.clear()

3566

2810

3567

2811

atexit.register(cleanup)

3568

3569

for client in tcp_server.clients.values():

2812

2813

for client in tcp_server.clients.itervalues():

3570

2814

if use_dbus:

3571

# Emit D-Bus signal for adding

3572

mandos_dbus_service.client_added_signal(client)

2815

# Emit D-Bus signal

2816

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3573

2817

# Need to initiate checking of clients

3574

2818

if client.enabled:

3575

2819

client.init_checker()

3576

2820

3577

2821

tcp_server.enable()

3578

2822

tcp_server.server_activate()

3579

2823

3580

2824

# Find out what port we got

3581

if zeroconf:

3582

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

2825

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

3583

2826

if use_ipv6:

3584

2827

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

3585

2828

" flowinfo %d, scope_id %d",

3587

2830

else: # IPv4

3588

2831

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

3589

2832

*tcp_server.socket.getsockname())

3590

3591

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

3592

2833

2834

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

2835

3593

2836

try:

3594

if zeroconf:

3595

# From the Avahi example code

3596

try:

3597

service.activate()

3598

except dbus.exceptions.DBusException as error:

3599

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

3600

cleanup()

3601

sys.exit(1)

3602

# End of Avahi example code

3603

3604

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

3605

lambda *args, **kwargs:

3606

(tcp_server.handle_request

3607

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

3608

2837

# From the Avahi example code

2838

try:

2839

service.activate()

2840

except dbus.exceptions.DBusException as error:

2841

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

2842

cleanup()

2843

sys.exit(1)

2844

# End of Avahi example code

2845

2846

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

2847

lambda *args, **kwargs:

2848

(tcp_server.handle_request

2849

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

2850

3609

2851

logger.debug("Starting main loop")

3610

2852

main_loop.run()

3611

2853

except AvahiError as error:

3620

2862

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

3621

2863

cleanup()

3622

2864

3623

3624

2865

if __name__ == '__main__':

3625

2866

main()