/mandos/trunk : revision 1149

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

import SocketServer as socketserver

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

42

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

38

47

import socket

39

48

import argparse

40

49

import datetime

41

50

import errno

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

49

55

import sys

50

56

import re

51

57

import os

60

66

import struct

61

67

import fcntl

62

68

import functools

63

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

64

73

import multiprocessing

65

74

import types

66

75

import binascii

67

76

import tempfile

68

77

import itertools

78

import collections

79

import codecs

69

80

70

81

import dbus

71

82

import dbus.service

72

import gobject

73

import avahi

83

import gi

84

from gi.repository import GLib

74

85

from dbus.mainloop.glib import DBusGMainLoop

75

86

import ctypes

76

87

import ctypes.util

77

88

import xml.dom.minidom

78

89

import inspect

79

import GnuPGInterface

80

90

91

# Try to find the value of SO_BINDTODEVICE:

81

92

try:

93

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

94

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

82

95

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

83

96

except AttributeError:

84

97

try:

98

# This is where SO_BINDTODEVICE was up to and including Python

99

# 2.6, and also 3.2:

85

100

from IN import SO_BINDTODEVICE

86

101

except ImportError:

87

SO_BINDTODEVICE = None

88

89

version = "1.5.3"

102

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

103

# Try running the C preprocessor:

104

try:

105

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

106

"/dev/stdin"],

107

stdin=subprocess.PIPE,

108

stdout=subprocess.PIPE)

109

stdout = cc.communicate(

110

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

111

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

112

except (OSError, ValueError, IndexError):

113

# No value found

114

SO_BINDTODEVICE = None

115

116

if sys.version_info.major == 2:

117

str = unicode

118

119

if sys.version_info < (3, 2):

120

configparser.Configparser = configparser.SafeConfigParser

121

122

version = "1.8.6"

90

123

stored_state_file = "clients.pickle"

91

124

92

125

logger = logging.getLogger()

93

syslogger = (logging.handlers.SysLogHandler

94

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

95

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

126

syslogger = None

96

127

97

128

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

129

if_nametoindex = ctypes.cdll.LoadLibrary(

130

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

101

131

except (OSError, AttributeError):

132

102

133

def if_nametoindex(interface):

103

134

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

104

135

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

105

136

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

106

137

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

138

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

139

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

111

140

return interface_index

112

141

113

142

143

def copy_function(func):

144

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

145

if sys.version_info.major == 2:

146

return types.FunctionType(func.func_code,

147

func.func_globals,

148

func.func_name,

149

func.func_defaults,

150

func.func_closure)

151

else:

152

return types.FunctionType(func.__code__,

153

func.__globals__,

154

func.__name__,

155

func.__defaults__,

156

func.__closure__)

157

158

114

159

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

115

160

"""init logger and add loglevel"""

116

161

162

global syslogger

163

syslogger = (logging.handlers.SysLogHandler(

164

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

165

address="/dev/log"))

117

166

syslogger.setFormatter(logging.Formatter

118

167

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

119

168

' %(message)s'))

120

169

logger.addHandler(syslogger)

121

170

122

171

if debug:

123

172

console = logging.StreamHandler()

124

173

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

136

185

137

186

class PGPEngine(object):

138

187

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

188

139

189

def __init__(self):

140

self.gnupg = GnuPGInterface.GnuPG()

141

190

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

142

self.gnupg = GnuPGInterface.GnuPG()

143

self.gnupg.options.meta_interactive = False

144

self.gnupg.options.homedir = self.tempdir

145

self.gnupg.options.extra_args.extend(['--force-mdc',

146

'--quiet',

147

'--no-use-agent'])

148

191

self.gpg = "gpg"

192

try:

193

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

194

for line in output.splitlines():

195

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

196

if name == "gpg":

197

self.gpg = path

198

break

199

except OSError as e:

200

if e.errno != errno.ENOENT:

201

raise

202

self.gnupgargs = ['--batch',

203

'--homedir', self.tempdir,

204

'--force-mdc',

205

'--quiet']

206

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

207

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

208

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

209

149

210

def __enter__(self):

150

211

return self

151

152

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

212

213

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

153

214

self._cleanup()

154

215

return False

155

216

156

217

def __del__(self):

157

218

self._cleanup()

158

219

159

220

def _cleanup(self):

160

221

if self.tempdir is not None:

161

222

# Delete contents of tempdir

162

223

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

163

topdown = False):

224

topdown=False):

164

225

for filename in files:

165

226

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

166

227

for dirname in dirs:

168

229

# Remove tempdir

169

230

os.rmdir(self.tempdir)

170

231

self.tempdir = None

171

232

172

233

def password_encode(self, password):

173

234

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

174

235

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

175

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

176

236

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

237

if len(encoded) > 2048:

238

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

239

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

240

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

241

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

242

return encoded

243

177

244

def encrypt(self, data, password):

178

self.gnupg.passphrase = self.password_encode(password)

179

with open(os.devnull, "w") as devnull:

180

try:

181

proc = self.gnupg.run(['--symmetric'],

182

create_fhs=['stdin', 'stdout'],

183

attach_fhs={'stderr': devnull})

184

with contextlib.closing(proc.handles['stdin']) as f:

185

f.write(data)

186

with contextlib.closing(proc.handles['stdout']) as f:

187

ciphertext = f.read()

188

proc.wait()

189

except IOError as e:

190

raise PGPError(e)

191

self.gnupg.passphrase = None

245

passphrase = self.password_encode(password)

246

with tempfile.NamedTemporaryFile(

247

dir=self.tempdir) as passfile:

248

passfile.write(passphrase)

249

passfile.flush()

250

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

251

'--passphrase-file',

252

passfile.name]

253

+ self.gnupgargs,

254

stdin=subprocess.PIPE,

255

stdout=subprocess.PIPE,

256

stderr=subprocess.PIPE)

257

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

258

if proc.returncode != 0:

259

raise PGPError(err)

192

260

return ciphertext

193

261

194

262

def decrypt(self, data, password):

195

self.gnupg.passphrase = self.password_encode(password)

196

with open(os.devnull, "w") as devnull:

197

try:

198

proc = self.gnupg.run(['--decrypt'],

199

create_fhs=['stdin', 'stdout'],

200

attach_fhs={'stderr': devnull})

201

with contextlib.closing(proc.handles['stdin']) as f:

202

f.write(data)

203

with contextlib.closing(proc.handles['stdout']) as f:

204

decrypted_plaintext = f.read()

205

proc.wait()

206

except IOError as e:

207

raise PGPError(e)

208

self.gnupg.passphrase = None

263

passphrase = self.password_encode(password)

264

with tempfile.NamedTemporaryFile(

265

dir=self.tempdir) as passfile:

266

passfile.write(passphrase)

267

passfile.flush()

268

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

269

'--passphrase-file',

270

passfile.name]

271

+ self.gnupgargs,

272

stdin=subprocess.PIPE,

273

stdout=subprocess.PIPE,

274

stderr=subprocess.PIPE)

275

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

276

if proc.returncode != 0:

277

raise PGPError(err)

209

278

return decrypted_plaintext

210

279

211

280

281

# Pretend that we have an Avahi module

282

class avahi(object):

283

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

284

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

285

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

286

PROTO_INET = 0 # avahi-common/address.h

287

PROTO_INET6 = 1 # avahi-common/address.h

288

DBUS_NAME = "org.freedesktop.Avahi"

289

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

290

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

291

DBUS_PATH_SERVER = "/"

292

293

@staticmethod

294

def string_array_to_txt_array(t):

295

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

296

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

297

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

298

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

299

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

300

SERVER_INVALID = 0 # avahi-common/defs.h

301

SERVER_REGISTERING = 1 # avahi-common/defs.h

302

SERVER_RUNNING = 2 # avahi-common/defs.h

303

SERVER_COLLISION = 3 # avahi-common/defs.h

304

SERVER_FAILURE = 4 # avahi-common/defs.h

305

306

212

307

class AvahiError(Exception):

213

308

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

214

309

self.value = value

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

310

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

311

**kwargs)

312

218

313

219

314

class AvahiServiceError(AvahiError):

220

315

pass

221

316

317

222

318

class AvahiGroupError(AvahiError):

223

319

pass

224

320

225

321

226

322

class AvahiService(object):

227

323

"""An Avahi (Zeroconf) service.

228

324

229

325

Attributes:

230

326

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

231

327

Used to optionally bind to the specified interface.

232

328

name: string; Example: 'Mandos'

233

329

type: string; Example: '_mandos._tcp'.

234

See <http://www.dns-sd.org/ServiceTypes.html>

330

See <https://www.iana.org/assignments/service-names-port-numbers>

235

331

port: integer; what port to announce

236

332

TXT: list of strings; TXT record for the service

237

333

domain: string; Domain to publish on, default to .local if empty.

243

339

server: D-Bus Server

244

340

bus: dbus.SystemBus()

245

341

"""

246

247

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

248

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

249

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

250

protocol = avahi.PROTO_UNSPEC, bus = None):

342

343

def __init__(self,

344

interface=avahi.IF_UNSPEC,

345

name=None,

346

servicetype=None,

347

port=None,

348

TXT=None,

349

domain="",

350

host="",

351

max_renames=32768,

352

protocol=avahi.PROTO_UNSPEC,

353

bus=None):

251

354

self.interface = interface

252

355

self.name = name

253

356

self.type = servicetype

262

365

self.server = None

263

366

self.bus = bus

264

367

self.entry_group_state_changed_match = None

265

266

def rename(self):

368

369

def rename(self, remove=True):

267

370

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

268

371

if self.rename_count >= self.max_renames:

269

372

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

270

373

" after %i retries, exiting.",

271

374

self.rename_count)

272

375

raise AvahiServiceError("Too many renames")

273

self.name = unicode(self.server

274

.GetAlternativeServiceName(self.name))

376

self.name = str(

377

self.server.GetAlternativeServiceName(self.name))

378

self.rename_count += 1

275

379

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

276

380

self.name)

277

self.remove()

381

if remove:

382

self.remove()

278

383

try:

279

384

self.add()

280

385

except dbus.exceptions.DBusException as error:

281

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

282

self.cleanup()

283

os._exit(1)

284

self.rename_count += 1

285

386

if (error.get_dbus_name()

387

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

388

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

389

return self.rename(remove=False)

390

else:

391

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

392

self.cleanup()

393

os._exit(1)

394

286

395

def remove(self):

287

396

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

288

397

if self.entry_group_state_changed_match is not None:

290

399

self.entry_group_state_changed_match = None

291

400

if self.group is not None:

292

401

self.group.Reset()

293

402

294

403

def add(self):

295

404

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

296

405

self.remove()

313

422

dbus.UInt16(self.port),

314

423

avahi.string_array_to_txt_array(self.TXT))

315

424

self.group.Commit()

316

425

317

426

def entry_group_state_changed(self, state, error):

318

427

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

319

428

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

320

429

321

430

if state == avahi.ENTRY_GROUP_ESTABLISHED:

322

431

logger.debug("Zeroconf service established.")

323

432

elif state == avahi.ENTRY_GROUP_COLLISION:

325

434

self.rename()

326

435

elif state == avahi.ENTRY_GROUP_FAILURE:

327

436

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

328

unicode(error))

329

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

330

.format(error))

331

437

str(error))

438

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

439

332

440

def cleanup(self):

333

441

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

334

442

if self.group is not None:

339

447

pass

340

448

self.group = None

341

449

self.remove()

342

450

343

451

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

344

452

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

345

453

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

346

bad_states = { avahi.SERVER_INVALID:

347

"Zeroconf server invalid",

348

avahi.SERVER_REGISTERING: None,

349

avahi.SERVER_COLLISION:

350

"Zeroconf server name collision",

351

avahi.SERVER_FAILURE:

352

"Zeroconf server failure" }

454

bad_states = {

455

avahi.SERVER_INVALID: "Zeroconf server invalid",

456

avahi.SERVER_REGISTERING: None,

457

avahi.SERVER_COLLISION: "Zeroconf server name collision",

458

avahi.SERVER_FAILURE: "Zeroconf server failure",

459

}

353

460

if state in bad_states:

354

461

if bad_states[state] is not None:

355

462

if error is None:

358

465

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

359

466

self.cleanup()

360

467

elif state == avahi.SERVER_RUNNING:

361

self.add()

468

try:

469

self.add()

470

except dbus.exceptions.DBusException as error:

471

if (error.get_dbus_name()

472

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

473

logger.info("Local Zeroconf service name"

474

" collision.")

475

return self.rename(remove=False)

476

else:

477

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

478

self.cleanup()

479

os._exit(1)

362

480

else:

363

481

if error is None:

364

482

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

365

483

else:

366

484

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

367

485

368

486

def activate(self):

369

487

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

370

488

if self.server is None:

374

492

follow_name_owner_changes=True),

375

493

avahi.DBUS_INTERFACE_SERVER)

376

494

self.server.connect_to_signal("StateChanged",

377

self.server_state_changed)

495

self.server_state_changed)

378

496

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

379

497

498

380

499

class AvahiServiceToSyslog(AvahiService):

381

def rename(self):

500

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

382

501

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

383

ret = AvahiService.rename(self)

384

syslogger.setFormatter(logging.Formatter

385

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

386

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

387

.format(self.name)))

502

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

503

syslogger.setFormatter(logging.Formatter(

504

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

505

.format(self.name)))

388

506

return ret

389

507

390

def timedelta_to_milliseconds(td):

391

"Convert a datetime.timedelta() to milliseconds"

392

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

393

+ (td.seconds * 1000)

394

+ (td.microseconds // 1000))

508

509

# Pretend that we have a GnuTLS module

510

class gnutls(object):

511

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

512

513

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

514

if library is None:

515

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

516

_library = ctypes.cdll.LoadLibrary(library)

517

del library

518

519

# Unless otherwise indicated, the constants and types below are

520

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

521

522

# Constants

523

E_SUCCESS = 0

524

E_INTERRUPTED = -52

525

E_AGAIN = -28

526

CRT_OPENPGP = 2

527

CRT_RAWPK = 3

528

CLIENT = 2

529

SHUT_RDWR = 0

530

CRD_CERTIFICATE = 1

531

E_NO_CERTIFICATE_FOUND = -49

532

X509_FMT_DER = 0

533

NO_TICKETS = 1<<10

534

ENABLE_RAWPK = 1<<18

535

CTYPE_PEERS = 3

536

KEYID_USE_SHA256 = 1 # gnutls/x509.h

537

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

538

539

# Types

540

class session_int(ctypes.Structure):

541

_fields_ = []

542

session_t = ctypes.POINTER(session_int)

543

544

class certificate_credentials_st(ctypes.Structure):

545

_fields_ = []

546

certificate_credentials_t = ctypes.POINTER(

547

certificate_credentials_st)

548

certificate_type_t = ctypes.c_int

549

550

class datum_t(ctypes.Structure):

551

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

552

('size', ctypes.c_uint)]

553

554

class openpgp_crt_int(ctypes.Structure):

555

_fields_ = []

556

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

557

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

558

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

559

credentials_type_t = ctypes.c_int

560

transport_ptr_t = ctypes.c_void_p

561

close_request_t = ctypes.c_int

562

563

# Exceptions

564

class Error(Exception):

565

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

566

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

567

# code is passed, convert it to a string with

568

# gnutls.strerror()

569

self.code = code

570

if message is None and code is not None:

571

message = gnutls.strerror(code)

572

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

573

message, *args)

574

575

class CertificateSecurityError(Error):

576

pass

577

578

# Classes

579

class Credentials(object):

580

def __init__(self):

581

self._c_object = gnutls.certificate_credentials_t()

582

gnutls.certificate_allocate_credentials(

583

ctypes.byref(self._c_object))

584

self.type = gnutls.CRD_CERTIFICATE

585

586

def __del__(self):

587

gnutls.certificate_free_credentials(self._c_object)

588

589

class ClientSession(object):

590

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

591

self._c_object = gnutls.session_t()

592

gnutls_flags = gnutls.CLIENT

593

if gnutls.check_version(b"3.5.6"):

594

gnutls_flags |= gnutls.NO_TICKETS

595

if gnutls.has_rawpk:

596

gnutls_flags |= gnutls.ENABLE_RAWPK

597

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

598

del gnutls_flags

599

gnutls.set_default_priority(self._c_object)

600

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

601

gnutls.handshake_set_private_extensions(self._c_object,

602

True)

603

self.socket = socket

604

if credentials is None:

605

credentials = gnutls.Credentials()

606

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

607

ctypes.cast(credentials._c_object,

608

ctypes.c_void_p))

609

self.credentials = credentials

610

611

def __del__(self):

612

gnutls.deinit(self._c_object)

613

614

def handshake(self):

615

return gnutls.handshake(self._c_object)

616

617

def send(self, data):

618

data = bytes(data)

619

data_len = len(data)

620

while data_len > 0:

621

data_len -= gnutls.record_send(self._c_object,

622

data[-data_len:],

623

data_len)

624

625

def bye(self):

626

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

627

628

# Error handling functions

629

def _error_code(result):

630

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

631

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

632

if result >= 0:

633

return result

634

if result == gnutls.E_NO_CERTIFICATE_FOUND:

635

raise gnutls.CertificateSecurityError(code=result)

636

raise gnutls.Error(code=result)

637

638

def _retry_on_error(result, func, arguments):

639

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

640

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

641

while result < 0:

642

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

643

return _error_code(result)

644

result = func(*arguments)

645

return result

646

647

# Unless otherwise indicated, the function declarations below are

648

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

649

650

# Functions

651

priority_set_direct = _library.gnutls_priority_set_direct

652

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

653

ctypes.POINTER(ctypes.c_char_p)]

654

priority_set_direct.restype = _error_code

655

656

init = _library.gnutls_init

657

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

658

init.restype = _error_code

659

660

set_default_priority = _library.gnutls_set_default_priority

661

set_default_priority.argtypes = [session_t]

662

set_default_priority.restype = _error_code

663

664

record_send = _library.gnutls_record_send

665

record_send.argtypes = [session_t, ctypes.c_void_p,

666

ctypes.c_size_t]

667

record_send.restype = ctypes.c_ssize_t

668

record_send.errcheck = _retry_on_error

669

670

certificate_allocate_credentials = (

671

_library.gnutls_certificate_allocate_credentials)

672

certificate_allocate_credentials.argtypes = [

673

ctypes.POINTER(certificate_credentials_t)]

674

certificate_allocate_credentials.restype = _error_code

675

676

certificate_free_credentials = (

677

_library.gnutls_certificate_free_credentials)

678

certificate_free_credentials.argtypes = [

679

certificate_credentials_t]

680

certificate_free_credentials.restype = None

681

682

handshake_set_private_extensions = (

683

_library.gnutls_handshake_set_private_extensions)

684

handshake_set_private_extensions.argtypes = [session_t,

685

ctypes.c_int]

686

handshake_set_private_extensions.restype = None

687

688

credentials_set = _library.gnutls_credentials_set

689

credentials_set.argtypes = [session_t, credentials_type_t,

690

ctypes.c_void_p]

691

credentials_set.restype = _error_code

692

693

strerror = _library.gnutls_strerror

694

strerror.argtypes = [ctypes.c_int]

695

strerror.restype = ctypes.c_char_p

696

697

certificate_type_get = _library.gnutls_certificate_type_get

698

certificate_type_get.argtypes = [session_t]

699

certificate_type_get.restype = _error_code

700

701

certificate_get_peers = _library.gnutls_certificate_get_peers

702

certificate_get_peers.argtypes = [session_t,

703

ctypes.POINTER(ctypes.c_uint)]

704

certificate_get_peers.restype = ctypes.POINTER(datum_t)

705

706

global_set_log_level = _library.gnutls_global_set_log_level

707

global_set_log_level.argtypes = [ctypes.c_int]

708

global_set_log_level.restype = None

709

710

global_set_log_function = _library.gnutls_global_set_log_function

711

global_set_log_function.argtypes = [log_func]

712

global_set_log_function.restype = None

713

714

deinit = _library.gnutls_deinit

715

deinit.argtypes = [session_t]

716

deinit.restype = None

717

718

handshake = _library.gnutls_handshake

719

handshake.argtypes = [session_t]

720

handshake.restype = _error_code

721

handshake.errcheck = _retry_on_error

722

723

transport_set_ptr = _library.gnutls_transport_set_ptr

724

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

725

transport_set_ptr.restype = None

726

727

bye = _library.gnutls_bye

728

bye.argtypes = [session_t, close_request_t]

729

bye.restype = _error_code

730

bye.errcheck = _retry_on_error

731

732

check_version = _library.gnutls_check_version

733

check_version.argtypes = [ctypes.c_char_p]

734

check_version.restype = ctypes.c_char_p

735

736

_need_version = b"3.3.0"

737

if check_version(_need_version) is None:

738

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

739

.format(_need_version))

740

741

_tls_rawpk_version = b"3.6.6"

742

has_rawpk = bool(check_version(_tls_rawpk_version))

743

744

if has_rawpk:

745

# Types

746

class pubkey_st(ctypes.Structure):

747

_fields = []

748

pubkey_t = ctypes.POINTER(pubkey_st)

749

750

x509_crt_fmt_t = ctypes.c_int

751

752

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

753

pubkey_init = _library.gnutls_pubkey_init

754

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

755

pubkey_init.restype = _error_code

756

757

pubkey_import = _library.gnutls_pubkey_import

758

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

759

x509_crt_fmt_t]

760

pubkey_import.restype = _error_code

761

762

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

763

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

764

ctypes.POINTER(ctypes.c_ubyte),

765

ctypes.POINTER(ctypes.c_size_t)]

766

pubkey_get_key_id.restype = _error_code

767

768

pubkey_deinit = _library.gnutls_pubkey_deinit

769

pubkey_deinit.argtypes = [pubkey_t]

770

pubkey_deinit.restype = None

771

else:

772

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

773

774

openpgp_crt_init = _library.gnutls_openpgp_crt_init

775

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

776

openpgp_crt_init.restype = _error_code

777

778

openpgp_crt_import = _library.gnutls_openpgp_crt_import

779

openpgp_crt_import.argtypes = [openpgp_crt_t,

780

ctypes.POINTER(datum_t),

781

openpgp_crt_fmt_t]

782

openpgp_crt_import.restype = _error_code

783

784

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

785

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

786

ctypes.POINTER(ctypes.c_uint)]

787

openpgp_crt_verify_self.restype = _error_code

788

789

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

790

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

791

openpgp_crt_deinit.restype = None

792

793

openpgp_crt_get_fingerprint = (

794

_library.gnutls_openpgp_crt_get_fingerprint)

795

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

796

ctypes.c_void_p,

797

ctypes.POINTER(

798

ctypes.c_size_t)]

799

openpgp_crt_get_fingerprint.restype = _error_code

800

801

if check_version(b"3.6.4"):

802

certificate_type_get2 = _library.gnutls_certificate_type_get2

803

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

804

certificate_type_get2.restype = _error_code

805

806

# Remove non-public functions

807

del _error_code, _retry_on_error

808

809

810

def call_pipe(connection, # : multiprocessing.Connection

811

func, *args, **kwargs):

812

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

813

814

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

815

return value on the provided multiprocessing.Connection.

816

"""

817

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

818

connection.close()

819

395

820

396

821

class Client(object):

397

822

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

398

823

399

824

Attributes:

400

825

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

401

826

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

402

827

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

403

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

404

to see if the client lives.

405

'None' if no process is running.

406

checker_callback_tag: a gobject event source tag, or None

828

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

829

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

830

running.

831

checker_callback_tag: a GLib event source tag, or None

407

832

checker_command: string; External command which is run to check

408

833

if client lives. %() expansions are done at

409

834

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

410

835

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

411

checker_initiator_tag: a gobject event source tag, or None

836

checker_initiator_tag: a GLib event source tag, or None

412

837

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

413

838

client_structure: Object describing what attributes a client has

414

839

and is used for storing the client at exit

415

840

current_checker_command: string; current running checker_command

416

disable_initiator_tag: a gobject event source tag, or None

841

disable_initiator_tag: a GLib event source tag, or None

417

842

enabled: bool()

418

843

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

419

uniquely identify the client

844

uniquely identify an OpenPGP client

845

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

846

a client using raw public keys

420

847

host: string; available for use by the checker command

421

848

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

422

849

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

424

851

last_checker_status: integer between 0 and 255 reflecting exit

425

852

status of last checker. -1 reflects crashed

426

853

checker, -2 means no checker completed yet.

854

last_checker_signal: The signal which killed the last checker, if

855

last_checker_status is -1

427

856

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

428

857

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

429

858

D-Bus identifiers

434

863

runtime_expansions: Allowed attributes for runtime expansion.

435

864

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

436

865

disabled, or None

866

server_settings: The server_settings dict from main()

437

867

"""

438

868

439

869

runtime_expansions = ("approval_delay", "approval_duration",

440

"created", "enabled", "fingerprint",

441

"host", "interval", "last_checked_ok",

870

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

871

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

872

"last_approval_request", "last_checked_ok",

442

873

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

443

client_defaults = { "timeout": "5m",

444

"extended_timeout": "15m",

445

"interval": "2m",

446

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

447

"host": "",

448

"approval_delay": "0s",

449

"approval_duration": "1s",

450

"approved_by_default": "True",

451

"enabled": "True",

452

}

453

454

def timeout_milliseconds(self):

455

"Return the 'timeout' attribute in milliseconds"

456

return timedelta_to_milliseconds(self.timeout)

457

458

def extended_timeout_milliseconds(self):

459

"Return the 'extended_timeout' attribute in milliseconds"

460

return timedelta_to_milliseconds(self.extended_timeout)

461

462

def interval_milliseconds(self):

463

"Return the 'interval' attribute in milliseconds"

464

return timedelta_to_milliseconds(self.interval)

465

466

def approval_delay_milliseconds(self):

467

return timedelta_to_milliseconds(self.approval_delay)

468

874

client_defaults = {

875

"timeout": "PT5M",

876

"extended_timeout": "PT15M",

877

"interval": "PT2M",

878

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

879

"host": "",

880

"approval_delay": "PT0S",

881

"approval_duration": "PT1S",

882

"approved_by_default": "True",

883

"enabled": "True",

884

}

885

469

886

@staticmethod

470

887

def config_parser(config):

471

888

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

478

895

for client_name in config.sections():

479

896

section = dict(config.items(client_name))

480

897

client = settings[client_name] = {}

481

898

482

899

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

483

900

# Reformat values from string types to Python types

484

901

client["approved_by_default"] = config.getboolean(

485

902

client_name, "approved_by_default")

486

903

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

487

904

"enabled")

488

905

906

# Uppercase and remove spaces from key_id and fingerprint

907

# for later comparison purposes with return value from the

908

# key_id() and fingerprint() functions

909

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

910

.replace(" ", ""))

489

911

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

490

912

.replace(" ", ""))

491

913

if "secret" in section:

492

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

914

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

915

.encode("utf-8"),

916

"base64")

493

917

elif "secfile" in section:

494

918

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

495

919

(section["secfile"])),

496

920

"rb") as secfile:

497

921

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

498

922

else:

499

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

923

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

500

924

.format(section))

501

925

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

502

926

client["extended_timeout"] = string_to_delta(

510

934

client["last_approval_request"] = None

511

935

client["last_checked_ok"] = None

512

936

client["last_checker_status"] = -2

513

937

514

938

return settings

515

516

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

939

940

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

517

941

self.name = name

942

if server_settings is None:

943

server_settings = {}

944

self.server_settings = server_settings

518

945

# adding all client settings

519

for setting, value in settings.iteritems():

946

for setting, value in settings.items():

520

947

setattr(self, setting, value)

521

948

522

949

if self.enabled:

523

950

if not hasattr(self, "last_enabled"):

524

951

self.last_enabled = datetime.datetime.utcnow()

528

955

else:

529

956

self.last_enabled = None

530

957

self.expires = None

531

958

532

959

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

533

# Uppercase and remove spaces from fingerprint for later

534

# comparison purposes with return value from the fingerprint()

535

# function

960

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

536

961

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

537

962

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

538

963

datetime.datetime.utcnow())

539

964

540

965

# attributes specific for this server instance

541

966

self.checker = None

542

967

self.checker_initiator_tag = None

545

970

self.current_checker_command = None

546

971

self.approved = None

547

972

self.approvals_pending = 0

548

self.changedstate = (multiprocessing_manager

549

.Condition(multiprocessing_manager

550

.Lock()))

551

self.client_structure = [attr for attr in

552

self.__dict__.iterkeys()

973

self.changedstate = multiprocessing_manager.Condition(

974

multiprocessing_manager.Lock())

975

self.client_structure = [attr

976

for attr in self.__dict__.keys()

553

977

if not attr.startswith("_")]

554

978

self.client_structure.append("client_structure")

555

556

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

557

lambda obj:

558

isinstance(obj,

559

property)):

979

980

for name, t in inspect.getmembers(

981

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

560

982

if not name.startswith("_"):

561

983

self.client_structure.append(name)

562

984

563

985

# Send notice to process children that client state has changed

564

986

def send_changedstate(self):

565

987

with self.changedstate:

566

988

self.changedstate.notify_all()

567

989

568

990

def enable(self):

569

991

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

570

992

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

571

993

# Already enabled

572

994

return

573

self.send_changedstate()

574

995

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

575

996

self.enabled = True

576

997

self.last_enabled = datetime.datetime.utcnow()

577

998

self.init_checker()

578

999

self.send_changedstate()

1000

579

1001

def disable(self, quiet=True):

580

1002

"""Disable this client."""

581

1003

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

582

1004

return False

583

1005

if not quiet:

584

self.send_changedstate()

585

if not quiet:

586

1006

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

587

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

588

gobject.source_remove(self.disable_initiator_tag)

1007

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

1008

GLib.source_remove(self.disable_initiator_tag)

589

1009

self.disable_initiator_tag = None

590

1010

self.expires = None

591

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

592

gobject.source_remove(self.checker_initiator_tag)

1011

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

1012

GLib.source_remove(self.checker_initiator_tag)

593

1013

self.checker_initiator_tag = None

594

1014

self.stop_checker()

595

1015

self.enabled = False

596

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

1016

if not quiet:

1017

self.send_changedstate()

1018

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

597

1019

return False

598

1020

599

1021

def __del__(self):

600

1022

self.disable()

601

1023

602

1024

def init_checker(self):

603

1025

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

604

1026

# and every interval from then on.

605

self.checker_initiator_tag = (gobject.timeout_add

606

(self.interval_milliseconds(),

607

self.start_checker))

1027

if self.checker_initiator_tag is not None:

1028

GLib.source_remove(self.checker_initiator_tag)

1029

self.checker_initiator_tag = GLib.timeout_add(

1030

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

1031

self.start_checker)

608

1032

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

609

self.disable_initiator_tag = (gobject.timeout_add

610

(self.timeout_milliseconds(),

611

self.disable))

1033

if self.disable_initiator_tag is not None:

1034

GLib.source_remove(self.disable_initiator_tag)

1035

self.disable_initiator_tag = GLib.timeout_add(

1036

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

612

1037

# Also start a new checker *right now*.

613

1038

self.start_checker()

614

615

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

1039

1040

def checker_callback(self, source, condition, connection,

1041

command):

616

1042

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

1043

# Read return code from connection (see call_pipe)

1044

returncode = connection.recv()

1045

connection.close()

1046

self.checker.join()

617

1047

self.checker_callback_tag = None

618

1048

self.checker = None

619

if os.WIFEXITED(condition):

620

self.last_checker_status = os.WEXITSTATUS(condition)

1049

1050

if returncode >= 0:

1051

self.last_checker_status = returncode

1052

self.last_checker_signal = None

621

1053

if self.last_checker_status == 0:

622

1054

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

623

1055

vars(self))

624

1056

self.checked_ok()

625

1057

else:

626

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

627

vars(self))

1058

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

628

1059

else:

629

1060

self.last_checker_status = -1

1061

self.last_checker_signal = -returncode

630

1062

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

631

1063

vars(self))

632

1064

return False

1065

633

1066

def checked_ok(self):

634

1067

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

635

1068

self.last_checked_ok = datetime.datetime.utcnow()

636

1069

self.last_checker_status = 0

1070

self.last_checker_signal = None

637

1071

self.bump_timeout()

638

1072

639

1073

def bump_timeout(self, timeout=None):

640

1074

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

641

1075

if timeout is None:

642

1076

timeout = self.timeout

643

1077

if self.disable_initiator_tag is not None:

644

gobject.source_remove(self.disable_initiator_tag)

1078

GLib.source_remove(self.disable_initiator_tag)

1079

self.disable_initiator_tag = None

645

1080

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

646

self.disable_initiator_tag = (gobject.timeout_add

647

(timedelta_to_milliseconds

648

(timeout), self.disable))

1081

self.disable_initiator_tag = GLib.timeout_add(

1082

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

649

1083

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

650

1084

651

1085

def need_approval(self):

652

1086

self.last_approval_request = datetime.datetime.utcnow()

653

1087

654

1088

def start_checker(self):

655

1089

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

656

1090

657

1091

If a checker already exists, leave it running and do

658

1092

nothing."""

659

1093

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

660

# did that, then if a checker (for some reason) started

661

# running slowly and taking more than 'interval' time, the

662

# client would inevitably timeout, since no checker would get

663

# a chance to run to completion. If we instead leave running

1094

# did that, and if a checker (for some reason) started running

1095

# slowly and taking more than 'interval' time, then the client

1096

# would inevitably timeout, since no checker would get a

1097

# chance to run to completion. If we instead leave running

664

1098

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

665

1099

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

666

1100

# should be.

667

668

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

669

try:

670

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

671

except (AttributeError, OSError) as error:

672

if (isinstance(error, OSError)

673

and error.errno != errno.ECHILD):

674

raise error

675

else:

676

if pid:

677

logger.warning("Checker was a zombie")

678

gobject.source_remove(self.checker_callback_tag)

679

self.checker_callback(pid, status,

680

self.current_checker_command)

1101

1102

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

1103

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

1104

self.checker.join()

1105

self.checker = None

681

1106

# Start a new checker if needed

682

1107

if self.checker is None:

1108

# Escape attributes for the shell

1109

escaped_attrs = {

1110

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

1111

for attr in self.runtime_expansions}

683

1112

try:

684

# In case checker_command has exactly one % operator

685

command = self.checker_command % self.host

686

except TypeError:

687

# Escape attributes for the shell

688

escaped_attrs = dict(

689

(attr,

690

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

691

errors=

692

'replace')))

693

for attr in

694

self.runtime_expansions)

695

696

try:

697

command = self.checker_command % escaped_attrs

698

except TypeError as error:

699

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

700

self.checker_command, exc_info=error)

701

return True # Try again later

1113

command = self.checker_command % escaped_attrs

1114

except TypeError as error:

1115

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

1116

self.checker_command,

1117

exc_info=error)

1118

return True # Try again later

702

1119

self.current_checker_command = command

703

try:

704

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

705

command, self.name)

706

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

707

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

708

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

709

# always replaced by /dev/null.)

710

self.checker = subprocess.Popen(command,

711

close_fds=True,

712

shell=True, cwd="/")

713

self.checker_callback_tag = (gobject.child_watch_add

714

(self.checker.pid,

715

self.checker_callback,

716

data=command))

717

# The checker may have completed before the gobject

718

# watch was added. Check for this.

719

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

720

if pid:

721

gobject.source_remove(self.checker_callback_tag)

722

self.checker_callback(pid, status, command)

723

except OSError as error:

724

logger.error("Failed to start subprocess",

725

exc_info=error)

726

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

1120

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

1121

self.name)

1122

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

1123

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

1124

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

1125

# always replaced by /dev/null.)

1126

# The exception is when not debugging but nevertheless

1127

# running in the foreground; use the previously

1128

# created wnull.

1129

popen_args = {"close_fds": True,

1130

"shell": True,

1131

"cwd": "/"}

1132

if (not self.server_settings["debug"]

1133

and self.server_settings["foreground"]):

1134

popen_args.update({"stdout": wnull,

1135

"stderr": wnull})

1136

pipe = multiprocessing.Pipe(duplex=False)

1137

self.checker = multiprocessing.Process(

1138

target=call_pipe,

1139

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

1140

kwargs=popen_args)

1141

self.checker.start()

1142

self.checker_callback_tag = GLib.io_add_watch(

1143

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

1144

self.checker_callback, pipe[0], command)

1145

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

727

1146

return True

728

1147

729

1148

def stop_checker(self):

730

1149

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

731

1150

if self.checker_callback_tag:

732

gobject.source_remove(self.checker_callback_tag)

1151

GLib.source_remove(self.checker_callback_tag)

733

1152

self.checker_callback_tag = None

734

1153

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

735

1154

return

736

1155

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

737

try:

738

self.checker.terminate()

739

#time.sleep(0.5)

740

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

741

# self.checker.kill()

742

except OSError as error:

743

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

744

raise

1156

self.checker.terminate()

745

1157

self.checker = None

746

1158

747

1159

748

def dbus_service_property(dbus_interface, signature="v",

749

access="readwrite", byte_arrays=False):

1160

def dbus_service_property(dbus_interface,

1161

signature="v",

1162

access="readwrite",

1163

byte_arrays=False):

750

1164

"""Decorators for marking methods of a DBusObjectWithProperties to

751

1165

become properties on the D-Bus.

752

1166

753

1167

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

754

1168

and with one argument by "Set".

755

1169

756

1170

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

757

1171

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

758

1172

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

761

1175

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

762

1176

if byte_arrays and signature != "ay":

763

1177

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

764

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

1178

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

1179

765

1180

def decorator(func):

766

1181

func._dbus_is_property = True

767

1182

func._dbus_interface = dbus_interface

770

1185

func._dbus_name = func.__name__

771

1186

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

772

1187

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

773

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1188

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

774

1189

return func

1190

775

1191

return decorator

776

1192

777

1193

778

1194

def dbus_interface_annotations(dbus_interface):

779

1195

"""Decorator for marking functions returning interface annotations

780

1196

781

1197

Usage:

782

1198

783

1199

@dbus_interface_annotations("org.example.Interface")

784

1200

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

785

1201

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

786

1202

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

787

1203

"false"}

788

1204

"""

1205

789

1206

def decorator(func):

790

1207

func._dbus_is_interface = True

791

1208

func._dbus_interface = dbus_interface

792

1209

func._dbus_name = dbus_interface

793

1210

return func

1211

794

1212

return decorator

795

1213

796

1214

797

1215

def dbus_annotations(annotations):

798

1216

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

799

1217

Usage:

800

1218

1219

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

1220

"org.freedesktop.DBus.Property."

1221

"EmitsChangedSignal": "false"})

801

1222

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

802

1223

access="r")

803

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

804

"org.freedesktop.DBus.Property."

805

"EmitsChangedSignal": "false"})

806

1224

def Property_dbus_property(self):

807

1225

return dbus.Boolean(False)

1226

1227

See also the DBusObjectWithAnnotations class.

808

1228

"""

1229

809

1230

def decorator(func):

810

1231

func._dbus_annotations = annotations

811

1232

return func

1233

812

1234

return decorator

813

1235

814

1236

815

1237

class DBusPropertyException(dbus.exceptions.DBusException):

816

1238

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

817

1239

"""

818

def __unicode__(self):

819

return unicode(str(self))

1240

pass

820

1241

821

1242

822

1243

class DBusPropertyAccessException(DBusPropertyException):

831

1252

pass

832

1253

833

1254

834

class DBusObjectWithProperties(dbus.service.Object):

835

"""A D-Bus object with properties.

836

837

Classes inheriting from this can use the dbus_service_property

838

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

839

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

1255

class DBusObjectWithAnnotations(dbus.service.Object):

1256

"""A D-Bus object with annotations.

1257

1258

Classes inheriting from this can use the dbus_annotations

1259

decorator to add annotations to methods or signals.

840

1260

"""

841

1261

842

1262

@staticmethod

843

1263

def _is_dbus_thing(thing):

844

1264

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

845

1265

846

1266

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

847

1267

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

848

1268

"""

849

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

1269

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

850

1270

False)

851

1271

852

1272

def _get_all_dbus_things(self, thing):

853

1273

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

854

1274

"""

855

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

856

name),

1275

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

857

1276

athing.__get__(self))

858

1277

for cls in self.__class__.__mro__

859

1278

for name, athing in

860

inspect.getmembers(cls,

861

self._is_dbus_thing(thing)))

862

1279

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

1280

1281

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1282

out_signature="s",

1283

path_keyword='object_path',

1284

connection_keyword='connection')

1285

def Introspect(self, object_path, connection):

1286

"""Overloading of standard D-Bus method.

1287

1288

Inserts annotation tags on methods and signals.

1289

"""

1290

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

1291

connection)

1292

try:

1293

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

1294

1295

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

1296

# Add annotation tags

1297

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

1298

for tag in if_tag.getElementsByTagName(typ):

1299

annots = dict()

1300

for name, prop in (self.

1301

_get_all_dbus_things(typ)):

1302

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

1303

and prop._dbus_interface

1304

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

1305

annots.update(getattr(

1306

prop, "_dbus_annotations", {}))

1307

for name, value in annots.items():

1308

ann_tag = document.createElement(

1309

"annotation")

1310

ann_tag.setAttribute("name", name)

1311

ann_tag.setAttribute("value", value)

1312

tag.appendChild(ann_tag)

1313

# Add interface annotation tags

1314

for annotation, value in dict(

1315

itertools.chain.from_iterable(

1316

annotations().items()

1317

for name, annotations

1318

in self._get_all_dbus_things("interface")

1319

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

1320

)).items():

1321

ann_tag = document.createElement("annotation")

1322

ann_tag.setAttribute("name", annotation)

1323

ann_tag.setAttribute("value", value)

1324

if_tag.appendChild(ann_tag)

1325

# Fix argument name for the Introspect method itself

1326

if (if_tag.getAttribute("name")

1327

== dbus.INTROSPECTABLE_IFACE):

1328

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

1329

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

1330

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

1331

if (arg.getAttribute("direction")

1332

== "out"):

1333

arg.setAttribute("name",

1334

"xml_data")

1335

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

1336

document.unlink()

1337

except (AttributeError, xml.dom.DOMException,

1338

xml.parsers.expat.ExpatError) as error:

1339

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

1340

exc_info=error)

1341

return xmlstring

1342

1343

1344

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1345

"""A D-Bus object with properties.

1346

1347

Classes inheriting from this can use the dbus_service_property

1348

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

1349

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

1350

"""

1351

863

1352

def _get_dbus_property(self, interface_name, property_name):

864

1353

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

865

1354

property with the specified name and interface.

866

1355

"""

867

for cls in self.__class__.__mro__:

868

for name, value in (inspect.getmembers

869

(cls,

870

self._is_dbus_thing("property"))):

1356

for cls in self.__class__.__mro__:

1357

for name, value in inspect.getmembers(

1358

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

871

1359

if (value._dbus_name == property_name

872

1360

and value._dbus_interface == interface_name):

873

1361

return value.__get__(self)

874

1362

875

1363

# No such property

876

raise DBusPropertyNotFound(self.dbus_object_path + ":"

877

+ interface_name + "."

878

+ property_name)

879

880

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

1364

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

1365

self.dbus_object_path, interface_name, property_name))

1366

1367

@classmethod

1368

def _get_all_interface_names(cls):

1369

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

1370

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

1371

"_dbus_interface", None)

1372

for x in (inspect.getmro(cls))

1373

for attr in dir(x))

1374

if name is not None)

1375

1376

@dbus.service.method(dbus.PROPERTIES_IFACE,

1377

in_signature="ss",

881

1378

out_signature="v")

882

1379

def Get(self, interface_name, property_name):

883

1380

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

889

1386

if not hasattr(value, "variant_level"):

890

1387

return value

891

1388

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

892

1389

893

1390

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

894

1391

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

895

1392

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

901

1398

# The byte_arrays option is not supported yet on

902

1399

# signatures other than "ay".

903

1400

if prop._dbus_signature != "ay":

904

raise ValueError

1401

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

1402

"'ay' signature {!r}"

1403

.format(prop._dbus_signature))

905

1404

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

906

1405

for byte in value))

907

1406

prop(value)

908

909

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

1407

1408

@dbus.service.method(dbus.PROPERTIES_IFACE,

1409

in_signature="s",

910

1410

out_signature="a{sv}")

911

1411

def GetAll(self, interface_name):

912

1412

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

913

1413

standard.

914

1414

915

1415

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

916

1416

"""

917

1417

properties = {}

927

1427

if not hasattr(value, "variant_level"):

928

1428

properties[name] = value

929

1429

continue

930

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

931

value.variant_level+1)

1430

properties[name] = type(value)(

1431

value, variant_level=value.variant_level + 1)

932

1432

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

933

1433

1434

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

1435

def PropertiesChanged(self, interface_name, changed_properties,

1436

invalidated_properties):

1437

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

1438

standard.

1439

"""

1440

pass

1441

934

1442

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

935

1443

out_signature="s",

936

1444

path_keyword='object_path',

937

1445

connection_keyword='connection')

938

1446

def Introspect(self, object_path, connection):

939

1447

"""Overloading of standard D-Bus method.

940

1448

941

1449

Inserts property tags and interface annotation tags.

942

1450

"""

943

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

944

connection)

1451

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1452

object_path,

1453

connection)

945

1454

try:

946

1455

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

1456

947

1457

def make_tag(document, name, prop):

948

1458

e = document.createElement("property")

949

1459

e.setAttribute("name", name)

950

1460

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

951

1461

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

952

1462

return e

1463

953

1464

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

954

1465

# Add property tags

955

1466

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

958

1469

if prop._dbus_interface

959

1470

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

960

1471

if_tag.appendChild(tag)

961

# Add annotation tags

962

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

963

for tag in if_tag.getElementsByTagName(typ):

964

annots = dict()

965

for name, prop in (self.

966

_get_all_dbus_things(typ)):

967

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

968

and prop._dbus_interface

969

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

970

annots.update(getattr

971

(prop,

972

"_dbus_annotations",

973

{}))

974

for name, value in annots.iteritems():

975

ann_tag = document.createElement(

976

"annotation")

977

ann_tag.setAttribute("name", name)

978

ann_tag.setAttribute("value", value)

979

tag.appendChild(ann_tag)

980

# Add interface annotation tags

981

for annotation, value in dict(

982

itertools.chain(

983

*(annotations().iteritems()

984

for name, annotations in

985

self._get_all_dbus_things("interface")

986

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

987

))).iteritems():

988

ann_tag = document.createElement("annotation")

989

ann_tag.setAttribute("name", annotation)

990

ann_tag.setAttribute("value", value)

991

if_tag.appendChild(ann_tag)

1472

# Add annotation tags for properties

1473

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

1474

annots = dict()

1475

for name, prop in self._get_all_dbus_things(

1476

"property"):

1477

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

1478

and prop._dbus_interface

1479

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

1480

annots.update(getattr(

1481

prop, "_dbus_annotations", {}))

1482

for name, value in annots.items():

1483

ann_tag = document.createElement(

1484

"annotation")

1485

ann_tag.setAttribute("name", name)

1486

ann_tag.setAttribute("value", value)

1487

tag.appendChild(ann_tag)

992

1488

# Add the names to the return values for the

993

1489

# "org.freedesktop.DBus.Properties" methods

994

1490

if (if_tag.getAttribute("name")

1013

1509

return xmlstring

1014

1510

1015

1511

1016

def datetime_to_dbus (dt, variant_level=0):

1512

try:

1513

dbus.OBJECT_MANAGER_IFACE

1514

except AttributeError:

1515

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

1516

1517

1518

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1519

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

1520

1521

Classes inheriting from this exposes the standard

1522

GetManagedObjects call and the InterfacesAdded and

1523

InterfacesRemoved signals on the standard

1524

"org.freedesktop.DBus.ObjectManager" interface.

1525

1526

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

1527

manually.

1528

"""

1529

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1530

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

1531

def GetManagedObjects(self):

1532

"""This function must be overridden"""

1533

raise NotImplementedError()

1534

1535

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1536

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

1537

def InterfacesAdded(self, object_path, interfaces_and_properties):

1538

pass

1539

1540

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

1541

def InterfacesRemoved(self, object_path, interfaces):

1542

pass

1543

1544

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1545

out_signature="s",

1546

path_keyword='object_path',

1547

connection_keyword='connection')

1548

def Introspect(self, object_path, connection):

1549

"""Overloading of standard D-Bus method.

1550

1551

Override return argument name of GetManagedObjects to be

1552

"objpath_interfaces_and_properties"

1553

"""

1554

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1555

object_path,

1556

connection)

1557

try:

1558

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

1559

1560

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

1561

# Fix argument name for the GetManagedObjects method

1562

if (if_tag.getAttribute("name")

1563

== dbus.OBJECT_MANAGER_IFACE):

1564

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

1565

if (cn.getAttribute("name")

1566

== "GetManagedObjects"):

1567

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

1568

if (arg.getAttribute("direction")

1569

== "out"):

1570

arg.setAttribute(

1571

"name",

1572

"objpath_interfaces"

1573

"_and_properties")

1574

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

1575

document.unlink()

1576

except (AttributeError, xml.dom.DOMException,

1577

xml.parsers.expat.ExpatError) as error:

1578

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

1579

exc_info=error)

1580

return xmlstring

1581

1582

1583

def datetime_to_dbus(dt, variant_level=0):

1017

1584

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

1018

1585

if dt is None:

1019

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

1020

return dbus.String(dt.isoformat(),

1021

variant_level=variant_level)

1586

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

1587

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

1022

1588

1023

1589

1024

1590

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1026

1592

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

1027

1593

interface names according to the "alt_interface_names" mapping.

1028

1594

Usage:

1029

1030

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

1031

"net.example.AlternateInterface"})

1595

1596

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

1597

"net.example.AlternateInterface"})

1032

1598

class SampleDBusObject(dbus.service.Object):

1033

1599

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

1034

1600

def SampleDBusMethod():

1035

1601

pass

1036

1602

1037

1603

The above "SampleDBusMethod" on "SampleDBusObject" will be

1038

1604

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

1039

1605

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

1040

1606

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

1041

1607

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

1042

1608

1043

1609

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

1044

1610

(from DBusObjectWithProperties) and interfaces (from the

1045

1611

dbus_interface_annotations decorator).

1046

1612

"""

1613

1047

1614

def wrapper(cls):

1048

1615

for orig_interface_name, alt_interface_name in (

1049

alt_interface_names.iteritems()):

1616

alt_interface_names.items()):

1050

1617

attr = {}

1051

1618

interface_names = set()

1052

1619

# Go though all attributes of the class

1054

1621

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

1055

1622

# with the wrong interface name

1056

1623

if (not hasattr(attribute, "_dbus_interface")

1057

or not attribute._dbus_interface

1058

.startswith(orig_interface_name)):

1624

or not attribute._dbus_interface.startswith(

1625

orig_interface_name)):

1059

1626

continue

1060

1627

# Create an alternate D-Bus interface name based on

1061

1628

# the current name

1062

alt_interface = (attribute._dbus_interface

1063

.replace(orig_interface_name,

1064

alt_interface_name))

1629

alt_interface = attribute._dbus_interface.replace(

1630

orig_interface_name, alt_interface_name)

1065

1631

interface_names.add(alt_interface)

1066

1632

# Is this a D-Bus signal?

1067

1633

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

1068

# Extract the original non-method function by

1069

# black magic

1070

nonmethod_func = (dict(

1634

# Extract the original non-method undecorated

1635

# function by black magic

1636

if sys.version_info.major == 2:

1637

nonmethod_func = (dict(

1071

1638

zip(attribute.func_code.co_freevars,

1072

attribute.__closure__))["func"]

1073

.cell_contents)

1639

attribute.__closure__))

1640

["func"].cell_contents)

1641

else:

1642

nonmethod_func = (dict(

1643

zip(attribute.__code__.co_freevars,

1644

attribute.__closure__))

1645

["func"].cell_contents)

1074

1646

# Create a new, but exactly alike, function

1075

1647

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

1076

1648

# with the alternate D-Bus interface name

1077

new_function = (dbus.service.signal

1078

(alt_interface,

1079

attribute._dbus_signature)

1080

(types.FunctionType(

1081

nonmethod_func.func_code,

1082

nonmethod_func.func_globals,

1083

nonmethod_func.func_name,

1084

nonmethod_func.func_defaults,

1085

nonmethod_func.func_closure)))

1649

new_function = copy_function(nonmethod_func)

1650

new_function = (dbus.service.signal(

1651

alt_interface,

1652

attribute._dbus_signature)(new_function))

1086

1653

# Copy annotations, if any

1087

1654

try:

1088

new_function._dbus_annotations = (

1089

dict(attribute._dbus_annotations))

1655

new_function._dbus_annotations = dict(

1656

attribute._dbus_annotations)

1090

1657

except AttributeError:

1091

1658

pass

1659

1092

1660

# Define a creator of a function to call both the

1093

1661

# original and alternate functions, so both the

1094

1662

# original and alternate signals gets sent when

1097

1665

"""This function is a scope container to pass

1098

1666

func1 and func2 to the "call_both" function

1099

1667

outside of its arguments"""

1668

1669

@functools.wraps(func2)

1100

1670

def call_both(*args, **kwargs):

1101

1671

"""This function will emit two D-Bus

1102

1672

signals by calling func1 and func2"""

1103

1673

func1(*args, **kwargs)

1104

1674

func2(*args, **kwargs)

1675

# Make wrapper function look like a D-Bus

1676

# signal

1677

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

1678

if name.startswith("_dbus_"):

1679

setattr(call_both, name, attr)

1680

1105

1681

return call_both

1106

1682

# Create the "call_both" function and add it to

1107

1683

# the class

1112

1688

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

1113

1689

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

1114

1690

# to the class.

1115

attr[attrname] = (dbus.service.method

1116

(alt_interface,

1117

attribute._dbus_in_signature,

1118

attribute._dbus_out_signature)

1119

(types.FunctionType

1120

(attribute.func_code,

1121

attribute.func_globals,

1122

attribute.func_name,

1123

attribute.func_defaults,

1124

attribute.func_closure)))

1691

attr[attrname] = (

1692

dbus.service.method(

1693

alt_interface,

1694

attribute._dbus_in_signature,

1695

attribute._dbus_out_signature)

1696

(copy_function(attribute)))

1125

1697

# Copy annotations, if any

1126

1698

try:

1127

attr[attrname]._dbus_annotations = (

1128

dict(attribute._dbus_annotations))

1699

attr[attrname]._dbus_annotations = dict(

1700

attribute._dbus_annotations)

1129

1701

except AttributeError:

1130

1702

pass

1131

1703

# Is this a D-Bus property?

1134

1706

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

1135

1707

# property with the alternate D-Bus interface

1136

1708

# name. Add it to the class.

1137

attr[attrname] = (dbus_service_property

1138

(alt_interface,

1139

attribute._dbus_signature,

1140

attribute._dbus_access,

1141

attribute

1142

._dbus_get_args_options

1143

["byte_arrays"])

1144

(types.FunctionType

1145

(attribute.func_code,

1146

attribute.func_globals,

1147

attribute.func_name,

1148

attribute.func_defaults,

1149

attribute.func_closure)))

1709

attr[attrname] = (dbus_service_property(

1710

alt_interface, attribute._dbus_signature,

1711

attribute._dbus_access,

1712

attribute._dbus_get_args_options

1713

["byte_arrays"])

1714

(copy_function(attribute)))

1150

1715

# Copy annotations, if any

1151

1716

try:

1152

attr[attrname]._dbus_annotations = (

1153

dict(attribute._dbus_annotations))

1717

attr[attrname]._dbus_annotations = dict(

1718

attribute._dbus_annotations)

1154

1719

except AttributeError:

1155

1720

pass

1156

1721

# Is this a D-Bus interface?

1159

1724

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

1160

1725

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

1161

1726

# to the class.

1162

attr[attrname] = (dbus_interface_annotations

1163

(alt_interface)

1164

(types.FunctionType

1165

(attribute.func_code,

1166

attribute.func_globals,

1167

attribute.func_name,

1168

attribute.func_defaults,

1169

attribute.func_closure)))

1727

attr[attrname] = (

1728

dbus_interface_annotations(alt_interface)

1729

(copy_function(attribute)))

1170

1730

if deprecate:

1171

1731

# Deprecate all alternate interfaces

1172

iname="_AlternateDBusNames_interface_annotation{0}"

1732

iname = "_AlternateDBusNames_interface_annotation{}"

1173

1733

for interface_name in interface_names:

1734

1174

1735

@dbus_interface_annotations(interface_name)

1175

1736

def func(self):

1176

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

1177

"true" }

1737

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

1738

"true"}

1178

1739

# Find an unused name

1179

1740

for aname in (iname.format(i)

1180

1741

for i in itertools.count()):

1184

1745

if interface_names:

1185

1746

# Replace the class with a new subclass of it with

1186

1747

# methods, signals, etc. as created above.

1187

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

1188

(cls,), attr)

1748

if sys.version_info.major == 2:

1749

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

1750

(cls, ), attr)

1751

else:

1752

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

1753

(cls, ), attr)

1189

1754

return cls

1755

1190

1756

return wrapper

1191

1757

1192

1758

1193

1759

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

1194

"se.bsnet.fukt.Mandos"})

1760

"se.bsnet.fukt.Mandos"})

1195

1761

class ClientDBus(Client, DBusObjectWithProperties):

1196

1762

"""A Client class using D-Bus

1197

1763

1198

1764

Attributes:

1199

1765

dbus_object_path: dbus.ObjectPath

1200

1766

bus: dbus.SystemBus()

1201

1767

"""

1202

1768

1203

1769

runtime_expansions = (Client.runtime_expansions

1204

+ ("dbus_object_path",))

1205

1770

+ ("dbus_object_path", ))

1771

1772

_interface = "se.recompile.Mandos.Client"

1773

1206

1774

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

1207

1208

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

1775

1776

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

1209

1777

self.bus = bus

1210

1778

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

1211

1779

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

1212

1780

# the D-Bus

1213

client_object_name = unicode(self.name).translate(

1781

client_object_name = str(self.name).translate(

1214

1782

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

1215

1783

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

1216

self.dbus_object_path = (dbus.ObjectPath

1217

("/clients/" + client_object_name))

1784

self.dbus_object_path = dbus.ObjectPath(

1785

"/clients/" + client_object_name)

1218

1786

DBusObjectWithProperties.__init__(self, self.bus,

1219

1787

self.dbus_object_path)

1220

1221

def notifychangeproperty(transform_func,

1222

dbus_name, type_func=lambda x: x,

1223

variant_level=1):

1788

1789

def notifychangeproperty(transform_func, dbus_name,

1790

type_func=lambda x: x,

1791

variant_level=1,

1792

invalidate_only=False,

1793

_interface=_interface):

1224

1794

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

1225

1795

its changes to DBus.

1226

1796

1227

1797

transform_fun: Function that takes a value and a variant_level

1228

1798

and transforms it to a D-Bus type.

1229

1799

dbus_name: D-Bus name of the variable

1231

1801

to the D-Bus. Default: no transform

1232

1802

variant_level: D-Bus variant level. Default: 1

1233

1803

"""

1234

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

1804

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

1805

1235

1806

def setter(self, value):

1236

1807

if hasattr(self, "dbus_object_path"):

1237

1808

if (not hasattr(self, attrname) or

1238

1809

type_func(getattr(self, attrname, None))

1239

1810

!= type_func(value)):

1240

dbus_value = transform_func(type_func(value),

1241

variant_level

1242

=variant_level)

1243

self.PropertyChanged(dbus.String(dbus_name),

1244

dbus_value)

1811

if invalidate_only:

1812

self.PropertiesChanged(

1813

_interface, dbus.Dictionary(),

1814

dbus.Array((dbus_name, )))

1815

else:

1816

dbus_value = transform_func(

1817

type_func(value),

1818

variant_level=variant_level)

1819

self.PropertyChanged(dbus.String(dbus_name),

1820

dbus_value)

1821

self.PropertiesChanged(

1822

_interface,

1823

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

1824

dbus_value}),

1825

dbus.Array())

1245

1826

setattr(self, attrname, value)

1246

1827

1247

1828

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

1248

1829

1249

1830

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1250

1831

approvals_pending = notifychangeproperty(dbus.Boolean,

1251

1832

"ApprovalPending",

1252

type_func = bool)

1833

type_func=bool)

1253

1834

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

1254

1835

last_enabled = notifychangeproperty(datetime_to_dbus,

1255

1836

"LastEnabled")

1256

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

1257

type_func = lambda checker:

1258

checker is not None)

1837

checker = notifychangeproperty(

1838

dbus.Boolean, "CheckerRunning",

1839

type_func=lambda checker: checker is not None)

1259

1840

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1260

1841

"LastCheckedOK")

1261

1842

last_checker_status = notifychangeproperty(dbus.Int16,

1264

1845

datetime_to_dbus, "LastApprovalRequest")

1265

1846

approved_by_default = notifychangeproperty(dbus.Boolean,

1266

1847

"ApprovedByDefault")

1267

approval_delay = notifychangeproperty(dbus.UInt64,

1268

"ApprovalDelay",

1269

type_func =

1270

timedelta_to_milliseconds)

1848

approval_delay = notifychangeproperty(

1849

dbus.UInt64, "ApprovalDelay",

1850

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

1271

1851

approval_duration = notifychangeproperty(

1272

1852

dbus.UInt64, "ApprovalDuration",

1273

type_func = timedelta_to_milliseconds)

1853

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

1274

1854

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

1275

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

1276

type_func =

1277

timedelta_to_milliseconds)

1855

timeout = notifychangeproperty(

1856

dbus.UInt64, "Timeout",

1857

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

1278

1858

extended_timeout = notifychangeproperty(

1279

1859

dbus.UInt64, "ExtendedTimeout",

1280

type_func = timedelta_to_milliseconds)

1281

interval = notifychangeproperty(dbus.UInt64,

1282

"Interval",

1283

type_func =

1284

timedelta_to_milliseconds)

1860

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

1861

interval = notifychangeproperty(

1862

dbus.UInt64, "Interval",

1863

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

1285

1864

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

1286

1865

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

1866

invalidate_only=True)

1867

1287

1868

del notifychangeproperty

1288

1869

1289

1870

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

1290

1871

try:

1291

1872

self.remove_from_connection()

1294

1875

if hasattr(DBusObjectWithProperties, "__del__"):

1295

1876

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

1296

1877

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

1297

1298

def checker_callback(self, pid, condition, command,

1299

*args, **kwargs):

1300

self.checker_callback_tag = None

1301

self.checker = None

1302

if os.WIFEXITED(condition):

1303

exitstatus = os.WEXITSTATUS(condition)

1878

1879

def checker_callback(self, source, condition,

1880

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

1881

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

1882

connection, command, *args,

1883

**kwargs)

1884

exitstatus = self.last_checker_status

1885

if exitstatus >= 0:

1304

1886

# Emit D-Bus signal

1305

1887

self.CheckerCompleted(dbus.Int16(exitstatus),

1306

dbus.Int64(condition),

1888

# This is specific to GNU libC

1889

dbus.Int64(exitstatus << 8),

1307

1890

dbus.String(command))

1308

1891

else:

1309

1892

# Emit D-Bus signal

1310

1893

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

1311

dbus.Int64(condition),

1894

dbus.Int64(

1895

# This is specific to GNU libC

1896

(exitstatus << 8)

1897

| self.last_checker_signal),

1312

1898

dbus.String(command))

1313

1314

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

1315

*args, **kwargs)

1316

1899

return ret

1900

1317

1901

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

1318

old_checker = self.checker

1319

if self.checker is not None:

1320

old_checker_pid = self.checker.pid

1321

else:

1322

old_checker_pid = None

1902

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

1323

1903

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

1324

1904

# Only if new checker process was started

1325

1905

if (self.checker is not None

1327

1907

# Emit D-Bus signal

1328

1908

self.CheckerStarted(self.current_checker_command)

1329

1909

return r

1330

1910

1331

1911

def _reset_approved(self):

1332

1912

self.approved = None

1333

1913

return False

1334

1914

1335

1915

def approve(self, value=True):

1336

self.send_changedstate()

1337

1916

self.approved = value

1338

gobject.timeout_add(timedelta_to_milliseconds

1339

(self.approval_duration),

1340

self._reset_approved)

1341

1342

## D-Bus methods, signals & properties

1343

_interface = "se.recompile.Mandos.Client"

1344

1345

## Interfaces

1346

1347

@dbus_interface_annotations(_interface)

1348

def _foo(self):

1349

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

1350

"false"}

1351

1352

## Signals

1353

1917

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

1918

* 1000), self._reset_approved)

1919

self.send_changedstate()

1920

1921

# D-Bus methods, signals & properties

1922

1923

# Interfaces

1924

1925

# Signals

1926

1354

1927

# CheckerCompleted - signal

1355

1928

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

1356

1929

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

1357

1930

"D-Bus signal"

1358

1931

pass

1359

1932

1360

1933

# CheckerStarted - signal

1361

1934

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

1362

1935

def CheckerStarted(self, command):

1363

1936

"D-Bus signal"

1364

1937

pass

1365

1938

1366

1939

# PropertyChanged - signal

1940

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

1367

1941

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

1368

1942

def PropertyChanged(self, property, value):

1369

1943

"D-Bus signal"

1370

1944

pass

1371

1945

1372

1946

# GotSecret - signal

1373

1947

@dbus.service.signal(_interface)

1374

1948

def GotSecret(self):

1377

1951

server to mandos-client

1378

1952

"""

1379

1953

pass

1380

1954

1381

1955

# Rejected - signal

1382

1956

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

1383

1957

def Rejected(self, reason):

1384

1958

"D-Bus signal"

1385

1959

pass

1386

1960

1387

1961

# NeedApproval - signal

1388

1962

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

1389

1963

def NeedApproval(self, timeout, default):

1390

1964

"D-Bus signal"

1391

1965

return self.need_approval()

1392

1393

## Methods

1394

1966

1967

# Methods

1968

1395

1969

# Approve - method

1396

1970

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

1397

1971

def Approve(self, value):

1398

1972

self.approve(value)

1399

1973

1400

1974

# CheckedOK - method

1401

1975

@dbus.service.method(_interface)

1402

1976

def CheckedOK(self):

1403

1977

self.checked_ok()

1404

1978

1405

1979

# Enable - method

1980

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

1406

1981

@dbus.service.method(_interface)

1407

1982

def Enable(self):

1408

1983

"D-Bus method"

1409

1984

self.enable()

1410

1985

1411

1986

# StartChecker - method

1987

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

1412

1988

@dbus.service.method(_interface)

1413

1989

def StartChecker(self):

1414

1990

"D-Bus method"

1415

1991

self.start_checker()

1416

1992

1417

1993

# Disable - method

1994

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

1418

1995

@dbus.service.method(_interface)

1419

1996

def Disable(self):

1420

1997

"D-Bus method"

1421

1998

self.disable()

1422

1999

1423

2000

# StopChecker - method

2001

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

1424

2002

@dbus.service.method(_interface)

1425

2003

def StopChecker(self):

1426

2004

self.stop_checker()

1427

1428

## Properties

1429

2005

2006

# Properties

2007

1430

2008

# ApprovalPending - property

1431

2009

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

1432

2010

def ApprovalPending_dbus_property(self):

1433

2011

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

1434

2012

1435

2013

# ApprovedByDefault - property

1436

@dbus_service_property(_interface, signature="b",

2014

@dbus_service_property(_interface,

2015

signature="b",

1437

2016

access="readwrite")

1438

2017

def ApprovedByDefault_dbus_property(self, value=None):

1439

2018

if value is None: # get

1440

2019

return dbus.Boolean(self.approved_by_default)

1441

2020

self.approved_by_default = bool(value)

1442

2021

1443

2022

# ApprovalDelay - property

1444

@dbus_service_property(_interface, signature="t",

2023

@dbus_service_property(_interface,

2024

signature="t",

1445

2025

access="readwrite")

1446

2026

def ApprovalDelay_dbus_property(self, value=None):

1447

2027

if value is None: # get

1448

return dbus.UInt64(self.approval_delay_milliseconds())

2028

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

2029

* 1000)

1449

2030

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

1450

2031

1451

2032

# ApprovalDuration - property

1452

@dbus_service_property(_interface, signature="t",

2033

@dbus_service_property(_interface,

2034

signature="t",

1453

2035

access="readwrite")

1454

2036

def ApprovalDuration_dbus_property(self, value=None):

1455

2037

if value is None: # get

1456

return dbus.UInt64(timedelta_to_milliseconds(

1457

self.approval_duration))

2038

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

2039

* 1000)

1458

2040

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

1459

2041

1460

2042

# Name - property

2043

@dbus_annotations(

2044

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

1461

2045

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

1462

2046

def Name_dbus_property(self):

1463

2047

return dbus.String(self.name)

1464

2048

2049

# KeyID - property

2050

@dbus_annotations(

2051

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

2052

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

2053

def KeyID_dbus_property(self):

2054

return dbus.String(self.key_id)

2055

1465

2056

# Fingerprint - property

2057

@dbus_annotations(

2058

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

1466

2059

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

1467

2060

def Fingerprint_dbus_property(self):

1468

2061

return dbus.String(self.fingerprint)

1469

2062

1470

2063

# Host - property

1471

@dbus_service_property(_interface, signature="s",

2064

@dbus_service_property(_interface,

2065

signature="s",

1472

2066

access="readwrite")

1473

2067

def Host_dbus_property(self, value=None):

1474

2068

if value is None: # get

1475

2069

return dbus.String(self.host)

1476

self.host = unicode(value)

1477

2070

self.host = str(value)

2071

1478

2072

# Created - property

2073

@dbus_annotations(

2074

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

1479

2075

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

1480

2076

def Created_dbus_property(self):

1481

2077

return datetime_to_dbus(self.created)

1482

2078

1483

2079

# LastEnabled - property

1484

2080

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

1485

2081

def LastEnabled_dbus_property(self):

1486

2082

return datetime_to_dbus(self.last_enabled)

1487

2083

1488

2084

# Enabled - property

1489

@dbus_service_property(_interface, signature="b",

2085

@dbus_service_property(_interface,

2086

signature="b",

1490

2087

access="readwrite")

1491

2088

def Enabled_dbus_property(self, value=None):

1492

2089

if value is None: # get

1495

2092

self.enable()

1496

2093

else:

1497

2094

self.disable()

1498

2095

1499

2096

# LastCheckedOK - property

1500

@dbus_service_property(_interface, signature="s",

2097

@dbus_service_property(_interface,

2098

signature="s",

1501

2099

access="readwrite")

1502

2100

def LastCheckedOK_dbus_property(self, value=None):

1503

2101

if value is not None:

1504

2102

self.checked_ok()

1505

2103

return

1506

2104

return datetime_to_dbus(self.last_checked_ok)

1507

2105

1508

2106

# LastCheckerStatus - property

1509

@dbus_service_property(_interface, signature="n",

1510

access="read")

2107

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

1511

2108

def LastCheckerStatus_dbus_property(self):

1512

2109

return dbus.Int16(self.last_checker_status)

1513

2110

1514

2111

# Expires - property

1515

2112

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

1516

2113

def Expires_dbus_property(self):

1517

2114

return datetime_to_dbus(self.expires)

1518

2115

1519

2116

# LastApprovalRequest - property

1520

2117

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

1521

2118

def LastApprovalRequest_dbus_property(self):

1522

2119

return datetime_to_dbus(self.last_approval_request)

1523

2120

1524

2121

# Timeout - property

1525

@dbus_service_property(_interface, signature="t",

2122

@dbus_service_property(_interface,

2123

signature="t",

1526

2124

access="readwrite")

1527

2125

def Timeout_dbus_property(self, value=None):

1528

2126

if value is None: # get

1529

return dbus.UInt64(self.timeout_milliseconds())

2127

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

2128

old_timeout = self.timeout

1530

2129

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

1531

# Reschedule timeout

2130

# Reschedule disabling

1532

2131

if self.enabled:

1533

2132

now = datetime.datetime.utcnow()

1534

time_to_die = timedelta_to_milliseconds(

1535

(self.last_checked_ok + self.timeout) - now)

1536

if time_to_die <= 0:

2133

self.expires += self.timeout - old_timeout

2134

if self.expires <= now:

1537

2135

# The timeout has passed

1538

2136

self.disable()

1539

2137

else:

1540

self.expires = (now +

1541

datetime.timedelta(milliseconds =

1542

time_to_die))

1543

2138

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

1544

2139

is None):

1545

2140

return

1546

gobject.source_remove(self.disable_initiator_tag)

1547

self.disable_initiator_tag = (gobject.timeout_add

1548

(time_to_die,

1549

self.disable))

1550

2141

GLib.source_remove(self.disable_initiator_tag)

2142

self.disable_initiator_tag = GLib.timeout_add(

2143

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

2144

self.disable)

2145

1551

2146

# ExtendedTimeout - property

1552

@dbus_service_property(_interface, signature="t",

2147

@dbus_service_property(_interface,

2148

signature="t",

1553

2149

access="readwrite")

1554

2150

def ExtendedTimeout_dbus_property(self, value=None):

1555

2151

if value is None: # get

1556

return dbus.UInt64(self.extended_timeout_milliseconds())

2152

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

2153

* 1000)

1557

2154

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

1558

2155

1559

2156

# Interval - property

1560

@dbus_service_property(_interface, signature="t",

2157

@dbus_service_property(_interface,

2158

signature="t",

1561

2159

access="readwrite")

1562

2160

def Interval_dbus_property(self, value=None):

1563

2161

if value is None: # get

1564

return dbus.UInt64(self.interval_milliseconds())

2162

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

1565

2163

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

1566

2164

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

1567

2165

return

1568

2166

if self.enabled:

1569

2167

# Reschedule checker run

1570

gobject.source_remove(self.checker_initiator_tag)

1571

self.checker_initiator_tag = (gobject.timeout_add

1572

(value, self.start_checker))

1573

self.start_checker() # Start one now, too

1574

2168

GLib.source_remove(self.checker_initiator_tag)

2169

self.checker_initiator_tag = GLib.timeout_add(

2170

value, self.start_checker)

2171

self.start_checker() # Start one now, too

2172

1575

2173

# Checker - property

1576

@dbus_service_property(_interface, signature="s",

2174

@dbus_service_property(_interface,

2175

signature="s",

1577

2176

access="readwrite")

1578

2177

def Checker_dbus_property(self, value=None):

1579

2178

if value is None: # get

1580

2179

return dbus.String(self.checker_command)

1581

self.checker_command = unicode(value)

1582

2180

self.checker_command = str(value)

2181

1583

2182

# CheckerRunning - property

1584

@dbus_service_property(_interface, signature="b",

2183

@dbus_service_property(_interface,

2184

signature="b",

1585

2185

access="readwrite")

1586

2186

def CheckerRunning_dbus_property(self, value=None):

1587

2187

if value is None: # get

1590

2190

self.start_checker()

1591

2191

else:

1592

2192

self.stop_checker()

1593

2193

1594

2194

# ObjectPath - property

2195

@dbus_annotations(

2196

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

2197

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

1595

2198

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

1596

2199

def ObjectPath_dbus_property(self):

1597

return self.dbus_object_path # is already a dbus.ObjectPath

1598

2200

return self.dbus_object_path # is already a dbus.ObjectPath

2201

1599

2202

# Secret = property

1600

@dbus_service_property(_interface, signature="ay",

1601

access="write", byte_arrays=True)

2203

@dbus_annotations(

2204

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

2205

"invalidates"})

2206

@dbus_service_property(_interface,

2207

signature="ay",

2208

access="write",

2209

byte_arrays=True)

1602

2210

def Secret_dbus_property(self, value):

1603

self.secret = str(value)

1604

2211

self.secret = bytes(value)

2212

1605

2213

del _interface

1606

2214

1607

2215

1608

2216

class ProxyClient(object):

1609

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

2217

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

1610

2218

self._pipe = child_pipe

1611

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

2219

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

1612

2220

if not self._pipe.recv():

1613

raise KeyError()

1614

2221

raise KeyError(key_id or fpr)

2222

1615

2223

def __getattribute__(self, name):

1616

2224

if name == '_pipe':

1617

2225

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

1620

2228

if data[0] == 'data':

1621

2229

return data[1]

1622

2230

if data[0] == 'function':

2231

1623

2232

def func(*args, **kwargs):

1624

2233

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

1625

2234

return self._pipe.recv()[1]

2235

1626

2236

return func

1627

2237

1628

2238

def __setattr__(self, name, value):

1629

2239

if name == '_pipe':

1630

2240

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

1633

2243

1634

2244

class ClientHandler(socketserver.BaseRequestHandler, object):

1635

2245

"""A class to handle client connections.

1636

2246

1637

2247

Instantiated once for each connection to handle it.

1638

2248

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

1639

2249

1640

2250

def handle(self):

1641

2251

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

1642

2252

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

1643

unicode(self.client_address))

2253

str(self.client_address))

1644

2254

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

1645

2255

self.server.child_pipe.fileno())

1646

1647

session = (gnutls.connection

1648

.ClientSession(self.request,

1649

gnutls.connection

1650

.X509Credentials()))

1651

1652

# Note: gnutls.connection.X509Credentials is really a

1653

# generic GnuTLS certificate credentials object so long as

1654

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

1655

# here despite using OpenPGP certificates.

1656

1657

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

1658

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

1659

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

1660

# "+DHE-DSS"))

2256

2257

session = gnutls.ClientSession(self.request)

2258

2259

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

2260

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

2261

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

2262

# "+DHE-DSS"))

1661

2263

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

1662

2264

priority = self.server.gnutls_priority

1663

2265

if priority is None:

1664

2266

priority = "NORMAL"

1665

(gnutls.library.functions

1666

.gnutls_priority_set_direct(session._c_object,

1667

priority, None))

1668

2267

gnutls.priority_set_direct(session._c_object,

2268

priority.encode("utf-8"),

2269

None)

2270

1669

2271

# Start communication using the Mandos protocol

1670

2272

# Get protocol number

1671

2273

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

1672

2274

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

1673

2275

try:

1674

2276

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

1675

raise RuntimeError

2277

raise RuntimeError(line)

1676

2278

except (ValueError, IndexError, RuntimeError) as error:

1677

2279

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

1678

2280

return

1679

2281

1680

2282

# Start GnuTLS connection

1681

2283

try:

1682

2284

session.handshake()

1683

except gnutls.errors.GNUTLSError as error:

2285

except gnutls.Error as error:

1684

2286

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

1685

2287

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

1686

2288

# established. Just abandon the request.

1687

2289

return

1688

2290

logger.debug("Handshake succeeded")

1689

2291

1690

2292

approval_required = False

1691

2293

try:

1692

try:

1693

fpr = self.fingerprint(self.peer_certificate

1694

(session))

1695

except (TypeError,

1696

gnutls.errors.GNUTLSError) as error:

1697

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

1698

return

1699

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

1700

1701

try:

1702

client = ProxyClient(child_pipe, fpr,

2294

if gnutls.has_rawpk:

2295

fpr = b""

2296

try:

2297

key_id = self.key_id(

2298

self.peer_certificate(session))

2299

except (TypeError, gnutls.Error) as error:

2300

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

2301

return

2302

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

2303

2304

else:

2305

key_id = b""

2306

try:

2307

fpr = self.fingerprint(

2308

self.peer_certificate(session))

2309

except (TypeError, gnutls.Error) as error:

2310

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

2311

return

2312

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

2313

2314

try:

2315

client = ProxyClient(child_pipe, key_id, fpr,

1703

2316

self.client_address)

1704

2317

except KeyError:

1705

2318

return

1706

2319

1707

2320

if client.approval_delay:

1708

2321

delay = client.approval_delay

1709

2322

client.approvals_pending += 1

1710

2323

approval_required = True

1711

2324

1712

2325

while True:

1713

2326

if not client.enabled:

1714

2327

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

1715

client.name)

2328

client.name)

1716

2329

if self.server.use_dbus:

1717

2330

# Emit D-Bus signal

1718

2331

client.Rejected("Disabled")

1719

2332

return

1720

2333

1721

2334

if client.approved or not client.approval_delay:

1722

#We are approved or approval is disabled

2335

# We are approved or approval is disabled

1723

2336

break

1724

2337

elif client.approved is None:

1725

2338

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

1727

2340

if self.server.use_dbus:

1728

2341

# Emit D-Bus signal

1729

2342

client.NeedApproval(

1730

client.approval_delay_milliseconds(),

1731

client.approved_by_default)

2343

client.approval_delay.total_seconds()

2344

* 1000, client.approved_by_default)

1732

2345

else:

1733

2346

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

1734

2347

client.name)

1736

2349

# Emit D-Bus signal

1737

2350

client.Rejected("Denied")

1738

2351

return

1739

1740

#wait until timeout or approved

2352

2353

# wait until timeout or approved

1741

2354

time = datetime.datetime.now()

1742

2355

client.changedstate.acquire()

1743

(client.changedstate.wait

1744

(float(client.timedelta_to_milliseconds(delay)

1745

/ 1000)))

2356

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

1746

2357

client.changedstate.release()

1747

2358

time2 = datetime.datetime.now()

1748

2359

if (time2 - time) >= delay:

1758

2369

break

1759

2370

else:

1760

2371

delay -= time2 - time

1761

1762

sent_size = 0

1763

while sent_size < len(client.secret):

1764

try:

1765

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

1766

except gnutls.errors.GNUTLSError as error:

1767

logger.warning("gnutls send failed",

1768

exc_info=error)

1769

return

1770

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

1771

sent, len(client.secret)

1772

- (sent_size + sent))

1773

sent_size += sent

1774

2372

2373

try:

2374

session.send(client.secret)

2375

except gnutls.Error as error:

2376

logger.warning("gnutls send failed",

2377

exc_info=error)

2378

return

2379

1775

2380

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

1776

2381

# bump the timeout using extended_timeout

1777

2382

client.bump_timeout(client.extended_timeout)

1778

2383

if self.server.use_dbus:

1779

2384

# Emit D-Bus signal

1780

2385

client.GotSecret()

1781

2386

1782

2387

finally:

1783

2388

if approval_required:

1784

2389

client.approvals_pending -= 1

1785

2390

try:

1786

2391

session.bye()

1787

except gnutls.errors.GNUTLSError as error:

2392

except gnutls.Error as error:

1788

2393

logger.warning("GnuTLS bye failed",

1789

2394

exc_info=error)

1790

2395

1791

2396

@staticmethod

1792

2397

def peer_certificate(session):

1793

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

1794

# If not an OpenPGP certificate...

1795

if (gnutls.library.functions

1796

.gnutls_certificate_type_get(session._c_object)

1797

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1798

# ...do the normal thing

1799

return session.peer_certificate

2398

"Return the peer's certificate as a bytestring"

2399

try:

2400

cert_type = gnutls.certificate_type_get2(session._c_object,

2401

gnutls.CTYPE_PEERS)

2402

except AttributeError:

2403

cert_type = gnutls.certificate_type_get(session._c_object)

2404

if gnutls.has_rawpk:

2405

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2406

else:

2407

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2408

# If not a valid certificate type...

2409

if cert_type not in valid_cert_types:

2410

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

2411

valid_cert_types)

2412

# ...return invalid data

2413

return b""

1800

2414

list_size = ctypes.c_uint(1)

1801

cert_list = (gnutls.library.functions

1802

.gnutls_certificate_get_peers

2415

cert_list = (gnutls.certificate_get_peers

1803

2416

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

1804

2417

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

1805

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

1806

" certificate")

2418

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

1807

2419

if list_size.value == 0:

1808

2420

return None

1809

2421

cert = cert_list[0]

1810

2422

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

1811

2423

2424

@staticmethod

2425

def key_id(certificate):

2426

"Convert a certificate bytestring to a hexdigit key ID"

2427

# New GnuTLS "datum" with the public key

2428

datum = gnutls.datum_t(

2429

ctypes.cast(ctypes.c_char_p(certificate),

2430

ctypes.POINTER(ctypes.c_ubyte)),

2431

ctypes.c_uint(len(certificate)))

2432

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

2433

# New empty GnuTLS certificate

2434

pubkey = gnutls.pubkey_t()

2435

gnutls.pubkey_init(ctypes.byref(pubkey))

2436

# Import the raw public key into the certificate

2437

gnutls.pubkey_import(pubkey,

2438

ctypes.byref(datum),

2439

gnutls.X509_FMT_DER)

2440

# New buffer for the key ID

2441

buf = ctypes.create_string_buffer(32)

2442

buf_len = ctypes.c_size_t(len(buf))

2443

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

2444

gnutls.pubkey_get_key_id(pubkey,

2445

gnutls.KEYID_USE_SHA256,

2446

ctypes.cast(ctypes.byref(buf),

2447

ctypes.POINTER(ctypes.c_ubyte)),

2448

ctypes.byref(buf_len))

2449

# Deinit the certificate

2450

gnutls.pubkey_deinit(pubkey)

2451

2452

# Convert the buffer to a Python bytestring

2453

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

2454

# Convert the bytestring to hexadecimal notation

2455

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

2456

return hex_key_id

2457

1812

2458

@staticmethod

1813

2459

def fingerprint(openpgp):

1814

2460

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1815

2461

# New GnuTLS "datum" with the OpenPGP public key

1816

datum = (gnutls.library.types

1817

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

1818

ctypes.POINTER

1819

(ctypes.c_ubyte)),

1820

ctypes.c_uint(len(openpgp))))

2462

datum = gnutls.datum_t(

2463

ctypes.cast(ctypes.c_char_p(openpgp),

2464

ctypes.POINTER(ctypes.c_ubyte)),

2465

ctypes.c_uint(len(openpgp)))

1821

2466

# New empty GnuTLS certificate

1822

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1823

(gnutls.library.functions

1824

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2467

crt = gnutls.openpgp_crt_t()

2468

gnutls.openpgp_crt_init(ctypes.byref(crt))

1825

2469

# Import the OpenPGP public key into the certificate

1826

(gnutls.library.functions

1827

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

1828

gnutls.library.constants

1829

.GNUTLS_OPENPGP_FMT_RAW))

2470

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

2471

gnutls.OPENPGP_FMT_RAW)

1830

2472

# Verify the self signature in the key

1831

2473

crtverify = ctypes.c_uint()

1832

(gnutls.library.functions

1833

.gnutls_openpgp_crt_verify_self(crt, 0,

1834

ctypes.byref(crtverify)))

2474

gnutls.openpgp_crt_verify_self(crt, 0,

2475

ctypes.byref(crtverify))

1835

2476

if crtverify.value != 0:

1836

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1837

raise (gnutls.errors.CertificateSecurityError

1838

("Verify failed"))

2477

gnutls.openpgp_crt_deinit(crt)

2478

raise gnutls.CertificateSecurityError(code

2479

=crtverify.value)

1839

2480

# New buffer for the fingerprint

1840

2481

buf = ctypes.create_string_buffer(20)

1841

2482

buf_len = ctypes.c_size_t()

1842

2483

# Get the fingerprint from the certificate into the buffer

1843

(gnutls.library.functions

1844

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

1845

ctypes.byref(buf_len)))

2484

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

2485

ctypes.byref(buf_len))

1846

2486

# Deinit the certificate

1847

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2487

gnutls.openpgp_crt_deinit(crt)

1848

2488

# Convert the buffer to a Python bytestring

1849

2489

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

1850

2490

# Convert the bytestring to hexadecimal notation

1854

2494

1855

2495

class MultiprocessingMixIn(object):

1856

2496

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

2497

1857

2498

def sub_process_main(self, request, address):

1858

2499

try:

1859

2500

self.finish_request(request, address)

1860

2501

except Exception:

1861

2502

self.handle_error(request, address)

1862

2503

self.close_request(request)

1863

2504

1864

2505

def process_request(self, request, address):

1865

2506

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

1866

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

1867

args = (request,

1868

address))

2507

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

2508

args=(request, address))

1869

2509

proc.start()

1870

2510

return proc

1871

2511

1872

2512

1873

2513

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1874

2514

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

2515

1875

2516

def process_request(self, request, client_address):

1876

2517

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

1877

2518

1878

2519

This function creates a new pipe in self.pipe

1879

2520

"""

1880

2521

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1881

2522

1882

2523

proc = MultiprocessingMixIn.process_request(self, request,

1883

2524

client_address)

1884

2525

self.child_pipe.close()

1885

2526

self.add_pipe(parent_pipe, proc)

1886

2527

1887

2528

def add_pipe(self, parent_pipe, proc):

1888

2529

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

1889

raise NotImplementedError

2530

raise NotImplementedError()

1890

2531

1891

2532

1892

2533

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1893

2534

socketserver.TCPServer, object):

1894

2535

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

1895

2536

1896

2537

Attributes:

1897

2538

enabled: Boolean; whether this server is activated yet

1898

2539

interface: None or a network interface name (string)

1899

2540

use_ipv6: Boolean; to use IPv6 or not

1900

2541

"""

2542

1901

2543

def __init__(self, server_address, RequestHandlerClass,

1902

interface=None, use_ipv6=True):

2544

interface=None,

2545

use_ipv6=True,

2546

socketfd=None):

2547

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

2548

creating a new one with socket.socket().

2549

"""

1903

2550

self.interface = interface

1904

2551

if use_ipv6:

1905

2552

self.address_family = socket.AF_INET6

2553

if socketfd is not None:

2554

# Save the file descriptor

2555

self.socketfd = socketfd

2556

# Save the original socket.socket() function

2557

self.socket_socket = socket.socket

2558

2559

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

2560

#

2561

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

2562

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

2563

# patching socket.socket.)

2564

#

2565

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

2566

@functools.wraps(socket.socket)

2567

def socket_wrapper(*args, **kwargs):

2568

# Restore original function so subsequent calls are

2569

# not affected.

2570

socket.socket = self.socket_socket

2571

del self.socket_socket

2572

# This time only, return a new socket object from the

2573

# saved file descriptor.

2574

return socket.fromfd(self.socketfd, *args, **kwargs)

2575

# Replace socket.socket() function with wrapper

2576

socket.socket = socket_wrapper

2577

# The socketserver.TCPServer.__init__ will call

2578

# socket.socket(), which might be our replacement,

2579

# socket_wrapper(), if socketfd was set.

1906

2580

socketserver.TCPServer.__init__(self, server_address,

1907

2581

RequestHandlerClass)

2582

1908

2583

def server_bind(self):

1909

2584

"""This overrides the normal server_bind() function

1910

2585

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

1911

2586

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

2587

global SO_BINDTODEVICE

1912

2588

if self.interface is not None:

1913

2589

if SO_BINDTODEVICE is None:

1914

logger.error("SO_BINDTODEVICE does not exist;"

1915

" cannot bind to interface %s",

1916

self.interface)

1917

else:

1918

try:

1919

self.socket.setsockopt(socket.SOL_SOCKET,

1920

SO_BINDTODEVICE,

1921

str(self.interface

1922

+ '\0'))

1923

except socket.error as error:

1924

if error[0] == errno.EPERM:

1925

logger.error("No permission to"

1926

" bind to interface %s",

1927

self.interface)

1928

elif error[0] == errno.ENOPROTOOPT:

1929

logger.error("SO_BINDTODEVICE not available;"

1930

" cannot bind to interface %s",

1931

self.interface)

1932

else:

1933

raise

2590

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

2591

# common enough.

2592

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

2593

SO_BINDTODEVICE = 25

2594

try:

2595

self.socket.setsockopt(

2596

socket.SOL_SOCKET, SO_BINDTODEVICE,

2597

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

2598

except socket.error as error:

2599

if error.errno == errno.EPERM:

2600

logger.error("No permission to bind to"

2601

" interface %s", self.interface)

2602

elif error.errno == errno.ENOPROTOOPT:

2603

logger.error("SO_BINDTODEVICE not available;"

2604

" cannot bind to interface %s",

2605

self.interface)

2606

elif error.errno == errno.ENODEV:

2607

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

2608

" cannot bind", self.interface)

2609

else:

2610

raise

1934

2611

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

1935

2612

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

2613

if self.server_address[1]:

2614

self.allow_reuse_address = True

1936

2615

if not self.server_address[0]:

1937

2616

if self.address_family == socket.AF_INET6:

1938

any_address = "::" # in6addr_any

2617

any_address = "::" # in6addr_any

1939

2618

else:

1940

any_address = socket.INADDR_ANY

2619

any_address = "0.0.0.0" # INADDR_ANY

1941

2620

self.server_address = (any_address,

1942

2621

self.server_address[1])

1943

2622

elif not self.server_address[1]:

1944

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

1945

0)

2623

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

1946

2624

# if self.interface:

1947

2625

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

1948

2626

# 0, # port

1954

2632

1955

2633

class MandosServer(IPv6_TCPServer):

1956

2634

"""Mandos server.

1957

2635

1958

2636

Attributes:

1959

2637

clients: set of Client objects

1960

2638

gnutls_priority GnuTLS priority string

1961

2639

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

1962

1963

Assumes a gobject.MainLoop event loop.

2640

2641

Assumes a GLib.MainLoop event loop.

1964

2642

"""

2643

1965

2644

def __init__(self, server_address, RequestHandlerClass,

1966

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

1967

gnutls_priority=None, use_dbus=True):

2645

interface=None,

2646

use_ipv6=True,

2647

clients=None,

2648

gnutls_priority=None,

2649

use_dbus=True,

2650

socketfd=None):

1968

2651

self.enabled = False

1969

2652

self.clients = clients

1970

2653

if self.clients is None:

1973

2656

self.gnutls_priority = gnutls_priority

1974

2657

IPv6_TCPServer.__init__(self, server_address,

1975

2658

RequestHandlerClass,

1976

interface = interface,

1977

use_ipv6 = use_ipv6)

2659

interface=interface,

2660

use_ipv6=use_ipv6,

2661

socketfd=socketfd)

2662

1978

2663

def server_activate(self):

1979

2664

if self.enabled:

1980

2665

return socketserver.TCPServer.server_activate(self)

1981

2666

1982

2667

def enable(self):

1983

2668

self.enabled = True

1984

2669

1985

2670

def add_pipe(self, parent_pipe, proc):

1986

2671

# Call "handle_ipc" for both data and EOF events

1987

gobject.io_add_watch(parent_pipe.fileno(),

1988

gobject.IO_IN | gobject.IO_HUP,

1989

functools.partial(self.handle_ipc,

1990

parent_pipe =

1991

parent_pipe,

1992

proc = proc))

1993

1994

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

1995

proc = None, client_object=None):

1996

condition_names = {

1997

gobject.IO_IN: "IN", # There is data to read.

1998

gobject.IO_OUT: "OUT", # Data can be written (without

1999

# blocking).

2000

gobject.IO_PRI: "PRI", # There is urgent data to read.

2001

gobject.IO_ERR: "ERR", # Error condition.

2002

gobject.IO_HUP: "HUP" # Hung up (the connection has been

2003

# broken, usually for pipes and

2004

# sockets).

2005

}

2006

conditions_string = ' | '.join(name

2007

for cond, name in

2008

condition_names.iteritems()

2009

if cond & condition)

2672

GLib.io_add_watch(

2673

parent_pipe.fileno(),

2674

GLib.IO_IN | GLib.IO_HUP,

2675

functools.partial(self.handle_ipc,

2676

parent_pipe=parent_pipe,

2677

proc=proc))

2678

2679

def handle_ipc(self, source, condition,

2680

parent_pipe=None,

2681

proc=None,

2682

client_object=None):

2010

2683

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

2011

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

2684

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

2012

2685

# Wait for other process to exit

2013

2686

proc.join()

2014

2687

return False

2015

2688

2016

2689

# Read a request from the child

2017

2690

request = parent_pipe.recv()

2018

2691

command = request[0]

2019

2692

2020

2693

if command == 'init':

2021

fpr = request[1]

2022

address = request[2]

2023

2024

for c in self.clients.itervalues():

2025

if c.fingerprint == fpr:

2694

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

2695

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

2696

address = request[3]

2697

2698

for c in self.clients.values():

2699

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2700

continue

2701

if key_id and c.key_id == key_id:

2702

client = c

2703

break

2704

if fpr and c.fingerprint == fpr:

2026

2705

client = c

2027

2706

break

2028

2707

else:

2029

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

2030

"dress: %s", fpr, address)

2708

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

2709

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

2031

2710

if self.use_dbus:

2032

2711

# Emit D-Bus signal

2033

mandos_dbus_service.ClientNotFound(fpr,

2712

mandos_dbus_service.ClientNotFound(key_id or fpr,

2034

2713

address[0])

2035

2714

parent_pipe.send(False)

2036

2715

return False

2037

2038

gobject.io_add_watch(parent_pipe.fileno(),

2039

gobject.IO_IN | gobject.IO_HUP,

2040

functools.partial(self.handle_ipc,

2041

parent_pipe =

2042

parent_pipe,

2043

proc = proc,

2044

client_object =

2045

client))

2716

2717

GLib.io_add_watch(

2718

parent_pipe.fileno(),

2719

GLib.IO_IN | GLib.IO_HUP,

2720

functools.partial(self.handle_ipc,

2721

parent_pipe=parent_pipe,

2722

proc=proc,

2723

client_object=client))

2046

2724

parent_pipe.send(True)

2047

2725

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

2048

2726

# same fileno

2051

2729

funcname = request[1]

2052

2730

args = request[2]

2053

2731

kwargs = request[3]

2054

2732

2055

2733

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

2056

2734

funcname)(*args,

2057

**kwargs)))

2058

2735

**kwargs)))

2736

2059

2737

if command == 'getattr':

2060

2738

attrname = request[1]

2061

if callable(client_object.__getattribute__(attrname)):

2062

parent_pipe.send(('function',))

2739

if isinstance(client_object.__getattribute__(attrname),

2740

collections.Callable):

2741

parent_pipe.send(('function', ))

2063

2742

else:

2064

parent_pipe.send(('data', client_object

2065

.__getattribute__(attrname)))

2066

2743

parent_pipe.send((

2744

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

2745

2067

2746

if command == 'setattr':

2068

2747

attrname = request[1]

2069

2748

value = request[2]

2070

2749

setattr(client_object, attrname, value)

2071

2750

2072

2751

return True

2073

2752

2074

2753

2754

def rfc3339_duration_to_delta(duration):

2755

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

2756

2757

>>> rfc3339_duration_to_delta("P7D")

2758

datetime.timedelta(7)

2759

>>> rfc3339_duration_to_delta("PT60S")

2760

datetime.timedelta(0, 60)

2761

>>> rfc3339_duration_to_delta("PT60M")

2762

datetime.timedelta(0, 3600)

2763

>>> rfc3339_duration_to_delta("PT24H")

2764

datetime.timedelta(1)

2765

>>> rfc3339_duration_to_delta("P1W")

2766

datetime.timedelta(7)

2767

>>> rfc3339_duration_to_delta("PT5M30S")

2768

datetime.timedelta(0, 330)

2769

>>> rfc3339_duration_to_delta("P1DT3M20S")

2770

datetime.timedelta(1, 200)

2771

"""

2772

2773

# Parsing an RFC 3339 duration with regular expressions is not

2774

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

2775

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

2776

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

2777

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

2778

# avoid excessive use of external libraries.

2779

2780

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

2781

Token = collections.namedtuple("Token", (

2782

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

2783

# a "group" containing digits

2784

"value", # datetime.timedelta or None

2785

"followers")) # Tokens valid after this token

2786

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

2787

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

2788

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

2789

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

2790

datetime.timedelta(seconds=1),

2791

frozenset((token_end, )))

2792

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

2793

datetime.timedelta(minutes=1),

2794

frozenset((token_second, token_end)))

2795

token_hour = Token(re.compile(r"(\d+)H"),

2796

datetime.timedelta(hours=1),

2797

frozenset((token_minute, token_end)))

2798

token_time = Token(re.compile(r"T"),

2799

None,

2800

frozenset((token_hour, token_minute,

2801

token_second)))

2802

token_day = Token(re.compile(r"(\d+)D"),

2803

datetime.timedelta(days=1),

2804

frozenset((token_time, token_end)))

2805

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

2806

datetime.timedelta(weeks=4),

2807

frozenset((token_day, token_end)))

2808

token_year = Token(re.compile(r"(\d+)Y"),

2809

datetime.timedelta(weeks=52),

2810

frozenset((token_month, token_end)))

2811

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

2812

datetime.timedelta(weeks=1),

2813

frozenset((token_end, )))

2814

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

2815

frozenset((token_year, token_month,

2816

token_day, token_time,

2817

token_week)))

2818

# Define starting values:

2819

# Value so far

2820

value = datetime.timedelta()

2821

found_token = None

2822

# Following valid tokens

2823

followers = frozenset((token_duration, ))

2824

# String left to parse

2825

s = duration

2826

# Loop until end token is found

2827

while found_token is not token_end:

2828

# Search for any currently valid tokens

2829

for token in followers:

2830

match = token.regexp.match(s)

2831

if match is not None:

2832

# Token found

2833

if token.value is not None:

2834

# Value found, parse digits

2835

factor = int(match.group(1), 10)

2836

# Add to value so far

2837

value += factor * token.value

2838

# Strip token from string

2839

s = token.regexp.sub("", s, 1)

2840

# Go to found token

2841

found_token = token

2842

# Set valid next tokens

2843

followers = found_token.followers

2844

break

2845

else:

2846

# No currently valid tokens were found

2847

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

2848

.format(duration))

2849

# End token found

2850

return value

2851

2852

2075

2853

def string_to_delta(interval):

2076

2854

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

2077

2855

2078

2856

>>> string_to_delta('7d')

2079

2857

datetime.timedelta(7)

2080

2858

>>> string_to_delta('60s')

2088

2866

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

2089

2867

datetime.timedelta(0, 330)

2090

2868

"""

2869

2870

try:

2871

return rfc3339_duration_to_delta(interval)

2872

except ValueError:

2873

pass

2874

2091

2875

timevalue = datetime.timedelta(0)

2092

2876

for s in interval.split():

2093

2877

try:

2094

suffix = unicode(s[-1])

2878

suffix = s[-1]

2095

2879

value = int(s[:-1])

2096

2880

if suffix == "d":

2097

2881

delta = datetime.timedelta(value)

2104

2888

elif suffix == "w":

2105

2889

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

2106

2890

else:

2107

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

2108

.format(suffix))

2109

except (ValueError, IndexError) as e:

2891

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

2892

except IndexError as e:

2110

2893

raise ValueError(*(e.args))

2111

2894

timevalue += delta

2112

2895

return timevalue

2113

2896

2114

2897

2115

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

2898

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

2116

2899

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

2117

2900

2118

2901

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

2119

2902

if os.fork():

2120

2903

sys.exit()

2128

2911

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

2129

2912

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

2130

2913

raise OSError(errno.ENODEV,

2131

"{0} not a character device"

2914

"{} not a character device"

2132

2915

.format(os.devnull))

2133

2916

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

2134

2917

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

2138

2921

2139

2922

2140

2923

def main():

2141

2924

2142

2925

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

2143

2926

# Parsing of options, both command line and config file

2144

2927

2145

2928

parser = argparse.ArgumentParser()

2146

2929

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

2147

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

2930

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

2148

2931

help="show version number and exit")

2149

2932

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

2150

2933

help="Bind to interface IF")

2156

2939

help="Run self-test")

2157

2940

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

2158

2941

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

2159

" to terminal")

2942

" to terminal", default=None)

2160

2943

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

2161

2944

help="Debug level for stdout output")

2162

2945

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

2169

2952

" files")

2170

2953

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

2171

2954

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

2172

" system bus interface")

2955

" system bus interface", default=None)

2173

2956

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

2174

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

2957

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

2958

default=None)

2175

2959

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

2176

2960

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

2177

" state")

2961

" state", default=None)

2962

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

2963

help="Specify a file descriptor to a network"

2964

" socket to use instead of creating one")

2178

2965

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

2179

2966

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

2180

2967

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

2968

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

2969

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

2970

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

2971

default=None)

2972

2181

2973

options = parser.parse_args()

2182

2974

2183

2975

if options.check:

2184

2976

import doctest

2185

doctest.testmod()

2186

sys.exit()

2187

2977

fail_count, test_count = doctest.testmod()

2978

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

2979

2188

2980

# Default values for config file for server-global settings

2189

server_defaults = { "interface": "",

2190

"address": "",

2191

"port": "",

2192

"debug": "False",

2193

"priority":

2194

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

2195

"servicename": "Mandos",

2196

"use_dbus": "True",

2197

"use_ipv6": "True",

2198

"debuglevel": "",

2199

"restore": "True",

2200

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

2201

}

2202

2981

if gnutls.has_rawpk:

2982

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

2983

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

2984

else:

2985

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

2986

":+SIGN-DSA-SHA256")

2987

server_defaults = {"interface": "",

2988

"address": "",

2989

"port": "",

2990

"debug": "False",

2991

"priority": priority,

2992

"servicename": "Mandos",

2993

"use_dbus": "True",

2994

"use_ipv6": "True",

2995

"debuglevel": "",

2996

"restore": "True",

2997

"socket": "",

2998

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

2999

"foreground": "False",

3000

"zeroconf": "True",

3001

}

3002

del priority

3003

2203

3004

# Parse config file for server-global settings

2204

server_config = configparser.SafeConfigParser(server_defaults)

3005

server_config = configparser.ConfigParser(server_defaults)

2205

3006

del server_defaults

2206

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

2207

"mandos.conf"))

2208

# Convert the SafeConfigParser object to a dict

3007

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

3008

# Convert the ConfigParser object to a dict

2209

3009

server_settings = server_config.defaults()

2210

3010

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

2211

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

3011

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

3012

"foreground", "zeroconf"):

2212

3013

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

2213

3014

option)

2214

3015

if server_settings["port"]:

2215

3016

server_settings["port"] = server_config.getint("DEFAULT",

2216

3017

"port")

3018

if server_settings["socket"]:

3019

server_settings["socket"] = server_config.getint("DEFAULT",

3020

"socket")

3021

# Later, stdin will, and stdout and stderr might, be dup'ed

3022

# over with an opened os.devnull. But we don't want this to

3023

# happen with a supplied network socket.

3024

if 0 <= server_settings["socket"] <= 2:

3025

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

3026

["socket"])

2217

3027

del server_config

2218

3028

2219

3029

# Override the settings from the config file with command line

2220

3030

# options, if set.

2221

3031

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

2222

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

2223

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

2224

"statedir"):

3032

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

3033

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

3034

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

2225

3035

value = getattr(options, option)

2226

3036

if value is not None:

2227

3037

server_settings[option] = value

2228

3038

del options

2229

3039

# Force all strings to be unicode

2230

3040

for option in server_settings.keys():

2231

if type(server_settings[option]) is str:

2232

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

3041

if isinstance(server_settings[option], bytes):

3042

server_settings[option] = (server_settings[option]

3043

.decode("utf-8"))

3044

# Force all boolean options to be boolean

3045

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

3046

"foreground", "zeroconf"):

3047

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

3048

# Debug implies foreground

3049

if server_settings["debug"]:

3050

server_settings["foreground"] = True

2233

3051

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

2234

3052

2235

3053

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

2236

3054

3055

if (not server_settings["zeroconf"]

3056

and not (server_settings["port"]

3057

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

3058

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

3059

2237

3060

# For convenience

2238

3061

debug = server_settings["debug"]

2239

3062

debuglevel = server_settings["debuglevel"]

2241

3064

use_ipv6 = server_settings["use_ipv6"]

2242

3065

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

2243

3066

stored_state_file)

2244

3067

foreground = server_settings["foreground"]

3068

zeroconf = server_settings["zeroconf"]

3069

2245

3070

if debug:

2246

3071

initlogger(debug, logging.DEBUG)

2247

3072

else:

2250

3075

else:

2251

3076

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

2252

3077

initlogger(debug, level)

2253

3078

2254

3079

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

2255

syslogger.setFormatter(logging.Formatter

2256

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

2257

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

2258

.format(server_settings

2259

["servicename"])))

2260

3080

syslogger.setFormatter(

3081

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

3082

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

3083

server_settings["servicename"])))

3084

2261

3085

# Parse config file with clients

2262

client_config = configparser.SafeConfigParser(Client

2263

.client_defaults)

3086

client_config = configparser.ConfigParser(Client.client_defaults)

2264

3087

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

2265

3088

"clients.conf"))

2266

3089

2267

3090

global mandos_dbus_service

2268

3091

mandos_dbus_service = None

2269

2270

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

2271

server_settings["port"]),

2272

ClientHandler,

2273

interface=(server_settings["interface"]

2274

or None),

2275

use_ipv6=use_ipv6,

2276

gnutls_priority=

2277

server_settings["priority"],

2278

use_dbus=use_dbus)

2279

if not debug:

2280

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

3092

3093

socketfd = None

3094

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

3095

socketfd = server_settings["socket"]

3096

tcp_server = MandosServer(

3097

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

3098

ClientHandler,

3099

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

3100

use_ipv6=use_ipv6,

3101

gnutls_priority=server_settings["priority"],

3102

use_dbus=use_dbus,

3103

socketfd=socketfd)

3104

if not foreground:

3105

pidfilename = "/run/mandos.pid"

3106

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

3107

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

3108

pidfile = None

2281

3109

try:

2282

pidfile = open(pidfilename, "w")

3110

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

2283

3111

except IOError as e:

2284

3112

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

2285

3113

exc_info=e)

2286

2287

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

3114

3115

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

3116

("mandos", "mandos"),

3117

("nobody", "nogroup")):

2288

3118

try:

2289

3119

uid = pwd.getpwnam(name).pw_uid

2290

gid = pwd.getpwnam(name).pw_gid

3120

gid = pwd.getpwnam(group).pw_gid

2291

3121

break

2292

3122

except KeyError:

2293

3123

continue

2297

3127

try:

2298

3128

os.setgid(gid)

2299

3129

os.setuid(uid)

3130

if debug:

3131

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

3132

gid))

2300

3133

except OSError as error:

2301

if error[0] != errno.EPERM:

2302

raise error

2303

3134

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

3135

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

3136

if error.errno != errno.EPERM:

3137

raise

3138

2304

3139

if debug:

2305

3140

# Enable all possible GnuTLS debugging

2306

3141

2307

3142

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

2308

3143

# - GnuTLS manual

2309

gnutls.library.functions.gnutls_global_set_log_level(11)

2310

2311

@gnutls.library.types.gnutls_log_func

3144

gnutls.global_set_log_level(11)

3145

3146

@gnutls.log_func

2312

3147

def debug_gnutls(level, string):

2313

3148

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

2314

2315

(gnutls.library.functions

2316

.gnutls_global_set_log_function(debug_gnutls))

2317

3149

3150

gnutls.global_set_log_function(debug_gnutls)

3151

2318

3152

# Redirect stdin so all checkers get /dev/null

2319

3153

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

2320

3154

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

2321

3155

if null > 2:

2322

3156

os.close(null)

2323

3157

2324

3158

# Need to fork before connecting to D-Bus

2325

if not debug:

3159

if not foreground:

2326

3160

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

2327

3161

daemon()

2328

2329

gobject.threads_init()

2330

3162

3163

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

3164

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

3165

# need to inform GLib that threads will be used.

3166

GLib.threads_init()

3167

2331

3168

global main_loop

2332

3169

# From the Avahi example code

2333

3170

DBusGMainLoop(set_as_default=True)

2334

main_loop = gobject.MainLoop()

3171

main_loop = GLib.MainLoop()

2335

3172

bus = dbus.SystemBus()

2336

3173

# End of Avahi example code

2337

3174

if use_dbus:

2338

3175

try:

2339

3176

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

2340

bus, do_not_queue=True)

2341

old_bus_name = (dbus.service.BusName

2342

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

2343

do_not_queue=True))

2344

except dbus.exceptions.NameExistsException as e:

3177

bus,

3178

do_not_queue=True)

3179

old_bus_name = dbus.service.BusName(

3180

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

3181

do_not_queue=True)

3182

except dbus.exceptions.DBusException as e:

2345

3183

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

2346

3184

use_dbus = False

2347

3185

server_settings["use_dbus"] = False

2348

3186

tcp_server.use_dbus = False

2349

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2350

service = AvahiServiceToSyslog(name =

2351

server_settings["servicename"],

2352

servicetype = "_mandos._tcp",

2353

protocol = protocol, bus = bus)

2354

if server_settings["interface"]:

2355

service.interface = (if_nametoindex

2356

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

2357

3187

if zeroconf:

3188

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3189

service = AvahiServiceToSyslog(

3190

name=server_settings["servicename"],

3191

servicetype="_mandos._tcp",

3192

protocol=protocol,

3193

bus=bus)

3194

if server_settings["interface"]:

3195

service.interface = if_nametoindex(

3196

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

3197

2358

3198

global multiprocessing_manager

2359

3199

multiprocessing_manager = multiprocessing.Manager()

2360

3200

2361

3201

client_class = Client

2362

3202

if use_dbus:

2363

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

2364

3203

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

3204

2365

3205

client_settings = Client.config_parser(client_config)

2366

3206

old_client_settings = {}

2367

3207

clients_data = {}

2368

3208

3209

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

3210

global wnull

3211

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

3212

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

3213

# mode

3214

if debug or not foreground:

3215

wnull.close()

3216

2369

3217

# Get client data and settings from last running state.

2370

3218

if server_settings["restore"]:

2371

3219

try:

2372

3220

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

2373

clients_data, old_client_settings = (pickle.load

2374

(stored_state))

3221

if sys.version_info.major == 2:

3222

clients_data, old_client_settings = pickle.load(

3223

stored_state)

3224

else:

3225

bytes_clients_data, bytes_old_client_settings = (

3226

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

3227

# Fix bytes to strings

3228

# clients_data

3229

# .keys()

3230

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

3231

if isinstance(key, bytes)

3232

else key): value

3233

for key, value in

3234

bytes_clients_data.items()}

3235

del bytes_clients_data

3236

for key in clients_data:

3237

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

3238

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

3239

for k, v in

3240

clients_data[key].items()}

3241

clients_data[key] = value

3242

# .client_structure

3243

value["client_structure"] = [

3244

(s.decode("utf-8")

3245

if isinstance(s, bytes)

3246

else s) for s in

3247

value["client_structure"]]

3248

# .name & .host

3249

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

3250

if isinstance(value[k], bytes):

3251

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

3252

if "key_id" not in value:

3253

value["key_id"] = ""

3254

elif "fingerprint" not in value:

3255

value["fingerprint"] = ""

3256

# old_client_settings

3257

# .keys()

3258

old_client_settings = {

3259

(key.decode("utf-8")

3260

if isinstance(key, bytes)

3261

else key): value

3262

for key, value in

3263

bytes_old_client_settings.items()}

3264

del bytes_old_client_settings

3265

# .host

3266

for value in old_client_settings.values():

3267

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

3268

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

3269

.decode("utf-8"))

2375

3270

os.remove(stored_state_path)

2376

3271

except IOError as e:

2377

3272

if e.errno == errno.ENOENT:

2378

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

2379

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

3273

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

3274

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

2380

3275

else:

2381

3276

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

2382

3277

exc_info=e)

2383

3278

raise

2384

3279

except EOFError as e:

2385

3280

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

2386

"EOFError:", exc_info=e)

2387

3281

"EOFError:",

3282

exc_info=e)

3283

2388

3284

with PGPEngine() as pgp:

2389

for client_name, client in clients_data.iteritems():

3285

for client_name, client in clients_data.items():

3286

# Skip removed clients

3287

if client_name not in client_settings:

3288

continue

3289

2390

3290

# Decide which value to use after restoring saved state.

2391

3291

# We have three different values: Old config file,

2392

3292

# new config file, and saved state.

2397

3297

# For each value in new config, check if it

2398

3298

# differs from the old config value (Except for

2399

3299

# the "secret" attribute)

2400

if (name != "secret" and

2401

value != old_client_settings[client_name]

2402

[name]):

3300

if (name != "secret"

3301

and (value !=

3302

old_client_settings[client_name][name])):

2403

3303

client[name] = value

2404

3304

except KeyError:

2405

3305

pass

2406

3306

2407

3307

# Clients who has passed its expire date can still be

2408

# enabled if its last checker was successful. Clients

3308

# enabled if its last checker was successful. A Client

2409

3309

# whose checker succeeded before we stored its state is

2410

3310

# assumed to have successfully run all checkers during

2411

3311

# downtime.

2413

3313

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

2414

3314

if not client["last_checked_ok"]:

2415

3315

logger.warning(

2416

"disabling client {0} - Client never "

2417

"performed a successful checker"

2418

.format(client_name))

3316

"disabling client {} - Client never "

3317

"performed a successful checker".format(

3318

client_name))

2419

3319

client["enabled"] = False

2420

3320

elif client["last_checker_status"] != 0:

2421

3321

logger.warning(

2422

"disabling client {0} - Client "

2423

"last checker failed with error code {1}"

2424

.format(client_name,

2425

client["last_checker_status"]))

3322

"disabling client {} - Client last"

3323

" checker failed with error code"

3324

" {}".format(

3325

client_name,

3326

client["last_checker_status"]))

2426

3327

client["enabled"] = False

2427

3328

else:

2428

client["expires"] = (datetime.datetime

2429

.utcnow()

2430

+ client["timeout"])

3329

client["expires"] = (

3330

datetime.datetime.utcnow()

3331

+ client["timeout"])

2431

3332

logger.debug("Last checker succeeded,"

2432

" keeping {0} enabled"

2433

.format(client_name))

3333

" keeping {} enabled".format(

3334

client_name))

2434

3335

try:

2435

client["secret"] = (

2436

pgp.decrypt(client["encrypted_secret"],

2437

client_settings[client_name]

2438

["secret"]))

3336

client["secret"] = pgp.decrypt(

3337

client["encrypted_secret"],

3338

client_settings[client_name]["secret"])

2439

3339

except PGPError:

2440

3340

# If decryption fails, we use secret from new settings

2441

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

2442

.format(client_name))

2443

client["secret"] = (

2444

client_settings[client_name]["secret"])

2445

3341

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

3342

client_name))

3343

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

3344

["secret"])

3345

2446

3346

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

2447

3347

for client_name in (set(old_client_settings)

2448

3348

- set(client_settings)):

2450

3350

for client_name in (set(client_settings)

2451

3351

- set(old_client_settings)):

2452

3352

clients_data[client_name] = client_settings[client_name]

2453

3353

2454

3354

# Create all client objects

2455

for client_name, client in clients_data.iteritems():

3355

for client_name, client in clients_data.items():

2456

3356

tcp_server.clients[client_name] = client_class(

2457

name = client_name, settings = client)

2458

3357

name=client_name,

3358

settings=client,

3359

server_settings=server_settings)

3360

2459

3361

if not tcp_server.clients:

2460

3362

logger.warning("No clients defined")

2461

2462

if not debug:

2463

try:

2464

with pidfile:

2465

pid = os.getpid()

2466

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

2467

del pidfile

2468

except IOError:

2469

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

2470

pidfilename, pid)

2471

except NameError:

2472

# "pidfile" was never created

2473

pass

3363

3364

if not foreground:

3365

if pidfile is not None:

3366

pid = os.getpid()

3367

try:

3368

with pidfile:

3369

print(pid, file=pidfile)

3370

except IOError:

3371

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

3372

pidfilename, pid)

3373

del pidfile

2474

3374

del pidfilename

2475

signal.signal(signal.SIGINT, signal.SIG_IGN)

2476

2477

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

2478

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

2479

3375

3376

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

3377

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3378

lambda: main_loop.quit() and False)

3379

2480

3380

if use_dbus:

2481

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

2482

"se.bsnet.fukt.Mandos"})

2483

class MandosDBusService(DBusObjectWithProperties):

3381

3382

@alternate_dbus_interfaces(

3383

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

3384

class MandosDBusService(DBusObjectWithObjectManager):

2484

3385

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

3386

2485

3387

def __init__(self):

2486

3388

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

3389

2487

3390

_interface = "se.recompile.Mandos"

2488

2489

@dbus_interface_annotations(_interface)

2490

def _foo(self):

2491

return { "org.freedesktop.DBus.Property"

2492

".EmitsChangedSignal":

2493

"false"}

2494

3391

2495

3392

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

2496

3393

def ClientAdded(self, objpath):

2497

3394

"D-Bus signal"

2498

3395

pass

2499

3396

2500

3397

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

2501

def ClientNotFound(self, fingerprint, address):

3398

def ClientNotFound(self, key_id, address):

2502

3399

"D-Bus signal"

2503

3400

pass

2504

3401

3402

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

3403

"true"})

2505

3404

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

2506

3405

def ClientRemoved(self, objpath, name):

2507

3406

"D-Bus signal"

2508

3407

pass

2509

3408

3409

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

3410

"true"})

2510

3411

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

2511

3412

def GetAllClients(self):

2512

3413

"D-Bus method"

2513

return dbus.Array(c.dbus_object_path

2514

for c in

2515

tcp_server.clients.itervalues())

2516

3414

return dbus.Array(c.dbus_object_path for c in

3415

tcp_server.clients.values())

3416

3417

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

3418

"true"})

2517

3419

@dbus.service.method(_interface,

2518

3420

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

2519

3421

def GetAllClientsWithProperties(self):

2520

3422

"D-Bus method"

2521

3423

return dbus.Dictionary(

2522

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

2523

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

3424

{c.dbus_object_path: c.GetAll(

3425

"se.recompile.Mandos.Client")

3426

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

2524

3427

signature="oa{sv}")

2525

3428

2526

3429

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

2527

3430

def RemoveClient(self, object_path):

2528

3431

"D-Bus method"

2529

for c in tcp_server.clients.itervalues():

3432

for c in tcp_server.clients.values():

2530

3433

if c.dbus_object_path == object_path:

2531

3434

del tcp_server.clients[c.name]

2532

3435

c.remove_from_connection()

2533

# Don't signal anything except ClientRemoved

3436

# Don't signal the disabling

2534

3437

c.disable(quiet=True)

2535

# Emit D-Bus signal

2536

self.ClientRemoved(object_path, c.name)

3438

# Emit D-Bus signal for removal

3439

self.client_removed_signal(c)

2537

3440

return

2538

3441

raise KeyError(object_path)

2539

3442

2540

3443

del _interface

2541

3444

3445

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3446

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

3447

def GetManagedObjects(self):

3448

"""D-Bus method"""

3449

return dbus.Dictionary(

3450

{client.dbus_object_path:

3451

dbus.Dictionary(

3452

{interface: client.GetAll(interface)

3453

for interface in

3454

client._get_all_interface_names()})

3455

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

3456

3457

def client_added_signal(self, client):

3458

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

3459

if use_dbus:

3460

# New standard signal

3461

self.InterfacesAdded(

3462

client.dbus_object_path,

3463

dbus.Dictionary(

3464

{interface: client.GetAll(interface)

3465

for interface in

3466

client._get_all_interface_names()}))

3467

# Old signal

3468

self.ClientAdded(client.dbus_object_path)

3469

3470

def client_removed_signal(self, client):

3471

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

3472

if use_dbus:

3473

# New standard signal

3474

self.InterfacesRemoved(

3475

client.dbus_object_path,

3476

client._get_all_interface_names())

3477

# Old signal

3478

self.ClientRemoved(client.dbus_object_path,

3479

client.name)

3480

2542

3481

mandos_dbus_service = MandosDBusService()

2543

3482

3483

# Save modules to variables to exempt the modules from being

3484

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

3485

mp = multiprocessing

3486

wn = wnull

3487

2544

3488

def cleanup():

2545

3489

"Cleanup function; run on exit"

2546

service.cleanup()

2547

2548

multiprocessing.active_children()

3490

if zeroconf:

3491

service.cleanup()

3492

3493

mp.active_children()

3494

wn.close()

2549

3495

if not (tcp_server.clients or client_settings):

2550

3496

return

2551

3497

2552

3498

# Store client before exiting. Secrets are encrypted with key

2553

3499

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

2554

3500

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

2555

3501

clients = {}

2556

3502

with PGPEngine() as pgp:

2557

for client in tcp_server.clients.itervalues():

3503

for client in tcp_server.clients.values():

2558

3504

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

2559

3505

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

2560

3506

key)

2561

3507

client_dict = {}

2562

3508

2563

3509

# A list of attributes that can not be pickled

2564

3510

# + secret.

2565

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

2566

"checker"))

2567

for name, typ in (inspect.getmembers

2568

(dbus.service.Object)):

3511

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

3512

"checker", "server_settings"}

3513

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

3514

.Object):

2569

3515

exclude.add(name)

2570

3516

2571

3517

client_dict["encrypted_secret"] = (client

2572

3518

.encrypted_secret)

2573

3519

for attr in client.client_structure:

2574

3520

if attr not in exclude:

2575

3521

client_dict[attr] = getattr(client, attr)

2576

3522

2577

3523

clients[client.name] = client_dict

2578

3524

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

2579

3525

2580

3526

try:

2581

tempfd, tempname = tempfile.mkstemp(suffix=".pickle",

2582

prefix="clients-",

2583

dir=os.path.dirname

2584

(stored_state_path))

2585

with os.fdopen(tempfd, "wb") as stored_state:

2586

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

3527

with tempfile.NamedTemporaryFile(

3528

mode='wb',

3529

suffix=".pickle",

3530

prefix='clients-',

3531

dir=os.path.dirname(stored_state_path),

3532

delete=False) as stored_state:

3533

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

3534

protocol=2)

3535

tempname = stored_state.name

2587

3536

os.rename(tempname, stored_state_path)

2588

3537

except (IOError, OSError) as e:

2589

3538

if not debug:

2592

3541

except NameError:

2593

3542

pass

2594

3543

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

2595

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

3544

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

2596

3545

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

2597

3546

else:

2598

3547

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

2599

3548

exc_info=e)

2600

raise e

2601

3549

raise

3550

2602

3551

# Delete all clients, and settings from config

2603

3552

while tcp_server.clients:

2604

3553

name, client = tcp_server.clients.popitem()

2605

3554

if use_dbus:

2606

3555

client.remove_from_connection()

2607

# Don't signal anything except ClientRemoved

3556

# Don't signal the disabling

2608

3557

client.disable(quiet=True)

3558

# Emit D-Bus signal for removal

2609

3559

if use_dbus:

2610

# Emit D-Bus signal

2611

mandos_dbus_service.ClientRemoved(client

2612

.dbus_object_path,

2613

client.name)

3560

mandos_dbus_service.client_removed_signal(client)

2614

3561

client_settings.clear()

2615

3562

2616

3563

atexit.register(cleanup)

2617

2618

for client in tcp_server.clients.itervalues():

3564

3565

for client in tcp_server.clients.values():

2619

3566

if use_dbus:

2620

# Emit D-Bus signal

2621

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3567

# Emit D-Bus signal for adding

3568

mandos_dbus_service.client_added_signal(client)

2622

3569

# Need to initiate checking of clients

2623

3570

if client.enabled:

2624

3571

client.init_checker()

2625

3572

2626

3573

tcp_server.enable()

2627

3574

tcp_server.server_activate()

2628

3575

2629

3576

# Find out what port we got

2630

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

3577

if zeroconf:

3578

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

2631

3579

if use_ipv6:

2632

3580

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

2633

3581

" flowinfo %d, scope_id %d",

2635

3583

else: # IPv4

2636

3584

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

2637

3585

*tcp_server.socket.getsockname())

2638

2639

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

2640

3586

3587

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

3588

2641

3589

try:

2642

# From the Avahi example code

2643

try:

2644

service.activate()

2645

except dbus.exceptions.DBusException as error:

2646

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

2647

cleanup()

2648

sys.exit(1)

2649

# End of Avahi example code

2650

2651

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

2652

lambda *args, **kwargs:

2653

(tcp_server.handle_request

2654

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

2655

3590

if zeroconf:

3591

# From the Avahi example code

3592

try:

3593

service.activate()

3594

except dbus.exceptions.DBusException as error:

3595

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

3596

cleanup()

3597

sys.exit(1)

3598

# End of Avahi example code

3599

3600

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

3601

lambda *args, **kwargs:

3602

(tcp_server.handle_request

3603

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

3604

2656

3605

logger.debug("Starting main loop")

2657

3606

main_loop.run()

2658

3607

except AvahiError as error:

2667

3616

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

2668

3617

cleanup()

2669

3618

3619

2670

3620

if __name__ == '__main__':

2671

3621

main()