/mandos/release : revision 237.7.651

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

from gi.repository import GLib

74

84

from dbus.mainloop.glib import DBusGMainLoop

75

85

import ctypes

76

86

import ctypes.util

77

87

import xml.dom.minidom

78

88

import inspect

79

import GnuPGInterface

80

89

90

# Try to find the value of SO_BINDTODEVICE:

81

91

try:

92

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

93

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

82

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

83

95

except AttributeError:

84

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

85

99

from IN import SO_BINDTODEVICE

86

100

except ImportError:

87

SO_BINDTODEVICE = None

88

89

version = "1.5.3"

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.8.4"

90

119

stored_state_file = "clients.pickle"

91

120

92

121

logger = logging.getLogger()

93

syslogger = (logging.handlers.SysLogHandler

94

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

95

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

122

syslogger = None

96

123

97

124

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

101

127

except (OSError, AttributeError):

128

102

129

def if_nametoindex(interface):

103

130

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

104

131

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

105

132

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

106

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

134

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

135

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

111

136

return interface_index

112

137

113

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

114

155

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

115

156

"""init logger and add loglevel"""

116

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

117

162

syslogger.setFormatter(logging.Formatter

118

163

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

119

164

' %(message)s'))

120

165

logger.addHandler(syslogger)

121

166

122

167

if debug:

123

168

console = logging.StreamHandler()

124

169

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

136

181

137

182

class PGPEngine(object):

138

183

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

184

139

185

def __init__(self):

140

self.gnupg = GnuPGInterface.GnuPG()

141

186

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

198

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

200

'--force-mdc',

201

'--quiet']

202

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

203

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

204

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

205

149

206

def __enter__(self):

150

207

return self

151

152

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

208

209

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

153

210

self._cleanup()

154

211

return False

155

212

156

213

def __del__(self):

157

214

self._cleanup()

158

215

159

216

def _cleanup(self):

160

217

if self.tempdir is not None:

161

218

# Delete contents of tempdir

162

219

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

163

topdown = False):

220

topdown=False):

164

221

for filename in files:

165

222

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

166

223

for dirname in dirs:

168

225

# Remove tempdir

169

226

os.rmdir(self.tempdir)

170

227

self.tempdir = None

171

228

172

229

def password_encode(self, password):

173

230

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

174

231

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

175

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

176

232

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

233

if len(encoded) > 2048:

234

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

235

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

236

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

237

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

238

return encoded

239

177

240

def encrypt(self, data, password):

178

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

241

passphrase = self.password_encode(password)

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

244

passfile.write(passphrase)

245

passfile.flush()

246

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

247

'--passphrase-file',

248

passfile.name]

249

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

254

if proc.returncode != 0:

255

raise PGPError(err)

192

256

return ciphertext

193

257

194

258

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

259

passphrase = self.password_encode(password)

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

262

passfile.write(passphrase)

263

passfile.flush()

264

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

265

'--passphrase-file',

266

passfile.name]

267

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

272

if proc.returncode != 0:

273

raise PGPError(err)

209

274

return decrypted_plaintext

210

275

211

276

277

# Pretend that we have an Avahi module

278

class avahi(object):

279

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

280

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

281

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

282

PROTO_INET = 0 # avahi-common/address.h

283

PROTO_INET6 = 1 # avahi-common/address.h

284

DBUS_NAME = "org.freedesktop.Avahi"

285

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

286

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

287

DBUS_PATH_SERVER = "/"

288

289

@staticmethod

290

def string_array_to_txt_array(t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

302

212

303

class AvahiError(Exception):

213

304

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

214

305

self.value = value

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

306

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

307

**kwargs)

308

218

309

219

310

class AvahiServiceError(AvahiError):

220

311

pass

221

312

313

222

314

class AvahiGroupError(AvahiError):

223

315

pass

224

316

225

317

226

318

class AvahiService(object):

227

319

"""An Avahi (Zeroconf) service.

228

320

229

321

Attributes:

230

322

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

231

323

Used to optionally bind to the specified interface.

232

324

name: string; Example: 'Mandos'

233

325

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

234

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

326

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

235

327

port: integer; what port to announce

236

328

TXT: list of strings; TXT record for the service

237

329

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

243

335

server: D-Bus Server

244

336

bus: dbus.SystemBus()

245

337

"""

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

338

339

def __init__(self,

340

interface=avahi.IF_UNSPEC,

341

name=None,

342

servicetype=None,

343

port=None,

344

TXT=None,

345

domain="",

346

host="",

347

max_renames=32768,

348

protocol=avahi.PROTO_UNSPEC,

349

bus=None):

251

350

self.interface = interface

252

351

self.name = name

253

352

self.type = servicetype

262

361

self.server = None

263

362

self.bus = bus

264

363

self.entry_group_state_changed_match = None

265

266

def rename(self):

364

365

def rename(self, remove=True):

267

366

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

268

367

if self.rename_count >= self.max_renames:

269

368

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

270

369

" after %i retries, exiting.",

271

370

self.rename_count)

272

371

raise AvahiServiceError("Too many renames")

273

self.name = unicode(self.server

274

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

275

375

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

276

376

self.name)

277

self.remove()

377

if remove:

378

self.remove()

278

379

try:

279

380

self.add()

280

381

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

382

if (error.get_dbus_name()

383

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

384

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

385

return self.rename(remove=False)

386

else:

387

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

388

self.cleanup()

389

os._exit(1)

390

286

391

def remove(self):

287

392

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

288

393

if self.entry_group_state_changed_match is not None:

290

395

self.entry_group_state_changed_match = None

291

396

if self.group is not None:

292

397

self.group.Reset()

293

398

294

399

def add(self):

295

400

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

296

401

self.remove()

313

418

dbus.UInt16(self.port),

314

419

avahi.string_array_to_txt_array(self.TXT))

315

420

self.group.Commit()

316

421

317

422

def entry_group_state_changed(self, state, error):

318

423

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

319

424

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

320

425

321

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

322

427

logger.debug("Zeroconf service established.")

323

428

elif state == avahi.ENTRY_GROUP_COLLISION:

325

430

self.rename()

326

431

elif state == avahi.ENTRY_GROUP_FAILURE:

327

432

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

328

unicode(error))

329

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

330

.format(error))

331

433

str(error))

434

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

435

332

436

def cleanup(self):

333

437

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

334

438

if self.group is not None:

339

443

pass

340

444

self.group = None

341

445

self.remove()

342

446

343

447

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

344

448

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

345

449

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

450

bad_states = {

451

avahi.SERVER_INVALID: "Zeroconf server invalid",

452

avahi.SERVER_REGISTERING: None,

453

avahi.SERVER_COLLISION: "Zeroconf server name collision",

454

avahi.SERVER_FAILURE: "Zeroconf server failure",

455

}

353

456

if state in bad_states:

354

457

if bad_states[state] is not None:

355

458

if error is None:

358

461

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

359

462

self.cleanup()

360

463

elif state == avahi.SERVER_RUNNING:

361

self.add()

464

try:

465

self.add()

466

except dbus.exceptions.DBusException as error:

467

if (error.get_dbus_name()

468

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

469

logger.info("Local Zeroconf service name"

470

" collision.")

471

return self.rename(remove=False)

472

else:

473

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

474

self.cleanup()

475

os._exit(1)

362

476

else:

363

477

if error is None:

364

478

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

365

479

else:

366

480

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

367

481

368

482

def activate(self):

369

483

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

370

484

if self.server is None:

374

488

follow_name_owner_changes=True),

375

489

avahi.DBUS_INTERFACE_SERVER)

376

490

self.server.connect_to_signal("StateChanged",

377

self.server_state_changed)

491

self.server_state_changed)

378

492

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

379

493

494

380

495

class AvahiServiceToSyslog(AvahiService):

381

def rename(self):

496

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

382

497

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

498

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

499

syslogger.setFormatter(logging.Formatter(

500

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

501

.format(self.name)))

388

502

return ret

389

503

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

504

505

# Pretend that we have a GnuTLS module

506

class gnutls(object):

507

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

508

509

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

510

if library is None:

511

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

512

_library = ctypes.cdll.LoadLibrary(library)

513

del library

514

515

# Unless otherwise indicated, the constants and types below are

516

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

517

518

# Constants

519

E_SUCCESS = 0

520

E_INTERRUPTED = -52

521

E_AGAIN = -28

522

CRT_OPENPGP = 2

523

CRT_RAWPK = 3

524

CLIENT = 2

525

SHUT_RDWR = 0

526

CRD_CERTIFICATE = 1

527

E_NO_CERTIFICATE_FOUND = -49

528

X509_FMT_DER = 0

529

NO_TICKETS = 1<<10

530

ENABLE_RAWPK = 1<<18

531

CTYPE_PEERS = 3

532

KEYID_USE_SHA256 = 1 # gnutls/x509.h

533

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

534

535

# Types

536

class session_int(ctypes.Structure):

537

_fields_ = []

538

session_t = ctypes.POINTER(session_int)

539

540

class certificate_credentials_st(ctypes.Structure):

541

_fields_ = []

542

certificate_credentials_t = ctypes.POINTER(

543

certificate_credentials_st)

544

certificate_type_t = ctypes.c_int

545

546

class datum_t(ctypes.Structure):

547

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

548

('size', ctypes.c_uint)]

549

550

class openpgp_crt_int(ctypes.Structure):

551

_fields_ = []

552

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

553

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

554

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

555

credentials_type_t = ctypes.c_int

556

transport_ptr_t = ctypes.c_void_p

557

close_request_t = ctypes.c_int

558

559

# Exceptions

560

class Error(Exception):

561

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

562

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

563

# code is passed, convert it to a string with

564

# gnutls.strerror()

565

self.code = code

566

if message is None and code is not None:

567

message = gnutls.strerror(code)

568

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

569

message, *args)

570

571

class CertificateSecurityError(Error):

572

pass

573

574

# Classes

575

class Credentials(object):

576

def __init__(self):

577

self._c_object = gnutls.certificate_credentials_t()

578

gnutls.certificate_allocate_credentials(

579

ctypes.byref(self._c_object))

580

self.type = gnutls.CRD_CERTIFICATE

581

582

def __del__(self):

583

gnutls.certificate_free_credentials(self._c_object)

584

585

class ClientSession(object):

586

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

587

self._c_object = gnutls.session_t()

588

gnutls_flags = gnutls.CLIENT

589

if gnutls.check_version("3.5.6"):

590

gnutls_flags |= gnutls.NO_TICKETS

591

if gnutls.has_rawpk:

592

gnutls_flags |= gnutls.ENABLE_RAWPK

593

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

594

del gnutls_flags

595

gnutls.set_default_priority(self._c_object)

596

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

597

gnutls.handshake_set_private_extensions(self._c_object,

598

True)

599

self.socket = socket

600

if credentials is None:

601

credentials = gnutls.Credentials()

602

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

603

ctypes.cast(credentials._c_object,

604

ctypes.c_void_p))

605

self.credentials = credentials

606

607

def __del__(self):

608

gnutls.deinit(self._c_object)

609

610

def handshake(self):

611

return gnutls.handshake(self._c_object)

612

613

def send(self, data):

614

data = bytes(data)

615

data_len = len(data)

616

while data_len > 0:

617

data_len -= gnutls.record_send(self._c_object,

618

data[-data_len:],

619

data_len)

620

621

def bye(self):

622

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

623

624

# Error handling functions

625

def _error_code(result):

626

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

627

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

628

if result >= 0:

629

return result

630

if result == gnutls.E_NO_CERTIFICATE_FOUND:

631

raise gnutls.CertificateSecurityError(code=result)

632

raise gnutls.Error(code=result)

633

634

def _retry_on_error(result, func, arguments):

635

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

636

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

637

while result < 0:

638

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

639

return _error_code(result)

640

result = func(*arguments)

641

return result

642

643

# Unless otherwise indicated, the function declarations below are

644

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

645

646

# Functions

647

priority_set_direct = _library.gnutls_priority_set_direct

648

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

649

ctypes.POINTER(ctypes.c_char_p)]

650

priority_set_direct.restype = _error_code

651

652

init = _library.gnutls_init

653

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

654

init.restype = _error_code

655

656

set_default_priority = _library.gnutls_set_default_priority

657

set_default_priority.argtypes = [session_t]

658

set_default_priority.restype = _error_code

659

660

record_send = _library.gnutls_record_send

661

record_send.argtypes = [session_t, ctypes.c_void_p,

662

ctypes.c_size_t]

663

record_send.restype = ctypes.c_ssize_t

664

record_send.errcheck = _retry_on_error

665

666

certificate_allocate_credentials = (

667

_library.gnutls_certificate_allocate_credentials)

668

certificate_allocate_credentials.argtypes = [

669

ctypes.POINTER(certificate_credentials_t)]

670

certificate_allocate_credentials.restype = _error_code

671

672

certificate_free_credentials = (

673

_library.gnutls_certificate_free_credentials)

674

certificate_free_credentials.argtypes = [

675

certificate_credentials_t]

676

certificate_free_credentials.restype = None

677

678

handshake_set_private_extensions = (

679

_library.gnutls_handshake_set_private_extensions)

680

handshake_set_private_extensions.argtypes = [session_t,

681

ctypes.c_int]

682

handshake_set_private_extensions.restype = None

683

684

credentials_set = _library.gnutls_credentials_set

685

credentials_set.argtypes = [session_t, credentials_type_t,

686

ctypes.c_void_p]

687

credentials_set.restype = _error_code

688

689

strerror = _library.gnutls_strerror

690

strerror.argtypes = [ctypes.c_int]

691

strerror.restype = ctypes.c_char_p

692

693

certificate_type_get = _library.gnutls_certificate_type_get

694

certificate_type_get.argtypes = [session_t]

695

certificate_type_get.restype = _error_code

696

697

certificate_get_peers = _library.gnutls_certificate_get_peers

698

certificate_get_peers.argtypes = [session_t,

699

ctypes.POINTER(ctypes.c_uint)]

700

certificate_get_peers.restype = ctypes.POINTER(datum_t)

701

702

global_set_log_level = _library.gnutls_global_set_log_level

703

global_set_log_level.argtypes = [ctypes.c_int]

704

global_set_log_level.restype = None

705

706

global_set_log_function = _library.gnutls_global_set_log_function

707

global_set_log_function.argtypes = [log_func]

708

global_set_log_function.restype = None

709

710

deinit = _library.gnutls_deinit

711

deinit.argtypes = [session_t]

712

deinit.restype = None

713

714

handshake = _library.gnutls_handshake

715

handshake.argtypes = [session_t]

716

handshake.restype = _error_code

717

handshake.errcheck = _retry_on_error

718

719

transport_set_ptr = _library.gnutls_transport_set_ptr

720

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

721

transport_set_ptr.restype = None

722

723

bye = _library.gnutls_bye

724

bye.argtypes = [session_t, close_request_t]

725

bye.restype = _error_code

726

bye.errcheck = _retry_on_error

727

728

check_version = _library.gnutls_check_version

729

check_version.argtypes = [ctypes.c_char_p]

730

check_version.restype = ctypes.c_char_p

731

732

_need_version = b"3.3.0"

733

if check_version(_need_version) is None:

734

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

735

.format(_need_version))

736

737

_tls_rawpk_version = b"3.6.6"

738

has_rawpk = bool(check_version(_tls_rawpk_version))

739

740

if has_rawpk:

741

# Types

742

class pubkey_st(ctypes.Structure):

743

_fields = []

744

pubkey_t = ctypes.POINTER(pubkey_st)

745

746

x509_crt_fmt_t = ctypes.c_int

747

748

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

749

pubkey_init = _library.gnutls_pubkey_init

750

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

751

pubkey_init.restype = _error_code

752

753

pubkey_import = _library.gnutls_pubkey_import

754

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

755

x509_crt_fmt_t]

756

pubkey_import.restype = _error_code

757

758

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

759

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

760

ctypes.POINTER(ctypes.c_ubyte),

761

ctypes.POINTER(ctypes.c_size_t)]

762

pubkey_get_key_id.restype = _error_code

763

764

pubkey_deinit = _library.gnutls_pubkey_deinit

765

pubkey_deinit.argtypes = [pubkey_t]

766

pubkey_deinit.restype = None

767

else:

768

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

769

770

openpgp_crt_init = _library.gnutls_openpgp_crt_init

771

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

772

openpgp_crt_init.restype = _error_code

773

774

openpgp_crt_import = _library.gnutls_openpgp_crt_import

775

openpgp_crt_import.argtypes = [openpgp_crt_t,

776

ctypes.POINTER(datum_t),

777

openpgp_crt_fmt_t]

778

openpgp_crt_import.restype = _error_code

779

780

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

781

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

782

ctypes.POINTER(ctypes.c_uint)]

783

openpgp_crt_verify_self.restype = _error_code

784

785

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

786

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

787

openpgp_crt_deinit.restype = None

788

789

openpgp_crt_get_fingerprint = (

790

_library.gnutls_openpgp_crt_get_fingerprint)

791

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

792

ctypes.c_void_p,

793

ctypes.POINTER(

794

ctypes.c_size_t)]

795

openpgp_crt_get_fingerprint.restype = _error_code

796

797

if check_version("3.6.4"):

798

certificate_type_get2 = _library.gnutls_certificate_type_get2

799

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

800

certificate_type_get2.restype = _error_code

801

802

# Remove non-public functions

803

del _error_code, _retry_on_error

804

805

806

def call_pipe(connection, # : multiprocessing.Connection

807

func, *args, **kwargs):

808

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

809

810

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

811

return value on the provided multiprocessing.Connection.

812

"""

813

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

814

connection.close()

815

395

816

396

817

class Client(object):

397

818

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

398

819

399

820

Attributes:

400

821

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

401

822

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

403

824

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

404

825

to see if the client lives.

405

826

'None' if no process is running.

406

checker_callback_tag: a gobject event source tag, or None

827

checker_callback_tag: a GLib event source tag, or None

407

828

checker_command: string; External command which is run to check

408

829

if client lives. %() expansions are done at

409

830

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

410

831

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

411

checker_initiator_tag: a gobject event source tag, or None

832

checker_initiator_tag: a GLib event source tag, or None

412

833

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

413

834

client_structure: Object describing what attributes a client has

414

835

and is used for storing the client at exit

415

836

current_checker_command: string; current running checker_command

416

disable_initiator_tag: a gobject event source tag, or None

837

disable_initiator_tag: a GLib event source tag, or None

417

838

enabled: bool()

418

839

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

419

uniquely identify the client

840

uniquely identify an OpenPGP client

841

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

842

a client using raw public keys

420

843

host: string; available for use by the checker command

421

844

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

422

845

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

424

847

last_checker_status: integer between 0 and 255 reflecting exit

425

848

status of last checker. -1 reflects crashed

426

849

checker, -2 means no checker completed yet.

850

last_checker_signal: The signal which killed the last checker, if

851

last_checker_status is -1

427

852

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

428

853

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

429

854

D-Bus identifiers

434

859

runtime_expansions: Allowed attributes for runtime expansion.

435

860

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

436

861

disabled, or None

862

server_settings: The server_settings dict from main()

437

863

"""

438

864

439

865

runtime_expansions = ("approval_delay", "approval_duration",

440

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

441

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

866

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

867

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

868

"last_approval_request", "last_checked_ok",

442

869

"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

870

client_defaults = {

871

"timeout": "PT5M",

872

"extended_timeout": "PT15M",

873

"interval": "PT2M",

874

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

875

"host": "",

876

"approval_delay": "PT0S",

877

"approval_duration": "PT1S",

878

"approved_by_default": "True",

879

"enabled": "True",

880

}

881

469

882

@staticmethod

470

883

def config_parser(config):

471

884

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

478

891

for client_name in config.sections():

479

892

section = dict(config.items(client_name))

480

893

client = settings[client_name] = {}

481

894

482

895

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

483

896

# Reformat values from string types to Python types

484

897

client["approved_by_default"] = config.getboolean(

485

898

client_name, "approved_by_default")

486

899

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

487

900

"enabled")

488

901

902

# Uppercase and remove spaces from key_id and fingerprint

903

# for later comparison purposes with return value from the

904

# key_id() and fingerprint() functions

905

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

906

.replace(" ", ""))

489

907

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

490

908

.replace(" ", ""))

491

909

if "secret" in section:

492

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

910

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

911

.encode("utf-8"),

912

"base64")

493

913

elif "secfile" in section:

494

914

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

495

915

(section["secfile"])),

496

916

"rb") as secfile:

497

917

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

498

918

else:

499

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

919

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

500

920

.format(section))

501

921

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

502

922

client["extended_timeout"] = string_to_delta(

510

930

client["last_approval_request"] = None

511

931

client["last_checked_ok"] = None

512

932

client["last_checker_status"] = -2

513

933

514

934

return settings

515

516

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

935

936

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

517

937

self.name = name

938

if server_settings is None:

939

server_settings = {}

940

self.server_settings = server_settings

518

941

# adding all client settings

519

for setting, value in settings.iteritems():

942

for setting, value in settings.items():

520

943

setattr(self, setting, value)

521

944

522

945

if self.enabled:

523

946

if not hasattr(self, "last_enabled"):

524

947

self.last_enabled = datetime.datetime.utcnow()

528

951

else:

529

952

self.last_enabled = None

530

953

self.expires = None

531

954

532

955

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

956

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

536

957

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

537

958

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

538

959

datetime.datetime.utcnow())

539

960

540

961

# attributes specific for this server instance

541

962

self.checker = None

542

963

self.checker_initiator_tag = None

545

966

self.current_checker_command = None

546

967

self.approved = None

547

968

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

969

self.changedstate = multiprocessing_manager.Condition(

970

multiprocessing_manager.Lock())

971

self.client_structure = [attr

972

for attr in self.__dict__.keys()

553

973

if not attr.startswith("_")]

554

974

self.client_structure.append("client_structure")

555

556

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

557

lambda obj:

558

isinstance(obj,

559

property)):

975

976

for name, t in inspect.getmembers(

977

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

560

978

if not name.startswith("_"):

561

979

self.client_structure.append(name)

562

980

563

981

# Send notice to process children that client state has changed

564

982

def send_changedstate(self):

565

983

with self.changedstate:

566

984

self.changedstate.notify_all()

567

985

568

986

def enable(self):

569

987

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

570

988

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

571

989

# Already enabled

572

990

return

573

self.send_changedstate()

574

991

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

575

992

self.enabled = True

576

993

self.last_enabled = datetime.datetime.utcnow()

577

994

self.init_checker()

578

995

self.send_changedstate()

996

579

997

def disable(self, quiet=True):

580

998

"""Disable this client."""

581

999

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

582

1000

return False

583

1001

if not quiet:

584

self.send_changedstate()

585

if not quiet:

586

1002

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

587

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

588

gobject.source_remove(self.disable_initiator_tag)

1003

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

1004

GLib.source_remove(self.disable_initiator_tag)

589

1005

self.disable_initiator_tag = None

590

1006

self.expires = None

591

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

592

gobject.source_remove(self.checker_initiator_tag)

1007

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

1008

GLib.source_remove(self.checker_initiator_tag)

593

1009

self.checker_initiator_tag = None

594

1010

self.stop_checker()

595

1011

self.enabled = False

596

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

1012

if not quiet:

1013

self.send_changedstate()

1014

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

597

1015

return False

598

1016

599

1017

def __del__(self):

600

1018

self.disable()

601

1019

602

1020

def init_checker(self):

603

1021

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

604

1022

# and every interval from then on.

605

self.checker_initiator_tag = (gobject.timeout_add

606

(self.interval_milliseconds(),

607

self.start_checker))

1023

if self.checker_initiator_tag is not None:

1024

GLib.source_remove(self.checker_initiator_tag)

1025

self.checker_initiator_tag = GLib.timeout_add(

1026

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

1027

self.start_checker)

608

1028

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

609

self.disable_initiator_tag = (gobject.timeout_add

610

(self.timeout_milliseconds(),

611

self.disable))

1029

if self.disable_initiator_tag is not None:

1030

GLib.source_remove(self.disable_initiator_tag)

1031

self.disable_initiator_tag = GLib.timeout_add(

1032

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

612

1033

# Also start a new checker *right now*.

613

1034

self.start_checker()

614

615

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

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

616

1038

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

617

1039

self.checker_callback_tag = None

618

1040

self.checker = None

619

if os.WIFEXITED(condition):

620

self.last_checker_status = os.WEXITSTATUS(condition)

1041

# Read return code from connection (see call_pipe)

1042

returncode = connection.recv()

1043

connection.close()

1044

1045

if returncode >= 0:

1046

self.last_checker_status = returncode

1047

self.last_checker_signal = None

621

1048

if self.last_checker_status == 0:

622

1049

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

623

1050

vars(self))

624

1051

self.checked_ok()

625

1052

else:

626

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

627

vars(self))

1053

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

628

1054

else:

629

1055

self.last_checker_status = -1

1056

self.last_checker_signal = -returncode

630

1057

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

631

1058

vars(self))

632

1059

return False

1060

633

1061

def checked_ok(self):

634

1062

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

635

1063

self.last_checked_ok = datetime.datetime.utcnow()

636

1064

self.last_checker_status = 0

1065

self.last_checker_signal = None

637

1066

self.bump_timeout()

638

1067

639

1068

def bump_timeout(self, timeout=None):

640

1069

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

641

1070

if timeout is None:

642

1071

timeout = self.timeout

643

1072

if self.disable_initiator_tag is not None:

644

gobject.source_remove(self.disable_initiator_tag)

1073

GLib.source_remove(self.disable_initiator_tag)

1074

self.disable_initiator_tag = None

645

1075

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

646

self.disable_initiator_tag = (gobject.timeout_add

647

(timedelta_to_milliseconds

648

(timeout), self.disable))

1076

self.disable_initiator_tag = GLib.timeout_add(

1077

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

649

1078

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

650

1079

651

1080

def need_approval(self):

652

1081

self.last_approval_request = datetime.datetime.utcnow()

653

1082

654

1083

def start_checker(self):

655

1084

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

656

1085

657

1086

If a checker already exists, leave it running and do

658

1087

nothing."""

659

1088

# 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

1089

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

1090

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

1091

# would inevitably timeout, since no checker would get a

1092

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

664

1093

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

665

1094

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

666

1095

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

1096

1097

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

1098

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

1099

self.checker.join()

1100

self.checker = None

681

1101

# Start a new checker if needed

682

1102

if self.checker is None:

1103

# Escape attributes for the shell

1104

escaped_attrs = {

1105

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

1106

for attr in self.runtime_expansions}

683

1107

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

1108

command = self.checker_command % escaped_attrs

1109

except TypeError as error:

1110

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

1111

self.checker_command,

1112

exc_info=error)

1113

return True # Try again later

702

1114

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

1115

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

1116

self.name)

1117

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

1118

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

1119

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

1120

# always replaced by /dev/null.)

1121

# The exception is when not debugging but nevertheless

1122

# running in the foreground; use the previously

1123

# created wnull.

1124

popen_args = {"close_fds": True,

1125

"shell": True,

1126

"cwd": "/"}

1127

if (not self.server_settings["debug"]

1128

and self.server_settings["foreground"]):

1129

popen_args.update({"stdout": wnull,

1130

"stderr": wnull})

1131

pipe = multiprocessing.Pipe(duplex=False)

1132

self.checker = multiprocessing.Process(

1133

target=call_pipe,

1134

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

1135

kwargs=popen_args)

1136

self.checker.start()

1137

self.checker_callback_tag = GLib.io_add_watch(

1138

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

1139

self.checker_callback, pipe[0], command)

1140

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

727

1141

return True

728

1142

729

1143

def stop_checker(self):

730

1144

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

731

1145

if self.checker_callback_tag:

732

gobject.source_remove(self.checker_callback_tag)

1146

GLib.source_remove(self.checker_callback_tag)

733

1147

self.checker_callback_tag = None

734

1148

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

735

1149

return

736

1150

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

1151

self.checker.terminate()

745

1152

self.checker = None

746

1153

747

1154

748

def dbus_service_property(dbus_interface, signature="v",

749

access="readwrite", byte_arrays=False):

1155

def dbus_service_property(dbus_interface,

1156

signature="v",

1157

access="readwrite",

1158

byte_arrays=False):

750

1159

"""Decorators for marking methods of a DBusObjectWithProperties to

751

1160

become properties on the D-Bus.

752

1161

753

1162

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

754

1163

and with one argument by "Set".

755

1164

756

1165

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

757

1166

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

758

1167

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

761

1170

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

762

1171

if byte_arrays and signature != "ay":

763

1172

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

764

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

1173

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

1174

765

1175

def decorator(func):

766

1176

func._dbus_is_property = True

767

1177

func._dbus_interface = dbus_interface

770

1180

func._dbus_name = func.__name__

771

1181

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

772

1182

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

773

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1183

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

774

1184

return func

1185

775

1186

return decorator

776

1187

777

1188

778

1189

def dbus_interface_annotations(dbus_interface):

779

1190

"""Decorator for marking functions returning interface annotations

780

1191

781

1192

Usage:

782

1193

783

1194

@dbus_interface_annotations("org.example.Interface")

784

1195

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

785

1196

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

786

1197

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

787

1198

"false"}

788

1199

"""

1200

789

1201

def decorator(func):

790

1202

func._dbus_is_interface = True

791

1203

func._dbus_interface = dbus_interface

792

1204

func._dbus_name = dbus_interface

793

1205

return func

1206

794

1207

return decorator

795

1208

796

1209

797

1210

def dbus_annotations(annotations):

798

1211

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

799

1212

Usage:

800

1213

1214

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

1215

"org.freedesktop.DBus.Property."

1216

"EmitsChangedSignal": "false"})

801

1217

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

802

1218

access="r")

803

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

804

"org.freedesktop.DBus.Property."

805

"EmitsChangedSignal": "false"})

806

1219

def Property_dbus_property(self):

807

1220

return dbus.Boolean(False)

1221

1222

See also the DBusObjectWithAnnotations class.

808

1223

"""

1224

809

1225

def decorator(func):

810

1226

func._dbus_annotations = annotations

811

1227

return func

1228

812

1229

return decorator

813

1230

814

1231

815

1232

class DBusPropertyException(dbus.exceptions.DBusException):

816

1233

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

817

1234

"""

818

def __unicode__(self):

819

return unicode(str(self))

1235

pass

820

1236

821

1237

822

1238

class DBusPropertyAccessException(DBusPropertyException):

831

1247

pass

832

1248

833

1249

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.

1250

class DBusObjectWithAnnotations(dbus.service.Object):

1251

"""A D-Bus object with annotations.

1252

1253

Classes inheriting from this can use the dbus_annotations

1254

decorator to add annotations to methods or signals.

840

1255

"""

841

1256

842

1257

@staticmethod

843

1258

def _is_dbus_thing(thing):

844

1259

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

845

1260

846

1261

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

847

1262

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

848

1263

"""

849

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

1264

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

850

1265

False)

851

1266

852

1267

def _get_all_dbus_things(self, thing):

853

1268

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

854

1269

"""

855

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

856

name),

1270

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

857

1271

athing.__get__(self))

858

1272

for cls in self.__class__.__mro__

859

1273

for name, athing in

860

inspect.getmembers(cls,

861

self._is_dbus_thing(thing)))

862

1274

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

1275

1276

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1277

out_signature="s",

1278

path_keyword='object_path',

1279

connection_keyword='connection')

1280

def Introspect(self, object_path, connection):

1281

"""Overloading of standard D-Bus method.

1282

1283

Inserts annotation tags on methods and signals.

1284

"""

1285

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

1286

connection)

1287

try:

1288

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

1289

1290

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

1291

# Add annotation tags

1292

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

1293

for tag in if_tag.getElementsByTagName(typ):

1294

annots = dict()

1295

for name, prop in (self.

1296

_get_all_dbus_things(typ)):

1297

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

1298

and prop._dbus_interface

1299

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

1300

annots.update(getattr(

1301

prop, "_dbus_annotations", {}))

1302

for name, value in annots.items():

1303

ann_tag = document.createElement(

1304

"annotation")

1305

ann_tag.setAttribute("name", name)

1306

ann_tag.setAttribute("value", value)

1307

tag.appendChild(ann_tag)

1308

# Add interface annotation tags

1309

for annotation, value in dict(

1310

itertools.chain.from_iterable(

1311

annotations().items()

1312

for name, annotations

1313

in self._get_all_dbus_things("interface")

1314

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

1315

)).items():

1316

ann_tag = document.createElement("annotation")

1317

ann_tag.setAttribute("name", annotation)

1318

ann_tag.setAttribute("value", value)

1319

if_tag.appendChild(ann_tag)

1320

# Fix argument name for the Introspect method itself

1321

if (if_tag.getAttribute("name")

1322

== dbus.INTROSPECTABLE_IFACE):

1323

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

1324

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

1325

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

1326

if (arg.getAttribute("direction")

1327

== "out"):

1328

arg.setAttribute("name",

1329

"xml_data")

1330

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

1331

document.unlink()

1332

except (AttributeError, xml.dom.DOMException,

1333

xml.parsers.expat.ExpatError) as error:

1334

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

1335

exc_info=error)

1336

return xmlstring

1337

1338

1339

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1340

"""A D-Bus object with properties.

1341

1342

Classes inheriting from this can use the dbus_service_property

1343

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

1344

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

1345

"""

1346

863

1347

def _get_dbus_property(self, interface_name, property_name):

864

1348

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

865

1349

property with the specified name and interface.

866

1350

"""

867

for cls in self.__class__.__mro__:

868

for name, value in (inspect.getmembers

869

(cls,

870

self._is_dbus_thing("property"))):

1351

for cls in self.__class__.__mro__:

1352

for name, value in inspect.getmembers(

1353

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

871

1354

if (value._dbus_name == property_name

872

1355

and value._dbus_interface == interface_name):

873

1356

return value.__get__(self)

874

1357

875

1358

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

1359

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

1360

self.dbus_object_path, interface_name, property_name))

1361

1362

@classmethod

1363

def _get_all_interface_names(cls):

1364

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

1365

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

1366

"_dbus_interface", None)

1367

for x in (inspect.getmro(cls))

1368

for attr in dir(x))

1369

if name is not None)

1370

1371

@dbus.service.method(dbus.PROPERTIES_IFACE,

1372

in_signature="ss",

881

1373

out_signature="v")

882

1374

def Get(self, interface_name, property_name):

883

1375

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

889

1381

if not hasattr(value, "variant_level"):

890

1382

return value

891

1383

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

892

1384

893

1385

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

894

1386

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

895

1387

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

901

1393

# The byte_arrays option is not supported yet on

902

1394

# signatures other than "ay".

903

1395

if prop._dbus_signature != "ay":

904

raise ValueError

1396

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

1397

"'ay' signature {!r}"

1398

.format(prop._dbus_signature))

905

1399

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

906

1400

for byte in value))

907

1401

prop(value)

908

909

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

1402

1403

@dbus.service.method(dbus.PROPERTIES_IFACE,

1404

in_signature="s",

910

1405

out_signature="a{sv}")

911

1406

def GetAll(self, interface_name):

912

1407

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

913

1408

standard.

914

1409

915

1410

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

916

1411

"""

917

1412

properties = {}

927

1422

if not hasattr(value, "variant_level"):

928

1423

properties[name] = value

929

1424

continue

930

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

931

value.variant_level+1)

1425

properties[name] = type(value)(

1426

value, variant_level=value.variant_level + 1)

932

1427

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

933

1428

1429

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

1430

def PropertiesChanged(self, interface_name, changed_properties,

1431

invalidated_properties):

1432

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

1433

standard.

1434

"""

1435

pass

1436

934

1437

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

935

1438

out_signature="s",

936

1439

path_keyword='object_path',

937

1440

connection_keyword='connection')

938

1441

def Introspect(self, object_path, connection):

939

1442

"""Overloading of standard D-Bus method.

940

1443

941

1444

Inserts property tags and interface annotation tags.

942

1445

"""

943

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

944

connection)

1446

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1447

object_path,

1448

connection)

945

1449

try:

946

1450

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

1451

947

1452

def make_tag(document, name, prop):

948

1453

e = document.createElement("property")

949

1454

e.setAttribute("name", name)

950

1455

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

951

1456

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

952

1457

return e

1458

953

1459

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

954

1460

# Add property tags

955

1461

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

958

1464

if prop._dbus_interface

959

1465

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

960

1466

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)

1467

# Add annotation tags for properties

1468

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

1469

annots = dict()

1470

for name, prop in self._get_all_dbus_things(

1471

"property"):

1472

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

1473

and prop._dbus_interface

1474

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

1475

annots.update(getattr(

1476

prop, "_dbus_annotations", {}))

1477

for name, value in annots.items():

1478

ann_tag = document.createElement(

1479

"annotation")

1480

ann_tag.setAttribute("name", name)

1481

ann_tag.setAttribute("value", value)

1482

tag.appendChild(ann_tag)

992

1483

# Add the names to the return values for the

993

1484

# "org.freedesktop.DBus.Properties" methods

994

1485

if (if_tag.getAttribute("name")

1013

1504

return xmlstring

1014

1505

1015

1506

1016

def datetime_to_dbus (dt, variant_level=0):

1507

try:

1508

dbus.OBJECT_MANAGER_IFACE

1509

except AttributeError:

1510

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

1511

1512

1513

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1514

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

1515

1516

Classes inheriting from this exposes the standard

1517

GetManagedObjects call and the InterfacesAdded and

1518

InterfacesRemoved signals on the standard

1519

"org.freedesktop.DBus.ObjectManager" interface.

1520

1521

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

1522

manually.

1523

"""

1524

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1525

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

1526

def GetManagedObjects(self):

1527

"""This function must be overridden"""

1528

raise NotImplementedError()

1529

1530

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1531

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

1532

def InterfacesAdded(self, object_path, interfaces_and_properties):

1533

pass

1534

1535

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

1536

def InterfacesRemoved(self, object_path, interfaces):

1537

pass

1538

1539

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1540

out_signature="s",

1541

path_keyword='object_path',

1542

connection_keyword='connection')

1543

def Introspect(self, object_path, connection):

1544

"""Overloading of standard D-Bus method.

1545

1546

Override return argument name of GetManagedObjects to be

1547

"objpath_interfaces_and_properties"

1548

"""

1549

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1550

object_path,

1551

connection)

1552

try:

1553

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

1554

1555

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

1556

# Fix argument name for the GetManagedObjects method

1557

if (if_tag.getAttribute("name")

1558

== dbus.OBJECT_MANAGER_IFACE):

1559

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

1560

if (cn.getAttribute("name")

1561

== "GetManagedObjects"):

1562

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

1563

if (arg.getAttribute("direction")

1564

== "out"):

1565

arg.setAttribute(

1566

"name",

1567

"objpath_interfaces"

1568

"_and_properties")

1569

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

1570

document.unlink()

1571

except (AttributeError, xml.dom.DOMException,

1572

xml.parsers.expat.ExpatError) as error:

1573

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

1574

exc_info=error)

1575

return xmlstring

1576

1577

1578

def datetime_to_dbus(dt, variant_level=0):

1017

1579

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

1018

1580

if dt is None:

1019

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

1020

return dbus.String(dt.isoformat(),

1021

variant_level=variant_level)

1022

1023

1024

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

1025

.__metaclass__):

1026

"""Applied to an empty subclass of a D-Bus object, this metaclass

1027

will add additional D-Bus attributes matching a certain pattern.

1581

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

1582

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

1583

1584

1585

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1586

"""A class decorator; applied to a subclass of

1587

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

1588

interface names according to the "alt_interface_names" mapping.

1589

Usage:

1590

1591

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

1592

"net.example.AlternateInterface"})

1593

class SampleDBusObject(dbus.service.Object):

1594

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

1595

def SampleDBusMethod():

1596

pass

1597

1598

The above "SampleDBusMethod" on "SampleDBusObject" will be

1599

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

1600

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

1601

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

1602

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

1603

1604

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

1605

(from DBusObjectWithProperties) and interfaces (from the

1606

dbus_interface_annotations decorator).

1028

1607

"""

1029

def __new__(mcs, name, bases, attr):

1030

# Go through all the base classes which could have D-Bus

1031

# methods, signals, or properties in them

1032

old_interface_names = []

1033

for base in (b for b in bases

1034

if issubclass(b, dbus.service.Object)):

1035

# Go though all attributes of the base class

1036

for attrname, attribute in inspect.getmembers(base):

1608

1609

def wrapper(cls):

1610

for orig_interface_name, alt_interface_name in (

1611

alt_interface_names.items()):

1612

attr = {}

1613

interface_names = set()

1614

# Go though all attributes of the class

1615

for attrname, attribute in inspect.getmembers(cls):

1037

1616

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

1038

1617

# with the wrong interface name

1039

1618

if (not hasattr(attribute, "_dbus_interface")

1040

or not attribute._dbus_interface

1041

.startswith("se.recompile.Mandos")):

1619

or not attribute._dbus_interface.startswith(

1620

orig_interface_name)):

1042

1621

continue

1043

1622

# Create an alternate D-Bus interface name based on

1044

1623

# the current name

1045

alt_interface = (attribute._dbus_interface

1046

.replace("se.recompile.Mandos",

1047

"se.bsnet.fukt.Mandos"))

1048

if alt_interface != attribute._dbus_interface:

1049

old_interface_names.append(alt_interface)

1624

alt_interface = attribute._dbus_interface.replace(

1625

orig_interface_name, alt_interface_name)

1626

interface_names.add(alt_interface)

1050

1627

# Is this a D-Bus signal?

1051

1628

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

1052

# Extract the original non-method function by

1053

# black magic

1054

nonmethod_func = (dict(

1629

# Extract the original non-method undecorated

1630

# function by black magic

1631

if sys.version_info.major == 2:

1632

nonmethod_func = (dict(

1055

1633

zip(attribute.func_code.co_freevars,

1056

attribute.__closure__))["func"]

1057

.cell_contents)

1634

attribute.__closure__))

1635

["func"].cell_contents)

1636

else:

1637

nonmethod_func = (dict(

1638

zip(attribute.__code__.co_freevars,

1639

attribute.__closure__))

1640

["func"].cell_contents)

1058

1641

# Create a new, but exactly alike, function

1059

1642

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

1060

1643

# with the alternate D-Bus interface name

1061

new_function = (dbus.service.signal

1062

(alt_interface,

1063

attribute._dbus_signature)

1064

(types.FunctionType(

1065

nonmethod_func.func_code,

1066

nonmethod_func.func_globals,

1067

nonmethod_func.func_name,

1068

nonmethod_func.func_defaults,

1069

nonmethod_func.func_closure)))

1644

new_function = copy_function(nonmethod_func)

1645

new_function = (dbus.service.signal(

1646

alt_interface,

1647

attribute._dbus_signature)(new_function))

1070

1648

# Copy annotations, if any

1071

1649

try:

1072

new_function._dbus_annotations = (

1073

dict(attribute._dbus_annotations))

1650

new_function._dbus_annotations = dict(

1651

attribute._dbus_annotations)

1074

1652

except AttributeError:

1075

1653

pass

1654

1076

1655

# Define a creator of a function to call both the

1077

# old and new functions, so both the old and new

1078

# signals gets sent when the function is called

1656

# original and alternate functions, so both the

1657

# original and alternate signals gets sent when

1658

# the function is called

1079

1659

def fixscope(func1, func2):

1080

1660

"""This function is a scope container to pass

1081

1661

func1 and func2 to the "call_both" function

1082

1662

outside of its arguments"""

1663

1664

@functools.wraps(func2)

1083

1665

def call_both(*args, **kwargs):

1084

1666

"""This function will emit two D-Bus

1085

1667

signals by calling func1 and func2"""

1086

1668

func1(*args, **kwargs)

1087

1669

func2(*args, **kwargs)

1670

# Make wrapper function look like a D-Bus

1671

# signal

1672

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

1673

if name.startswith("_dbus_"):

1674

setattr(call_both, name, attr)

1675

1088

1676

return call_both

1089

1677

# Create the "call_both" function and add it to

1090

1678

# the class

1091

attr[attrname] = fixscope(attribute,

1092

new_function)

1679

attr[attrname] = fixscope(attribute, new_function)

1093

1680

# Is this a D-Bus method?

1094

1681

elif getattr(attribute, "_dbus_is_method", False):

1095

1682

# Create a new, but exactly alike, function

1096

1683

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

1097

1684

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

1098

1685

# to the class.

1099

attr[attrname] = (dbus.service.method

1100

(alt_interface,

1101

attribute._dbus_in_signature,

1102

attribute._dbus_out_signature)

1103

(types.FunctionType

1104

(attribute.func_code,

1105

attribute.func_globals,

1106

attribute.func_name,

1107

attribute.func_defaults,

1108

attribute.func_closure)))

1686

attr[attrname] = (

1687

dbus.service.method(

1688

alt_interface,

1689

attribute._dbus_in_signature,

1690

attribute._dbus_out_signature)

1691

(copy_function(attribute)))

1109

1692

# Copy annotations, if any

1110

1693

try:

1111

attr[attrname]._dbus_annotations = (

1112

dict(attribute._dbus_annotations))

1694

attr[attrname]._dbus_annotations = dict(

1695

attribute._dbus_annotations)

1113

1696

except AttributeError:

1114

1697

pass

1115

1698

# Is this a D-Bus property?

1118

1701

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

1119

1702

# property with the alternate D-Bus interface

1120

1703

# name. Add it to the class.

1121

attr[attrname] = (dbus_service_property

1122

(alt_interface,

1123

attribute._dbus_signature,

1124

attribute._dbus_access,

1125

attribute

1126

._dbus_get_args_options

1127

["byte_arrays"])

1128

(types.FunctionType

1129

(attribute.func_code,

1130

attribute.func_globals,

1131

attribute.func_name,

1132

attribute.func_defaults,

1133

attribute.func_closure)))

1704

attr[attrname] = (dbus_service_property(

1705

alt_interface, attribute._dbus_signature,

1706

attribute._dbus_access,

1707

attribute._dbus_get_args_options

1708

["byte_arrays"])

1709

(copy_function(attribute)))

1134

1710

# Copy annotations, if any

1135

1711

try:

1136

attr[attrname]._dbus_annotations = (

1137

dict(attribute._dbus_annotations))

1712

attr[attrname]._dbus_annotations = dict(

1713

attribute._dbus_annotations)

1138

1714

except AttributeError:

1139

1715

pass

1140

1716

# Is this a D-Bus interface?

1143

1719

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

1144

1720

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

1145

1721

# to the class.

1146

attr[attrname] = (dbus_interface_annotations

1147

(alt_interface)

1148

(types.FunctionType

1149

(attribute.func_code,

1150

attribute.func_globals,

1151

attribute.func_name,

1152

attribute.func_defaults,

1153

attribute.func_closure)))

1154

# Deprecate all old interfaces

1155

iname="_AlternateDBusNamesMetaclass_interface_annotation{0}"

1156

for old_interface_name in old_interface_names:

1157

@dbus_interface_annotations(old_interface_name)

1158

def func(self):

1159

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

1160

# Find an unused name

1161

for aname in (iname.format(i) for i in itertools.count()):

1162

if aname not in attr:

1163

attr[aname] = func

1164

break

1165

return type.__new__(mcs, name, bases, attr)

1166

1167

1722

attr[attrname] = (

1723

dbus_interface_annotations(alt_interface)

1724

(copy_function(attribute)))

1725

if deprecate:

1726

# Deprecate all alternate interfaces

1727

iname = "_AlternateDBusNames_interface_annotation{}"

1728

for interface_name in interface_names:

1729

1730

@dbus_interface_annotations(interface_name)

1731

def func(self):

1732

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

1733

"true"}

1734

# Find an unused name

1735

for aname in (iname.format(i)

1736

for i in itertools.count()):

1737

if aname not in attr:

1738

attr[aname] = func

1739

break

1740

if interface_names:

1741

# Replace the class with a new subclass of it with

1742

# methods, signals, etc. as created above.

1743

if sys.version_info.major == 2:

1744

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

1745

(cls, ), attr)

1746

else:

1747

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

1748

(cls, ), attr)

1749

return cls

1750

1751

return wrapper

1752

1753

1754

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

1755

"se.bsnet.fukt.Mandos"})

1168

1756

class ClientDBus(Client, DBusObjectWithProperties):

1169

1757

"""A Client class using D-Bus

1170

1758

1171

1759

Attributes:

1172

1760

dbus_object_path: dbus.ObjectPath

1173

1761

bus: dbus.SystemBus()

1174

1762

"""

1175

1763

1176

1764

runtime_expansions = (Client.runtime_expansions

1177

+ ("dbus_object_path",))

1178

1765

+ ("dbus_object_path", ))

1766

1767

_interface = "se.recompile.Mandos.Client"

1768

1179

1769

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

1180

1181

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

1770

1771

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

1182

1772

self.bus = bus

1183

1773

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

1184

1774

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

1185

1775

# the D-Bus

1186

client_object_name = unicode(self.name).translate(

1776

client_object_name = str(self.name).translate(

1187

1777

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

1188

1778

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

1189

self.dbus_object_path = (dbus.ObjectPath

1190

("/clients/" + client_object_name))

1779

self.dbus_object_path = dbus.ObjectPath(

1780

"/clients/" + client_object_name)

1191

1781

DBusObjectWithProperties.__init__(self, self.bus,

1192

1782

self.dbus_object_path)

1193

1194

def notifychangeproperty(transform_func,

1195

dbus_name, type_func=lambda x: x,

1196

variant_level=1):

1783

1784

def notifychangeproperty(transform_func, dbus_name,

1785

type_func=lambda x: x,

1786

variant_level=1,

1787

invalidate_only=False,

1788

_interface=_interface):

1197

1789

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

1198

1790

its changes to DBus.

1199

1791

1200

1792

transform_fun: Function that takes a value and a variant_level

1201

1793

and transforms it to a D-Bus type.

1202

1794

dbus_name: D-Bus name of the variable

1204

1796

to the D-Bus. Default: no transform

1205

1797

variant_level: D-Bus variant level. Default: 1

1206

1798

"""

1207

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

1799

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

1800

1208

1801

def setter(self, value):

1209

1802

if hasattr(self, "dbus_object_path"):

1210

1803

if (not hasattr(self, attrname) or

1211

1804

type_func(getattr(self, attrname, None))

1212

1805

!= type_func(value)):

1213

dbus_value = transform_func(type_func(value),

1214

variant_level

1215

=variant_level)

1216

self.PropertyChanged(dbus.String(dbus_name),

1217

dbus_value)

1806

if invalidate_only:

1807

self.PropertiesChanged(

1808

_interface, dbus.Dictionary(),

1809

dbus.Array((dbus_name, )))

1810

else:

1811

dbus_value = transform_func(

1812

type_func(value),

1813

variant_level=variant_level)

1814

self.PropertyChanged(dbus.String(dbus_name),

1815

dbus_value)

1816

self.PropertiesChanged(

1817

_interface,

1818

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

1819

dbus_value}),

1820

dbus.Array())

1218

1821

setattr(self, attrname, value)

1219

1822

1220

1823

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

1221

1824

1222

1825

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1223

1826

approvals_pending = notifychangeproperty(dbus.Boolean,

1224

1827

"ApprovalPending",

1225

type_func = bool)

1828

type_func=bool)

1226

1829

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

1227

1830

last_enabled = notifychangeproperty(datetime_to_dbus,

1228

1831

"LastEnabled")

1229

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

1230

type_func = lambda checker:

1231

checker is not None)

1832

checker = notifychangeproperty(

1833

dbus.Boolean, "CheckerRunning",

1834

type_func=lambda checker: checker is not None)

1232

1835

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1233

1836

"LastCheckedOK")

1234

1837

last_checker_status = notifychangeproperty(dbus.Int16,

1237

1840

datetime_to_dbus, "LastApprovalRequest")

1238

1841

approved_by_default = notifychangeproperty(dbus.Boolean,

1239

1842

"ApprovedByDefault")

1240

approval_delay = notifychangeproperty(dbus.UInt64,

1241

"ApprovalDelay",

1242

type_func =

1243

timedelta_to_milliseconds)

1843

approval_delay = notifychangeproperty(

1844

dbus.UInt64, "ApprovalDelay",

1845

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

1244

1846

approval_duration = notifychangeproperty(

1245

1847

dbus.UInt64, "ApprovalDuration",

1246

type_func = timedelta_to_milliseconds)

1848

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

1247

1849

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

1248

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

1249

type_func =

1250

timedelta_to_milliseconds)

1850

timeout = notifychangeproperty(

1851

dbus.UInt64, "Timeout",

1852

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

1251

1853

extended_timeout = notifychangeproperty(

1252

1854

dbus.UInt64, "ExtendedTimeout",

1253

type_func = timedelta_to_milliseconds)

1254

interval = notifychangeproperty(dbus.UInt64,

1255

"Interval",

1256

type_func =

1257

timedelta_to_milliseconds)

1855

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

1856

interval = notifychangeproperty(

1857

dbus.UInt64, "Interval",

1858

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

1258

1859

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

1259

1860

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

1861

invalidate_only=True)

1862

1260

1863

del notifychangeproperty

1261

1864

1262

1865

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

1263

1866

try:

1264

1867

self.remove_from_connection()

1267

1870

if hasattr(DBusObjectWithProperties, "__del__"):

1268

1871

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

1269

1872

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

1270

1271

def checker_callback(self, pid, condition, command,

1272

*args, **kwargs):

1273

self.checker_callback_tag = None

1274

self.checker = None

1275

if os.WIFEXITED(condition):

1276

exitstatus = os.WEXITSTATUS(condition)

1873

1874

def checker_callback(self, source, condition,

1875

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

1876

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

1877

connection, command, *args,

1878

**kwargs)

1879

exitstatus = self.last_checker_status

1880

if exitstatus >= 0:

1277

1881

# Emit D-Bus signal

1278

1882

self.CheckerCompleted(dbus.Int16(exitstatus),

1279

dbus.Int64(condition),

1883

# This is specific to GNU libC

1884

dbus.Int64(exitstatus << 8),

1280

1885

dbus.String(command))

1281

1886

else:

1282

1887

# Emit D-Bus signal

1283

1888

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

1284

dbus.Int64(condition),

1889

dbus.Int64(

1890

# This is specific to GNU libC

1891

(exitstatus << 8)

1892

| self.last_checker_signal),

1285

1893

dbus.String(command))

1286

1287

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

1288

*args, **kwargs)

1289

1894

return ret

1895

1290

1896

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

1291

old_checker = self.checker

1292

if self.checker is not None:

1293

old_checker_pid = self.checker.pid

1294

else:

1295

old_checker_pid = None

1897

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

1296

1898

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

1297

1899

# Only if new checker process was started

1298

1900

if (self.checker is not None

1300

1902

# Emit D-Bus signal

1301

1903

self.CheckerStarted(self.current_checker_command)

1302

1904

return r

1303

1905

1304

1906

def _reset_approved(self):

1305

1907

self.approved = None

1306

1908

return False

1307

1909

1308

1910

def approve(self, value=True):

1309

self.send_changedstate()

1310

1911

self.approved = value

1311

gobject.timeout_add(timedelta_to_milliseconds

1312

(self.approval_duration),

1313

self._reset_approved)

1314

1315

## D-Bus methods, signals & properties

1316

_interface = "se.recompile.Mandos.Client"

1317

1318

## Interfaces

1319

1320

@dbus_interface_annotations(_interface)

1321

def _foo(self):

1322

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

1323

"false"}

1324

1325

## Signals

1326

1912

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

1913

* 1000), self._reset_approved)

1914

self.send_changedstate()

1915

1916

# D-Bus methods, signals & properties

1917

1918

# Interfaces

1919

1920

# Signals

1921

1327

1922

# CheckerCompleted - signal

1328

1923

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

1329

1924

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

1330

1925

"D-Bus signal"

1331

1926

pass

1332

1927

1333

1928

# CheckerStarted - signal

1334

1929

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

1335

1930

def CheckerStarted(self, command):

1336

1931

"D-Bus signal"

1337

1932

pass

1338

1933

1339

1934

# PropertyChanged - signal

1935

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

1340

1936

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

1341

1937

def PropertyChanged(self, property, value):

1342

1938

"D-Bus signal"

1343

1939

pass

1344

1940

1345

1941

# GotSecret - signal

1346

1942

@dbus.service.signal(_interface)

1347

1943

def GotSecret(self):

1350

1946

server to mandos-client

1351

1947

"""

1352

1948

pass

1353

1949

1354

1950

# Rejected - signal

1355

1951

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

1356

1952

def Rejected(self, reason):

1357

1953

"D-Bus signal"

1358

1954

pass

1359

1955

1360

1956

# NeedApproval - signal

1361

1957

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

1362

1958

def NeedApproval(self, timeout, default):

1363

1959

"D-Bus signal"

1364

1960

return self.need_approval()

1365

1366

## Methods

1367

1961

1962

# Methods

1963

1368

1964

# Approve - method

1369

1965

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

1370

1966

def Approve(self, value):

1371

1967

self.approve(value)

1372

1968

1373

1969

# CheckedOK - method

1374

1970

@dbus.service.method(_interface)

1375

1971

def CheckedOK(self):

1376

1972

self.checked_ok()

1377

1973

1378

1974

# Enable - method

1975

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

1379

1976

@dbus.service.method(_interface)

1380

1977

def Enable(self):

1381

1978

"D-Bus method"

1382

1979

self.enable()

1383

1980

1384

1981

# StartChecker - method

1982

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

1385

1983

@dbus.service.method(_interface)

1386

1984

def StartChecker(self):

1387

1985

"D-Bus method"

1388

1986

self.start_checker()

1389

1987

1390

1988

# Disable - method

1989

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

1391

1990

@dbus.service.method(_interface)

1392

1991

def Disable(self):

1393

1992

"D-Bus method"

1394

1993

self.disable()

1395

1994

1396

1995

# StopChecker - method

1996

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

1397

1997

@dbus.service.method(_interface)

1398

1998

def StopChecker(self):

1399

1999

self.stop_checker()

1400

1401

## Properties

1402

2000

2001

# Properties

2002

1403

2003

# ApprovalPending - property

1404

2004

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

1405

2005

def ApprovalPending_dbus_property(self):

1406

2006

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

1407

2007

1408

2008

# ApprovedByDefault - property

1409

@dbus_service_property(_interface, signature="b",

2009

@dbus_service_property(_interface,

2010

signature="b",

1410

2011

access="readwrite")

1411

2012

def ApprovedByDefault_dbus_property(self, value=None):

1412

2013

if value is None: # get

1413

2014

return dbus.Boolean(self.approved_by_default)

1414

2015

self.approved_by_default = bool(value)

1415

2016

1416

2017

# ApprovalDelay - property

1417

@dbus_service_property(_interface, signature="t",

2018

@dbus_service_property(_interface,

2019

signature="t",

1418

2020

access="readwrite")

1419

2021

def ApprovalDelay_dbus_property(self, value=None):

1420

2022

if value is None: # get

1421

return dbus.UInt64(self.approval_delay_milliseconds())

2023

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

2024

* 1000)

1422

2025

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

1423

2026

1424

2027

# ApprovalDuration - property

1425

@dbus_service_property(_interface, signature="t",

2028

@dbus_service_property(_interface,

2029

signature="t",

1426

2030

access="readwrite")

1427

2031

def ApprovalDuration_dbus_property(self, value=None):

1428

2032

if value is None: # get

1429

return dbus.UInt64(timedelta_to_milliseconds(

1430

self.approval_duration))

2033

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

2034

* 1000)

1431

2035

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

1432

2036

1433

2037

# Name - property

2038

@dbus_annotations(

2039

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

1434

2040

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

1435

2041

def Name_dbus_property(self):

1436

2042

return dbus.String(self.name)

1437

2043

2044

# KeyID - property

2045

@dbus_annotations(

2046

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

2047

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

2048

def KeyID_dbus_property(self):

2049

return dbus.String(self.key_id)

2050

1438

2051

# Fingerprint - property

2052

@dbus_annotations(

2053

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

1439

2054

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

1440

2055

def Fingerprint_dbus_property(self):

1441

2056

return dbus.String(self.fingerprint)

1442

2057

1443

2058

# Host - property

1444

@dbus_service_property(_interface, signature="s",

2059

@dbus_service_property(_interface,

2060

signature="s",

1445

2061

access="readwrite")

1446

2062

def Host_dbus_property(self, value=None):

1447

2063

if value is None: # get

1448

2064

return dbus.String(self.host)

1449

self.host = unicode(value)

1450

2065

self.host = str(value)

2066

1451

2067

# Created - property

2068

@dbus_annotations(

2069

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

1452

2070

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

1453

2071

def Created_dbus_property(self):

1454

2072

return datetime_to_dbus(self.created)

1455

2073

1456

2074

# LastEnabled - property

1457

2075

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

1458

2076

def LastEnabled_dbus_property(self):

1459

2077

return datetime_to_dbus(self.last_enabled)

1460

2078

1461

2079

# Enabled - property

1462

@dbus_service_property(_interface, signature="b",

2080

@dbus_service_property(_interface,

2081

signature="b",

1463

2082

access="readwrite")

1464

2083

def Enabled_dbus_property(self, value=None):

1465

2084

if value is None: # get

1468

2087

self.enable()

1469

2088

else:

1470

2089

self.disable()

1471

2090

1472

2091

# LastCheckedOK - property

1473

@dbus_service_property(_interface, signature="s",

2092

@dbus_service_property(_interface,

2093

signature="s",

1474

2094

access="readwrite")

1475

2095

def LastCheckedOK_dbus_property(self, value=None):

1476

2096

if value is not None:

1477

2097

self.checked_ok()

1478

2098

return

1479

2099

return datetime_to_dbus(self.last_checked_ok)

1480

2100

1481

2101

# LastCheckerStatus - property

1482

@dbus_service_property(_interface, signature="n",

1483

access="read")

2102

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

1484

2103

def LastCheckerStatus_dbus_property(self):

1485

2104

return dbus.Int16(self.last_checker_status)

1486

2105

1487

2106

# Expires - property

1488

2107

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

1489

2108

def Expires_dbus_property(self):

1490

2109

return datetime_to_dbus(self.expires)

1491

2110

1492

2111

# LastApprovalRequest - property

1493

2112

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

1494

2113

def LastApprovalRequest_dbus_property(self):

1495

2114

return datetime_to_dbus(self.last_approval_request)

1496

2115

1497

2116

# Timeout - property

1498

@dbus_service_property(_interface, signature="t",

2117

@dbus_service_property(_interface,

2118

signature="t",

1499

2119

access="readwrite")

1500

2120

def Timeout_dbus_property(self, value=None):

1501

2121

if value is None: # get

1502

return dbus.UInt64(self.timeout_milliseconds())

2122

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

2123

old_timeout = self.timeout

1503

2124

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

1504

# Reschedule timeout

2125

# Reschedule disabling

1505

2126

if self.enabled:

1506

2127

now = datetime.datetime.utcnow()

1507

time_to_die = timedelta_to_milliseconds(

1508

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

1509

if time_to_die <= 0:

2128

self.expires += self.timeout - old_timeout

2129

if self.expires <= now:

1510

2130

# The timeout has passed

1511

2131

self.disable()

1512

2132

else:

1513

self.expires = (now +

1514

datetime.timedelta(milliseconds =

1515

time_to_die))

1516

2133

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

1517

2134

is None):

1518

2135

return

1519

gobject.source_remove(self.disable_initiator_tag)

1520

self.disable_initiator_tag = (gobject.timeout_add

1521

(time_to_die,

1522

self.disable))

1523

2136

GLib.source_remove(self.disable_initiator_tag)

2137

self.disable_initiator_tag = GLib.timeout_add(

2138

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

2139

self.disable)

2140

1524

2141

# ExtendedTimeout - property

1525

@dbus_service_property(_interface, signature="t",

2142

@dbus_service_property(_interface,

2143

signature="t",

1526

2144

access="readwrite")

1527

2145

def ExtendedTimeout_dbus_property(self, value=None):

1528

2146

if value is None: # get

1529

return dbus.UInt64(self.extended_timeout_milliseconds())

2147

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

2148

* 1000)

1530

2149

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

1531

2150

1532

2151

# Interval - property

1533

@dbus_service_property(_interface, signature="t",

2152

@dbus_service_property(_interface,

2153

signature="t",

1534

2154

access="readwrite")

1535

2155

def Interval_dbus_property(self, value=None):

1536

2156

if value is None: # get

1537

return dbus.UInt64(self.interval_milliseconds())

2157

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

1538

2158

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

1539

2159

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

1540

2160

return

1541

2161

if self.enabled:

1542

2162

# Reschedule checker run

1543

gobject.source_remove(self.checker_initiator_tag)

1544

self.checker_initiator_tag = (gobject.timeout_add

1545

(value, self.start_checker))

1546

self.start_checker() # Start one now, too

1547

2163

GLib.source_remove(self.checker_initiator_tag)

2164

self.checker_initiator_tag = GLib.timeout_add(

2165

value, self.start_checker)

2166

self.start_checker() # Start one now, too

2167

1548

2168

# Checker - property

1549

@dbus_service_property(_interface, signature="s",

2169

@dbus_service_property(_interface,

2170

signature="s",

1550

2171

access="readwrite")

1551

2172

def Checker_dbus_property(self, value=None):

1552

2173

if value is None: # get

1553

2174

return dbus.String(self.checker_command)

1554

self.checker_command = unicode(value)

1555

2175

self.checker_command = str(value)

2176

1556

2177

# CheckerRunning - property

1557

@dbus_service_property(_interface, signature="b",

2178

@dbus_service_property(_interface,

2179

signature="b",

1558

2180

access="readwrite")

1559

2181

def CheckerRunning_dbus_property(self, value=None):

1560

2182

if value is None: # get

1563

2185

self.start_checker()

1564

2186

else:

1565

2187

self.stop_checker()

1566

2188

1567

2189

# ObjectPath - property

2190

@dbus_annotations(

2191

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

2192

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

1568

2193

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

1569

2194

def ObjectPath_dbus_property(self):

1570

return self.dbus_object_path # is already a dbus.ObjectPath

1571

2195

return self.dbus_object_path # is already a dbus.ObjectPath

2196

1572

2197

# Secret = property

1573

@dbus_service_property(_interface, signature="ay",

1574

access="write", byte_arrays=True)

2198

@dbus_annotations(

2199

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

2200

"invalidates"})

2201

@dbus_service_property(_interface,

2202

signature="ay",

2203

access="write",

2204

byte_arrays=True)

1575

2205

def Secret_dbus_property(self, value):

1576

self.secret = str(value)

1577

2206

self.secret = bytes(value)

2207

1578

2208

del _interface

1579

2209

1580

2210

1581

2211

class ProxyClient(object):

1582

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

2212

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

1583

2213

self._pipe = child_pipe

1584

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

2214

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

1585

2215

if not self._pipe.recv():

1586

raise KeyError()

1587

2216

raise KeyError(key_id or fpr)

2217

1588

2218

def __getattribute__(self, name):

1589

2219

if name == '_pipe':

1590

2220

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

1593

2223

if data[0] == 'data':

1594

2224

return data[1]

1595

2225

if data[0] == 'function':

2226

1596

2227

def func(*args, **kwargs):

1597

2228

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

1598

2229

return self._pipe.recv()[1]

2230

1599

2231

return func

1600

2232

1601

2233

def __setattr__(self, name, value):

1602

2234

if name == '_pipe':

1603

2235

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

1604

2236

self._pipe.send(('setattr', name, value))

1605

2237

1606

2238

1607

class ClientDBusTransitional(ClientDBus):

1608

__metaclass__ = AlternateDBusNamesMetaclass

1609

1610

1611

2239

class ClientHandler(socketserver.BaseRequestHandler, object):

1612

2240

"""A class to handle client connections.

1613

2241

1614

2242

Instantiated once for each connection to handle it.

1615

2243

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

1616

2244

1617

2245

def handle(self):

1618

2246

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

1619

2247

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

1620

unicode(self.client_address))

2248

str(self.client_address))

1621

2249

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

1622

2250

self.server.child_pipe.fileno())

1623

1624

session = (gnutls.connection

1625

.ClientSession(self.request,

1626

gnutls.connection

1627

.X509Credentials()))

1628

1629

# Note: gnutls.connection.X509Credentials is really a

1630

# generic GnuTLS certificate credentials object so long as

1631

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

1632

# here despite using OpenPGP certificates.

1633

1634

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

1635

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

1636

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

1637

# "+DHE-DSS"))

2251

2252

session = gnutls.ClientSession(self.request)

2253

2254

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

2255

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

2256

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

2257

# "+DHE-DSS"))

1638

2258

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

1639

2259

priority = self.server.gnutls_priority

1640

2260

if priority is None:

1641

2261

priority = "NORMAL"

1642

(gnutls.library.functions

1643

.gnutls_priority_set_direct(session._c_object,

1644

priority, None))

1645

2262

gnutls.priority_set_direct(session._c_object,

2263

priority.encode("utf-8"),

2264

None)

2265

1646

2266

# Start communication using the Mandos protocol

1647

2267

# Get protocol number

1648

2268

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

1649

2269

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

1650

2270

try:

1651

2271

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

1652

raise RuntimeError

2272

raise RuntimeError(line)

1653

2273

except (ValueError, IndexError, RuntimeError) as error:

1654

2274

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

1655

2275

return

1656

2276

1657

2277

# Start GnuTLS connection

1658

2278

try:

1659

2279

session.handshake()

1660

except gnutls.errors.GNUTLSError as error:

2280

except gnutls.Error as error:

1661

2281

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

1662

2282

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

1663

2283

# established. Just abandon the request.

1664

2284

return

1665

2285

logger.debug("Handshake succeeded")

1666

2286

1667

2287

approval_required = False

1668

2288

try:

1669

try:

1670

fpr = self.fingerprint(self.peer_certificate

1671

(session))

1672

except (TypeError,

1673

gnutls.errors.GNUTLSError) as error:

1674

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

1675

return

1676

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

1677

1678

try:

1679

client = ProxyClient(child_pipe, fpr,

2289

if gnutls.has_rawpk:

2290

fpr = ""

2291

try:

2292

key_id = self.key_id(

2293

self.peer_certificate(session))

2294

except (TypeError, gnutls.Error) as error:

2295

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

2296

return

2297

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

2298

2299

else:

2300

key_id = ""

2301

try:

2302

fpr = self.fingerprint(

2303

self.peer_certificate(session))

2304

except (TypeError, gnutls.Error) as error:

2305

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

2306

return

2307

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

2308

2309

try:

2310

client = ProxyClient(child_pipe, key_id, fpr,

1680

2311

self.client_address)

1681

2312

except KeyError:

1682

2313

return

1683

2314

1684

2315

if client.approval_delay:

1685

2316

delay = client.approval_delay

1686

2317

client.approvals_pending += 1

1687

2318

approval_required = True

1688

2319

1689

2320

while True:

1690

2321

if not client.enabled:

1691

2322

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

1692

client.name)

2323

client.name)

1693

2324

if self.server.use_dbus:

1694

2325

# Emit D-Bus signal

1695

2326

client.Rejected("Disabled")

1696

2327

return

1697

2328

1698

2329

if client.approved or not client.approval_delay:

1699

#We are approved or approval is disabled

2330

# We are approved or approval is disabled

1700

2331

break

1701

2332

elif client.approved is None:

1702

2333

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

1704

2335

if self.server.use_dbus:

1705

2336

# Emit D-Bus signal

1706

2337

client.NeedApproval(

1707

client.approval_delay_milliseconds(),

1708

client.approved_by_default)

2338

client.approval_delay.total_seconds()

2339

* 1000, client.approved_by_default)

1709

2340

else:

1710

2341

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

1711

2342

client.name)

1713

2344

# Emit D-Bus signal

1714

2345

client.Rejected("Denied")

1715

2346

return

1716

1717

#wait until timeout or approved

2347

2348

# wait until timeout or approved

1718

2349

time = datetime.datetime.now()

1719

2350

client.changedstate.acquire()

1720

(client.changedstate.wait

1721

(float(client.timedelta_to_milliseconds(delay)

1722

/ 1000)))

2351

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

1723

2352

client.changedstate.release()

1724

2353

time2 = datetime.datetime.now()

1725

2354

if (time2 - time) >= delay:

1735

2364

break

1736

2365

else:

1737

2366

delay -= time2 - time

1738

1739

sent_size = 0

1740

while sent_size < len(client.secret):

1741

try:

1742

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

1743

except gnutls.errors.GNUTLSError as error:

1744

logger.warning("gnutls send failed",

1745

exc_info=error)

1746

return

1747

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

1748

sent, len(client.secret)

1749

- (sent_size + sent))

1750

sent_size += sent

1751

2367

2368

try:

2369

session.send(client.secret)

2370

except gnutls.Error as error:

2371

logger.warning("gnutls send failed",

2372

exc_info=error)

2373

return

2374

1752

2375

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

1753

2376

# bump the timeout using extended_timeout

1754

2377

client.bump_timeout(client.extended_timeout)

1755

2378

if self.server.use_dbus:

1756

2379

# Emit D-Bus signal

1757

2380

client.GotSecret()

1758

2381

1759

2382

finally:

1760

2383

if approval_required:

1761

2384

client.approvals_pending -= 1

1762

2385

try:

1763

2386

session.bye()

1764

except gnutls.errors.GNUTLSError as error:

2387

except gnutls.Error as error:

1765

2388

logger.warning("GnuTLS bye failed",

1766

2389

exc_info=error)

1767

2390

1768

2391

@staticmethod

1769

2392

def peer_certificate(session):

1770

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

1771

# If not an OpenPGP certificate...

1772

if (gnutls.library.functions

1773

.gnutls_certificate_type_get(session._c_object)

1774

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1775

# ...do the normal thing

1776

return session.peer_certificate

2393

"Return the peer's certificate as a bytestring"

2394

try:

2395

cert_type = gnutls.certificate_type_get2(session._c_object,

2396

gnutls.CTYPE_PEERS)

2397

except AttributeError:

2398

cert_type = gnutls.certificate_type_get(session._c_object)

2399

if gnutls.has_rawpk:

2400

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2401

else:

2402

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2403

# If not a valid certificate type...

2404

if cert_type not in valid_cert_types:

2405

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

2406

valid_cert_types)

2407

# ...return invalid data

2408

return b""

1777

2409

list_size = ctypes.c_uint(1)

1778

cert_list = (gnutls.library.functions

1779

.gnutls_certificate_get_peers

2410

cert_list = (gnutls.certificate_get_peers

1780

2411

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

1781

2412

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

1782

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

1783

" certificate")

2413

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

1784

2414

if list_size.value == 0:

1785

2415

return None

1786

2416

cert = cert_list[0]

1787

2417

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

1788

2418

2419

@staticmethod

2420

def key_id(certificate):

2421

"Convert a certificate bytestring to a hexdigit key ID"

2422

# New GnuTLS "datum" with the public key

2423

datum = gnutls.datum_t(

2424

ctypes.cast(ctypes.c_char_p(certificate),

2425

ctypes.POINTER(ctypes.c_ubyte)),

2426

ctypes.c_uint(len(certificate)))

2427

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

2428

# New empty GnuTLS certificate

2429

pubkey = gnutls.pubkey_t()

2430

gnutls.pubkey_init(ctypes.byref(pubkey))

2431

# Import the raw public key into the certificate

2432

gnutls.pubkey_import(pubkey,

2433

ctypes.byref(datum),

2434

gnutls.X509_FMT_DER)

2435

# New buffer for the key ID

2436

buf = ctypes.create_string_buffer(32)

2437

buf_len = ctypes.c_size_t(len(buf))

2438

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

2439

gnutls.pubkey_get_key_id(pubkey,

2440

gnutls.KEYID_USE_SHA256,

2441

ctypes.cast(ctypes.byref(buf),

2442

ctypes.POINTER(ctypes.c_ubyte)),

2443

ctypes.byref(buf_len))

2444

# Deinit the certificate

2445

gnutls.pubkey_deinit(pubkey)

2446

2447

# Convert the buffer to a Python bytestring

2448

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

2449

# Convert the bytestring to hexadecimal notation

2450

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

2451

return hex_key_id

2452

1789

2453

@staticmethod

1790

2454

def fingerprint(openpgp):

1791

2455

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1792

2456

# New GnuTLS "datum" with the OpenPGP public key

1793

datum = (gnutls.library.types

1794

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

1795

ctypes.POINTER

1796

(ctypes.c_ubyte)),

1797

ctypes.c_uint(len(openpgp))))

2457

datum = gnutls.datum_t(

2458

ctypes.cast(ctypes.c_char_p(openpgp),

2459

ctypes.POINTER(ctypes.c_ubyte)),

2460

ctypes.c_uint(len(openpgp)))

1798

2461

# New empty GnuTLS certificate

1799

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1800

(gnutls.library.functions

1801

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2462

crt = gnutls.openpgp_crt_t()

2463

gnutls.openpgp_crt_init(ctypes.byref(crt))

1802

2464

# Import the OpenPGP public key into the certificate

1803

(gnutls.library.functions

1804

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

1805

gnutls.library.constants

1806

.GNUTLS_OPENPGP_FMT_RAW))

2465

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

2466

gnutls.OPENPGP_FMT_RAW)

1807

2467

# Verify the self signature in the key

1808

2468

crtverify = ctypes.c_uint()

1809

(gnutls.library.functions

1810

.gnutls_openpgp_crt_verify_self(crt, 0,

1811

ctypes.byref(crtverify)))

2469

gnutls.openpgp_crt_verify_self(crt, 0,

2470

ctypes.byref(crtverify))

1812

2471

if crtverify.value != 0:

1813

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1814

raise (gnutls.errors.CertificateSecurityError

1815

("Verify failed"))

2472

gnutls.openpgp_crt_deinit(crt)

2473

raise gnutls.CertificateSecurityError(code

2474

=crtverify.value)

1816

2475

# New buffer for the fingerprint

1817

2476

buf = ctypes.create_string_buffer(20)

1818

2477

buf_len = ctypes.c_size_t()

1819

2478

# Get the fingerprint from the certificate into the buffer

1820

(gnutls.library.functions

1821

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

1822

ctypes.byref(buf_len)))

2479

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

2480

ctypes.byref(buf_len))

1823

2481

# Deinit the certificate

1824

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2482

gnutls.openpgp_crt_deinit(crt)

1825

2483

# Convert the buffer to a Python bytestring

1826

2484

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

1827

2485

# Convert the bytestring to hexadecimal notation

1831

2489

1832

2490

class MultiprocessingMixIn(object):

1833

2491

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

2492

1834

2493

def sub_process_main(self, request, address):

1835

2494

try:

1836

2495

self.finish_request(request, address)

1837

2496

except Exception:

1838

2497

self.handle_error(request, address)

1839

2498

self.close_request(request)

1840

2499

1841

2500

def process_request(self, request, address):

1842

2501

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

1843

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

1844

args = (request,

1845

address))

2502

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

2503

args=(request, address))

1846

2504

proc.start()

1847

2505

return proc

1848

2506

1849

2507

1850

2508

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1851

2509

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

2510

1852

2511

def process_request(self, request, client_address):

1853

2512

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

1854

2513

1855

2514

This function creates a new pipe in self.pipe

1856

2515

"""

1857

2516

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1858

2517

1859

2518

proc = MultiprocessingMixIn.process_request(self, request,

1860

2519

client_address)

1861

2520

self.child_pipe.close()

1862

2521

self.add_pipe(parent_pipe, proc)

1863

2522

1864

2523

def add_pipe(self, parent_pipe, proc):

1865

2524

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

1866

raise NotImplementedError

2525

raise NotImplementedError()

1867

2526

1868

2527

1869

2528

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1870

2529

socketserver.TCPServer, object):

1871

2530

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

1872

2531

1873

2532

Attributes:

1874

2533

enabled: Boolean; whether this server is activated yet

1875

2534

interface: None or a network interface name (string)

1876

2535

use_ipv6: Boolean; to use IPv6 or not

1877

2536

"""

2537

1878

2538

def __init__(self, server_address, RequestHandlerClass,

1879

interface=None, use_ipv6=True):

2539

interface=None,

2540

use_ipv6=True,

2541

socketfd=None):

2542

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

2543

creating a new one with socket.socket().

2544

"""

1880

2545

self.interface = interface

1881

2546

if use_ipv6:

1882

2547

self.address_family = socket.AF_INET6

2548

if socketfd is not None:

2549

# Save the file descriptor

2550

self.socketfd = socketfd

2551

# Save the original socket.socket() function

2552

self.socket_socket = socket.socket

2553

2554

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

2555

#

2556

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

2557

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

2558

# patching socket.socket.)

2559

#

2560

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

2561

@functools.wraps(socket.socket)

2562

def socket_wrapper(*args, **kwargs):

2563

# Restore original function so subsequent calls are

2564

# not affected.

2565

socket.socket = self.socket_socket

2566

del self.socket_socket

2567

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

2568

# saved file descriptor.

2569

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

2570

# Replace socket.socket() function with wrapper

2571

socket.socket = socket_wrapper

2572

# The socketserver.TCPServer.__init__ will call

2573

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

2574

# socket_wrapper(), if socketfd was set.

1883

2575

socketserver.TCPServer.__init__(self, server_address,

1884

2576

RequestHandlerClass)

2577

1885

2578

def server_bind(self):

1886

2579

"""This overrides the normal server_bind() function

1887

2580

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

1888

2581

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

2582

global SO_BINDTODEVICE

1889

2583

if self.interface is not None:

1890

2584

if SO_BINDTODEVICE is None:

1891

logger.error("SO_BINDTODEVICE does not exist;"

1892

" cannot bind to interface %s",

1893

self.interface)

1894

else:

1895

try:

1896

self.socket.setsockopt(socket.SOL_SOCKET,

1897

SO_BINDTODEVICE,

1898

str(self.interface

1899

+ '\0'))

1900

except socket.error as error:

1901

if error[0] == errno.EPERM:

1902

logger.error("No permission to"

1903

" bind to interface %s",

1904

self.interface)

1905

elif error[0] == errno.ENOPROTOOPT:

1906

logger.error("SO_BINDTODEVICE not available;"

1907

" cannot bind to interface %s",

1908

self.interface)

1909

else:

1910

raise

2585

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

2586

# common enough.

2587

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

2588

SO_BINDTODEVICE = 25

2589

try:

2590

self.socket.setsockopt(

2591

socket.SOL_SOCKET, SO_BINDTODEVICE,

2592

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

2593

except socket.error as error:

2594

if error.errno == errno.EPERM:

2595

logger.error("No permission to bind to"

2596

" interface %s", self.interface)

2597

elif error.errno == errno.ENOPROTOOPT:

2598

logger.error("SO_BINDTODEVICE not available;"

2599

" cannot bind to interface %s",

2600

self.interface)

2601

elif error.errno == errno.ENODEV:

2602

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

2603

" cannot bind", self.interface)

2604

else:

2605

raise

1911

2606

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

1912

2607

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

1913

2608

if not self.server_address[0]:

1914

2609

if self.address_family == socket.AF_INET6:

1915

any_address = "::" # in6addr_any

2610

any_address = "::" # in6addr_any

1916

2611

else:

1917

any_address = socket.INADDR_ANY

2612

any_address = "0.0.0.0" # INADDR_ANY

1918

2613

self.server_address = (any_address,

1919

2614

self.server_address[1])

1920

2615

elif not self.server_address[1]:

1921

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

1922

0)

2616

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

1923

2617

# if self.interface:

1924

2618

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

1925

2619

# 0, # port

1931

2625

1932

2626

class MandosServer(IPv6_TCPServer):

1933

2627

"""Mandos server.

1934

2628

1935

2629

Attributes:

1936

2630

clients: set of Client objects

1937

2631

gnutls_priority GnuTLS priority string

1938

2632

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

1939

1940

Assumes a gobject.MainLoop event loop.

2633

2634

Assumes a GLib.MainLoop event loop.

1941

2635

"""

2636

1942

2637

def __init__(self, server_address, RequestHandlerClass,

1943

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

1944

gnutls_priority=None, use_dbus=True):

2638

interface=None,

2639

use_ipv6=True,

2640

clients=None,

2641

gnutls_priority=None,

2642

use_dbus=True,

2643

socketfd=None):

1945

2644

self.enabled = False

1946

2645

self.clients = clients

1947

2646

if self.clients is None:

1950

2649

self.gnutls_priority = gnutls_priority

1951

2650

IPv6_TCPServer.__init__(self, server_address,

1952

2651

RequestHandlerClass,

1953

interface = interface,

1954

use_ipv6 = use_ipv6)

2652

interface=interface,

2653

use_ipv6=use_ipv6,

2654

socketfd=socketfd)

2655

1955

2656

def server_activate(self):

1956

2657

if self.enabled:

1957

2658

return socketserver.TCPServer.server_activate(self)

1958

2659

1959

2660

def enable(self):

1960

2661

self.enabled = True

1961

2662

1962

2663

def add_pipe(self, parent_pipe, proc):

1963

2664

# Call "handle_ipc" for both data and EOF events

1964

gobject.io_add_watch(parent_pipe.fileno(),

1965

gobject.IO_IN | gobject.IO_HUP,

1966

functools.partial(self.handle_ipc,

1967

parent_pipe =

1968

parent_pipe,

1969

proc = proc))

1970

1971

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

1972

proc = None, client_object=None):

1973

condition_names = {

1974

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

1975

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

1976

# blocking).

1977

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

1978

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

1979

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

1980

# broken, usually for pipes and

1981

# sockets).

1982

}

1983

conditions_string = ' | '.join(name

1984

for cond, name in

1985

condition_names.iteritems()

1986

if cond & condition)

2665

GLib.io_add_watch(

2666

parent_pipe.fileno(),

2667

GLib.IO_IN | GLib.IO_HUP,

2668

functools.partial(self.handle_ipc,

2669

parent_pipe=parent_pipe,

2670

proc=proc))

2671

2672

def handle_ipc(self, source, condition,

2673

parent_pipe=None,

2674

proc=None,

2675

client_object=None):

1987

2676

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

1988

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

2677

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

1989

2678

# Wait for other process to exit

1990

2679

proc.join()

1991

2680

return False

1992

2681

1993

2682

# Read a request from the child

1994

2683

request = parent_pipe.recv()

1995

2684

command = request[0]

1996

2685

1997

2686

if command == 'init':

1998

fpr = request[1]

1999

address = request[2]

2000

2001

for c in self.clients.itervalues():

2002

if c.fingerprint == fpr:

2687

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

2688

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

2689

address = request[3]

2690

2691

for c in self.clients.values():

2692

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2693

continue

2694

if key_id and c.key_id == key_id:

2695

client = c

2696

break

2697

if fpr and c.fingerprint == fpr:

2003

2698

client = c

2004

2699

break

2005

2700

else:

2006

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

2007

"dress: %s", fpr, address)

2701

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

2702

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

2008

2703

if self.use_dbus:

2009

2704

# Emit D-Bus signal

2010

mandos_dbus_service.ClientNotFound(fpr,

2705

mandos_dbus_service.ClientNotFound(key_id or fpr,

2011

2706

address[0])

2012

2707

parent_pipe.send(False)

2013

2708

return False

2014

2015

gobject.io_add_watch(parent_pipe.fileno(),

2016

gobject.IO_IN | gobject.IO_HUP,

2017

functools.partial(self.handle_ipc,

2018

parent_pipe =

2019

parent_pipe,

2020

proc = proc,

2021

client_object =

2022

client))

2709

2710

GLib.io_add_watch(

2711

parent_pipe.fileno(),

2712

GLib.IO_IN | GLib.IO_HUP,

2713

functools.partial(self.handle_ipc,

2714

parent_pipe=parent_pipe,

2715

proc=proc,

2716

client_object=client))

2023

2717

parent_pipe.send(True)

2024

2718

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

2025

2719

# same fileno

2028

2722

funcname = request[1]

2029

2723

args = request[2]

2030

2724

kwargs = request[3]

2031

2725

2032

2726

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

2033

2727

funcname)(*args,

2034

**kwargs)))

2035

2728

**kwargs)))

2729

2036

2730

if command == 'getattr':

2037

2731

attrname = request[1]

2038

if callable(client_object.__getattribute__(attrname)):

2039

parent_pipe.send(('function',))

2732

if isinstance(client_object.__getattribute__(attrname),

2733

collections.Callable):

2734

parent_pipe.send(('function', ))

2040

2735

else:

2041

parent_pipe.send(('data', client_object

2042

.__getattribute__(attrname)))

2043

2736

parent_pipe.send((

2737

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

2738

2044

2739

if command == 'setattr':

2045

2740

attrname = request[1]

2046

2741

value = request[2]

2047

2742

setattr(client_object, attrname, value)

2048

2743

2049

2744

return True

2050

2745

2051

2746

2747

def rfc3339_duration_to_delta(duration):

2748

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

2749

2750

>>> rfc3339_duration_to_delta("P7D")

2751

datetime.timedelta(7)

2752

>>> rfc3339_duration_to_delta("PT60S")

2753

datetime.timedelta(0, 60)

2754

>>> rfc3339_duration_to_delta("PT60M")

2755

datetime.timedelta(0, 3600)

2756

>>> rfc3339_duration_to_delta("PT24H")

2757

datetime.timedelta(1)

2758

>>> rfc3339_duration_to_delta("P1W")

2759

datetime.timedelta(7)

2760

>>> rfc3339_duration_to_delta("PT5M30S")

2761

datetime.timedelta(0, 330)

2762

>>> rfc3339_duration_to_delta("P1DT3M20S")

2763

datetime.timedelta(1, 200)

2764

"""

2765

2766

# Parsing an RFC 3339 duration with regular expressions is not

2767

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

2768

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

2769

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

2770

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

2771

# avoid excessive use of external libraries.

2772

2773

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

2774

Token = collections.namedtuple("Token", (

2775

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

2776

# a "group" containing digits

2777

"value", # datetime.timedelta or None

2778

"followers")) # Tokens valid after this token

2779

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

2780

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

2781

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

2782

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

2783

datetime.timedelta(seconds=1),

2784

frozenset((token_end, )))

2785

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

2786

datetime.timedelta(minutes=1),

2787

frozenset((token_second, token_end)))

2788

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

2789

datetime.timedelta(hours=1),

2790

frozenset((token_minute, token_end)))

2791

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

2792

None,

2793

frozenset((token_hour, token_minute,

2794

token_second)))

2795

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

2796

datetime.timedelta(days=1),

2797

frozenset((token_time, token_end)))

2798

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

2799

datetime.timedelta(weeks=4),

2800

frozenset((token_day, token_end)))

2801

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

2802

datetime.timedelta(weeks=52),

2803

frozenset((token_month, token_end)))

2804

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

2805

datetime.timedelta(weeks=1),

2806

frozenset((token_end, )))

2807

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

2808

frozenset((token_year, token_month,

2809

token_day, token_time,

2810

token_week)))

2811

# Define starting values:

2812

# Value so far

2813

value = datetime.timedelta()

2814

found_token = None

2815

# Following valid tokens

2816

followers = frozenset((token_duration, ))

2817

# String left to parse

2818

s = duration

2819

# Loop until end token is found

2820

while found_token is not token_end:

2821

# Search for any currently valid tokens

2822

for token in followers:

2823

match = token.regexp.match(s)

2824

if match is not None:

2825

# Token found

2826

if token.value is not None:

2827

# Value found, parse digits

2828

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

2829

# Add to value so far

2830

value += factor * token.value

2831

# Strip token from string

2832

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

2833

# Go to found token

2834

found_token = token

2835

# Set valid next tokens

2836

followers = found_token.followers

2837

break

2838

else:

2839

# No currently valid tokens were found

2840

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

2841

.format(duration))

2842

# End token found

2843

return value

2844

2845

2052

2846

def string_to_delta(interval):

2053

2847

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

2054

2848

2055

2849

>>> string_to_delta('7d')

2056

2850

datetime.timedelta(7)

2057

2851

>>> string_to_delta('60s')

2065

2859

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

2066

2860

datetime.timedelta(0, 330)

2067

2861

"""

2862

2863

try:

2864

return rfc3339_duration_to_delta(interval)

2865

except ValueError:

2866

pass

2867

2068

2868

timevalue = datetime.timedelta(0)

2069

2869

for s in interval.split():

2070

2870

try:

2071

suffix = unicode(s[-1])

2871

suffix = s[-1]

2072

2872

value = int(s[:-1])

2073

2873

if suffix == "d":

2074

2874

delta = datetime.timedelta(value)

2081

2881

elif suffix == "w":

2082

2882

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

2083

2883

else:

2084

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

2085

.format(suffix))

2086

except (ValueError, IndexError) as e:

2884

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

2885

except IndexError as e:

2087

2886

raise ValueError(*(e.args))

2088

2887

timevalue += delta

2089

2888

return timevalue

2090

2889

2091

2890

2092

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

2891

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

2093

2892

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

2094

2893

2095

2894

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

2096

2895

if os.fork():

2097

2896

sys.exit()

2105

2904

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

2106

2905

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

2107

2906

raise OSError(errno.ENODEV,

2108

"{0} not a character device"

2907

"{} not a character device"

2109

2908

.format(os.devnull))

2110

2909

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

2111

2910

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

2115

2914

2116

2915

2117

2916

def main():

2118

2917

2119

2918

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

2120

2919

# Parsing of options, both command line and config file

2121

2920

2122

2921

parser = argparse.ArgumentParser()

2123

2922

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

2124

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

2923

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

2125

2924

help="show version number and exit")

2126

2925

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

2127

2926

help="Bind to interface IF")

2133

2932

help="Run self-test")

2134

2933

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

2135

2934

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

2136

" to terminal")

2935

" to terminal", default=None)

2137

2936

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

2138

2937

help="Debug level for stdout output")

2139

2938

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

2146

2945

" files")

2147

2946

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

2148

2947

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

2149

" system bus interface")

2948

" system bus interface", default=None)

2150

2949

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

2151

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

2950

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

2951

default=None)

2152

2952

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

2153

2953

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

2154

" state")

2954

" state", default=None)

2955

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

2956

help="Specify a file descriptor to a network"

2957

" socket to use instead of creating one")

2155

2958

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

2156

2959

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

2157

2960

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

2961

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

2962

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

2963

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

2964

default=None)

2965

2158

2966

options = parser.parse_args()

2159

2967

2160

2968

if options.check:

2161

2969

import doctest

2162

doctest.testmod()

2163

sys.exit()

2164

2970

fail_count, test_count = doctest.testmod()

2971

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

2972

2165

2973

# Default values for config file for server-global settings

2166

server_defaults = { "interface": "",

2167

"address": "",

2168

"port": "",

2169

"debug": "False",

2170

"priority":

2171

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

2172

"servicename": "Mandos",

2173

"use_dbus": "True",

2174

"use_ipv6": "True",

2175

"debuglevel": "",

2176

"restore": "True",

2177

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

2178

}

2179

2974

if gnutls.has_rawpk:

2975

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

2976

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

2977

else:

2978

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

2979

":+SIGN-DSA-SHA256")

2980

server_defaults = {"interface": "",

2981

"address": "",

2982

"port": "",

2983

"debug": "False",

2984

"priority": priority,

2985

"servicename": "Mandos",

2986

"use_dbus": "True",

2987

"use_ipv6": "True",

2988

"debuglevel": "",

2989

"restore": "True",

2990

"socket": "",

2991

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

2992

"foreground": "False",

2993

"zeroconf": "True",

2994

}

2995

del priority

2996

2180

2997

# Parse config file for server-global settings

2181

2998

server_config = configparser.SafeConfigParser(server_defaults)

2182

2999

del server_defaults

2183

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

2184

"mandos.conf"))

3000

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

2185

3001

# Convert the SafeConfigParser object to a dict

2186

3002

server_settings = server_config.defaults()

2187

3003

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

2188

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

3004

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

3005

"foreground", "zeroconf"):

2189

3006

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

2190

3007

option)

2191

3008

if server_settings["port"]:

2192

3009

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

2193

3010

"port")

3011

if server_settings["socket"]:

3012

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

3013

"socket")

3014

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

3015

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

3016

# happen with a supplied network socket.

3017

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

3018

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

3019

["socket"])

2194

3020

del server_config

2195

3021

2196

3022

# Override the settings from the config file with command line

2197

3023

# options, if set.

2198

3024

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

2199

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

2200

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

2201

"statedir"):

3025

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

3026

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

3027

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

2202

3028

value = getattr(options, option)

2203

3029

if value is not None:

2204

3030

server_settings[option] = value

2205

3031

del options

2206

3032

# Force all strings to be unicode

2207

3033

for option in server_settings.keys():

2208

if type(server_settings[option]) is str:

2209

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

3034

if isinstance(server_settings[option], bytes):

3035

server_settings[option] = (server_settings[option]

3036

.decode("utf-8"))

3037

# Force all boolean options to be boolean

3038

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

3039

"foreground", "zeroconf"):

3040

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

3041

# Debug implies foreground

3042

if server_settings["debug"]:

3043

server_settings["foreground"] = True

2210

3044

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

2211

3045

2212

3046

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

2213

3047

3048

if (not server_settings["zeroconf"]

3049

and not (server_settings["port"]

3050

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

3051

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

3052

2214

3053

# For convenience

2215

3054

debug = server_settings["debug"]

2216

3055

debuglevel = server_settings["debuglevel"]

2218

3057

use_ipv6 = server_settings["use_ipv6"]

2219

3058

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

2220

3059

stored_state_file)

2221

3060

foreground = server_settings["foreground"]

3061

zeroconf = server_settings["zeroconf"]

3062

2222

3063

if debug:

2223

3064

initlogger(debug, logging.DEBUG)

2224

3065

else:

2227

3068

else:

2228

3069

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

2229

3070

initlogger(debug, level)

2230

3071

2231

3072

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

2232

syslogger.setFormatter(logging.Formatter

2233

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

2234

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

2235

.format(server_settings

2236

["servicename"])))

2237

3073

syslogger.setFormatter(

3074

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

3075

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

3076

server_settings["servicename"])))

3077

2238

3078

# Parse config file with clients

2239

3079

client_config = configparser.SafeConfigParser(Client

2240

3080

.client_defaults)

2241

3081

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

2242

3082

"clients.conf"))

2243

3083

2244

3084

global mandos_dbus_service

2245

3085

mandos_dbus_service = None

2246

2247

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

2248

server_settings["port"]),

2249

ClientHandler,

2250

interface=(server_settings["interface"]

2251

or None),

2252

use_ipv6=use_ipv6,

2253

gnutls_priority=

2254

server_settings["priority"],

2255

use_dbus=use_dbus)

2256

if not debug:

2257

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

3086

3087

socketfd = None

3088

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

3089

socketfd = server_settings["socket"]

3090

tcp_server = MandosServer(

3091

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

3092

ClientHandler,

3093

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

3094

use_ipv6=use_ipv6,

3095

gnutls_priority=server_settings["priority"],

3096

use_dbus=use_dbus,

3097

socketfd=socketfd)

3098

if not foreground:

3099

pidfilename = "/run/mandos.pid"

3100

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

3101

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

3102

pidfile = None

2258

3103

try:

2259

pidfile = open(pidfilename, "w")

3104

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

2260

3105

except IOError as e:

2261

3106

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

2262

3107

exc_info=e)

2263

2264

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

3108

3109

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

3110

("mandos", "mandos"),

3111

("nobody", "nogroup")):

2265

3112

try:

2266

3113

uid = pwd.getpwnam(name).pw_uid

2267

gid = pwd.getpwnam(name).pw_gid

3114

gid = pwd.getpwnam(group).pw_gid

2268

3115

break

2269

3116

except KeyError:

2270

3117

continue

2274

3121

try:

2275

3122

os.setgid(gid)

2276

3123

os.setuid(uid)

3124

if debug:

3125

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

3126

gid))

2277

3127

except OSError as error:

2278

if error[0] != errno.EPERM:

2279

raise error

2280

3128

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

3129

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

3130

if error.errno != errno.EPERM:

3131

raise

3132

2281

3133

if debug:

2282

3134

# Enable all possible GnuTLS debugging

2283

3135

2284

3136

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

2285

3137

# - GnuTLS manual

2286

gnutls.library.functions.gnutls_global_set_log_level(11)

2287

2288

@gnutls.library.types.gnutls_log_func

3138

gnutls.global_set_log_level(11)

3139

3140

@gnutls.log_func

2289

3141

def debug_gnutls(level, string):

2290

3142

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

2291

2292

(gnutls.library.functions

2293

.gnutls_global_set_log_function(debug_gnutls))

2294

3143

3144

gnutls.global_set_log_function(debug_gnutls)

3145

2295

3146

# Redirect stdin so all checkers get /dev/null

2296

3147

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

2297

3148

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

2298

3149

if null > 2:

2299

3150

os.close(null)

2300

3151

2301

3152

# Need to fork before connecting to D-Bus

2302

if not debug:

3153

if not foreground:

2303

3154

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

2304

3155

daemon()

2305

2306

gobject.threads_init()

2307

3156

3157

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

3158

# to inform GLib that threads will be used.

3159

GLib.threads_init()

3160

2308

3161

global main_loop

2309

3162

# From the Avahi example code

2310

3163

DBusGMainLoop(set_as_default=True)

2311

main_loop = gobject.MainLoop()

3164

main_loop = GLib.MainLoop()

2312

3165

bus = dbus.SystemBus()

2313

3166

# End of Avahi example code

2314

3167

if use_dbus:

2315

3168

try:

2316

3169

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

2317

bus, do_not_queue=True)

2318

old_bus_name = (dbus.service.BusName

2319

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

2320

do_not_queue=True))

2321

except dbus.exceptions.NameExistsException as e:

3170

bus,

3171

do_not_queue=True)

3172

old_bus_name = dbus.service.BusName(

3173

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

3174

do_not_queue=True)

3175

except dbus.exceptions.DBusException as e:

2322

3176

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

2323

3177

use_dbus = False

2324

3178

server_settings["use_dbus"] = False

2325

3179

tcp_server.use_dbus = False

2326

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2327

service = AvahiServiceToSyslog(name =

2328

server_settings["servicename"],

2329

servicetype = "_mandos._tcp",

2330

protocol = protocol, bus = bus)

2331

if server_settings["interface"]:

2332

service.interface = (if_nametoindex

2333

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

2334

3180

if zeroconf:

3181

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3182

service = AvahiServiceToSyslog(

3183

name=server_settings["servicename"],

3184

servicetype="_mandos._tcp",

3185

protocol=protocol,

3186

bus=bus)

3187

if server_settings["interface"]:

3188

service.interface = if_nametoindex(

3189

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

3190

2335

3191

global multiprocessing_manager

2336

3192

multiprocessing_manager = multiprocessing.Manager()

2337

3193

2338

3194

client_class = Client

2339

3195

if use_dbus:

2340

client_class = functools.partial(ClientDBusTransitional,

2341

bus = bus)

2342

3196

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

3197

2343

3198

client_settings = Client.config_parser(client_config)

2344

3199

old_client_settings = {}

2345

3200

clients_data = {}

2346

3201

3202

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

3203

global wnull

3204

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

3205

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

3206

# mode

3207

if debug or not foreground:

3208

wnull.close()

3209

2347

3210

# Get client data and settings from last running state.

2348

3211

if server_settings["restore"]:

2349

3212

try:

2350

3213

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

2351

clients_data, old_client_settings = (pickle.load

2352

(stored_state))

3214

if sys.version_info.major == 2:

3215

clients_data, old_client_settings = pickle.load(

3216

stored_state)

3217

else:

3218

bytes_clients_data, bytes_old_client_settings = (

3219

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

3220

# Fix bytes to strings

3221

# clients_data

3222

# .keys()

3223

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

3224

if isinstance(key, bytes)

3225

else key): value

3226

for key, value in

3227

bytes_clients_data.items()}

3228

del bytes_clients_data

3229

for key in clients_data:

3230

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

3231

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

3232

for k, v in

3233

clients_data[key].items()}

3234

clients_data[key] = value

3235

# .client_structure

3236

value["client_structure"] = [

3237

(s.decode("utf-8")

3238

if isinstance(s, bytes)

3239

else s) for s in

3240

value["client_structure"]]

3241

# .name & .host

3242

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

3243

if isinstance(value[k], bytes):

3244

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

3245

if not value.has_key("key_id"):

3246

value["key_id"] = ""

3247

elif not value.has_key("fingerprint"):

3248

value["fingerprint"] = ""

3249

# old_client_settings

3250

# .keys()

3251

old_client_settings = {

3252

(key.decode("utf-8")

3253

if isinstance(key, bytes)

3254

else key): value

3255

for key, value in

3256

bytes_old_client_settings.items()}

3257

del bytes_old_client_settings

3258

# .host

3259

for value in old_client_settings.values():

3260

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

3261

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

3262

.decode("utf-8"))

2353

3263

os.remove(stored_state_path)

2354

3264

except IOError as e:

2355

3265

if e.errno == errno.ENOENT:

2356

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

2357

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

3266

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

3267

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

2358

3268

else:

2359

3269

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

2360

3270

exc_info=e)

2361

3271

raise

2362

3272

except EOFError as e:

2363

3273

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

2364

"EOFError:", exc_info=e)

2365

3274

"EOFError:",

3275

exc_info=e)

3276

2366

3277

with PGPEngine() as pgp:

2367

for client_name, client in clients_data.iteritems():

3278

for client_name, client in clients_data.items():

3279

# Skip removed clients

3280

if client_name not in client_settings:

3281

continue

3282

2368

3283

# Decide which value to use after restoring saved state.

2369

3284

# We have three different values: Old config file,

2370

3285

# new config file, and saved state.

2375

3290

# For each value in new config, check if it

2376

3291

# differs from the old config value (Except for

2377

3292

# the "secret" attribute)

2378

if (name != "secret" and

2379

value != old_client_settings[client_name]

2380

[name]):

3293

if (name != "secret"

3294

and (value !=

3295

old_client_settings[client_name][name])):

2381

3296

client[name] = value

2382

3297

except KeyError:

2383

3298

pass

2384

3299

2385

3300

# Clients who has passed its expire date can still be

2386

# enabled if its last checker was successful. Clients

3301

# enabled if its last checker was successful. A Client

2387

3302

# whose checker succeeded before we stored its state is

2388

3303

# assumed to have successfully run all checkers during

2389

3304

# downtime.

2391

3306

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

2392

3307

if not client["last_checked_ok"]:

2393

3308

logger.warning(

2394

"disabling client {0} - Client never "

2395

"performed a successful checker"

2396

.format(client_name))

3309

"disabling client {} - Client never "

3310

"performed a successful checker".format(

3311

client_name))

2397

3312

client["enabled"] = False

2398

3313

elif client["last_checker_status"] != 0:

2399

3314

logger.warning(

2400

"disabling client {0} - Client "

2401

"last checker failed with error code {1}"

2402

.format(client_name,

2403

client["last_checker_status"]))

3315

"disabling client {} - Client last"

3316

" checker failed with error code"

3317

" {}".format(

3318

client_name,

3319

client["last_checker_status"]))

2404

3320

client["enabled"] = False

2405

3321

else:

2406

client["expires"] = (datetime.datetime

2407

.utcnow()

2408

+ client["timeout"])

3322

client["expires"] = (

3323

datetime.datetime.utcnow()

3324

+ client["timeout"])

2409

3325

logger.debug("Last checker succeeded,"

2410

" keeping {0} enabled"

2411

.format(client_name))

3326

" keeping {} enabled".format(

3327

client_name))

2412

3328

try:

2413

client["secret"] = (

2414

pgp.decrypt(client["encrypted_secret"],

2415

client_settings[client_name]

2416

["secret"]))

3329

client["secret"] = pgp.decrypt(

3330

client["encrypted_secret"],

3331

client_settings[client_name]["secret"])

2417

3332

except PGPError:

2418

3333

# If decryption fails, we use secret from new settings

2419

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

2420

.format(client_name))

2421

client["secret"] = (

2422

client_settings[client_name]["secret"])

2423

3334

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

3335

client_name))

3336

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

3337

["secret"])

3338

2424

3339

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

2425

3340

for client_name in (set(old_client_settings)

2426

3341

- set(client_settings)):

2428

3343

for client_name in (set(client_settings)

2429

3344

- set(old_client_settings)):

2430

3345

clients_data[client_name] = client_settings[client_name]

2431

3346

2432

3347

# Create all client objects

2433

for client_name, client in clients_data.iteritems():

3348

for client_name, client in clients_data.items():

2434

3349

tcp_server.clients[client_name] = client_class(

2435

name = client_name, settings = client)

2436

3350

name=client_name,

3351

settings=client,

3352

server_settings=server_settings)

3353

2437

3354

if not tcp_server.clients:

2438

3355

logger.warning("No clients defined")

2439

2440

if not debug:

2441

try:

2442

with pidfile:

2443

pid = os.getpid()

2444

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

2445

del pidfile

2446

except IOError:

2447

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

2448

pidfilename, pid)

2449

except NameError:

2450

# "pidfile" was never created

2451

pass

3356

3357

if not foreground:

3358

if pidfile is not None:

3359

pid = os.getpid()

3360

try:

3361

with pidfile:

3362

print(pid, file=pidfile)

3363

except IOError:

3364

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

3365

pidfilename, pid)

3366

del pidfile

2452

3367

del pidfilename

2453

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

2454

2455

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

2456

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

2457

3368

3369

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

3370

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3371

lambda: main_loop.quit() and False)

3372

2458

3373

if use_dbus:

2459

class MandosDBusService(DBusObjectWithProperties):

3374

3375

@alternate_dbus_interfaces(

3376

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

3377

class MandosDBusService(DBusObjectWithObjectManager):

2460

3378

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

3379

2461

3380

def __init__(self):

2462

3381

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

3382

2463

3383

_interface = "se.recompile.Mandos"

2464

2465

@dbus_interface_annotations(_interface)

2466

def _foo(self):

2467

return { "org.freedesktop.DBus.Property"

2468

".EmitsChangedSignal":

2469

"false"}

2470

3384

2471

3385

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

2472

3386

def ClientAdded(self, objpath):

2473

3387

"D-Bus signal"

2474

3388

pass

2475

3389

2476

3390

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

2477

def ClientNotFound(self, fingerprint, address):

3391

def ClientNotFound(self, key_id, address):

2478

3392

"D-Bus signal"

2479

3393

pass

2480

3394

3395

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

3396

"true"})

2481

3397

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

2482

3398

def ClientRemoved(self, objpath, name):

2483

3399

"D-Bus signal"

2484

3400

pass

2485

3401

3402

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

3403

"true"})

2486

3404

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

2487

3405

def GetAllClients(self):

2488

3406

"D-Bus method"

2489

return dbus.Array(c.dbus_object_path

2490

for c in

2491

tcp_server.clients.itervalues())

2492

3407

return dbus.Array(c.dbus_object_path for c in

3408

tcp_server.clients.values())

3409

3410

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

3411

"true"})

2493

3412

@dbus.service.method(_interface,

2494

3413

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

2495

3414

def GetAllClientsWithProperties(self):

2496

3415

"D-Bus method"

2497

3416

return dbus.Dictionary(

2498

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

2499

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

3417

{c.dbus_object_path: c.GetAll(

3418

"se.recompile.Mandos.Client")

3419

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

2500

3420

signature="oa{sv}")

2501

3421

2502

3422

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

2503

3423

def RemoveClient(self, object_path):

2504

3424

"D-Bus method"

2505

for c in tcp_server.clients.itervalues():

3425

for c in tcp_server.clients.values():

2506

3426

if c.dbus_object_path == object_path:

2507

3427

del tcp_server.clients[c.name]

2508

3428

c.remove_from_connection()

2509

# Don't signal anything except ClientRemoved

3429

# Don't signal the disabling

2510

3430

c.disable(quiet=True)

2511

# Emit D-Bus signal

2512

self.ClientRemoved(object_path, c.name)

3431

# Emit D-Bus signal for removal

3432

self.client_removed_signal(c)

2513

3433

return

2514

3434

raise KeyError(object_path)

2515

3435

2516

3436

del _interface

2517

2518

class MandosDBusServiceTransitional(MandosDBusService):

2519

__metaclass__ = AlternateDBusNamesMetaclass

2520

mandos_dbus_service = MandosDBusServiceTransitional()

2521

3437

3438

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3439

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

3440

def GetManagedObjects(self):

3441

"""D-Bus method"""

3442

return dbus.Dictionary(

3443

{client.dbus_object_path:

3444

dbus.Dictionary(

3445

{interface: client.GetAll(interface)

3446

for interface in

3447

client._get_all_interface_names()})

3448

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

3449

3450

def client_added_signal(self, client):

3451

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

3452

if use_dbus:

3453

# New standard signal

3454

self.InterfacesAdded(

3455

client.dbus_object_path,

3456

dbus.Dictionary(

3457

{interface: client.GetAll(interface)

3458

for interface in

3459

client._get_all_interface_names()}))

3460

# Old signal

3461

self.ClientAdded(client.dbus_object_path)

3462

3463

def client_removed_signal(self, client):

3464

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

3465

if use_dbus:

3466

# New standard signal

3467

self.InterfacesRemoved(

3468

client.dbus_object_path,

3469

client._get_all_interface_names())

3470

# Old signal

3471

self.ClientRemoved(client.dbus_object_path,

3472

client.name)

3473

3474

mandos_dbus_service = MandosDBusService()

3475

3476

# Save modules to variables to exempt the modules from being

3477

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

3478

mp = multiprocessing

3479

wn = wnull

3480

2522

3481

def cleanup():

2523

3482

"Cleanup function; run on exit"

2524

service.cleanup()

2525

2526

multiprocessing.active_children()

3483

if zeroconf:

3484

service.cleanup()

3485

3486

mp.active_children()

3487

wn.close()

2527

3488

if not (tcp_server.clients or client_settings):

2528

3489

return

2529

3490

2530

3491

# Store client before exiting. Secrets are encrypted with key

2531

3492

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

2532

3493

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

2533

3494

clients = {}

2534

3495

with PGPEngine() as pgp:

2535

for client in tcp_server.clients.itervalues():

3496

for client in tcp_server.clients.values():

2536

3497

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

2537

3498

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

2538

3499

key)

2539

3500

client_dict = {}

2540

3501

2541

3502

# A list of attributes that can not be pickled

2542

3503

# + secret.

2543

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

2544

"checker"))

2545

for name, typ in (inspect.getmembers

2546

(dbus.service.Object)):

3504

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

3505

"checker", "server_settings"}

3506

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

3507

.Object):

2547

3508

exclude.add(name)

2548

3509

2549

3510

client_dict["encrypted_secret"] = (client

2550

3511

.encrypted_secret)

2551

3512

for attr in client.client_structure:

2552

3513

if attr not in exclude:

2553

3514

client_dict[attr] = getattr(client, attr)

2554

3515

2555

3516

clients[client.name] = client_dict

2556

3517

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

2557

3518

2558

3519

try:

2559

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

2560

prefix="clients-",

2561

dir=os.path.dirname

2562

(stored_state_path))

2563

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

2564

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

3520

with tempfile.NamedTemporaryFile(

3521

mode='wb',

3522

suffix=".pickle",

3523

prefix='clients-',

3524

dir=os.path.dirname(stored_state_path),

3525

delete=False) as stored_state:

3526

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

3527

protocol=2)

3528

tempname = stored_state.name

2565

3529

os.rename(tempname, stored_state_path)

2566

3530

except (IOError, OSError) as e:

2567

3531

if not debug:

2570

3534

except NameError:

2571

3535

pass

2572

3536

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

2573

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

3537

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

2574

3538

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

2575

3539

else:

2576

3540

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

2577

3541

exc_info=e)

2578

raise e

2579

3542

raise

3543

2580

3544

# Delete all clients, and settings from config

2581

3545

while tcp_server.clients:

2582

3546

name, client = tcp_server.clients.popitem()

2583

3547

if use_dbus:

2584

3548

client.remove_from_connection()

2585

# Don't signal anything except ClientRemoved

3549

# Don't signal the disabling

2586

3550

client.disable(quiet=True)

3551

# Emit D-Bus signal for removal

2587

3552

if use_dbus:

2588

# Emit D-Bus signal

2589

mandos_dbus_service.ClientRemoved(client

2590

.dbus_object_path,

2591

client.name)

3553

mandos_dbus_service.client_removed_signal(client)

2592

3554

client_settings.clear()

2593

3555

2594

3556

atexit.register(cleanup)

2595

2596

for client in tcp_server.clients.itervalues():

3557

3558

for client in tcp_server.clients.values():

2597

3559

if use_dbus:

2598

# Emit D-Bus signal

2599

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3560

# Emit D-Bus signal for adding

3561

mandos_dbus_service.client_added_signal(client)

2600

3562

# Need to initiate checking of clients

2601

3563

if client.enabled:

2602

3564

client.init_checker()

2603

3565

2604

3566

tcp_server.enable()

2605

3567

tcp_server.server_activate()

2606

3568

2607

3569

# Find out what port we got

2608

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

3570

if zeroconf:

3571

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

2609

3572

if use_ipv6:

2610

3573

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

2611

3574

" flowinfo %d, scope_id %d",

2613

3576

else: # IPv4

2614

3577

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

2615

3578

*tcp_server.socket.getsockname())

2616

2617

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

2618

3579

3580

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

3581

2619

3582

try:

2620

# From the Avahi example code

2621

try:

2622

service.activate()

2623

except dbus.exceptions.DBusException as error:

2624

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

2625

cleanup()

2626

sys.exit(1)

2627

# End of Avahi example code

2628

2629

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

2630

lambda *args, **kwargs:

2631

(tcp_server.handle_request

2632

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

2633

3583

if zeroconf:

3584

# From the Avahi example code

3585

try:

3586

service.activate()

3587

except dbus.exceptions.DBusException as error:

3588

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

3589

cleanup()

3590

sys.exit(1)

3591

# End of Avahi example code

3592

3593

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

3594

lambda *args, **kwargs:

3595

(tcp_server.handle_request

3596

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

3597

2634

3598

logger.debug("Starting main loop")

2635

3599

main_loop.run()

2636

3600

except AvahiError as error:

2645

3609

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

2646

3610

cleanup()

2647

3611

3612

2648

3613

if __name__ == '__main__':

2649

3614

main()