/mandos/trunk : revision 1092

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

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

212

302

213

303

class AvahiError(Exception):

214

304

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

215

305

self.value = value

216

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

217

def __unicode__(self):

218

return unicode(repr(self.value))

306

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

307

**kwargs)

308

219

309

220

310

class AvahiServiceError(AvahiError):

221

311

pass

222

312

313

223

314

class AvahiGroupError(AvahiError):

224

315

pass

225

316

226

317

227

318

class AvahiService(object):

228

319

"""An Avahi (Zeroconf) service.

229

320

230

321

Attributes:

231

322

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

232

323

Used to optionally bind to the specified interface.

233

324

name: string; Example: 'Mandos'

234

325

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

235

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

326

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

236

327

port: integer; what port to announce

237

328

TXT: list of strings; TXT record for the service

238

329

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

244

335

server: D-Bus Server

245

336

bus: dbus.SystemBus()

246

337

"""

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

def rename(self):

364

365

def rename(self, remove=True):

266

366

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

267

367

if self.rename_count >= self.max_renames:

268

368

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

269

369

" after %i retries, exiting.",

270

370

self.rename_count)

271

371

raise AvahiServiceError("Too many renames")

272

self.name = unicode(self.server

273

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

274

375

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

275

376

self.name)

276

self.remove()

377

if remove:

378

self.remove()

277

379

try:

278

380

self.add()

279

381

except dbus.exceptions.DBusException as error:

280

logger.critical("DBusException: %s", error)

281

self.cleanup()

282

os._exit(1)

283

self.rename_count += 1

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

284

391

def remove(self):

285

392

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

286

393

if self.entry_group_state_changed_match is not None:

288

395

self.entry_group_state_changed_match = None

289

396

if self.group is not None:

290

397

self.group.Reset()

398

291

399

def add(self):

292

400

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

293

401

self.remove()

310

418

dbus.UInt16(self.port),

311

419

avahi.string_array_to_txt_array(self.TXT))

312

420

self.group.Commit()

421

313

422

def entry_group_state_changed(self, state, error):

314

423

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

315

424

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

316

425

317

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

318

427

logger.debug("Zeroconf service established.")

319

428

elif state == avahi.ENTRY_GROUP_COLLISION:

321

430

self.rename()

322

431

elif state == avahi.ENTRY_GROUP_FAILURE:

323

432

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

324

unicode(error))

325

raise AvahiGroupError("State changed: %s"

326

% unicode(error))

433

str(error))

434

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

435

327

436

def cleanup(self):

328

437

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

329

438

if self.group is not None:

334

443

pass

335

444

self.group = None

336

445

self.remove()

446

337

447

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

338

448

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

339

449

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

340

bad_states = { avahi.SERVER_INVALID:

341

"Zeroconf server invalid",

342

avahi.SERVER_REGISTERING: None,

343

avahi.SERVER_COLLISION:

344

"Zeroconf server name collision",

345

avahi.SERVER_FAILURE:

346

"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

}

347

456

if state in bad_states:

348

457

if bad_states[state] is not None:

349

458

if error is None:

352

461

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

353

462

self.cleanup()

354

463

elif state == avahi.SERVER_RUNNING:

355

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)

356

476

else:

357

477

if error is None:

358

478

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

359

479

else:

360

480

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

481

361

482

def activate(self):

362

483

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

363

484

if self.server is None:

367

488

follow_name_owner_changes=True),

368

489

avahi.DBUS_INTERFACE_SERVER)

369

490

self.server.connect_to_signal("StateChanged",

370

self.server_state_changed)

491

self.server_state_changed)

371

492

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

372

493

494

373

495

class AvahiServiceToSyslog(AvahiService):

374

def rename(self):

496

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

375

497

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

376

ret = AvahiService.rename(self)

377

syslogger.setFormatter(logging.Formatter

378

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

379

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

380

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

381

502

return ret

382

503

383

def timedelta_to_milliseconds(td):

384

"Convert a datetime.timedelta() to milliseconds"

385

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

386

+ (td.seconds * 1000)

387

+ (td.microseconds // 1000))

388

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

816

389

817

class Client(object):

390

818

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

391

819

392

820

Attributes:

393

821

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

394

822

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

396

824

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

397

825

to see if the client lives.

398

826

'None' if no process is running.

399

checker_callback_tag: a gobject event source tag, or None

827

checker_callback_tag: a GLib event source tag, or None

400

828

checker_command: string; External command which is run to check

401

829

if client lives. %() expansions are done at

402

830

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

403

831

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

404

checker_initiator_tag: a gobject event source tag, or None

832

checker_initiator_tag: a GLib event source tag, or None

405

833

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

406

834

client_structure: Object describing what attributes a client has

407

835

and is used for storing the client at exit

408

836

current_checker_command: string; current running checker_command

409

disable_initiator_tag: a gobject event source tag, or None

837

disable_initiator_tag: a GLib event source tag, or None

410

838

enabled: bool()

411

839

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

412

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

413

843

host: string; available for use by the checker command

414

844

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

415

845

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

417

847

last_checker_status: integer between 0 and 255 reflecting exit

418

848

status of last checker. -1 reflects crashed

419

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

420

852

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

421

853

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

422

854

D-Bus identifiers

427

859

runtime_expansions: Allowed attributes for runtime expansion.

428

860

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

429

861

disabled, or None

862

server_settings: The server_settings dict from main()

430

863

"""

431

864

432

865

runtime_expansions = ("approval_delay", "approval_duration",

433

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

434

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

866

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

867

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

868

"last_approval_request", "last_checked_ok",

435

869

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

436

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

437

"extended_timeout": "15m",

438

"interval": "2m",

439

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

440

"host": "",

441

"approval_delay": "0s",

442

"approval_duration": "1s",

443

"approved_by_default": "True",

444

"enabled": "True",

445

}

446

447

def timeout_milliseconds(self):

448

"Return the 'timeout' attribute in milliseconds"

449

return timedelta_to_milliseconds(self.timeout)

450

451

def extended_timeout_milliseconds(self):

452

"Return the 'extended_timeout' attribute in milliseconds"

453

return timedelta_to_milliseconds(self.extended_timeout)

454

455

def interval_milliseconds(self):

456

"Return the 'interval' attribute in milliseconds"

457

return timedelta_to_milliseconds(self.interval)

458

459

def approval_delay_milliseconds(self):

460

return timedelta_to_milliseconds(self.approval_delay)

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

}

461

881

462

882

@staticmethod

463

883

def config_parser(config):

471

891

for client_name in config.sections():

472

892

section = dict(config.items(client_name))

473

893

client = settings[client_name] = {}

474

894

475

895

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

476

896

# Reformat values from string types to Python types

477

897

client["approved_by_default"] = config.getboolean(

478

898

client_name, "approved_by_default")

479

899

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

480

900

"enabled")

481

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

482

907

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

483

908

.replace(" ", ""))

484

909

if "secret" in section:

485

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

910

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

911

.encode("utf-8"),

912

"base64")

486

913

elif "secfile" in section:

487

914

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

488

915

(section["secfile"])),

489

916

"rb") as secfile:

490

917

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

491

918

else:

492

raise TypeError("No secret or secfile for section %s"

493

% section)

919

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

920

.format(section))

494

921

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

495

922

client["extended_timeout"] = string_to_delta(

496

923

section["extended_timeout"])

503

930

client["last_approval_request"] = None

504

931

client["last_checked_ok"] = None

505

932

client["last_checker_status"] = -2

506

933

507

934

return settings

508

509

510

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

511

"""Note: the 'checker' key in 'config' sets the

512

'checker_command' attribute and *not* the 'checker'

513

attribute."""

935

936

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

514

937

self.name = name

938

if server_settings is None:

939

server_settings = {}

940

self.server_settings = server_settings

515

941

# adding all client settings

516

for setting, value in settings.iteritems():

942

for setting, value in settings.items():

517

943

setattr(self, setting, value)

518

944

519

945

if self.enabled:

520

946

if not hasattr(self, "last_enabled"):

521

947

self.last_enabled = datetime.datetime.utcnow()

525

951

else:

526

952

self.last_enabled = None

527

953

self.expires = None

528

954

529

955

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

530

# Uppercase and remove spaces from fingerprint for later

531

# comparison purposes with return value from the fingerprint()

532

# function

956

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

533

957

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

534

958

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

535

959

datetime.datetime.utcnow())

542

966

self.current_checker_command = None

543

967

self.approved = None

544

968

self.approvals_pending = 0

545

self.changedstate = (multiprocessing_manager

546

.Condition(multiprocessing_manager

547

.Lock()))

548

self.client_structure = [attr for attr in

549

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

550

973

if not attr.startswith("_")]

551

974

self.client_structure.append("client_structure")

552

553

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

554

lambda obj:

555

isinstance(obj,

556

property)):

975

976

for name, t in inspect.getmembers(

977

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

557

978

if not name.startswith("_"):

558

979

self.client_structure.append(name)

559

980

560

981

# Send notice to process children that client state has changed

561

982

def send_changedstate(self):

562

983

with self.changedstate:

563

984

self.changedstate.notify_all()

564

985

565

986

def enable(self):

566

987

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

567

988

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

568

989

# Already enabled

569

990

return

570

self.send_changedstate()

571

991

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

572

992

self.enabled = True

573

993

self.last_enabled = datetime.datetime.utcnow()

574

994

self.init_checker()

575

995

self.send_changedstate()

996

576

997

def disable(self, quiet=True):

577

998

"""Disable this client."""

578

999

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

579

1000

return False

580

1001

if not quiet:

581

self.send_changedstate()

582

if not quiet:

583

1002

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

584

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

585

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)

586

1005

self.disable_initiator_tag = None

587

1006

self.expires = None

588

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

589

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)

590

1009

self.checker_initiator_tag = None

591

1010

self.stop_checker()

592

1011

self.enabled = False

593

# 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

594

1015

return False

595

1016

596

1017

def __del__(self):

597

1018

self.disable()

598

1019

599

1020

def init_checker(self):

600

1021

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

601

1022

# and every interval from then on.

602

self.checker_initiator_tag = (gobject.timeout_add

603

(self.interval_milliseconds(),

604

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)

605

1028

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

606

self.disable_initiator_tag = (gobject.timeout_add

607

(self.timeout_milliseconds(),

608

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)

609

1033

# Also start a new checker *right now*.

610

1034

self.start_checker()

611

612

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

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

613

1038

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

614

1039

self.checker_callback_tag = None

615

1040

self.checker = None

616

if os.WIFEXITED(condition):

617

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

618

1048

if self.last_checker_status == 0:

619

1049

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

620

1050

vars(self))

621

1051

self.checked_ok()

622

1052

else:

623

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

624

vars(self))

1053

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

625

1054

else:

626

1055

self.last_checker_status = -1

1056

self.last_checker_signal = -returncode

627

1057

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

628

1058

vars(self))

629

1059

return False

1060

630

1061

def checked_ok(self):

631

1062

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

632

1063

self.last_checked_ok = datetime.datetime.utcnow()

633

1064

self.last_checker_status = 0

1065

self.last_checker_signal = None

634

1066

self.bump_timeout()

635

1067

636

1068

def bump_timeout(self, timeout=None):

637

1069

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

638

1070

if timeout is None:

639

1071

timeout = self.timeout

640

1072

if self.disable_initiator_tag is not None:

641

gobject.source_remove(self.disable_initiator_tag)

1073

GLib.source_remove(self.disable_initiator_tag)

1074

self.disable_initiator_tag = None

642

1075

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

643

self.disable_initiator_tag = (gobject.timeout_add

644

(timedelta_to_milliseconds

645

(timeout), self.disable))

1076

self.disable_initiator_tag = GLib.timeout_add(

1077

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

646

1078

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

647

1079

648

1080

def need_approval(self):

649

1081

self.last_approval_request = datetime.datetime.utcnow()

650

1082

651

1083

def start_checker(self):

652

1084

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

653

1085

654

1086

If a checker already exists, leave it running and do

655

1087

nothing."""

656

1088

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

657

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

658

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

659

# client would inevitably timeout, since no checker would get

660

# 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

661

1093

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

662

1094

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

663

1095

# should be.

664

665

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

666

try:

667

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

668

except (AttributeError, OSError) as error:

669

if (isinstance(error, OSError)

670

and error.errno != errno.ECHILD):

671

raise error

672

else:

673

if pid:

674

logger.warning("Checker was a zombie")

675

gobject.source_remove(self.checker_callback_tag)

676

self.checker_callback(pid, status,

677

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

678

1101

# Start a new checker if needed

679

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}

680

1107

try:

681

# In case checker_command has exactly one % operator

682

command = self.checker_command % self.host

683

except TypeError:

684

# Escape attributes for the shell

685

escaped_attrs = dict(

686

(attr,

687

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

688

errors=

689

'replace')))

690

for attr in

691

self.runtime_expansions)

692

693

try:

694

command = self.checker_command % escaped_attrs

695

except TypeError as error:

696

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

697

' %s', self.checker_command, error)

698

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

699

1114

self.current_checker_command = command

700

try:

701

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

702

command, self.name)

703

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

704

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

705

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

706

# always replaced by /dev/null.)

707

self.checker = subprocess.Popen(command,

708

close_fds=True,

709

shell=True, cwd="/")

710

self.checker_callback_tag = (gobject.child_watch_add

711

(self.checker.pid,

712

self.checker_callback,

713

data=command))

714

# The checker may have completed before the gobject

715

# watch was added. Check for this.

716

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

717

if pid:

718

gobject.source_remove(self.checker_callback_tag)

719

self.checker_callback(pid, status, command)

720

except OSError as error:

721

logger.error("Failed to start subprocess: %s",

722

error)

723

# 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

724

1141

return True

725

1142

726

1143

def stop_checker(self):

727

1144

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

728

1145

if self.checker_callback_tag:

729

gobject.source_remove(self.checker_callback_tag)

1146

GLib.source_remove(self.checker_callback_tag)

730

1147

self.checker_callback_tag = None

731

1148

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

732

1149

return

733

1150

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

734

try:

735

os.kill(self.checker.pid, signal.SIGTERM)

736

#time.sleep(0.5)

737

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

738

# os.kill(self.checker.pid, signal.SIGKILL)

739

except OSError as error:

740

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

741

raise

1151

self.checker.terminate()

742

1152

self.checker = None

743

1153

744

1154

745

def dbus_service_property(dbus_interface, signature="v",

746

access="readwrite", byte_arrays=False):

1155

def dbus_service_property(dbus_interface,

1156

signature="v",

1157

access="readwrite",

1158

byte_arrays=False):

747

1159

"""Decorators for marking methods of a DBusObjectWithProperties to

748

1160

become properties on the D-Bus.

749

1161

750

1162

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

751

1163

and with one argument by "Set".

752

1164

753

1165

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

754

1166

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

755

1167

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

758

1170

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

759

1171

if byte_arrays and signature != "ay":

760

1172

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

761

" signature %r" % signature)

1173

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

1174

762

1175

def decorator(func):

763

1176

func._dbus_is_property = True

764

1177

func._dbus_interface = dbus_interface

767

1180

func._dbus_name = func.__name__

768

1181

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

769

1182

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

770

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1183

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

771

1184

return func

1185

772

1186

return decorator

773

1187

774

1188

775

1189

def dbus_interface_annotations(dbus_interface):

776

"""Decorator for marking functions returning interface annotations.

777

1190

"""Decorator for marking functions returning interface annotations

1191

778

1192

Usage:

779

1193

780

1194

@dbus_interface_annotations("org.example.Interface")

781

1195

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

782

1196

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

783

1197

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

784

1198

"false"}

785

1199

"""

1200

786

1201

def decorator(func):

787

1202

func._dbus_is_interface = True

788

1203

func._dbus_interface = dbus_interface

789

1204

func._dbus_name = dbus_interface

790

1205

return func

1206

1207

return decorator

1208

1209

1210

def dbus_annotations(annotations):

1211

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

1212

Usage:

1213

1214

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

1215

"org.freedesktop.DBus.Property."

1216

"EmitsChangedSignal": "false"})

1217

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

1218

access="r")

1219

def Property_dbus_property(self):

1220

return dbus.Boolean(False)

1221

1222

See also the DBusObjectWithAnnotations class.

1223

"""

1224

1225

def decorator(func):

1226

func._dbus_annotations = annotations

1227

return func

1228

791

1229

return decorator

792

1230

793

1231

794

1232

class DBusPropertyException(dbus.exceptions.DBusException):

795

1233

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

796

1234

"""

797

def __unicode__(self):

798

return unicode(str(self))

1235

pass

799

1236

800

1237

801

1238

class DBusPropertyAccessException(DBusPropertyException):

810

1247

pass

811

1248

812

1249

813

class DBusObjectWithProperties(dbus.service.Object):

814

"""A D-Bus object with properties.

815

816

Classes inheriting from this can use the dbus_service_property

817

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

818

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.

819

1255

"""

820

1256

821

1257

@staticmethod

822

1258

def _is_dbus_thing(thing):

823

1259

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

824

1260

825

1261

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

826

1262

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

827

1263

"""

828

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

1264

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

829

1265

False)

830

1266

831

1267

def _get_all_dbus_things(self, thing):

832

1268

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

833

1269

"""

834

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

1270

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

835

1271

athing.__get__(self))

836

1272

for cls in self.__class__.__mro__

837

1273

for name, athing in

838

inspect.getmembers(cls,

839

self._is_dbus_thing(thing)))

840

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

841

1347

def _get_dbus_property(self, interface_name, property_name):

842

1348

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

843

1349

property with the specified name and interface.

844

1350

"""

845

for cls in self.__class__.__mro__:

846

for name, value in (inspect.getmembers

847

(cls,

848

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

849

1354

if (value._dbus_name == property_name

850

1355

and value._dbus_interface == interface_name):

851

1356

return value.__get__(self)

852

1357

853

1358

# No such property

854

raise DBusPropertyNotFound(self.dbus_object_path + ":"

855

+ interface_name + "."

856

+ property_name)

857

858

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

859

1373

out_signature="v")

860

1374

def Get(self, interface_name, property_name):

861

1375

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

867

1381

if not hasattr(value, "variant_level"):

868

1382

return value

869

1383

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

870

1384

871

1385

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

872

1386

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

873

1387

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

879

1393

# The byte_arrays option is not supported yet on

880

1394

# signatures other than "ay".

881

1395

if prop._dbus_signature != "ay":

882

raise ValueError

1396

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

1397

"'ay' signature {!r}"

1398

.format(prop._dbus_signature))

883

1399

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

884

1400

for byte in value))

885

1401

prop(value)

886

887

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

1402

1403

@dbus.service.method(dbus.PROPERTIES_IFACE,

1404

in_signature="s",

888

1405

out_signature="a{sv}")

889

1406

def GetAll(self, interface_name):

890

1407

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

891

1408

standard.

892

1409

893

1410

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

894

1411

"""

895

1412

properties = {}

905

1422

if not hasattr(value, "variant_level"):

906

1423

properties[name] = value

907

1424

continue

908

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

909

value.variant_level+1)

1425

properties[name] = type(value)(

1426

value, variant_level=value.variant_level + 1)

910

1427

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

911

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

912

1437

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

913

1438

out_signature="s",

914

1439

path_keyword='object_path',

915

1440

connection_keyword='connection')

916

1441

def Introspect(self, object_path, connection):

917

1442

"""Overloading of standard D-Bus method.

918

1443

919

1444

Inserts property tags and interface annotation tags.

920

1445

"""

921

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

922

connection)

1446

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1447

object_path,

1448

connection)

923

1449

try:

924

1450

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

1451

925

1452

def make_tag(document, name, prop):

926

1453

e = document.createElement("property")

927

1454

e.setAttribute("name", name)

928

1455

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

929

1456

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

930

1457

return e

1458

931

1459

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

932

1460

# Add property tags

933

1461

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

936

1464

if prop._dbus_interface

937

1465

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

938

1466

if_tag.appendChild(tag)

939

# Add interface annotation tags

940

for annotation, value in dict(

941

itertools.chain(

942

*(annotations().iteritems()

943

for name, annotations in

944

self._get_all_dbus_things("interface")

945

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

946

))).iteritems():

947

attr_tag = document.createElement("annotation")

948

attr_tag.setAttribute("name", annotation)

949

attr_tag.setAttribute("value", value)

950

if_tag.appendChild(attr_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)

951

1483

# Add the names to the return values for the

952

1484

# "org.freedesktop.DBus.Properties" methods

953

1485

if (if_tag.getAttribute("name")

968

1500

except (AttributeError, xml.dom.DOMException,

969

1501

xml.parsers.expat.ExpatError) as error:

970

1502

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

971

error)

972

return xmlstring

973

974

975

def datetime_to_dbus (dt, variant_level=0):

1503

exc_info=error)

1504

return xmlstring

1505

1506

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

976

1579

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

977

1580

if dt is None:

978

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

979

return dbus.String(dt.isoformat(),

980

variant_level=variant_level)

981

982

983

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

984

.__metaclass__):

985

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

986

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

987

1607

"""

988

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

989

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

990

# methods, signals, or properties in them

991

old_interface_names = []

992

for base in (b for b in bases

993

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

994

# Go though all attributes of the base class

995

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

996

1616

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

997

1617

# with the wrong interface name

998

1618

if (not hasattr(attribute, "_dbus_interface")

999

or not attribute._dbus_interface

1000

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

1619

or not attribute._dbus_interface.startswith(

1620

orig_interface_name)):

1001

1621

continue

1002

1622

# Create an alternate D-Bus interface name based on

1003

1623

# the current name

1004

alt_interface = (attribute._dbus_interface

1005

.replace("se.recompile.Mandos",

1006

"se.bsnet.fukt.Mandos"))

1007

if alt_interface != attribute._dbus_interface:

1008

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)

1009

1627

# Is this a D-Bus signal?

1010

1628

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

1011

# Extract the original non-method function by

1012

# black magic

1013

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(

1014

1633

zip(attribute.func_code.co_freevars,

1015

attribute.__closure__))["func"]

1016

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

1017

1641

# Create a new, but exactly alike, function

1018

1642

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

1019

1643

# with the alternate D-Bus interface name

1020

new_function = (dbus.service.signal

1021

(alt_interface,

1022

attribute._dbus_signature)

1023

(types.FunctionType(

1024

nonmethod_func.func_code,

1025

nonmethod_func.func_globals,

1026

nonmethod_func.func_name,

1027

nonmethod_func.func_defaults,

1028

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

1648

# Copy annotations, if any

1649

try:

1650

new_function._dbus_annotations = dict(

1651

attribute._dbus_annotations)

1652

except AttributeError:

1653

pass

1654

1029

1655

# Define a creator of a function to call both the

1030

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

1031

# 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

1032

1659

def fixscope(func1, func2):

1033

1660

"""This function is a scope container to pass

1034

1661

func1 and func2 to the "call_both" function

1035

1662

outside of its arguments"""

1663

1664

@functools.wraps(func2)

1036

1665

def call_both(*args, **kwargs):

1037

1666

"""This function will emit two D-Bus

1038

1667

signals by calling func1 and func2"""

1039

1668

func1(*args, **kwargs)

1040

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

1041

1676

return call_both

1042

1677

# Create the "call_both" function and add it to

1043

1678

# the class

1044

attr[attrname] = fixscope(attribute,

1045

new_function)

1679

attr[attrname] = fixscope(attribute, new_function)

1046

1680

# Is this a D-Bus method?

1047

1681

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

1048

1682

# Create a new, but exactly alike, function

1049

1683

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

1050

1684

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

1051

1685

# to the class.

1052

attr[attrname] = (dbus.service.method

1053

(alt_interface,

1054

attribute._dbus_in_signature,

1055

attribute._dbus_out_signature)

1056

(types.FunctionType

1057

(attribute.func_code,

1058

attribute.func_globals,

1059

attribute.func_name,

1060

attribute.func_defaults,

1061

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

1692

# Copy annotations, if any

1693

try:

1694

attr[attrname]._dbus_annotations = dict(

1695

attribute._dbus_annotations)

1696

except AttributeError:

1697

pass

1062

1698

# Is this a D-Bus property?

1063

1699

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

1064

1700

# Create a new, but exactly alike, function

1065

1701

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

1066

1702

# property with the alternate D-Bus interface

1067

1703

# name. Add it to the class.

1068

attr[attrname] = (dbus_service_property

1069

(alt_interface,

1070

attribute._dbus_signature,

1071

attribute._dbus_access,

1072

attribute

1073

._dbus_get_args_options

1074

["byte_arrays"])

1075

(types.FunctionType

1076

(attribute.func_code,

1077

attribute.func_globals,

1078

attribute.func_name,

1079

attribute.func_defaults,

1080

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

1710

# Copy annotations, if any

1711

try:

1712

attr[attrname]._dbus_annotations = dict(

1713

attribute._dbus_annotations)

1714

except AttributeError:

1715

pass

1081

1716

# Is this a D-Bus interface?

1082

1717

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

1083

1718

# Create a new, but exactly alike, function

1084

1719

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

1085

1720

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

1086

1721

# to the class.

1087

attr[attrname] = (dbus_interface_annotations

1088

(alt_interface)

1089

(types.FunctionType

1090

(attribute.func_code,

1091

attribute.func_globals,

1092

attribute.func_name,

1093

attribute.func_defaults,

1094

attribute.func_closure)))

1095

# Deprecate all old interfaces

1096

basename="_AlternateDBusNamesMetaclass_interface_annotation{0}"

1097

for old_interface_name in old_interface_names:

1098

@dbus_interface_annotations(old_interface_name)

1099

def func(self):

1100

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

1101

# Find an unused name

1102

for aname in (basename.format(i) for i in

1103

itertools.count()):

1104

if aname not in attr:

1105

attr[aname] = func

1106

break

1107

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

1108

1109

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

1110

1756

class ClientDBus(Client, DBusObjectWithProperties):

1111

1757

"""A Client class using D-Bus

1112

1758

1113

1759

Attributes:

1114

1760

dbus_object_path: dbus.ObjectPath

1115

1761

bus: dbus.SystemBus()

1116

1762

"""

1117

1763

1118

1764

runtime_expansions = (Client.runtime_expansions

1119

+ ("dbus_object_path",))

1120

1765

+ ("dbus_object_path", ))

1766

1767

_interface = "se.recompile.Mandos.Client"

1768

1121

1769

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

1122

1123

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

1770

1771

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

1124

1772

self.bus = bus

1125

1773

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

1126

1774

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

1127

1775

# the D-Bus

1128

client_object_name = unicode(self.name).translate(

1776

client_object_name = str(self.name).translate(

1129

1777

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

1130

1778

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

1131

self.dbus_object_path = (dbus.ObjectPath

1132

("/clients/" + client_object_name))

1779

self.dbus_object_path = dbus.ObjectPath(

1780

"/clients/" + client_object_name)

1133

1781

DBusObjectWithProperties.__init__(self, self.bus,

1134

1782

self.dbus_object_path)

1135

1136

def notifychangeproperty(transform_func,

1137

dbus_name, type_func=lambda x: x,

1138

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

1139

1789

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

1140

1790

its changes to DBus.

1141

1791

1142

1792

transform_fun: Function that takes a value and a variant_level

1143

1793

and transforms it to a D-Bus type.

1144

1794

dbus_name: D-Bus name of the variable

1146

1796

to the D-Bus. Default: no transform

1147

1797

variant_level: D-Bus variant level. Default: 1

1148

1798

"""

1149

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

1799

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

1800

1150

1801

def setter(self, value):

1151

1802

if hasattr(self, "dbus_object_path"):

1152

1803

if (not hasattr(self, attrname) or

1153

1804

type_func(getattr(self, attrname, None))

1154

1805

!= type_func(value)):

1155

dbus_value = transform_func(type_func(value),

1156

variant_level

1157

=variant_level)

1158

self.PropertyChanged(dbus.String(dbus_name),

1159

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

1160

1821

setattr(self, attrname, value)

1161

1822

1162

1823

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

1163

1164

1824

1165

1825

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1166

1826

approvals_pending = notifychangeproperty(dbus.Boolean,

1167

1827

"ApprovalPending",

1168

type_func = bool)

1828

type_func=bool)

1169

1829

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

1170

1830

last_enabled = notifychangeproperty(datetime_to_dbus,

1171

1831

"LastEnabled")

1172

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

1173

type_func = lambda checker:

1174

checker is not None)

1832

checker = notifychangeproperty(

1833

dbus.Boolean, "CheckerRunning",

1834

type_func=lambda checker: checker is not None)

1175

1835

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1176

1836

"LastCheckedOK")

1177

1837

last_checker_status = notifychangeproperty(dbus.Int16,

1180

1840

datetime_to_dbus, "LastApprovalRequest")

1181

1841

approved_by_default = notifychangeproperty(dbus.Boolean,

1182

1842

"ApprovedByDefault")

1183

approval_delay = notifychangeproperty(dbus.UInt64,

1184

"ApprovalDelay",

1185

type_func =

1186

timedelta_to_milliseconds)

1843

approval_delay = notifychangeproperty(

1844

dbus.UInt64, "ApprovalDelay",

1845

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

1187

1846

approval_duration = notifychangeproperty(

1188

1847

dbus.UInt64, "ApprovalDuration",

1189

type_func = timedelta_to_milliseconds)

1848

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

1190

1849

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

1191

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

1192

type_func =

1193

timedelta_to_milliseconds)

1850

timeout = notifychangeproperty(

1851

dbus.UInt64, "Timeout",

1852

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

1194

1853

extended_timeout = notifychangeproperty(

1195

1854

dbus.UInt64, "ExtendedTimeout",

1196

type_func = timedelta_to_milliseconds)

1197

interval = notifychangeproperty(dbus.UInt64,

1198

"Interval",

1199

type_func =

1200

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)

1201

1859

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

1202

1860

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

1861

invalidate_only=True)

1862

1203

1863

del notifychangeproperty

1204

1864

1205

1865

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

1206

1866

try:

1207

1867

self.remove_from_connection()

1210

1870

if hasattr(DBusObjectWithProperties, "__del__"):

1211

1871

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

1212

1872

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

1213

1214

def checker_callback(self, pid, condition, command,

1215

*args, **kwargs):

1216

self.checker_callback_tag = None

1217

self.checker = None

1218

if os.WIFEXITED(condition):

1219

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:

1220

1881

# Emit D-Bus signal

1221

1882

self.CheckerCompleted(dbus.Int16(exitstatus),

1222

dbus.Int64(condition),

1883

# This is specific to GNU libC

1884

dbus.Int64(exitstatus << 8),

1223

1885

dbus.String(command))

1224

1886

else:

1225

1887

# Emit D-Bus signal

1226

1888

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

1227

dbus.Int64(condition),

1889

dbus.Int64(

1890

# This is specific to GNU libC

1891

(exitstatus << 8)

1892

| self.last_checker_signal),

1228

1893

dbus.String(command))

1229

1230

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

1231

*args, **kwargs)

1232

1894

return ret

1895

1233

1896

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

1234

old_checker = self.checker

1235

if self.checker is not None:

1236

old_checker_pid = self.checker.pid

1237

else:

1238

old_checker_pid = None

1897

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

1239

1898

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

1240

1899

# Only if new checker process was started

1241

1900

if (self.checker is not None

1243

1902

# Emit D-Bus signal

1244

1903

self.CheckerStarted(self.current_checker_command)

1245

1904

return r

1246

1905

1247

1906

def _reset_approved(self):

1248

1907

self.approved = None

1249

1908

return False

1250

1909

1251

1910

def approve(self, value=True):

1252

self.send_changedstate()

1253

1911

self.approved = value

1254

gobject.timeout_add(timedelta_to_milliseconds

1255

(self.approval_duration),

1256

self._reset_approved)

1257

1258

1259

## D-Bus methods, signals & properties

1260

_interface = "se.recompile.Mandos.Client"

1261

1262

## Interfaces

1263

1264

@dbus_interface_annotations(_interface)

1265

def _foo(self):

1266

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

1267

"false"}

1268

1269

## Signals

1270

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

1271

1922

# CheckerCompleted - signal

1272

1923

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

1273

1924

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

1274

1925

"D-Bus signal"

1275

1926

pass

1276

1927

1277

1928

# CheckerStarted - signal

1278

1929

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

1279

1930

def CheckerStarted(self, command):

1280

1931

"D-Bus signal"

1281

1932

pass

1282

1933

1283

1934

# PropertyChanged - signal

1935

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

1284

1936

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

1285

1937

def PropertyChanged(self, property, value):

1286

1938

"D-Bus signal"

1287

1939

pass

1288

1940

1289

1941

# GotSecret - signal

1290

1942

@dbus.service.signal(_interface)

1291

1943

def GotSecret(self):

1294

1946

server to mandos-client

1295

1947

"""

1296

1948

pass

1297

1949

1298

1950

# Rejected - signal

1299

1951

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

1300

1952

def Rejected(self, reason):

1301

1953

"D-Bus signal"

1302

1954

pass

1303

1955

1304

1956

# NeedApproval - signal

1305

1957

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

1306

1958

def NeedApproval(self, timeout, default):

1307

1959

"D-Bus signal"

1308

1960

return self.need_approval()

1309

1310

## Methods

1311

1961

1962

# Methods

1963

1312

1964

# Approve - method

1313

1965

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

1314

1966

def Approve(self, value):

1315

1967

self.approve(value)

1316

1968

1317

1969

# CheckedOK - method

1318

1970

@dbus.service.method(_interface)

1319

1971

def CheckedOK(self):

1320

1972

self.checked_ok()

1321

1973

1322

1974

# Enable - method

1975

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

1323

1976

@dbus.service.method(_interface)

1324

1977

def Enable(self):

1325

1978

"D-Bus method"

1326

1979

self.enable()

1327

1980

1328

1981

# StartChecker - method

1982

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

1329

1983

@dbus.service.method(_interface)

1330

1984

def StartChecker(self):

1331

1985

"D-Bus method"

1332

1986

self.start_checker()

1333

1987

1334

1988

# Disable - method

1989

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

1335

1990

@dbus.service.method(_interface)

1336

1991

def Disable(self):

1337

1992

"D-Bus method"

1338

1993

self.disable()

1339

1994

1340

1995

# StopChecker - method

1996

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

1341

1997

@dbus.service.method(_interface)

1342

1998

def StopChecker(self):

1343

1999

self.stop_checker()

1344

1345

## Properties

1346

2000

2001

# Properties

2002

1347

2003

# ApprovalPending - property

1348

2004

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

1349

2005

def ApprovalPending_dbus_property(self):

1350

2006

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

1351

2007

1352

2008

# ApprovedByDefault - property

1353

@dbus_service_property(_interface, signature="b",

2009

@dbus_service_property(_interface,

2010

signature="b",

1354

2011

access="readwrite")

1355

2012

def ApprovedByDefault_dbus_property(self, value=None):

1356

2013

if value is None: # get

1357

2014

return dbus.Boolean(self.approved_by_default)

1358

2015

self.approved_by_default = bool(value)

1359

2016

1360

2017

# ApprovalDelay - property

1361

@dbus_service_property(_interface, signature="t",

2018

@dbus_service_property(_interface,

2019

signature="t",

1362

2020

access="readwrite")

1363

2021

def ApprovalDelay_dbus_property(self, value=None):

1364

2022

if value is None: # get

1365

return dbus.UInt64(self.approval_delay_milliseconds())

2023

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

2024

* 1000)

1366

2025

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

1367

2026

1368

2027

# ApprovalDuration - property

1369

@dbus_service_property(_interface, signature="t",

2028

@dbus_service_property(_interface,

2029

signature="t",

1370

2030

access="readwrite")

1371

2031

def ApprovalDuration_dbus_property(self, value=None):

1372

2032

if value is None: # get

1373

return dbus.UInt64(timedelta_to_milliseconds(

1374

self.approval_duration))

2033

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

2034

* 1000)

1375

2035

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

1376

2036

1377

2037

# Name - property

2038

@dbus_annotations(

2039

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

1378

2040

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

1379

2041

def Name_dbus_property(self):

1380

2042

return dbus.String(self.name)

1381

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

1382

2051

# Fingerprint - property

2052

@dbus_annotations(

2053

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

1383

2054

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

1384

2055

def Fingerprint_dbus_property(self):

1385

2056

return dbus.String(self.fingerprint)

1386

2057

1387

2058

# Host - property

1388

@dbus_service_property(_interface, signature="s",

2059

@dbus_service_property(_interface,

2060

signature="s",

1389

2061

access="readwrite")

1390

2062

def Host_dbus_property(self, value=None):

1391

2063

if value is None: # get

1392

2064

return dbus.String(self.host)

1393

self.host = unicode(value)

1394

2065

self.host = str(value)

2066

1395

2067

# Created - property

2068

@dbus_annotations(

2069

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

1396

2070

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

1397

2071

def Created_dbus_property(self):

1398

2072

return datetime_to_dbus(self.created)

1399

2073

1400

2074

# LastEnabled - property

1401

2075

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

1402

2076

def LastEnabled_dbus_property(self):

1403

2077

return datetime_to_dbus(self.last_enabled)

1404

2078

1405

2079

# Enabled - property

1406

@dbus_service_property(_interface, signature="b",

2080

@dbus_service_property(_interface,

2081

signature="b",

1407

2082

access="readwrite")

1408

2083

def Enabled_dbus_property(self, value=None):

1409

2084

if value is None: # get

1412

2087

self.enable()

1413

2088

else:

1414

2089

self.disable()

1415

2090

1416

2091

# LastCheckedOK - property

1417

@dbus_service_property(_interface, signature="s",

2092

@dbus_service_property(_interface,

2093

signature="s",

1418

2094

access="readwrite")

1419

2095

def LastCheckedOK_dbus_property(self, value=None):

1420

2096

if value is not None:

1421

2097

self.checked_ok()

1422

2098

return

1423

2099

return datetime_to_dbus(self.last_checked_ok)

1424

2100

1425

2101

# LastCheckerStatus - property

1426

@dbus_service_property(_interface, signature="n",

1427

access="read")

2102

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

1428

2103

def LastCheckerStatus_dbus_property(self):

1429

2104

return dbus.Int16(self.last_checker_status)

1430

2105

1431

2106

# Expires - property

1432

2107

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

1433

2108

def Expires_dbus_property(self):

1434

2109

return datetime_to_dbus(self.expires)

1435

2110

1436

2111

# LastApprovalRequest - property

1437

2112

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

1438

2113

def LastApprovalRequest_dbus_property(self):

1439

2114

return datetime_to_dbus(self.last_approval_request)

1440

2115

1441

2116

# Timeout - property

1442

@dbus_service_property(_interface, signature="t",

2117

@dbus_service_property(_interface,

2118

signature="t",

1443

2119

access="readwrite")

1444

2120

def Timeout_dbus_property(self, value=None):

1445

2121

if value is None: # get

1446

return dbus.UInt64(self.timeout_milliseconds())

2122

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

2123

old_timeout = self.timeout

1447

2124

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

1448

# Reschedule timeout

2125

# Reschedule disabling

1449

2126

if self.enabled:

1450

2127

now = datetime.datetime.utcnow()

1451

time_to_die = timedelta_to_milliseconds(

1452

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

1453

if time_to_die <= 0:

2128

self.expires += self.timeout - old_timeout

2129

if self.expires <= now:

1454

2130

# The timeout has passed

1455

2131

self.disable()

1456

2132

else:

1457

self.expires = (now +

1458

datetime.timedelta(milliseconds =

1459

time_to_die))

1460

2133

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

1461

2134

is None):

1462

2135

return

1463

gobject.source_remove(self.disable_initiator_tag)

1464

self.disable_initiator_tag = (gobject.timeout_add

1465

(time_to_die,

1466

self.disable))

1467

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

1468

2141

# ExtendedTimeout - property

1469

@dbus_service_property(_interface, signature="t",

2142

@dbus_service_property(_interface,

2143

signature="t",

1470

2144

access="readwrite")

1471

2145

def ExtendedTimeout_dbus_property(self, value=None):

1472

2146

if value is None: # get

1473

return dbus.UInt64(self.extended_timeout_milliseconds())

2147

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

2148

* 1000)

1474

2149

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

1475

2150

1476

2151

# Interval - property

1477

@dbus_service_property(_interface, signature="t",

2152

@dbus_service_property(_interface,

2153

signature="t",

1478

2154

access="readwrite")

1479

2155

def Interval_dbus_property(self, value=None):

1480

2156

if value is None: # get

1481

return dbus.UInt64(self.interval_milliseconds())

2157

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

1482

2158

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

1483

2159

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

1484

2160

return

1485

2161

if self.enabled:

1486

2162

# Reschedule checker run

1487

gobject.source_remove(self.checker_initiator_tag)

1488

self.checker_initiator_tag = (gobject.timeout_add

1489

(value, self.start_checker))

1490

self.start_checker() # Start one now, too

1491

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

1492

2168

# Checker - property

1493

@dbus_service_property(_interface, signature="s",

2169

@dbus_service_property(_interface,

2170

signature="s",

1494

2171

access="readwrite")

1495

2172

def Checker_dbus_property(self, value=None):

1496

2173

if value is None: # get

1497

2174

return dbus.String(self.checker_command)

1498

self.checker_command = unicode(value)

1499

2175

self.checker_command = str(value)

2176

1500

2177

# CheckerRunning - property

1501

@dbus_service_property(_interface, signature="b",

2178

@dbus_service_property(_interface,

2179

signature="b",

1502

2180

access="readwrite")

1503

2181

def CheckerRunning_dbus_property(self, value=None):

1504

2182

if value is None: # get

1507

2185

self.start_checker()

1508

2186

else:

1509

2187

self.stop_checker()

1510

2188

1511

2189

# ObjectPath - property

2190

@dbus_annotations(

2191

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

2192

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

1512

2193

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

1513

2194

def ObjectPath_dbus_property(self):

1514

return self.dbus_object_path # is already a dbus.ObjectPath

1515

2195

return self.dbus_object_path # is already a dbus.ObjectPath

2196

1516

2197

# Secret = property

1517

@dbus_service_property(_interface, signature="ay",

1518

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)

1519

2205

def Secret_dbus_property(self, value):

1520

self.secret = str(value)

1521

2206

self.secret = bytes(value)

2207

1522

2208

del _interface

1523

2209

1524

2210

1525

2211

class ProxyClient(object):

1526

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

2212

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

1527

2213

self._pipe = child_pipe

1528

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

2214

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

1529

2215

if not self._pipe.recv():

1530

raise KeyError()

1531

2216

raise KeyError(key_id or fpr)

2217

1532

2218

def __getattribute__(self, name):

1533

2219

if name == '_pipe':

1534

2220

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

1537

2223

if data[0] == 'data':

1538

2224

return data[1]

1539

2225

if data[0] == 'function':

2226

1540

2227

def func(*args, **kwargs):

1541

2228

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

1542

2229

return self._pipe.recv()[1]

2230

1543

2231

return func

1544

2232

1545

2233

def __setattr__(self, name, value):

1546

2234

if name == '_pipe':

1547

2235

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

1548

2236

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

1549

2237

1550

2238

1551

class ClientDBusTransitional(ClientDBus):

1552

__metaclass__ = AlternateDBusNamesMetaclass

1553

1554

1555

2239

class ClientHandler(socketserver.BaseRequestHandler, object):

1556

2240

"""A class to handle client connections.

1557

2241

1558

2242

Instantiated once for each connection to handle it.

1559

2243

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

1560

2244

1561

2245

def handle(self):

1562

2246

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

1563

2247

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

1564

unicode(self.client_address))

2248

str(self.client_address))

1565

2249

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

1566

2250

self.server.child_pipe.fileno())

1567

1568

session = (gnutls.connection

1569

.ClientSession(self.request,

1570

gnutls.connection

1571

.X509Credentials()))

1572

1573

# Note: gnutls.connection.X509Credentials is really a

1574

# generic GnuTLS certificate credentials object so long as

1575

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

1576

# here despite using OpenPGP certificates.

1577

1578

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

1579

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

1580

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

1581

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

1582

2258

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

1583

2259

priority = self.server.gnutls_priority

1584

2260

if priority is None:

1585

2261

priority = "NORMAL"

1586

(gnutls.library.functions

1587

.gnutls_priority_set_direct(session._c_object,

1588

priority, None))

1589

2262

gnutls.priority_set_direct(session._c_object,

2263

priority.encode("utf-8"),

2264

None)

2265

1590

2266

# Start communication using the Mandos protocol

1591

2267

# Get protocol number

1592

2268

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

1593

2269

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

1594

2270

try:

1595

2271

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

1596

raise RuntimeError

2272

raise RuntimeError(line)

1597

2273

except (ValueError, IndexError, RuntimeError) as error:

1598

2274

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

1599

2275

return

1600

2276

1601

2277

# Start GnuTLS connection

1602

2278

try:

1603

2279

session.handshake()

1604

except gnutls.errors.GNUTLSError as error:

2280

except gnutls.Error as error:

1605

2281

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

1606

2282

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

1607

2283

# established. Just abandon the request.

1608

2284

return

1609

2285

logger.debug("Handshake succeeded")

1610

2286

1611

2287

approval_required = False

1612

2288

try:

1613

try:

1614

fpr = self.fingerprint(self.peer_certificate

1615

(session))

1616

except (TypeError,

1617

gnutls.errors.GNUTLSError) as error:

1618

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

1619

return

1620

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

1621

1622

try:

1623

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,

1624

2311

self.client_address)

1625

2312

except KeyError:

1626

2313

return

1627

2314

1628

2315

if client.approval_delay:

1629

2316

delay = client.approval_delay

1630

2317

client.approvals_pending += 1

1631

2318

approval_required = True

1632

2319

1633

2320

while True:

1634

2321

if not client.enabled:

1635

2322

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

1636

client.name)

2323

client.name)

1637

2324

if self.server.use_dbus:

1638

2325

# Emit D-Bus signal

1639

2326

client.Rejected("Disabled")

1640

2327

return

1641

2328

1642

2329

if client.approved or not client.approval_delay:

1643

#We are approved or approval is disabled

2330

# We are approved or approval is disabled

1644

2331

break

1645

2332

elif client.approved is None:

1646

2333

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

1648

2335

if self.server.use_dbus:

1649

2336

# Emit D-Bus signal

1650

2337

client.NeedApproval(

1651

client.approval_delay_milliseconds(),

1652

client.approved_by_default)

2338

client.approval_delay.total_seconds()

2339

* 1000, client.approved_by_default)

1653

2340

else:

1654

2341

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

1655

2342

client.name)

1657

2344

# Emit D-Bus signal

1658

2345

client.Rejected("Denied")

1659

2346

return

1660

1661

#wait until timeout or approved

2347

2348

# wait until timeout or approved

1662

2349

time = datetime.datetime.now()

1663

2350

client.changedstate.acquire()

1664

(client.changedstate.wait

1665

(float(client.timedelta_to_milliseconds(delay)

1666

/ 1000)))

2351

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

1667

2352

client.changedstate.release()

1668

2353

time2 = datetime.datetime.now()

1669

2354

if (time2 - time) >= delay:

1679

2364

break

1680

2365

else:

1681

2366

delay -= time2 - time

1682

1683

sent_size = 0

1684

while sent_size < len(client.secret):

1685

try:

1686

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

1687

except gnutls.errors.GNUTLSError as error:

1688

logger.warning("gnutls send failed")

1689

return

1690

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

1691

sent, len(client.secret)

1692

- (sent_size + sent))

1693

sent_size += sent

1694

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

1695

2375

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

1696

2376

# bump the timeout using extended_timeout

1697

2377

client.bump_timeout(client.extended_timeout)

1698

2378

if self.server.use_dbus:

1699

2379

# Emit D-Bus signal

1700

2380

client.GotSecret()

1701

2381

1702

2382

finally:

1703

2383

if approval_required:

1704

2384

client.approvals_pending -= 1

1705

2385

try:

1706

2386

session.bye()

1707

except gnutls.errors.GNUTLSError as error:

1708

logger.warning("GnuTLS bye failed")

1709

2387

except gnutls.Error as error:

2388

logger.warning("GnuTLS bye failed",

2389

exc_info=error)

2390

1710

2391

@staticmethod

1711

2392

def peer_certificate(session):

1712

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

1713

# If not an OpenPGP certificate...

1714

if (gnutls.library.functions

1715

.gnutls_certificate_type_get(session._c_object)

1716

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1717

# ...do the normal thing

1718

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

1719

2409

list_size = ctypes.c_uint(1)

1720

cert_list = (gnutls.library.functions

1721

.gnutls_certificate_get_peers

2410

cert_list = (gnutls.certificate_get_peers

1722

2411

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

1723

2412

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

1724

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

1725

" certificate")

2413

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

1726

2414

if list_size.value == 0:

1727

2415

return None

1728

2416

cert = cert_list[0]

1729

2417

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

1730

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

1731

2453

@staticmethod

1732

2454

def fingerprint(openpgp):

1733

2455

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1734

2456

# New GnuTLS "datum" with the OpenPGP public key

1735

datum = (gnutls.library.types

1736

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

1737

ctypes.POINTER

1738

(ctypes.c_ubyte)),

1739

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

1740

2461

# New empty GnuTLS certificate

1741

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1742

(gnutls.library.functions

1743

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2462

crt = gnutls.openpgp_crt_t()

2463

gnutls.openpgp_crt_init(ctypes.byref(crt))

1744

2464

# Import the OpenPGP public key into the certificate

1745

(gnutls.library.functions

1746

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

1747

gnutls.library.constants

1748

.GNUTLS_OPENPGP_FMT_RAW))

2465

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

2466

gnutls.OPENPGP_FMT_RAW)

1749

2467

# Verify the self signature in the key

1750

2468

crtverify = ctypes.c_uint()

1751

(gnutls.library.functions

1752

.gnutls_openpgp_crt_verify_self(crt, 0,

1753

ctypes.byref(crtverify)))

2469

gnutls.openpgp_crt_verify_self(crt, 0,

2470

ctypes.byref(crtverify))

1754

2471

if crtverify.value != 0:

1755

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1756

raise (gnutls.errors.CertificateSecurityError

1757

("Verify failed"))

2472

gnutls.openpgp_crt_deinit(crt)

2473

raise gnutls.CertificateSecurityError(code

2474

=crtverify.value)

1758

2475

# New buffer for the fingerprint

1759

2476

buf = ctypes.create_string_buffer(20)

1760

2477

buf_len = ctypes.c_size_t()

1761

2478

# Get the fingerprint from the certificate into the buffer

1762

(gnutls.library.functions

1763

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

1764

ctypes.byref(buf_len)))

2479

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

2480

ctypes.byref(buf_len))

1765

2481

# Deinit the certificate

1766

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2482

gnutls.openpgp_crt_deinit(crt)

1767

2483

# Convert the buffer to a Python bytestring

1768

2484

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

1769

2485

# Convert the bytestring to hexadecimal notation

1773

2489

1774

2490

class MultiprocessingMixIn(object):

1775

2491

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

2492

1776

2493

def sub_process_main(self, request, address):

1777

2494

try:

1778

2495

self.finish_request(request, address)

1779

2496

except Exception:

1780

2497

self.handle_error(request, address)

1781

2498

self.close_request(request)

1782

2499

1783

2500

def process_request(self, request, address):

1784

2501

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

1785

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

1786

args = (request,

1787

address))

2502

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

2503

args=(request, address))

1788

2504

proc.start()

1789

2505

return proc

1790

2506

1791

2507

1792

2508

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1793

2509

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

2510

1794

2511

def process_request(self, request, client_address):

1795

2512

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

1796

2513

1797

2514

This function creates a new pipe in self.pipe

1798

2515

"""

1799

2516

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1800

2517

1801

2518

proc = MultiprocessingMixIn.process_request(self, request,

1802

2519

client_address)

1803

2520

self.child_pipe.close()

1804

2521

self.add_pipe(parent_pipe, proc)

1805

2522

1806

2523

def add_pipe(self, parent_pipe, proc):

1807

2524

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

1808

raise NotImplementedError

2525

raise NotImplementedError()

1809

2526

1810

2527

1811

2528

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1812

2529

socketserver.TCPServer, object):

1813

2530

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

1814

2531

1815

2532

Attributes:

1816

2533

enabled: Boolean; whether this server is activated yet

1817

2534

interface: None or a network interface name (string)

1818

2535

use_ipv6: Boolean; to use IPv6 or not

1819

2536

"""

2537

1820

2538

def __init__(self, server_address, RequestHandlerClass,

1821

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

"""

1822

2545

self.interface = interface

1823

2546

if use_ipv6:

1824

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.

1825

2575

socketserver.TCPServer.__init__(self, server_address,

1826

2576

RequestHandlerClass)

2577

1827

2578

def server_bind(self):

1828

2579

"""This overrides the normal server_bind() function

1829

2580

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

1830

2581

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

2582

global SO_BINDTODEVICE

1831

2583

if self.interface is not None:

1832

2584

if SO_BINDTODEVICE is None:

1833

logger.error("SO_BINDTODEVICE does not exist;"

1834

" cannot bind to interface %s",

1835

self.interface)

1836

else:

1837

try:

1838

self.socket.setsockopt(socket.SOL_SOCKET,

1839

SO_BINDTODEVICE,

1840

str(self.interface

1841

+ '\0'))

1842

except socket.error as error:

1843

if error[0] == errno.EPERM:

1844

logger.error("No permission to"

1845

" bind to interface %s",

1846

self.interface)

1847

elif error[0] == errno.ENOPROTOOPT:

1848

logger.error("SO_BINDTODEVICE not available;"

1849

" cannot bind to interface %s",

1850

self.interface)

1851

else:

1852

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

1853

2606

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

1854

2607

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

1855

2608

if not self.server_address[0]:

1856

2609

if self.address_family == socket.AF_INET6:

1857

any_address = "::" # in6addr_any

2610

any_address = "::" # in6addr_any

1858

2611

else:

1859

any_address = socket.INADDR_ANY

2612

any_address = "0.0.0.0" # INADDR_ANY

1860

2613

self.server_address = (any_address,

1861

2614

self.server_address[1])

1862

2615

elif not self.server_address[1]:

1863

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

1864

0)

2616

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

1865

2617

# if self.interface:

1866

2618

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

1867

2619

# 0, # port

1873

2625

1874

2626

class MandosServer(IPv6_TCPServer):

1875

2627

"""Mandos server.

1876

2628

1877

2629

Attributes:

1878

2630

clients: set of Client objects

1879

2631

gnutls_priority GnuTLS priority string

1880

2632

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

1881

1882

Assumes a gobject.MainLoop event loop.

2633

2634

Assumes a GLib.MainLoop event loop.

1883

2635

"""

2636

1884

2637

def __init__(self, server_address, RequestHandlerClass,

1885

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

1886

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

1887

2644

self.enabled = False

1888

2645

self.clients = clients

1889

2646

if self.clients is None:

1892

2649

self.gnutls_priority = gnutls_priority

1893

2650

IPv6_TCPServer.__init__(self, server_address,

1894

2651

RequestHandlerClass,

1895

interface = interface,

1896

use_ipv6 = use_ipv6)

2652

interface=interface,

2653

use_ipv6=use_ipv6,

2654

socketfd=socketfd)

2655

1897

2656

def server_activate(self):

1898

2657

if self.enabled:

1899

2658

return socketserver.TCPServer.server_activate(self)

1900

2659

1901

2660

def enable(self):

1902

2661

self.enabled = True

1903

2662

1904

2663

def add_pipe(self, parent_pipe, proc):

1905

2664

# Call "handle_ipc" for both data and EOF events

1906

gobject.io_add_watch(parent_pipe.fileno(),

1907

gobject.IO_IN | gobject.IO_HUP,

1908

functools.partial(self.handle_ipc,

1909

parent_pipe =

1910

parent_pipe,

1911

proc = proc))

1912

1913

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

1914

proc = None, client_object=None):

1915

condition_names = {

1916

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

1917

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

1918

# blocking).

1919

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

1920

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

1921

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

1922

# broken, usually for pipes and

1923

# sockets).

1924

}

1925

conditions_string = ' | '.join(name

1926

for cond, name in

1927

condition_names.iteritems()

1928

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

1929

2676

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

1930

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

2677

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

1931

2678

# Wait for other process to exit

1932

2679

proc.join()

1933

2680

return False

1934

2681

1935

2682

# Read a request from the child

1936

2683

request = parent_pipe.recv()

1937

2684

command = request[0]

1938

2685

1939

2686

if command == 'init':

1940

fpr = request[1]

1941

address = request[2]

1942

1943

for c in self.clients.itervalues():

1944

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:

1945

2698

client = c

1946

2699

break

1947

2700

else:

1948

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

1949

"dress: %s", fpr, address)

2701

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

2702

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

1950

2703

if self.use_dbus:

1951

2704

# Emit D-Bus signal

1952

mandos_dbus_service.ClientNotFound(fpr,

2705

mandos_dbus_service.ClientNotFound(key_id or fpr,

1953

2706

address[0])

1954

2707

parent_pipe.send(False)

1955

2708

return False

1956

1957

gobject.io_add_watch(parent_pipe.fileno(),

1958

gobject.IO_IN | gobject.IO_HUP,

1959

functools.partial(self.handle_ipc,

1960

parent_pipe =

1961

parent_pipe,

1962

proc = proc,

1963

client_object =

1964

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

1965

2717

parent_pipe.send(True)

1966

2718

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

1967

2719

# same fileno

1970

2722

funcname = request[1]

1971

2723

args = request[2]

1972

2724

kwargs = request[3]

1973

2725

1974

2726

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

1975

2727

funcname)(*args,

1976

**kwargs)))

1977

2728

**kwargs)))

2729

1978

2730

if command == 'getattr':

1979

2731

attrname = request[1]

1980

if callable(client_object.__getattribute__(attrname)):

1981

parent_pipe.send(('function',))

2732

if isinstance(client_object.__getattribute__(attrname),

2733

collections.Callable):

2734

parent_pipe.send(('function', ))

1982

2735

else:

1983

parent_pipe.send(('data', client_object

1984

.__getattribute__(attrname)))

1985

2736

parent_pipe.send((

2737

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

2738

1986

2739

if command == 'setattr':

1987

2740

attrname = request[1]

1988

2741

value = request[2]

1989

2742

setattr(client_object, attrname, value)

1990

2743

1991

2744

return True

1992

2745

1993

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

1994

2846

def string_to_delta(interval):

1995

2847

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

1996

2848

1997

2849

>>> string_to_delta('7d')

1998

2850

datetime.timedelta(7)

1999

2851

>>> string_to_delta('60s')

2007

2859

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

2008

2860

datetime.timedelta(0, 330)

2009

2861

"""

2862

2863

try:

2864

return rfc3339_duration_to_delta(interval)

2865

except ValueError:

2866

pass

2867

2010

2868

timevalue = datetime.timedelta(0)

2011

2869

for s in interval.split():

2012

2870

try:

2013

suffix = unicode(s[-1])

2871

suffix = s[-1]

2014

2872

value = int(s[:-1])

2015

2873

if suffix == "d":

2016

2874

delta = datetime.timedelta(value)

2023

2881

elif suffix == "w":

2024

2882

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

2025

2883

else:

2026

raise ValueError("Unknown suffix %r" % suffix)

2027

except (ValueError, IndexError) as e:

2884

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

2885

except IndexError as e:

2028

2886

raise ValueError(*(e.args))

2029

2887

timevalue += delta

2030

2888

return timevalue

2031

2889

2032

2890

2033

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

2891

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

2034

2892

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

2035

2893

2036

2894

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

2037

2895

if os.fork():

2038

2896

sys.exit()

2046

2904

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

2047

2905

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

2048

2906

raise OSError(errno.ENODEV,

2049

"%s not a character device"

2050

% os.devnull)

2907

"{} not a character device"

2908

.format(os.devnull))

2051

2909

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

2052

2910

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

2053

2911

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

2056

2914

2057

2915

2058

2916

def main():

2059

2917

2060

2918

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

2061

2919

# Parsing of options, both command line and config file

2062

2920

2063

2921

parser = argparse.ArgumentParser()

2064

2922

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

2065

version = "%%(prog)s %s" % version,

2923

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

2066

2924

help="show version number and exit")

2067

2925

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

2068

2926

help="Bind to interface IF")

2074

2932

help="Run self-test")

2075

2933

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

2076

2934

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

2077

" to terminal")

2935

" to terminal", default=None)

2078

2936

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

2079

2937

help="Debug level for stdout output")

2080

2938

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

2087

2945

" files")

2088

2946

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

2089

2947

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

2090

" system bus interface")

2948

" system bus interface", default=None)

2091

2949

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

2092

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

2950

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

2951

default=None)

2093

2952

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

2094

2953

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

2095

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

2096

2958

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

2097

2959

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

2098

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

2099

2966

options = parser.parse_args()

2100

2967

2101

2968

if options.check:

2102

2969

import doctest

2103

doctest.testmod()

2104

sys.exit()

2105

2970

fail_count, test_count = doctest.testmod()

2971

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

2972

2106

2973

# Default values for config file for server-global settings

2107

server_defaults = { "interface": "",

2108

"address": "",

2109

"port": "",

2110

"debug": "False",

2111

"priority":

2112

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

2113

"servicename": "Mandos",

2114

"use_dbus": "True",

2115

"use_ipv6": "True",

2116

"debuglevel": "",

2117

"restore": "True",

2118

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

2119

}

2120

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

2121

2997

# Parse config file for server-global settings

2122

2998

server_config = configparser.SafeConfigParser(server_defaults)

2123

2999

del server_defaults

2124

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

2125

"mandos.conf"))

3000

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

2126

3001

# Convert the SafeConfigParser object to a dict

2127

3002

server_settings = server_config.defaults()

2128

3003

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

2129

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

3004

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

3005

"foreground", "zeroconf"):

2130

3006

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

2131

3007

option)

2132

3008

if server_settings["port"]:

2133

3009

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

2134

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

2135

3020

del server_config

2136

3021

2137

3022

# Override the settings from the config file with command line

2138

3023

# options, if set.

2139

3024

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

2140

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

2141

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

2142

"statedir"):

3025

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

3026

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

3027

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

2143

3028

value = getattr(options, option)

2144

3029

if value is not None:

2145

3030

server_settings[option] = value

2146

3031

del options

2147

3032

# Force all strings to be unicode

2148

3033

for option in server_settings.keys():

2149

if type(server_settings[option]) is str:

2150

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

2151

3044

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

2152

3045

2153

3046

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

2154

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

2155

3053

# For convenience

2156

3054

debug = server_settings["debug"]

2157

3055

debuglevel = server_settings["debuglevel"]

2159

3057

use_ipv6 = server_settings["use_ipv6"]

2160

3058

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

2161

3059

stored_state_file)

2162

3060

foreground = server_settings["foreground"]

3061

zeroconf = server_settings["zeroconf"]

3062

2163

3063

if debug:

2164

3064

initlogger(debug, logging.DEBUG)

2165

3065

else:

2168

3068

else:

2169

3069

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

2170

3070

initlogger(debug, level)

2171

3071

2172

3072

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

2173

syslogger.setFormatter(logging.Formatter

2174

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

2175

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

2176

% server_settings["servicename"]))

2177

3073

syslogger.setFormatter(

3074

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

3075

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

3076

server_settings["servicename"])))

3077

2178

3078

# Parse config file with clients

2179

3079

client_config = configparser.SafeConfigParser(Client

2180

3080

.client_defaults)

2181

3081

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

2182

3082

"clients.conf"))

2183

3083

2184

3084

global mandos_dbus_service

2185

3085

mandos_dbus_service = None

2186

2187

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

2188

server_settings["port"]),

2189

ClientHandler,

2190

interface=(server_settings["interface"]

2191

or None),

2192

use_ipv6=use_ipv6,

2193

gnutls_priority=

2194

server_settings["priority"],

2195

use_dbus=use_dbus)

2196

if not debug:

2197

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

2198

try:

2199

pidfile = open(pidfilename, "w")

2200

except IOError:

2201

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

2202

2203

try:

2204

uid = pwd.getpwnam("_mandos").pw_uid

2205

gid = pwd.getpwnam("_mandos").pw_gid

2206

except KeyError:

2207

try:

2208

uid = pwd.getpwnam("mandos").pw_uid

2209

gid = pwd.getpwnam("mandos").pw_gid

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

3103

try:

3104

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

3105

except IOError as e:

3106

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

3107

exc_info=e)

3108

3109

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

3110

("mandos", "mandos"),

3111

("nobody", "nogroup")):

3112

try:

3113

uid = pwd.getpwnam(name).pw_uid

3114

gid = pwd.getpwnam(group).pw_gid

3115

break

2210

3116

except KeyError:

2211

try:

2212

uid = pwd.getpwnam("nobody").pw_uid

2213

gid = pwd.getpwnam("nobody").pw_gid

2214

except KeyError:

2215

uid = 65534

2216

gid = 65534

3117

continue

3118

else:

3119

uid = 65534

3120

gid = 65534

2217

3121

try:

2218

3122

os.setgid(gid)

2219

3123

os.setuid(uid)

3124

if debug:

3125

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

3126

gid))

2220

3127

except OSError as error:

2221

if error[0] != errno.EPERM:

2222

raise error

2223

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

2224

3133

if debug:

2225

3134

# Enable all possible GnuTLS debugging

2226

3135

2227

3136

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

2228

3137

# - GnuTLS manual

2229

gnutls.library.functions.gnutls_global_set_log_level(11)

2230

2231

@gnutls.library.types.gnutls_log_func

3138

gnutls.global_set_log_level(11)

3139

3140

@gnutls.log_func

2232

3141

def debug_gnutls(level, string):

2233

3142

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

2234

2235

(gnutls.library.functions

2236

.gnutls_global_set_log_function(debug_gnutls))

2237

3143

3144

gnutls.global_set_log_function(debug_gnutls)

3145

2238

3146

# Redirect stdin so all checkers get /dev/null

2239

3147

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

2240

3148

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

2241

3149

if null > 2:

2242

3150

os.close(null)

2243

3151

2244

3152

# Need to fork before connecting to D-Bus

2245

if not debug:

3153

if not foreground:

2246

3154

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

2247

3155

daemon()

2248

2249

gobject.threads_init()

2250

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

2251

3161

global main_loop

2252

3162

# From the Avahi example code

2253

3163

DBusGMainLoop(set_as_default=True)

2254

main_loop = gobject.MainLoop()

3164

main_loop = GLib.MainLoop()

2255

3165

bus = dbus.SystemBus()

2256

3166

# End of Avahi example code

2257

3167

if use_dbus:

2258

3168

try:

2259

3169

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

2260

bus, do_not_queue=True)

2261

old_bus_name = (dbus.service.BusName

2262

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

2263

do_not_queue=True))

2264

except dbus.exceptions.NameExistsException as e:

2265

logger.error(unicode(e) + ", disabling D-Bus")

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:

3176

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

2266

3177

use_dbus = False

2267

3178

server_settings["use_dbus"] = False

2268

3179

tcp_server.use_dbus = False

2269

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2270

service = AvahiServiceToSyslog(name =

2271

server_settings["servicename"],

2272

servicetype = "_mandos._tcp",

2273

protocol = protocol, bus = bus)

2274

if server_settings["interface"]:

2275

service.interface = (if_nametoindex

2276

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

2277

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

2278

3191

global multiprocessing_manager

2279

3192

multiprocessing_manager = multiprocessing.Manager()

2280

3193

2281

3194

client_class = Client

2282

3195

if use_dbus:

2283

client_class = functools.partial(ClientDBusTransitional,

2284

bus = bus)

2285

3196

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

3197

2286

3198

client_settings = Client.config_parser(client_config)

2287

3199

old_client_settings = {}

2288

3200

clients_data = {}

2289

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

2290

3210

# Get client data and settings from last running state.

2291

3211

if server_settings["restore"]:

2292

3212

try:

2293

3213

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

2294

clients_data, old_client_settings = (pickle.load

2295

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

2296

3263

os.remove(stored_state_path)

2297

3264

except IOError as e:

2298

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

2299

.format(e))

2300

if e.errno != errno.ENOENT:

3265

if e.errno == errno.ENOENT:

3266

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

3267

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

3268

else:

3269

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

3270

exc_info=e)

2301

3271

raise

2302

3272

except EOFError as e:

2303

3273

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

2304

"EOFError: {0}".format(e))

2305

3274

"EOFError:",

3275

exc_info=e)

3276

2306

3277

with PGPEngine() as pgp:

2307

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

2308

3283

# Decide which value to use after restoring saved state.

2309

3284

# We have three different values: Old config file,

2310

3285

# new config file, and saved state.

2315

3290

# For each value in new config, check if it

2316

3291

# differs from the old config value (Except for

2317

3292

# the "secret" attribute)

2318

if (name != "secret" and

2319

value != old_client_settings[client_name]

2320

[name]):

3293

if (name != "secret"

3294

and (value !=

3295

old_client_settings[client_name][name])):

2321

3296

client[name] = value

2322

3297

except KeyError:

2323

3298

pass

2324

3299

2325

3300

# Clients who has passed its expire date can still be

2326

# enabled if its last checker was successful. Clients

3301

# enabled if its last checker was successful. A Client

2327

3302

# whose checker succeeded before we stored its state is

2328

3303

# assumed to have successfully run all checkers during

2329

3304

# downtime.

2331

3306

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

2332

3307

if not client["last_checked_ok"]:

2333

3308

logger.warning(

2334

"disabling client {0} - Client never "

2335

"performed a successful checker"

2336

.format(client_name))

3309

"disabling client {} - Client never "

3310

"performed a successful checker".format(

3311

client_name))

2337

3312

client["enabled"] = False

2338

3313

elif client["last_checker_status"] != 0:

2339

3314

logger.warning(

2340

"disabling client {0} - Client "

2341

"last checker failed with error code {1}"

2342

.format(client_name,

2343

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

2344

3320

client["enabled"] = False

2345

3321

else:

2346

client["expires"] = (datetime.datetime

2347

.utcnow()

2348

+ client["timeout"])

3322

client["expires"] = (

3323

datetime.datetime.utcnow()

3324

+ client["timeout"])

2349

3325

logger.debug("Last checker succeeded,"

2350

" keeping {0} enabled"

2351

.format(client_name))

3326

" keeping {} enabled".format(

3327

client_name))

2352

3328

try:

2353

client["secret"] = (

2354

pgp.decrypt(client["encrypted_secret"],

2355

client_settings[client_name]

2356

["secret"]))

3329

client["secret"] = pgp.decrypt(

3330

client["encrypted_secret"],

3331

client_settings[client_name]["secret"])

2357

3332

except PGPError:

2358

3333

# If decryption fails, we use secret from new settings

2359

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

2360

.format(client_name))

2361

client["secret"] = (

2362

client_settings[client_name]["secret"])

3334

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

3335

client_name))

3336

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

3337

["secret"])

2363

3338

2364

2365

3339

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

2366

3340

for client_name in (set(old_client_settings)

2367

3341

- set(client_settings)):

2371

3345

clients_data[client_name] = client_settings[client_name]

2372

3346

2373

3347

# Create all client objects

2374

for client_name, client in clients_data.iteritems():

3348

for client_name, client in clients_data.items():

2375

3349

tcp_server.clients[client_name] = client_class(

2376

name = client_name, settings = client)

2377

3350

name=client_name,

3351

settings=client,

3352

server_settings=server_settings)

3353

2378

3354

if not tcp_server.clients:

2379

3355

logger.warning("No clients defined")

2380

2381

if not debug:

2382

try:

2383

with pidfile:

2384

pid = os.getpid()

2385

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

2386

del pidfile

2387

except IOError:

2388

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

2389

pidfilename, pid)

2390

except NameError:

2391

# "pidfile" was never created

2392

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

2393

3367

del pidfilename

2394

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

2395

2396

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

2397

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

2398

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

2399

3373

if use_dbus:

2400

class MandosDBusService(DBusObjectWithProperties):

3374

3375

@alternate_dbus_interfaces(

3376

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

3377

class MandosDBusService(DBusObjectWithObjectManager):

2401

3378

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

3379

2402

3380

def __init__(self):

2403

3381

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

3382

2404

3383

_interface = "se.recompile.Mandos"

2405

2406

@dbus_interface_annotations(_interface)

2407

def _foo(self):

2408

return { "org.freedesktop.DBus.Property"

2409

".EmitsChangedSignal":

2410

"false"}

2411

3384

2412

3385

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

2413

3386

def ClientAdded(self, objpath):

2414

3387

"D-Bus signal"

2415

3388

pass

2416

3389

2417

3390

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

2418

def ClientNotFound(self, fingerprint, address):

3391

def ClientNotFound(self, key_id, address):

2419

3392

"D-Bus signal"

2420

3393

pass

2421

3394

3395

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

3396

"true"})

2422

3397

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

2423

3398

def ClientRemoved(self, objpath, name):

2424

3399

"D-Bus signal"

2425

3400

pass

2426

3401

3402

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

3403

"true"})

2427

3404

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

2428

3405

def GetAllClients(self):

2429

3406

"D-Bus method"

2430

return dbus.Array(c.dbus_object_path

2431

for c in

2432

tcp_server.clients.itervalues())

2433

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

2434

3412

@dbus.service.method(_interface,

2435

3413

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

2436

3414

def GetAllClientsWithProperties(self):

2437

3415

"D-Bus method"

2438

3416

return dbus.Dictionary(

2439

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

2440

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

2441

3420

signature="oa{sv}")

2442

3421

2443

3422

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

2444

3423

def RemoveClient(self, object_path):

2445

3424

"D-Bus method"

2446

for c in tcp_server.clients.itervalues():

3425

for c in tcp_server.clients.values():

2447

3426

if c.dbus_object_path == object_path:

2448

3427

del tcp_server.clients[c.name]

2449

3428

c.remove_from_connection()

2450

# Don't signal anything except ClientRemoved

3429

# Don't signal the disabling

2451

3430

c.disable(quiet=True)

2452

# Emit D-Bus signal

2453

self.ClientRemoved(object_path, c.name)

3431

# Emit D-Bus signal for removal

3432

self.client_removed_signal(c)

2454

3433

return

2455

3434

raise KeyError(object_path)

2456

3435

2457

3436

del _interface

2458

2459

class MandosDBusServiceTransitional(MandosDBusService):

2460

__metaclass__ = AlternateDBusNamesMetaclass

2461

mandos_dbus_service = MandosDBusServiceTransitional()

2462

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

2463

3481

def cleanup():

2464

3482

"Cleanup function; run on exit"

2465

service.cleanup()

2466

2467

multiprocessing.active_children()

3483

if zeroconf:

3484

service.cleanup()

3485

3486

mp.active_children()

3487

wn.close()

2468

3488

if not (tcp_server.clients or client_settings):

2469

3489

return

2470

3490

2471

3491

# Store client before exiting. Secrets are encrypted with key

2472

3492

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

2473

3493

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

2474

3494

clients = {}

2475

3495

with PGPEngine() as pgp:

2476

for client in tcp_server.clients.itervalues():

3496

for client in tcp_server.clients.values():

2477

3497

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

2478

3498

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

2479

3499

key)

2480

3500

client_dict = {}

2481

3501

2482

3502

# A list of attributes that can not be pickled

2483

3503

# + secret.

2484

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

2485

"checker"))

2486

for name, typ in (inspect.getmembers

2487

(dbus.service.Object)):

3504

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

3505

"checker", "server_settings"}

3506

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

3507

.Object):

2488

3508

exclude.add(name)

2489

3509

2490

3510

client_dict["encrypted_secret"] = (client

2491

3511

.encrypted_secret)

2492

3512

for attr in client.client_structure:

2493

3513

if attr not in exclude:

2494

3514

client_dict[attr] = getattr(client, attr)

2495

3515

2496

3516

clients[client.name] = client_dict

2497

3517

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

2498

3518

2499

3519

try:

2500

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

2501

prefix="clients-",

2502

dir=os.path.dirname

2503

(stored_state_path))

2504

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

2505

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

2506

3529

os.rename(tempname, stored_state_path)

2507

3530

except (IOError, OSError) as e:

2508

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

2509

.format(e))

2510

3531

if not debug:

2511

3532

try:

2512

3533

os.remove(tempname)

2513

3534

except NameError:

2514

3535

pass

2515

if e.errno not in set((errno.ENOENT, errno.EACCES,

2516

errno.EEXIST)):

2517

raise e

2518

3536

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

3537

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

3538

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

3539

else:

3540

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

3541

exc_info=e)

3542

raise

3543

2519

3544

# Delete all clients, and settings from config

2520

3545

while tcp_server.clients:

2521

3546

name, client = tcp_server.clients.popitem()

2522

3547

if use_dbus:

2523

3548

client.remove_from_connection()

2524

# Don't signal anything except ClientRemoved

3549

# Don't signal the disabling

2525

3550

client.disable(quiet=True)

3551

# Emit D-Bus signal for removal

2526

3552

if use_dbus:

2527

# Emit D-Bus signal

2528

mandos_dbus_service.ClientRemoved(client

2529

.dbus_object_path,

2530

client.name)

3553

mandos_dbus_service.client_removed_signal(client)

2531

3554

client_settings.clear()

2532

3555

2533

3556

atexit.register(cleanup)

2534

2535

for client in tcp_server.clients.itervalues():

3557

3558

for client in tcp_server.clients.values():

2536

3559

if use_dbus:

2537

# Emit D-Bus signal

2538

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3560

# Emit D-Bus signal for adding

3561

mandos_dbus_service.client_added_signal(client)

2539

3562

# Need to initiate checking of clients

2540

3563

if client.enabled:

2541

3564

client.init_checker()

2542

3565

2543

3566

tcp_server.enable()

2544

3567

tcp_server.server_activate()

2545

3568

2546

3569

# Find out what port we got

2547

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

3570

if zeroconf:

3571

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

2548

3572

if use_ipv6:

2549

3573

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

2550

" flowinfo %d, scope_id %d"

2551

% tcp_server.socket.getsockname())

3574

" flowinfo %d, scope_id %d",

3575

*tcp_server.socket.getsockname())

2552

3576

else: # IPv4

2553

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

2554

% tcp_server.socket.getsockname())

2555

2556

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

2557

3577

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

3578

*tcp_server.socket.getsockname())

3579

3580

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

3581

2558

3582

try:

2559

# From the Avahi example code

2560

try:

2561

service.activate()

2562

except dbus.exceptions.DBusException as error:

2563

logger.critical("DBusException: %s", error)

2564

cleanup()

2565

sys.exit(1)

2566

# End of Avahi example code

2567

2568

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

2569

lambda *args, **kwargs:

2570

(tcp_server.handle_request

2571

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

2572

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

2573

3598

logger.debug("Starting main loop")

2574

3599

main_loop.run()

2575

3600

except AvahiError as error:

2576

logger.critical("AvahiError: %s", error)

3601

logger.critical("Avahi Error", exc_info=error)

2577

3602

cleanup()

2578

3603

sys.exit(1)

2579

3604

except KeyboardInterrupt:

2584

3609

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

2585

3610

cleanup()

2586

3611

3612

2587

3613

if __name__ == '__main__':

2588

3614

main()