/mandos/release : revision 237.7.650

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

77

import itertools

78

import collections

79

import codecs

68

80

69

81

import dbus

70

82

import dbus.service

71

import gobject

72

import avahi

83

from gi.repository import GLib

73

84

from dbus.mainloop.glib import DBusGMainLoop

74

85

import ctypes

75

86

import ctypes.util

76

87

import xml.dom.minidom

77

88

import inspect

78

import GnuPGInterface

79

89

90

# Try to find the value of SO_BINDTODEVICE:

80

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:

81

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

82

95

except AttributeError:

83

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

84

99

from IN import SO_BINDTODEVICE

85

100

except ImportError:

86

SO_BINDTODEVICE = None

87

88

version = "1.5.2"

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.8.4"

89

119

stored_state_file = "clients.pickle"

90

120

91

121

logger = logging.getLogger()

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

122

syslogger = None

95

123

96

124

try:

97

if_nametoindex = (ctypes.cdll.LoadLibrary

98

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

99

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

100

127

except (OSError, AttributeError):

128

101

129

def if_nametoindex(interface):

102

130

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

103

131

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

104

132

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

105

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

106

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

107

interface))

108

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

109

ifreq[16:20])[0]

134

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

135

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

110

136

return interface_index

111

137

112

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

113

155

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

114

156

"""init logger and add loglevel"""

115

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

116

162

syslogger.setFormatter(logging.Formatter

117

163

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

118

164

' %(message)s'))

119

165

logger.addHandler(syslogger)

120

166

121

167

if debug:

122

168

console = logging.StreamHandler()

123

169

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

135

181

136

182

class PGPEngine(object):

137

183

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

184

138

185

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

140

186

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

141

self.gnupg = GnuPGInterface.GnuPG()

142

self.gnupg.options.meta_interactive = False

143

self.gnupg.options.homedir = self.tempdir

144

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

145

'--quiet',

146

'--no-use-agent'])

147

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

148

206

def __enter__(self):

149

207

return self

150

151

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

208

209

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

152

210

self._cleanup()

153

211

return False

154

212

155

213

def __del__(self):

156

214

self._cleanup()

157

215

158

216

def _cleanup(self):

159

217

if self.tempdir is not None:

160

218

# Delete contents of tempdir

161

219

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

162

topdown = False):

220

topdown=False):

163

221

for filename in files:

164

222

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

165

223

for dirname in dirs:

167

225

# Remove tempdir

168

226

os.rmdir(self.tempdir)

169

227

self.tempdir = None

170

228

171

229

def password_encode(self, password):

172

230

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

173

231

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

174

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

175

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

176

240

def encrypt(self, data, password):

177

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

178

with open(os.devnull) as devnull:

179

try:

180

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

181

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

182

attach_fhs={'stderr': devnull})

183

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

184

f.write(data)

185

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

186

ciphertext = f.read()

187

proc.wait()

188

except IOError as e:

189

raise PGPError(e)

190

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)

191

256

return ciphertext

192

257

193

258

def decrypt(self, data, password):

194

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

195

with open(os.devnull) as devnull:

196

try:

197

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

198

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

199

attach_fhs={'stderr': devnull})

200

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

201

f.write(data)

202

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

203

decrypted_plaintext = f.read()

204

proc.wait()

205

except IOError as e:

206

raise PGPError(e)

207

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)

208

274

return decrypted_plaintext

209

275

210

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

211

302

212

303

class AvahiError(Exception):

213

304

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

214

305

self.value = value

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

306

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

307

**kwargs)

308

218

309

219

310

class AvahiServiceError(AvahiError):

220

311

pass

221

312

313

222

314

class AvahiGroupError(AvahiError):

223

315

pass

224

316

225

317

226

318

class AvahiService(object):

227

319

"""An Avahi (Zeroconf) service.

228

320

229

321

Attributes:

230

322

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

231

323

Used to optionally bind to the specified interface.

232

324

name: string; Example: 'Mandos'

233

325

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

234

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

326

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

235

327

port: integer; what port to announce

236

328

TXT: list of strings; TXT record for the service

237

329

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

243

335

server: D-Bus Server

244

336

bus: dbus.SystemBus()

245

337

"""

246

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

247

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

248

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

249

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

250

350

self.interface = interface

251

351

self.name = name

252

352

self.type = servicetype

261

361

self.server = None

262

362

self.bus = bus

263

363

self.entry_group_state_changed_match = None

264

def rename(self):

364

365

def rename(self, remove=True):

265

366

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

266

367

if self.rename_count >= self.max_renames:

267

368

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

268

369

" after %i retries, exiting.",

269

370

self.rename_count)

270

371

raise AvahiServiceError("Too many renames")

271

self.name = unicode(self.server

272

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

273

375

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

274

376

self.name)

275

self.remove()

377

if remove:

378

self.remove()

276

379

try:

277

380

self.add()

278

381

except dbus.exceptions.DBusException as error:

279

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

280

self.cleanup()

281

os._exit(1)

282

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

283

391

def remove(self):

284

392

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

285

393

if self.entry_group_state_changed_match is not None:

287

395

self.entry_group_state_changed_match = None

288

396

if self.group is not None:

289

397

self.group.Reset()

398

290

399

def add(self):

291

400

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

292

401

self.remove()

309

418

dbus.UInt16(self.port),

310

419

avahi.string_array_to_txt_array(self.TXT))

311

420

self.group.Commit()

421

312

422

def entry_group_state_changed(self, state, error):

313

423

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

314

424

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

315

425

316

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

317

427

logger.debug("Zeroconf service established.")

318

428

elif state == avahi.ENTRY_GROUP_COLLISION:

320

430

self.rename()

321

431

elif state == avahi.ENTRY_GROUP_FAILURE:

322

432

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

323

unicode(error))

324

raise AvahiGroupError("State changed: %s"

325

% unicode(error))

433

str(error))

434

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

435

326

436

def cleanup(self):

327

437

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

328

438

if self.group is not None:

333

443

pass

334

444

self.group = None

335

445

self.remove()

446

336

447

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

337

448

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

338

449

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

339

bad_states = { avahi.SERVER_INVALID:

340

"Zeroconf server invalid",

341

avahi.SERVER_REGISTERING: None,

342

avahi.SERVER_COLLISION:

343

"Zeroconf server name collision",

344

avahi.SERVER_FAILURE:

345

"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

}

346

456

if state in bad_states:

347

457

if bad_states[state] is not None:

348

458

if error is None:

351

461

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

352

462

self.cleanup()

353

463

elif state == avahi.SERVER_RUNNING:

354

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)

355

476

else:

356

477

if error is None:

357

478

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

358

479

else:

359

480

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

481

360

482

def activate(self):

361

483

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

362

484

if self.server is None:

366

488

follow_name_owner_changes=True),

367

489

avahi.DBUS_INTERFACE_SERVER)

368

490

self.server.connect_to_signal("StateChanged",

369

self.server_state_changed)

491

self.server_state_changed)

370

492

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

371

493

494

372

495

class AvahiServiceToSyslog(AvahiService):

373

def rename(self):

496

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

374

497

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

375

ret = AvahiService.rename(self)

376

syslogger.setFormatter(logging.Formatter

377

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

378

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

379

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

380

502

return ret

381

503

382

def timedelta_to_milliseconds(td):

383

"Convert a datetime.timedelta() to milliseconds"

384

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

385

+ (td.seconds * 1000)

386

+ (td.microseconds // 1000))

387

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

388

817

class Client(object):

389

818

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

390

819

391

820

Attributes:

392

821

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

393

822

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

395

824

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

396

825

to see if the client lives.

397

826

'None' if no process is running.

398

checker_callback_tag: a gobject event source tag, or None

827

checker_callback_tag: a GLib event source tag, or None

399

828

checker_command: string; External command which is run to check

400

829

if client lives. %() expansions are done at

401

830

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

402

831

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

403

checker_initiator_tag: a gobject event source tag, or None

832

checker_initiator_tag: a GLib event source tag, or None

404

833

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

405

834

client_structure: Object describing what attributes a client has

406

835

and is used for storing the client at exit

407

836

current_checker_command: string; current running checker_command

408

disable_initiator_tag: a gobject event source tag, or None

837

disable_initiator_tag: a GLib event source tag, or None

409

838

enabled: bool()

410

839

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

411

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

412

843

host: string; available for use by the checker command

413

844

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

414

845

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

415

846

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

416

847

last_checker_status: integer between 0 and 255 reflecting exit

417

848

status of last checker. -1 reflects crashed

418

checker, or None.

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

419

852

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

420

853

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

421

854

D-Bus identifiers

426

859

runtime_expansions: Allowed attributes for runtime expansion.

427

860

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

428

861

disabled, or None

862

server_settings: The server_settings dict from main()

429

863

"""

430

864

431

865

runtime_expansions = ("approval_delay", "approval_duration",

432

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

433

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

866

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

867

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

868

"last_approval_request", "last_checked_ok",

434

869

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

435

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

436

"extended_timeout": "15m",

437

"interval": "2m",

438

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

439

"host": "",

440

"approval_delay": "0s",

441

"approval_duration": "1s",

442

"approved_by_default": "True",

443

"enabled": "True",

444

}

445

446

def timeout_milliseconds(self):

447

"Return the 'timeout' attribute in milliseconds"

448

return timedelta_to_milliseconds(self.timeout)

449

450

def extended_timeout_milliseconds(self):

451

"Return the 'extended_timeout' attribute in milliseconds"

452

return timedelta_to_milliseconds(self.extended_timeout)

453

454

def interval_milliseconds(self):

455

"Return the 'interval' attribute in milliseconds"

456

return timedelta_to_milliseconds(self.interval)

457

458

def approval_delay_milliseconds(self):

459

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

}

460

881

461

882

@staticmethod

462

883

def config_parser(config):

470

891

for client_name in config.sections():

471

892

section = dict(config.items(client_name))

472

893

client = settings[client_name] = {}

473

894

474

895

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

475

896

# Reformat values from string types to Python types

476

897

client["approved_by_default"] = config.getboolean(

477

898

client_name, "approved_by_default")

478

899

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

479

900

"enabled")

480

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

481

907

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

482

908

.replace(" ", ""))

483

909

if "secret" in section:

484

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

910

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

911

.encode("utf-8"),

912

"base64")

485

913

elif "secfile" in section:

486

914

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

487

915

(section["secfile"])),

488

916

"rb") as secfile:

489

917

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

490

918

else:

491

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

492

% section)

919

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

920

.format(section))

493

921

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

494

922

client["extended_timeout"] = string_to_delta(

495

923

section["extended_timeout"])

501

929

client["checker_command"] = section["checker"]

502

930

client["last_approval_request"] = None

503

931

client["last_checked_ok"] = None

504

client["last_checker_status"] = None

505

932

client["last_checker_status"] = -2

933

506

934

return settings

507

508

509

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

510

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

511

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

512

attribute."""

935

936

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

513

937

self.name = name

938

if server_settings is None:

939

server_settings = {}

940

self.server_settings = server_settings

514

941

# adding all client settings

515

for setting, value in settings.iteritems():

942

for setting, value in settings.items():

516

943

setattr(self, setting, value)

517

944

518

945

if self.enabled:

519

946

if not hasattr(self, "last_enabled"):

520

947

self.last_enabled = datetime.datetime.utcnow()

524

951

else:

525

952

self.last_enabled = None

526

953

self.expires = None

527

954

528

955

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

529

# Uppercase and remove spaces from fingerprint for later

530

# comparison purposes with return value from the fingerprint()

531

# function

956

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

532

957

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

533

958

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

534

959

datetime.datetime.utcnow())

541

966

self.current_checker_command = None

542

967

self.approved = None

543

968

self.approvals_pending = 0

544

self.changedstate = (multiprocessing_manager

545

.Condition(multiprocessing_manager

546

.Lock()))

547

self.client_structure = [attr for attr in

548

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

549

973

if not attr.startswith("_")]

550

974

self.client_structure.append("client_structure")

551

552

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

553

lambda obj:

554

isinstance(obj,

555

property)):

975

976

for name, t in inspect.getmembers(

977

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

556

978

if not name.startswith("_"):

557

979

self.client_structure.append(name)

558

980

559

981

# Send notice to process children that client state has changed

560

982

def send_changedstate(self):

561

983

with self.changedstate:

562

984

self.changedstate.notify_all()

563

985

564

986

def enable(self):

565

987

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

566

988

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

567

989

# Already enabled

568

990

return

569

self.send_changedstate()

570

991

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

571

992

self.enabled = True

572

993

self.last_enabled = datetime.datetime.utcnow()

573

994

self.init_checker()

574

995

self.send_changedstate()

996

575

997

def disable(self, quiet=True):

576

998

"""Disable this client."""

577

999

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

578

1000

return False

579

1001

if not quiet:

580

self.send_changedstate()

581

if not quiet:

582

1002

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

583

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

584

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)

585

1005

self.disable_initiator_tag = None

586

1006

self.expires = None

587

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

588

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)

589

1009

self.checker_initiator_tag = None

590

1010

self.stop_checker()

591

1011

self.enabled = False

592

# 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

593

1015

return False

594

1016

595

1017

def __del__(self):

596

1018

self.disable()

597

1019

598

1020

def init_checker(self):

599

1021

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

600

1022

# and every interval from then on.

601

self.checker_initiator_tag = (gobject.timeout_add

602

(self.interval_milliseconds(),

603

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)

604

1028

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

605

self.disable_initiator_tag = (gobject.timeout_add

606

(self.timeout_milliseconds(),

607

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)

608

1033

# Also start a new checker *right now*.

609

1034

self.start_checker()

610

611

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

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

612

1038

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

613

1039

self.checker_callback_tag = None

614

1040

self.checker = None

615

if os.WIFEXITED(condition):

616

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

617

1048

if self.last_checker_status == 0:

618

1049

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

619

1050

vars(self))

620

1051

self.checked_ok()

621

1052

else:

622

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

623

vars(self))

1053

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

624

1054

else:

625

1055

self.last_checker_status = -1

1056

self.last_checker_signal = -returncode

626

1057

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

627

1058

vars(self))

628

629

def checked_ok(self, timeout=None):

630

"""Bump up the timeout for this client.

631

632

This should only be called when the client has been seen,

633

alive and well.

634

"""

1059

return False

1060

1061

def checked_ok(self):

1062

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

1063

self.last_checked_ok = datetime.datetime.utcnow()

1064

self.last_checker_status = 0

1065

self.last_checker_signal = None

1066

self.bump_timeout()

1067

1068

def bump_timeout(self, timeout=None):

1069

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

635

1070

if timeout is None:

636

1071

timeout = self.timeout

637

self.last_checked_ok = datetime.datetime.utcnow()

638

1072

if self.disable_initiator_tag is not None:

639

gobject.source_remove(self.disable_initiator_tag)

1073

GLib.source_remove(self.disable_initiator_tag)

1074

self.disable_initiator_tag = None

640

1075

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

641

self.disable_initiator_tag = (gobject.timeout_add

642

(timedelta_to_milliseconds

643

(timeout), self.disable))

1076

self.disable_initiator_tag = GLib.timeout_add(

1077

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

644

1078

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

645

1079

646

1080

def need_approval(self):

647

1081

self.last_approval_request = datetime.datetime.utcnow()

648

1082

649

1083

def start_checker(self):

650

1084

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

651

1085

652

1086

If a checker already exists, leave it running and do

653

1087

nothing."""

654

1088

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

655

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

656

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

657

# client would inevitably timeout, since no checker would get

658

# 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

659

1093

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

660

1094

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

661

1095

# should be.

662

663

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

664

try:

665

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

666

except (AttributeError, OSError) as error:

667

if (isinstance(error, OSError)

668

and error.errno != errno.ECHILD):

669

raise error

670

else:

671

if pid:

672

logger.warning("Checker was a zombie")

673

gobject.source_remove(self.checker_callback_tag)

674

self.checker_callback(pid, status,

675

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

676

1101

# Start a new checker if needed

677

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}

678

1107

try:

679

# In case checker_command has exactly one % operator

680

command = self.checker_command % self.host

681

except TypeError:

682

# Escape attributes for the shell

683

escaped_attrs = dict(

684

(attr,

685

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

686

errors=

687

'replace')))

688

for attr in

689

self.runtime_expansions)

690

691

try:

692

command = self.checker_command % escaped_attrs

693

except TypeError as error:

694

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

695

' %s', self.checker_command, error)

696

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

697

1114

self.current_checker_command = command

698

try:

699

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

700

command, self.name)

701

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

702

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

703

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

704

# always replaced by /dev/null.)

705

self.checker = subprocess.Popen(command,

706

close_fds=True,

707

shell=True, cwd="/")

708

self.checker_callback_tag = (gobject.child_watch_add

709

(self.checker.pid,

710

self.checker_callback,

711

data=command))

712

# The checker may have completed before the gobject

713

# watch was added. Check for this.

714

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

715

if pid:

716

gobject.source_remove(self.checker_callback_tag)

717

self.checker_callback(pid, status, command)

718

except OSError as error:

719

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

720

error)

721

# 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

722

1141

return True

723

1142

724

1143

def stop_checker(self):

725

1144

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

726

1145

if self.checker_callback_tag:

727

gobject.source_remove(self.checker_callback_tag)

1146

GLib.source_remove(self.checker_callback_tag)

728

1147

self.checker_callback_tag = None

729

1148

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

730

1149

return

731

1150

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

732

try:

733

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

734

#time.sleep(0.5)

735

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

736

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

737

except OSError as error:

738

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

739

raise

1151

self.checker.terminate()

740

1152

self.checker = None

741

1153

742

1154

743

def dbus_service_property(dbus_interface, signature="v",

744

access="readwrite", byte_arrays=False):

1155

def dbus_service_property(dbus_interface,

1156

signature="v",

1157

access="readwrite",

1158

byte_arrays=False):

745

1159

"""Decorators for marking methods of a DBusObjectWithProperties to

746

1160

become properties on the D-Bus.

747

1161

748

1162

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

749

1163

and with one argument by "Set".

750

1164

751

1165

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

752

1166

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

753

1167

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

756

1170

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

757

1171

if byte_arrays and signature != "ay":

758

1172

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

759

" signature %r" % signature)

1173

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

1174

760

1175

def decorator(func):

761

1176

func._dbus_is_property = True

762

1177

func._dbus_interface = dbus_interface

765

1180

func._dbus_name = func.__name__

766

1181

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

767

1182

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

768

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

769

return func

1183

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

1184

return func

1185

1186

return decorator

1187

1188

1189

def dbus_interface_annotations(dbus_interface):

1190

"""Decorator for marking functions returning interface annotations

1191

1192

Usage:

1193

1194

@dbus_interface_annotations("org.example.Interface")

1195

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

1196

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

1197

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

1198

"false"}

1199

"""

1200

1201

def decorator(func):

1202

func._dbus_is_interface = True

1203

func._dbus_interface = dbus_interface

1204

func._dbus_name = dbus_interface

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

770

1229

return decorator

771

1230

772

1231

773

1232

class DBusPropertyException(dbus.exceptions.DBusException):

774

1233

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

775

1234

"""

776

def __unicode__(self):

777

return unicode(str(self))

1235

pass

778

1236

779

1237

780

1238

class DBusPropertyAccessException(DBusPropertyException):

789

1247

pass

790

1248

791

1249

792

class DBusObjectWithProperties(dbus.service.Object):

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.

1255

"""

1256

1257

@staticmethod

1258

def _is_dbus_thing(thing):

1259

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

1260

1261

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

1262

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

1263

"""

1264

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

1265

False)

1266

1267

def _get_all_dbus_things(self, thing):

1268

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

1269

"""

1270

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

1271

athing.__get__(self))

1272

for cls in self.__class__.__mro__

1273

for name, athing in

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

793

1340

"""A D-Bus object with properties.

794

1341

795

1342

Classes inheriting from this can use the dbus_service_property

796

1343

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

797

1344

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

798

1345

"""

799

800

@staticmethod

801

def _is_dbus_property(obj):

802

return getattr(obj, "_dbus_is_property", False)

803

804

def _get_all_dbus_properties(self):

805

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

806

"""

807

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

808

for cls in self.__class__.__mro__

809

for name, prop in

810

inspect.getmembers(cls, self._is_dbus_property))

811

1346

812

1347

def _get_dbus_property(self, interface_name, property_name):

813

1348

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

814

1349

property with the specified name and interface.

815

1350

"""

816

for cls in self.__class__.__mro__:

817

for name, value in (inspect.getmembers

818

(cls, self._is_dbus_property)):

1351

for cls in self.__class__.__mro__:

1352

for name, value in inspect.getmembers(

1353

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

819

1354

if (value._dbus_name == property_name

820

1355

and value._dbus_interface == interface_name):

821

1356

return value.__get__(self)

822

1357

823

1358

# No such property

824

raise DBusPropertyNotFound(self.dbus_object_path + ":"

825

+ interface_name + "."

826

+ property_name)

827

828

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

829

1373

out_signature="v")

830

1374

def Get(self, interface_name, property_name):

831

1375

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

837

1381

if not hasattr(value, "variant_level"):

838

1382

return value

839

1383

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

840

1384

841

1385

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

842

1386

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

843

1387

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

849

1393

# The byte_arrays option is not supported yet on

850

1394

# signatures other than "ay".

851

1395

if prop._dbus_signature != "ay":

852

raise ValueError

1396

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

1397

"'ay' signature {!r}"

1398

.format(prop._dbus_signature))

853

1399

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

854

1400

for byte in value))

855

1401

prop(value)

856

857

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

1402

1403

@dbus.service.method(dbus.PROPERTIES_IFACE,

1404

in_signature="s",

858

1405

out_signature="a{sv}")

859

1406

def GetAll(self, interface_name):

860

1407

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

861

1408

standard.

862

1409

863

1410

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

864

1411

"""

865

1412

properties = {}

866

for name, prop in self._get_all_dbus_properties():

1413

for name, prop in self._get_all_dbus_things("property"):

867

1414

if (interface_name

868

1415

and interface_name != prop._dbus_interface):

869

1416

# Interface non-empty but did not match

875

1422

if not hasattr(value, "variant_level"):

876

1423

properties[name] = value

877

1424

continue

878

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

879

value.variant_level+1)

1425

properties[name] = type(value)(

1426

value, variant_level=value.variant_level + 1)

880

1427

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

881

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

882

1437

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

883

1438

out_signature="s",

884

1439

path_keyword='object_path',

885

1440

connection_keyword='connection')

886

1441

def Introspect(self, object_path, connection):

887

"""Standard D-Bus method, overloaded to insert property tags.

1442

"""Overloading of standard D-Bus method.

1443

1444

Inserts property tags and interface annotation tags.

888

1445

"""

889

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

890

connection)

1446

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1447

object_path,

1448

connection)

891

1449

try:

892

1450

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

1451

893

1452

def make_tag(document, name, prop):

894

1453

e = document.createElement("property")

895

1454

e.setAttribute("name", name)

896

1455

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

897

1456

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

898

1457

return e

1458

899

1459

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

1460

# Add property tags

900

1461

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

901

1462

for name, prop

902

in self._get_all_dbus_properties()

1463

in self._get_all_dbus_things("property")

903

1464

if prop._dbus_interface

904

1465

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

905

1466

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

906

1483

# Add the names to the return values for the

907

1484

# "org.freedesktop.DBus.Properties" methods

908

1485

if (if_tag.getAttribute("name")

923

1500

except (AttributeError, xml.dom.DOMException,

924

1501

xml.parsers.expat.ExpatError) as error:

925

1502

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

926

error)

927

return xmlstring

928

929

930

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

931

1579

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

932

1580

if dt is None:

933

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

934

return dbus.String(dt.isoformat(),

935

variant_level=variant_level)

936

937

938

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

939

.__metaclass__):

940

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

941

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

942

1607

"""

943

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

944

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

945

# methods, signals, or properties in them

946

for base in (b for b in bases

947

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

948

# Go though all attributes of the base class

949

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

950

1616

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

951

1617

# with the wrong interface name

952

1618

if (not hasattr(attribute, "_dbus_interface")

953

or not attribute._dbus_interface

954

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

1619

or not attribute._dbus_interface.startswith(

1620

orig_interface_name)):

955

1621

continue

956

1622

# Create an alternate D-Bus interface name based on

957

1623

# the current name

958

alt_interface = (attribute._dbus_interface

959

.replace("se.recompile.Mandos",

960

"se.bsnet.fukt.Mandos"))

1624

alt_interface = attribute._dbus_interface.replace(

1625

orig_interface_name, alt_interface_name)

1626

interface_names.add(alt_interface)

961

1627

# Is this a D-Bus signal?

962

1628

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

963

# Extract the original non-method function by

964

# black magic

965

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(

966

1633

zip(attribute.func_code.co_freevars,

967

attribute.__closure__))["func"]

968

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

969

1641

# Create a new, but exactly alike, function

970

1642

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

971

1643

# with the alternate D-Bus interface name

972

new_function = (dbus.service.signal

973

(alt_interface,

974

attribute._dbus_signature)

975

(types.FunctionType(

976

nonmethod_func.func_code,

977

nonmethod_func.func_globals,

978

nonmethod_func.func_name,

979

nonmethod_func.func_defaults,

980

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

981

1655

# Define a creator of a function to call both the

982

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

983

# 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

984

1659

def fixscope(func1, func2):

985

1660

"""This function is a scope container to pass

986

1661

func1 and func2 to the "call_both" function

987

1662

outside of its arguments"""

1663

1664

@functools.wraps(func2)

988

1665

def call_both(*args, **kwargs):

989

1666

"""This function will emit two D-Bus

990

1667

signals by calling func1 and func2"""

991

1668

func1(*args, **kwargs)

992

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

993

1676

return call_both

994

1677

# Create the "call_both" function and add it to

995

1678

# the class

996

attr[attrname] = fixscope(attribute,

997

new_function)

1679

attr[attrname] = fixscope(attribute, new_function)

998

1680

# Is this a D-Bus method?

999

1681

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

1000

1682

# Create a new, but exactly alike, function

1001

1683

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

1002

1684

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

1003

1685

# to the class.

1004

attr[attrname] = (dbus.service.method

1005

(alt_interface,

1006

attribute._dbus_in_signature,

1007

attribute._dbus_out_signature)

1008

(types.FunctionType

1009

(attribute.func_code,

1010

attribute.func_globals,

1011

attribute.func_name,

1012

attribute.func_defaults,

1013

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

1014

1698

# Is this a D-Bus property?

1015

1699

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

1016

1700

# Create a new, but exactly alike, function

1017

1701

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

1018

1702

# property with the alternate D-Bus interface

1019

1703

# name. Add it to the class.

1020

attr[attrname] = (dbus_service_property

1021

(alt_interface,

1022

attribute._dbus_signature,

1023

attribute._dbus_access,

1024

attribute

1025

._dbus_get_args_options

1026

["byte_arrays"])

1027

(types.FunctionType

1028

(attribute.func_code,

1029

attribute.func_globals,

1030

attribute.func_name,

1031

attribute.func_defaults,

1032

attribute.func_closure)))

1033

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

1034

1035

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

1716

# Is this a D-Bus interface?

1717

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

1718

# Create a new, but exactly alike, function

1719

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

1720

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

1721

# to the class.

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

1036

1756

class ClientDBus(Client, DBusObjectWithProperties):

1037

1757

"""A Client class using D-Bus

1038

1758

1039

1759

Attributes:

1040

1760

dbus_object_path: dbus.ObjectPath

1041

1761

bus: dbus.SystemBus()

1042

1762

"""

1043

1763

1044

1764

runtime_expansions = (Client.runtime_expansions

1045

+ ("dbus_object_path",))

1046

1765

+ ("dbus_object_path", ))

1766

1767

_interface = "se.recompile.Mandos.Client"

1768

1047

1769

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

1048

1049

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

1770

1771

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

1050

1772

self.bus = bus

1051

1773

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

1052

1774

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

1053

1775

# the D-Bus

1054

client_object_name = unicode(self.name).translate(

1776

client_object_name = str(self.name).translate(

1055

1777

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

1056

1778

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

1057

self.dbus_object_path = (dbus.ObjectPath

1058

("/clients/" + client_object_name))

1779

self.dbus_object_path = dbus.ObjectPath(

1780

"/clients/" + client_object_name)

1059

1781

DBusObjectWithProperties.__init__(self, self.bus,

1060

1782

self.dbus_object_path)

1061

1062

def notifychangeproperty(transform_func,

1063

dbus_name, type_func=lambda x: x,

1064

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

1065

1789

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

1066

1790

its changes to DBus.

1067

1791

1068

1792

transform_fun: Function that takes a value and a variant_level

1069

1793

and transforms it to a D-Bus type.

1070

1794

dbus_name: D-Bus name of the variable

1072

1796

to the D-Bus. Default: no transform

1073

1797

variant_level: D-Bus variant level. Default: 1

1074

1798

"""

1075

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

1799

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

1800

1076

1801

def setter(self, value):

1077

1802

if hasattr(self, "dbus_object_path"):

1078

1803

if (not hasattr(self, attrname) or

1079

1804

type_func(getattr(self, attrname, None))

1080

1805

!= type_func(value)):

1081

dbus_value = transform_func(type_func(value),

1082

variant_level

1083

=variant_level)

1084

self.PropertyChanged(dbus.String(dbus_name),

1085

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

1086

1821

setattr(self, attrname, value)

1087

1822

1088

1823

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

1089

1090

1824

1091

1825

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1092

1826

approvals_pending = notifychangeproperty(dbus.Boolean,

1093

1827

"ApprovalPending",

1094

type_func = bool)

1828

type_func=bool)

1095

1829

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

1096

1830

last_enabled = notifychangeproperty(datetime_to_dbus,

1097

1831

"LastEnabled")

1098

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

1099

type_func = lambda checker:

1100

checker is not None)

1832

checker = notifychangeproperty(

1833

dbus.Boolean, "CheckerRunning",

1834

type_func=lambda checker: checker is not None)

1101

1835

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1102

1836

"LastCheckedOK")

1837

last_checker_status = notifychangeproperty(dbus.Int16,

1838

"LastCheckerStatus")

1103

1839

last_approval_request = notifychangeproperty(

1104

1840

datetime_to_dbus, "LastApprovalRequest")

1105

1841

approved_by_default = notifychangeproperty(dbus.Boolean,

1106

1842

"ApprovedByDefault")

1107

approval_delay = notifychangeproperty(dbus.UInt64,

1108

"ApprovalDelay",

1109

type_func =

1110

timedelta_to_milliseconds)

1843

approval_delay = notifychangeproperty(

1844

dbus.UInt64, "ApprovalDelay",

1845

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

1111

1846

approval_duration = notifychangeproperty(

1112

1847

dbus.UInt64, "ApprovalDuration",

1113

type_func = timedelta_to_milliseconds)

1848

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

1114

1849

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

1115

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

1116

type_func =

1117

timedelta_to_milliseconds)

1850

timeout = notifychangeproperty(

1851

dbus.UInt64, "Timeout",

1852

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

1118

1853

extended_timeout = notifychangeproperty(

1119

1854

dbus.UInt64, "ExtendedTimeout",

1120

type_func = timedelta_to_milliseconds)

1121

interval = notifychangeproperty(dbus.UInt64,

1122

"Interval",

1123

type_func =

1124

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)

1125

1859

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

1126

1860

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

1861

invalidate_only=True)

1862

1127

1863

del notifychangeproperty

1128

1864

1129

1865

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

1130

1866

try:

1131

1867

self.remove_from_connection()

1134

1870

if hasattr(DBusObjectWithProperties, "__del__"):

1135

1871

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

1136

1872

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

1137

1138

def checker_callback(self, pid, condition, command,

1139

*args, **kwargs):

1140

self.checker_callback_tag = None

1141

self.checker = None

1142

if os.WIFEXITED(condition):

1143

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:

1144

1881

# Emit D-Bus signal

1145

1882

self.CheckerCompleted(dbus.Int16(exitstatus),

1146

dbus.Int64(condition),

1883

# This is specific to GNU libC

1884

dbus.Int64(exitstatus << 8),

1147

1885

dbus.String(command))

1148

1886

else:

1149

1887

# Emit D-Bus signal

1150

1888

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

1151

dbus.Int64(condition),

1889

dbus.Int64(

1890

# This is specific to GNU libC

1891

(exitstatus << 8)

1892

| self.last_checker_signal),

1152

1893

dbus.String(command))

1153

1154

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

1155

*args, **kwargs)

1156

1894

return ret

1895

1157

1896

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

1158

old_checker = self.checker

1159

if self.checker is not None:

1160

old_checker_pid = self.checker.pid

1161

else:

1162

old_checker_pid = None

1897

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

1163

1898

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

1164

1899

# Only if new checker process was started

1165

1900

if (self.checker is not None

1167

1902

# Emit D-Bus signal

1168

1903

self.CheckerStarted(self.current_checker_command)

1169

1904

return r

1170

1905

1171

1906

def _reset_approved(self):

1172

1907

self.approved = None

1173

1908

return False

1174

1909

1175

1910

def approve(self, value=True):

1176

self.send_changedstate()

1177

1911

self.approved = value

1178

gobject.timeout_add(timedelta_to_milliseconds

1179

(self.approval_duration),

1180

self._reset_approved)

1181

1182

1183

## D-Bus methods, signals & properties

1184

_interface = "se.recompile.Mandos.Client"

1185

1186

## Signals

1187

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

1188

1922

# CheckerCompleted - signal

1189

1923

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

1190

1924

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

1191

1925

"D-Bus signal"

1192

1926

pass

1193

1927

1194

1928

# CheckerStarted - signal

1195

1929

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

1196

1930

def CheckerStarted(self, command):

1197

1931

"D-Bus signal"

1198

1932

pass

1199

1933

1200

1934

# PropertyChanged - signal

1935

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

1201

1936

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

1202

1937

def PropertyChanged(self, property, value):

1203

1938

"D-Bus signal"

1204

1939

pass

1205

1940

1206

1941

# GotSecret - signal

1207

1942

@dbus.service.signal(_interface)

1208

1943

def GotSecret(self):

1211

1946

server to mandos-client

1212

1947

"""

1213

1948

pass

1214

1949

1215

1950

# Rejected - signal

1216

1951

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

1217

1952

def Rejected(self, reason):

1218

1953

"D-Bus signal"

1219

1954

pass

1220

1955

1221

1956

# NeedApproval - signal

1222

1957

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

1223

1958

def NeedApproval(self, timeout, default):

1224

1959

"D-Bus signal"

1225

1960

return self.need_approval()

1226

1227

## Methods

1228

1961

1962

# Methods

1963

1229

1964

# Approve - method

1230

1965

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

1231

1966

def Approve(self, value):

1232

1967

self.approve(value)

1233

1968

1234

1969

# CheckedOK - method

1235

1970

@dbus.service.method(_interface)

1236

1971

def CheckedOK(self):

1237

1972

self.checked_ok()

1238

1973

1239

1974

# Enable - method

1975

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

1240

1976

@dbus.service.method(_interface)

1241

1977

def Enable(self):

1242

1978

"D-Bus method"

1243

1979

self.enable()

1244

1980

1245

1981

# StartChecker - method

1982

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

1246

1983

@dbus.service.method(_interface)

1247

1984

def StartChecker(self):

1248

1985

"D-Bus method"

1249

1986

self.start_checker()

1250

1987

1251

1988

# Disable - method

1989

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

1252

1990

@dbus.service.method(_interface)

1253

1991

def Disable(self):

1254

1992

"D-Bus method"

1255

1993

self.disable()

1256

1994

1257

1995

# StopChecker - method

1996

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

1258

1997

@dbus.service.method(_interface)

1259

1998

def StopChecker(self):

1260

1999

self.stop_checker()

1261

1262

## Properties

1263

2000

2001

# Properties

2002

1264

2003

# ApprovalPending - property

1265

2004

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

1266

2005

def ApprovalPending_dbus_property(self):

1267

2006

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

1268

2007

1269

2008

# ApprovedByDefault - property

1270

@dbus_service_property(_interface, signature="b",

2009

@dbus_service_property(_interface,

2010

signature="b",

1271

2011

access="readwrite")

1272

2012

def ApprovedByDefault_dbus_property(self, value=None):

1273

2013

if value is None: # get

1274

2014

return dbus.Boolean(self.approved_by_default)

1275

2015

self.approved_by_default = bool(value)

1276

2016

1277

2017

# ApprovalDelay - property

1278

@dbus_service_property(_interface, signature="t",

2018

@dbus_service_property(_interface,

2019

signature="t",

1279

2020

access="readwrite")

1280

2021

def ApprovalDelay_dbus_property(self, value=None):

1281

2022

if value is None: # get

1282

return dbus.UInt64(self.approval_delay_milliseconds())

2023

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

2024

* 1000)

1283

2025

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

1284

2026

1285

2027

# ApprovalDuration - property

1286

@dbus_service_property(_interface, signature="t",

2028

@dbus_service_property(_interface,

2029

signature="t",

1287

2030

access="readwrite")

1288

2031

def ApprovalDuration_dbus_property(self, value=None):

1289

2032

if value is None: # get

1290

return dbus.UInt64(timedelta_to_milliseconds(

1291

self.approval_duration))

2033

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

2034

* 1000)

1292

2035

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

1293

2036

1294

2037

# Name - property

2038

@dbus_annotations(

2039

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

1295

2040

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

1296

2041

def Name_dbus_property(self):

1297

2042

return dbus.String(self.name)

1298

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

1299

2051

# Fingerprint - property

2052

@dbus_annotations(

2053

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

1300

2054

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

1301

2055

def Fingerprint_dbus_property(self):

1302

2056

return dbus.String(self.fingerprint)

1303

2057

1304

2058

# Host - property

1305

@dbus_service_property(_interface, signature="s",

2059

@dbus_service_property(_interface,

2060

signature="s",

1306

2061

access="readwrite")

1307

2062

def Host_dbus_property(self, value=None):

1308

2063

if value is None: # get

1309

2064

return dbus.String(self.host)

1310

self.host = unicode(value)

1311

2065

self.host = str(value)

2066

1312

2067

# Created - property

2068

@dbus_annotations(

2069

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

1313

2070

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

1314

2071

def Created_dbus_property(self):

1315

2072

return datetime_to_dbus(self.created)

1316

2073

1317

2074

# LastEnabled - property

1318

2075

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

1319

2076

def LastEnabled_dbus_property(self):

1320

2077

return datetime_to_dbus(self.last_enabled)

1321

2078

1322

2079

# Enabled - property

1323

@dbus_service_property(_interface, signature="b",

2080

@dbus_service_property(_interface,

2081

signature="b",

1324

2082

access="readwrite")

1325

2083

def Enabled_dbus_property(self, value=None):

1326

2084

if value is None: # get

1329

2087

self.enable()

1330

2088

else:

1331

2089

self.disable()

1332

2090

1333

2091

# LastCheckedOK - property

1334

@dbus_service_property(_interface, signature="s",

2092

@dbus_service_property(_interface,

2093

signature="s",

1335

2094

access="readwrite")

1336

2095

def LastCheckedOK_dbus_property(self, value=None):

1337

2096

if value is not None:

1338

2097

self.checked_ok()

1339

2098

return

1340

2099

return datetime_to_dbus(self.last_checked_ok)

1341

2100

2101

# LastCheckerStatus - property

2102

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

2103

def LastCheckerStatus_dbus_property(self):

2104

return dbus.Int16(self.last_checker_status)

2105

1342

2106

# Expires - property

1343

2107

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

1344

2108

def Expires_dbus_property(self):

1345

2109

return datetime_to_dbus(self.expires)

1346

2110

1347

2111

# LastApprovalRequest - property

1348

2112

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

1349

2113

def LastApprovalRequest_dbus_property(self):

1350

2114

return datetime_to_dbus(self.last_approval_request)

1351

2115

1352

2116

# Timeout - property

1353

@dbus_service_property(_interface, signature="t",

2117

@dbus_service_property(_interface,

2118

signature="t",

1354

2119

access="readwrite")

1355

2120

def Timeout_dbus_property(self, value=None):

1356

2121

if value is None: # get

1357

return dbus.UInt64(self.timeout_milliseconds())

2122

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

2123

old_timeout = self.timeout

1358

2124

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

1359

# Reschedule timeout

2125

# Reschedule disabling

1360

2126

if self.enabled:

1361

2127

now = datetime.datetime.utcnow()

1362

time_to_die = timedelta_to_milliseconds(

1363

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

1364

if time_to_die <= 0:

2128

self.expires += self.timeout - old_timeout

2129

if self.expires <= now:

1365

2130

# The timeout has passed

1366

2131

self.disable()

1367

2132

else:

1368

self.expires = (now +

1369

datetime.timedelta(milliseconds =

1370

time_to_die))

1371

2133

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

1372

2134

is None):

1373

2135

return

1374

gobject.source_remove(self.disable_initiator_tag)

1375

self.disable_initiator_tag = (gobject.timeout_add

1376

(time_to_die,

1377

self.disable))

1378

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

1379

2141

# ExtendedTimeout - property

1380

@dbus_service_property(_interface, signature="t",

2142

@dbus_service_property(_interface,

2143

signature="t",

1381

2144

access="readwrite")

1382

2145

def ExtendedTimeout_dbus_property(self, value=None):

1383

2146

if value is None: # get

1384

return dbus.UInt64(self.extended_timeout_milliseconds())

2147

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

2148

* 1000)

1385

2149

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

1386

2150

1387

2151

# Interval - property

1388

@dbus_service_property(_interface, signature="t",

2152

@dbus_service_property(_interface,

2153

signature="t",

1389

2154

access="readwrite")

1390

2155

def Interval_dbus_property(self, value=None):

1391

2156

if value is None: # get

1392

return dbus.UInt64(self.interval_milliseconds())

2157

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

1393

2158

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

1394

2159

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

1395

2160

return

1396

2161

if self.enabled:

1397

2162

# Reschedule checker run

1398

gobject.source_remove(self.checker_initiator_tag)

1399

self.checker_initiator_tag = (gobject.timeout_add

1400

(value, self.start_checker))

1401

self.start_checker() # Start one now, too

1402

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

1403

2168

# Checker - property

1404

@dbus_service_property(_interface, signature="s",

2169

@dbus_service_property(_interface,

2170

signature="s",

1405

2171

access="readwrite")

1406

2172

def Checker_dbus_property(self, value=None):

1407

2173

if value is None: # get

1408

2174

return dbus.String(self.checker_command)

1409

self.checker_command = unicode(value)

1410

2175

self.checker_command = str(value)

2176

1411

2177

# CheckerRunning - property

1412

@dbus_service_property(_interface, signature="b",

2178

@dbus_service_property(_interface,

2179

signature="b",

1413

2180

access="readwrite")

1414

2181

def CheckerRunning_dbus_property(self, value=None):

1415

2182

if value is None: # get

1418

2185

self.start_checker()

1419

2186

else:

1420

2187

self.stop_checker()

1421

2188

1422

2189

# ObjectPath - property

2190

@dbus_annotations(

2191

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

2192

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

1423

2193

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

1424

2194

def ObjectPath_dbus_property(self):

1425

return self.dbus_object_path # is already a dbus.ObjectPath

1426

2195

return self.dbus_object_path # is already a dbus.ObjectPath

2196

1427

2197

# Secret = property

1428

@dbus_service_property(_interface, signature="ay",

1429

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)

1430

2205

def Secret_dbus_property(self, value):

1431

self.secret = str(value)

1432

2206

self.secret = bytes(value)

2207

1433

2208

del _interface

1434

2209

1435

2210

1436

2211

class ProxyClient(object):

1437

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

2212

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

1438

2213

self._pipe = child_pipe

1439

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

2214

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

1440

2215

if not self._pipe.recv():

1441

raise KeyError()

1442

2216

raise KeyError(key_id or fpr)

2217

1443

2218

def __getattribute__(self, name):

1444

2219

if name == '_pipe':

1445

2220

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

1448

2223

if data[0] == 'data':

1449

2224

return data[1]

1450

2225

if data[0] == 'function':

2226

1451

2227

def func(*args, **kwargs):

1452

2228

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

1453

2229

return self._pipe.recv()[1]

2230

1454

2231

return func

1455

2232

1456

2233

def __setattr__(self, name, value):

1457

2234

if name == '_pipe':

1458

2235

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

1459

2236

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

1460

2237

1461

2238

1462

class ClientDBusTransitional(ClientDBus):

1463

__metaclass__ = AlternateDBusNamesMetaclass

1464

1465

1466

2239

class ClientHandler(socketserver.BaseRequestHandler, object):

1467

2240

"""A class to handle client connections.

1468

2241

1469

2242

Instantiated once for each connection to handle it.

1470

2243

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

1471

2244

1472

2245

def handle(self):

1473

2246

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

1474

2247

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

1475

unicode(self.client_address))

2248

str(self.client_address))

1476

2249

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

1477

2250

self.server.child_pipe.fileno())

1478

1479

session = (gnutls.connection

1480

.ClientSession(self.request,

1481

gnutls.connection

1482

.X509Credentials()))

1483

1484

# Note: gnutls.connection.X509Credentials is really a

1485

# generic GnuTLS certificate credentials object so long as

1486

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

1487

# here despite using OpenPGP certificates.

1488

1489

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

1490

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

1491

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

1492

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

1493

2258

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

1494

2259

priority = self.server.gnutls_priority

1495

2260

if priority is None:

1496

2261

priority = "NORMAL"

1497

(gnutls.library.functions

1498

.gnutls_priority_set_direct(session._c_object,

1499

priority, None))

1500

2262

gnutls.priority_set_direct(session._c_object,

2263

priority.encode("utf-8"),

2264

None)

2265

1501

2266

# Start communication using the Mandos protocol

1502

2267

# Get protocol number

1503

2268

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

1504

2269

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

1505

2270

try:

1506

2271

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

1507

raise RuntimeError

2272

raise RuntimeError(line)

1508

2273

except (ValueError, IndexError, RuntimeError) as error:

1509

2274

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

1510

2275

return

1511

2276

1512

2277

# Start GnuTLS connection

1513

2278

try:

1514

2279

session.handshake()

1515

except gnutls.errors.GNUTLSError as error:

2280

except gnutls.Error as error:

1516

2281

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

1517

2282

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

1518

2283

# established. Just abandon the request.

1519

2284

return

1520

2285

logger.debug("Handshake succeeded")

1521

2286

1522

2287

approval_required = False

1523

2288

try:

1524

try:

1525

fpr = self.fingerprint(self.peer_certificate

1526

(session))

1527

except (TypeError,

1528

gnutls.errors.GNUTLSError) as error:

1529

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

1530

return

1531

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

1532

1533

try:

1534

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,

1535

2311

self.client_address)

1536

2312

except KeyError:

1537

2313

return

1538

2314

1539

2315

if client.approval_delay:

1540

2316

delay = client.approval_delay

1541

2317

client.approvals_pending += 1

1542

2318

approval_required = True

1543

2319

1544

2320

while True:

1545

2321

if not client.enabled:

1546

2322

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

1547

client.name)

2323

client.name)

1548

2324

if self.server.use_dbus:

1549

2325

# Emit D-Bus signal

1550

2326

client.Rejected("Disabled")

1551

2327

return

1552

2328

1553

2329

if client.approved or not client.approval_delay:

1554

#We are approved or approval is disabled

2330

# We are approved or approval is disabled

1555

2331

break

1556

2332

elif client.approved is None:

1557

2333

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

1559

2335

if self.server.use_dbus:

1560

2336

# Emit D-Bus signal

1561

2337

client.NeedApproval(

1562

client.approval_delay_milliseconds(),

1563

client.approved_by_default)

2338

client.approval_delay.total_seconds()

2339

* 1000, client.approved_by_default)

1564

2340

else:

1565

2341

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

1566

2342

client.name)

1568

2344

# Emit D-Bus signal

1569

2345

client.Rejected("Denied")

1570

2346

return

1571

1572

#wait until timeout or approved

2347

2348

# wait until timeout or approved

1573

2349

time = datetime.datetime.now()

1574

2350

client.changedstate.acquire()

1575

(client.changedstate.wait

1576

(float(client.timedelta_to_milliseconds(delay)

1577

/ 1000)))

2351

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

1578

2352

client.changedstate.release()

1579

2353

time2 = datetime.datetime.now()

1580

2354

if (time2 - time) >= delay:

1590

2364

break

1591

2365

else:

1592

2366

delay -= time2 - time

1593

1594

sent_size = 0

1595

while sent_size < len(client.secret):

1596

try:

1597

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

1598

except gnutls.errors.GNUTLSError as error:

1599

logger.warning("gnutls send failed")

1600

return

1601

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

1602

sent, len(client.secret)

1603

- (sent_size + sent))

1604

sent_size += sent

1605

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

1606

2375

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

1607

2376

# bump the timeout using extended_timeout

1608

client.checked_ok(client.extended_timeout)

2377

client.bump_timeout(client.extended_timeout)

1609

2378

if self.server.use_dbus:

1610

2379

# Emit D-Bus signal

1611

2380

client.GotSecret()

1612

2381

1613

2382

finally:

1614

2383

if approval_required:

1615

2384

client.approvals_pending -= 1

1616

2385

try:

1617

2386

session.bye()

1618

except gnutls.errors.GNUTLSError as error:

1619

logger.warning("GnuTLS bye failed")

1620

2387

except gnutls.Error as error:

2388

logger.warning("GnuTLS bye failed",

2389

exc_info=error)

2390

1621

2391

@staticmethod

1622

2392

def peer_certificate(session):

1623

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

1624

# If not an OpenPGP certificate...

1625

if (gnutls.library.functions

1626

.gnutls_certificate_type_get(session._c_object)

1627

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1628

# ...do the normal thing

1629

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

1630

2409

list_size = ctypes.c_uint(1)

1631

cert_list = (gnutls.library.functions

1632

.gnutls_certificate_get_peers

2410

cert_list = (gnutls.certificate_get_peers

1633

2411

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

1634

2412

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

1635

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

1636

" certificate")

2413

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

1637

2414

if list_size.value == 0:

1638

2415

return None

1639

2416

cert = cert_list[0]

1640

2417

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

1641

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

1642

2453

@staticmethod

1643

2454

def fingerprint(openpgp):

1644

2455

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1645

2456

# New GnuTLS "datum" with the OpenPGP public key

1646

datum = (gnutls.library.types

1647

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

1648

ctypes.POINTER

1649

(ctypes.c_ubyte)),

1650

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

1651

2461

# New empty GnuTLS certificate

1652

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1653

(gnutls.library.functions

1654

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2462

crt = gnutls.openpgp_crt_t()

2463

gnutls.openpgp_crt_init(ctypes.byref(crt))

1655

2464

# Import the OpenPGP public key into the certificate

1656

(gnutls.library.functions

1657

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

1658

gnutls.library.constants

1659

.GNUTLS_OPENPGP_FMT_RAW))

2465

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

2466

gnutls.OPENPGP_FMT_RAW)

1660

2467

# Verify the self signature in the key

1661

2468

crtverify = ctypes.c_uint()

1662

(gnutls.library.functions

1663

.gnutls_openpgp_crt_verify_self(crt, 0,

1664

ctypes.byref(crtverify)))

2469

gnutls.openpgp_crt_verify_self(crt, 0,

2470

ctypes.byref(crtverify))

1665

2471

if crtverify.value != 0:

1666

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1667

raise (gnutls.errors.CertificateSecurityError

1668

("Verify failed"))

2472

gnutls.openpgp_crt_deinit(crt)

2473

raise gnutls.CertificateSecurityError(code

2474

=crtverify.value)

1669

2475

# New buffer for the fingerprint

1670

2476

buf = ctypes.create_string_buffer(20)

1671

2477

buf_len = ctypes.c_size_t()

1672

2478

# Get the fingerprint from the certificate into the buffer

1673

(gnutls.library.functions

1674

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

1675

ctypes.byref(buf_len)))

2479

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

2480

ctypes.byref(buf_len))

1676

2481

# Deinit the certificate

1677

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2482

gnutls.openpgp_crt_deinit(crt)

1678

2483

# Convert the buffer to a Python bytestring

1679

2484

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

1680

2485

# Convert the bytestring to hexadecimal notation

1684

2489

1685

2490

class MultiprocessingMixIn(object):

1686

2491

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

2492

1687

2493

def sub_process_main(self, request, address):

1688

2494

try:

1689

2495

self.finish_request(request, address)

1690

2496

except Exception:

1691

2497

self.handle_error(request, address)

1692

2498

self.close_request(request)

1693

2499

1694

2500

def process_request(self, request, address):

1695

2501

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

1696

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

1697

args = (request,

1698

address))

2502

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

2503

args=(request, address))

1699

2504

proc.start()

1700

2505

return proc

1701

2506

1702

2507

1703

2508

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1704

2509

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

2510

1705

2511

def process_request(self, request, client_address):

1706

2512

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

1707

2513

1708

2514

This function creates a new pipe in self.pipe

1709

2515

"""

1710

2516

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1711

2517

1712

2518

proc = MultiprocessingMixIn.process_request(self, request,

1713

2519

client_address)

1714

2520

self.child_pipe.close()

1715

2521

self.add_pipe(parent_pipe, proc)

1716

2522

1717

2523

def add_pipe(self, parent_pipe, proc):

1718

2524

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

1719

raise NotImplementedError

2525

raise NotImplementedError()

1720

2526

1721

2527

1722

2528

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1723

2529

socketserver.TCPServer, object):

1724

2530

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

1725

2531

1726

2532

Attributes:

1727

2533

enabled: Boolean; whether this server is activated yet

1728

2534

interface: None or a network interface name (string)

1729

2535

use_ipv6: Boolean; to use IPv6 or not

1730

2536

"""

2537

1731

2538

def __init__(self, server_address, RequestHandlerClass,

1732

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

"""

1733

2545

self.interface = interface

1734

2546

if use_ipv6:

1735

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.

1736

2575

socketserver.TCPServer.__init__(self, server_address,

1737

2576

RequestHandlerClass)

2577

1738

2578

def server_bind(self):

1739

2579

"""This overrides the normal server_bind() function

1740

2580

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

1741

2581

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

2582

global SO_BINDTODEVICE

1742

2583

if self.interface is not None:

1743

2584

if SO_BINDTODEVICE is None:

1744

logger.error("SO_BINDTODEVICE does not exist;"

1745

" cannot bind to interface %s",

1746

self.interface)

1747

else:

1748

try:

1749

self.socket.setsockopt(socket.SOL_SOCKET,

1750

SO_BINDTODEVICE,

1751

str(self.interface

1752

+ '\0'))

1753

except socket.error as error:

1754

if error[0] == errno.EPERM:

1755

logger.error("No permission to"

1756

" bind to interface %s",

1757

self.interface)

1758

elif error[0] == errno.ENOPROTOOPT:

1759

logger.error("SO_BINDTODEVICE not available;"

1760

" cannot bind to interface %s",

1761

self.interface)

1762

else:

1763

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

1764

2606

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

1765

2607

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

1766

2608

if not self.server_address[0]:

1767

2609

if self.address_family == socket.AF_INET6:

1768

any_address = "::" # in6addr_any

2610

any_address = "::" # in6addr_any

1769

2611

else:

1770

any_address = socket.INADDR_ANY

2612

any_address = "0.0.0.0" # INADDR_ANY

1771

2613

self.server_address = (any_address,

1772

2614

self.server_address[1])

1773

2615

elif not self.server_address[1]:

1774

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

1775

0)

2616

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

1776

2617

# if self.interface:

1777

2618

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

1778

2619

# 0, # port

1784

2625

1785

2626

class MandosServer(IPv6_TCPServer):

1786

2627

"""Mandos server.

1787

2628

1788

2629

Attributes:

1789

2630

clients: set of Client objects

1790

2631

gnutls_priority GnuTLS priority string

1791

2632

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

1792

1793

Assumes a gobject.MainLoop event loop.

2633

2634

Assumes a GLib.MainLoop event loop.

1794

2635

"""

2636

1795

2637

def __init__(self, server_address, RequestHandlerClass,

1796

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

1797

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

1798

2644

self.enabled = False

1799

2645

self.clients = clients

1800

2646

if self.clients is None:

1803

2649

self.gnutls_priority = gnutls_priority

1804

2650

IPv6_TCPServer.__init__(self, server_address,

1805

2651

RequestHandlerClass,

1806

interface = interface,

1807

use_ipv6 = use_ipv6)

2652

interface=interface,

2653

use_ipv6=use_ipv6,

2654

socketfd=socketfd)

2655

1808

2656

def server_activate(self):

1809

2657

if self.enabled:

1810

2658

return socketserver.TCPServer.server_activate(self)

1811

2659

1812

2660

def enable(self):

1813

2661

self.enabled = True

1814

2662

1815

2663

def add_pipe(self, parent_pipe, proc):

1816

2664

# Call "handle_ipc" for both data and EOF events

1817

gobject.io_add_watch(parent_pipe.fileno(),

1818

gobject.IO_IN | gobject.IO_HUP,

1819

functools.partial(self.handle_ipc,

1820

parent_pipe =

1821

parent_pipe,

1822

proc = proc))

1823

1824

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

1825

proc = None, client_object=None):

1826

condition_names = {

1827

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

1828

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

1829

# blocking).

1830

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

1831

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

1832

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

1833

# broken, usually for pipes and

1834

# sockets).

1835

}

1836

conditions_string = ' | '.join(name

1837

for cond, name in

1838

condition_names.iteritems()

1839

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

1840

2676

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

1841

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

2677

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

1842

2678

# Wait for other process to exit

1843

2679

proc.join()

1844

2680

return False

1845

2681

1846

2682

# Read a request from the child

1847

2683

request = parent_pipe.recv()

1848

2684

command = request[0]

1849

2685

1850

2686

if command == 'init':

1851

fpr = request[1]

1852

address = request[2]

1853

1854

for c in self.clients.itervalues():

1855

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:

1856

2698

client = c

1857

2699

break

1858

2700

else:

1859

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

1860

"dress: %s", fpr, address)

2701

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

2702

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

1861

2703

if self.use_dbus:

1862

2704

# Emit D-Bus signal

1863

mandos_dbus_service.ClientNotFound(fpr,

2705

mandos_dbus_service.ClientNotFound(key_id or fpr,

1864

2706

address[0])

1865

2707

parent_pipe.send(False)

1866

2708

return False

1867

1868

gobject.io_add_watch(parent_pipe.fileno(),

1869

gobject.IO_IN | gobject.IO_HUP,

1870

functools.partial(self.handle_ipc,

1871

parent_pipe =

1872

parent_pipe,

1873

proc = proc,

1874

client_object =

1875

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

1876

2717

parent_pipe.send(True)

1877

2718

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

1878

2719

# same fileno

1881

2722

funcname = request[1]

1882

2723

args = request[2]

1883

2724

kwargs = request[3]

1884

2725

1885

2726

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

1886

2727

funcname)(*args,

1887

**kwargs)))

1888

2728

**kwargs)))

2729

1889

2730

if command == 'getattr':

1890

2731

attrname = request[1]

1891

if callable(client_object.__getattribute__(attrname)):

1892

parent_pipe.send(('function',))

2732

if isinstance(client_object.__getattribute__(attrname),

2733

collections.Callable):

2734

parent_pipe.send(('function', ))

1893

2735

else:

1894

parent_pipe.send(('data', client_object

1895

.__getattribute__(attrname)))

1896

2736

parent_pipe.send((

2737

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

2738

1897

2739

if command == 'setattr':

1898

2740

attrname = request[1]

1899

2741

value = request[2]

1900

2742

setattr(client_object, attrname, value)

1901

2743

1902

2744

return True

1903

2745

1904

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

1905

2846

def string_to_delta(interval):

1906

2847

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

1907

2848

1908

2849

>>> string_to_delta('7d')

1909

2850

datetime.timedelta(7)

1910

2851

>>> string_to_delta('60s')

1918

2859

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

1919

2860

datetime.timedelta(0, 330)

1920

2861

"""

2862

2863

try:

2864

return rfc3339_duration_to_delta(interval)

2865

except ValueError:

2866

pass

2867

1921

2868

timevalue = datetime.timedelta(0)

1922

2869

for s in interval.split():

1923

2870

try:

1924

suffix = unicode(s[-1])

2871

suffix = s[-1]

1925

2872

value = int(s[:-1])

1926

2873

if suffix == "d":

1927

2874

delta = datetime.timedelta(value)

1934

2881

elif suffix == "w":

1935

2882

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

1936

2883

else:

1937

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

1938

except (ValueError, IndexError) as e:

2884

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

2885

except IndexError as e:

1939

2886

raise ValueError(*(e.args))

1940

2887

timevalue += delta

1941

2888

return timevalue

1942

2889

1943

2890

1944

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

2891

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

1945

2892

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

1946

2893

1947

2894

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

1948

2895

if os.fork():

1949

2896

sys.exit()

1954

2901

sys.exit()

1955

2902

if not noclose:

1956

2903

# Close all standard open file descriptors

1957

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

2904

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

1958

2905

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

1959

2906

raise OSError(errno.ENODEV,

1960

"%s not a character device"

1961

% os.path.devnull)

2907

"{} not a character device"

2908

.format(os.devnull))

1962

2909

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

1963

2910

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

1964

2911

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

1967

2914

1968

2915

1969

2916

def main():

1970

2917

1971

2918

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

1972

2919

# Parsing of options, both command line and config file

1973

2920

1974

2921

parser = argparse.ArgumentParser()

1975

2922

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

1976

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

2923

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

1977

2924

help="show version number and exit")

1978

2925

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

1979

2926

help="Bind to interface IF")

1985

2932

help="Run self-test")

1986

2933

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

1987

2934

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

1988

" to terminal")

2935

" to terminal", default=None)

1989

2936

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

1990

2937

help="Debug level for stdout output")

1991

2938

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

1998

2945

" files")

1999

2946

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

2000

2947

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

2001

" system bus interface")

2948

" system bus interface", default=None)

2002

2949

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

2003

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

2950

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

2951

default=None)

2004

2952

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

2005

2953

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

2006

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

2007

2958

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

2008

2959

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

2009

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

2010

2966

options = parser.parse_args()

2011

2967

2012

2968

if options.check:

2013

2969

import doctest

2014

doctest.testmod()

2015

sys.exit()

2016

2970

fail_count, test_count = doctest.testmod()

2971

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

2972

2017

2973

# Default values for config file for server-global settings

2018

server_defaults = { "interface": "",

2019

"address": "",

2020

"port": "",

2021

"debug": "False",

2022

"priority":

2023

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

2024

"servicename": "Mandos",

2025

"use_dbus": "True",

2026

"use_ipv6": "True",

2027

"debuglevel": "",

2028

"restore": "True",

2029

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

2030

}

2031

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

2032

2997

# Parse config file for server-global settings

2033

2998

server_config = configparser.SafeConfigParser(server_defaults)

2034

2999

del server_defaults

2035

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

2036

"mandos.conf"))

3000

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

2037

3001

# Convert the SafeConfigParser object to a dict

2038

3002

server_settings = server_config.defaults()

2039

3003

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

2040

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

3004

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

3005

"foreground", "zeroconf"):

2041

3006

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

2042

3007

option)

2043

3008

if server_settings["port"]:

2044

3009

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

2045

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

2046

3020

del server_config

2047

3021

2048

3022

# Override the settings from the config file with command line

2049

3023

# options, if set.

2050

3024

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

2051

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

2052

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

2053

"statedir"):

3025

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

3026

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

3027

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

2054

3028

value = getattr(options, option)

2055

3029

if value is not None:

2056

3030

server_settings[option] = value

2057

3031

del options

2058

3032

# Force all strings to be unicode

2059

3033

for option in server_settings.keys():

2060

if type(server_settings[option]) is str:

2061

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

2062

3044

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

2063

3045

2064

3046

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

2065

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

2066

3053

# For convenience

2067

3054

debug = server_settings["debug"]

2068

3055

debuglevel = server_settings["debuglevel"]

2070

3057

use_ipv6 = server_settings["use_ipv6"]

2071

3058

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

2072

3059

stored_state_file)

2073

3060

foreground = server_settings["foreground"]

3061

zeroconf = server_settings["zeroconf"]

3062

2074

3063

if debug:

2075

3064

initlogger(debug, logging.DEBUG)

2076

3065

else:

2079

3068

else:

2080

3069

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

2081

3070

initlogger(debug, level)

2082

3071

2083

3072

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

2084

syslogger.setFormatter(logging.Formatter

2085

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

2086

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

2087

% server_settings["servicename"]))

2088

3073

syslogger.setFormatter(

3074

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

3075

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

3076

server_settings["servicename"])))

3077

2089

3078

# Parse config file with clients

2090

3079

client_config = configparser.SafeConfigParser(Client

2091

3080

.client_defaults)

2092

3081

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

2093

3082

"clients.conf"))

2094

3083

2095

3084

global mandos_dbus_service

2096

3085

mandos_dbus_service = None

2097

2098

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

2099

server_settings["port"]),

2100

ClientHandler,

2101

interface=(server_settings["interface"]

2102

or None),

2103

use_ipv6=use_ipv6,

2104

gnutls_priority=

2105

server_settings["priority"],

2106

use_dbus=use_dbus)

2107

if not debug:

2108

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

2109

try:

2110

pidfile = open(pidfilename, "w")

2111

except IOError:

2112

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

2113

2114

try:

2115

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

2116

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

2117

except KeyError:

2118

try:

2119

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

2120

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

2121

3116

except KeyError:

2122

try:

2123

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

2124

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

2125

except KeyError:

2126

uid = 65534

2127

gid = 65534

3117

continue

3118

else:

3119

uid = 65534

3120

gid = 65534

2128

3121

try:

2129

3122

os.setgid(gid)

2130

3123

os.setuid(uid)

3124

if debug:

3125

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

3126

gid))

2131

3127

except OSError as error:

2132

if error[0] != errno.EPERM:

2133

raise error

2134

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

2135

3133

if debug:

2136

3134

# Enable all possible GnuTLS debugging

2137

3135

2138

3136

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

2139

3137

# - GnuTLS manual

2140

gnutls.library.functions.gnutls_global_set_log_level(11)

2141

2142

@gnutls.library.types.gnutls_log_func

3138

gnutls.global_set_log_level(11)

3139

3140

@gnutls.log_func

2143

3141

def debug_gnutls(level, string):

2144

3142

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

2145

2146

(gnutls.library.functions

2147

.gnutls_global_set_log_function(debug_gnutls))

2148

3143

3144

gnutls.global_set_log_function(debug_gnutls)

3145

2149

3146

# Redirect stdin so all checkers get /dev/null

2150

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

3147

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

2151

3148

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

2152

3149

if null > 2:

2153

3150

os.close(null)

2154

3151

2155

3152

# Need to fork before connecting to D-Bus

2156

if not debug:

3153

if not foreground:

2157

3154

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

2158

3155

daemon()

2159

2160

gobject.threads_init()

2161

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

2162

3161

global main_loop

2163

3162

# From the Avahi example code

2164

DBusGMainLoop(set_as_default=True )

2165

main_loop = gobject.MainLoop()

3163

DBusGMainLoop(set_as_default=True)

3164

main_loop = GLib.MainLoop()

2166

3165

bus = dbus.SystemBus()

2167

3166

# End of Avahi example code

2168

3167

if use_dbus:

2169

3168

try:

2170

3169

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

2171

bus, do_not_queue=True)

2172

old_bus_name = (dbus.service.BusName

2173

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

2174

do_not_queue=True))

2175

except dbus.exceptions.NameExistsException as e:

2176

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)

2177

3177

use_dbus = False

2178

3178

server_settings["use_dbus"] = False

2179

3179

tcp_server.use_dbus = False

2180

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2181

service = AvahiServiceToSyslog(name =

2182

server_settings["servicename"],

2183

servicetype = "_mandos._tcp",

2184

protocol = protocol, bus = bus)

2185

if server_settings["interface"]:

2186

service.interface = (if_nametoindex

2187

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

2188

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

2189

3191

global multiprocessing_manager

2190

3192

multiprocessing_manager = multiprocessing.Manager()

2191

3193

2192

3194

client_class = Client

2193

3195

if use_dbus:

2194

client_class = functools.partial(ClientDBusTransitional,

2195

bus = bus)

2196

3196

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

3197

2197

3198

client_settings = Client.config_parser(client_config)

2198

3199

old_client_settings = {}

2199

3200

clients_data = {}

2200

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

2201

3210

# Get client data and settings from last running state.

2202

3211

if server_settings["restore"]:

2203

3212

try:

2204

3213

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

2205

clients_data, old_client_settings = (pickle.load

2206

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

2207

3263

os.remove(stored_state_path)

2208

3264

except IOError as e:

2209

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

2210

.format(e))

2211

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)

2212

3271

raise

2213

3272

except EOFError as e:

2214

3273

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

2215

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

2216

3274

"EOFError:",

3275

exc_info=e)

3276

2217

3277

with PGPEngine() as pgp:

2218

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

2219

3283

# Decide which value to use after restoring saved state.

2220

3284

# We have three different values: Old config file,

2221

3285

# new config file, and saved state.

2226

3290

# For each value in new config, check if it

2227

3291

# differs from the old config value (Except for

2228

3292

# the "secret" attribute)

2229

if (name != "secret" and

2230

value != old_client_settings[client_name]

2231

[name]):

3293

if (name != "secret"

3294

and (value !=

3295

old_client_settings[client_name][name])):

2232

3296

client[name] = value

2233

3297

except KeyError:

2234

3298

pass

2235

3299

2236

3300

# Clients who has passed its expire date can still be

2237

# enabled if its last checker was successful. Clients

3301

# enabled if its last checker was successful. A Client

2238

3302

# whose checker succeeded before we stored its state is

2239

3303

# assumed to have successfully run all checkers during

2240

3304

# downtime.

2242

3306

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

2243

3307

if not client["last_checked_ok"]:

2244

3308

logger.warning(

2245

"disabling client {0} - Client never "

2246

"performed a successful checker"

2247

.format(client_name))

3309

"disabling client {} - Client never "

3310

"performed a successful checker".format(

3311

client_name))

2248

3312

client["enabled"] = False

2249

3313

elif client["last_checker_status"] != 0:

2250

3314

logger.warning(

2251

"disabling client {0} - Client "

2252

"last checker failed with error code {1}"

2253

.format(client_name,

2254

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

2255

3320

client["enabled"] = False

2256

3321

else:

2257

client["expires"] = (datetime.datetime

2258

.utcnow()

2259

+ client["timeout"])

3322

client["expires"] = (

3323

datetime.datetime.utcnow()

3324

+ client["timeout"])

2260

3325

logger.debug("Last checker succeeded,"

2261

" keeping {0} enabled"

2262

.format(client_name))

3326

" keeping {} enabled".format(

3327

client_name))

2263

3328

try:

2264

client["secret"] = (

2265

pgp.decrypt(client["encrypted_secret"],

2266

client_settings[client_name]

2267

["secret"]))

3329

client["secret"] = pgp.decrypt(

3330

client["encrypted_secret"],

3331

client_settings[client_name]["secret"])

2268

3332

except PGPError:

2269

3333

# If decryption fails, we use secret from new settings

2270

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

2271

.format(client_name))

2272

client["secret"] = (

2273

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

2274

3338

2275

2276

3339

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

2277

3340

for client_name in (set(old_client_settings)

2278

3341

- set(client_settings)):

2282

3345

clients_data[client_name] = client_settings[client_name]

2283

3346

2284

3347

# Create all client objects

2285

for client_name, client in clients_data.iteritems():

3348

for client_name, client in clients_data.items():

2286

3349

tcp_server.clients[client_name] = client_class(

2287

name = client_name, settings = client)

2288

3350

name=client_name,

3351

settings=client,

3352

server_settings=server_settings)

3353

2289

3354

if not tcp_server.clients:

2290

3355

logger.warning("No clients defined")

2291

2292

if not debug:

2293

try:

2294

with pidfile:

2295

pid = os.getpid()

2296

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

2297

del pidfile

2298

except IOError:

2299

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

2300

pidfilename, pid)

2301

except NameError:

2302

# "pidfile" was never created

2303

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

2304

3367

del pidfilename

2305

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

2306

2307

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

2308

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

2309

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

2310

3373

if use_dbus:

2311

class MandosDBusService(dbus.service.Object):

3374

3375

@alternate_dbus_interfaces(

3376

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

3377

class MandosDBusService(DBusObjectWithObjectManager):

2312

3378

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

3379

2313

3380

def __init__(self):

2314

3381

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

3382

2315

3383

_interface = "se.recompile.Mandos"

2316

3384

2317

3385

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

2318

3386

def ClientAdded(self, objpath):

2319

3387

"D-Bus signal"

2320

3388

pass

2321

3389

2322

3390

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

2323

def ClientNotFound(self, fingerprint, address):

3391

def ClientNotFound(self, key_id, address):

2324

3392

"D-Bus signal"

2325

3393

pass

2326

3394

3395

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

3396

"true"})

2327

3397

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

2328

3398

def ClientRemoved(self, objpath, name):

2329

3399

"D-Bus signal"

2330

3400

pass

2331

3401

3402

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

3403

"true"})

2332

3404

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

2333

3405

def GetAllClients(self):

2334

3406

"D-Bus method"

2335

return dbus.Array(c.dbus_object_path

2336

for c in

2337

tcp_server.clients.itervalues())

2338

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

2339

3412

@dbus.service.method(_interface,

2340

3413

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

2341

3414

def GetAllClientsWithProperties(self):

2342

3415

"D-Bus method"

2343

3416

return dbus.Dictionary(

2344

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

2345

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

2346

3420

signature="oa{sv}")

2347

3421

2348

3422

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

2349

3423

def RemoveClient(self, object_path):

2350

3424

"D-Bus method"

2351

for c in tcp_server.clients.itervalues():

3425

for c in tcp_server.clients.values():

2352

3426

if c.dbus_object_path == object_path:

2353

3427

del tcp_server.clients[c.name]

2354

3428

c.remove_from_connection()

2355

# Don't signal anything except ClientRemoved

3429

# Don't signal the disabling

2356

3430

c.disable(quiet=True)

2357

# Emit D-Bus signal

2358

self.ClientRemoved(object_path, c.name)

3431

# Emit D-Bus signal for removal

3432

self.client_removed_signal(c)

2359

3433

return

2360

3434

raise KeyError(object_path)

2361

3435

2362

3436

del _interface

2363

2364

class MandosDBusServiceTransitional(MandosDBusService):

2365

__metaclass__ = AlternateDBusNamesMetaclass

2366

mandos_dbus_service = MandosDBusServiceTransitional()

2367

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

2368

3481

def cleanup():

2369

3482

"Cleanup function; run on exit"

2370

service.cleanup()

2371

2372

multiprocessing.active_children()

3483

if zeroconf:

3484

service.cleanup()

3485

3486

mp.active_children()

3487

wn.close()

2373

3488

if not (tcp_server.clients or client_settings):

2374

3489

return

2375

3490

2376

3491

# Store client before exiting. Secrets are encrypted with key

2377

3492

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

2378

3493

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

2379

3494

clients = {}

2380

3495

with PGPEngine() as pgp:

2381

for client in tcp_server.clients.itervalues():

3496

for client in tcp_server.clients.values():

2382

3497

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

2383

3498

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

2384

3499

key)

2385

3500

client_dict = {}

2386

3501

2387

3502

# A list of attributes that can not be pickled

2388

3503

# + secret.

2389

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

2390

"checker"))

2391

for name, typ in (inspect.getmembers

2392

(dbus.service.Object)):

3504

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

3505

"checker", "server_settings"}

3506

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

3507

.Object):

2393

3508

exclude.add(name)

2394

3509

2395

3510

client_dict["encrypted_secret"] = (client

2396

3511

.encrypted_secret)

2397

3512

for attr in client.client_structure:

2398

3513

if attr not in exclude:

2399

3514

client_dict[attr] = getattr(client, attr)

2400

3515

2401

3516

clients[client.name] = client_dict

2402

3517

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

2403

3518

2404

3519

try:

2405

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

2406

prefix="clients-",

2407

dir=os.path.dirname

2408

(stored_state_path))

2409

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

2410

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

2411

3529

os.rename(tempname, stored_state_path)

2412

3530

except (IOError, OSError) as e:

2413

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

2414

.format(e))

2415

3531

if not debug:

2416

3532

try:

2417

3533

os.remove(tempname)

2418

3534

except NameError:

2419

3535

pass

2420

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

2421

errno.EEXIST)):

2422

raise e

2423

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

2424

3544

# Delete all clients, and settings from config

2425

3545

while tcp_server.clients:

2426

3546

name, client = tcp_server.clients.popitem()

2427

3547

if use_dbus:

2428

3548

client.remove_from_connection()

2429

# Don't signal anything except ClientRemoved

3549

# Don't signal the disabling

2430

3550

client.disable(quiet=True)

3551

# Emit D-Bus signal for removal

2431

3552

if use_dbus:

2432

# Emit D-Bus signal

2433

mandos_dbus_service.ClientRemoved(client

2434

.dbus_object_path,

2435

client.name)

3553

mandos_dbus_service.client_removed_signal(client)

2436

3554

client_settings.clear()

2437

3555

2438

3556

atexit.register(cleanup)

2439

2440

for client in tcp_server.clients.itervalues():

3557

3558

for client in tcp_server.clients.values():

2441

3559

if use_dbus:

2442

# Emit D-Bus signal

2443

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3560

# Emit D-Bus signal for adding

3561

mandos_dbus_service.client_added_signal(client)

2444

3562

# Need to initiate checking of clients

2445

3563

if client.enabled:

2446

3564

client.init_checker()

2447

3565

2448

3566

tcp_server.enable()

2449

3567

tcp_server.server_activate()

2450

3568

2451

3569

# Find out what port we got

2452

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

3570

if zeroconf:

3571

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

2453

3572

if use_ipv6:

2454

3573

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

2455

" flowinfo %d, scope_id %d"

2456

% tcp_server.socket.getsockname())

3574

" flowinfo %d, scope_id %d",

3575

*tcp_server.socket.getsockname())

2457

3576

else: # IPv4

2458

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

2459

% tcp_server.socket.getsockname())

2460

2461

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

2462

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

2463

3582

try:

2464

# From the Avahi example code

2465

try:

2466

service.activate()

2467

except dbus.exceptions.DBusException as error:

2468

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

2469

cleanup()

2470

sys.exit(1)

2471

# End of Avahi example code

2472

2473

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

2474

lambda *args, **kwargs:

2475

(tcp_server.handle_request

2476

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

2477

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

2478

3598

logger.debug("Starting main loop")

2479

3599

main_loop.run()

2480

3600

except AvahiError as error:

2481

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

3601

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

2482

3602

cleanup()

2483

3603

sys.exit(1)

2484

3604

except KeyboardInterrupt:

2489

3609

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

2490

3610

cleanup()

2491

3611

3612

2492

3613

if __name__ == '__main__':

2493

3614

main()