/mandos/release : revision 237.7.707

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.5"

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

129

syslogger = None

96

130

97

131

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

132

if_nametoindex = ctypes.cdll.LoadLibrary(

133

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

101

134

except (OSError, AttributeError):

135

102

136

def if_nametoindex(interface):

103

137

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

104

138

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

105

139

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

106

140

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

141

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

142

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

111

143

return interface_index

112

144

113

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

114

162

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

115

163

"""init logger and add loglevel"""

116

164

117

165

global syslogger

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

166

syslogger = (logging.handlers.SysLogHandler(

167

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

168

address="/dev/log"))

122

169

syslogger.setFormatter(logging.Formatter

123

170

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

124

171

' %(message)s'))

125

172

logger.addHandler(syslogger)

126

173

127

174

if debug:

128

175

console = logging.StreamHandler()

129

176

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

139

186

pass

140

187

141

188

142

class PGPEngine(object):

189

class PGPEngine:

143

190

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

191

144

192

def __init__(self):

145

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

146

205

self.gnupgargs = ['--batch',

147

'--home', self.tempdir,

206

'--homedir', self.tempdir,

148

207

'--force-mdc',

149

'--quiet',

150

'--no-use-agent']

151

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

152

213

def __enter__(self):

153

214

return self

154

215

155

216

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

156

217

self._cleanup()

157

218

return False

158

219

159

220

def __del__(self):

160

221

self._cleanup()

161

222

162

223

def _cleanup(self):

163

224

if self.tempdir is not None:

164

225

# Delete contents of tempdir

165

226

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

166

topdown = False):

227

topdown=False):

167

228

for filename in files:

168

229

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

169

230

for dirname in dirs:

171

232

# Remove tempdir

172

233

os.rmdir(self.tempdir)

173

234

self.tempdir = None

174

235

175

236

def password_encode(self, password):

176

237

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

177

238

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

182

243

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

183

244

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

184

245

return encoded

185

246

186

247

def encrypt(self, data, password):

187

248

passphrase = self.password_encode(password)

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

249

with tempfile.NamedTemporaryFile(

250

dir=self.tempdir) as passfile:

190

251

passfile.write(passphrase)

191

252

passfile.flush()

192

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

253

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

193

254

'--passphrase-file',

194

255

passfile.name]

195

256

+ self.gnupgargs,

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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)

200

261

if proc.returncode != 0:

201

262

raise PGPError(err)

202

263

return ciphertext

203

264

204

265

def decrypt(self, data, password):

205

266

passphrase = self.password_encode(password)

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

267

with tempfile.NamedTemporaryFile(

268

dir=self.tempdir) as passfile:

208

269

passfile.write(passphrase)

209

270

passfile.flush()

210

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

271

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

211

272

'--passphrase-file',

212

273

passfile.name]

213

274

+ self.gnupgargs,

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

275

stdin=subprocess.PIPE,

276

stdout=subprocess.PIPE,

277

stderr=subprocess.PIPE)

278

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

219

279

if proc.returncode != 0:

220

280

raise PGPError(err)

221

281

return decrypted_plaintext

222

282

223

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

224

310

class AvahiError(Exception):

225

311

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

226

312

self.value = value

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

313

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

314

**kwargs)

315

230

316

231

317

class AvahiServiceError(AvahiError):

232

318

pass

233

319

320

234

321

class AvahiGroupError(AvahiError):

235

322

pass

236

323

237

324

238

class AvahiService(object):

325

class AvahiService:

239

326

"""An Avahi (Zeroconf) service.

240

327

241

328

Attributes:

242

329

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

243

330

Used to optionally bind to the specified interface.

255

342

server: D-Bus Server

256

343

bus: dbus.SystemBus()

257

344

"""

258

259

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

260

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

261

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

262

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

263

357

self.interface = interface

264

358

self.name = name

265

359

self.type = servicetype

274

368

self.server = None

275

369

self.bus = bus

276

370

self.entry_group_state_changed_match = None

277

278

def rename(self):

371

372

def rename(self, remove=True):

279

373

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

280

374

if self.rename_count >= self.max_renames:

281

375

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

282

376

" after %i retries, exiting.",

283

377

self.rename_count)

284

378

raise AvahiServiceError("Too many renames")

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

379

self.name = str(

380

self.server.GetAlternativeServiceName(self.name))

381

self.rename_count += 1

287

382

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

288

383

self.name)

289

self.remove()

384

if remove:

385

self.remove()

290

386

try:

291

387

self.add()

292

388

except dbus.exceptions.DBusException as error:

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

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

298

398

def remove(self):

299

399

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

300

400

if self.entry_group_state_changed_match is not None:

302

402

self.entry_group_state_changed_match = None

303

403

if self.group is not None:

304

404

self.group.Reset()

305

405

306

406

def add(self):

307

407

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

308

408

self.remove()

325

425

dbus.UInt16(self.port),

326

426

avahi.string_array_to_txt_array(self.TXT))

327

427

self.group.Commit()

328

428

329

429

def entry_group_state_changed(self, state, error):

330

430

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

331

431

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

332

432

333

433

if state == avahi.ENTRY_GROUP_ESTABLISHED:

334

434

logger.debug("Zeroconf service established.")

335

435

elif state == avahi.ENTRY_GROUP_COLLISION:

337

437

self.rename()

338

438

elif state == avahi.ENTRY_GROUP_FAILURE:

339

439

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

340

unicode(error))

341

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

342

.format(error))

343

440

str(error))

441

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

442

344

443

def cleanup(self):

345

444

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

346

445

if self.group is not None:

351

450

pass

352

451

self.group = None

353

452

self.remove()

354

453

355

454

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

356

455

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

357

456

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

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"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

}

365

463

if state in bad_states:

366

464

if bad_states[state] is not None:

367

465

if error is None:

370

468

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

371

469

self.cleanup()

372

470

elif state == avahi.SERVER_RUNNING:

373

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)

374

483

else:

375

484

if error is None:

376

485

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

377

486

else:

378

487

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

379

488

380

489

def activate(self):

381

490

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

382

491

if self.server is None:

386

495

follow_name_owner_changes=True),

387

496

avahi.DBUS_INTERFACE_SERVER)

388

497

self.server.connect_to_signal("StateChanged",

389

self.server_state_changed)

498

self.server_state_changed)

390

499

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

391

500

392

501

393

502

class AvahiServiceToSyslog(AvahiService):

394

def rename(self):

503

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

395

504

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

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

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

401

509

return ret

402

510

403

511

404

def timedelta_to_milliseconds(td):

405

"Convert a datetime.timedelta() to milliseconds"

406

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

407

+ (td.seconds * 1000)

408

+ (td.microseconds // 1000))

409

410

411

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:

412

825

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

413

826

414

827

Attributes:

415

828

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

416

829

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

417

830

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

418

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

419

to see if the client lives.

420

'None' if no process is running.

421

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

422

835

checker_command: string; External command which is run to check

423

836

if client lives. %() expansions are done at

424

837

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

425

838

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

426

checker_initiator_tag: a gobject event source tag, or None

839

checker_initiator_tag: a GLib event source tag, or None

427

840

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

428

841

client_structure: Object describing what attributes a client has

429

842

and is used for storing the client at exit

430

843

current_checker_command: string; current running checker_command

431

disable_initiator_tag: a gobject event source tag, or None

844

disable_initiator_tag: a GLib event source tag, or None

432

845

enabled: bool()

433

846

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

434

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

435

850

host: string; available for use by the checker command

436

851

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

437

852

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

439

854

last_checker_status: integer between 0 and 255 reflecting exit

440

855

status of last checker. -1 reflects crashed

441

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

442

859

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

443

860

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

444

861

D-Bus identifiers

451

868

disabled, or None

452

869

server_settings: The server_settings dict from main()

453

870

"""

454

871

455

872

runtime_expansions = ("approval_delay", "approval_duration",

456

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

873

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

457

874

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

458

875

"last_approval_request", "last_checked_ok",

459

876

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

460

client_defaults = { "timeout": "PT5M",

461

"extended_timeout": "PT15M",

462

"interval": "PT2M",

463

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

464

"host": "",

465

"approval_delay": "PT0S",

466

"approval_duration": "PT1S",

467

"approved_by_default": "True",

468

"enabled": "True",

469

}

470

471

def timeout_milliseconds(self):

472

"Return the 'timeout' attribute in milliseconds"

473

return timedelta_to_milliseconds(self.timeout)

474

475

def extended_timeout_milliseconds(self):

476

"Return the 'extended_timeout' attribute in milliseconds"

477

return timedelta_to_milliseconds(self.extended_timeout)

478

479

def interval_milliseconds(self):

480

"Return the 'interval' attribute in milliseconds"

481

return timedelta_to_milliseconds(self.interval)

482

483

def approval_delay_milliseconds(self):

484

return timedelta_to_milliseconds(self.approval_delay)

485

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

486

889

@staticmethod

487

890

def config_parser(config):

488

891

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

495

898

for client_name in config.sections():

496

899

section = dict(config.items(client_name))

497

900

client = settings[client_name] = {}

498

901

499

902

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

500

903

# Reformat values from string types to Python types

501

904

client["approved_by_default"] = config.getboolean(

502

905

client_name, "approved_by_default")

503

906

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

504

907

"enabled")

505

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(" ", ""))

506

914

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

507

915

.replace(" ", ""))

508

916

if "secret" in section:

509

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

917

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

918

.encode("utf-8"),

919

"base64")

510

920

elif "secfile" in section:

511

921

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

512

922

(section["secfile"])),

513

923

"rb") as secfile:

514

924

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

515

925

else:

516

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

926

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

517

927

.format(section))

518

928

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

519

929

client["extended_timeout"] = string_to_delta(

527

937

client["last_approval_request"] = None

528

938

client["last_checked_ok"] = None

529

939

client["last_checker_status"] = -2

530

940

531

941

return settings

532

533

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

942

943

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

534

944

self.name = name

535

945

if server_settings is None:

536

946

server_settings = {}

537

947

self.server_settings = server_settings

538

948

# adding all client settings

539

for setting, value in settings.iteritems():

949

for setting, value in settings.items():

540

950

setattr(self, setting, value)

541

951

542

952

if self.enabled:

543

953

if not hasattr(self, "last_enabled"):

544

954

self.last_enabled = datetime.datetime.utcnow()

548

958

else:

549

959

self.last_enabled = None

550

960

self.expires = None

551

961

552

962

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

553

# Uppercase and remove spaces from fingerprint for later

554

# comparison purposes with return value from the fingerprint()

555

# function

963

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

556

964

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

557

965

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

558

966

datetime.datetime.utcnow())

559

967

560

968

# attributes specific for this server instance

561

969

self.checker = None

562

970

self.checker_initiator_tag = None

565

973

self.current_checker_command = None

566

974

self.approved = None

567

975

self.approvals_pending = 0

568

self.changedstate = (multiprocessing_manager

569

.Condition(multiprocessing_manager

570

.Lock()))

571

self.client_structure = [attr for attr in

572

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

573

980

if not attr.startswith("_")]

574

981

self.client_structure.append("client_structure")

575

576

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

577

lambda obj:

578

isinstance(obj,

579

property)):

982

983

for name, t in inspect.getmembers(

984

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

580

985

if not name.startswith("_"):

581

986

self.client_structure.append(name)

582

987

583

988

# Send notice to process children that client state has changed

584

989

def send_changedstate(self):

585

990

with self.changedstate:

586

991

self.changedstate.notify_all()

587

992

588

993

def enable(self):

589

994

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

590

995

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

595

1000

self.last_enabled = datetime.datetime.utcnow()

596

1001

self.init_checker()

597

1002

self.send_changedstate()

598

1003

599

1004

def disable(self, quiet=True):

600

1005

"""Disable this client."""

601

1006

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

603

1008

if not quiet:

604

1009

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

605

1010

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

606

gobject.source_remove(self.disable_initiator_tag)

1011

GLib.source_remove(self.disable_initiator_tag)

607

1012

self.disable_initiator_tag = None

608

1013

self.expires = None

609

1014

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

610

gobject.source_remove(self.checker_initiator_tag)

1015

GLib.source_remove(self.checker_initiator_tag)

611

1016

self.checker_initiator_tag = None

612

1017

self.stop_checker()

613

1018

self.enabled = False

614

1019

if not quiet:

615

1020

self.send_changedstate()

616

# 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

617

1022

return False

618

1023

619

1024

def __del__(self):

620

1025

self.disable()

621

1026

622

1027

def init_checker(self):

623

1028

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

624

1029

# and every interval from then on.

625

1030

if self.checker_initiator_tag is not None:

626

gobject.source_remove(self.checker_initiator_tag)

627

self.checker_initiator_tag = (gobject.timeout_add

628

(self.interval_milliseconds(),

629

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)

630

1035

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

631

1036

if self.disable_initiator_tag is not None:

632

gobject.source_remove(self.disable_initiator_tag)

633

self.disable_initiator_tag = (gobject.timeout_add

634

(self.timeout_milliseconds(),

635

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)

636

1040

# Also start a new checker *right now*.

637

1041

self.start_checker()

638

639

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

1042

1043

def checker_callback(self, source, condition, connection,

1044

command):

640

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

641

1050

self.checker_callback_tag = None

642

1051

self.checker = None

643

if os.WIFEXITED(condition):

644

self.last_checker_status = os.WEXITSTATUS(condition)

1052

1053

if returncode >= 0:

1054

self.last_checker_status = returncode

1055

self.last_checker_signal = None

645

1056

if self.last_checker_status == 0:

646

1057

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

647

1058

vars(self))

648

1059

self.checked_ok()

649

1060

else:

650

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

651

vars(self))

1061

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

652

1062

else:

653

1063

self.last_checker_status = -1

1064

self.last_checker_signal = -returncode

654

1065

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

655

1066

vars(self))

656

1067

return False

1068

657

1069

def checked_ok(self):

658

1070

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

659

1071

self.last_checked_ok = datetime.datetime.utcnow()

660

1072

self.last_checker_status = 0

1073

self.last_checker_signal = None

661

1074

self.bump_timeout()

662

1075

663

1076

def bump_timeout(self, timeout=None):

664

1077

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

665

1078

if timeout is None:

666

1079

timeout = self.timeout

667

1080

if self.disable_initiator_tag is not None:

668

gobject.source_remove(self.disable_initiator_tag)

1081

GLib.source_remove(self.disable_initiator_tag)

669

1082

self.disable_initiator_tag = None

670

1083

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

671

self.disable_initiator_tag = (gobject.timeout_add

672

(timedelta_to_milliseconds

673

(timeout), self.disable))

1084

self.disable_initiator_tag = GLib.timeout_add(

1085

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

674

1086

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

675

1087

676

1088

def need_approval(self):

677

1089

self.last_approval_request = datetime.datetime.utcnow()

678

1090

679

1091

def start_checker(self):

680

1092

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

681

1093

682

1094

If a checker already exists, leave it running and do

683

1095

nothing."""

684

1096

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

689

1101

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

690

1102

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

691

1103

# should be.

692

693

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

694

try:

695

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

696

except AttributeError:

697

pass

698

except OSError as error:

699

if error.errno != errno.ECHILD:

700

raise

701

else:

702

if pid:

703

logger.warning("Checker was a zombie")

704

gobject.source_remove(self.checker_callback_tag)

705

self.checker_callback(pid, status,

706

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

707

1109

# Start a new checker if needed

708

1110

if self.checker is None:

709

1111

# Escape attributes for the shell

710

escaped_attrs = dict(

711

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

712

for attr in

713

self.runtime_expansions)

1112

escaped_attrs = {

1113

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

1114

for attr in self.runtime_expansions}

714

1115

try:

715

1116

command = self.checker_command % escaped_attrs

716

1117

except TypeError as error:

717

1118

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

718

self.checker_command, exc_info=error)

719

return True # Try again later

1119

self.checker_command,

1120

exc_info=error)

1121

return True # Try again later

720

1122

self.current_checker_command = command

721

try:

722

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

723

command, self.name)

724

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

725

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

726

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

727

# always replaced by /dev/null.)

728

# The exception is when not debugging but nevertheless

729

# running in the foreground; use the previously

730

# created wnull.

731

popen_args = {}

732

if (not self.server_settings["debug"]

733

and self.server_settings["foreground"]):

734

popen_args.update({"stdout": wnull,

735

"stderr": wnull })

736

self.checker = subprocess.Popen(command,

737

close_fds=True,

738

shell=True, cwd="/",

739

**popen_args)

740

except OSError as error:

741

logger.error("Failed to start subprocess",

742

exc_info=error)

743

return True

744

self.checker_callback_tag = (gobject.child_watch_add

745

(self.checker.pid,

746

self.checker_callback,

747

data=command))

748

# The checker may have completed before the gobject

749

# watch was added. Check for this.

750

try:

751

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

752

except OSError as error:

753

if error.errno == errno.ECHILD:

754

# This should never happen

755

logger.error("Child process vanished",

756

exc_info=error)

757

return True

758

raise

759

if pid:

760

gobject.source_remove(self.checker_callback_tag)

761

self.checker_callback(pid, status, command)

762

# 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

763

1149

return True

764

1150

765

1151

def stop_checker(self):

766

1152

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

767

1153

if self.checker_callback_tag:

768

gobject.source_remove(self.checker_callback_tag)

1154

GLib.source_remove(self.checker_callback_tag)

769

1155

self.checker_callback_tag = None

770

1156

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

771

1157

return

772

1158

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

773

try:

774

self.checker.terminate()

775

#time.sleep(0.5)

776

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

777

# self.checker.kill()

778

except OSError as error:

779

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

780

raise

1159

self.checker.terminate()

781

1160

self.checker = None

782

1161

783

1162

784

def dbus_service_property(dbus_interface, signature="v",

785

access="readwrite", byte_arrays=False):

1163

def dbus_service_property(dbus_interface,

1164

signature="v",

1165

access="readwrite",

1166

byte_arrays=False):

786

1167

"""Decorators for marking methods of a DBusObjectWithProperties to

787

1168

become properties on the D-Bus.

788

1169

789

1170

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

790

1171

and with one argument by "Set".

791

1172

792

1173

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

793

1174

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

794

1175

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

797

1178

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

798

1179

if byte_arrays and signature != "ay":

799

1180

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

800

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

1181

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

1182

801

1183

def decorator(func):

802

1184

func._dbus_is_property = True

803

1185

func._dbus_interface = dbus_interface

806

1188

func._dbus_name = func.__name__

807

1189

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

808

1190

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

809

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1191

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

810

1192

return func

1193

811

1194

return decorator

812

1195

813

1196

814

1197

def dbus_interface_annotations(dbus_interface):

815

1198

"""Decorator for marking functions returning interface annotations

816

1199

817

1200

Usage:

818

1201

819

1202

@dbus_interface_annotations("org.example.Interface")

820

1203

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

821

1204

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

822

1205

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

823

1206

"false"}

824

1207

"""

1208

825

1209

def decorator(func):

826

1210

func._dbus_is_interface = True

827

1211

func._dbus_interface = dbus_interface

828

1212

func._dbus_name = dbus_interface

829

1213

return func

1214

830

1215

return decorator

831

1216

832

1217

833

1218

def dbus_annotations(annotations):

834

1219

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

835

1220

Usage:

836

1221

1222

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

1223

"org.freedesktop.DBus.Property."

1224

"EmitsChangedSignal": "false"})

837

1225

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

838

1226

access="r")

839

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

840

"org.freedesktop.DBus.Property."

841

"EmitsChangedSignal": "false"})

842

1227

def Property_dbus_property(self):

843

1228

return dbus.Boolean(False)

1229

1230

See also the DBusObjectWithAnnotations class.

844

1231

"""

1232

845

1233

def decorator(func):

846

1234

func._dbus_annotations = annotations

847

1235

return func

1236

848

1237

return decorator

849

1238

850

1239

851

1240

class DBusPropertyException(dbus.exceptions.DBusException):

852

1241

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

853

1242

"""

854

def __unicode__(self):

855

return unicode(str(self))

1243

pass

856

1244

857

1245

858

1246

class DBusPropertyAccessException(DBusPropertyException):

867

1255

pass

868

1256

869

1257

870

class DBusObjectWithProperties(dbus.service.Object):

871

"""A D-Bus object with properties.

872

873

Classes inheriting from this can use the dbus_service_property

874

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

875

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.

876

1263

"""

877

1264

878

1265

@staticmethod

879

1266

def _is_dbus_thing(thing):

880

1267

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

881

1268

882

1269

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

883

1270

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

884

1271

"""

885

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

1272

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

886

1273

False)

887

1274

888

1275

def _get_all_dbus_things(self, thing):

889

1276

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

890

1277

"""

891

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

892

name),

1278

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

893

1279

athing.__get__(self))

894

1280

for cls in self.__class__.__mro__

895

1281

for name, athing in

896

inspect.getmembers(cls,

897

self._is_dbus_thing(thing)))

898

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

899

1355

def _get_dbus_property(self, interface_name, property_name):

900

1356

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

901

1357

property with the specified name and interface.

902

1358

"""

903

for cls in self.__class__.__mro__:

904

for name, value in (inspect.getmembers

905

(cls,

906

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

907

1362

if (value._dbus_name == property_name

908

1363

and value._dbus_interface == interface_name):

909

1364

return value.__get__(self)

910

1365

911

1366

# No such property

912

raise DBusPropertyNotFound(self.dbus_object_path + ":"

913

+ interface_name + "."

914

+ property_name)

915

916

@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",

917

1381

out_signature="v")

918

1382

def Get(self, interface_name, property_name):

919

1383

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

925

1389

if not hasattr(value, "variant_level"):

926

1390

return value

927

1391

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

928

1392

929

1393

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

930

1394

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

931

1395

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

938

1402

# signatures other than "ay".

939

1403

if prop._dbus_signature != "ay":

940

1404

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

941

"'ay' signature {0!r}"

1405

"'ay' signature {!r}"

942

1406

.format(prop._dbus_signature))

943

1407

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

944

1408

for byte in value))

945

1409

prop(value)

946

947

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

1410

1411

@dbus.service.method(dbus.PROPERTIES_IFACE,

1412

in_signature="s",

948

1413

out_signature="a{sv}")

949

1414

def GetAll(self, interface_name):

950

1415

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

951

1416

standard.

952

1417

953

1418

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

954

1419

"""

955

1420

properties = {}

965

1430

if not hasattr(value, "variant_level"):

966

1431

properties[name] = value

967

1432

continue

968

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

969

value.variant_level+1)

1433

properties[name] = type(value)(

1434

value, variant_level=value.variant_level + 1)

970

1435

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

971

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

972

1445

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

973

1446

out_signature="s",

974

1447

path_keyword='object_path',

975

1448

connection_keyword='connection')

976

1449

def Introspect(self, object_path, connection):

977

1450

"""Overloading of standard D-Bus method.

978

1451

979

1452

Inserts property tags and interface annotation tags.

980

1453

"""

981

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

982

connection)

1454

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1455

object_path,

1456

connection)

983

1457

try:

984

1458

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

1459

985

1460

def make_tag(document, name, prop):

986

1461

e = document.createElement("property")

987

1462

e.setAttribute("name", name)

988

1463

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

989

1464

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

990

1465

return e

1466

991

1467

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

992

1468

# Add property tags

993

1469

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

996

1472

if prop._dbus_interface

997

1473

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

998

1474

if_tag.appendChild(tag)

999

# Add annotation tags

1000

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

1001

for tag in if_tag.getElementsByTagName(typ):

1002

annots = dict()

1003

for name, prop in (self.

1004

_get_all_dbus_things(typ)):

1005

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

1006

and prop._dbus_interface

1007

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

1008

annots.update(getattr

1009

(prop,

1010

"_dbus_annotations",

1011

{}))

1012

for name, value in annots.iteritems():

1013

ann_tag = document.createElement(

1014

"annotation")

1015

ann_tag.setAttribute("name", name)

1016

ann_tag.setAttribute("value", value)

1017

tag.appendChild(ann_tag)

1018

# Add interface annotation tags

1019

for annotation, value in dict(

1020

itertools.chain.from_iterable(

1021

annotations().iteritems()

1022

for name, annotations in

1023

self._get_all_dbus_things("interface")

1024

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

1025

)).iteritems():

1026

ann_tag = document.createElement("annotation")

1027

ann_tag.setAttribute("name", annotation)

1028

ann_tag.setAttribute("value", value)

1029

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)

1030

1491

# Add the names to the return values for the

1031

1492

# "org.freedesktop.DBus.Properties" methods

1032

1493

if (if_tag.getAttribute("name")

1051

1512

return xmlstring

1052

1513

1053

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

1054

1586

def datetime_to_dbus(dt, variant_level=0):

1055

1587

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

1056

1588

if dt is None:

1057

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

1058

return dbus.String(dt.isoformat(),

1059

variant_level=variant_level)

1589

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

1590

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

1060

1591

1061

1592

1062

1593

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1064

1595

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

1065

1596

interface names according to the "alt_interface_names" mapping.

1066

1597

Usage:

1067

1598

1068

1599

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

1069

1600

"net.example.AlternateInterface"})

1070

1601

class SampleDBusObject(dbus.service.Object):

1071

1602

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

1072

1603

def SampleDBusMethod():

1073

1604

pass

1074

1605

1075

1606

The above "SampleDBusMethod" on "SampleDBusObject" will be

1076

1607

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

1077

1608

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

1078

1609

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

1079

1610

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

1080

1611

1081

1612

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

1082

1613

(from DBusObjectWithProperties) and interfaces (from the

1083

1614

dbus_interface_annotations decorator).

1084

1615

"""

1616

1085

1617

def wrapper(cls):

1086

1618

for orig_interface_name, alt_interface_name in (

1087

alt_interface_names.iteritems()):

1619

alt_interface_names.items()):

1088

1620

attr = {}

1089

1621

interface_names = set()

1090

1622

# Go though all attributes of the class

1092

1624

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

1093

1625

# with the wrong interface name

1094

1626

if (not hasattr(attribute, "_dbus_interface")

1095

or not attribute._dbus_interface

1096

.startswith(orig_interface_name)):

1627

or not attribute._dbus_interface.startswith(

1628

orig_interface_name)):

1097

1629

continue

1098

1630

# Create an alternate D-Bus interface name based on

1099

1631

# the current name

1100

alt_interface = (attribute._dbus_interface

1101

.replace(orig_interface_name,

1102

alt_interface_name))

1632

alt_interface = attribute._dbus_interface.replace(

1633

orig_interface_name, alt_interface_name)

1103

1634

interface_names.add(alt_interface)

1104

1635

# Is this a D-Bus signal?

1105

1636

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

1106

1637

# Extract the original non-method undecorated

1107

1638

# function by black magic

1108

nonmethod_func = (dict(

1639

if sys.version_info.major == 2:

1640

nonmethod_func = (dict(

1109

1641

zip(attribute.func_code.co_freevars,

1110

attribute.__closure__))["func"]

1111

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

1112

1649

# Create a new, but exactly alike, function

1113

1650

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

1114

1651

# with the alternate D-Bus interface name

1115

new_function = (dbus.service.signal

1116

(alt_interface,

1117

attribute._dbus_signature)

1118

(types.FunctionType(

1119

nonmethod_func.func_code,

1120

nonmethod_func.func_globals,

1121

nonmethod_func.func_name,

1122

nonmethod_func.func_defaults,

1123

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

1124

1656

# Copy annotations, if any

1125

1657

try:

1126

new_function._dbus_annotations = (

1127

dict(attribute._dbus_annotations))

1658

new_function._dbus_annotations = dict(

1659

attribute._dbus_annotations)

1128

1660

except AttributeError:

1129

1661

pass

1662

1130

1663

# Define a creator of a function to call both the

1131

1664

# original and alternate functions, so both the

1132

1665

# original and alternate signals gets sent when

1135

1668

"""This function is a scope container to pass

1136

1669

func1 and func2 to the "call_both" function

1137

1670

outside of its arguments"""

1671

1672

@functools.wraps(func2)

1138

1673

def call_both(*args, **kwargs):

1139

1674

"""This function will emit two D-Bus

1140

1675

signals by calling func1 and func2"""

1141

1676

func1(*args, **kwargs)

1142

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

1143

1684

return call_both

1144

1685

# Create the "call_both" function and add it to

1145

1686

# the class

1150

1691

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

1151

1692

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

1152

1693

# to the class.

1153

attr[attrname] = (dbus.service.method

1154

(alt_interface,

1155

attribute._dbus_in_signature,

1156

attribute._dbus_out_signature)

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

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

1163

1700

# Copy annotations, if any

1164

1701

try:

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1702

attr[attrname]._dbus_annotations = dict(

1703

attribute._dbus_annotations)

1167

1704

except AttributeError:

1168

1705

pass

1169

1706

# Is this a D-Bus property?

1172

1709

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

1173

1710

# property with the alternate D-Bus interface

1174

1711

# name. Add it to the class.

1175

attr[attrname] = (dbus_service_property

1176

(alt_interface,

1177

attribute._dbus_signature,

1178

attribute._dbus_access,

1179

attribute

1180

._dbus_get_args_options

1181

["byte_arrays"])

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

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

1188

1718

# Copy annotations, if any

1189

1719

try:

1190

attr[attrname]._dbus_annotations = (

1191

dict(attribute._dbus_annotations))

1720

attr[attrname]._dbus_annotations = dict(

1721

attribute._dbus_annotations)

1192

1722

except AttributeError:

1193

1723

pass

1194

1724

# Is this a D-Bus interface?

1197

1727

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

1198

1728

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

1199

1729

# to the class.

1200

attr[attrname] = (dbus_interface_annotations

1201

(alt_interface)

1202

(types.FunctionType

1203

(attribute.func_code,

1204

attribute.func_globals,

1205

attribute.func_name,

1206

attribute.func_defaults,

1207

attribute.func_closure)))

1730

attr[attrname] = (

1731

dbus_interface_annotations(alt_interface)

1732

(copy_function(attribute)))

1208

1733

if deprecate:

1209

1734

# Deprecate all alternate interfaces

1210

iname="_AlternateDBusNames_interface_annotation{0}"

1735

iname = "_AlternateDBusNames_interface_annotation{}"

1211

1736

for interface_name in interface_names:

1737

1212

1738

@dbus_interface_annotations(interface_name)

1213

1739

def func(self):

1214

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

1215

"true" }

1740

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

1741

"true"}

1216

1742

# Find an unused name

1217

1743

for aname in (iname.format(i)

1218

1744

for i in itertools.count()):

1222

1748

if interface_names:

1223

1749

# Replace the class with a new subclass of it with

1224

1750

# methods, signals, etc. as created above.

1225

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

1226

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

1227

1757

return cls

1758

1228

1759

return wrapper

1229

1760

1230

1761

1231

1762

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

1232

"se.bsnet.fukt.Mandos"})

1763

"se.bsnet.fukt.Mandos"})

1233

1764

class ClientDBus(Client, DBusObjectWithProperties):

1234

1765

"""A Client class using D-Bus

1235

1766

1236

1767

Attributes:

1237

1768

dbus_object_path: dbus.ObjectPath

1238

1769

bus: dbus.SystemBus()

1239

1770

"""

1240

1771

1241

1772

runtime_expansions = (Client.runtime_expansions

1242

+ ("dbus_object_path",))

1243

1773

+ ("dbus_object_path", ))

1774

1775

_interface = "se.recompile.Mandos.Client"

1776

1244

1777

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

1245

1246

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

1778

1779

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

1247

1780

self.bus = bus

1248

1781

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

1249

1782

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

1250

1783

# the D-Bus

1251

client_object_name = unicode(self.name).translate(

1784

client_object_name = str(self.name).translate(

1252

1785

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

1253

1786

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

1254

self.dbus_object_path = (dbus.ObjectPath

1255

("/clients/" + client_object_name))

1787

self.dbus_object_path = dbus.ObjectPath(

1788

"/clients/" + client_object_name)

1256

1789

DBusObjectWithProperties.__init__(self, self.bus,

1257

1790

self.dbus_object_path)

1258

1259

def notifychangeproperty(transform_func,

1260

dbus_name, type_func=lambda x: x,

1261

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

1262

1797

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

1263

1798

its changes to DBus.

1264

1799

1265

1800

transform_fun: Function that takes a value and a variant_level

1266

1801

and transforms it to a D-Bus type.

1267

1802

dbus_name: D-Bus name of the variable

1269

1804

to the D-Bus. Default: no transform

1270

1805

variant_level: D-Bus variant level. Default: 1

1271

1806

"""

1272

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

1807

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

1808

1273

1809

def setter(self, value):

1274

1810

if hasattr(self, "dbus_object_path"):

1275

1811

if (not hasattr(self, attrname) or

1276

1812

type_func(getattr(self, attrname, None))

1277

1813

!= type_func(value)):

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1281

self.PropertyChanged(dbus.String(dbus_name),

1282

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

1283

1829

setattr(self, attrname, value)

1284

1830

1285

1831

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

1286

1832

1287

1833

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1288

1834

approvals_pending = notifychangeproperty(dbus.Boolean,

1289

1835

"ApprovalPending",

1290

type_func = bool)

1836

type_func=bool)

1291

1837

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

1292

1838

last_enabled = notifychangeproperty(datetime_to_dbus,

1293

1839

"LastEnabled")

1294

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

1295

type_func = lambda checker:

1296

checker is not None)

1840

checker = notifychangeproperty(

1841

dbus.Boolean, "CheckerRunning",

1842

type_func=lambda checker: checker is not None)

1297

1843

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1298

1844

"LastCheckedOK")

1299

1845

last_checker_status = notifychangeproperty(dbus.Int16,

1302

1848

datetime_to_dbus, "LastApprovalRequest")

1303

1849

approved_by_default = notifychangeproperty(dbus.Boolean,

1304

1850

"ApprovedByDefault")

1305

approval_delay = notifychangeproperty(dbus.UInt64,

1306

"ApprovalDelay",

1307

type_func =

1308

timedelta_to_milliseconds)

1851

approval_delay = notifychangeproperty(

1852

dbus.UInt64, "ApprovalDelay",

1853

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

1309

1854

approval_duration = notifychangeproperty(

1310

1855

dbus.UInt64, "ApprovalDuration",

1311

type_func = timedelta_to_milliseconds)

1856

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

1312

1857

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

1313

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

1314

type_func =

1315

timedelta_to_milliseconds)

1858

timeout = notifychangeproperty(

1859

dbus.UInt64, "Timeout",

1860

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

1316

1861

extended_timeout = notifychangeproperty(

1317

1862

dbus.UInt64, "ExtendedTimeout",

1318

type_func = timedelta_to_milliseconds)

1319

interval = notifychangeproperty(dbus.UInt64,

1320

"Interval",

1321

type_func =

1322

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)

1323

1867

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

1324

1868

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

1869

invalidate_only=True)

1870

1325

1871

del notifychangeproperty

1326

1872

1327

1873

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

1328

1874

try:

1329

1875

self.remove_from_connection()

1332

1878

if hasattr(DBusObjectWithProperties, "__del__"):

1333

1879

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

1334

1880

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

1335

1336

def checker_callback(self, pid, condition, command,

1337

*args, **kwargs):

1338

self.checker_callback_tag = None

1339

self.checker = None

1340

if os.WIFEXITED(condition):

1341

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:

1342

1889

# Emit D-Bus signal

1343

1890

self.CheckerCompleted(dbus.Int16(exitstatus),

1344

dbus.Int64(condition),

1891

# This is specific to GNU libC

1892

dbus.Int64(exitstatus << 8),

1345

1893

dbus.String(command))

1346

1894

else:

1347

1895

# Emit D-Bus signal

1348

1896

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

1349

dbus.Int64(condition),

1897

dbus.Int64(

1898

# This is specific to GNU libC

1899

(exitstatus << 8)

1900

| self.last_checker_signal),

1350

1901

dbus.String(command))

1351

1352

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

1353

*args, **kwargs)

1354

1902

return ret

1903

1355

1904

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

1356

1905

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

1357

1906

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

1361

1910

# Emit D-Bus signal

1362

1911

self.CheckerStarted(self.current_checker_command)

1363

1912

return r

1364

1913

1365

1914

def _reset_approved(self):

1366

1915

self.approved = None

1367

1916

return False

1368

1917

1369

1918

def approve(self, value=True):

1370

1919

self.approved = value

1371

gobject.timeout_add(timedelta_to_milliseconds

1372

(self.approval_duration),

1373

self._reset_approved)

1920

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

1921

* 1000), self._reset_approved)

1374

1922

self.send_changedstate()

1375

1376

## D-Bus methods, signals & properties

1377

_interface = "se.recompile.Mandos.Client"

1378

1379

## Interfaces

1380

1381

@dbus_interface_annotations(_interface)

1382

def _foo(self):

1383

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

1384

"false"}

1385

1386

## Signals

1387

1923

1924

# D-Bus methods, signals & properties

1925

1926

# Interfaces

1927

1928

# Signals

1929

1388

1930

# CheckerCompleted - signal

1389

1931

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

1390

1932

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

1391

1933

"D-Bus signal"

1392

1934

pass

1393

1935

1394

1936

# CheckerStarted - signal

1395

1937

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

1396

1938

def CheckerStarted(self, command):

1397

1939

"D-Bus signal"

1398

1940

pass

1399

1941

1400

1942

# PropertyChanged - signal

1943

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

1401

1944

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

1402

1945

def PropertyChanged(self, property, value):

1403

1946

"D-Bus signal"

1404

1947

pass

1405

1948

1406

1949

# GotSecret - signal

1407

1950

@dbus.service.signal(_interface)

1408

1951

def GotSecret(self):

1411

1954

server to mandos-client

1412

1955

"""

1413

1956

pass

1414

1957

1415

1958

# Rejected - signal

1416

1959

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

1417

1960

def Rejected(self, reason):

1418

1961

"D-Bus signal"

1419

1962

pass

1420

1963

1421

1964

# NeedApproval - signal

1422

1965

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

1423

1966

def NeedApproval(self, timeout, default):

1424

1967

"D-Bus signal"

1425

1968

return self.need_approval()

1426

1427

## Methods

1428

1969

1970

# Methods

1971

1429

1972

# Approve - method

1430

1973

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

1431

1974

def Approve(self, value):

1432

1975

self.approve(value)

1433

1976

1434

1977

# CheckedOK - method

1435

1978

@dbus.service.method(_interface)

1436

1979

def CheckedOK(self):

1437

1980

self.checked_ok()

1438

1981

1439

1982

# Enable - method

1983

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

1440

1984

@dbus.service.method(_interface)

1441

1985

def Enable(self):

1442

1986

"D-Bus method"

1443

1987

self.enable()

1444

1988

1445

1989

# StartChecker - method

1990

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

1446

1991

@dbus.service.method(_interface)

1447

1992

def StartChecker(self):

1448

1993

"D-Bus method"

1449

1994

self.start_checker()

1450

1995

1451

1996

# Disable - method

1997

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

1452

1998

@dbus.service.method(_interface)

1453

1999

def Disable(self):

1454

2000

"D-Bus method"

1455

2001

self.disable()

1456

2002

1457

2003

# StopChecker - method

2004

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

1458

2005

@dbus.service.method(_interface)

1459

2006

def StopChecker(self):

1460

2007

self.stop_checker()

1461

1462

## Properties

1463

2008

2009

# Properties

2010

1464

2011

# ApprovalPending - property

1465

2012

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

1466

2013

def ApprovalPending_dbus_property(self):

1467

2014

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

1468

2015

1469

2016

# ApprovedByDefault - property

1470

@dbus_service_property(_interface, signature="b",

2017

@dbus_service_property(_interface,

2018

signature="b",

1471

2019

access="readwrite")

1472

2020

def ApprovedByDefault_dbus_property(self, value=None):

1473

2021

if value is None: # get

1474

2022

return dbus.Boolean(self.approved_by_default)

1475

2023

self.approved_by_default = bool(value)

1476

2024

1477

2025

# ApprovalDelay - property

1478

@dbus_service_property(_interface, signature="t",

2026

@dbus_service_property(_interface,

2027

signature="t",

1479

2028

access="readwrite")

1480

2029

def ApprovalDelay_dbus_property(self, value=None):

1481

2030

if value is None: # get

1482

return dbus.UInt64(self.approval_delay_milliseconds())

2031

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

2032

* 1000)

1483

2033

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

1484

2034

1485

2035

# ApprovalDuration - property

1486

@dbus_service_property(_interface, signature="t",

2036

@dbus_service_property(_interface,

2037

signature="t",

1487

2038

access="readwrite")

1488

2039

def ApprovalDuration_dbus_property(self, value=None):

1489

2040

if value is None: # get

1490

return dbus.UInt64(timedelta_to_milliseconds(

1491

self.approval_duration))

2041

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

2042

* 1000)

1492

2043

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

1493

2044

1494

2045

# Name - property

2046

@dbus_annotations(

2047

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

1495

2048

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

1496

2049

def Name_dbus_property(self):

1497

2050

return dbus.String(self.name)

1498

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

1499

2059

# Fingerprint - property

2060

@dbus_annotations(

2061

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

1500

2062

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

1501

2063

def Fingerprint_dbus_property(self):

1502

2064

return dbus.String(self.fingerprint)

1503

2065

1504

2066

# Host - property

1505

@dbus_service_property(_interface, signature="s",

2067

@dbus_service_property(_interface,

2068

signature="s",

1506

2069

access="readwrite")

1507

2070

def Host_dbus_property(self, value=None):

1508

2071

if value is None: # get

1509

2072

return dbus.String(self.host)

1510

self.host = unicode(value)

1511

2073

self.host = str(value)

2074

1512

2075

# Created - property

2076

@dbus_annotations(

2077

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

1513

2078

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

1514

2079

def Created_dbus_property(self):

1515

2080

return datetime_to_dbus(self.created)

1516

2081

1517

2082

# LastEnabled - property

1518

2083

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

1519

2084

def LastEnabled_dbus_property(self):

1520

2085

return datetime_to_dbus(self.last_enabled)

1521

2086

1522

2087

# Enabled - property

1523

@dbus_service_property(_interface, signature="b",

2088

@dbus_service_property(_interface,

2089

signature="b",

1524

2090

access="readwrite")

1525

2091

def Enabled_dbus_property(self, value=None):

1526

2092

if value is None: # get

1529

2095

self.enable()

1530

2096

else:

1531

2097

self.disable()

1532

2098

1533

2099

# LastCheckedOK - property

1534

@dbus_service_property(_interface, signature="s",

2100

@dbus_service_property(_interface,

2101

signature="s",

1535

2102

access="readwrite")

1536

2103

def LastCheckedOK_dbus_property(self, value=None):

1537

2104

if value is not None:

1538

2105

self.checked_ok()

1539

2106

return

1540

2107

return datetime_to_dbus(self.last_checked_ok)

1541

2108

1542

2109

# LastCheckerStatus - property

1543

@dbus_service_property(_interface, signature="n",

1544

access="read")

2110

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

1545

2111

def LastCheckerStatus_dbus_property(self):

1546

2112

return dbus.Int16(self.last_checker_status)

1547

2113

1548

2114

# Expires - property

1549

2115

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

1550

2116

def Expires_dbus_property(self):

1551

2117

return datetime_to_dbus(self.expires)

1552

2118

1553

2119

# LastApprovalRequest - property

1554

2120

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

1555

2121

def LastApprovalRequest_dbus_property(self):

1556

2122

return datetime_to_dbus(self.last_approval_request)

1557

2123

1558

2124

# Timeout - property

1559

@dbus_service_property(_interface, signature="t",

2125

@dbus_service_property(_interface,

2126

signature="t",

1560

2127

access="readwrite")

1561

2128

def Timeout_dbus_property(self, value=None):

1562

2129

if value is None: # get

1563

return dbus.UInt64(self.timeout_milliseconds())

2130

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

1564

2131

old_timeout = self.timeout

1565

2132

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

1566

2133

# Reschedule disabling

1574

2141

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

1575

2142

is None):

1576

2143

return

1577

gobject.source_remove(self.disable_initiator_tag)

1578

self.disable_initiator_tag = (

1579

gobject.timeout_add(

1580

timedelta_to_milliseconds(self.expires - now),

1581

self.disable))

1582

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

1583

2149

# ExtendedTimeout - property

1584

@dbus_service_property(_interface, signature="t",

2150

@dbus_service_property(_interface,

2151

signature="t",

1585

2152

access="readwrite")

1586

2153

def ExtendedTimeout_dbus_property(self, value=None):

1587

2154

if value is None: # get

1588

return dbus.UInt64(self.extended_timeout_milliseconds())

2155

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

2156

* 1000)

1589

2157

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

1590

2158

1591

2159

# Interval - property

1592

@dbus_service_property(_interface, signature="t",

2160

@dbus_service_property(_interface,

2161

signature="t",

1593

2162

access="readwrite")

1594

2163

def Interval_dbus_property(self, value=None):

1595

2164

if value is None: # get

1596

return dbus.UInt64(self.interval_milliseconds())

2165

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

1597

2166

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

1598

2167

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

1599

2168

return

1600

2169

if self.enabled:

1601

2170

# Reschedule checker run

1602

gobject.source_remove(self.checker_initiator_tag)

1603

self.checker_initiator_tag = (gobject.timeout_add

1604

(value, self.start_checker))

1605

self.start_checker() # Start one now, too

1606

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

1607

2176

# Checker - property

1608

@dbus_service_property(_interface, signature="s",

2177

@dbus_service_property(_interface,

2178

signature="s",

1609

2179

access="readwrite")

1610

2180

def Checker_dbus_property(self, value=None):

1611

2181

if value is None: # get

1612

2182

return dbus.String(self.checker_command)

1613

self.checker_command = unicode(value)

1614

2183

self.checker_command = str(value)

2184

1615

2185

# CheckerRunning - property

1616

@dbus_service_property(_interface, signature="b",

2186

@dbus_service_property(_interface,

2187

signature="b",

1617

2188

access="readwrite")

1618

2189

def CheckerRunning_dbus_property(self, value=None):

1619

2190

if value is None: # get

1622

2193

self.start_checker()

1623

2194

else:

1624

2195

self.stop_checker()

1625

2196

1626

2197

# ObjectPath - property

2198

@dbus_annotations(

2199

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

2200

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

1627

2201

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

1628

2202

def ObjectPath_dbus_property(self):

1629

return self.dbus_object_path # is already a dbus.ObjectPath

1630

2203

return self.dbus_object_path # is already a dbus.ObjectPath

2204

1631

2205

# Secret = property

1632

@dbus_service_property(_interface, signature="ay",

1633

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)

1634

2213

def Secret_dbus_property(self, value):

1635

self.secret = str(value)

1636

2214

self.secret = bytes(value)

2215

1637

2216

del _interface

1638

2217

1639

2218

1640

class ProxyClient(object):

1641

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

2219

class ProxyClient:

2220

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

1642

2221

self._pipe = child_pipe

1643

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

2222

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

1644

2223

if not self._pipe.recv():

1645

raise KeyError()

1646

2224

raise KeyError(key_id or fpr)

2225

1647

2226

def __getattribute__(self, name):

1648

2227

if name == '_pipe':

1649

2228

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

1652

2231

if data[0] == 'data':

1653

2232

return data[1]

1654

2233

if data[0] == 'function':

2234

1655

2235

def func(*args, **kwargs):

1656

2236

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

1657

2237

return self._pipe.recv()[1]

2238

1658

2239

return func

1659

2240

1660

2241

def __setattr__(self, name, value):

1661

2242

if name == '_pipe':

1662

2243

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

1665

2246

1666

2247

class ClientHandler(socketserver.BaseRequestHandler, object):

1667

2248

"""A class to handle client connections.

1668

2249

1669

2250

Instantiated once for each connection to handle it.

1670

2251

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

1671

2252

1672

2253

def handle(self):

1673

2254

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

1674

2255

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

1675

unicode(self.client_address))

2256

str(self.client_address))

1676

2257

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

1677

2258

self.server.child_pipe.fileno())

1678

1679

session = (gnutls.connection

1680

.ClientSession(self.request,

1681

gnutls.connection

1682

.X509Credentials()))

1683

1684

# Note: gnutls.connection.X509Credentials is really a

1685

# generic GnuTLS certificate credentials object so long as

1686

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

1687

# here despite using OpenPGP certificates.

1688

1689

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

1690

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

1691

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

1692

# "+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"))

1693

2266

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

1694

2267

priority = self.server.gnutls_priority

1695

2268

if priority is None:

1696

2269

priority = "NORMAL"

1697

(gnutls.library.functions

1698

.gnutls_priority_set_direct(session._c_object,

1699

priority, None))

1700

2270

gnutls.priority_set_direct(session._c_object,

2271

priority.encode("utf-8"),

2272

None)

2273

1701

2274

# Start communication using the Mandos protocol

1702

2275

# Get protocol number

1703

2276

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

1708

2281

except (ValueError, IndexError, RuntimeError) as error:

1709

2282

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

1710

2283

return

1711

2284

1712

2285

# Start GnuTLS connection

1713

2286

try:

1714

2287

session.handshake()

1715

except gnutls.errors.GNUTLSError as error:

2288

except gnutls.Error as error:

1716

2289

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

1717

2290

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

1718

2291

# established. Just abandon the request.

1719

2292

return

1720

2293

logger.debug("Handshake succeeded")

1721

2294

1722

2295

approval_required = False

1723

2296

try:

1724

try:

1725

fpr = self.fingerprint(self.peer_certificate

1726

(session))

1727

except (TypeError,

1728

gnutls.errors.GNUTLSError) as error:

1729

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

1730

return

1731

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

1732

1733

try:

1734

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,

1735

2319

self.client_address)

1736

2320

except KeyError:

1737

2321

return

1738

2322

1739

2323

if client.approval_delay:

1740

2324

delay = client.approval_delay

1741

2325

client.approvals_pending += 1

1742

2326

approval_required = True

1743

2327

1744

2328

while True:

1745

2329

if not client.enabled:

1746

2330

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

1747

client.name)

2331

client.name)

1748

2332

if self.server.use_dbus:

1749

2333

# Emit D-Bus signal

1750

2334

client.Rejected("Disabled")

1751

2335

return

1752

2336

1753

2337

if client.approved or not client.approval_delay:

1754

#We are approved or approval is disabled

2338

# We are approved or approval is disabled

1755

2339

break

1756

2340

elif client.approved is None:

1757

2341

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

1759

2343

if self.server.use_dbus:

1760

2344

# Emit D-Bus signal

1761

2345

client.NeedApproval(

1762

client.approval_delay_milliseconds(),

1763

client.approved_by_default)

2346

client.approval_delay.total_seconds()

2347

* 1000, client.approved_by_default)

1764

2348

else:

1765

2349

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

1766

2350

client.name)

1768

2352

# Emit D-Bus signal

1769

2353

client.Rejected("Denied")

1770

2354

return

1771

1772

#wait until timeout or approved

2355

2356

# wait until timeout or approved

1773

2357

time = datetime.datetime.now()

1774

2358

client.changedstate.acquire()

1775

client.changedstate.wait(

1776

float(timedelta_to_milliseconds(delay)

1777

/ 1000))

2359

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

1778

2360

client.changedstate.release()

1779

2361

time2 = datetime.datetime.now()

1780

2362

if (time2 - time) >= delay:

1790

2372

break

1791

2373

else:

1792

2374

delay -= time2 - time

1793

1794

sent_size = 0

1795

while sent_size < len(client.secret):

1796

try:

1797

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

1798

except gnutls.errors.GNUTLSError as error:

1799

logger.warning("gnutls send failed",

1800

exc_info=error)

1801

return

1802

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

1803

sent, len(client.secret)

1804

- (sent_size + sent))

1805

sent_size += sent

1806

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

1807

2383

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

1808

2384

# bump the timeout using extended_timeout

1809

2385

client.bump_timeout(client.extended_timeout)

1810

2386

if self.server.use_dbus:

1811

2387

# Emit D-Bus signal

1812

2388

client.GotSecret()

1813

2389

1814

2390

finally:

1815

2391

if approval_required:

1816

2392

client.approvals_pending -= 1

1817

2393

try:

1818

2394

session.bye()

1819

except gnutls.errors.GNUTLSError as error:

2395

except gnutls.Error as error:

1820

2396

logger.warning("GnuTLS bye failed",

1821

2397

exc_info=error)

1822

2398

1823

2399

@staticmethod

1824

2400

def peer_certificate(session):

1825

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

1826

# If not an OpenPGP certificate...

1827

if (gnutls.library.functions

1828

.gnutls_certificate_type_get(session._c_object)

1829

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1830

# ...do the normal thing

1831

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

1832

2417

list_size = ctypes.c_uint(1)

1833

cert_list = (gnutls.library.functions

1834

.gnutls_certificate_get_peers

2418

cert_list = (gnutls.certificate_get_peers

1835

2419

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

1836

2420

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

1837

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

1838

" certificate")

2421

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

1839

2422

if list_size.value == 0:

1840

2423

return None

1841

2424

cert = cert_list[0]

1842

2425

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

1843

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

1844

2461

@staticmethod

1845

2462

def fingerprint(openpgp):

1846

2463

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1847

2464

# New GnuTLS "datum" with the OpenPGP public key

1848

datum = (gnutls.library.types

1849

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

1850

ctypes.POINTER

1851

(ctypes.c_ubyte)),

1852

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

1853

2469

# New empty GnuTLS certificate

1854

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1855

(gnutls.library.functions

1856

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2470

crt = gnutls.openpgp_crt_t()

2471

gnutls.openpgp_crt_init(ctypes.byref(crt))

1857

2472

# Import the OpenPGP public key into the certificate

1858

(gnutls.library.functions

1859

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

1860

gnutls.library.constants

1861

.GNUTLS_OPENPGP_FMT_RAW))

2473

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

2474

gnutls.OPENPGP_FMT_RAW)

1862

2475

# Verify the self signature in the key

1863

2476

crtverify = ctypes.c_uint()

1864

(gnutls.library.functions

1865

.gnutls_openpgp_crt_verify_self(crt, 0,

1866

ctypes.byref(crtverify)))

2477

gnutls.openpgp_crt_verify_self(crt, 0,

2478

ctypes.byref(crtverify))

1867

2479

if crtverify.value != 0:

1868

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1869

raise (gnutls.errors.CertificateSecurityError

1870

("Verify failed"))

2480

gnutls.openpgp_crt_deinit(crt)

2481

raise gnutls.CertificateSecurityError(code

2482

=crtverify.value)

1871

2483

# New buffer for the fingerprint

1872

2484

buf = ctypes.create_string_buffer(20)

1873

2485

buf_len = ctypes.c_size_t()

1874

2486

# Get the fingerprint from the certificate into the buffer

1875

(gnutls.library.functions

1876

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

1877

ctypes.byref(buf_len)))

2487

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

2488

ctypes.byref(buf_len))

1878

2489

# Deinit the certificate

1879

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2490

gnutls.openpgp_crt_deinit(crt)

1880

2491

# Convert the buffer to a Python bytestring

1881

2492

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

1882

2493

# Convert the bytestring to hexadecimal notation

1884

2495

return hex_fpr

1885

2496

1886

2497

1887

class MultiprocessingMixIn(object):

2498

class MultiprocessingMixIn:

1888

2499

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

2500

1889

2501

def sub_process_main(self, request, address):

1890

2502

try:

1891

2503

self.finish_request(request, address)

1892

2504

except Exception:

1893

2505

self.handle_error(request, address)

1894

2506

self.close_request(request)

1895

2507

1896

2508

def process_request(self, request, address):

1897

2509

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

1898

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

1899

args = (request, address))

2510

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

2511

args=(request, address))

1900

2512

proc.start()

1901

2513

return proc

1902

2514

1903

2515

1904

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2516

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1905

2517

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

2518

1906

2519

def process_request(self, request, client_address):

1907

2520

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

1908

2521

1909

2522

This function creates a new pipe in self.pipe

1910

2523

"""

1911

2524

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1912

2525

1913

2526

proc = MultiprocessingMixIn.process_request(self, request,

1914

2527

client_address)

1915

2528

self.child_pipe.close()

1916

2529

self.add_pipe(parent_pipe, proc)

1917

2530

1918

2531

def add_pipe(self, parent_pipe, proc):

1919

2532

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

1920

2533

raise NotImplementedError()

1921

2534

1922

2535

1923

2536

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1924

socketserver.TCPServer, object):

2537

socketserver.TCPServer):

1925

2538

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

1926

2539

1927

2540

Attributes:

1928

2541

enabled: Boolean; whether this server is activated yet

1929

2542

interface: None or a network interface name (string)

1930

2543

use_ipv6: Boolean; to use IPv6 or not

1931

2544

"""

2545

1932

2546

def __init__(self, server_address, RequestHandlerClass,

1933

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

2547

interface=None,

2548

use_ipv6=True,

2549

socketfd=None):

1934

2550

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

1935

2551

creating a new one with socket.socket().

1936

2552

"""

1942

2558

self.socketfd = socketfd

1943

2559

# Save the original socket.socket() function

1944

2560

self.socket_socket = socket.socket

2561

1945

2562

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

1946

#

2563

#

1947

2564

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

1948

2565

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

1949

2566

# patching socket.socket.)

1950

#

2567

#

1951

2568

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

1952

2569

@functools.wraps(socket.socket)

1953

2570

def socket_wrapper(*args, **kwargs):

1965

2582

# socket_wrapper(), if socketfd was set.

1966

2583

socketserver.TCPServer.__init__(self, server_address,

1967

2584

RequestHandlerClass)

1968

2585

1969

2586

def server_bind(self):

1970

2587

"""This overrides the normal server_bind() function

1971

2588

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

1972

2589

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

2590

global SO_BINDTODEVICE

1973

2591

if self.interface is not None:

1974

2592

if SO_BINDTODEVICE is None:

1975

logger.error("SO_BINDTODEVICE does not exist;"

1976

" cannot bind to interface %s",

1977

self.interface)

1978

else:

1979

try:

1980

self.socket.setsockopt(socket.SOL_SOCKET,

1981

SO_BINDTODEVICE,

1982

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

1983

except socket.error as error:

1984

if error.errno == errno.EPERM:

1985

logger.error("No permission to bind to"

1986

" interface %s", self.interface)

1987

elif error.errno == errno.ENOPROTOOPT:

1988

logger.error("SO_BINDTODEVICE not available;"

1989

" cannot bind to interface %s",

1990

self.interface)

1991

elif error.errno == errno.ENODEV:

1992

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

1993

" cannot bind", self.interface)

1994

else:

1995

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

1996

2614

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

1997

2615

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

2616

if self.server_address[1]:

2617

self.allow_reuse_address = True

1998

2618

if not self.server_address[0]:

1999

2619

if self.address_family == socket.AF_INET6:

2000

any_address = "::" # in6addr_any

2620

any_address = "::" # in6addr_any

2001

2621

else:

2002

any_address = "0.0.0.0" # INADDR_ANY

2622

any_address = "0.0.0.0" # INADDR_ANY

2003

2623

self.server_address = (any_address,

2004

2624

self.server_address[1])

2005

2625

elif not self.server_address[1]:

2006

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

2007

0)

2626

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

2008

2627

# if self.interface:

2009

2628

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

2010

2629

# 0, # port

2016

2635

2017

2636

class MandosServer(IPv6_TCPServer):

2018

2637

"""Mandos server.

2019

2638

2020

2639

Attributes:

2021

2640

clients: set of Client objects

2022

2641

gnutls_priority GnuTLS priority string

2023

2642

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

2024

2025

Assumes a gobject.MainLoop event loop.

2643

2644

Assumes a GLib.MainLoop event loop.

2026

2645

"""

2646

2027

2647

def __init__(self, server_address, RequestHandlerClass,

2028

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

2029

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

2030

2654

self.enabled = False

2031

2655

self.clients = clients

2032

2656

if self.clients is None:

2035

2659

self.gnutls_priority = gnutls_priority

2036

2660

IPv6_TCPServer.__init__(self, server_address,

2037

2661

RequestHandlerClass,

2038

interface = interface,

2039

use_ipv6 = use_ipv6,

2040

socketfd = socketfd)

2662

interface=interface,

2663

use_ipv6=use_ipv6,

2664

socketfd=socketfd)

2665

2041

2666

def server_activate(self):

2042

2667

if self.enabled:

2043

2668

return socketserver.TCPServer.server_activate(self)

2044

2669

2045

2670

def enable(self):

2046

2671

self.enabled = True

2047

2672

2048

2673

def add_pipe(self, parent_pipe, proc):

2049

2674

# Call "handle_ipc" for both data and EOF events

2050

gobject.io_add_watch(parent_pipe.fileno(),

2051

gobject.IO_IN | gobject.IO_HUP,

2052

functools.partial(self.handle_ipc,

2053

parent_pipe =

2054

parent_pipe,

2055

proc = proc))

2056

2057

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

2058

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

2059

2686

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

2060

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

2687

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

2061

2688

# Wait for other process to exit

2062

2689

proc.join()

2063

2690

return False

2064

2691

2065

2692

# Read a request from the child

2066

2693

request = parent_pipe.recv()

2067

2694

command = request[0]

2068

2695

2069

2696

if command == 'init':

2070

fpr = request[1]

2071

address = request[2]

2072

2073

for c in self.clients.itervalues():

2074

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:

2075

2708

client = c

2076

2709

break

2077

2710

else:

2078

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

2079

"dress: %s", fpr, address)

2711

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

2712

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

2080

2713

if self.use_dbus:

2081

2714

# Emit D-Bus signal

2082

mandos_dbus_service.ClientNotFound(fpr,

2715

mandos_dbus_service.ClientNotFound(key_id or fpr,

2083

2716

address[0])

2084

2717

parent_pipe.send(False)

2085

2718

return False

2086

2087

gobject.io_add_watch(parent_pipe.fileno(),

2088

gobject.IO_IN | gobject.IO_HUP,

2089

functools.partial(self.handle_ipc,

2090

parent_pipe =

2091

parent_pipe,

2092

proc = proc,

2093

client_object =

2094

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

2095

2727

parent_pipe.send(True)

2096

2728

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

2097

2729

# same fileno

2100

2732

funcname = request[1]

2101

2733

args = request[2]

2102

2734

kwargs = request[3]

2103

2735

2104

2736

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

2105

2737

funcname)(*args,

2106

**kwargs)))

2107

2738

**kwargs)))

2739

2108

2740

if command == 'getattr':

2109

2741

attrname = request[1]

2110

if callable(client_object.__getattribute__(attrname)):

2111

parent_pipe.send(('function',))

2742

if isinstance(client_object.__getattribute__(attrname),

2743

collections.Callable):

2744

parent_pipe.send(('function', ))

2112

2745

else:

2113

parent_pipe.send(('data', client_object

2114

.__getattribute__(attrname)))

2115

2746

parent_pipe.send((

2747

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

2748

2116

2749

if command == 'setattr':

2117

2750

attrname = request[1]

2118

2751

value = request[2]

2119

2752

setattr(client_object, attrname, value)

2120

2753

2121

2754

return True

2122

2755

2123

2756

2124

2757

def rfc3339_duration_to_delta(duration):

2125

2758

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

2126

2759

2127

2760

>>> rfc3339_duration_to_delta("P7D")

2128

2761

datetime.timedelta(7)

2129

2762

>>> rfc3339_duration_to_delta("PT60S")

2139

2772

>>> rfc3339_duration_to_delta("P1DT3M20S")

2140

2773

datetime.timedelta(1, 200)

2141

2774

"""

2142

2775

2143

2776

# Parsing an RFC 3339 duration with regular expressions is not

2144

2777

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

2145

2778

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

2146

2779

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

2147

2780

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

2148

2781

# avoid excessive use of external libraries.

2149

2782

2150

2783

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

2151

Token = collections.namedtuple("Token",

2152

("regexp", # To match token; if

2153

# "value" is not None,

2154

# must have a "group"

2155

# containing digits

2156

"value", # datetime.timedelta or

2157

# None

2158

"followers")) # Tokens valid after

2159

# 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

2160

2789

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

2161

2790

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

2162

2791

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

2163

2792

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

2164

2793

datetime.timedelta(seconds=1),

2165

frozenset((token_end,)))

2794

frozenset((token_end, )))

2166

2795

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

2167

2796

datetime.timedelta(minutes=1),

2168

2797

frozenset((token_second, token_end)))

2184

2813

frozenset((token_month, token_end)))

2185

2814

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

2186

2815

datetime.timedelta(weeks=1),

2187

frozenset((token_end,)))

2816

frozenset((token_end, )))

2188

2817

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

2189

2818

frozenset((token_year, token_month,

2190

2819

token_day, token_time,

2191

token_week))),

2192

# Define starting values

2193

value = datetime.timedelta() # Value so far

2820

token_week)))

2821

# Define starting values:

2822

# Value so far

2823

value = datetime.timedelta()

2194

2824

found_token = None

2195

followers = frozenset(token_duration,) # Following valid tokens

2196

s = duration # String left to parse

2825

# Following valid tokens

2826

followers = frozenset((token_duration, ))

2827

# String left to parse

2828

s = duration

2197

2829

# Loop until end token is found

2198

2830

while found_token is not token_end:

2199

2831

# Search for any currently valid tokens

2215

2847

break

2216

2848

else:

2217

2849

# No currently valid tokens were found

2218

raise ValueError("Invalid RFC 3339 duration")

2850

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

2851

.format(duration))

2219

2852

# End token found

2220

2853

return value

2221

2854

2222

2855

2223

2856

def string_to_delta(interval):

2224

2857

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

2225

2858

2226

2859

>>> string_to_delta('7d')

2227

2860

datetime.timedelta(7)

2228

2861

>>> string_to_delta('60s')

2236

2869

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

2237

2870

datetime.timedelta(0, 330)

2238

2871

"""

2239

2872

2240

2873

try:

2241

2874

return rfc3339_duration_to_delta(interval)

2242

2875

except ValueError:

2243

2876

pass

2244

2877

2245

2878

timevalue = datetime.timedelta(0)

2246

2879

for s in interval.split():

2247

2880

try:

2248

suffix = unicode(s[-1])

2881

suffix = s[-1]

2249

2882

value = int(s[:-1])

2250

2883

if suffix == "d":

2251

2884

delta = datetime.timedelta(value)

2258

2891

elif suffix == "w":

2259

2892

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

2260

2893

else:

2261

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

2262

.format(suffix))

2894

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

2263

2895

except IndexError as e:

2264

2896

raise ValueError(*(e.args))

2265

2897

timevalue += delta

2266

2898

return timevalue

2267

2899

2268

2900

2269

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

2901

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

2270

2902

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

2271

2903

2272

2904

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

2273

2905

if os.fork():

2274

2906

sys.exit()

2282

2914

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

2283

2915

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

2284

2916

raise OSError(errno.ENODEV,

2285

"{0} not a character device"

2917

"{} not a character device"

2286

2918

.format(os.devnull))

2287

2919

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

2288

2920

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

2292

2924

2293

2925

2294

2926

def main():

2295

2927

2296

2928

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

2297

2929

# Parsing of options, both command line and config file

2298

2930

2299

2931

parser = argparse.ArgumentParser()

2300

2932

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

2301

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

2933

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

2302

2934

help="show version number and exit")

2303

2935

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

2304

2936

help="Bind to interface IF")

2337

2969

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

2338

2970

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

2339

2971

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

2340

2972

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

2973

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

2974

default=None)

2975

2341

2976

options = parser.parse_args()

2342

2977

2343

2978

if options.check:

2344

2979

import doctest

2345

2980

fail_count, test_count = doctest.testmod()

2346

2981

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

2347

2982

2348

2983

# Default values for config file for server-global settings

2349

server_defaults = { "interface": "",

2350

"address": "",

2351

"port": "",

2352

"debug": "False",

2353

"priority":

2354

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

2355

"servicename": "Mandos",

2356

"use_dbus": "True",

2357

"use_ipv6": "True",

2358

"debuglevel": "",

2359

"restore": "True",

2360

"socket": "",

2361

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

2362

"foreground": "False",

2363

}

2364

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

2365

3007

# Parse config file for server-global settings

2366

server_config = configparser.SafeConfigParser(server_defaults)

3008

server_config = configparser.ConfigParser(server_defaults)

2367

3009

del server_defaults

2368

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

2369

"mandos.conf"))

2370

# 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

2371

3012

server_settings = server_config.defaults()

2372

3013

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

2373

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

3014

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

3015

"foreground", "zeroconf"):

2374

3016

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

2375

3017

option)

2376

3018

if server_settings["port"]:

2386

3028

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

2387

3029

["socket"])

2388

3030

del server_config

2389

3031

2390

3032

# Override the settings from the config file with command line

2391

3033

# options, if set.

2392

3034

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

2393

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

2394

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

2395

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

3035

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

3036

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

3037

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

2396

3038

value = getattr(options, option)

2397

3039

if value is not None:

2398

3040

server_settings[option] = value

2399

3041

del options

2400

3042

# Force all strings to be unicode

2401

3043

for option in server_settings.keys():

2402

if type(server_settings[option]) is str:

2403

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

2404

3047

# Force all boolean options to be boolean

2405

3048

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

2406

"foreground"):

3049

"foreground", "zeroconf"):

2407

3050

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

2408

3051

# Debug implies foreground

2409

3052

if server_settings["debug"]:

2410

3053

server_settings["foreground"] = True

2411

3054

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

2412

3055

2413

3056

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

2414

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

2415

3063

# For convenience

2416

3064

debug = server_settings["debug"]

2417

3065

debuglevel = server_settings["debuglevel"]

2420

3068

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

2421

3069

stored_state_file)

2422

3070

foreground = server_settings["foreground"]

2423

3071

zeroconf = server_settings["zeroconf"]

3072

2424

3073

if debug:

2425

3074

initlogger(debug, logging.DEBUG)

2426

3075

else:

2429

3078

else:

2430

3079

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

2431

3080

initlogger(debug, level)

2432

3081

2433

3082

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

2434

syslogger.setFormatter(logging.Formatter

2435

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

2436

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

2437

.format(server_settings

2438

["servicename"])))

2439

3083

syslogger.setFormatter(

3084

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

3085

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

3086

server_settings["servicename"])))

3087

2440

3088

# Parse config file with clients

2441

client_config = configparser.SafeConfigParser(Client

2442

.client_defaults)

3089

client_config = configparser.ConfigParser(Client.client_defaults)

2443

3090

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

2444

3091

"clients.conf"))

2445

3092

2446

3093

global mandos_dbus_service

2447

3094

mandos_dbus_service = None

2448

2449

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

2450

server_settings["port"]),

2451

ClientHandler,

2452

interface=(server_settings["interface"]

2453

or None),

2454

use_ipv6=use_ipv6,

2455

gnutls_priority=

2456

server_settings["priority"],

2457

use_dbus=use_dbus,

2458

socketfd=(server_settings["socket"]

2459

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)

2460

3107

if not foreground:

2461

3108

pidfilename = "/run/mandos.pid"

2462

3109

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

2463

3110

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

2464

3111

pidfile = None

2465

3112

try:

2466

pidfile = open(pidfilename, "w")

3113

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

2467

3114

except IOError as e:

2468

3115

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

2469

3116

exc_info=e)

2470

2471

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

3117

3118

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

3119

("mandos", "mandos"),

3120

("nobody", "nogroup")):

2472

3121

try:

2473

3122

uid = pwd.getpwnam(name).pw_uid

2474

gid = pwd.getpwnam(name).pw_gid

3123

gid = pwd.getpwnam(group).pw_gid

2475

3124

break

2476

3125

except KeyError:

2477

3126

continue

2481

3130

try:

2482

3131

os.setgid(gid)

2483

3132

os.setuid(uid)

3133

if debug:

3134

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

3135

gid))

2484

3136

except OSError as error:

3137

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

3138

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

2485

3139

if error.errno != errno.EPERM:

2486

3140

raise

2487

3141

2488

3142

if debug:

2489

3143

# Enable all possible GnuTLS debugging

2490

3144

2491

3145

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

2492

3146

# - GnuTLS manual

2493

gnutls.library.functions.gnutls_global_set_log_level(11)

2494

2495

@gnutls.library.types.gnutls_log_func

3147

gnutls.global_set_log_level(11)

3148

3149

@gnutls.log_func

2496

3150

def debug_gnutls(level, string):

2497

3151

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

2498

2499

(gnutls.library.functions

2500

.gnutls_global_set_log_function(debug_gnutls))

2501

3152

3153

gnutls.global_set_log_function(debug_gnutls)

3154

2502

3155

# Redirect stdin so all checkers get /dev/null

2503

3156

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

2504

3157

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

2505

3158

if null > 2:

2506

3159

os.close(null)

2507

3160

2508

3161

# Need to fork before connecting to D-Bus

2509

3162

if not foreground:

2510

3163

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

2511

3164

daemon()

2512

2513

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

2514

# need to inform gobject that threads will be used.

2515

gobject.threads_init()

2516

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

2517

3171

global main_loop

2518

3172

# From the Avahi example code

2519

3173

DBusGMainLoop(set_as_default=True)

2520

main_loop = gobject.MainLoop()

3174

main_loop = GLib.MainLoop()

2521

3175

bus = dbus.SystemBus()

2522

3176

# End of Avahi example code

2523

3177

if use_dbus:

2524

3178

try:

2525

3179

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

2526

bus, do_not_queue=True)

2527

old_bus_name = (dbus.service.BusName

2528

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

2529

do_not_queue=True))

2530

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:

2531

3186

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

2532

3187

use_dbus = False

2533

3188

server_settings["use_dbus"] = False

2534

3189

tcp_server.use_dbus = False

2535

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2536

service = AvahiServiceToSyslog(name =

2537

server_settings["servicename"],

2538

servicetype = "_mandos._tcp",

2539

protocol = protocol, bus = bus)

2540

if server_settings["interface"]:

2541

service.interface = (if_nametoindex

2542

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

2543

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

2544

3201

global multiprocessing_manager

2545

3202

multiprocessing_manager = multiprocessing.Manager()

2546

3203

2547

3204

client_class = Client

2548

3205

if use_dbus:

2549

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

2550

3206

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

3207

2551

3208

client_settings = Client.config_parser(client_config)

2552

3209

old_client_settings = {}

2553

3210

clients_data = {}

2554

3211

2555

3212

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

2556

3213

global wnull

2557

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

3214

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

2558

3215

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

2559

3216

# mode

2560

3217

if debug or not foreground:

2561

3218

wnull.close()

2562

3219

2563

3220

# Get client data and settings from last running state.

2564

3221

if server_settings["restore"]:

2565

3222

try:

2566

3223

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

2567

clients_data, old_client_settings = (pickle.load

2568

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

2569

3273

os.remove(stored_state_path)

2570

3274

except IOError as e:

2571

3275

if e.errno == errno.ENOENT:

2572

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

2573

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

3276

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

3277

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

2574

3278

else:

2575

3279

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

2576

3280

exc_info=e)

2577

3281

raise

2578

3282

except EOFError as e:

2579

3283

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

2580

"EOFError:", exc_info=e)

2581

3284

"EOFError:",

3285

exc_info=e)

3286

2582

3287

with PGPEngine() as pgp:

2583

for client_name, client in clients_data.iteritems():

3288

for client_name, client in clients_data.items():

2584

3289

# Skip removed clients

2585

3290

if client_name not in client_settings:

2586

3291

continue

2587

3292

2588

3293

# Decide which value to use after restoring saved state.

2589

3294

# We have three different values: Old config file,

2590

3295

# new config file, and saved state.

2595

3300

# For each value in new config, check if it

2596

3301

# differs from the old config value (Except for

2597

3302

# the "secret" attribute)

2598

if (name != "secret" and

2599

value != old_client_settings[client_name]

2600

[name]):

3303

if (name != "secret"

3304

and (value !=

3305

old_client_settings[client_name][name])):

2601

3306

client[name] = value

2602

3307

except KeyError:

2603

3308

pass

2604

3309

2605

3310

# Clients who has passed its expire date can still be

2606

# enabled if its last checker was successful. Clients

3311

# enabled if its last checker was successful. A Client

2607

3312

# whose checker succeeded before we stored its state is

2608

3313

# assumed to have successfully run all checkers during

2609

3314

# downtime.

2611

3316

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

2612

3317

if not client["last_checked_ok"]:

2613

3318

logger.warning(

2614

"disabling client {0} - Client never "

2615

"performed a successful checker"

2616

.format(client_name))

3319

"disabling client {} - Client never "

3320

"performed a successful checker".format(

3321

client_name))

2617

3322

client["enabled"] = False

2618

3323

elif client["last_checker_status"] != 0:

2619

3324

logger.warning(

2620

"disabling client {0} - Client "

2621

"last checker failed with error code {1}"

2622

.format(client_name,

2623

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

2624

3330

client["enabled"] = False

2625

3331

else:

2626

client["expires"] = (datetime.datetime

2627

.utcnow()

2628

+ client["timeout"])

3332

client["expires"] = (

3333

datetime.datetime.utcnow()

3334

+ client["timeout"])

2629

3335

logger.debug("Last checker succeeded,"

2630

" keeping {0} enabled"

2631

.format(client_name))

3336

" keeping {} enabled".format(

3337

client_name))

2632

3338

try:

2633

client["secret"] = (

2634

pgp.decrypt(client["encrypted_secret"],

2635

client_settings[client_name]

2636

["secret"]))

3339

client["secret"] = pgp.decrypt(

3340

client["encrypted_secret"],

3341

client_settings[client_name]["secret"])

2637

3342

except PGPError:

2638

3343

# If decryption fails, we use secret from new settings

2639

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

2640

.format(client_name))

2641

client["secret"] = (

2642

client_settings[client_name]["secret"])

2643

3344

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

3345

client_name))

3346

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

3347

["secret"])

3348

2644

3349

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

2645

3350

for client_name in (set(old_client_settings)

2646

3351

- set(client_settings)):

2648

3353

for client_name in (set(client_settings)

2649

3354

- set(old_client_settings)):

2650

3355

clients_data[client_name] = client_settings[client_name]

2651

3356

2652

3357

# Create all client objects

2653

for client_name, client in clients_data.iteritems():

3358

for client_name, client in clients_data.items():

2654

3359

tcp_server.clients[client_name] = client_class(

2655

name = client_name, settings = client,

2656

server_settings = server_settings)

2657

3360

name=client_name,

3361

settings=client,

3362

server_settings=server_settings)

3363

2658

3364

if not tcp_server.clients:

2659

3365

logger.warning("No clients defined")

2660

3366

2661

3367

if not foreground:

2662

3368

if pidfile is not None:

3369

pid = os.getpid()

2663

3370

try:

2664

3371

with pidfile:

2665

pid = os.getpid()

2666

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

3372

print(pid, file=pidfile)

2667

3373

except IOError:

2668

3374

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

2669

3375

pidfilename, pid)

2670

3376

del pidfile

2671

3377

del pidfilename

2672

2673

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

2674

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

2675

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

2676

3383

if use_dbus:

2677

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

2678

"se.bsnet.fukt.Mandos"})

2679

class MandosDBusService(DBusObjectWithProperties):

3384

3385

@alternate_dbus_interfaces(

3386

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

3387

class MandosDBusService(DBusObjectWithObjectManager):

2680

3388

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

3389

2681

3390

def __init__(self):

2682

3391

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

3392

2683

3393

_interface = "se.recompile.Mandos"

2684

2685

@dbus_interface_annotations(_interface)

2686

def _foo(self):

2687

return { "org.freedesktop.DBus.Property"

2688

".EmitsChangedSignal":

2689

"false"}

2690

3394

2691

3395

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

2692

3396

def ClientAdded(self, objpath):

2693

3397

"D-Bus signal"

2694

3398

pass

2695

3399

2696

3400

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

2697

def ClientNotFound(self, fingerprint, address):

3401

def ClientNotFound(self, key_id, address):

2698

3402

"D-Bus signal"

2699

3403

pass

2700

3404

3405

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

3406

"true"})

2701

3407

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

2702

3408

def ClientRemoved(self, objpath, name):

2703

3409

"D-Bus signal"

2704

3410

pass

2705

3411

3412

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

3413

"true"})

2706

3414

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

2707

3415

def GetAllClients(self):

2708

3416

"D-Bus method"

2709

return dbus.Array(c.dbus_object_path

2710

for c in

2711

tcp_server.clients.itervalues())

2712

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

2713

3422

@dbus.service.method(_interface,

2714

3423

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

2715

3424

def GetAllClientsWithProperties(self):

2716

3425

"D-Bus method"

2717

3426

return dbus.Dictionary(

2718

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

2719

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()},

2720

3430

signature="oa{sv}")

2721

3431

2722

3432

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

2723

3433

def RemoveClient(self, object_path):

2724

3434

"D-Bus method"

2725

for c in tcp_server.clients.itervalues():

3435

for c in tcp_server.clients.values():

2726

3436

if c.dbus_object_path == object_path:

2727

3437

del tcp_server.clients[c.name]

2728

3438

c.remove_from_connection()

2729

# Don't signal anything except ClientRemoved

3439

# Don't signal the disabling

2730

3440

c.disable(quiet=True)

2731

# Emit D-Bus signal

2732

self.ClientRemoved(object_path, c.name)

3441

# Emit D-Bus signal for removal

3442

self.client_removed_signal(c)

2733

3443

return

2734

3444

raise KeyError(object_path)

2735

3445

2736

3446

del _interface

2737

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

2738

3484

mandos_dbus_service = MandosDBusService()

2739

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

2740

3491

def cleanup():

2741

3492

"Cleanup function; run on exit"

2742

service.cleanup()

2743

2744

multiprocessing.active_children()

2745

wnull.close()

3493

if zeroconf:

3494

service.cleanup()

3495

3496

mp.active_children()

3497

wn.close()

2746

3498

if not (tcp_server.clients or client_settings):

2747

3499

return

2748

3500

2749

3501

# Store client before exiting. Secrets are encrypted with key

2750

3502

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

2751

3503

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

2752

3504

clients = {}

2753

3505

with PGPEngine() as pgp:

2754

for client in tcp_server.clients.itervalues():

3506

for client in tcp_server.clients.values():

2755

3507

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

2756

3508

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

2757

3509

key)

2758

3510

client_dict = {}

2759

3511

2760

3512

# A list of attributes that can not be pickled

2761

3513

# + secret.

2762

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

2763

"checker", "server_settings"))

2764

for name, typ in (inspect.getmembers

2765

(dbus.service.Object)):

3514

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

3515

"checker", "server_settings"}

3516

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

3517

.Object):

2766

3518

exclude.add(name)

2767

3519

2768

3520

client_dict["encrypted_secret"] = (client

2769

3521

.encrypted_secret)

2770

3522

for attr in client.client_structure:

2771

3523

if attr not in exclude:

2772

3524

client_dict[attr] = getattr(client, attr)

2773

3525

2774

3526

clients[client.name] = client_dict

2775

3527

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

2776

3528

2777

3529

try:

2778

with (tempfile.NamedTemporaryFile

2779

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

2780

dir=os.path.dirname(stored_state_path),

2781

delete=False)) as stored_state:

2782

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

2783

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

2784

3539

os.rename(tempname, stored_state_path)

2785

3540

except (IOError, OSError) as e:

2786

3541

if not debug:

2789

3544

except NameError:

2790

3545

pass

2791

3546

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

2792

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

3547

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

2793

3548

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

2794

3549

else:

2795

3550

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

2796

3551

exc_info=e)

2797

3552

raise

2798

3553

2799

3554

# Delete all clients, and settings from config

2800

3555

while tcp_server.clients:

2801

3556

name, client = tcp_server.clients.popitem()

2802

3557

if use_dbus:

2803

3558

client.remove_from_connection()

2804

# Don't signal anything except ClientRemoved

3559

# Don't signal the disabling

2805

3560

client.disable(quiet=True)

3561

# Emit D-Bus signal for removal

2806

3562

if use_dbus:

2807

# Emit D-Bus signal

2808

mandos_dbus_service.ClientRemoved(client

2809

.dbus_object_path,

2810

client.name)

3563

mandos_dbus_service.client_removed_signal(client)

2811

3564

client_settings.clear()

2812

3565

2813

3566

atexit.register(cleanup)

2814

2815

for client in tcp_server.clients.itervalues():

3567

3568

for client in tcp_server.clients.values():

2816

3569

if use_dbus:

2817

# Emit D-Bus signal

2818

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3570

# Emit D-Bus signal for adding

3571

mandos_dbus_service.client_added_signal(client)

2819

3572

# Need to initiate checking of clients

2820

3573

if client.enabled:

2821

3574

client.init_checker()

2822

3575

2823

3576

tcp_server.enable()

2824

3577

tcp_server.server_activate()

2825

3578

2826

3579

# Find out what port we got

2827

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

3580

if zeroconf:

3581

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

2828

3582

if use_ipv6:

2829

3583

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

2830

3584

" flowinfo %d, scope_id %d",

2832

3586

else: # IPv4

2833

3587

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

2834

3588

*tcp_server.socket.getsockname())

2835

2836

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

2837

3589

3590

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

3591

2838

3592

try:

2839

# From the Avahi example code

2840

try:

2841

service.activate()

2842

except dbus.exceptions.DBusException as error:

2843

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

2844

cleanup()

2845

sys.exit(1)

2846

# End of Avahi example code

2847

2848

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

2849

lambda *args, **kwargs:

2850

(tcp_server.handle_request

2851

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

2852

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

2853

3608

logger.debug("Starting main loop")

2854

3609

main_loop.run()

2855

3610

except AvahiError as error:

2864

3619

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

2865

3620

cleanup()

2866

3621

3622

2867

3623

if __name__ == '__main__':

2868

3624

main()