/mandos/release : revision 237.7.709

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

72

80

73

81

import dbus

74

82

import dbus.service

75

import gobject

76

import avahi

83

import gi

84

from gi.repository import GLib

77

85

from dbus.mainloop.glib import DBusGMainLoop

78

86

import ctypes

79

87

import ctypes.util

80

88

import xml.dom.minidom

81

89

import inspect

82

90

91

if sys.version_info.major == 2:

92

__metaclass__ = type

93

94

# Try to find the value of SO_BINDTODEVICE:

83

95

try:

96

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

97

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

84

98

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

99

except AttributeError:

86

100

try:

101

# This is where SO_BINDTODEVICE was up to and including Python

102

# 2.6, and also 3.2:

87

103

from IN import SO_BINDTODEVICE

88

104

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.3"

105

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

106

# Try running the C preprocessor:

107

try:

108

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

109

"/dev/stdin"],

110

stdin=subprocess.PIPE,

111

stdout=subprocess.PIPE)

112

stdout = cc.communicate(

113

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

114

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

115

except (OSError, ValueError, IndexError):

116

# No value found

117

SO_BINDTODEVICE = None

118

119

if sys.version_info.major == 2:

120

str = unicode

121

122

if sys.version_info < (3, 2):

123

configparser.Configparser = configparser.SafeConfigParser

124

125

version = "1.8.7"

92

126

stored_state_file = "clients.pickle"

93

127

94

128

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

129

syslogger = None

98

130

99

131

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

132

if_nametoindex = ctypes.cdll.LoadLibrary(

133

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

103

134

except (OSError, AttributeError):

135

104

136

def if_nametoindex(interface):

105

137

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

106

138

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

107

139

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

108

140

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

141

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

142

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

113

143

return interface_index

114

144

115

145

146

def copy_function(func):

147

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

148

if sys.version_info.major == 2:

149

return types.FunctionType(func.func_code,

150

func.func_globals,

151

func.func_name,

152

func.func_defaults,

153

func.func_closure)

154

else:

155

return types.FunctionType(func.__code__,

156

func.__globals__,

157

func.__name__,

158

func.__defaults__,

159

func.__closure__)

160

161

116

162

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

117

163

"""init logger and add loglevel"""

118

164

165

global syslogger

166

syslogger = (logging.handlers.SysLogHandler(

167

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

168

address="/dev/log"))

119

169

syslogger.setFormatter(logging.Formatter

120

170

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

121

171

' %(message)s'))

122

172

logger.addHandler(syslogger)

123

173

124

174

if debug:

125

175

console = logging.StreamHandler()

126

176

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

136

186

pass

137

187

138

188

139

class PGPEngine(object):

189

class PGPEngine:

140

190

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

191

141

192

def __init__(self):

142

193

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

194

self.gpg = "gpg"

195

try:

196

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

197

for line in output.splitlines():

198

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

199

if name == "gpg":

200

self.gpg = path

201

break

202

except OSError as e:

203

if e.errno != errno.ENOENT:

204

raise

143

205

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

206

'--homedir', self.tempdir,

145

207

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

148

208

'--quiet']

209

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

210

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

211

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

212

149

213

def __enter__(self):

150

214

return self

151

215

152

216

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

153

217

self._cleanup()

154

218

return False

155

219

156

220

def __del__(self):

157

221

self._cleanup()

158

222

159

223

def _cleanup(self):

160

224

if self.tempdir is not None:

161

225

# Delete contents of tempdir

162

226

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

163

topdown = False):

227

topdown=False):

164

228

for filename in files:

165

229

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

166

230

for dirname in dirs:

168

232

# Remove tempdir

169

233

os.rmdir(self.tempdir)

170

234

self.tempdir = None

171

235

172

236

def password_encode(self, password):

173

237

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

174

238

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

179

243

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

180

244

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

181

245

return encoded

182

246

183

247

def encrypt(self, data, password):

184

248

passphrase = self.password_encode(password)

185

with tempfile.NamedTemporaryFile(dir=self.tempdir

186

) as passfile:

249

with tempfile.NamedTemporaryFile(

250

dir=self.tempdir) as passfile:

187

251

passfile.write(passphrase)

188

252

passfile.flush()

189

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

253

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

190

254

'--passphrase-file',

191

255

passfile.name]

192

256

+ self.gnupgargs,

193

stdin = subprocess.PIPE,

194

stdout = subprocess.PIPE,

195

stderr = subprocess.PIPE)

196

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

257

stdin=subprocess.PIPE,

258

stdout=subprocess.PIPE,

259

stderr=subprocess.PIPE)

260

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

197

261

if proc.returncode != 0:

198

262

raise PGPError(err)

199

263

return ciphertext

200

264

201

265

def decrypt(self, data, password):

202

266

passphrase = self.password_encode(password)

203

with tempfile.NamedTemporaryFile(dir = self.tempdir

204

) as passfile:

267

with tempfile.NamedTemporaryFile(

268

dir=self.tempdir) as passfile:

205

269

passfile.write(passphrase)

206

270

passfile.flush()

207

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

271

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

208

272

'--passphrase-file',

209

273

passfile.name]

210

274

+ self.gnupgargs,

211

stdin = subprocess.PIPE,

212

stdout = subprocess.PIPE,

213

stderr = subprocess.PIPE)

214

decrypted_plaintext, err = proc.communicate(input

215

= data)

275

stdin=subprocess.PIPE,

276

stdout=subprocess.PIPE,

277

stderr=subprocess.PIPE)

278

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

216

279

if proc.returncode != 0:

217

280

raise PGPError(err)

218

281

return decrypted_plaintext

219

282

220

283

284

# Pretend that we have an Avahi module

285

class avahi:

286

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

287

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

288

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

289

PROTO_INET = 0 # avahi-common/address.h

290

PROTO_INET6 = 1 # avahi-common/address.h

291

DBUS_NAME = "org.freedesktop.Avahi"

292

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

293

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

294

DBUS_PATH_SERVER = "/"

295

296

@staticmethod

297

def string_array_to_txt_array(t):

298

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

299

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

300

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

301

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

302

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

303

SERVER_INVALID = 0 # avahi-common/defs.h

304

SERVER_REGISTERING = 1 # avahi-common/defs.h

305

SERVER_RUNNING = 2 # avahi-common/defs.h

306

SERVER_COLLISION = 3 # avahi-common/defs.h

307

SERVER_FAILURE = 4 # avahi-common/defs.h

308

309

221

310

class AvahiError(Exception):

222

311

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

223

312

self.value = value

224

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

225

def __unicode__(self):

226

return unicode(repr(self.value))

313

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

314

**kwargs)

315

227

316

228

317

class AvahiServiceError(AvahiError):

229

318

pass

230

319

320

231

321

class AvahiGroupError(AvahiError):

232

322

pass

233

323

234

324

235

class AvahiService(object):

325

class AvahiService:

236

326

"""An Avahi (Zeroconf) service.

237

327

238

328

Attributes:

239

329

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

240

330

Used to optionally bind to the specified interface.

252

342

server: D-Bus Server

253

343

bus: dbus.SystemBus()

254

344

"""

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

345

346

def __init__(self,

347

interface=avahi.IF_UNSPEC,

348

name=None,

349

servicetype=None,

350

port=None,

351

TXT=None,

352

domain="",

353

host="",

354

max_renames=32768,

355

protocol=avahi.PROTO_UNSPEC,

356

bus=None):

260

357

self.interface = interface

261

358

self.name = name

262

359

self.type = servicetype

271

368

self.server = None

272

369

self.bus = bus

273

370

self.entry_group_state_changed_match = None

274

275

def rename(self):

371

372

def rename(self, remove=True):

276

373

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

277

374

if self.rename_count >= self.max_renames:

278

375

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

279

376

" after %i retries, exiting.",

280

377

self.rename_count)

281

378

raise AvahiServiceError("Too many renames")

282

self.name = unicode(self.server

283

.GetAlternativeServiceName(self.name))

379

self.name = str(

380

self.server.GetAlternativeServiceName(self.name))

381

self.rename_count += 1

284

382

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

285

383

self.name)

286

self.remove()

384

if remove:

385

self.remove()

287

386

try:

288

387

self.add()

289

388

except dbus.exceptions.DBusException as error:

290

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

291

self.cleanup()

292

os._exit(1)

293

self.rename_count += 1

294

389

if (error.get_dbus_name()

390

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

391

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

392

return self.rename(remove=False)

393

else:

394

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

395

self.cleanup()

396

os._exit(1)

397

295

398

def remove(self):

296

399

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

297

400

if self.entry_group_state_changed_match is not None:

299

402

self.entry_group_state_changed_match = None

300

403

if self.group is not None:

301

404

self.group.Reset()

302

405

303

406

def add(self):

304

407

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

305

408

self.remove()

322

425

dbus.UInt16(self.port),

323

426

avahi.string_array_to_txt_array(self.TXT))

324

427

self.group.Commit()

325

428

326

429

def entry_group_state_changed(self, state, error):

327

430

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

328

431

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

329

432

330

433

if state == avahi.ENTRY_GROUP_ESTABLISHED:

331

434

logger.debug("Zeroconf service established.")

332

435

elif state == avahi.ENTRY_GROUP_COLLISION:

334

437

self.rename()

335

438

elif state == avahi.ENTRY_GROUP_FAILURE:

336

439

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

337

unicode(error))

338

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

339

.format(error))

340

440

str(error))

441

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

442

341

443

def cleanup(self):

342

444

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

343

445

if self.group is not None:

348

450

pass

349

451

self.group = None

350

452

self.remove()

351

453

352

454

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

353

455

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

354

456

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

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

bad_states = {

458

avahi.SERVER_INVALID: "Zeroconf server invalid",

459

avahi.SERVER_REGISTERING: None,

460

avahi.SERVER_COLLISION: "Zeroconf server name collision",

461

avahi.SERVER_FAILURE: "Zeroconf server failure",

462

}

362

463

if state in bad_states:

363

464

if bad_states[state] is not None:

364

465

if error is None:

367

468

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

368

469

self.cleanup()

369

470

elif state == avahi.SERVER_RUNNING:

370

self.add()

471

try:

472

self.add()

473

except dbus.exceptions.DBusException as error:

474

if (error.get_dbus_name()

475

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

476

logger.info("Local Zeroconf service name"

477

" collision.")

478

return self.rename(remove=False)

479

else:

480

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

481

self.cleanup()

482

os._exit(1)

371

483

else:

372

484

if error is None:

373

485

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

374

486

else:

375

487

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

376

488

377

489

def activate(self):

378

490

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

379

491

if self.server is None:

383

495

follow_name_owner_changes=True),

384

496

avahi.DBUS_INTERFACE_SERVER)

385

497

self.server.connect_to_signal("StateChanged",

386

self.server_state_changed)

498

self.server_state_changed)

387

499

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

388

500

389

501

390

502

class AvahiServiceToSyslog(AvahiService):

391

def rename(self):

503

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

392

504

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

393

ret = AvahiService.rename(self)

394

syslogger.setFormatter(logging.Formatter

395

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

396

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

397

.format(self.name)))

505

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

506

syslogger.setFormatter(logging.Formatter(

507

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

508

.format(self.name)))

398

509

return ret

399

510

400

511

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

406

407

408

class Client(object):

512

# Pretend that we have a GnuTLS module

513

class gnutls:

514

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

515

516

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

517

if library is None:

518

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

519

_library = ctypes.cdll.LoadLibrary(library)

520

del library

521

522

# Unless otherwise indicated, the constants and types below are

523

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

524

525

# Constants

526

E_SUCCESS = 0

527

E_INTERRUPTED = -52

528

E_AGAIN = -28

529

CRT_OPENPGP = 2

530

CRT_RAWPK = 3

531

CLIENT = 2

532

SHUT_RDWR = 0

533

CRD_CERTIFICATE = 1

534

E_NO_CERTIFICATE_FOUND = -49

535

X509_FMT_DER = 0

536

NO_TICKETS = 1<<10

537

ENABLE_RAWPK = 1<<18

538

CTYPE_PEERS = 3

539

KEYID_USE_SHA256 = 1 # gnutls/x509.h

540

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

541

542

# Types

543

class session_int(ctypes.Structure):

544

_fields_ = []

545

session_t = ctypes.POINTER(session_int)

546

547

class certificate_credentials_st(ctypes.Structure):

548

_fields_ = []

549

certificate_credentials_t = ctypes.POINTER(

550

certificate_credentials_st)

551

certificate_type_t = ctypes.c_int

552

553

class datum_t(ctypes.Structure):

554

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

555

('size', ctypes.c_uint)]

556

557

class openpgp_crt_int(ctypes.Structure):

558

_fields_ = []

559

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

560

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

561

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

562

credentials_type_t = ctypes.c_int

563

transport_ptr_t = ctypes.c_void_p

564

close_request_t = ctypes.c_int

565

566

# Exceptions

567

class Error(Exception):

568

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

569

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

570

# code is passed, convert it to a string with

571

# gnutls.strerror()

572

self.code = code

573

if message is None and code is not None:

574

message = gnutls.strerror(code)

575

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

576

message, *args)

577

578

class CertificateSecurityError(Error):

579

pass

580

581

# Classes

582

class Credentials:

583

def __init__(self):

584

self._c_object = gnutls.certificate_credentials_t()

585

gnutls.certificate_allocate_credentials(

586

ctypes.byref(self._c_object))

587

self.type = gnutls.CRD_CERTIFICATE

588

589

def __del__(self):

590

gnutls.certificate_free_credentials(self._c_object)

591

592

class ClientSession:

593

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

594

self._c_object = gnutls.session_t()

595

gnutls_flags = gnutls.CLIENT

596

if gnutls.check_version(b"3.5.6"):

597

gnutls_flags |= gnutls.NO_TICKETS

598

if gnutls.has_rawpk:

599

gnutls_flags |= gnutls.ENABLE_RAWPK

600

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

601

del gnutls_flags

602

gnutls.set_default_priority(self._c_object)

603

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

604

gnutls.handshake_set_private_extensions(self._c_object,

605

True)

606

self.socket = socket

607

if credentials is None:

608

credentials = gnutls.Credentials()

609

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

610

ctypes.cast(credentials._c_object,

611

ctypes.c_void_p))

612

self.credentials = credentials

613

614

def __del__(self):

615

gnutls.deinit(self._c_object)

616

617

def handshake(self):

618

return gnutls.handshake(self._c_object)

619

620

def send(self, data):

621

data = bytes(data)

622

data_len = len(data)

623

while data_len > 0:

624

data_len -= gnutls.record_send(self._c_object,

625

data[-data_len:],

626

data_len)

627

628

def bye(self):

629

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

630

631

# Error handling functions

632

def _error_code(result):

633

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

634

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

635

if result >= 0:

636

return result

637

if result == gnutls.E_NO_CERTIFICATE_FOUND:

638

raise gnutls.CertificateSecurityError(code=result)

639

raise gnutls.Error(code=result)

640

641

def _retry_on_error(result, func, arguments):

642

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

643

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

644

while result < 0:

645

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

646

return _error_code(result)

647

result = func(*arguments)

648

return result

649

650

# Unless otherwise indicated, the function declarations below are

651

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

652

653

# Functions

654

priority_set_direct = _library.gnutls_priority_set_direct

655

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

656

ctypes.POINTER(ctypes.c_char_p)]

657

priority_set_direct.restype = _error_code

658

659

init = _library.gnutls_init

660

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

661

init.restype = _error_code

662

663

set_default_priority = _library.gnutls_set_default_priority

664

set_default_priority.argtypes = [session_t]

665

set_default_priority.restype = _error_code

666

667

record_send = _library.gnutls_record_send

668

record_send.argtypes = [session_t, ctypes.c_void_p,

669

ctypes.c_size_t]

670

record_send.restype = ctypes.c_ssize_t

671

record_send.errcheck = _retry_on_error

672

673

certificate_allocate_credentials = (

674

_library.gnutls_certificate_allocate_credentials)

675

certificate_allocate_credentials.argtypes = [

676

ctypes.POINTER(certificate_credentials_t)]

677

certificate_allocate_credentials.restype = _error_code

678

679

certificate_free_credentials = (

680

_library.gnutls_certificate_free_credentials)

681

certificate_free_credentials.argtypes = [

682

certificate_credentials_t]

683

certificate_free_credentials.restype = None

684

685

handshake_set_private_extensions = (

686

_library.gnutls_handshake_set_private_extensions)

687

handshake_set_private_extensions.argtypes = [session_t,

688

ctypes.c_int]

689

handshake_set_private_extensions.restype = None

690

691

credentials_set = _library.gnutls_credentials_set

692

credentials_set.argtypes = [session_t, credentials_type_t,

693

ctypes.c_void_p]

694

credentials_set.restype = _error_code

695

696

strerror = _library.gnutls_strerror

697

strerror.argtypes = [ctypes.c_int]

698

strerror.restype = ctypes.c_char_p

699

700

certificate_type_get = _library.gnutls_certificate_type_get

701

certificate_type_get.argtypes = [session_t]

702

certificate_type_get.restype = _error_code

703

704

certificate_get_peers = _library.gnutls_certificate_get_peers

705

certificate_get_peers.argtypes = [session_t,

706

ctypes.POINTER(ctypes.c_uint)]

707

certificate_get_peers.restype = ctypes.POINTER(datum_t)

708

709

global_set_log_level = _library.gnutls_global_set_log_level

710

global_set_log_level.argtypes = [ctypes.c_int]

711

global_set_log_level.restype = None

712

713

global_set_log_function = _library.gnutls_global_set_log_function

714

global_set_log_function.argtypes = [log_func]

715

global_set_log_function.restype = None

716

717

deinit = _library.gnutls_deinit

718

deinit.argtypes = [session_t]

719

deinit.restype = None

720

721

handshake = _library.gnutls_handshake

722

handshake.argtypes = [session_t]

723

handshake.restype = _error_code

724

handshake.errcheck = _retry_on_error

725

726

transport_set_ptr = _library.gnutls_transport_set_ptr

727

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

728

transport_set_ptr.restype = None

729

730

bye = _library.gnutls_bye

731

bye.argtypes = [session_t, close_request_t]

732

bye.restype = _error_code

733

bye.errcheck = _retry_on_error

734

735

check_version = _library.gnutls_check_version

736

check_version.argtypes = [ctypes.c_char_p]

737

check_version.restype = ctypes.c_char_p

738

739

_need_version = b"3.3.0"

740

if check_version(_need_version) is None:

741

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

742

.format(_need_version))

743

744

_tls_rawpk_version = b"3.6.6"

745

has_rawpk = bool(check_version(_tls_rawpk_version))

746

747

if has_rawpk:

748

# Types

749

class pubkey_st(ctypes.Structure):

750

_fields = []

751

pubkey_t = ctypes.POINTER(pubkey_st)

752

753

x509_crt_fmt_t = ctypes.c_int

754

755

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

756

pubkey_init = _library.gnutls_pubkey_init

757

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

758

pubkey_init.restype = _error_code

759

760

pubkey_import = _library.gnutls_pubkey_import

761

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

762

x509_crt_fmt_t]

763

pubkey_import.restype = _error_code

764

765

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

766

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

767

ctypes.POINTER(ctypes.c_ubyte),

768

ctypes.POINTER(ctypes.c_size_t)]

769

pubkey_get_key_id.restype = _error_code

770

771

pubkey_deinit = _library.gnutls_pubkey_deinit

772

pubkey_deinit.argtypes = [pubkey_t]

773

pubkey_deinit.restype = None

774

else:

775

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

776

777

openpgp_crt_init = _library.gnutls_openpgp_crt_init

778

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

779

openpgp_crt_init.restype = _error_code

780

781

openpgp_crt_import = _library.gnutls_openpgp_crt_import

782

openpgp_crt_import.argtypes = [openpgp_crt_t,

783

ctypes.POINTER(datum_t),

784

openpgp_crt_fmt_t]

785

openpgp_crt_import.restype = _error_code

786

787

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

788

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

789

ctypes.POINTER(ctypes.c_uint)]

790

openpgp_crt_verify_self.restype = _error_code

791

792

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

793

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

794

openpgp_crt_deinit.restype = None

795

796

openpgp_crt_get_fingerprint = (

797

_library.gnutls_openpgp_crt_get_fingerprint)

798

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

799

ctypes.c_void_p,

800

ctypes.POINTER(

801

ctypes.c_size_t)]

802

openpgp_crt_get_fingerprint.restype = _error_code

803

804

if check_version(b"3.6.4"):

805

certificate_type_get2 = _library.gnutls_certificate_type_get2

806

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

807

certificate_type_get2.restype = _error_code

808

809

# Remove non-public functions

810

del _error_code, _retry_on_error

811

812

813

def call_pipe(connection, # : multiprocessing.Connection

814

func, *args, **kwargs):

815

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

816

817

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

818

return value on the provided multiprocessing.Connection.

819

"""

820

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

821

connection.close()

822

823

824

class Client:

409

825

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

410

826

411

827

Attributes:

412

828

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

413

829

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

414

830

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

415

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

416

to see if the client lives.

417

'None' if no process is running.

418

checker_callback_tag: a gobject event source tag, or None

831

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

832

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

833

running.

834

checker_callback_tag: a GLib event source tag, or None

419

835

checker_command: string; External command which is run to check

420

836

if client lives. %() expansions are done at

421

837

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

422

838

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

423

checker_initiator_tag: a gobject event source tag, or None

839

checker_initiator_tag: a GLib event source tag, or None

424

840

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

425

841

client_structure: Object describing what attributes a client has

426

842

and is used for storing the client at exit

427

843

current_checker_command: string; current running checker_command

428

disable_initiator_tag: a gobject event source tag, or None

844

disable_initiator_tag: a GLib event source tag, or None

429

845

enabled: bool()

430

846

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

431

uniquely identify the client

847

uniquely identify an OpenPGP client

848

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

849

a client using raw public keys

432

850

host: string; available for use by the checker command

433

851

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

434

852

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

436

854

last_checker_status: integer between 0 and 255 reflecting exit

437

855

status of last checker. -1 reflects crashed

438

856

checker, -2 means no checker completed yet.

857

last_checker_signal: The signal which killed the last checker, if

858

last_checker_status is -1

439

859

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

440

860

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

441

861

D-Bus identifiers

448

868

disabled, or None

449

869

server_settings: The server_settings dict from main()

450

870

"""

451

871

452

872

runtime_expansions = ("approval_delay", "approval_duration",

453

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

873

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

454

874

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

455

875

"last_approval_request", "last_checked_ok",

456

876

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

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

877

client_defaults = {

878

"timeout": "PT5M",

879

"extended_timeout": "PT15M",

880

"interval": "PT2M",

881

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

882

"host": "",

883

"approval_delay": "PT0S",

884

"approval_duration": "PT1S",

885

"approved_by_default": "True",

886

"enabled": "True",

887

}

888

483

889

@staticmethod

484

890

def config_parser(config):

485

891

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

492

898

for client_name in config.sections():

493

899

section = dict(config.items(client_name))

494

900

client = settings[client_name] = {}

495

901

496

902

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

497

903

# Reformat values from string types to Python types

498

904

client["approved_by_default"] = config.getboolean(

499

905

client_name, "approved_by_default")

500

906

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

501

907

"enabled")

502

908

909

# Uppercase and remove spaces from key_id and fingerprint

910

# for later comparison purposes with return value from the

911

# key_id() and fingerprint() functions

912

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

913

.replace(" ", ""))

503

914

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

504

915

.replace(" ", ""))

505

916

if "secret" in section:

506

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

917

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

918

.encode("utf-8"),

919

"base64")

507

920

elif "secfile" in section:

508

921

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

509

922

(section["secfile"])),

510

923

"rb") as secfile:

511

924

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

512

925

else:

513

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

926

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

514

927

.format(section))

515

928

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

516

929

client["extended_timeout"] = string_to_delta(

524

937

client["last_approval_request"] = None

525

938

client["last_checked_ok"] = None

526

939

client["last_checker_status"] = -2

527

940

528

941

return settings

529

530

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

942

943

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

531

944

self.name = name

532

945

if server_settings is None:

533

946

server_settings = {}

534

947

self.server_settings = server_settings

535

948

# adding all client settings

536

for setting, value in settings.iteritems():

949

for setting, value in settings.items():

537

950

setattr(self, setting, value)

538

951

539

952

if self.enabled:

540

953

if not hasattr(self, "last_enabled"):

541

954

self.last_enabled = datetime.datetime.utcnow()

545

958

else:

546

959

self.last_enabled = None

547

960

self.expires = None

548

961

549

962

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

550

# Uppercase and remove spaces from fingerprint for later

551

# comparison purposes with return value from the fingerprint()

552

# function

963

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

553

964

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

554

965

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

555

966

datetime.datetime.utcnow())

556

967

557

968

# attributes specific for this server instance

558

969

self.checker = None

559

970

self.checker_initiator_tag = None

562

973

self.current_checker_command = None

563

974

self.approved = None

564

975

self.approvals_pending = 0

565

self.changedstate = (multiprocessing_manager

566

.Condition(multiprocessing_manager

567

.Lock()))

568

self.client_structure = [attr for attr in

569

self.__dict__.iterkeys()

976

self.changedstate = multiprocessing_manager.Condition(

977

multiprocessing_manager.Lock())

978

self.client_structure = [attr

979

for attr in self.__dict__.keys()

570

980

if not attr.startswith("_")]

571

981

self.client_structure.append("client_structure")

572

573

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

574

lambda obj:

575

isinstance(obj,

576

property)):

982

983

for name, t in inspect.getmembers(

984

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

577

985

if not name.startswith("_"):

578

986

self.client_structure.append(name)

579

987

580

988

# Send notice to process children that client state has changed

581

989

def send_changedstate(self):

582

990

with self.changedstate:

583

991

self.changedstate.notify_all()

584

992

585

993

def enable(self):

586

994

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

587

995

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

592

1000

self.last_enabled = datetime.datetime.utcnow()

593

1001

self.init_checker()

594

1002

self.send_changedstate()

595

1003

596

1004

def disable(self, quiet=True):

597

1005

"""Disable this client."""

598

1006

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

600

1008

if not quiet:

601

1009

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

602

1010

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

603

gobject.source_remove(self.disable_initiator_tag)

1011

GLib.source_remove(self.disable_initiator_tag)

604

1012

self.disable_initiator_tag = None

605

1013

self.expires = None

606

1014

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

607

gobject.source_remove(self.checker_initiator_tag)

1015

GLib.source_remove(self.checker_initiator_tag)

608

1016

self.checker_initiator_tag = None

609

1017

self.stop_checker()

610

1018

self.enabled = False

611

1019

if not quiet:

612

1020

self.send_changedstate()

613

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

1021

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

614

1022

return False

615

1023

616

1024

def __del__(self):

617

1025

self.disable()

618

1026

619

1027

def init_checker(self):

620

1028

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

621

1029

# and every interval from then on.

622

1030

if self.checker_initiator_tag is not None:

623

gobject.source_remove(self.checker_initiator_tag)

624

self.checker_initiator_tag = (gobject.timeout_add

625

(self.interval_milliseconds(),

626

self.start_checker))

1031

GLib.source_remove(self.checker_initiator_tag)

1032

self.checker_initiator_tag = GLib.timeout_add(

1033

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

1034

self.start_checker)

627

1035

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

628

1036

if self.disable_initiator_tag is not None:

629

gobject.source_remove(self.disable_initiator_tag)

630

self.disable_initiator_tag = (gobject.timeout_add

631

(self.timeout_milliseconds(),

632

self.disable))

1037

GLib.source_remove(self.disable_initiator_tag)

1038

self.disable_initiator_tag = GLib.timeout_add(

1039

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

633

1040

# Also start a new checker *right now*.

634

1041

self.start_checker()

635

636

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

1042

1043

def checker_callback(self, source, condition, connection,

1044

command):

637

1045

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

1046

# Read return code from connection (see call_pipe)

1047

returncode = connection.recv()

1048

connection.close()

1049

self.checker.join()

638

1050

self.checker_callback_tag = None

639

1051

self.checker = None

640

if os.WIFEXITED(condition):

641

self.last_checker_status = os.WEXITSTATUS(condition)

1052

1053

if returncode >= 0:

1054

self.last_checker_status = returncode

1055

self.last_checker_signal = None

642

1056

if self.last_checker_status == 0:

643

1057

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

644

1058

vars(self))

645

1059

self.checked_ok()

646

1060

else:

647

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

648

vars(self))

1061

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

649

1062

else:

650

1063

self.last_checker_status = -1

1064

self.last_checker_signal = -returncode

651

1065

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

652

1066

vars(self))

653

1067

return False

1068

654

1069

def checked_ok(self):

655

1070

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

656

1071

self.last_checked_ok = datetime.datetime.utcnow()

657

1072

self.last_checker_status = 0

1073

self.last_checker_signal = None

658

1074

self.bump_timeout()

659

1075

660

1076

def bump_timeout(self, timeout=None):

661

1077

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

662

1078

if timeout is None:

663

1079

timeout = self.timeout

664

1080

if self.disable_initiator_tag is not None:

665

gobject.source_remove(self.disable_initiator_tag)

1081

GLib.source_remove(self.disable_initiator_tag)

666

1082

self.disable_initiator_tag = None

667

1083

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

668

self.disable_initiator_tag = (gobject.timeout_add

669

(timedelta_to_milliseconds

670

(timeout), self.disable))

1084

self.disable_initiator_tag = GLib.timeout_add(

1085

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

671

1086

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

672

1087

673

1088

def need_approval(self):

674

1089

self.last_approval_request = datetime.datetime.utcnow()

675

1090

676

1091

def start_checker(self):

677

1092

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

678

1093

679

1094

If a checker already exists, leave it running and do

680

1095

nothing."""

681

1096

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

686

1101

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

687

1102

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

688

1103

# should be.

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:

694

pass

695

except OSError as error:

696

if error.errno != errno.ECHILD:

697

raise

698

else:

699

if pid:

700

logger.warning("Checker was a zombie")

701

gobject.source_remove(self.checker_callback_tag)

702

self.checker_callback(pid, status,

703

self.current_checker_command)

1104

1105

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

1106

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

1107

self.checker.join()

1108

self.checker = None

704

1109

# Start a new checker if needed

705

1110

if self.checker is None:

706

1111

# Escape attributes for the shell

707

escaped_attrs = dict(

708

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

709

for attr in

710

self.runtime_expansions)

1112

escaped_attrs = {

1113

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

1114

for attr in self.runtime_expansions}

711

1115

try:

712

1116

command = self.checker_command % escaped_attrs

713

1117

except TypeError as error:

714

1118

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

715

self.checker_command, exc_info=error)

716

return True # Try again later

1119

self.checker_command,

1120

exc_info=error)

1121

return True # Try again later

717

1122

self.current_checker_command = command

718

try:

719

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

720

command, self.name)

721

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

722

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

723

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

724

# always replaced by /dev/null.)

725

# The exception is when not debugging but nevertheless

726

# running in the foreground; use the previously

727

# created wnull.

728

popen_args = {}

729

if (not self.server_settings["debug"]

730

and self.server_settings["foreground"]):

731

popen_args.update({"stdout": wnull,

732

"stderr": wnull })

733

self.checker = subprocess.Popen(command,

734

close_fds=True,

735

shell=True, cwd="/",

736

**popen_args)

737

except OSError as error:

738

logger.error("Failed to start subprocess",

739

exc_info=error)

740

return True

741

self.checker_callback_tag = (gobject.child_watch_add

742

(self.checker.pid,

743

self.checker_callback,

744

data=command))

745

# The checker may have completed before the gobject

746

# watch was added. Check for this.

747

try:

748

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

749

except OSError as error:

750

if error.errno == errno.ECHILD:

751

# This should never happen

752

logger.error("Child process vanished",

753

exc_info=error)

754

return True

755

raise

756

if pid:

757

gobject.source_remove(self.checker_callback_tag)

758

self.checker_callback(pid, status, command)

759

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

1123

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

1124

self.name)

1125

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

1126

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

1127

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

1128

# always replaced by /dev/null.)

1129

# The exception is when not debugging but nevertheless

1130

# running in the foreground; use the previously

1131

# created wnull.

1132

popen_args = {"close_fds": True,

1133

"shell": True,

1134

"cwd": "/"}

1135

if (not self.server_settings["debug"]

1136

and self.server_settings["foreground"]):

1137

popen_args.update({"stdout": wnull,

1138

"stderr": wnull})

1139

pipe = multiprocessing.Pipe(duplex=False)

1140

self.checker = multiprocessing.Process(

1141

target=call_pipe,

1142

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

1143

kwargs=popen_args)

1144

self.checker.start()

1145

self.checker_callback_tag = GLib.io_add_watch(

1146

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

1147

self.checker_callback, pipe[0], command)

1148

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

760

1149

return True

761

1150

762

1151

def stop_checker(self):

763

1152

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

764

1153

if self.checker_callback_tag:

765

gobject.source_remove(self.checker_callback_tag)

1154

GLib.source_remove(self.checker_callback_tag)

766

1155

self.checker_callback_tag = None

767

1156

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

768

1157

return

769

1158

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

770

try:

771

self.checker.terminate()

772

#time.sleep(0.5)

773

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

774

# self.checker.kill()

775

except OSError as error:

776

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

777

raise

1159

self.checker.terminate()

778

1160

self.checker = None

779

1161

780

1162

781

def dbus_service_property(dbus_interface, signature="v",

782

access="readwrite", byte_arrays=False):

1163

def dbus_service_property(dbus_interface,

1164

signature="v",

1165

access="readwrite",

1166

byte_arrays=False):

783

1167

"""Decorators for marking methods of a DBusObjectWithProperties to

784

1168

become properties on the D-Bus.

785

1169

786

1170

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

787

1171

and with one argument by "Set".

788

1172

789

1173

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

790

1174

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

791

1175

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

794

1178

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

795

1179

if byte_arrays and signature != "ay":

796

1180

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

797

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

1181

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

1182

798

1183

def decorator(func):

799

1184

func._dbus_is_property = True

800

1185

func._dbus_interface = dbus_interface

803

1188

func._dbus_name = func.__name__

804

1189

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

805

1190

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

806

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1191

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

807

1192

return func

1193

808

1194

return decorator

809

1195

810

1196

811

1197

def dbus_interface_annotations(dbus_interface):

812

1198

"""Decorator for marking functions returning interface annotations

813

1199

814

1200

Usage:

815

1201

816

1202

@dbus_interface_annotations("org.example.Interface")

817

1203

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

818

1204

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

819

1205

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

820

1206

"false"}

821

1207

"""

1208

822

1209

def decorator(func):

823

1210

func._dbus_is_interface = True

824

1211

func._dbus_interface = dbus_interface

825

1212

func._dbus_name = dbus_interface

826

1213

return func

1214

827

1215

return decorator

828

1216

829

1217

830

1218

def dbus_annotations(annotations):

831

1219

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

832

1220

Usage:

833

1221

1222

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

1223

"org.freedesktop.DBus.Property."

1224

"EmitsChangedSignal": "false"})

834

1225

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

835

1226

access="r")

836

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

837

"org.freedesktop.DBus.Property."

838

"EmitsChangedSignal": "false"})

839

1227

def Property_dbus_property(self):

840

1228

return dbus.Boolean(False)

1229

1230

See also the DBusObjectWithAnnotations class.

841

1231

"""

1232

842

1233

def decorator(func):

843

1234

func._dbus_annotations = annotations

844

1235

return func

1236

845

1237

return decorator

846

1238

847

1239

848

1240

class DBusPropertyException(dbus.exceptions.DBusException):

849

1241

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

850

1242

"""

851

def __unicode__(self):

852

return unicode(str(self))

1243

pass

853

1244

854

1245

855

1246

class DBusPropertyAccessException(DBusPropertyException):

864

1255

pass

865

1256

866

1257

867

class DBusObjectWithProperties(dbus.service.Object):

868

"""A D-Bus object with properties.

869

870

Classes inheriting from this can use the dbus_service_property

871

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

872

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

1258

class DBusObjectWithAnnotations(dbus.service.Object):

1259

"""A D-Bus object with annotations.

1260

1261

Classes inheriting from this can use the dbus_annotations

1262

decorator to add annotations to methods or signals.

873

1263

"""

874

1264

875

1265

@staticmethod

876

1266

def _is_dbus_thing(thing):

877

1267

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

878

1268

879

1269

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

880

1270

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

881

1271

"""

882

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

1272

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

883

1273

False)

884

1274

885

1275

def _get_all_dbus_things(self, thing):

886

1276

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

887

1277

"""

888

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

889

name),

1278

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

890

1279

athing.__get__(self))

891

1280

for cls in self.__class__.__mro__

892

1281

for name, athing in

893

inspect.getmembers(cls,

894

self._is_dbus_thing(thing)))

895

1282

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

1283

1284

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1285

out_signature="s",

1286

path_keyword='object_path',

1287

connection_keyword='connection')

1288

def Introspect(self, object_path, connection):

1289

"""Overloading of standard D-Bus method.

1290

1291

Inserts annotation tags on methods and signals.

1292

"""

1293

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

1294

connection)

1295

try:

1296

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

1297

1298

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

1299

# Add annotation tags

1300

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

1301

for tag in if_tag.getElementsByTagName(typ):

1302

annots = dict()

1303

for name, prop in (self.

1304

_get_all_dbus_things(typ)):

1305

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

1306

and prop._dbus_interface

1307

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

1308

annots.update(getattr(

1309

prop, "_dbus_annotations", {}))

1310

for name, value in annots.items():

1311

ann_tag = document.createElement(

1312

"annotation")

1313

ann_tag.setAttribute("name", name)

1314

ann_tag.setAttribute("value", value)

1315

tag.appendChild(ann_tag)

1316

# Add interface annotation tags

1317

for annotation, value in dict(

1318

itertools.chain.from_iterable(

1319

annotations().items()

1320

for name, annotations

1321

in self._get_all_dbus_things("interface")

1322

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

1323

)).items():

1324

ann_tag = document.createElement("annotation")

1325

ann_tag.setAttribute("name", annotation)

1326

ann_tag.setAttribute("value", value)

1327

if_tag.appendChild(ann_tag)

1328

# Fix argument name for the Introspect method itself

1329

if (if_tag.getAttribute("name")

1330

== dbus.INTROSPECTABLE_IFACE):

1331

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

1332

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

1333

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

1334

if (arg.getAttribute("direction")

1335

== "out"):

1336

arg.setAttribute("name",

1337

"xml_data")

1338

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

1339

document.unlink()

1340

except (AttributeError, xml.dom.DOMException,

1341

xml.parsers.expat.ExpatError) as error:

1342

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

1343

exc_info=error)

1344

return xmlstring

1345

1346

1347

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1348

"""A D-Bus object with properties.

1349

1350

Classes inheriting from this can use the dbus_service_property

1351

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

1352

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

1353

"""

1354

896

1355

def _get_dbus_property(self, interface_name, property_name):

897

1356

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

898

1357

property with the specified name and interface.

899

1358

"""

900

for cls in self.__class__.__mro__:

901

for name, value in (inspect.getmembers

902

(cls,

903

self._is_dbus_thing("property"))):

1359

for cls in self.__class__.__mro__:

1360

for name, value in inspect.getmembers(

1361

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

904

1362

if (value._dbus_name == property_name

905

1363

and value._dbus_interface == interface_name):

906

1364

return value.__get__(self)

907

1365

908

1366

# No such property

909

raise DBusPropertyNotFound(self.dbus_object_path + ":"

910

+ interface_name + "."

911

+ property_name)

912

913

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

1367

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

1368

self.dbus_object_path, interface_name, property_name))

1369

1370

@classmethod

1371

def _get_all_interface_names(cls):

1372

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

1373

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

1374

"_dbus_interface", None)

1375

for x in (inspect.getmro(cls))

1376

for attr in dir(x))

1377

if name is not None)

1378

1379

@dbus.service.method(dbus.PROPERTIES_IFACE,

1380

in_signature="ss",

914

1381

out_signature="v")

915

1382

def Get(self, interface_name, property_name):

916

1383

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

922

1389

if not hasattr(value, "variant_level"):

923

1390

return value

924

1391

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

925

1392

926

1393

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

927

1394

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

928

1395

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

935

1402

# signatures other than "ay".

936

1403

if prop._dbus_signature != "ay":

937

1404

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

938

"'ay' signature {0!r}"

1405

"'ay' signature {!r}"

939

1406

.format(prop._dbus_signature))

940

1407

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

941

1408

for byte in value))

942

1409

prop(value)

943

944

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

1410

1411

@dbus.service.method(dbus.PROPERTIES_IFACE,

1412

in_signature="s",

945

1413

out_signature="a{sv}")

946

1414

def GetAll(self, interface_name):

947

1415

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

948

1416

standard.

949

1417

950

1418

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

951

1419

"""

952

1420

properties = {}

962

1430

if not hasattr(value, "variant_level"):

963

1431

properties[name] = value

964

1432

continue

965

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

966

value.variant_level+1)

1433

properties[name] = type(value)(

1434

value, variant_level=value.variant_level + 1)

967

1435

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

968

1436

1437

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

1438

def PropertiesChanged(self, interface_name, changed_properties,

1439

invalidated_properties):

1440

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

1441

standard.

1442

"""

1443

pass

1444

969

1445

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

970

1446

out_signature="s",

971

1447

path_keyword='object_path',

972

1448

connection_keyword='connection')

973

1449

def Introspect(self, object_path, connection):

974

1450

"""Overloading of standard D-Bus method.

975

1451

976

1452

Inserts property tags and interface annotation tags.

977

1453

"""

978

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

979

connection)

1454

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1455

object_path,

1456

connection)

980

1457

try:

981

1458

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

1459

982

1460

def make_tag(document, name, prop):

983

1461

e = document.createElement("property")

984

1462

e.setAttribute("name", name)

985

1463

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

986

1464

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

987

1465

return e

1466

988

1467

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

989

1468

# Add property tags

990

1469

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

993

1472

if prop._dbus_interface

994

1473

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

995

1474

if_tag.appendChild(tag)

996

# Add annotation tags

997

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

998

for tag in if_tag.getElementsByTagName(typ):

999

annots = dict()

1000

for name, prop in (self.

1001

_get_all_dbus_things(typ)):

1002

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

1003

and prop._dbus_interface

1004

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

1005

annots.update(getattr

1006

(prop,

1007

"_dbus_annotations",

1008

{}))

1009

for name, value in annots.iteritems():

1010

ann_tag = document.createElement(

1011

"annotation")

1012

ann_tag.setAttribute("name", name)

1013

ann_tag.setAttribute("value", value)

1014

tag.appendChild(ann_tag)

1015

# Add interface annotation tags

1016

for annotation, value in dict(

1017

itertools.chain.from_iterable(

1018

annotations().iteritems()

1019

for name, annotations in

1020

self._get_all_dbus_things("interface")

1021

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

1022

)).iteritems():

1023

ann_tag = document.createElement("annotation")

1024

ann_tag.setAttribute("name", annotation)

1025

ann_tag.setAttribute("value", value)

1026

if_tag.appendChild(ann_tag)

1475

# Add annotation tags for properties

1476

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

1477

annots = dict()

1478

for name, prop in self._get_all_dbus_things(

1479

"property"):

1480

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

1481

and prop._dbus_interface

1482

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

1483

annots.update(getattr(

1484

prop, "_dbus_annotations", {}))

1485

for name, value in annots.items():

1486

ann_tag = document.createElement(

1487

"annotation")

1488

ann_tag.setAttribute("name", name)

1489

ann_tag.setAttribute("value", value)

1490

tag.appendChild(ann_tag)

1027

1491

# Add the names to the return values for the

1028

1492

# "org.freedesktop.DBus.Properties" methods

1029

1493

if (if_tag.getAttribute("name")

1048

1512

return xmlstring

1049

1513

1050

1514

1515

try:

1516

dbus.OBJECT_MANAGER_IFACE

1517

except AttributeError:

1518

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

1519

1520

1521

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1522

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

1523

1524

Classes inheriting from this exposes the standard

1525

GetManagedObjects call and the InterfacesAdded and

1526

InterfacesRemoved signals on the standard

1527

"org.freedesktop.DBus.ObjectManager" interface.

1528

1529

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

1530

manually.

1531

"""

1532

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1533

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

1534

def GetManagedObjects(self):

1535

"""This function must be overridden"""

1536

raise NotImplementedError()

1537

1538

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1539

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

1540

def InterfacesAdded(self, object_path, interfaces_and_properties):

1541

pass

1542

1543

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

1544

def InterfacesRemoved(self, object_path, interfaces):

1545

pass

1546

1547

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1548

out_signature="s",

1549

path_keyword='object_path',

1550

connection_keyword='connection')

1551

def Introspect(self, object_path, connection):

1552

"""Overloading of standard D-Bus method.

1553

1554

Override return argument name of GetManagedObjects to be

1555

"objpath_interfaces_and_properties"

1556

"""

1557

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1558

object_path,

1559

connection)

1560

try:

1561

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

1562

1563

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

1564

# Fix argument name for the GetManagedObjects method

1565

if (if_tag.getAttribute("name")

1566

== dbus.OBJECT_MANAGER_IFACE):

1567

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

1568

if (cn.getAttribute("name")

1569

== "GetManagedObjects"):

1570

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

1571

if (arg.getAttribute("direction")

1572

== "out"):

1573

arg.setAttribute(

1574

"name",

1575

"objpath_interfaces"

1576

"_and_properties")

1577

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

1578

document.unlink()

1579

except (AttributeError, xml.dom.DOMException,

1580

xml.parsers.expat.ExpatError) as error:

1581

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

1582

exc_info=error)

1583

return xmlstring

1584

1585

1051

1586

def datetime_to_dbus(dt, variant_level=0):

1052

1587

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

1053

1588

if dt is None:

1054

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

1055

return dbus.String(dt.isoformat(),

1056

variant_level=variant_level)

1589

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

1590

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

1057

1591

1058

1592

1059

1593

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1061

1595

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

1062

1596

interface names according to the "alt_interface_names" mapping.

1063

1597

Usage:

1064

1598

1065

1599

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

1066

1600

"net.example.AlternateInterface"})

1067

1601

class SampleDBusObject(dbus.service.Object):

1068

1602

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

1069

1603

def SampleDBusMethod():

1070

1604

pass

1071

1605

1072

1606

The above "SampleDBusMethod" on "SampleDBusObject" will be

1073

1607

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

1074

1608

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

1075

1609

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

1076

1610

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

1077

1611

1078

1612

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

1079

1613

(from DBusObjectWithProperties) and interfaces (from the

1080

1614

dbus_interface_annotations decorator).

1081

1615

"""

1616

1082

1617

def wrapper(cls):

1083

1618

for orig_interface_name, alt_interface_name in (

1084

alt_interface_names.iteritems()):

1619

alt_interface_names.items()):

1085

1620

attr = {}

1086

1621

interface_names = set()

1087

1622

# Go though all attributes of the class

1089

1624

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

1090

1625

# with the wrong interface name

1091

1626

if (not hasattr(attribute, "_dbus_interface")

1092

or not attribute._dbus_interface

1093

.startswith(orig_interface_name)):

1627

or not attribute._dbus_interface.startswith(

1628

orig_interface_name)):

1094

1629

continue

1095

1630

# Create an alternate D-Bus interface name based on

1096

1631

# the current name

1097

alt_interface = (attribute._dbus_interface

1098

.replace(orig_interface_name,

1099

alt_interface_name))

1632

alt_interface = attribute._dbus_interface.replace(

1633

orig_interface_name, alt_interface_name)

1100

1634

interface_names.add(alt_interface)

1101

1635

# Is this a D-Bus signal?

1102

1636

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

1103

1637

# Extract the original non-method undecorated

1104

1638

# function by black magic

1105

nonmethod_func = (dict(

1639

if sys.version_info.major == 2:

1640

nonmethod_func = (dict(

1106

1641

zip(attribute.func_code.co_freevars,

1107

attribute.__closure__))["func"]

1108

.cell_contents)

1642

attribute.__closure__))

1643

["func"].cell_contents)

1644

else:

1645

nonmethod_func = (dict(

1646

zip(attribute.__code__.co_freevars,

1647

attribute.__closure__))

1648

["func"].cell_contents)

1109

1649

# Create a new, but exactly alike, function

1110

1650

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

1111

1651

# with the alternate D-Bus interface name

1112

new_function = (dbus.service.signal

1113

(alt_interface,

1114

attribute._dbus_signature)

1115

(types.FunctionType(

1116

nonmethod_func.func_code,

1117

nonmethod_func.func_globals,

1118

nonmethod_func.func_name,

1119

nonmethod_func.func_defaults,

1120

nonmethod_func.func_closure)))

1652

new_function = copy_function(nonmethod_func)

1653

new_function = (dbus.service.signal(

1654

alt_interface,

1655

attribute._dbus_signature)(new_function))

1121

1656

# Copy annotations, if any

1122

1657

try:

1123

new_function._dbus_annotations = (

1124

dict(attribute._dbus_annotations))

1658

new_function._dbus_annotations = dict(

1659

attribute._dbus_annotations)

1125

1660

except AttributeError:

1126

1661

pass

1662

1127

1663

# Define a creator of a function to call both the

1128

1664

# original and alternate functions, so both the

1129

1665

# original and alternate signals gets sent when

1132

1668

"""This function is a scope container to pass

1133

1669

func1 and func2 to the "call_both" function

1134

1670

outside of its arguments"""

1671

1672

@functools.wraps(func2)

1135

1673

def call_both(*args, **kwargs):

1136

1674

"""This function will emit two D-Bus

1137

1675

signals by calling func1 and func2"""

1138

1676

func1(*args, **kwargs)

1139

1677

func2(*args, **kwargs)

1678

# Make wrapper function look like a D-Bus

1679

# signal

1680

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

1681

if name.startswith("_dbus_"):

1682

setattr(call_both, name, attr)

1683

1140

1684

return call_both

1141

1685

# Create the "call_both" function and add it to

1142

1686

# the class

1147

1691

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

1148

1692

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

1149

1693

# to the class.

1150

attr[attrname] = (dbus.service.method

1151

(alt_interface,

1152

attribute._dbus_in_signature,

1153

attribute._dbus_out_signature)

1154

(types.FunctionType

1155

(attribute.func_code,

1156

attribute.func_globals,

1157

attribute.func_name,

1158

attribute.func_defaults,

1159

attribute.func_closure)))

1694

attr[attrname] = (

1695

dbus.service.method(

1696

alt_interface,

1697

attribute._dbus_in_signature,

1698

attribute._dbus_out_signature)

1699

(copy_function(attribute)))

1160

1700

# Copy annotations, if any

1161

1701

try:

1162

attr[attrname]._dbus_annotations = (

1163

dict(attribute._dbus_annotations))

1702

attr[attrname]._dbus_annotations = dict(

1703

attribute._dbus_annotations)

1164

1704

except AttributeError:

1165

1705

pass

1166

1706

# Is this a D-Bus property?

1169

1709

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

1170

1710

# property with the alternate D-Bus interface

1171

1711

# name. Add it to the class.

1172

attr[attrname] = (dbus_service_property

1173

(alt_interface,

1174

attribute._dbus_signature,

1175

attribute._dbus_access,

1176

attribute

1177

._dbus_get_args_options

1178

["byte_arrays"])

1179

(types.FunctionType

1180

(attribute.func_code,

1181

attribute.func_globals,

1182

attribute.func_name,

1183

attribute.func_defaults,

1184

attribute.func_closure)))

1712

attr[attrname] = (dbus_service_property(

1713

alt_interface, attribute._dbus_signature,

1714

attribute._dbus_access,

1715

attribute._dbus_get_args_options

1716

["byte_arrays"])

1717

(copy_function(attribute)))

1185

1718

# Copy annotations, if any

1186

1719

try:

1187

attr[attrname]._dbus_annotations = (

1188

dict(attribute._dbus_annotations))

1720

attr[attrname]._dbus_annotations = dict(

1721

attribute._dbus_annotations)

1189

1722

except AttributeError:

1190

1723

pass

1191

1724

# Is this a D-Bus interface?

1194

1727

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

1195

1728

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

1196

1729

# to the class.

1197

attr[attrname] = (dbus_interface_annotations

1198

(alt_interface)

1199

(types.FunctionType

1200

(attribute.func_code,

1201

attribute.func_globals,

1202

attribute.func_name,

1203

attribute.func_defaults,

1204

attribute.func_closure)))

1730

attr[attrname] = (

1731

dbus_interface_annotations(alt_interface)

1732

(copy_function(attribute)))

1205

1733

if deprecate:

1206

1734

# Deprecate all alternate interfaces

1207

iname="_AlternateDBusNames_interface_annotation{0}"

1735

iname = "_AlternateDBusNames_interface_annotation{}"

1208

1736

for interface_name in interface_names:

1737

1209

1738

@dbus_interface_annotations(interface_name)

1210

1739

def func(self):

1211

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

1212

"true" }

1740

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

1741

"true"}

1213

1742

# Find an unused name

1214

1743

for aname in (iname.format(i)

1215

1744

for i in itertools.count()):

1219

1748

if interface_names:

1220

1749

# Replace the class with a new subclass of it with

1221

1750

# methods, signals, etc. as created above.

1222

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

1223

(cls,), attr)

1751

if sys.version_info.major == 2:

1752

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

1753

(cls, ), attr)

1754

else:

1755

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

1756

(cls, ), attr)

1224

1757

return cls

1758

1225

1759

return wrapper

1226

1760

1227

1761

1228

1762

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

1229

"se.bsnet.fukt.Mandos"})

1763

"se.bsnet.fukt.Mandos"})

1230

1764

class ClientDBus(Client, DBusObjectWithProperties):

1231

1765

"""A Client class using D-Bus

1232

1766

1233

1767

Attributes:

1234

1768

dbus_object_path: dbus.ObjectPath

1235

1769

bus: dbus.SystemBus()

1236

1770

"""

1237

1771

1238

1772

runtime_expansions = (Client.runtime_expansions

1239

+ ("dbus_object_path",))

1240

1773

+ ("dbus_object_path", ))

1774

1775

_interface = "se.recompile.Mandos.Client"

1776

1241

1777

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

1242

1243

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

1778

1779

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

1244

1780

self.bus = bus

1245

1781

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

1246

1782

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

1247

1783

# the D-Bus

1248

client_object_name = unicode(self.name).translate(

1784

client_object_name = str(self.name).translate(

1249

1785

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

1250

1786

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

1251

self.dbus_object_path = (dbus.ObjectPath

1252

("/clients/" + client_object_name))

1787

self.dbus_object_path = dbus.ObjectPath(

1788

"/clients/" + client_object_name)

1253

1789

DBusObjectWithProperties.__init__(self, self.bus,

1254

1790

self.dbus_object_path)

1255

1256

def notifychangeproperty(transform_func,

1257

dbus_name, type_func=lambda x: x,

1258

variant_level=1):

1791

1792

def notifychangeproperty(transform_func, dbus_name,

1793

type_func=lambda x: x,

1794

variant_level=1,

1795

invalidate_only=False,

1796

_interface=_interface):

1259

1797

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

1260

1798

its changes to DBus.

1261

1799

1262

1800

transform_fun: Function that takes a value and a variant_level

1263

1801

and transforms it to a D-Bus type.

1264

1802

dbus_name: D-Bus name of the variable

1266

1804

to the D-Bus. Default: no transform

1267

1805

variant_level: D-Bus variant level. Default: 1

1268

1806

"""

1269

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

1807

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

1808

1270

1809

def setter(self, value):

1271

1810

if hasattr(self, "dbus_object_path"):

1272

1811

if (not hasattr(self, attrname) or

1273

1812

type_func(getattr(self, attrname, None))

1274

1813

!= type_func(value)):

1275

dbus_value = transform_func(type_func(value),

1276

variant_level

1277

=variant_level)

1278

self.PropertyChanged(dbus.String(dbus_name),

1279

dbus_value)

1814

if invalidate_only:

1815

self.PropertiesChanged(

1816

_interface, dbus.Dictionary(),

1817

dbus.Array((dbus_name, )))

1818

else:

1819

dbus_value = transform_func(

1820

type_func(value),

1821

variant_level=variant_level)

1822

self.PropertyChanged(dbus.String(dbus_name),

1823

dbus_value)

1824

self.PropertiesChanged(

1825

_interface,

1826

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

1827

dbus_value}),

1828

dbus.Array())

1280

1829

setattr(self, attrname, value)

1281

1830

1282

1831

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

1283

1832

1284

1833

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1285

1834

approvals_pending = notifychangeproperty(dbus.Boolean,

1286

1835

"ApprovalPending",

1287

type_func = bool)

1836

type_func=bool)

1288

1837

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

1289

1838

last_enabled = notifychangeproperty(datetime_to_dbus,

1290

1839

"LastEnabled")

1291

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

1292

type_func = lambda checker:

1293

checker is not None)

1840

checker = notifychangeproperty(

1841

dbus.Boolean, "CheckerRunning",

1842

type_func=lambda checker: checker is not None)

1294

1843

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1295

1844

"LastCheckedOK")

1296

1845

last_checker_status = notifychangeproperty(dbus.Int16,

1299

1848

datetime_to_dbus, "LastApprovalRequest")

1300

1849

approved_by_default = notifychangeproperty(dbus.Boolean,

1301

1850

"ApprovedByDefault")

1302

approval_delay = notifychangeproperty(dbus.UInt64,

1303

"ApprovalDelay",

1304

type_func =

1305

timedelta_to_milliseconds)

1851

approval_delay = notifychangeproperty(

1852

dbus.UInt64, "ApprovalDelay",

1853

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

1306

1854

approval_duration = notifychangeproperty(

1307

1855

dbus.UInt64, "ApprovalDuration",

1308

type_func = timedelta_to_milliseconds)

1856

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

1309

1857

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

1310

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

1311

type_func =

1312

timedelta_to_milliseconds)

1858

timeout = notifychangeproperty(

1859

dbus.UInt64, "Timeout",

1860

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

1313

1861

extended_timeout = notifychangeproperty(

1314

1862

dbus.UInt64, "ExtendedTimeout",

1315

type_func = timedelta_to_milliseconds)

1316

interval = notifychangeproperty(dbus.UInt64,

1317

"Interval",

1318

type_func =

1319

timedelta_to_milliseconds)

1863

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

1864

interval = notifychangeproperty(

1865

dbus.UInt64, "Interval",

1866

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

1320

1867

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

1321

1868

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

1869

invalidate_only=True)

1870

1322

1871

del notifychangeproperty

1323

1872

1324

1873

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

1325

1874

try:

1326

1875

self.remove_from_connection()

1329

1878

if hasattr(DBusObjectWithProperties, "__del__"):

1330

1879

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

1331

1880

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

1332

1333

def checker_callback(self, pid, condition, command,

1334

*args, **kwargs):

1335

self.checker_callback_tag = None

1336

self.checker = None

1337

if os.WIFEXITED(condition):

1338

exitstatus = os.WEXITSTATUS(condition)

1881

1882

def checker_callback(self, source, condition,

1883

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

1884

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

1885

connection, command, *args,

1886

**kwargs)

1887

exitstatus = self.last_checker_status

1888

if exitstatus >= 0:

1339

1889

# Emit D-Bus signal

1340

1890

self.CheckerCompleted(dbus.Int16(exitstatus),

1341

dbus.Int64(condition),

1891

# This is specific to GNU libC

1892

dbus.Int64(exitstatus << 8),

1342

1893

dbus.String(command))

1343

1894

else:

1344

1895

# Emit D-Bus signal

1345

1896

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

1346

dbus.Int64(condition),

1897

dbus.Int64(

1898

# This is specific to GNU libC

1899

(exitstatus << 8)

1900

| self.last_checker_signal),

1347

1901

dbus.String(command))

1348

1349

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

1350

*args, **kwargs)

1351

1902

return ret

1903

1352

1904

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

1353

old_checker = self.checker

1354

if self.checker is not None:

1355

old_checker_pid = self.checker.pid

1356

else:

1357

old_checker_pid = None

1905

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

1358

1906

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

1359

1907

# Only if new checker process was started

1360

1908

if (self.checker is not None

1362

1910

# Emit D-Bus signal

1363

1911

self.CheckerStarted(self.current_checker_command)

1364

1912

return r

1365

1913

1366

1914

def _reset_approved(self):

1367

1915

self.approved = None

1368

1916

return False

1369

1917

1370

1918

def approve(self, value=True):

1371

1919

self.approved = value

1372

gobject.timeout_add(timedelta_to_milliseconds

1373

(self.approval_duration),

1374

self._reset_approved)

1920

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

1921

* 1000), self._reset_approved)

1375

1922

self.send_changedstate()

1376

1377

## D-Bus methods, signals & properties

1378

_interface = "se.recompile.Mandos.Client"

1379

1380

## Interfaces

1381

1382

@dbus_interface_annotations(_interface)

1383

def _foo(self):

1384

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

1385

"false"}

1386

1387

## Signals

1388

1923

1924

# D-Bus methods, signals & properties

1925

1926

# Interfaces

1927

1928

# Signals

1929

1389

1930

# CheckerCompleted - signal

1390

1931

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

1391

1932

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

1392

1933

"D-Bus signal"

1393

1934

pass

1394

1935

1395

1936

# CheckerStarted - signal

1396

1937

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

1397

1938

def CheckerStarted(self, command):

1398

1939

"D-Bus signal"

1399

1940

pass

1400

1941

1401

1942

# PropertyChanged - signal

1943

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

1402

1944

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

1403

1945

def PropertyChanged(self, property, value):

1404

1946

"D-Bus signal"

1405

1947

pass

1406

1948

1407

1949

# GotSecret - signal

1408

1950

@dbus.service.signal(_interface)

1409

1951

def GotSecret(self):

1412

1954

server to mandos-client

1413

1955

"""

1414

1956

pass

1415

1957

1416

1958

# Rejected - signal

1417

1959

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

1418

1960

def Rejected(self, reason):

1419

1961

"D-Bus signal"

1420

1962

pass

1421

1963

1422

1964

# NeedApproval - signal

1423

1965

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

1424

1966

def NeedApproval(self, timeout, default):

1425

1967

"D-Bus signal"

1426

1968

return self.need_approval()

1427

1428

## Methods

1429

1969

1970

# Methods

1971

1430

1972

# Approve - method

1431

1973

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

1432

1974

def Approve(self, value):

1433

1975

self.approve(value)

1434

1976

1435

1977

# CheckedOK - method

1436

1978

@dbus.service.method(_interface)

1437

1979

def CheckedOK(self):

1438

1980

self.checked_ok()

1439

1981

1440

1982

# Enable - method

1983

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

1441

1984

@dbus.service.method(_interface)

1442

1985

def Enable(self):

1443

1986

"D-Bus method"

1444

1987

self.enable()

1445

1988

1446

1989

# StartChecker - method

1990

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

1447

1991

@dbus.service.method(_interface)

1448

1992

def StartChecker(self):

1449

1993

"D-Bus method"

1450

1994

self.start_checker()

1451

1995

1452

1996

# Disable - method

1997

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

1453

1998

@dbus.service.method(_interface)

1454

1999

def Disable(self):

1455

2000

"D-Bus method"

1456

2001

self.disable()

1457

2002

1458

2003

# StopChecker - method

2004

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

1459

2005

@dbus.service.method(_interface)

1460

2006

def StopChecker(self):

1461

2007

self.stop_checker()

1462

1463

## Properties

1464

2008

2009

# Properties

2010

1465

2011

# ApprovalPending - property

1466

2012

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

1467

2013

def ApprovalPending_dbus_property(self):

1468

2014

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

1469

2015

1470

2016

# ApprovedByDefault - property

1471

@dbus_service_property(_interface, signature="b",

2017

@dbus_service_property(_interface,

2018

signature="b",

1472

2019

access="readwrite")

1473

2020

def ApprovedByDefault_dbus_property(self, value=None):

1474

2021

if value is None: # get

1475

2022

return dbus.Boolean(self.approved_by_default)

1476

2023

self.approved_by_default = bool(value)

1477

2024

1478

2025

# ApprovalDelay - property

1479

@dbus_service_property(_interface, signature="t",

2026

@dbus_service_property(_interface,

2027

signature="t",

1480

2028

access="readwrite")

1481

2029

def ApprovalDelay_dbus_property(self, value=None):

1482

2030

if value is None: # get

1483

return dbus.UInt64(self.approval_delay_milliseconds())

2031

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

2032

* 1000)

1484

2033

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

1485

2034

1486

2035

# ApprovalDuration - property

1487

@dbus_service_property(_interface, signature="t",

2036

@dbus_service_property(_interface,

2037

signature="t",

1488

2038

access="readwrite")

1489

2039

def ApprovalDuration_dbus_property(self, value=None):

1490

2040

if value is None: # get

1491

return dbus.UInt64(timedelta_to_milliseconds(

1492

self.approval_duration))

2041

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

2042

* 1000)

1493

2043

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

1494

2044

1495

2045

# Name - property

2046

@dbus_annotations(

2047

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

1496

2048

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

1497

2049

def Name_dbus_property(self):

1498

2050

return dbus.String(self.name)

1499

2051

2052

# KeyID - property

2053

@dbus_annotations(

2054

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

2055

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

2056

def KeyID_dbus_property(self):

2057

return dbus.String(self.key_id)

2058

1500

2059

# Fingerprint - property

2060

@dbus_annotations(

2061

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

1501

2062

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

1502

2063

def Fingerprint_dbus_property(self):

1503

2064

return dbus.String(self.fingerprint)

1504

2065

1505

2066

# Host - property

1506

@dbus_service_property(_interface, signature="s",

2067

@dbus_service_property(_interface,

2068

signature="s",

1507

2069

access="readwrite")

1508

2070

def Host_dbus_property(self, value=None):

1509

2071

if value is None: # get

1510

2072

return dbus.String(self.host)

1511

self.host = unicode(value)

1512

2073

self.host = str(value)

2074

1513

2075

# Created - property

2076

@dbus_annotations(

2077

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

1514

2078

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

1515

2079

def Created_dbus_property(self):

1516

2080

return datetime_to_dbus(self.created)

1517

2081

1518

2082

# LastEnabled - property

1519

2083

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

1520

2084

def LastEnabled_dbus_property(self):

1521

2085

return datetime_to_dbus(self.last_enabled)

1522

2086

1523

2087

# Enabled - property

1524

@dbus_service_property(_interface, signature="b",

2088

@dbus_service_property(_interface,

2089

signature="b",

1525

2090

access="readwrite")

1526

2091

def Enabled_dbus_property(self, value=None):

1527

2092

if value is None: # get

1530

2095

self.enable()

1531

2096

else:

1532

2097

self.disable()

1533

2098

1534

2099

# LastCheckedOK - property

1535

@dbus_service_property(_interface, signature="s",

2100

@dbus_service_property(_interface,

2101

signature="s",

1536

2102

access="readwrite")

1537

2103

def LastCheckedOK_dbus_property(self, value=None):

1538

2104

if value is not None:

1539

2105

self.checked_ok()

1540

2106

return

1541

2107

return datetime_to_dbus(self.last_checked_ok)

1542

2108

1543

2109

# LastCheckerStatus - property

1544

@dbus_service_property(_interface, signature="n",

1545

access="read")

2110

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

1546

2111

def LastCheckerStatus_dbus_property(self):

1547

2112

return dbus.Int16(self.last_checker_status)

1548

2113

1549

2114

# Expires - property

1550

2115

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

1551

2116

def Expires_dbus_property(self):

1552

2117

return datetime_to_dbus(self.expires)

1553

2118

1554

2119

# LastApprovalRequest - property

1555

2120

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

1556

2121

def LastApprovalRequest_dbus_property(self):

1557

2122

return datetime_to_dbus(self.last_approval_request)

1558

2123

1559

2124

# Timeout - property

1560

@dbus_service_property(_interface, signature="t",

2125

@dbus_service_property(_interface,

2126

signature="t",

1561

2127

access="readwrite")

1562

2128

def Timeout_dbus_property(self, value=None):

1563

2129

if value is None: # get

1564

return dbus.UInt64(self.timeout_milliseconds())

2130

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

1565

2131

old_timeout = self.timeout

1566

2132

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

1567

2133

# Reschedule disabling

1575

2141

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

1576

2142

is None):

1577

2143

return

1578

gobject.source_remove(self.disable_initiator_tag)

1579

self.disable_initiator_tag = (

1580

gobject.timeout_add(

1581

timedelta_to_milliseconds(self.expires - now),

1582

self.disable))

1583

2144

GLib.source_remove(self.disable_initiator_tag)

2145

self.disable_initiator_tag = GLib.timeout_add(

2146

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

2147

self.disable)

2148

1584

2149

# ExtendedTimeout - property

1585

@dbus_service_property(_interface, signature="t",

2150

@dbus_service_property(_interface,

2151

signature="t",

1586

2152

access="readwrite")

1587

2153

def ExtendedTimeout_dbus_property(self, value=None):

1588

2154

if value is None: # get

1589

return dbus.UInt64(self.extended_timeout_milliseconds())

2155

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

2156

* 1000)

1590

2157

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

1591

2158

1592

2159

# Interval - property

1593

@dbus_service_property(_interface, signature="t",

2160

@dbus_service_property(_interface,

2161

signature="t",

1594

2162

access="readwrite")

1595

2163

def Interval_dbus_property(self, value=None):

1596

2164

if value is None: # get

1597

return dbus.UInt64(self.interval_milliseconds())

2165

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

1598

2166

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

1599

2167

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

1600

2168

return

1601

2169

if self.enabled:

1602

2170

# Reschedule checker run

1603

gobject.source_remove(self.checker_initiator_tag)

1604

self.checker_initiator_tag = (gobject.timeout_add

1605

(value, self.start_checker))

1606

self.start_checker() # Start one now, too

1607

2171

GLib.source_remove(self.checker_initiator_tag)

2172

self.checker_initiator_tag = GLib.timeout_add(

2173

value, self.start_checker)

2174

self.start_checker() # Start one now, too

2175

1608

2176

# Checker - property

1609

@dbus_service_property(_interface, signature="s",

2177

@dbus_service_property(_interface,

2178

signature="s",

1610

2179

access="readwrite")

1611

2180

def Checker_dbus_property(self, value=None):

1612

2181

if value is None: # get

1613

2182

return dbus.String(self.checker_command)

1614

self.checker_command = unicode(value)

1615

2183

self.checker_command = str(value)

2184

1616

2185

# CheckerRunning - property

1617

@dbus_service_property(_interface, signature="b",

2186

@dbus_service_property(_interface,

2187

signature="b",

1618

2188

access="readwrite")

1619

2189

def CheckerRunning_dbus_property(self, value=None):

1620

2190

if value is None: # get

1623

2193

self.start_checker()

1624

2194

else:

1625

2195

self.stop_checker()

1626

2196

1627

2197

# ObjectPath - property

2198

@dbus_annotations(

2199

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

2200

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

1628

2201

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

1629

2202

def ObjectPath_dbus_property(self):

1630

return self.dbus_object_path # is already a dbus.ObjectPath

1631

2203

return self.dbus_object_path # is already a dbus.ObjectPath

2204

1632

2205

# Secret = property

1633

@dbus_service_property(_interface, signature="ay",

1634

access="write", byte_arrays=True)

2206

@dbus_annotations(

2207

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

2208

"invalidates"})

2209

@dbus_service_property(_interface,

2210

signature="ay",

2211

access="write",

2212

byte_arrays=True)

1635

2213

def Secret_dbus_property(self, value):

1636

self.secret = str(value)

1637

2214

self.secret = bytes(value)

2215

1638

2216

del _interface

1639

2217

1640

2218

1641

class ProxyClient(object):

1642

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

2219

class ProxyClient:

2220

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

1643

2221

self._pipe = child_pipe

1644

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

2222

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

1645

2223

if not self._pipe.recv():

1646

raise KeyError()

1647

2224

raise KeyError(key_id or fpr)

2225

1648

2226

def __getattribute__(self, name):

1649

2227

if name == '_pipe':

1650

2228

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

1653

2231

if data[0] == 'data':

1654

2232

return data[1]

1655

2233

if data[0] == 'function':

2234

1656

2235

def func(*args, **kwargs):

1657

2236

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

1658

2237

return self._pipe.recv()[1]

2238

1659

2239

return func

1660

2240

1661

2241

def __setattr__(self, name, value):

1662

2242

if name == '_pipe':

1663

2243

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

1666

2246

1667

2247

class ClientHandler(socketserver.BaseRequestHandler, object):

1668

2248

"""A class to handle client connections.

1669

2249

1670

2250

Instantiated once for each connection to handle it.

1671

2251

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

1672

2252

1673

2253

def handle(self):

1674

2254

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

1675

2255

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

1676

unicode(self.client_address))

2256

str(self.client_address))

1677

2257

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

1678

2258

self.server.child_pipe.fileno())

1679

1680

session = (gnutls.connection

1681

.ClientSession(self.request,

1682

gnutls.connection

1683

.X509Credentials()))

1684

1685

# Note: gnutls.connection.X509Credentials is really a

1686

# generic GnuTLS certificate credentials object so long as

1687

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

1688

# here despite using OpenPGP certificates.

1689

1690

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

1691

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

1692

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

1693

# "+DHE-DSS"))

2259

2260

session = gnutls.ClientSession(self.request)

2261

2262

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

2263

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

2264

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

2265

# "+DHE-DSS"))

1694

2266

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

1695

2267

priority = self.server.gnutls_priority

1696

2268

if priority is None:

1697

2269

priority = "NORMAL"

1698

(gnutls.library.functions

1699

.gnutls_priority_set_direct(session._c_object,

1700

priority, None))

1701

2270

gnutls.priority_set_direct(session._c_object,

2271

priority.encode("utf-8"),

2272

None)

2273

1702

2274

# Start communication using the Mandos protocol

1703

2275

# Get protocol number

1704

2276

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

1709

2281

except (ValueError, IndexError, RuntimeError) as error:

1710

2282

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

1711

2283

return

1712

2284

1713

2285

# Start GnuTLS connection

1714

2286

try:

1715

2287

session.handshake()

1716

except gnutls.errors.GNUTLSError as error:

2288

except gnutls.Error as error:

1717

2289

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

1718

2290

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

1719

2291

# established. Just abandon the request.

1720

2292

return

1721

2293

logger.debug("Handshake succeeded")

1722

2294

1723

2295

approval_required = False

1724

2296

try:

1725

try:

1726

fpr = self.fingerprint(self.peer_certificate

1727

(session))

1728

except (TypeError,

1729

gnutls.errors.GNUTLSError) as error:

1730

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

1731

return

1732

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

1733

1734

try:

1735

client = ProxyClient(child_pipe, fpr,

2297

if gnutls.has_rawpk:

2298

fpr = b""

2299

try:

2300

key_id = self.key_id(

2301

self.peer_certificate(session))

2302

except (TypeError, gnutls.Error) as error:

2303

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

2304

return

2305

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

2306

2307

else:

2308

key_id = b""

2309

try:

2310

fpr = self.fingerprint(

2311

self.peer_certificate(session))

2312

except (TypeError, gnutls.Error) as error:

2313

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

2314

return

2315

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

2316

2317

try:

2318

client = ProxyClient(child_pipe, key_id, fpr,

1736

2319

self.client_address)

1737

2320

except KeyError:

1738

2321

return

1739

2322

1740

2323

if client.approval_delay:

1741

2324

delay = client.approval_delay

1742

2325

client.approvals_pending += 1

1743

2326

approval_required = True

1744

2327

1745

2328

while True:

1746

2329

if not client.enabled:

1747

2330

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

1748

client.name)

2331

client.name)

1749

2332

if self.server.use_dbus:

1750

2333

# Emit D-Bus signal

1751

2334

client.Rejected("Disabled")

1752

2335

return

1753

2336

1754

2337

if client.approved or not client.approval_delay:

1755

#We are approved or approval is disabled

2338

# We are approved or approval is disabled

1756

2339

break

1757

2340

elif client.approved is None:

1758

2341

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

1760

2343

if self.server.use_dbus:

1761

2344

# Emit D-Bus signal

1762

2345

client.NeedApproval(

1763

client.approval_delay_milliseconds(),

1764

client.approved_by_default)

2346

client.approval_delay.total_seconds()

2347

* 1000, client.approved_by_default)

1765

2348

else:

1766

2349

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

1767

2350

client.name)

1769

2352

# Emit D-Bus signal

1770

2353

client.Rejected("Denied")

1771

2354

return

1772

1773

#wait until timeout or approved

2355

2356

# wait until timeout or approved

1774

2357

time = datetime.datetime.now()

1775

2358

client.changedstate.acquire()

1776

client.changedstate.wait(

1777

float(timedelta_to_milliseconds(delay)

1778

/ 1000))

2359

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

1779

2360

client.changedstate.release()

1780

2361

time2 = datetime.datetime.now()

1781

2362

if (time2 - time) >= delay:

1791

2372

break

1792

2373

else:

1793

2374

delay -= time2 - time

1794

1795

sent_size = 0

1796

while sent_size < len(client.secret):

1797

try:

1798

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

1799

except gnutls.errors.GNUTLSError as error:

1800

logger.warning("gnutls send failed",

1801

exc_info=error)

1802

return

1803

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

1804

sent, len(client.secret)

1805

- (sent_size + sent))

1806

sent_size += sent

1807

2375

2376

try:

2377

session.send(client.secret)

2378

except gnutls.Error as error:

2379

logger.warning("gnutls send failed",

2380

exc_info=error)

2381

return

2382

1808

2383

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

1809

2384

# bump the timeout using extended_timeout

1810

2385

client.bump_timeout(client.extended_timeout)

1811

2386

if self.server.use_dbus:

1812

2387

# Emit D-Bus signal

1813

2388

client.GotSecret()

1814

2389

1815

2390

finally:

1816

2391

if approval_required:

1817

2392

client.approvals_pending -= 1

1818

2393

try:

1819

2394

session.bye()

1820

except gnutls.errors.GNUTLSError as error:

2395

except gnutls.Error as error:

1821

2396

logger.warning("GnuTLS bye failed",

1822

2397

exc_info=error)

1823

2398

1824

2399

@staticmethod

1825

2400

def peer_certificate(session):

1826

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

1827

# If not an OpenPGP certificate...

1828

if (gnutls.library.functions

1829

.gnutls_certificate_type_get(session._c_object)

1830

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1831

# ...do the normal thing

1832

return session.peer_certificate

2401

"Return the peer's certificate as a bytestring"

2402

try:

2403

cert_type = gnutls.certificate_type_get2(session._c_object,

2404

gnutls.CTYPE_PEERS)

2405

except AttributeError:

2406

cert_type = gnutls.certificate_type_get(session._c_object)

2407

if gnutls.has_rawpk:

2408

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2409

else:

2410

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2411

# If not a valid certificate type...

2412

if cert_type not in valid_cert_types:

2413

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

2414

valid_cert_types)

2415

# ...return invalid data

2416

return b""

1833

2417

list_size = ctypes.c_uint(1)

1834

cert_list = (gnutls.library.functions

1835

.gnutls_certificate_get_peers

2418

cert_list = (gnutls.certificate_get_peers

1836

2419

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

1837

2420

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

1838

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

1839

" certificate")

2421

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

1840

2422

if list_size.value == 0:

1841

2423

return None

1842

2424

cert = cert_list[0]

1843

2425

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

1844

2426

2427

@staticmethod

2428

def key_id(certificate):

2429

"Convert a certificate bytestring to a hexdigit key ID"

2430

# New GnuTLS "datum" with the public key

2431

datum = gnutls.datum_t(

2432

ctypes.cast(ctypes.c_char_p(certificate),

2433

ctypes.POINTER(ctypes.c_ubyte)),

2434

ctypes.c_uint(len(certificate)))

2435

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

2436

# New empty GnuTLS certificate

2437

pubkey = gnutls.pubkey_t()

2438

gnutls.pubkey_init(ctypes.byref(pubkey))

2439

# Import the raw public key into the certificate

2440

gnutls.pubkey_import(pubkey,

2441

ctypes.byref(datum),

2442

gnutls.X509_FMT_DER)

2443

# New buffer for the key ID

2444

buf = ctypes.create_string_buffer(32)

2445

buf_len = ctypes.c_size_t(len(buf))

2446

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

2447

gnutls.pubkey_get_key_id(pubkey,

2448

gnutls.KEYID_USE_SHA256,

2449

ctypes.cast(ctypes.byref(buf),

2450

ctypes.POINTER(ctypes.c_ubyte)),

2451

ctypes.byref(buf_len))

2452

# Deinit the certificate

2453

gnutls.pubkey_deinit(pubkey)

2454

2455

# Convert the buffer to a Python bytestring

2456

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

2457

# Convert the bytestring to hexadecimal notation

2458

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

2459

return hex_key_id

2460

1845

2461

@staticmethod

1846

2462

def fingerprint(openpgp):

1847

2463

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1848

2464

# New GnuTLS "datum" with the OpenPGP public key

1849

datum = (gnutls.library.types

1850

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

1851

ctypes.POINTER

1852

(ctypes.c_ubyte)),

1853

ctypes.c_uint(len(openpgp))))

2465

datum = gnutls.datum_t(

2466

ctypes.cast(ctypes.c_char_p(openpgp),

2467

ctypes.POINTER(ctypes.c_ubyte)),

2468

ctypes.c_uint(len(openpgp)))

1854

2469

# New empty GnuTLS certificate

1855

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2470

crt = gnutls.openpgp_crt_t()

2471

gnutls.openpgp_crt_init(ctypes.byref(crt))

1858

2472

# Import the OpenPGP public key into the certificate

1859

(gnutls.library.functions

1860

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

1861

gnutls.library.constants

1862

.GNUTLS_OPENPGP_FMT_RAW))

2473

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

2474

gnutls.OPENPGP_FMT_RAW)

1863

2475

# Verify the self signature in the key

1864

2476

crtverify = ctypes.c_uint()

1865

(gnutls.library.functions

1866

.gnutls_openpgp_crt_verify_self(crt, 0,

1867

ctypes.byref(crtverify)))

2477

gnutls.openpgp_crt_verify_self(crt, 0,

2478

ctypes.byref(crtverify))

1868

2479

if crtverify.value != 0:

1869

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1870

raise (gnutls.errors.CertificateSecurityError

1871

("Verify failed"))

2480

gnutls.openpgp_crt_deinit(crt)

2481

raise gnutls.CertificateSecurityError(code

2482

=crtverify.value)

1872

2483

# New buffer for the fingerprint

1873

2484

buf = ctypes.create_string_buffer(20)

1874

2485

buf_len = ctypes.c_size_t()

1875

2486

# Get the fingerprint from the certificate into the buffer

1876

(gnutls.library.functions

1877

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

1878

ctypes.byref(buf_len)))

2487

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

2488

ctypes.byref(buf_len))

1879

2489

# Deinit the certificate

1880

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2490

gnutls.openpgp_crt_deinit(crt)

1881

2491

# Convert the buffer to a Python bytestring

1882

2492

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

1883

2493

# Convert the bytestring to hexadecimal notation

1885

2495

return hex_fpr

1886

2496

1887

2497

1888

class MultiprocessingMixIn(object):

2498

class MultiprocessingMixIn:

1889

2499

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

2500

1890

2501

def sub_process_main(self, request, address):

1891

2502

try:

1892

2503

self.finish_request(request, address)

1893

2504

except Exception:

1894

2505

self.handle_error(request, address)

1895

2506

self.close_request(request)

1896

2507

1897

2508

def process_request(self, request, address):

1898

2509

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

1899

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

1900

args = (request, address))

2510

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

2511

args=(request, address))

1901

2512

proc.start()

1902

2513

return proc

1903

2514

1904

2515

1905

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2516

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1906

2517

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

2518

1907

2519

def process_request(self, request, client_address):

1908

2520

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

1909

2521

1910

2522

This function creates a new pipe in self.pipe

1911

2523

"""

1912

2524

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1913

2525

1914

2526

proc = MultiprocessingMixIn.process_request(self, request,

1915

2527

client_address)

1916

2528

self.child_pipe.close()

1917

2529

self.add_pipe(parent_pipe, proc)

1918

2530

1919

2531

def add_pipe(self, parent_pipe, proc):

1920

2532

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

1921

2533

raise NotImplementedError()

1922

2534

1923

2535

1924

2536

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1925

socketserver.TCPServer, object):

2537

socketserver.TCPServer):

1926

2538

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

1927

2539

1928

2540

Attributes:

1929

2541

enabled: Boolean; whether this server is activated yet

1930

2542

interface: None or a network interface name (string)

1931

2543

use_ipv6: Boolean; to use IPv6 or not

1932

2544

"""

2545

1933

2546

def __init__(self, server_address, RequestHandlerClass,

1934

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

2547

interface=None,

2548

use_ipv6=True,

2549

socketfd=None):

1935

2550

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

1936

2551

creating a new one with socket.socket().

1937

2552

"""

1943

2558

self.socketfd = socketfd

1944

2559

# Save the original socket.socket() function

1945

2560

self.socket_socket = socket.socket

2561

1946

2562

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

1947

#

2563

#

1948

2564

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

1949

2565

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

1950

2566

# patching socket.socket.)

1951

#

2567

#

1952

2568

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

1953

2569

@functools.wraps(socket.socket)

1954

2570

def socket_wrapper(*args, **kwargs):

1966

2582

# socket_wrapper(), if socketfd was set.

1967

2583

socketserver.TCPServer.__init__(self, server_address,

1968

2584

RequestHandlerClass)

1969

2585

1970

2586

def server_bind(self):

1971

2587

"""This overrides the normal server_bind() function

1972

2588

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

1973

2589

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

2590

global SO_BINDTODEVICE

1974

2591

if self.interface is not None:

1975

2592

if SO_BINDTODEVICE is None:

1976

logger.error("SO_BINDTODEVICE does not exist;"

1977

" cannot bind to interface %s",

1978

self.interface)

1979

else:

1980

try:

1981

self.socket.setsockopt(socket.SOL_SOCKET,

1982

SO_BINDTODEVICE,

1983

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

1984

except socket.error as error:

1985

if error.errno == errno.EPERM:

1986

logger.error("No permission to bind to"

1987

" interface %s", self.interface)

1988

elif error.errno == errno.ENOPROTOOPT:

1989

logger.error("SO_BINDTODEVICE not available;"

1990

" cannot bind to interface %s",

1991

self.interface)

1992

elif error.errno == errno.ENODEV:

1993

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

1994

" cannot bind", self.interface)

1995

else:

1996

raise

2593

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

2594

# common enough.

2595

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

2596

SO_BINDTODEVICE = 25

2597

try:

2598

self.socket.setsockopt(

2599

socket.SOL_SOCKET, SO_BINDTODEVICE,

2600

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

2601

except socket.error as error:

2602

if error.errno == errno.EPERM:

2603

logger.error("No permission to bind to"

2604

" interface %s", self.interface)

2605

elif error.errno == errno.ENOPROTOOPT:

2606

logger.error("SO_BINDTODEVICE not available;"

2607

" cannot bind to interface %s",

2608

self.interface)

2609

elif error.errno == errno.ENODEV:

2610

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

2611

" cannot bind", self.interface)

2612

else:

2613

raise

1997

2614

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

1998

2615

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

2616

if self.server_address[1]:

2617

self.allow_reuse_address = True

1999

2618

if not self.server_address[0]:

2000

2619

if self.address_family == socket.AF_INET6:

2001

any_address = "::" # in6addr_any

2620

any_address = "::" # in6addr_any

2002

2621

else:

2003

any_address = "0.0.0.0" # INADDR_ANY

2622

any_address = "0.0.0.0" # INADDR_ANY

2004

2623

self.server_address = (any_address,

2005

2624

self.server_address[1])

2006

2625

elif not self.server_address[1]:

2007

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

2008

0)

2626

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

2009

2627

# if self.interface:

2010

2628

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

2011

2629

# 0, # port

2017

2635

2018

2636

class MandosServer(IPv6_TCPServer):

2019

2637

"""Mandos server.

2020

2638

2021

2639

Attributes:

2022

2640

clients: set of Client objects

2023

2641

gnutls_priority GnuTLS priority string

2024

2642

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

2025

2026

Assumes a gobject.MainLoop event loop.

2643

2644

Assumes a GLib.MainLoop event loop.

2027

2645

"""

2646

2028

2647

def __init__(self, server_address, RequestHandlerClass,

2029

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

2030

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

2648

interface=None,

2649

use_ipv6=True,

2650

clients=None,

2651

gnutls_priority=None,

2652

use_dbus=True,

2653

socketfd=None):

2031

2654

self.enabled = False

2032

2655

self.clients = clients

2033

2656

if self.clients is None:

2036

2659

self.gnutls_priority = gnutls_priority

2037

2660

IPv6_TCPServer.__init__(self, server_address,

2038

2661

RequestHandlerClass,

2039

interface = interface,

2040

use_ipv6 = use_ipv6,

2041

socketfd = socketfd)

2662

interface=interface,

2663

use_ipv6=use_ipv6,

2664

socketfd=socketfd)

2665

2042

2666

def server_activate(self):

2043

2667

if self.enabled:

2044

2668

return socketserver.TCPServer.server_activate(self)

2045

2669

2046

2670

def enable(self):

2047

2671

self.enabled = True

2048

2672

2049

2673

def add_pipe(self, parent_pipe, proc):

2050

2674

# Call "handle_ipc" for both data and EOF events

2051

gobject.io_add_watch(parent_pipe.fileno(),

2052

gobject.IO_IN | gobject.IO_HUP,

2053

functools.partial(self.handle_ipc,

2054

parent_pipe =

2055

parent_pipe,

2056

proc = proc))

2057

2058

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

2059

proc = None, client_object=None):

2675

GLib.io_add_watch(

2676

parent_pipe.fileno(),

2677

GLib.IO_IN | GLib.IO_HUP,

2678

functools.partial(self.handle_ipc,

2679

parent_pipe=parent_pipe,

2680

proc=proc))

2681

2682

def handle_ipc(self, source, condition,

2683

parent_pipe=None,

2684

proc=None,

2685

client_object=None):

2060

2686

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

2061

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

2687

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

2062

2688

# Wait for other process to exit

2063

2689

proc.join()

2064

2690

return False

2065

2691

2066

2692

# Read a request from the child

2067

2693

request = parent_pipe.recv()

2068

2694

command = request[0]

2069

2695

2070

2696

if command == 'init':

2071

fpr = request[1]

2072

address = request[2]

2073

2074

for c in self.clients.itervalues():

2075

if c.fingerprint == fpr:

2697

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

2698

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

2699

address = request[3]

2700

2701

for c in self.clients.values():

2702

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2703

continue

2704

if key_id and c.key_id == key_id:

2705

client = c

2706

break

2707

if fpr and c.fingerprint == fpr:

2076

2708

client = c

2077

2709

break

2078

2710

else:

2079

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

2080

"dress: %s", fpr, address)

2711

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

2712

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

2081

2713

if self.use_dbus:

2082

2714

# Emit D-Bus signal

2083

mandos_dbus_service.ClientNotFound(fpr,

2715

mandos_dbus_service.ClientNotFound(key_id or fpr,

2084

2716

address[0])

2085

2717

parent_pipe.send(False)

2086

2718

return False

2087

2088

gobject.io_add_watch(parent_pipe.fileno(),

2089

gobject.IO_IN | gobject.IO_HUP,

2090

functools.partial(self.handle_ipc,

2091

parent_pipe =

2092

parent_pipe,

2093

proc = proc,

2094

client_object =

2095

client))

2719

2720

GLib.io_add_watch(

2721

parent_pipe.fileno(),

2722

GLib.IO_IN | GLib.IO_HUP,

2723

functools.partial(self.handle_ipc,

2724

parent_pipe=parent_pipe,

2725

proc=proc,

2726

client_object=client))

2096

2727

parent_pipe.send(True)

2097

2728

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

2098

2729

# same fileno

2101

2732

funcname = request[1]

2102

2733

args = request[2]

2103

2734

kwargs = request[3]

2104

2735

2105

2736

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

2106

2737

funcname)(*args,

2107

**kwargs)))

2108

2738

**kwargs)))

2739

2109

2740

if command == 'getattr':

2110

2741

attrname = request[1]

2111

if callable(client_object.__getattribute__(attrname)):

2112

parent_pipe.send(('function',))

2742

if isinstance(client_object.__getattribute__(attrname),

2743

collections.Callable):

2744

parent_pipe.send(('function', ))

2113

2745

else:

2114

parent_pipe.send(('data', client_object

2115

.__getattribute__(attrname)))

2116

2746

parent_pipe.send((

2747

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

2748

2117

2749

if command == 'setattr':

2118

2750

attrname = request[1]

2119

2751

value = request[2]

2120

2752

setattr(client_object, attrname, value)

2121

2753

2122

2754

return True

2123

2755

2124

2756

2125

2757

def rfc3339_duration_to_delta(duration):

2126

2758

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

2127

2759

2128

2760

>>> rfc3339_duration_to_delta("P7D")

2129

2761

datetime.timedelta(7)

2130

2762

>>> rfc3339_duration_to_delta("PT60S")

2140

2772

>>> rfc3339_duration_to_delta("P1DT3M20S")

2141

2773

datetime.timedelta(1, 200)

2142

2774

"""

2143

2775

2144

2776

# Parsing an RFC 3339 duration with regular expressions is not

2145

2777

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

2146

2778

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

2147

2779

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

2148

2780

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

2149

2781

# avoid excessive use of external libraries.

2150

2782

2151

2783

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

2152

Token = collections.namedtuple("Token",

2153

("regexp", # To match token; if

2154

# "value" is not None,

2155

# must have a "group"

2156

# containing digits

2157

"value", # datetime.timedelta or

2158

# None

2159

"followers")) # Tokens valid after

2160

# this token

2784

Token = collections.namedtuple("Token", (

2785

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

2786

# a "group" containing digits

2787

"value", # datetime.timedelta or None

2788

"followers")) # Tokens valid after this token

2161

2789

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

2162

2790

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

2163

2791

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

2164

2792

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

2165

2793

datetime.timedelta(seconds=1),

2166

frozenset((token_end,)))

2794

frozenset((token_end, )))

2167

2795

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

2168

2796

datetime.timedelta(minutes=1),

2169

2797

frozenset((token_second, token_end)))

2185

2813

frozenset((token_month, token_end)))

2186

2814

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

2187

2815

datetime.timedelta(weeks=1),

2188

frozenset((token_end,)))

2816

frozenset((token_end, )))

2189

2817

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

2190

2818

frozenset((token_year, token_month,

2191

2819

token_day, token_time,

2192

token_week))),

2193

# Define starting values

2194

value = datetime.timedelta() # Value so far

2820

token_week)))

2821

# Define starting values:

2822

# Value so far

2823

value = datetime.timedelta()

2195

2824

found_token = None

2196

followers = frozenset(token_duration,) # Following valid tokens

2197

s = duration # String left to parse

2825

# Following valid tokens

2826

followers = frozenset((token_duration, ))

2827

# String left to parse

2828

s = duration

2198

2829

# Loop until end token is found

2199

2830

while found_token is not token_end:

2200

2831

# Search for any currently valid tokens

2216

2847

break

2217

2848

else:

2218

2849

# No currently valid tokens were found

2219

raise ValueError("Invalid RFC 3339 duration")

2850

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

2851

.format(duration))

2220

2852

# End token found

2221

2853

return value

2222

2854

2223

2855

2224

2856

def string_to_delta(interval):

2225

2857

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

2226

2858

2227

2859

>>> string_to_delta('7d')

2228

2860

datetime.timedelta(7)

2229

2861

>>> string_to_delta('60s')

2237

2869

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

2238

2870

datetime.timedelta(0, 330)

2239

2871

"""

2240

2872

2241

2873

try:

2242

2874

return rfc3339_duration_to_delta(interval)

2243

2875

except ValueError:

2244

2876

pass

2245

2877

2246

2878

timevalue = datetime.timedelta(0)

2247

2879

for s in interval.split():

2248

2880

try:

2249

suffix = unicode(s[-1])

2881

suffix = s[-1]

2250

2882

value = int(s[:-1])

2251

2883

if suffix == "d":

2252

2884

delta = datetime.timedelta(value)

2259

2891

elif suffix == "w":

2260

2892

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

2261

2893

else:

2262

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

2263

.format(suffix))

2894

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

2264

2895

except IndexError as e:

2265

2896

raise ValueError(*(e.args))

2266

2897

timevalue += delta

2267

2898

return timevalue

2268

2899

2269

2900

2270

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

2901

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

2271

2902

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

2272

2903

2273

2904

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

2274

2905

if os.fork():

2275

2906

sys.exit()

2283

2914

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

2284

2915

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

2285

2916

raise OSError(errno.ENODEV,

2286

"{0} not a character device"

2917

"{} not a character device"

2287

2918

.format(os.devnull))

2288

2919

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

2289

2920

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

2293

2924

2294

2925

2295

2926

def main():

2296

2927

2297

2928

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

2298

2929

# Parsing of options, both command line and config file

2299

2930

2300

2931

parser = argparse.ArgumentParser()

2301

2932

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

2302

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

2933

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

2303

2934

help="show version number and exit")

2304

2935

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

2305

2936

help="Bind to interface IF")

2338

2969

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

2339

2970

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

2340

2971

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

2341

2972

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

2973

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

2974

default=None)

2975

2342

2976

options = parser.parse_args()

2343

2977

2344

2978

if options.check:

2345

2979

import doctest

2346

doctest.testmod()

2347

sys.exit()

2348

2980

fail_count, test_count = doctest.testmod()

2981

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

2982

2349

2983

# Default values for config file for server-global settings

2350

server_defaults = { "interface": "",

2351

"address": "",

2352

"port": "",

2353

"debug": "False",

2354

"priority":

2355

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

2356

"servicename": "Mandos",

2357

"use_dbus": "True",

2358

"use_ipv6": "True",

2359

"debuglevel": "",

2360

"restore": "True",

2361

"socket": "",

2362

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

2363

"foreground": "False",

2364

}

2365

2984

if gnutls.has_rawpk:

2985

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

2986

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

2987

else:

2988

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

2989

":+SIGN-DSA-SHA256")

2990

server_defaults = {"interface": "",

2991

"address": "",

2992

"port": "",

2993

"debug": "False",

2994

"priority": priority,

2995

"servicename": "Mandos",

2996

"use_dbus": "True",

2997

"use_ipv6": "True",

2998

"debuglevel": "",

2999

"restore": "True",

3000

"socket": "",

3001

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

3002

"foreground": "False",

3003

"zeroconf": "True",

3004

}

3005

del priority

3006

2366

3007

# Parse config file for server-global settings

2367

server_config = configparser.SafeConfigParser(server_defaults)

3008

server_config = configparser.ConfigParser(server_defaults)

2368

3009

del server_defaults

2369

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

2370

"mandos.conf"))

2371

# Convert the SafeConfigParser object to a dict

3010

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

3011

# Convert the ConfigParser object to a dict

2372

3012

server_settings = server_config.defaults()

2373

3013

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

2374

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

3014

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

3015

"foreground", "zeroconf"):

2375

3016

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

2376

3017

option)

2377

3018

if server_settings["port"]:

2387

3028

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

2388

3029

["socket"])

2389

3030

del server_config

2390

3031

2391

3032

# Override the settings from the config file with command line

2392

3033

# options, if set.

2393

3034

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

2394

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

2395

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

2396

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

3035

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

3036

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

3037

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

2397

3038

value = getattr(options, option)

2398

3039

if value is not None:

2399

3040

server_settings[option] = value

2400

3041

del options

2401

3042

# Force all strings to be unicode

2402

3043

for option in server_settings.keys():

2403

if type(server_settings[option]) is str:

2404

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

3044

if isinstance(server_settings[option], bytes):

3045

server_settings[option] = (server_settings[option]

3046

.decode("utf-8"))

2405

3047

# Force all boolean options to be boolean

2406

3048

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

2407

"foreground"):

3049

"foreground", "zeroconf"):

2408

3050

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

2409

3051

# Debug implies foreground

2410

3052

if server_settings["debug"]:

2411

3053

server_settings["foreground"] = True

2412

3054

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

2413

3055

2414

3056

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

2415

3057

3058

if (not server_settings["zeroconf"]

3059

and not (server_settings["port"]

3060

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

3061

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

3062

2416

3063

# For convenience

2417

3064

debug = server_settings["debug"]

2418

3065

debuglevel = server_settings["debuglevel"]

2421

3068

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

2422

3069

stored_state_file)

2423

3070

foreground = server_settings["foreground"]

2424

3071

zeroconf = server_settings["zeroconf"]

3072

2425

3073

if debug:

2426

3074

initlogger(debug, logging.DEBUG)

2427

3075

else:

2430

3078

else:

2431

3079

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

2432

3080

initlogger(debug, level)

2433

3081

2434

3082

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

2435

syslogger.setFormatter(logging.Formatter

2436

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

2437

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

2438

.format(server_settings

2439

["servicename"])))

2440

3083

syslogger.setFormatter(

3084

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

3085

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

3086

server_settings["servicename"])))

3087

2441

3088

# Parse config file with clients

2442

client_config = configparser.SafeConfigParser(Client

2443

.client_defaults)

3089

client_config = configparser.ConfigParser(Client.client_defaults)

2444

3090

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

2445

3091

"clients.conf"))

2446

3092

2447

3093

global mandos_dbus_service

2448

3094

mandos_dbus_service = None

2449

2450

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

2451

server_settings["port"]),

2452

ClientHandler,

2453

interface=(server_settings["interface"]

2454

or None),

2455

use_ipv6=use_ipv6,

2456

gnutls_priority=

2457

server_settings["priority"],

2458

use_dbus=use_dbus,

2459

socketfd=(server_settings["socket"]

2460

or None))

3095

3096

socketfd = None

3097

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

3098

socketfd = server_settings["socket"]

3099

tcp_server = MandosServer(

3100

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

3101

ClientHandler,

3102

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

3103

use_ipv6=use_ipv6,

3104

gnutls_priority=server_settings["priority"],

3105

use_dbus=use_dbus,

3106

socketfd=socketfd)

2461

3107

if not foreground:

2462

3108

pidfilename = "/run/mandos.pid"

2463

3109

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

2464

3110

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

2465

3111

pidfile = None

2466

3112

try:

2467

pidfile = open(pidfilename, "w")

3113

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

2468

3114

except IOError as e:

2469

3115

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

2470

3116

exc_info=e)

2471

2472

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

3117

3118

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

3119

("mandos", "mandos"),

3120

("nobody", "nogroup")):

2473

3121

try:

2474

3122

uid = pwd.getpwnam(name).pw_uid

2475

gid = pwd.getpwnam(name).pw_gid

3123

gid = pwd.getpwnam(group).pw_gid

2476

3124

break

2477

3125

except KeyError:

2478

3126

continue

2482

3130

try:

2483

3131

os.setgid(gid)

2484

3132

os.setuid(uid)

3133

if debug:

3134

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

3135

gid))

2485

3136

except OSError as error:

3137

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

3138

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

2486

3139

if error.errno != errno.EPERM:

2487

3140

raise

2488

3141

2489

3142

if debug:

2490

3143

# Enable all possible GnuTLS debugging

2491

3144

2492

3145

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

2493

3146

# - GnuTLS manual

2494

gnutls.library.functions.gnutls_global_set_log_level(11)

2495

2496

@gnutls.library.types.gnutls_log_func

3147

gnutls.global_set_log_level(11)

3148

3149

@gnutls.log_func

2497

3150

def debug_gnutls(level, string):

2498

3151

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

2499

2500

(gnutls.library.functions

2501

.gnutls_global_set_log_function(debug_gnutls))

2502

3152

3153

gnutls.global_set_log_function(debug_gnutls)

3154

2503

3155

# Redirect stdin so all checkers get /dev/null

2504

3156

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

2505

3157

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

2506

3158

if null > 2:

2507

3159

os.close(null)

2508

3160

2509

3161

# Need to fork before connecting to D-Bus

2510

3162

if not foreground:

2511

3163

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

2512

3164

daemon()

2513

2514

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

2515

# need to inform gobject that threads will be used.

2516

gobject.threads_init()

2517

3165

3166

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

3167

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

3168

# need to inform GLib that threads will be used.

3169

GLib.threads_init()

3170

2518

3171

global main_loop

2519

3172

# From the Avahi example code

2520

3173

DBusGMainLoop(set_as_default=True)

2521

main_loop = gobject.MainLoop()

3174

main_loop = GLib.MainLoop()

2522

3175

bus = dbus.SystemBus()

2523

3176

# End of Avahi example code

2524

3177

if use_dbus:

2525

3178

try:

2526

3179

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

2527

bus, do_not_queue=True)

2528

old_bus_name = (dbus.service.BusName

2529

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

2530

do_not_queue=True))

2531

except dbus.exceptions.NameExistsException as e:

3180

bus,

3181

do_not_queue=True)

3182

old_bus_name = dbus.service.BusName(

3183

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

3184

do_not_queue=True)

3185

except dbus.exceptions.DBusException as e:

2532

3186

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

2533

3187

use_dbus = False

2534

3188

server_settings["use_dbus"] = False

2535

3189

tcp_server.use_dbus = False

2536

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2537

service = AvahiServiceToSyslog(name =

2538

server_settings["servicename"],

2539

servicetype = "_mandos._tcp",

2540

protocol = protocol, bus = bus)

2541

if server_settings["interface"]:

2542

service.interface = (if_nametoindex

2543

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

2544

3190

if zeroconf:

3191

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3192

service = AvahiServiceToSyslog(

3193

name=server_settings["servicename"],

3194

servicetype="_mandos._tcp",

3195

protocol=protocol,

3196

bus=bus)

3197

if server_settings["interface"]:

3198

service.interface = if_nametoindex(

3199

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

3200

2545

3201

global multiprocessing_manager

2546

3202

multiprocessing_manager = multiprocessing.Manager()

2547

3203

2548

3204

client_class = Client

2549

3205

if use_dbus:

2550

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

2551

3206

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

3207

2552

3208

client_settings = Client.config_parser(client_config)

2553

3209

old_client_settings = {}

2554

3210

clients_data = {}

2555

3211

2556

3212

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

2557

3213

global wnull

2558

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

3214

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

2559

3215

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

2560

3216

# mode

2561

3217

if debug or not foreground:

2562

3218

wnull.close()

2563

3219

2564

3220

# Get client data and settings from last running state.

2565

3221

if server_settings["restore"]:

2566

3222

try:

2567

3223

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

2568

clients_data, old_client_settings = (pickle.load

2569

(stored_state))

3224

if sys.version_info.major == 2:

3225

clients_data, old_client_settings = pickle.load(

3226

stored_state)

3227

else:

3228

bytes_clients_data, bytes_old_client_settings = (

3229

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

3230

# Fix bytes to strings

3231

# clients_data

3232

# .keys()

3233

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

3234

if isinstance(key, bytes)

3235

else key): value

3236

for key, value in

3237

bytes_clients_data.items()}

3238

del bytes_clients_data

3239

for key in clients_data:

3240

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

3241

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

3242

for k, v in

3243

clients_data[key].items()}

3244

clients_data[key] = value

3245

# .client_structure

3246

value["client_structure"] = [

3247

(s.decode("utf-8")

3248

if isinstance(s, bytes)

3249

else s) for s in

3250

value["client_structure"]]

3251

# .name & .host

3252

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

3253

if isinstance(value[k], bytes):

3254

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

3255

if "key_id" not in value:

3256

value["key_id"] = ""

3257

elif "fingerprint" not in value:

3258

value["fingerprint"] = ""

3259

# old_client_settings

3260

# .keys()

3261

old_client_settings = {

3262

(key.decode("utf-8")

3263

if isinstance(key, bytes)

3264

else key): value

3265

for key, value in

3266

bytes_old_client_settings.items()}

3267

del bytes_old_client_settings

3268

# .host

3269

for value in old_client_settings.values():

3270

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

3271

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

3272

.decode("utf-8"))

2570

3273

os.remove(stored_state_path)

2571

3274

except IOError as e:

2572

3275

if e.errno == errno.ENOENT:

2573

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

2574

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

3276

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

3277

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

2575

3278

else:

2576

3279

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

2577

3280

exc_info=e)

2578

3281

raise

2579

3282

except EOFError as e:

2580

3283

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

2581

"EOFError:", exc_info=e)

2582

3284

"EOFError:",

3285

exc_info=e)

3286

2583

3287

with PGPEngine() as pgp:

2584

for client_name, client in clients_data.iteritems():

3288

for client_name, client in clients_data.items():

2585

3289

# Skip removed clients

2586

3290

if client_name not in client_settings:

2587

3291

continue

2588

3292

2589

3293

# Decide which value to use after restoring saved state.

2590

3294

# We have three different values: Old config file,

2591

3295

# new config file, and saved state.

2596

3300

# For each value in new config, check if it

2597

3301

# differs from the old config value (Except for

2598

3302

# the "secret" attribute)

2599

if (name != "secret" and

2600

value != old_client_settings[client_name]

2601

[name]):

3303

if (name != "secret"

3304

and (value !=

3305

old_client_settings[client_name][name])):

2602

3306

client[name] = value

2603

3307

except KeyError:

2604

3308

pass

2605

3309

2606

3310

# Clients who has passed its expire date can still be

2607

# enabled if its last checker was successful. Clients

3311

# enabled if its last checker was successful. A Client

2608

3312

# whose checker succeeded before we stored its state is

2609

3313

# assumed to have successfully run all checkers during

2610

3314

# downtime.

2612

3316

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

2613

3317

if not client["last_checked_ok"]:

2614

3318

logger.warning(

2615

"disabling client {0} - Client never "

2616

"performed a successful checker"

2617

.format(client_name))

3319

"disabling client {} - Client never "

3320

"performed a successful checker".format(

3321

client_name))

2618

3322

client["enabled"] = False

2619

3323

elif client["last_checker_status"] != 0:

2620

3324

logger.warning(

2621

"disabling client {0} - Client "

2622

"last checker failed with error code {1}"

2623

.format(client_name,

2624

client["last_checker_status"]))

3325

"disabling client {} - Client last"

3326

" checker failed with error code"

3327

" {}".format(

3328

client_name,

3329

client["last_checker_status"]))

2625

3330

client["enabled"] = False

2626

3331

else:

2627

client["expires"] = (datetime.datetime

2628

.utcnow()

2629

+ client["timeout"])

3332

client["expires"] = (

3333

datetime.datetime.utcnow()

3334

+ client["timeout"])

2630

3335

logger.debug("Last checker succeeded,"

2631

" keeping {0} enabled"

2632

.format(client_name))

3336

" keeping {} enabled".format(

3337

client_name))

2633

3338

try:

2634

client["secret"] = (

2635

pgp.decrypt(client["encrypted_secret"],

2636

client_settings[client_name]

2637

["secret"]))

3339

client["secret"] = pgp.decrypt(

3340

client["encrypted_secret"],

3341

client_settings[client_name]["secret"])

2638

3342

except PGPError:

2639

3343

# If decryption fails, we use secret from new settings

2640

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

2641

.format(client_name))

2642

client["secret"] = (

2643

client_settings[client_name]["secret"])

2644

3344

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

3345

client_name))

3346

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

3347

["secret"])

3348

2645

3349

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

2646

3350

for client_name in (set(old_client_settings)

2647

3351

- set(client_settings)):

2649

3353

for client_name in (set(client_settings)

2650

3354

- set(old_client_settings)):

2651

3355

clients_data[client_name] = client_settings[client_name]

2652

3356

2653

3357

# Create all client objects

2654

for client_name, client in clients_data.iteritems():

3358

for client_name, client in clients_data.items():

2655

3359

tcp_server.clients[client_name] = client_class(

2656

name = client_name, settings = client,

2657

server_settings = server_settings)

2658

3360

name=client_name,

3361

settings=client,

3362

server_settings=server_settings)

3363

2659

3364

if not tcp_server.clients:

2660

3365

logger.warning("No clients defined")

2661

3366

2662

3367

if not foreground:

2663

3368

if pidfile is not None:

3369

pid = os.getpid()

2664

3370

try:

2665

3371

with pidfile:

2666

pid = os.getpid()

2667

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

3372

print(pid, file=pidfile)

2668

3373

except IOError:

2669

3374

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

2670

3375

pidfilename, pid)

2671

3376

del pidfile

2672

3377

del pidfilename

2673

2674

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

2675

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

2676

3378

3379

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

3380

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3381

lambda: main_loop.quit() and False)

3382

2677

3383

if use_dbus:

2678

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

2679

"se.bsnet.fukt.Mandos"})

2680

class MandosDBusService(DBusObjectWithProperties):

3384

3385

@alternate_dbus_interfaces(

3386

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

3387

class MandosDBusService(DBusObjectWithObjectManager):

2681

3388

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

3389

2682

3390

def __init__(self):

2683

3391

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

3392

2684

3393

_interface = "se.recompile.Mandos"

2685

2686

@dbus_interface_annotations(_interface)

2687

def _foo(self):

2688

return { "org.freedesktop.DBus.Property"

2689

".EmitsChangedSignal":

2690

"false"}

2691

3394

2692

3395

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

2693

3396

def ClientAdded(self, objpath):

2694

3397

"D-Bus signal"

2695

3398

pass

2696

3399

2697

3400

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

2698

def ClientNotFound(self, fingerprint, address):

3401

def ClientNotFound(self, key_id, address):

2699

3402

"D-Bus signal"

2700

3403

pass

2701

3404

3405

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

3406

"true"})

2702

3407

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

2703

3408

def ClientRemoved(self, objpath, name):

2704

3409

"D-Bus signal"

2705

3410

pass

2706

3411

3412

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

3413

"true"})

2707

3414

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

2708

3415

def GetAllClients(self):

2709

3416

"D-Bus method"

2710

return dbus.Array(c.dbus_object_path

2711

for c in

2712

tcp_server.clients.itervalues())

2713

3417

return dbus.Array(c.dbus_object_path for c in

3418

tcp_server.clients.values())

3419

3420

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

3421

"true"})

2714

3422

@dbus.service.method(_interface,

2715

3423

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

2716

3424

def GetAllClientsWithProperties(self):

2717

3425

"D-Bus method"

2718

3426

return dbus.Dictionary(

2719

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

2720

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

3427

{c.dbus_object_path: c.GetAll(

3428

"se.recompile.Mandos.Client")

3429

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

2721

3430

signature="oa{sv}")

2722

3431

2723

3432

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

2724

3433

def RemoveClient(self, object_path):

2725

3434

"D-Bus method"

2726

for c in tcp_server.clients.itervalues():

3435

for c in tcp_server.clients.values():

2727

3436

if c.dbus_object_path == object_path:

2728

3437

del tcp_server.clients[c.name]

2729

3438

c.remove_from_connection()

2730

# Don't signal anything except ClientRemoved

3439

# Don't signal the disabling

2731

3440

c.disable(quiet=True)

2732

# Emit D-Bus signal

2733

self.ClientRemoved(object_path, c.name)

3441

# Emit D-Bus signal for removal

3442

self.client_removed_signal(c)

2734

3443

return

2735

3444

raise KeyError(object_path)

2736

3445

2737

3446

del _interface

2738

3447

3448

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3449

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

3450

def GetManagedObjects(self):

3451

"""D-Bus method"""

3452

return dbus.Dictionary(

3453

{client.dbus_object_path:

3454

dbus.Dictionary(

3455

{interface: client.GetAll(interface)

3456

for interface in

3457

client._get_all_interface_names()})

3458

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

3459

3460

def client_added_signal(self, client):

3461

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

3462

if use_dbus:

3463

# New standard signal

3464

self.InterfacesAdded(

3465

client.dbus_object_path,

3466

dbus.Dictionary(

3467

{interface: client.GetAll(interface)

3468

for interface in

3469

client._get_all_interface_names()}))

3470

# Old signal

3471

self.ClientAdded(client.dbus_object_path)

3472

3473

def client_removed_signal(self, client):

3474

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

3475

if use_dbus:

3476

# New standard signal

3477

self.InterfacesRemoved(

3478

client.dbus_object_path,

3479

client._get_all_interface_names())

3480

# Old signal

3481

self.ClientRemoved(client.dbus_object_path,

3482

client.name)

3483

2739

3484

mandos_dbus_service = MandosDBusService()

2740

3485

3486

# Save modules to variables to exempt the modules from being

3487

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

3488

mp = multiprocessing

3489

wn = wnull

3490

2741

3491

def cleanup():

2742

3492

"Cleanup function; run on exit"

2743

service.cleanup()

2744

2745

multiprocessing.active_children()

2746

wnull.close()

3493

if zeroconf:

3494

service.cleanup()

3495

3496

mp.active_children()

3497

wn.close()

2747

3498

if not (tcp_server.clients or client_settings):

2748

3499

return

2749

3500

2750

3501

# Store client before exiting. Secrets are encrypted with key

2751

3502

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

2752

3503

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

2753

3504

clients = {}

2754

3505

with PGPEngine() as pgp:

2755

for client in tcp_server.clients.itervalues():

3506

for client in tcp_server.clients.values():

2756

3507

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

2757

3508

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

2758

3509

key)

2759

3510

client_dict = {}

2760

3511

2761

3512

# A list of attributes that can not be pickled

2762

3513

# + secret.

2763

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

2764

"checker", "server_settings"))

2765

for name, typ in (inspect.getmembers

2766

(dbus.service.Object)):

3514

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

3515

"checker", "server_settings"}

3516

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

3517

.Object):

2767

3518

exclude.add(name)

2768

3519

2769

3520

client_dict["encrypted_secret"] = (client

2770

3521

.encrypted_secret)

2771

3522

for attr in client.client_structure:

2772

3523

if attr not in exclude:

2773

3524

client_dict[attr] = getattr(client, attr)

2774

3525

2775

3526

clients[client.name] = client_dict

2776

3527

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

2777

3528

2778

3529

try:

2779

with (tempfile.NamedTemporaryFile

2780

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

2781

dir=os.path.dirname(stored_state_path),

2782

delete=False)) as stored_state:

2783

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

2784

tempname=stored_state.name

3530

with tempfile.NamedTemporaryFile(

3531

mode='wb',

3532

suffix=".pickle",

3533

prefix='clients-',

3534

dir=os.path.dirname(stored_state_path),

3535

delete=False) as stored_state:

3536

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

3537

protocol=2)

3538

tempname = stored_state.name

2785

3539

os.rename(tempname, stored_state_path)

2786

3540

except (IOError, OSError) as e:

2787

3541

if not debug:

2790

3544

except NameError:

2791

3545

pass

2792

3546

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

2793

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

3547

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

2794

3548

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

2795

3549

else:

2796

3550

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

2797

3551

exc_info=e)

2798

3552

raise

2799

3553

2800

3554

# Delete all clients, and settings from config

2801

3555

while tcp_server.clients:

2802

3556

name, client = tcp_server.clients.popitem()

2803

3557

if use_dbus:

2804

3558

client.remove_from_connection()

2805

# Don't signal anything except ClientRemoved

3559

# Don't signal the disabling

2806

3560

client.disable(quiet=True)

3561

# Emit D-Bus signal for removal

2807

3562

if use_dbus:

2808

# Emit D-Bus signal

2809

mandos_dbus_service.ClientRemoved(client

2810

.dbus_object_path,

2811

client.name)

3563

mandos_dbus_service.client_removed_signal(client)

2812

3564

client_settings.clear()

2813

3565

2814

3566

atexit.register(cleanup)

2815

2816

for client in tcp_server.clients.itervalues():

3567

3568

for client in tcp_server.clients.values():

2817

3569

if use_dbus:

2818

# Emit D-Bus signal

2819

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3570

# Emit D-Bus signal for adding

3571

mandos_dbus_service.client_added_signal(client)

2820

3572

# Need to initiate checking of clients

2821

3573

if client.enabled:

2822

3574

client.init_checker()

2823

3575

2824

3576

tcp_server.enable()

2825

3577

tcp_server.server_activate()

2826

3578

2827

3579

# Find out what port we got

2828

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

3580

if zeroconf:

3581

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

2829

3582

if use_ipv6:

2830

3583

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

2831

3584

" flowinfo %d, scope_id %d",

2833

3586

else: # IPv4

2834

3587

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

2835

3588

*tcp_server.socket.getsockname())

2836

2837

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

2838

3589

3590

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

3591

2839

3592

try:

2840

# From the Avahi example code

2841

try:

2842

service.activate()

2843

except dbus.exceptions.DBusException as error:

2844

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

2845

cleanup()

2846

sys.exit(1)

2847

# End of Avahi example code

2848

2849

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

2850

lambda *args, **kwargs:

2851

(tcp_server.handle_request

2852

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

2853

3593

if zeroconf:

3594

# From the Avahi example code

3595

try:

3596

service.activate()

3597

except dbus.exceptions.DBusException as error:

3598

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

3599

cleanup()

3600

sys.exit(1)

3601

# End of Avahi example code

3602

3603

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

3604

lambda *args, **kwargs:

3605

(tcp_server.handle_request

3606

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

3607

2854

3608

logger.debug("Starting main loop")

2855

3609

main_loop.run()

2856

3610

except AvahiError as error:

2865

3619

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

2866

3620

cleanup()

2867

3621

3622

2868

3623

if __name__ == '__main__':

2869

3624

main()