/mandos/trunk : revision 927

1

#!/usr/bin/python

2

# -*- mode: python; coding: utf-8 -*-

3

#

3

#

4

# Mandos server - give out binary blobs to connecting clients.

5

#

5

#

6

# This program is partly derived from an example program for an Avahi

7

# service publisher, downloaded from

8

# <http://avahi.org/wiki/PythonPublishExample>. This includes the

9

# methods "add", "remove", "server_state_changed",

10

# "entry_group_state_changed", "cleanup", and "activate" in the

11

# "AvahiService" class, and some lines in "main".

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This program is free software: you can redistribute it and/or modify

18

# it under the terms of the GNU General Public License as published by

14

15

16

#

17

# This file is part of Mandos.

18

#

19

# Mandos is free software: you can redistribute it and/or modify it

20

# under the terms of the GNU General Public License as published by

19

21

# the Free Software Foundation, either version 3 of the License, or

20

22

# (at your option) any later version.

21

23

#

22

# This program is distributed in the hope that it will be useful,

23

# but WITHOUT ANY WARRANTY; without even the implied warranty of

24

# Mandos is distributed in the hope that it will be useful, but

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

# You should have received a copy of the GNU General Public License

28

# along with this program. If not, see

29

# <http://www.gnu.org/licenses/>.

30

#

30

# along with Mandos. If not, see <http://www.gnu.org/licenses/>.

31

#

31

32

# Contact the authors at <mandos@recompile.se>.

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

72

80

73

81

import dbus

74

82

import dbus.service

75

import gobject

76

import avahi

83

from gi.repository import GLib

77

84

from dbus.mainloop.glib import DBusGMainLoop

78

85

import ctypes

79

86

import ctypes.util

80

87

import xml.dom.minidom

81

88

import inspect

82

89

90

# Try to find the value of SO_BINDTODEVICE:

83

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:

84

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

95

except AttributeError:

86

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

87

99

from IN import SO_BINDTODEVICE

88

100

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.0"

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

92

119

stored_state_file = "clients.pickle"

93

120

94

121

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

122

syslogger = None

98

123

99

124

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

103

127

except (OSError, AttributeError):

128

104

129

def if_nametoindex(interface):

105

130

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

106

131

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

107

132

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

108

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

134

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

135

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

113

136

return interface_index

114

137

115

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

116

155

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

117

156

"""init logger and add loglevel"""

118

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

119

162

syslogger.setFormatter(logging.Formatter

120

163

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

121

164

' %(message)s'))

122

165

logger.addHandler(syslogger)

123

166

124

167

if debug:

125

168

console = logging.StreamHandler()

126

169

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

138

181

139

182

class PGPEngine(object):

140

183

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

184

141

185

def __init__(self):

142

186

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

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

143

198

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

199

'--homedir', self.tempdir,

145

200

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

148

201

'--quiet']

202

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

203

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

204

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

205

149

206

def __enter__(self):

150

207

return self

151

208

152

209

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

153

210

self._cleanup()

154

211

return False

155

212

156

213

def __del__(self):

157

214

self._cleanup()

158

215

159

216

def _cleanup(self):

160

217

if self.tempdir is not None:

161

218

# Delete contents of tempdir

162

219

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

163

topdown = False):

220

topdown=False):

164

221

for filename in files:

165

222

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

166

223

for dirname in dirs:

168

225

# Remove tempdir

169

226

os.rmdir(self.tempdir)

170

227

self.tempdir = None

171

228

172

229

def password_encode(self, password):

173

230

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

174

231

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

175

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

176

232

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

233

if len(encoded) > 2048:

234

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

235

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

236

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

237

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

238

return encoded

239

177

240

def encrypt(self, data, password):

178

241

passphrase = self.password_encode(password)

179

with tempfile.NamedTemporaryFile(dir=self.tempdir

180

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

181

244

passfile.write(passphrase)

182

245

passfile.flush()

183

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

246

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

184

247

'--passphrase-file',

185

248

passfile.name]

186

249

+ self.gnupgargs,

187

stdin = subprocess.PIPE,

188

stdout = subprocess.PIPE,

189

stderr = subprocess.PIPE)

190

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

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

191

254

if proc.returncode != 0:

192

255

raise PGPError(err)

193

256

return ciphertext

194

257

195

258

def decrypt(self, data, password):

196

259

passphrase = self.password_encode(password)

197

with tempfile.NamedTemporaryFile(dir = self.tempdir

198

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

199

262

passfile.write(passphrase)

200

263

passfile.flush()

201

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

264

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

202

265

'--passphrase-file',

203

266

passfile.name]

204

267

+ self.gnupgargs,

205

stdin = subprocess.PIPE,

206

stdout = subprocess.PIPE,

207

stderr = subprocess.PIPE)

208

decrypted_plaintext, err = proc.communicate(input

209

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

210

272

if proc.returncode != 0:

211

273

raise PGPError(err)

212

274

return decrypted_plaintext

213

275

214

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

It is instantiated once, and simulates having an Avahi module."""

281

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

282

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

283

PROTO_INET = 0 # avahi-common/address.h

284

PROTO_INET6 = 1 # avahi-common/address.h

285

DBUS_NAME = "org.freedesktop.Avahi"

286

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

287

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

288

DBUS_PATH_SERVER = "/"

289

290

def string_array_to_txt_array(self, 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

avahi = Avahi()

302

303

215

304

class AvahiError(Exception):

216

305

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

217

306

self.value = value

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

307

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

308

**kwargs)

309

221

310

222

311

class AvahiServiceError(AvahiError):

223

312

pass

224

313

314

225

315

class AvahiGroupError(AvahiError):

226

316

pass

227

317

228

318

229

319

class AvahiService(object):

230

320

"""An Avahi (Zeroconf) service.

231

321

232

322

Attributes:

233

323

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

234

324

Used to optionally bind to the specified interface.

246

336

server: D-Bus Server

247

337

bus: dbus.SystemBus()

248

338

"""

249

250

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

251

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

252

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

253

protocol = avahi.PROTO_UNSPEC, bus = None):

339

340

def __init__(self,

341

interface=avahi.IF_UNSPEC,

342

name=None,

343

servicetype=None,

344

port=None,

345

TXT=None,

346

domain="",

347

host="",

348

max_renames=32768,

349

protocol=avahi.PROTO_UNSPEC,

350

bus=None):

254

351

self.interface = interface

255

352

self.name = name

256

353

self.type = servicetype

265

362

self.server = None

266

363

self.bus = bus

267

364

self.entry_group_state_changed_match = None

268

269

def rename(self):

365

366

def rename(self, remove=True):

270

367

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

271

368

if self.rename_count >= self.max_renames:

272

369

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

273

370

" after %i retries, exiting.",

274

371

self.rename_count)

275

372

raise AvahiServiceError("Too many renames")

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

278

376

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

279

377

self.name)

280

self.remove()

378

if remove:

379

self.remove()

281

380

try:

282

381

self.add()

283

382

except dbus.exceptions.DBusException as error:

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

288

383

if (error.get_dbus_name()

384

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

385

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

386

return self.rename(remove=False)

387

else:

388

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

389

self.cleanup()

390

os._exit(1)

391

289

392

def remove(self):

290

393

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

291

394

if self.entry_group_state_changed_match is not None:

293

396

self.entry_group_state_changed_match = None

294

397

if self.group is not None:

295

398

self.group.Reset()

296

399

297

400

def add(self):

298

401

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

299

402

self.remove()

316

419

dbus.UInt16(self.port),

317

420

avahi.string_array_to_txt_array(self.TXT))

318

421

self.group.Commit()

319

422

320

423

def entry_group_state_changed(self, state, error):

321

424

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

322

425

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

323

426

324

427

if state == avahi.ENTRY_GROUP_ESTABLISHED:

325

428

logger.debug("Zeroconf service established.")

326

429

elif state == avahi.ENTRY_GROUP_COLLISION:

328

431

self.rename()

329

432

elif state == avahi.ENTRY_GROUP_FAILURE:

330

433

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

331

unicode(error))

332

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

333

.format(error))

334

434

str(error))

435

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

436

335

437

def cleanup(self):

336

438

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

337

439

if self.group is not None:

342

444

pass

343

445

self.group = None

344

446

self.remove()

345

447

346

448

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

347

449

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

348

450

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

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

451

bad_states = {

452

avahi.SERVER_INVALID: "Zeroconf server invalid",

453

avahi.SERVER_REGISTERING: None,

454

avahi.SERVER_COLLISION: "Zeroconf server name collision",

455

avahi.SERVER_FAILURE: "Zeroconf server failure",

456

}

356

457

if state in bad_states:

357

458

if bad_states[state] is not None:

358

459

if error is None:

361

462

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

362

463

self.cleanup()

363

464

elif state == avahi.SERVER_RUNNING:

364

self.add()

465

try:

466

self.add()

467

except dbus.exceptions.DBusException as error:

468

if (error.get_dbus_name()

469

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

470

logger.info("Local Zeroconf service name"

471

" collision.")

472

return self.rename(remove=False)

473

else:

474

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

475

self.cleanup()

476

os._exit(1)

365

477

else:

366

478

if error is None:

367

479

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

368

480

else:

369

481

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

370

482

371

483

def activate(self):

372

484

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

373

485

if self.server is None:

377

489

follow_name_owner_changes=True),

378

490

avahi.DBUS_INTERFACE_SERVER)

379

491

self.server.connect_to_signal("StateChanged",

380

self.server_state_changed)

492

self.server_state_changed)

381

493

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

382

494

383

495

384

496

class AvahiServiceToSyslog(AvahiService):

385

def rename(self):

497

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

386

498

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

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

499

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

500

syslogger.setFormatter(logging.Formatter(

501

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

502

.format(self.name)))

392

503

return ret

393

504

394

505

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

506

# Pretend that we have a GnuTLS module

507

class GnuTLS(object):

508

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

509

It is instantiated once, and simulates having a GnuTLS module."""

510

511

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

512

if library is None:

513

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

514

_library = ctypes.cdll.LoadLibrary(library)

515

del library

516

_need_version = b"3.3.0"

517

518

def __init__(self):

519

# Need to use "self" here, since this method is called before

520

# the assignment to the "gnutls" global variable happens.

521

if self.check_version(self._need_version) is None:

522

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

523

.format(self._need_version))

524

525

# Unless otherwise indicated, the constants and types below are

526

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

527

528

# Constants

529

E_SUCCESS = 0

530

E_INTERRUPTED = -52

531

E_AGAIN = -28

532

CRT_OPENPGP = 2

533

CLIENT = 2

534

SHUT_RDWR = 0

535

CRD_CERTIFICATE = 1

536

E_NO_CERTIFICATE_FOUND = -49

537

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

538

539

# Types

540

class session_int(ctypes.Structure):

541

_fields_ = []

542

session_t = ctypes.POINTER(session_int)

543

544

class certificate_credentials_st(ctypes.Structure):

545

_fields_ = []

546

certificate_credentials_t = ctypes.POINTER(

547

certificate_credentials_st)

548

certificate_type_t = ctypes.c_int

549

550

class datum_t(ctypes.Structure):

551

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

552

('size', ctypes.c_uint)]

553

554

class openpgp_crt_int(ctypes.Structure):

555

_fields_ = []

556

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

557

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

558

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

559

credentials_type_t = ctypes.c_int

560

transport_ptr_t = ctypes.c_void_p

561

close_request_t = ctypes.c_int

562

563

# Exceptions

564

class Error(Exception):

565

# We need to use the class name "GnuTLS" here, since this

566

# exception might be raised from within GnuTLS.__init__,

567

# which is called before the assignment to the "gnutls"

568

# global variable has happened.

569

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

570

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

571

# code is passed, convert it to a string with

572

# gnutls.strerror()

573

self.code = code

574

if message is None and code is not None:

575

message = GnuTLS.strerror(code)

576

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

577

message, *args)

578

579

class CertificateSecurityError(Error):

580

pass

581

582

# Classes

583

class Credentials(object):

584

def __init__(self):

585

self._c_object = gnutls.certificate_credentials_t()

586

gnutls.certificate_allocate_credentials(

587

ctypes.byref(self._c_object))

588

self.type = gnutls.CRD_CERTIFICATE

589

590

def __del__(self):

591

gnutls.certificate_free_credentials(self._c_object)

592

593

class ClientSession(object):

594

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

595

self._c_object = gnutls.session_t()

596

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

597

gnutls.set_default_priority(self._c_object)

598

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

599

gnutls.handshake_set_private_extensions(self._c_object,

600

True)

601

self.socket = socket

602

if credentials is None:

603

credentials = gnutls.Credentials()

604

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

605

ctypes.cast(credentials._c_object,

606

ctypes.c_void_p))

607

self.credentials = credentials

608

609

def __del__(self):

610

gnutls.deinit(self._c_object)

611

612

def handshake(self):

613

return gnutls.handshake(self._c_object)

614

615

def send(self, data):

616

data = bytes(data)

617

data_len = len(data)

618

while data_len > 0:

619

data_len -= gnutls.record_send(self._c_object,

620

data[-data_len:],

621

data_len)

622

623

def bye(self):

624

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

625

626

# Error handling functions

627

def _error_code(result):

628

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

629

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

630

if result >= 0:

631

return result

632

if result == gnutls.E_NO_CERTIFICATE_FOUND:

633

raise gnutls.CertificateSecurityError(code=result)

634

raise gnutls.Error(code=result)

635

636

def _retry_on_error(result, func, arguments):

637

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

638

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

639

while result < 0:

640

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

641

return _error_code(result)

642

result = func(*arguments)

643

return result

644

645

# Unless otherwise indicated, the function declarations below are

646

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

647

648

# Functions

649

priority_set_direct = _library.gnutls_priority_set_direct

650

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

651

ctypes.POINTER(ctypes.c_char_p)]

652

priority_set_direct.restype = _error_code

653

654

init = _library.gnutls_init

655

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

656

init.restype = _error_code

657

658

set_default_priority = _library.gnutls_set_default_priority

659

set_default_priority.argtypes = [session_t]

660

set_default_priority.restype = _error_code

661

662

record_send = _library.gnutls_record_send

663

record_send.argtypes = [session_t, ctypes.c_void_p,

664

ctypes.c_size_t]

665

record_send.restype = ctypes.c_ssize_t

666

record_send.errcheck = _retry_on_error

667

668

certificate_allocate_credentials = (

669

_library.gnutls_certificate_allocate_credentials)

670

certificate_allocate_credentials.argtypes = [

671

ctypes.POINTER(certificate_credentials_t)]

672

certificate_allocate_credentials.restype = _error_code

673

674

certificate_free_credentials = (

675

_library.gnutls_certificate_free_credentials)

676

certificate_free_credentials.argtypes = [

677

certificate_credentials_t]

678

certificate_free_credentials.restype = None

679

680

handshake_set_private_extensions = (

681

_library.gnutls_handshake_set_private_extensions)

682

handshake_set_private_extensions.argtypes = [session_t,

683

ctypes.c_int]

684

handshake_set_private_extensions.restype = None

685

686

credentials_set = _library.gnutls_credentials_set

687

credentials_set.argtypes = [session_t, credentials_type_t,

688

ctypes.c_void_p]

689

credentials_set.restype = _error_code

690

691

strerror = _library.gnutls_strerror

692

strerror.argtypes = [ctypes.c_int]

693

strerror.restype = ctypes.c_char_p

694

695

certificate_type_get = _library.gnutls_certificate_type_get

696

certificate_type_get.argtypes = [session_t]

697

certificate_type_get.restype = _error_code

698

699

certificate_get_peers = _library.gnutls_certificate_get_peers

700

certificate_get_peers.argtypes = [session_t,

701

ctypes.POINTER(ctypes.c_uint)]

702

certificate_get_peers.restype = ctypes.POINTER(datum_t)

703

704

global_set_log_level = _library.gnutls_global_set_log_level

705

global_set_log_level.argtypes = [ctypes.c_int]

706

global_set_log_level.restype = None

707

708

global_set_log_function = _library.gnutls_global_set_log_function

709

global_set_log_function.argtypes = [log_func]

710

global_set_log_function.restype = None

711

712

deinit = _library.gnutls_deinit

713

deinit.argtypes = [session_t]

714

deinit.restype = None

715

716

handshake = _library.gnutls_handshake

717

handshake.argtypes = [session_t]

718

handshake.restype = _error_code

719

handshake.errcheck = _retry_on_error

720

721

transport_set_ptr = _library.gnutls_transport_set_ptr

722

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

723

transport_set_ptr.restype = None

724

725

bye = _library.gnutls_bye

726

bye.argtypes = [session_t, close_request_t]

727

bye.restype = _error_code

728

bye.errcheck = _retry_on_error

729

730

check_version = _library.gnutls_check_version

731

check_version.argtypes = [ctypes.c_char_p]

732

check_version.restype = ctypes.c_char_p

733

734

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

735

736

openpgp_crt_init = _library.gnutls_openpgp_crt_init

737

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

738

openpgp_crt_init.restype = _error_code

739

740

openpgp_crt_import = _library.gnutls_openpgp_crt_import

741

openpgp_crt_import.argtypes = [openpgp_crt_t,

742

ctypes.POINTER(datum_t),

743

openpgp_crt_fmt_t]

744

openpgp_crt_import.restype = _error_code

745

746

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

747

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

748

ctypes.POINTER(ctypes.c_uint)]

749

openpgp_crt_verify_self.restype = _error_code

750

751

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

752

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

753

openpgp_crt_deinit.restype = None

754

755

openpgp_crt_get_fingerprint = (

756

_library.gnutls_openpgp_crt_get_fingerprint)

757

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

758

ctypes.c_void_p,

759

ctypes.POINTER(

760

ctypes.c_size_t)]

761

openpgp_crt_get_fingerprint.restype = _error_code

762

763

# Remove non-public functions

764

del _error_code, _retry_on_error

765

# Create the global "gnutls" object, simulating a module

766

gnutls = GnuTLS()

767

768

769

def call_pipe(connection, # : multiprocessing.Connection

770

func, *args, **kwargs):

771

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

772

773

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

774

return value on the provided multiprocessing.Connection.

775

"""

776

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

777

connection.close()

400

778

401

779

402

780

class Client(object):

403

781

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

404

782

405

783

Attributes:

406

784

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

407

785

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

409

787

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

410

788

to see if the client lives.

411

789

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

790

checker_callback_tag: a GLib event source tag, or None

413

791

checker_command: string; External command which is run to check

414

792

if client lives. %() expansions are done at

415

793

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

416

794

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

417

checker_initiator_tag: a gobject event source tag, or None

795

checker_initiator_tag: a GLib event source tag, or None

418

796

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

419

797

client_structure: Object describing what attributes a client has

420

798

and is used for storing the client at exit

421

799

current_checker_command: string; current running checker_command

422

disable_initiator_tag: a gobject event source tag, or None

800

disable_initiator_tag: a GLib event source tag, or None

423

801

enabled: bool()

424

802

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

425

803

uniquely identify the client

430

808

last_checker_status: integer between 0 and 255 reflecting exit

431

809

status of last checker. -1 reflects crashed

432

810

checker, -2 means no checker completed yet.

811

last_checker_signal: The signal which killed the last checker, if

812

last_checker_status is -1

433

813

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

434

814

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

435

815

D-Bus identifiers

442

822

disabled, or None

443

823

server_settings: The server_settings dict from main()

444

824

"""

445

825

446

826

runtime_expansions = ("approval_delay", "approval_duration",

447

827

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

448

828

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

449

829

"last_approval_request", "last_checked_ok",

450

830

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

451

client_defaults = { "timeout": "PT5M",

452

"extended_timeout": "PT15M",

453

"interval": "PT2M",

454

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

455

"host": "",

456

"approval_delay": "PT0S",

457

"approval_duration": "PT1S",

458

"approved_by_default": "True",

459

"enabled": "True",

460

}

461

462

def timeout_milliseconds(self):

463

"Return the 'timeout' attribute in milliseconds"

464

return timedelta_to_milliseconds(self.timeout)

465

466

def extended_timeout_milliseconds(self):

467

"Return the 'extended_timeout' attribute in milliseconds"

468

return timedelta_to_milliseconds(self.extended_timeout)

469

470

def interval_milliseconds(self):

471

"Return the 'interval' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.interval)

473

474

def approval_delay_milliseconds(self):

475

return timedelta_to_milliseconds(self.approval_delay)

476

831

client_defaults = {

832

"timeout": "PT5M",

833

"extended_timeout": "PT15M",

834

"interval": "PT2M",

835

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

836

"host": "",

837

"approval_delay": "PT0S",

838

"approval_duration": "PT1S",

839

"approved_by_default": "True",

840

"enabled": "True",

841

}

842

477

843

@staticmethod

478

844

def config_parser(config):

479

845

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

486

852

for client_name in config.sections():

487

853

section = dict(config.items(client_name))

488

854

client = settings[client_name] = {}

489

855

490

856

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

491

857

# Reformat values from string types to Python types

492

858

client["approved_by_default"] = config.getboolean(

493

859

client_name, "approved_by_default")

494

860

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

495

861

"enabled")

496

862

863

# Uppercase and remove spaces from fingerprint for later

864

# comparison purposes with return value from the

865

# fingerprint() function

497

866

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

498

867

.replace(" ", ""))

499

868

if "secret" in section:

500

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

869

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

870

.encode("utf-8"),

871

"base64")

501

872

elif "secfile" in section:

502

873

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

503

874

(section["secfile"])),

504

875

"rb") as secfile:

505

876

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

506

877

else:

507

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

878

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

508

879

.format(section))

509

880

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

510

881

client["extended_timeout"] = string_to_delta(

518

889

client["last_approval_request"] = None

519

890

client["last_checked_ok"] = None

520

891

client["last_checker_status"] = -2

521

892

522

893

return settings

523

524

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

894

895

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

525

896

self.name = name

526

897

if server_settings is None:

527

898

server_settings = {}

528

899

self.server_settings = server_settings

529

900

# adding all client settings

530

for setting, value in settings.iteritems():

901

for setting, value in settings.items():

531

902

setattr(self, setting, value)

532

903

533

904

if self.enabled:

534

905

if not hasattr(self, "last_enabled"):

535

906

self.last_enabled = datetime.datetime.utcnow()

539

910

else:

540

911

self.last_enabled = None

541

912

self.expires = None

542

913

543

914

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

544

# Uppercase and remove spaces from fingerprint for later

545

# comparison purposes with return value from the fingerprint()

546

# function

547

915

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

548

916

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

549

917

datetime.datetime.utcnow())

550

918

551

919

# attributes specific for this server instance

552

920

self.checker = None

553

921

self.checker_initiator_tag = None

556

924

self.current_checker_command = None

557

925

self.approved = None

558

926

self.approvals_pending = 0

559

self.changedstate = (multiprocessing_manager

560

.Condition(multiprocessing_manager

561

.Lock()))

562

self.client_structure = [attr for attr in

563

self.__dict__.iterkeys()

927

self.changedstate = multiprocessing_manager.Condition(

928

multiprocessing_manager.Lock())

929

self.client_structure = [attr

930

for attr in self.__dict__.keys()

564

931

if not attr.startswith("_")]

565

932

self.client_structure.append("client_structure")

566

567

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

568

lambda obj:

569

isinstance(obj,

570

property)):

933

934

for name, t in inspect.getmembers(

935

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

571

936

if not name.startswith("_"):

572

937

self.client_structure.append(name)

573

938

574

939

# Send notice to process children that client state has changed

575

940

def send_changedstate(self):

576

941

with self.changedstate:

577

942

self.changedstate.notify_all()

578

943

579

944

def enable(self):

580

945

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

581

946

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

586

951

self.last_enabled = datetime.datetime.utcnow()

587

952

self.init_checker()

588

953

self.send_changedstate()

589

954

590

955

def disable(self, quiet=True):

591

956

"""Disable this client."""

592

957

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

594

959

if not quiet:

595

960

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

596

961

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

597

gobject.source_remove(self.disable_initiator_tag)

962

GLib.source_remove(self.disable_initiator_tag)

598

963

self.disable_initiator_tag = None

599

964

self.expires = None

600

965

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

601

gobject.source_remove(self.checker_initiator_tag)

966

GLib.source_remove(self.checker_initiator_tag)

602

967

self.checker_initiator_tag = None

603

968

self.stop_checker()

604

969

self.enabled = False

605

970

if not quiet:

606

971

self.send_changedstate()

607

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

972

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

608

973

return False

609

974

610

975

def __del__(self):

611

976

self.disable()

612

977

613

978

def init_checker(self):

614

979

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

615

980

# and every interval from then on.

616

981

if self.checker_initiator_tag is not None:

617

gobject.source_remove(self.checker_initiator_tag)

618

self.checker_initiator_tag = (gobject.timeout_add

619

(self.interval_milliseconds(),

620

self.start_checker))

982

GLib.source_remove(self.checker_initiator_tag)

983

self.checker_initiator_tag = GLib.timeout_add(

984

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

985

self.start_checker)

621

986

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

622

987

if self.disable_initiator_tag is not None:

623

gobject.source_remove(self.disable_initiator_tag)

624

self.disable_initiator_tag = (gobject.timeout_add

625

(self.timeout_milliseconds(),

626

self.disable))

988

GLib.source_remove(self.disable_initiator_tag)

989

self.disable_initiator_tag = GLib.timeout_add(

990

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

627

991

# Also start a new checker *right now*.

628

992

self.start_checker()

629

630

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

993

994

def checker_callback(self, source, condition, connection,

995

command):

631

996

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

632

997

self.checker_callback_tag = None

633

998

self.checker = None

634

if os.WIFEXITED(condition):

635

self.last_checker_status = os.WEXITSTATUS(condition)

999

# Read return code from connection (see call_pipe)

1000

returncode = connection.recv()

1001

connection.close()

1002

1003

if returncode >= 0:

1004

self.last_checker_status = returncode

1005

self.last_checker_signal = None

636

1006

if self.last_checker_status == 0:

637

1007

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

638

1008

vars(self))

639

1009

self.checked_ok()

640

1010

else:

641

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

642

vars(self))

1011

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

643

1012

else:

644

1013

self.last_checker_status = -1

1014

self.last_checker_signal = -returncode

645

1015

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

646

1016

vars(self))

647

1017

return False

1018

648

1019

def checked_ok(self):

649

1020

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

650

1021

self.last_checked_ok = datetime.datetime.utcnow()

651

1022

self.last_checker_status = 0

1023

self.last_checker_signal = None

652

1024

self.bump_timeout()

653

1025

654

1026

def bump_timeout(self, timeout=None):

655

1027

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

656

1028

if timeout is None:

657

1029

timeout = self.timeout

658

1030

if self.disable_initiator_tag is not None:

659

gobject.source_remove(self.disable_initiator_tag)

1031

GLib.source_remove(self.disable_initiator_tag)

660

1032

self.disable_initiator_tag = None

661

1033

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

662

self.disable_initiator_tag = (gobject.timeout_add

663

(timedelta_to_milliseconds

664

(timeout), self.disable))

1034

self.disable_initiator_tag = GLib.timeout_add(

1035

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

665

1036

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

666

1037

667

1038

def need_approval(self):

668

1039

self.last_approval_request = datetime.datetime.utcnow()

669

1040

670

1041

def start_checker(self):

671

1042

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

672

1043

673

1044

If a checker already exists, leave it running and do

674

1045

nothing."""

675

1046

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

680

1051

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

681

1052

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

682

1053

# should be.

683

684

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

685

try:

686

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

687

except (AttributeError, OSError) as error:

688

if (isinstance(error, OSError)

689

and error.errno != errno.ECHILD):

690

raise error

691

else:

692

if pid:

693

logger.warning("Checker was a zombie")

694

gobject.source_remove(self.checker_callback_tag)

695

self.checker_callback(pid, status,

696

self.current_checker_command)

1054

1055

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

1056

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

1057

self.checker.join()

1058

self.checker = None

697

1059

# Start a new checker if needed

698

1060

if self.checker is None:

699

1061

# Escape attributes for the shell

700

escaped_attrs = dict(

701

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

702

for attr in

703

self.runtime_expansions)

1062

escaped_attrs = {

1063

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

1064

for attr in self.runtime_expansions}

704

1065

try:

705

1066

command = self.checker_command % escaped_attrs

706

1067

except TypeError as error:

707

1068

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

708

self.checker_command, exc_info=error)

709

return True # Try again later

1069

self.checker_command,

1070

exc_info=error)

1071

return True # Try again later

710

1072

self.current_checker_command = command

711

try:

712

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

713

command, self.name)

714

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

715

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

716

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

717

# always replaced by /dev/null.)

718

# The exception is when not debugging but nevertheless

719

# running in the foreground; use the previously

720

# created wnull.

721

popen_args = {}

722

if (not self.server_settings["debug"]

723

and self.server_settings["foreground"]):

724

popen_args.update({"stdout": wnull,

725

"stderr": wnull })

726

self.checker = subprocess.Popen(command,

727

close_fds=True,

728

shell=True, cwd="/",

729

**popen_args)

730

except OSError as error:

731

logger.error("Failed to start subprocess",

732

exc_info=error)

733

return True

734

self.checker_callback_tag = (gobject.child_watch_add

735

(self.checker.pid,

736

self.checker_callback,

737

data=command))

738

# The checker may have completed before the gobject

739

# watch was added. Check for this.

740

try:

741

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

742

except OSError as error:

743

if error.errno == errno.ECHILD:

744

# This should never happen

745

logger.error("Child process vanished",

746

exc_info=error)

747

return True

748

raise

749

if pid:

750

gobject.source_remove(self.checker_callback_tag)

751

self.checker_callback(pid, status, command)

752

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

1073

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

1074

self.name)

1075

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

1076

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

1077

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

1078

# always replaced by /dev/null.)

1079

# The exception is when not debugging but nevertheless

1080

# running in the foreground; use the previously

1081

# created wnull.

1082

popen_args = {"close_fds": True,

1083

"shell": True,

1084

"cwd": "/"}

1085

if (not self.server_settings["debug"]

1086

and self.server_settings["foreground"]):

1087

popen_args.update({"stdout": wnull,

1088

"stderr": wnull})

1089

pipe = multiprocessing.Pipe(duplex=False)

1090

self.checker = multiprocessing.Process(

1091

target=call_pipe,

1092

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

1093

kwargs=popen_args)

1094

self.checker.start()

1095

self.checker_callback_tag = GLib.io_add_watch(

1096

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

1097

self.checker_callback, pipe[0], command)

1098

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

753

1099

return True

754

1100

755

1101

def stop_checker(self):

756

1102

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

757

1103

if self.checker_callback_tag:

758

gobject.source_remove(self.checker_callback_tag)

1104

GLib.source_remove(self.checker_callback_tag)

759

1105

self.checker_callback_tag = None

760

1106

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

761

1107

return

762

1108

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

763

try:

764

self.checker.terminate()

765

#time.sleep(0.5)

766

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

767

# self.checker.kill()

768

except OSError as error:

769

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

770

raise

1109

self.checker.terminate()

771

1110

self.checker = None

772

1111

773

1112

774

def dbus_service_property(dbus_interface, signature="v",

775

access="readwrite", byte_arrays=False):

1113

def dbus_service_property(dbus_interface,

1114

signature="v",

1115

access="readwrite",

1116

byte_arrays=False):

776

1117

"""Decorators for marking methods of a DBusObjectWithProperties to

777

1118

become properties on the D-Bus.

778

1119

779

1120

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

780

1121

and with one argument by "Set".

781

1122

782

1123

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

783

1124

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

784

1125

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

787

1128

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

788

1129

if byte_arrays and signature != "ay":

789

1130

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

790

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

1131

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

1132

791

1133

def decorator(func):

792

1134

func._dbus_is_property = True

793

1135

func._dbus_interface = dbus_interface

796

1138

func._dbus_name = func.__name__

797

1139

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

798

1140

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

799

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1141

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

800

1142

return func

1143

801

1144

return decorator

802

1145

803

1146

804

1147

def dbus_interface_annotations(dbus_interface):

805

1148

"""Decorator for marking functions returning interface annotations

806

1149

807

1150

Usage:

808

1151

809

1152

@dbus_interface_annotations("org.example.Interface")

810

1153

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

811

1154

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

812

1155

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

813

1156

"false"}

814

1157

"""

1158

815

1159

def decorator(func):

816

1160

func._dbus_is_interface = True

817

1161

func._dbus_interface = dbus_interface

818

1162

func._dbus_name = dbus_interface

819

1163

return func

1164

820

1165

return decorator

821

1166

822

1167

823

1168

def dbus_annotations(annotations):

824

1169

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

825

1170

Usage:

826

1171

1172

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

1173

"org.freedesktop.DBus.Property."

1174

"EmitsChangedSignal": "false"})

827

1175

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

828

1176

access="r")

829

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

830

"org.freedesktop.DBus.Property."

831

"EmitsChangedSignal": "false"})

832

1177

def Property_dbus_property(self):

833

1178

return dbus.Boolean(False)

1179

1180

See also the DBusObjectWithAnnotations class.

834

1181

"""

1182

835

1183

def decorator(func):

836

1184

func._dbus_annotations = annotations

837

1185

return func

1186

838

1187

return decorator

839

1188

840

1189

841

1190

class DBusPropertyException(dbus.exceptions.DBusException):

842

1191

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

843

1192

"""

844

def __unicode__(self):

845

return unicode(str(self))

1193

pass

846

1194

847

1195

848

1196

class DBusPropertyAccessException(DBusPropertyException):

857

1205

pass

858

1206

859

1207

860

class DBusObjectWithProperties(dbus.service.Object):

861

"""A D-Bus object with properties.

862

863

Classes inheriting from this can use the dbus_service_property

864

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

865

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

1208

class DBusObjectWithAnnotations(dbus.service.Object):

1209

"""A D-Bus object with annotations.

1210

1211

Classes inheriting from this can use the dbus_annotations

1212

decorator to add annotations to methods or signals.

866

1213

"""

867

1214

868

1215

@staticmethod

869

1216

def _is_dbus_thing(thing):

870

1217

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

871

1218

872

1219

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

873

1220

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

874

1221

"""

875

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

1222

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

876

1223

False)

877

1224

878

1225

def _get_all_dbus_things(self, thing):

879

1226

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

880

1227

"""

881

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

882

name),

1228

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

883

1229

athing.__get__(self))

884

1230

for cls in self.__class__.__mro__

885

1231

for name, athing in

886

inspect.getmembers(cls,

887

self._is_dbus_thing(thing)))

888

1232

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

1233

1234

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1235

out_signature="s",

1236

path_keyword='object_path',

1237

connection_keyword='connection')

1238

def Introspect(self, object_path, connection):

1239

"""Overloading of standard D-Bus method.

1240

1241

Inserts annotation tags on methods and signals.

1242

"""

1243

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

1244

connection)

1245

try:

1246

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

1247

1248

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

1249

# Add annotation tags

1250

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

1251

for tag in if_tag.getElementsByTagName(typ):

1252

annots = dict()

1253

for name, prop in (self.

1254

_get_all_dbus_things(typ)):

1255

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

1256

and prop._dbus_interface

1257

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

1258

annots.update(getattr(

1259

prop, "_dbus_annotations", {}))

1260

for name, value in annots.items():

1261

ann_tag = document.createElement(

1262

"annotation")

1263

ann_tag.setAttribute("name", name)

1264

ann_tag.setAttribute("value", value)

1265

tag.appendChild(ann_tag)

1266

# Add interface annotation tags

1267

for annotation, value in dict(

1268

itertools.chain.from_iterable(

1269

annotations().items()

1270

for name, annotations

1271

in self._get_all_dbus_things("interface")

1272

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

1273

)).items():

1274

ann_tag = document.createElement("annotation")

1275

ann_tag.setAttribute("name", annotation)

1276

ann_tag.setAttribute("value", value)

1277

if_tag.appendChild(ann_tag)

1278

# Fix argument name for the Introspect method itself

1279

if (if_tag.getAttribute("name")

1280

== dbus.INTROSPECTABLE_IFACE):

1281

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

1282

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

1283

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

1284

if (arg.getAttribute("direction")

1285

== "out"):

1286

arg.setAttribute("name",

1287

"xml_data")

1288

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

1289

document.unlink()

1290

except (AttributeError, xml.dom.DOMException,

1291

xml.parsers.expat.ExpatError) as error:

1292

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

1293

exc_info=error)

1294

return xmlstring

1295

1296

1297

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1298

"""A D-Bus object with properties.

1299

1300

Classes inheriting from this can use the dbus_service_property

1301

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

1302

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

1303

"""

1304

889

1305

def _get_dbus_property(self, interface_name, property_name):

890

1306

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

891

1307

property with the specified name and interface.

892

1308

"""

893

for cls in self.__class__.__mro__:

894

for name, value in (inspect.getmembers

895

(cls,

896

self._is_dbus_thing("property"))):

1309

for cls in self.__class__.__mro__:

1310

for name, value in inspect.getmembers(

1311

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

897

1312

if (value._dbus_name == property_name

898

1313

and value._dbus_interface == interface_name):

899

1314

return value.__get__(self)

900

1315

901

1316

# No such property

902

raise DBusPropertyNotFound(self.dbus_object_path + ":"

903

+ interface_name + "."

904

+ property_name)

905

906

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

1317

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

1318

self.dbus_object_path, interface_name, property_name))

1319

1320

@classmethod

1321

def _get_all_interface_names(cls):

1322

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

1323

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

1324

"_dbus_interface", None)

1325

for x in (inspect.getmro(cls))

1326

for attr in dir(x))

1327

if name is not None)

1328

1329

@dbus.service.method(dbus.PROPERTIES_IFACE,

1330

in_signature="ss",

907

1331

out_signature="v")

908

1332

def Get(self, interface_name, property_name):

909

1333

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

915

1339

if not hasattr(value, "variant_level"):

916

1340

return value

917

1341

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

918

1342

919

1343

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

920

1344

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

921

1345

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

927

1351

# The byte_arrays option is not supported yet on

928

1352

# signatures other than "ay".

929

1353

if prop._dbus_signature != "ay":

930

raise ValueError

1354

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

1355

"'ay' signature {!r}"

1356

.format(prop._dbus_signature))

931

1357

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

932

1358

for byte in value))

933

1359

prop(value)

934

935

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

1360

1361

@dbus.service.method(dbus.PROPERTIES_IFACE,

1362

in_signature="s",

936

1363

out_signature="a{sv}")

937

1364

def GetAll(self, interface_name):

938

1365

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

939

1366

standard.

940

1367

941

1368

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

942

1369

"""

943

1370

properties = {}

953

1380

if not hasattr(value, "variant_level"):

954

1381

properties[name] = value

955

1382

continue

956

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

957

value.variant_level+1)

1383

properties[name] = type(value)(

1384

value, variant_level=value.variant_level + 1)

958

1385

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

959

1386

1387

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

1388

def PropertiesChanged(self, interface_name, changed_properties,

1389

invalidated_properties):

1390

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

1391

standard.

1392

"""

1393

pass

1394

960

1395

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

961

1396

out_signature="s",

962

1397

path_keyword='object_path',

963

1398

connection_keyword='connection')

964

1399

def Introspect(self, object_path, connection):

965

1400

"""Overloading of standard D-Bus method.

966

1401

967

1402

Inserts property tags and interface annotation tags.

968

1403

"""

969

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

970

connection)

1404

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1405

object_path,

1406

connection)

971

1407

try:

972

1408

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

1409

973

1410

def make_tag(document, name, prop):

974

1411

e = document.createElement("property")

975

1412

e.setAttribute("name", name)

976

1413

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

977

1414

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

978

1415

return e

1416

979

1417

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

980

1418

# Add property tags

981

1419

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

984

1422

if prop._dbus_interface

985

1423

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

986

1424

if_tag.appendChild(tag)

987

# Add annotation tags

988

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

989

for tag in if_tag.getElementsByTagName(typ):

990

annots = dict()

991

for name, prop in (self.

992

_get_all_dbus_things(typ)):

993

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

994

and prop._dbus_interface

995

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

996

annots.update(getattr

997

(prop,

998

"_dbus_annotations",

999

{}))

1000

for name, value in annots.iteritems():

1001

ann_tag = document.createElement(

1002

"annotation")

1003

ann_tag.setAttribute("name", name)

1004

ann_tag.setAttribute("value", value)

1005

tag.appendChild(ann_tag)

1006

# Add interface annotation tags

1007

for annotation, value in dict(

1008

itertools.chain.from_iterable(

1009

annotations().iteritems()

1010

for name, annotations in

1011

self._get_all_dbus_things("interface")

1012

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

1013

)).iteritems():

1014

ann_tag = document.createElement("annotation")

1015

ann_tag.setAttribute("name", annotation)

1016

ann_tag.setAttribute("value", value)

1017

if_tag.appendChild(ann_tag)

1425

# Add annotation tags for properties

1426

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

1427

annots = dict()

1428

for name, prop in self._get_all_dbus_things(

1429

"property"):

1430

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

1431

and prop._dbus_interface

1432

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

1433

annots.update(getattr(

1434

prop, "_dbus_annotations", {}))

1435

for name, value in annots.items():

1436

ann_tag = document.createElement(

1437

"annotation")

1438

ann_tag.setAttribute("name", name)

1439

ann_tag.setAttribute("value", value)

1440

tag.appendChild(ann_tag)

1018

1441

# Add the names to the return values for the

1019

1442

# "org.freedesktop.DBus.Properties" methods

1020

1443

if (if_tag.getAttribute("name")

1039

1462

return xmlstring

1040

1463

1041

1464

1465

try:

1466

dbus.OBJECT_MANAGER_IFACE

1467

except AttributeError:

1468

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

1469

1470

1471

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1472

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

1473

1474

Classes inheriting from this exposes the standard

1475

GetManagedObjects call and the InterfacesAdded and

1476

InterfacesRemoved signals on the standard

1477

"org.freedesktop.DBus.ObjectManager" interface.

1478

1479

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

1480

manually.

1481

"""

1482

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1483

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

1484

def GetManagedObjects(self):

1485

"""This function must be overridden"""

1486

raise NotImplementedError()

1487

1488

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1489

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

1490

def InterfacesAdded(self, object_path, interfaces_and_properties):

1491

pass

1492

1493

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

1494

def InterfacesRemoved(self, object_path, interfaces):

1495

pass

1496

1497

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1498

out_signature="s",

1499

path_keyword='object_path',

1500

connection_keyword='connection')

1501

def Introspect(self, object_path, connection):

1502

"""Overloading of standard D-Bus method.

1503

1504

Override return argument name of GetManagedObjects to be

1505

"objpath_interfaces_and_properties"

1506

"""

1507

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1508

object_path,

1509

connection)

1510

try:

1511

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

1512

1513

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

1514

# Fix argument name for the GetManagedObjects method

1515

if (if_tag.getAttribute("name")

1516

== dbus.OBJECT_MANAGER_IFACE):

1517

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

1518

if (cn.getAttribute("name")

1519

== "GetManagedObjects"):

1520

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

1521

if (arg.getAttribute("direction")

1522

== "out"):

1523

arg.setAttribute(

1524

"name",

1525

"objpath_interfaces"

1526

"_and_properties")

1527

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

1528

document.unlink()

1529

except (AttributeError, xml.dom.DOMException,

1530

xml.parsers.expat.ExpatError) as error:

1531

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

1532

exc_info=error)

1533

return xmlstring

1534

1535

1042

1536

def datetime_to_dbus(dt, variant_level=0):

1043

1537

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

1044

1538

if dt is None:

1045

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

1046

return dbus.String(dt.isoformat(),

1047

variant_level=variant_level)

1539

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

1540

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

1048

1541

1049

1542

1050

1543

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1052

1545

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

1053

1546

interface names according to the "alt_interface_names" mapping.

1054

1547

Usage:

1055

1548

1056

1549

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

1057

1550

"net.example.AlternateInterface"})

1058

1551

class SampleDBusObject(dbus.service.Object):

1059

1552

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

1060

1553

def SampleDBusMethod():

1061

1554

pass

1062

1555

1063

1556

The above "SampleDBusMethod" on "SampleDBusObject" will be

1064

1557

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

1065

1558

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

1066

1559

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

1067

1560

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

1068

1561

1069

1562

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

1070

1563

(from DBusObjectWithProperties) and interfaces (from the

1071

1564

dbus_interface_annotations decorator).

1072

1565

"""

1566

1073

1567

def wrapper(cls):

1074

1568

for orig_interface_name, alt_interface_name in (

1075

alt_interface_names.iteritems()):

1569

alt_interface_names.items()):

1076

1570

attr = {}

1077

1571

interface_names = set()

1078

1572

# Go though all attributes of the class

1080

1574

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

1081

1575

# with the wrong interface name

1082

1576

if (not hasattr(attribute, "_dbus_interface")

1083

or not attribute._dbus_interface

1084

.startswith(orig_interface_name)):

1577

or not attribute._dbus_interface.startswith(

1578

orig_interface_name)):

1085

1579

continue

1086

1580

# Create an alternate D-Bus interface name based on

1087

1581

# the current name

1088

alt_interface = (attribute._dbus_interface

1089

.replace(orig_interface_name,

1090

alt_interface_name))

1582

alt_interface = attribute._dbus_interface.replace(

1583

orig_interface_name, alt_interface_name)

1091

1584

interface_names.add(alt_interface)

1092

1585

# Is this a D-Bus signal?

1093

1586

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

1094

1587

# Extract the original non-method undecorated

1095

1588

# function by black magic

1096

nonmethod_func = (dict(

1589

if sys.version_info.major == 2:

1590

nonmethod_func = (dict(

1097

1591

zip(attribute.func_code.co_freevars,

1098

attribute.__closure__))["func"]

1099

.cell_contents)

1592

attribute.__closure__))

1593

["func"].cell_contents)

1594

else:

1595

nonmethod_func = (dict(

1596

zip(attribute.__code__.co_freevars,

1597

attribute.__closure__))

1598

["func"].cell_contents)

1100

1599

# Create a new, but exactly alike, function

1101

1600

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

1102

1601

# with the alternate D-Bus interface name

1103

new_function = (dbus.service.signal

1104

(alt_interface,

1105

attribute._dbus_signature)

1106

(types.FunctionType(

1107

nonmethod_func.func_code,

1108

nonmethod_func.func_globals,

1109

nonmethod_func.func_name,

1110

nonmethod_func.func_defaults,

1111

nonmethod_func.func_closure)))

1602

new_function = copy_function(nonmethod_func)

1603

new_function = (dbus.service.signal(

1604

alt_interface,

1605

attribute._dbus_signature)(new_function))

1112

1606

# Copy annotations, if any

1113

1607

try:

1114

new_function._dbus_annotations = (

1115

dict(attribute._dbus_annotations))

1608

new_function._dbus_annotations = dict(

1609

attribute._dbus_annotations)

1116

1610

except AttributeError:

1117

1611

pass

1612

1118

1613

# Define a creator of a function to call both the

1119

1614

# original and alternate functions, so both the

1120

1615

# original and alternate signals gets sent when

1123

1618

"""This function is a scope container to pass

1124

1619

func1 and func2 to the "call_both" function

1125

1620

outside of its arguments"""

1621

1622

@functools.wraps(func2)

1126

1623

def call_both(*args, **kwargs):

1127

1624

"""This function will emit two D-Bus

1128

1625

signals by calling func1 and func2"""

1129

1626

func1(*args, **kwargs)

1130

1627

func2(*args, **kwargs)

1628

# Make wrapper function look like a D-Bus

1629

# signal

1630

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

1631

if name.startswith("_dbus_"):

1632

setattr(call_both, name, attr)

1633

1131

1634

return call_both

1132

1635

# Create the "call_both" function and add it to

1133

1636

# the class

1138

1641

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

1139

1642

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

1140

1643

# to the class.

1141

attr[attrname] = (dbus.service.method

1142

(alt_interface,

1143

attribute._dbus_in_signature,

1144

attribute._dbus_out_signature)

1145

(types.FunctionType

1146

(attribute.func_code,

1147

attribute.func_globals,

1148

attribute.func_name,

1149

attribute.func_defaults,

1150

attribute.func_closure)))

1644

attr[attrname] = (

1645

dbus.service.method(

1646

alt_interface,

1647

attribute._dbus_in_signature,

1648

attribute._dbus_out_signature)

1649

(copy_function(attribute)))

1151

1650

# Copy annotations, if any

1152

1651

try:

1153

attr[attrname]._dbus_annotations = (

1154

dict(attribute._dbus_annotations))

1652

attr[attrname]._dbus_annotations = dict(

1653

attribute._dbus_annotations)

1155

1654

except AttributeError:

1156

1655

pass

1157

1656

# Is this a D-Bus property?

1160

1659

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

1161

1660

# property with the alternate D-Bus interface

1162

1661

# name. Add it to the class.

1163

attr[attrname] = (dbus_service_property

1164

(alt_interface,

1165

attribute._dbus_signature,

1166

attribute._dbus_access,

1167

attribute

1168

._dbus_get_args_options

1169

["byte_arrays"])

1170

(types.FunctionType

1171

(attribute.func_code,

1172

attribute.func_globals,

1173

attribute.func_name,

1174

attribute.func_defaults,

1175

attribute.func_closure)))

1662

attr[attrname] = (dbus_service_property(

1663

alt_interface, attribute._dbus_signature,

1664

attribute._dbus_access,

1665

attribute._dbus_get_args_options

1666

["byte_arrays"])

1667

(copy_function(attribute)))

1176

1668

# Copy annotations, if any

1177

1669

try:

1178

attr[attrname]._dbus_annotations = (

1179

dict(attribute._dbus_annotations))

1670

attr[attrname]._dbus_annotations = dict(

1671

attribute._dbus_annotations)

1180

1672

except AttributeError:

1181

1673

pass

1182

1674

# Is this a D-Bus interface?

1185

1677

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

1186

1678

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

1187

1679

# to the class.

1188

attr[attrname] = (dbus_interface_annotations

1189

(alt_interface)

1190

(types.FunctionType

1191

(attribute.func_code,

1192

attribute.func_globals,

1193

attribute.func_name,

1194

attribute.func_defaults,

1195

attribute.func_closure)))

1680

attr[attrname] = (

1681

dbus_interface_annotations(alt_interface)

1682

(copy_function(attribute)))

1196

1683

if deprecate:

1197

1684

# Deprecate all alternate interfaces

1198

iname="_AlternateDBusNames_interface_annotation{0}"

1685

iname = "_AlternateDBusNames_interface_annotation{}"

1199

1686

for interface_name in interface_names:

1687

1200

1688

@dbus_interface_annotations(interface_name)

1201

1689

def func(self):

1202

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

1203

"true" }

1690

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

1691

"true"}

1204

1692

# Find an unused name

1205

1693

for aname in (iname.format(i)

1206

1694

for i in itertools.count()):

1210

1698

if interface_names:

1211

1699

# Replace the class with a new subclass of it with

1212

1700

# methods, signals, etc. as created above.

1213

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

1214

(cls,), attr)

1701

if sys.version_info.major == 2:

1702

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

1703

(cls, ), attr)

1704

else:

1705

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

1706

(cls, ), attr)

1215

1707

return cls

1708

1216

1709

return wrapper

1217

1710

1218

1711

1219

1712

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

1220

"se.bsnet.fukt.Mandos"})

1713

"se.bsnet.fukt.Mandos"})

1221

1714

class ClientDBus(Client, DBusObjectWithProperties):

1222

1715

"""A Client class using D-Bus

1223

1716

1224

1717

Attributes:

1225

1718

dbus_object_path: dbus.ObjectPath

1226

1719

bus: dbus.SystemBus()

1227

1720

"""

1228

1721

1229

1722

runtime_expansions = (Client.runtime_expansions

1230

+ ("dbus_object_path",))

1231

1723

+ ("dbus_object_path", ))

1724

1725

_interface = "se.recompile.Mandos.Client"

1726

1232

1727

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

1233

1234

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

1728

1729

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

1235

1730

self.bus = bus

1236

1731

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

1237

1732

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

1238

1733

# the D-Bus

1239

client_object_name = unicode(self.name).translate(

1734

client_object_name = str(self.name).translate(

1240

1735

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

1241

1736

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

1242

self.dbus_object_path = (dbus.ObjectPath

1243

("/clients/" + client_object_name))

1737

self.dbus_object_path = dbus.ObjectPath(

1738

"/clients/" + client_object_name)

1244

1739

DBusObjectWithProperties.__init__(self, self.bus,

1245

1740

self.dbus_object_path)

1246

1247

def notifychangeproperty(transform_func,

1248

dbus_name, type_func=lambda x: x,

1249

variant_level=1):

1741

1742

def notifychangeproperty(transform_func, dbus_name,

1743

type_func=lambda x: x,

1744

variant_level=1,

1745

invalidate_only=False,

1746

_interface=_interface):

1250

1747

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

1251

1748

its changes to DBus.

1252

1749

1253

1750

transform_fun: Function that takes a value and a variant_level

1254

1751

and transforms it to a D-Bus type.

1255

1752

dbus_name: D-Bus name of the variable

1257

1754

to the D-Bus. Default: no transform

1258

1755

variant_level: D-Bus variant level. Default: 1

1259

1756

"""

1260

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

1757

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

1758

1261

1759

def setter(self, value):

1262

1760

if hasattr(self, "dbus_object_path"):

1263

1761

if (not hasattr(self, attrname) or

1264

1762

type_func(getattr(self, attrname, None))

1265

1763

!= type_func(value)):

1266

dbus_value = transform_func(type_func(value),

1267

variant_level

1268

=variant_level)

1269

self.PropertyChanged(dbus.String(dbus_name),

1270

dbus_value)

1764

if invalidate_only:

1765

self.PropertiesChanged(

1766

_interface, dbus.Dictionary(),

1767

dbus.Array((dbus_name, )))

1768

else:

1769

dbus_value = transform_func(

1770

type_func(value),

1771

variant_level=variant_level)

1772

self.PropertyChanged(dbus.String(dbus_name),

1773

dbus_value)

1774

self.PropertiesChanged(

1775

_interface,

1776

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

1777

dbus_value}),

1778

dbus.Array())

1271

1779

setattr(self, attrname, value)

1272

1780

1273

1781

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

1274

1782

1275

1783

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1276

1784

approvals_pending = notifychangeproperty(dbus.Boolean,

1277

1785

"ApprovalPending",

1278

type_func = bool)

1786

type_func=bool)

1279

1787

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

1280

1788

last_enabled = notifychangeproperty(datetime_to_dbus,

1281

1789

"LastEnabled")

1282

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

1283

type_func = lambda checker:

1284

checker is not None)

1790

checker = notifychangeproperty(

1791

dbus.Boolean, "CheckerRunning",

1792

type_func=lambda checker: checker is not None)

1285

1793

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1286

1794

"LastCheckedOK")

1287

1795

last_checker_status = notifychangeproperty(dbus.Int16,

1290

1798

datetime_to_dbus, "LastApprovalRequest")

1291

1799

approved_by_default = notifychangeproperty(dbus.Boolean,

1292

1800

"ApprovedByDefault")

1293

approval_delay = notifychangeproperty(dbus.UInt64,

1294

"ApprovalDelay",

1295

type_func =

1296

timedelta_to_milliseconds)

1801

approval_delay = notifychangeproperty(

1802

dbus.UInt64, "ApprovalDelay",

1803

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

1297

1804

approval_duration = notifychangeproperty(

1298

1805

dbus.UInt64, "ApprovalDuration",

1299

type_func = timedelta_to_milliseconds)

1806

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

1300

1807

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

1301

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

1302

type_func =

1303

timedelta_to_milliseconds)

1808

timeout = notifychangeproperty(

1809

dbus.UInt64, "Timeout",

1810

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

1304

1811

extended_timeout = notifychangeproperty(

1305

1812

dbus.UInt64, "ExtendedTimeout",

1306

type_func = timedelta_to_milliseconds)

1307

interval = notifychangeproperty(dbus.UInt64,

1308

"Interval",

1309

type_func =

1310

timedelta_to_milliseconds)

1813

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

1814

interval = notifychangeproperty(

1815

dbus.UInt64, "Interval",

1816

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

1311

1817

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

1312

1818

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

1819

invalidate_only=True)

1820

1313

1821

del notifychangeproperty

1314

1822

1315

1823

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

1316

1824

try:

1317

1825

self.remove_from_connection()

1320

1828

if hasattr(DBusObjectWithProperties, "__del__"):

1321

1829

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

1322

1830

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

1323

1324

def checker_callback(self, pid, condition, command,

1325

*args, **kwargs):

1326

self.checker_callback_tag = None

1327

self.checker = None

1328

if os.WIFEXITED(condition):

1329

exitstatus = os.WEXITSTATUS(condition)

1831

1832

def checker_callback(self, source, condition,

1833

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

1834

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

1835

connection, command, *args,

1836

**kwargs)

1837

exitstatus = self.last_checker_status

1838

if exitstatus >= 0:

1330

1839

# Emit D-Bus signal

1331

1840

self.CheckerCompleted(dbus.Int16(exitstatus),

1332

dbus.Int64(condition),

1841

# This is specific to GNU libC

1842

dbus.Int64(exitstatus << 8),

1333

1843

dbus.String(command))

1334

1844

else:

1335

1845

# Emit D-Bus signal

1336

1846

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

1337

dbus.Int64(condition),

1847

dbus.Int64(

1848

# This is specific to GNU libC

1849

(exitstatus << 8)

1850

| self.last_checker_signal),

1338

1851

dbus.String(command))

1339

1340

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

1341

*args, **kwargs)

1342

1852

return ret

1853

1343

1854

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

1344

old_checker = self.checker

1345

if self.checker is not None:

1346

old_checker_pid = self.checker.pid

1347

else:

1348

old_checker_pid = None

1855

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

1349

1856

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

1350

1857

# Only if new checker process was started

1351

1858

if (self.checker is not None

1353

1860

# Emit D-Bus signal

1354

1861

self.CheckerStarted(self.current_checker_command)

1355

1862

return r

1356

1863

1357

1864

def _reset_approved(self):

1358

1865

self.approved = None

1359

1866

return False

1360

1867

1361

1868

def approve(self, value=True):

1362

1869

self.approved = value

1363

gobject.timeout_add(timedelta_to_milliseconds

1364

(self.approval_duration),

1365

self._reset_approved)

1870

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

1871

* 1000), self._reset_approved)

1366

1872

self.send_changedstate()

1367

1368

## D-Bus methods, signals & properties

1369

_interface = "se.recompile.Mandos.Client"

1370

1371

## Interfaces

1372

1373

@dbus_interface_annotations(_interface)

1374

def _foo(self):

1375

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

1376

"false"}

1377

1378

## Signals

1379

1873

1874

# D-Bus methods, signals & properties

1875

1876

# Interfaces

1877

1878

# Signals

1879

1380

1880

# CheckerCompleted - signal

1381

1881

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

1382

1882

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

1383

1883

"D-Bus signal"

1384

1884

pass

1385

1885

1386

1886

# CheckerStarted - signal

1387

1887

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

1388

1888

def CheckerStarted(self, command):

1389

1889

"D-Bus signal"

1390

1890

pass

1391

1891

1392

1892

# PropertyChanged - signal

1893

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

1393

1894

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

1394

1895

def PropertyChanged(self, property, value):

1395

1896

"D-Bus signal"

1396

1897

pass

1397

1898

1398

1899

# GotSecret - signal

1399

1900

@dbus.service.signal(_interface)

1400

1901

def GotSecret(self):

1403

1904

server to mandos-client

1404

1905

"""

1405

1906

pass

1406

1907

1407

1908

# Rejected - signal

1408

1909

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

1409

1910

def Rejected(self, reason):

1410

1911

"D-Bus signal"

1411

1912

pass

1412

1913

1413

1914

# NeedApproval - signal

1414

1915

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

1415

1916

def NeedApproval(self, timeout, default):

1416

1917

"D-Bus signal"

1417

1918

return self.need_approval()

1418

1419

## Methods

1420

1919

1920

# Methods

1921

1421

1922

# Approve - method

1422

1923

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

1423

1924

def Approve(self, value):

1424

1925

self.approve(value)

1425

1926

1426

1927

# CheckedOK - method

1427

1928

@dbus.service.method(_interface)

1428

1929

def CheckedOK(self):

1429

1930

self.checked_ok()

1430

1931

1431

1932

# Enable - method

1933

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

1432

1934

@dbus.service.method(_interface)

1433

1935

def Enable(self):

1434

1936

"D-Bus method"

1435

1937

self.enable()

1436

1938

1437

1939

# StartChecker - method

1940

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

1438

1941

@dbus.service.method(_interface)

1439

1942

def StartChecker(self):

1440

1943

"D-Bus method"

1441

1944

self.start_checker()

1442

1945

1443

1946

# Disable - method

1947

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

1444

1948

@dbus.service.method(_interface)

1445

1949

def Disable(self):

1446

1950

"D-Bus method"

1447

1951

self.disable()

1448

1952

1449

1953

# StopChecker - method

1954

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

1450

1955

@dbus.service.method(_interface)

1451

1956

def StopChecker(self):

1452

1957

self.stop_checker()

1453

1454

## Properties

1455

1958

1959

# Properties

1960

1456

1961

# ApprovalPending - property

1457

1962

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

1458

1963

def ApprovalPending_dbus_property(self):

1459

1964

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

1460

1965

1461

1966

# ApprovedByDefault - property

1462

@dbus_service_property(_interface, signature="b",

1967

@dbus_service_property(_interface,

1968

signature="b",

1463

1969

access="readwrite")

1464

1970

def ApprovedByDefault_dbus_property(self, value=None):

1465

1971

if value is None: # get

1466

1972

return dbus.Boolean(self.approved_by_default)

1467

1973

self.approved_by_default = bool(value)

1468

1974

1469

1975

# ApprovalDelay - property

1470

@dbus_service_property(_interface, signature="t",

1976

@dbus_service_property(_interface,

1977

signature="t",

1471

1978

access="readwrite")

1472

1979

def ApprovalDelay_dbus_property(self, value=None):

1473

1980

if value is None: # get

1474

return dbus.UInt64(self.approval_delay_milliseconds())

1981

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

1982

* 1000)

1475

1983

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

1476

1984

1477

1985

# ApprovalDuration - property

1478

@dbus_service_property(_interface, signature="t",

1986

@dbus_service_property(_interface,

1987

signature="t",

1479

1988

access="readwrite")

1480

1989

def ApprovalDuration_dbus_property(self, value=None):

1481

1990

if value is None: # get

1482

return dbus.UInt64(timedelta_to_milliseconds(

1483

self.approval_duration))

1991

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

1992

* 1000)

1484

1993

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

1485

1994

1486

1995

# Name - property

1996

@dbus_annotations(

1997

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

1487

1998

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

1488

1999

def Name_dbus_property(self):

1489

2000

return dbus.String(self.name)

1490

2001

1491

2002

# Fingerprint - property

2003

@dbus_annotations(

2004

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

1492

2005

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

1493

2006

def Fingerprint_dbus_property(self):

1494

2007

return dbus.String(self.fingerprint)

1495

2008

1496

2009

# Host - property

1497

@dbus_service_property(_interface, signature="s",

2010

@dbus_service_property(_interface,

2011

signature="s",

1498

2012

access="readwrite")

1499

2013

def Host_dbus_property(self, value=None):

1500

2014

if value is None: # get

1501

2015

return dbus.String(self.host)

1502

self.host = unicode(value)

1503

2016

self.host = str(value)

2017

1504

2018

# Created - property

2019

@dbus_annotations(

2020

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

1505

2021

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

1506

2022

def Created_dbus_property(self):

1507

2023

return datetime_to_dbus(self.created)

1508

2024

1509

2025

# LastEnabled - property

1510

2026

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

1511

2027

def LastEnabled_dbus_property(self):

1512

2028

return datetime_to_dbus(self.last_enabled)

1513

2029

1514

2030

# Enabled - property

1515

@dbus_service_property(_interface, signature="b",

2031

@dbus_service_property(_interface,

2032

signature="b",

1516

2033

access="readwrite")

1517

2034

def Enabled_dbus_property(self, value=None):

1518

2035

if value is None: # get

1521

2038

self.enable()

1522

2039

else:

1523

2040

self.disable()

1524

2041

1525

2042

# LastCheckedOK - property

1526

@dbus_service_property(_interface, signature="s",

2043

@dbus_service_property(_interface,

2044

signature="s",

1527

2045

access="readwrite")

1528

2046

def LastCheckedOK_dbus_property(self, value=None):

1529

2047

if value is not None:

1530

2048

self.checked_ok()

1531

2049

return

1532

2050

return datetime_to_dbus(self.last_checked_ok)

1533

2051

1534

2052

# LastCheckerStatus - property

1535

@dbus_service_property(_interface, signature="n",

1536

access="read")

2053

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

1537

2054

def LastCheckerStatus_dbus_property(self):

1538

2055

return dbus.Int16(self.last_checker_status)

1539

2056

1540

2057

# Expires - property

1541

2058

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

1542

2059

def Expires_dbus_property(self):

1543

2060

return datetime_to_dbus(self.expires)

1544

2061

1545

2062

# LastApprovalRequest - property

1546

2063

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

1547

2064

def LastApprovalRequest_dbus_property(self):

1548

2065

return datetime_to_dbus(self.last_approval_request)

1549

2066

1550

2067

# Timeout - property

1551

@dbus_service_property(_interface, signature="t",

2068

@dbus_service_property(_interface,

2069

signature="t",

1552

2070

access="readwrite")

1553

2071

def Timeout_dbus_property(self, value=None):

1554

2072

if value is None: # get

1555

return dbus.UInt64(self.timeout_milliseconds())

2073

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

1556

2074

old_timeout = self.timeout

1557

2075

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

1558

2076

# Reschedule disabling

1566

2084

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

1567

2085

is None):

1568

2086

return

1569

gobject.source_remove(self.disable_initiator_tag)

1570

self.disable_initiator_tag = (

1571

gobject.timeout_add(

1572

timedelta_to_milliseconds(self.expires - now),

1573

self.disable))

1574

2087

GLib.source_remove(self.disable_initiator_tag)

2088

self.disable_initiator_tag = GLib.timeout_add(

2089

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

2090

self.disable)

2091

1575

2092

# ExtendedTimeout - property

1576

@dbus_service_property(_interface, signature="t",

2093

@dbus_service_property(_interface,

2094

signature="t",

1577

2095

access="readwrite")

1578

2096

def ExtendedTimeout_dbus_property(self, value=None):

1579

2097

if value is None: # get

1580

return dbus.UInt64(self.extended_timeout_milliseconds())

2098

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

2099

* 1000)

1581

2100

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

1582

2101

1583

2102

# Interval - property

1584

@dbus_service_property(_interface, signature="t",

2103

@dbus_service_property(_interface,

2104

signature="t",

1585

2105

access="readwrite")

1586

2106

def Interval_dbus_property(self, value=None):

1587

2107

if value is None: # get

1588

return dbus.UInt64(self.interval_milliseconds())

2108

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

1589

2109

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

1590

2110

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

1591

2111

return

1592

2112

if self.enabled:

1593

2113

# Reschedule checker run

1594

gobject.source_remove(self.checker_initiator_tag)

1595

self.checker_initiator_tag = (gobject.timeout_add

1596

(value, self.start_checker))

1597

self.start_checker() # Start one now, too

1598

2114

GLib.source_remove(self.checker_initiator_tag)

2115

self.checker_initiator_tag = GLib.timeout_add(

2116

value, self.start_checker)

2117

self.start_checker() # Start one now, too

2118

1599

2119

# Checker - property

1600

@dbus_service_property(_interface, signature="s",

2120

@dbus_service_property(_interface,

2121

signature="s",

1601

2122

access="readwrite")

1602

2123

def Checker_dbus_property(self, value=None):

1603

2124

if value is None: # get

1604

2125

return dbus.String(self.checker_command)

1605

self.checker_command = unicode(value)

1606

2126

self.checker_command = str(value)

2127

1607

2128

# CheckerRunning - property

1608

@dbus_service_property(_interface, signature="b",

2129

@dbus_service_property(_interface,

2130

signature="b",

1609

2131

access="readwrite")

1610

2132

def CheckerRunning_dbus_property(self, value=None):

1611

2133

if value is None: # get

1614

2136

self.start_checker()

1615

2137

else:

1616

2138

self.stop_checker()

1617

2139

1618

2140

# ObjectPath - property

2141

@dbus_annotations(

2142

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

2143

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

1619

2144

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

1620

2145

def ObjectPath_dbus_property(self):

1621

return self.dbus_object_path # is already a dbus.ObjectPath

1622

2146

return self.dbus_object_path # is already a dbus.ObjectPath

2147

1623

2148

# Secret = property

1624

@dbus_service_property(_interface, signature="ay",

1625

access="write", byte_arrays=True)

2149

@dbus_annotations(

2150

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

2151

"invalidates"})

2152

@dbus_service_property(_interface,

2153

signature="ay",

2154

access="write",

2155

byte_arrays=True)

1626

2156

def Secret_dbus_property(self, value):

1627

self.secret = str(value)

1628

2157

self.secret = bytes(value)

2158

1629

2159

del _interface

1630

2160

1631

2161

1634

2164

self._pipe = child_pipe

1635

2165

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

1636

2166

if not self._pipe.recv():

1637

raise KeyError()

1638

2167

raise KeyError(fpr)

2168

1639

2169

def __getattribute__(self, name):

1640

2170

if name == '_pipe':

1641

2171

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

1644

2174

if data[0] == 'data':

1645

2175

return data[1]

1646

2176

if data[0] == 'function':

2177

1647

2178

def func(*args, **kwargs):

1648

2179

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

1649

2180

return self._pipe.recv()[1]

2181

1650

2182

return func

1651

2183

1652

2184

def __setattr__(self, name, value):

1653

2185

if name == '_pipe':

1654

2186

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

1657

2189

1658

2190

class ClientHandler(socketserver.BaseRequestHandler, object):

1659

2191

"""A class to handle client connections.

1660

2192

1661

2193

Instantiated once for each connection to handle it.

1662

2194

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

1663

2195

1664

2196

def handle(self):

1665

2197

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

1666

2198

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

1667

unicode(self.client_address))

2199

str(self.client_address))

1668

2200

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

1669

2201

self.server.child_pipe.fileno())

1670

1671

session = (gnutls.connection

1672

.ClientSession(self.request,

1673

gnutls.connection

1674

.X509Credentials()))

1675

1676

# Note: gnutls.connection.X509Credentials is really a

1677

# generic GnuTLS certificate credentials object so long as

1678

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

1679

# here despite using OpenPGP certificates.

1680

1681

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

1682

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

1683

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

1684

# "+DHE-DSS"))

2202

2203

session = gnutls.ClientSession(self.request)

2204

2205

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

2206

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

2207

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

2208

# "+DHE-DSS"))

1685

2209

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

1686

2210

priority = self.server.gnutls_priority

1687

2211

if priority is None:

1688

2212

priority = "NORMAL"

1689

(gnutls.library.functions

1690

.gnutls_priority_set_direct(session._c_object,

1691

priority, None))

1692

2213

gnutls.priority_set_direct(session._c_object,

2214

priority.encode("utf-8"),

2215

None)

2216

1693

2217

# Start communication using the Mandos protocol

1694

2218

# Get protocol number

1695

2219

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

1696

2220

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

1697

2221

try:

1698

2222

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

1699

raise RuntimeError

2223

raise RuntimeError(line)

1700

2224

except (ValueError, IndexError, RuntimeError) as error:

1701

2225

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

1702

2226

return

1703

2227

1704

2228

# Start GnuTLS connection

1705

2229

try:

1706

2230

session.handshake()

1707

except gnutls.errors.GNUTLSError as error:

2231

except gnutls.Error as error:

1708

2232

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

1709

2233

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

1710

2234

# established. Just abandon the request.

1711

2235

return

1712

2236

logger.debug("Handshake succeeded")

1713

2237

1714

2238

approval_required = False

1715

2239

try:

1716

2240

try:

1717

fpr = self.fingerprint(self.peer_certificate

1718

(session))

1719

except (TypeError,

1720

gnutls.errors.GNUTLSError) as error:

2241

fpr = self.fingerprint(

2242

self.peer_certificate(session))

2243

except (TypeError, gnutls.Error) as error:

1721

2244

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

1722

2245

return

1723

2246

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

1724

2247

1725

2248

try:

1726

2249

client = ProxyClient(child_pipe, fpr,

1727

2250

self.client_address)

1728

2251

except KeyError:

1729

2252

return

1730

2253

1731

2254

if client.approval_delay:

1732

2255

delay = client.approval_delay

1733

2256

client.approvals_pending += 1

1734

2257

approval_required = True

1735

2258

1736

2259

while True:

1737

2260

if not client.enabled:

1738

2261

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

1739

client.name)

2262

client.name)

1740

2263

if self.server.use_dbus:

1741

2264

# Emit D-Bus signal

1742

2265

client.Rejected("Disabled")

1743

2266

return

1744

2267

1745

2268

if client.approved or not client.approval_delay:

1746

#We are approved or approval is disabled

2269

# We are approved or approval is disabled

1747

2270

break

1748

2271

elif client.approved is None:

1749

2272

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

1751

2274

if self.server.use_dbus:

1752

2275

# Emit D-Bus signal

1753

2276

client.NeedApproval(

1754

client.approval_delay_milliseconds(),

1755

client.approved_by_default)

2277

client.approval_delay.total_seconds()

2278

* 1000, client.approved_by_default)

1756

2279

else:

1757

2280

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

1758

2281

client.name)

1760

2283

# Emit D-Bus signal

1761

2284

client.Rejected("Denied")

1762

2285

return

1763

1764

#wait until timeout or approved

2286

2287

# wait until timeout or approved

1765

2288

time = datetime.datetime.now()

1766

2289

client.changedstate.acquire()

1767

client.changedstate.wait(

1768

float(timedelta_to_milliseconds(delay)

1769

/ 1000))

2290

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

1770

2291

client.changedstate.release()

1771

2292

time2 = datetime.datetime.now()

1772

2293

if (time2 - time) >= delay:

1782

2303

break

1783

2304

else:

1784

2305

delay -= time2 - time

1785

1786

sent_size = 0

1787

while sent_size < len(client.secret):

1788

try:

1789

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

1790

except gnutls.errors.GNUTLSError as error:

1791

logger.warning("gnutls send failed",

1792

exc_info=error)

1793

return

1794

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

1795

sent, len(client.secret)

1796

- (sent_size + sent))

1797

sent_size += sent

1798

2306

2307

try:

2308

session.send(client.secret)

2309

except gnutls.Error as error:

2310

logger.warning("gnutls send failed",

2311

exc_info=error)

2312

return

2313

1799

2314

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

1800

2315

# bump the timeout using extended_timeout

1801

2316

client.bump_timeout(client.extended_timeout)

1802

2317

if self.server.use_dbus:

1803

2318

# Emit D-Bus signal

1804

2319

client.GotSecret()

1805

2320

1806

2321

finally:

1807

2322

if approval_required:

1808

2323

client.approvals_pending -= 1

1809

2324

try:

1810

2325

session.bye()

1811

except gnutls.errors.GNUTLSError as error:

2326

except gnutls.Error as error:

1812

2327

logger.warning("GnuTLS bye failed",

1813

2328

exc_info=error)

1814

2329

1815

2330

@staticmethod

1816

2331

def peer_certificate(session):

1817

2332

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

1818

2333

# If not an OpenPGP certificate...

1819

if (gnutls.library.functions

1820

.gnutls_certificate_type_get(session._c_object)

1821

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1822

# ...do the normal thing

1823

return session.peer_certificate

2334

if (gnutls.certificate_type_get(session._c_object)

2335

!= gnutls.CRT_OPENPGP):

2336

# ...return invalid data

2337

return b""

1824

2338

list_size = ctypes.c_uint(1)

1825

cert_list = (gnutls.library.functions

1826

.gnutls_certificate_get_peers

2339

cert_list = (gnutls.certificate_get_peers

1827

2340

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

1828

2341

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

1829

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

1830

" certificate")

2342

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

1831

2343

if list_size.value == 0:

1832

2344

return None

1833

2345

cert = cert_list[0]

1834

2346

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

1835

2347

1836

2348

@staticmethod

1837

2349

def fingerprint(openpgp):

1838

2350

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1839

2351

# New GnuTLS "datum" with the OpenPGP public key

1840

datum = (gnutls.library.types

1841

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

1842

ctypes.POINTER

1843

(ctypes.c_ubyte)),

1844

ctypes.c_uint(len(openpgp))))

2352

datum = gnutls.datum_t(

2353

ctypes.cast(ctypes.c_char_p(openpgp),

2354

ctypes.POINTER(ctypes.c_ubyte)),

2355

ctypes.c_uint(len(openpgp)))

1845

2356

# New empty GnuTLS certificate

1846

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1847

(gnutls.library.functions

1848

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2357

crt = gnutls.openpgp_crt_t()

2358

gnutls.openpgp_crt_init(ctypes.byref(crt))

1849

2359

# Import the OpenPGP public key into the certificate

1850

(gnutls.library.functions

1851

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

1852

gnutls.library.constants

1853

.GNUTLS_OPENPGP_FMT_RAW))

2360

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

2361

gnutls.OPENPGP_FMT_RAW)

1854

2362

# Verify the self signature in the key

1855

2363

crtverify = ctypes.c_uint()

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_verify_self(crt, 0,

1858

ctypes.byref(crtverify)))

2364

gnutls.openpgp_crt_verify_self(crt, 0,

2365

ctypes.byref(crtverify))

1859

2366

if crtverify.value != 0:

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1861

raise (gnutls.errors.CertificateSecurityError

1862

("Verify failed"))

2367

gnutls.openpgp_crt_deinit(crt)

2368

raise gnutls.CertificateSecurityError("Verify failed")

1863

2369

# New buffer for the fingerprint

1864

2370

buf = ctypes.create_string_buffer(20)

1865

2371

buf_len = ctypes.c_size_t()

1866

2372

# Get the fingerprint from the certificate into the buffer

1867

(gnutls.library.functions

1868

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

1869

ctypes.byref(buf_len)))

2373

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

2374

ctypes.byref(buf_len))

1870

2375

# Deinit the certificate

1871

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2376

gnutls.openpgp_crt_deinit(crt)

1872

2377

# Convert the buffer to a Python bytestring

1873

2378

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

1874

2379

# Convert the bytestring to hexadecimal notation

1878

2383

1879

2384

class MultiprocessingMixIn(object):

1880

2385

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

2386

1881

2387

def sub_process_main(self, request, address):

1882

2388

try:

1883

2389

self.finish_request(request, address)

1884

2390

except Exception:

1885

2391

self.handle_error(request, address)

1886

2392

self.close_request(request)

1887

2393

1888

2394

def process_request(self, request, address):

1889

2395

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

1890

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

1891

args = (request, address))

2396

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

2397

args=(request, address))

1892

2398

proc.start()

1893

2399

return proc

1894

2400

1895

2401

1896

2402

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1897

2403

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

2404

1898

2405

def process_request(self, request, client_address):

1899

2406

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

1900

2407

1901

2408

This function creates a new pipe in self.pipe

1902

2409

"""

1903

2410

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1904

2411

1905

2412

proc = MultiprocessingMixIn.process_request(self, request,

1906

2413

client_address)

1907

2414

self.child_pipe.close()

1908

2415

self.add_pipe(parent_pipe, proc)

1909

2416

1910

2417

def add_pipe(self, parent_pipe, proc):

1911

2418

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

1912

raise NotImplementedError

2419

raise NotImplementedError()

1913

2420

1914

2421

1915

2422

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1916

2423

socketserver.TCPServer, object):

1917

2424

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

1918

2425

1919

2426

Attributes:

1920

2427

enabled: Boolean; whether this server is activated yet

1921

2428

interface: None or a network interface name (string)

1922

2429

use_ipv6: Boolean; to use IPv6 or not

1923

2430

"""

2431

1924

2432

def __init__(self, server_address, RequestHandlerClass,

1925

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

2433

interface=None,

2434

use_ipv6=True,

2435

socketfd=None):

1926

2436

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

1927

2437

creating a new one with socket.socket().

1928

2438

"""

1934

2444

self.socketfd = socketfd

1935

2445

# Save the original socket.socket() function

1936

2446

self.socket_socket = socket.socket

2447

1937

2448

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

1938

#

2449

#

1939

2450

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

1940

2451

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

1941

2452

# patching socket.socket.)

1942

#

2453

#

1943

2454

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

1944

2455

@functools.wraps(socket.socket)

1945

2456

def socket_wrapper(*args, **kwargs):

1957

2468

# socket_wrapper(), if socketfd was set.

1958

2469

socketserver.TCPServer.__init__(self, server_address,

1959

2470

RequestHandlerClass)

1960

2471

1961

2472

def server_bind(self):

1962

2473

"""This overrides the normal server_bind() function

1963

2474

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

1964

2475

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

2476

global SO_BINDTODEVICE

1965

2477

if self.interface is not None:

1966

2478

if SO_BINDTODEVICE is None:

1967

logger.error("SO_BINDTODEVICE does not exist;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

else:

1971

try:

1972

self.socket.setsockopt(socket.SOL_SOCKET,

1973

SO_BINDTODEVICE,

1974

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

1975

except socket.error as error:

1976

if error.errno == errno.EPERM:

1977

logger.error("No permission to bind to"

1978

" interface %s", self.interface)

1979

elif error.errno == errno.ENOPROTOOPT:

1980

logger.error("SO_BINDTODEVICE not available;"

1981

" cannot bind to interface %s",

1982

self.interface)

1983

elif error.errno == errno.ENODEV:

1984

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

1985

" cannot bind", self.interface)

1986

else:

1987

raise

2479

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

2480

# common enough.

2481

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

2482

SO_BINDTODEVICE = 25

2483

try:

2484

self.socket.setsockopt(

2485

socket.SOL_SOCKET, SO_BINDTODEVICE,

2486

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

2487

except socket.error as error:

2488

if error.errno == errno.EPERM:

2489

logger.error("No permission to bind to"

2490

" interface %s", self.interface)

2491

elif error.errno == errno.ENOPROTOOPT:

2492

logger.error("SO_BINDTODEVICE not available;"

2493

" cannot bind to interface %s",

2494

self.interface)

2495

elif error.errno == errno.ENODEV:

2496

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

2497

" cannot bind", self.interface)

2498

else:

2499

raise

1988

2500

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

1989

2501

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

1990

2502

if not self.server_address[0]:

1991

2503

if self.address_family == socket.AF_INET6:

1992

any_address = "::" # in6addr_any

2504

any_address = "::" # in6addr_any

1993

2505

else:

1994

any_address = socket.INADDR_ANY

2506

any_address = "0.0.0.0" # INADDR_ANY

1995

2507

self.server_address = (any_address,

1996

2508

self.server_address[1])

1997

2509

elif not self.server_address[1]:

1998

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

1999

0)

2510

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

2000

2511

# if self.interface:

2001

2512

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

2002

2513

# 0, # port

2008

2519

2009

2520

class MandosServer(IPv6_TCPServer):

2010

2521

"""Mandos server.

2011

2522

2012

2523

Attributes:

2013

2524

clients: set of Client objects

2014

2525

gnutls_priority GnuTLS priority string

2015

2526

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

2016

2017

Assumes a gobject.MainLoop event loop.

2527

2528

Assumes a GLib.MainLoop event loop.

2018

2529

"""

2530

2019

2531

def __init__(self, server_address, RequestHandlerClass,

2020

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

2021

gnutls_priority=None, use_dbus=True, socketfd=None):

2532

interface=None,

2533

use_ipv6=True,

2534

clients=None,

2535

gnutls_priority=None,

2536

use_dbus=True,

2537

socketfd=None):

2022

2538

self.enabled = False

2023

2539

self.clients = clients

2024

2540

if self.clients is None:

2027

2543

self.gnutls_priority = gnutls_priority

2028

2544

IPv6_TCPServer.__init__(self, server_address,

2029

2545

RequestHandlerClass,

2030

interface = interface,

2031

use_ipv6 = use_ipv6,

2032

socketfd = socketfd)

2546

interface=interface,

2547

use_ipv6=use_ipv6,

2548

socketfd=socketfd)

2549

2033

2550

def server_activate(self):

2034

2551

if self.enabled:

2035

2552

return socketserver.TCPServer.server_activate(self)

2036

2553

2037

2554

def enable(self):

2038

2555

self.enabled = True

2039

2556

2040

2557

def add_pipe(self, parent_pipe, proc):

2041

2558

# Call "handle_ipc" for both data and EOF events

2042

gobject.io_add_watch(parent_pipe.fileno(),

2043

gobject.IO_IN | gobject.IO_HUP,

2044

functools.partial(self.handle_ipc,

2045

parent_pipe =

2046

parent_pipe,

2047

proc = proc))

2048

2049

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

2050

proc = None, client_object=None):

2559

GLib.io_add_watch(

2560

parent_pipe.fileno(),

2561

GLib.IO_IN | GLib.IO_HUP,

2562

functools.partial(self.handle_ipc,

2563

parent_pipe=parent_pipe,

2564

proc=proc))

2565

2566

def handle_ipc(self, source, condition,

2567

parent_pipe=None,

2568

proc=None,

2569

client_object=None):

2051

2570

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

2052

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

2571

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

2053

2572

# Wait for other process to exit

2054

2573

proc.join()

2055

2574

return False

2056

2575

2057

2576

# Read a request from the child

2058

2577

request = parent_pipe.recv()

2059

2578

command = request[0]

2060

2579

2061

2580

if command == 'init':

2062

fpr = request[1]

2581

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

2063

2582

address = request[2]

2064

2065

for c in self.clients.itervalues():

2583

2584

for c in self.clients.values():

2066

2585

if c.fingerprint == fpr:

2067

2586

client = c

2068

2587

break

2075

2594

address[0])

2076

2595

parent_pipe.send(False)

2077

2596

return False

2078

2079

gobject.io_add_watch(parent_pipe.fileno(),

2080

gobject.IO_IN | gobject.IO_HUP,

2081

functools.partial(self.handle_ipc,

2082

parent_pipe =

2083

parent_pipe,

2084

proc = proc,

2085

client_object =

2086

client))

2597

2598

GLib.io_add_watch(

2599

parent_pipe.fileno(),

2600

GLib.IO_IN | GLib.IO_HUP,

2601

functools.partial(self.handle_ipc,

2602

parent_pipe=parent_pipe,

2603

proc=proc,

2604

client_object=client))

2087

2605

parent_pipe.send(True)

2088

2606

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

2089

2607

# same fileno

2092

2610

funcname = request[1]

2093

2611

args = request[2]

2094

2612

kwargs = request[3]

2095

2613

2096

2614

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

2097

2615

funcname)(*args,

2098

**kwargs)))

2099

2616

**kwargs)))

2617

2100

2618

if command == 'getattr':

2101

2619

attrname = request[1]

2102

if callable(client_object.__getattribute__(attrname)):

2103

parent_pipe.send(('function',))

2620

if isinstance(client_object.__getattribute__(attrname),

2621

collections.Callable):

2622

parent_pipe.send(('function', ))

2104

2623

else:

2105

parent_pipe.send(('data', client_object

2106

.__getattribute__(attrname)))

2107

2624

parent_pipe.send((

2625

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

2626

2108

2627

if command == 'setattr':

2109

2628

attrname = request[1]

2110

2629

value = request[2]

2111

2630

setattr(client_object, attrname, value)

2112

2631

2113

2632

return True

2114

2633

2115

2634

2116

2635

def rfc3339_duration_to_delta(duration):

2117

2636

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

2118

2637

2119

2638

>>> rfc3339_duration_to_delta("P7D")

2120

2639

datetime.timedelta(7)

2121

2640

>>> rfc3339_duration_to_delta("PT60S")

2131

2650

>>> rfc3339_duration_to_delta("P1DT3M20S")

2132

2651

datetime.timedelta(1, 200)

2133

2652

"""

2134

2653

2135

2654

# Parsing an RFC 3339 duration with regular expressions is not

2136

2655

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

2137

2656

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

2138

2657

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

2139

2658

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

2140

2659

# avoid excessive use of external libraries.

2141

2660

2142

2661

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

2143

Token = collections.namedtuple("Token",

2144

("regexp", # To match token; if

2145

# "value" is not None,

2146

# must have a "group"

2147

# containing digits

2148

"value", # datetime.timedelta or

2149

# None

2150

"followers")) # Tokens valid after

2151

# this token

2662

Token = collections.namedtuple("Token", (

2663

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

2664

# a "group" containing digits

2665

"value", # datetime.timedelta or None

2666

"followers")) # Tokens valid after this token

2152

2667

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

2153

2668

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

2154

2669

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

2155

2670

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

2156

2671

datetime.timedelta(seconds=1),

2157

frozenset((token_end,)))

2672

frozenset((token_end, )))

2158

2673

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

2159

2674

datetime.timedelta(minutes=1),

2160

2675

frozenset((token_second, token_end)))

2176

2691

frozenset((token_month, token_end)))

2177

2692

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

2178

2693

datetime.timedelta(weeks=1),

2179

frozenset((token_end,)))

2694

frozenset((token_end, )))

2180

2695

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

2181

2696

frozenset((token_year, token_month,

2182

2697

token_day, token_time,

2183

token_week))),

2184

# Define starting values

2185

value = datetime.timedelta() # Value so far

2698

token_week)))

2699

# Define starting values:

2700

# Value so far

2701

value = datetime.timedelta()

2186

2702

found_token = None

2187

followers = frozenset(token_duration,) # Following valid tokens

2188

s = duration # String left to parse

2703

# Following valid tokens

2704

followers = frozenset((token_duration, ))

2705

# String left to parse

2706

s = duration

2189

2707

# Loop until end token is found

2190

2708

while found_token is not token_end:

2191

2709

# Search for any currently valid tokens

2207

2725

break

2208

2726

else:

2209

2727

# No currently valid tokens were found

2210

raise ValueError("Invalid RFC 3339 duration")

2728

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

2729

.format(duration))

2211

2730

# End token found

2212

2731

return value

2213

2732

2214

2733

2215

2734

def string_to_delta(interval):

2216

2735

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

2217

2736

2218

2737

>>> string_to_delta('7d')

2219

2738

datetime.timedelta(7)

2220

2739

>>> string_to_delta('60s')

2228

2747

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

2229

2748

datetime.timedelta(0, 330)

2230

2749

"""

2231

2750

2232

2751

try:

2233

2752

return rfc3339_duration_to_delta(interval)

2234

2753

except ValueError:

2235

2754

pass

2236

2755

2237

2756

timevalue = datetime.timedelta(0)

2238

2757

for s in interval.split():

2239

2758

try:

2240

suffix = unicode(s[-1])

2759

suffix = s[-1]

2241

2760

value = int(s[:-1])

2242

2761

if suffix == "d":

2243

2762

delta = datetime.timedelta(value)

2250

2769

elif suffix == "w":

2251

2770

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

2252

2771

else:

2253

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

2254

.format(suffix))

2255

except (ValueError, IndexError) as e:

2772

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

2773

except IndexError as e:

2256

2774

raise ValueError(*(e.args))

2257

2775

timevalue += delta

2258

2776

return timevalue

2259

2777

2260

2778

2261

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

2779

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

2262

2780

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

2263

2781

2264

2782

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

2265

2783

if os.fork():

2266

2784

sys.exit()

2274

2792

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

2275

2793

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

2276

2794

raise OSError(errno.ENODEV,

2277

"{0} not a character device"

2795

"{} not a character device"

2278

2796

.format(os.devnull))

2279

2797

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

2280

2798

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

2284

2802

2285

2803

2286

2804

def main():

2287

2805

2288

2806

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

2289

2807

# Parsing of options, both command line and config file

2290

2808

2291

2809

parser = argparse.ArgumentParser()

2292

2810

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

2293

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

2811

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

2294

2812

help="show version number and exit")

2295

2813

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

2296

2814

help="Bind to interface IF")

2302

2820

help="Run self-test")

2303

2821

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

2304

2822

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

2305

" to terminal")

2823

" to terminal", default=None)

2306

2824

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

2307

2825

help="Debug level for stdout output")

2308

2826

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

2315

2833

" files")

2316

2834

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

2317

2835

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

2318

" system bus interface")

2836

" system bus interface", default=None)

2319

2837

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

2320

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

2838

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

2839

default=None)

2321

2840

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

2322

2841

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

2323

" state")

2842

" state", default=None)

2324

2843

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

2325

2844

help="Specify a file descriptor to a network"

2326

2845

" socket to use instead of creating one")

2327

2846

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

2328

2847

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

2329

2848

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

2330

help="Run in foreground")

2331

2849

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

2850

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

2851

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

2852

default=None)

2853

2332

2854

options = parser.parse_args()

2333

2855

2334

2856

if options.check:

2335

2857

import doctest

2336

doctest.testmod()

2337

sys.exit()

2338

2858

fail_count, test_count = doctest.testmod()

2859

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

2860

2339

2861

# Default values for config file for server-global settings

2340

server_defaults = { "interface": "",

2341

"address": "",

2342

"port": "",

2343

"debug": "False",

2344

"priority":

2345

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

2346

"servicename": "Mandos",

2347

"use_dbus": "True",

2348

"use_ipv6": "True",

2349

"debuglevel": "",

2350

"restore": "True",

2351

"socket": "",

2352

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

2353

"foreground": "False",

2354

}

2355

2862

server_defaults = {"interface": "",

2863

"address": "",

2864

"port": "",

2865

"debug": "False",

2866

"priority":

2867

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

2868

":+SIGN-DSA-SHA256",

2869

"servicename": "Mandos",

2870

"use_dbus": "True",

2871

"use_ipv6": "True",

2872

"debuglevel": "",

2873

"restore": "True",

2874

"socket": "",

2875

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

2876

"foreground": "False",

2877

"zeroconf": "True",

2878

}

2879

2356

2880

# Parse config file for server-global settings

2357

2881

server_config = configparser.SafeConfigParser(server_defaults)

2358

2882

del server_defaults

2359

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

2360

"mandos.conf"))

2883

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

2361

2884

# Convert the SafeConfigParser object to a dict

2362

2885

server_settings = server_config.defaults()

2363

2886

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

2364

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

2887

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

2888

"foreground", "zeroconf"):

2365

2889

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

2366

2890

option)

2367

2891

if server_settings["port"]:

2377

2901

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

2378

2902

["socket"])

2379

2903

del server_config

2380

2904

2381

2905

# Override the settings from the config file with command line

2382

2906

# options, if set.

2383

2907

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

2384

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

2385

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

2386

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

2908

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

2909

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

2910

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

2387

2911

value = getattr(options, option)

2388

2912

if value is not None:

2389

2913

server_settings[option] = value

2390

2914

del options

2391

2915

# Force all strings to be unicode

2392

2916

for option in server_settings.keys():

2393

if type(server_settings[option]) is str:

2394

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

2917

if isinstance(server_settings[option], bytes):

2918

server_settings[option] = (server_settings[option]

2919

.decode("utf-8"))

2920

# Force all boolean options to be boolean

2921

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

2922

"foreground", "zeroconf"):

2923

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

2395

2924

# Debug implies foreground

2396

2925

if server_settings["debug"]:

2397

2926

server_settings["foreground"] = True

2398

2927

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

2399

2928

2400

2929

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

2401

2930

2931

if (not server_settings["zeroconf"]

2932

and not (server_settings["port"]

2933

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

2934

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

2935

2402

2936

# For convenience

2403

2937

debug = server_settings["debug"]

2404

2938

debuglevel = server_settings["debuglevel"]

2407

2941

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

2408

2942

stored_state_file)

2409

2943

foreground = server_settings["foreground"]

2410

2944

zeroconf = server_settings["zeroconf"]

2945

2411

2946

if debug:

2412

2947

initlogger(debug, logging.DEBUG)

2413

2948

else:

2416

2951

else:

2417

2952

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

2418

2953

initlogger(debug, level)

2419

2954

2420

2955

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

2421

syslogger.setFormatter(logging.Formatter

2422

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

2423

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

2424

.format(server_settings

2425

["servicename"])))

2426

2956

syslogger.setFormatter(

2957

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

2958

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

2959

server_settings["servicename"])))

2960

2427

2961

# Parse config file with clients

2428

2962

client_config = configparser.SafeConfigParser(Client

2429

2963

.client_defaults)

2430

2964

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

2431

2965

"clients.conf"))

2432

2966

2433

2967

global mandos_dbus_service

2434

2968

mandos_dbus_service = None

2435

2436

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

2437

server_settings["port"]),

2438

ClientHandler,

2439

interface=(server_settings["interface"]

2440

or None),

2441

use_ipv6=use_ipv6,

2442

gnutls_priority=

2443

server_settings["priority"],

2444

use_dbus=use_dbus,

2445

socketfd=(server_settings["socket"]

2446

or None))

2969

2970

socketfd = None

2971

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

2972

socketfd = server_settings["socket"]

2973

tcp_server = MandosServer(

2974

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

2975

ClientHandler,

2976

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

2977

use_ipv6=use_ipv6,

2978

gnutls_priority=server_settings["priority"],

2979

use_dbus=use_dbus,

2980

socketfd=socketfd)

2447

2981

if not foreground:

2448

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

2982

pidfilename = "/run/mandos.pid"

2983

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

2984

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

2449

2985

pidfile = None

2450

2986

try:

2451

pidfile = open(pidfilename, "w")

2987

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

2452

2988

except IOError as e:

2453

2989

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

2454

2990

exc_info=e)

2455

2456

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

2991

2992

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

2993

("mandos", "mandos"),

2994

("nobody", "nogroup")):

2457

2995

try:

2458

2996

uid = pwd.getpwnam(name).pw_uid

2459

gid = pwd.getpwnam(name).pw_gid

2997

gid = pwd.getpwnam(group).pw_gid

2460

2998

break

2461

2999

except KeyError:

2462

3000

continue

2466

3004

try:

2467

3005

os.setgid(gid)

2468

3006

os.setuid(uid)

3007

if debug:

3008

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

3009

gid))

2469

3010

except OSError as error:

3011

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

3012

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

2470

3013

if error.errno != errno.EPERM:

2471

raise error

2472

3014

raise

3015

2473

3016

if debug:

2474

3017

# Enable all possible GnuTLS debugging

2475

3018

2476

3019

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

2477

3020

# - GnuTLS manual

2478

gnutls.library.functions.gnutls_global_set_log_level(11)

2479

2480

@gnutls.library.types.gnutls_log_func

3021

gnutls.global_set_log_level(11)

3022

3023

@gnutls.log_func

2481

3024

def debug_gnutls(level, string):

2482

3025

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

2483

2484

(gnutls.library.functions

2485

.gnutls_global_set_log_function(debug_gnutls))

2486

3026

3027

gnutls.global_set_log_function(debug_gnutls)

3028

2487

3029

# Redirect stdin so all checkers get /dev/null

2488

3030

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

2489

3031

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

2490

3032

if null > 2:

2491

3033

os.close(null)

2492

3034

2493

3035

# Need to fork before connecting to D-Bus

2494

3036

if not foreground:

2495

3037

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

2496

3038

daemon()

2497

2498

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

2499

# need to inform gobject that threads will be used.

2500

gobject.threads_init()

2501

3039

3040

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

3041

# to inform GLib that threads will be used.

3042

GLib.threads_init()

3043

2502

3044

global main_loop

2503

3045

# From the Avahi example code

2504

3046

DBusGMainLoop(set_as_default=True)

2505

main_loop = gobject.MainLoop()

3047

main_loop = GLib.MainLoop()

2506

3048

bus = dbus.SystemBus()

2507

3049

# End of Avahi example code

2508

3050

if use_dbus:

2509

3051

try:

2510

3052

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

2511

bus, do_not_queue=True)

2512

old_bus_name = (dbus.service.BusName

2513

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

2514

do_not_queue=True))

2515

except dbus.exceptions.NameExistsException as e:

3053

bus,

3054

do_not_queue=True)

3055

old_bus_name = dbus.service.BusName(

3056

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

3057

do_not_queue=True)

3058

except dbus.exceptions.DBusException as e:

2516

3059

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

2517

3060

use_dbus = False

2518

3061

server_settings["use_dbus"] = False

2519

3062

tcp_server.use_dbus = False

2520

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2521

service = AvahiServiceToSyslog(name =

2522

server_settings["servicename"],

2523

servicetype = "_mandos._tcp",

2524

protocol = protocol, bus = bus)

2525

if server_settings["interface"]:

2526

service.interface = (if_nametoindex

2527

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

2528

3063

if zeroconf:

3064

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3065

service = AvahiServiceToSyslog(

3066

name=server_settings["servicename"],

3067

servicetype="_mandos._tcp",

3068

protocol=protocol,

3069

bus=bus)

3070

if server_settings["interface"]:

3071

service.interface = if_nametoindex(

3072

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

3073

2529

3074

global multiprocessing_manager

2530

3075

multiprocessing_manager = multiprocessing.Manager()

2531

3076

2532

3077

client_class = Client

2533

3078

if use_dbus:

2534

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

2535

3079

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

3080

2536

3081

client_settings = Client.config_parser(client_config)

2537

3082

old_client_settings = {}

2538

3083

clients_data = {}

2539

3084

2540

3085

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

2541

3086

global wnull

2542

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

3087

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

2543

3088

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

2544

3089

# mode

2545

3090

if debug or not foreground:

2546

3091

wnull.close()

2547

3092

2548

3093

# Get client data and settings from last running state.

2549

3094

if server_settings["restore"]:

2550

3095

try:

2551

3096

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

2552

clients_data, old_client_settings = (pickle.load

2553

(stored_state))

3097

if sys.version_info.major == 2:

3098

clients_data, old_client_settings = pickle.load(

3099

stored_state)

3100

else:

3101

bytes_clients_data, bytes_old_client_settings = (

3102

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

3103

# Fix bytes to strings

3104

# clients_data

3105

# .keys()

3106

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

3107

if isinstance(key, bytes)

3108

else key): value

3109

for key, value in

3110

bytes_clients_data.items()}

3111

del bytes_clients_data

3112

for key in clients_data:

3113

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

3114

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

3115

for k, v in

3116

clients_data[key].items()}

3117

clients_data[key] = value

3118

# .client_structure

3119

value["client_structure"] = [

3120

(s.decode("utf-8")

3121

if isinstance(s, bytes)

3122

else s) for s in

3123

value["client_structure"]]

3124

# .name & .host

3125

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

3126

if isinstance(value[k], bytes):

3127

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

3128

# old_client_settings

3129

# .keys()

3130

old_client_settings = {

3131

(key.decode("utf-8")

3132

if isinstance(key, bytes)

3133

else key): value

3134

for key, value in

3135

bytes_old_client_settings.items()}

3136

del bytes_old_client_settings

3137

# .host

3138

for value in old_client_settings.values():

3139

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

3140

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

3141

.decode("utf-8"))

2554

3142

os.remove(stored_state_path)

2555

3143

except IOError as e:

2556

3144

if e.errno == errno.ENOENT:

2557

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

2558

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

3145

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

3146

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

2559

3147

else:

2560

3148

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

2561

3149

exc_info=e)

2562

3150

raise

2563

3151

except EOFError as e:

2564

3152

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

2565

"EOFError:", exc_info=e)

2566

3153

"EOFError:",

3154

exc_info=e)

3155

2567

3156

with PGPEngine() as pgp:

2568

for client_name, client in clients_data.iteritems():

3157

for client_name, client in clients_data.items():

2569

3158

# Skip removed clients

2570

3159

if client_name not in client_settings:

2571

3160

continue

2572

3161

2573

3162

# Decide which value to use after restoring saved state.

2574

3163

# We have three different values: Old config file,

2575

3164

# new config file, and saved state.

2580

3169

# For each value in new config, check if it

2581

3170

# differs from the old config value (Except for

2582

3171

# the "secret" attribute)

2583

if (name != "secret" and

2584

value != old_client_settings[client_name]

2585

[name]):

3172

if (name != "secret"

3173

and (value !=

3174

old_client_settings[client_name][name])):

2586

3175

client[name] = value

2587

3176

except KeyError:

2588

3177

pass

2589

3178

2590

3179

# Clients who has passed its expire date can still be

2591

# enabled if its last checker was successful. Clients

3180

# enabled if its last checker was successful. A Client

2592

3181

# whose checker succeeded before we stored its state is

2593

3182

# assumed to have successfully run all checkers during

2594

3183

# downtime.

2596

3185

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

2597

3186

if not client["last_checked_ok"]:

2598

3187

logger.warning(

2599

"disabling client {0} - Client never "

2600

"performed a successful checker"

2601

.format(client_name))

3188

"disabling client {} - Client never "

3189

"performed a successful checker".format(

3190

client_name))

2602

3191

client["enabled"] = False

2603

3192

elif client["last_checker_status"] != 0:

2604

3193

logger.warning(

2605

"disabling client {0} - Client "

2606

"last checker failed with error code {1}"

2607

.format(client_name,

2608

client["last_checker_status"]))

3194

"disabling client {} - Client last"

3195

" checker failed with error code"

3196

" {}".format(

3197

client_name,

3198

client["last_checker_status"]))

2609

3199

client["enabled"] = False

2610

3200

else:

2611

client["expires"] = (datetime.datetime

2612

.utcnow()

2613

+ client["timeout"])

3201

client["expires"] = (

3202

datetime.datetime.utcnow()

3203

+ client["timeout"])

2614

3204

logger.debug("Last checker succeeded,"

2615

" keeping {0} enabled"

2616

.format(client_name))

3205

" keeping {} enabled".format(

3206

client_name))

2617

3207

try:

2618

client["secret"] = (

2619

pgp.decrypt(client["encrypted_secret"],

2620

client_settings[client_name]

2621

["secret"]))

3208

client["secret"] = pgp.decrypt(

3209

client["encrypted_secret"],

3210

client_settings[client_name]["secret"])

2622

3211

except PGPError:

2623

3212

# If decryption fails, we use secret from new settings

2624

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

2625

.format(client_name))

2626

client["secret"] = (

2627

client_settings[client_name]["secret"])

2628

3213

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

3214

client_name))

3215

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

3216

["secret"])

3217

2629

3218

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

2630

3219

for client_name in (set(old_client_settings)

2631

3220

- set(client_settings)):

2633

3222

for client_name in (set(client_settings)

2634

3223

- set(old_client_settings)):

2635

3224

clients_data[client_name] = client_settings[client_name]

2636

3225

2637

3226

# Create all client objects

2638

for client_name, client in clients_data.iteritems():

3227

for client_name, client in clients_data.items():

2639

3228

tcp_server.clients[client_name] = client_class(

2640

name = client_name, settings = client,

2641

server_settings = server_settings)

2642

3229

name=client_name,

3230

settings=client,

3231

server_settings=server_settings)

3232

2643

3233

if not tcp_server.clients:

2644

3234

logger.warning("No clients defined")

2645

3235

2646

3236

if not foreground:

2647

3237

if pidfile is not None:

3238

pid = os.getpid()

2648

3239

try:

2649

3240

with pidfile:

2650

pid = os.getpid()

2651

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

3241

print(pid, file=pidfile)

2652

3242

except IOError:

2653

3243

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

2654

3244

pidfilename, pid)

2655

3245

del pidfile

2656

3246

del pidfilename

2657

2658

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

2659

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

2660

3247

3248

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

3249

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3250

lambda: main_loop.quit() and False)

3251

2661

3252

if use_dbus:

2662

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

2663

"se.bsnet.fukt.Mandos"})

2664

class MandosDBusService(DBusObjectWithProperties):

3253

3254

@alternate_dbus_interfaces(

3255

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

3256

class MandosDBusService(DBusObjectWithObjectManager):

2665

3257

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

3258

2666

3259

def __init__(self):

2667

3260

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

3261

2668

3262

_interface = "se.recompile.Mandos"

2669

2670

@dbus_interface_annotations(_interface)

2671

def _foo(self):

2672

return { "org.freedesktop.DBus.Property"

2673

".EmitsChangedSignal":

2674

"false"}

2675

3263

2676

3264

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

2677

3265

def ClientAdded(self, objpath):

2678

3266

"D-Bus signal"

2679

3267

pass

2680

3268

2681

3269

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

2682

3270

def ClientNotFound(self, fingerprint, address):

2683

3271

"D-Bus signal"

2684

3272

pass

2685

3273

3274

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

3275

"true"})

2686

3276

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

2687

3277

def ClientRemoved(self, objpath, name):

2688

3278

"D-Bus signal"

2689

3279

pass

2690

3280

3281

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

3282

"true"})

2691

3283

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

2692

3284

def GetAllClients(self):

2693

3285

"D-Bus method"

2694

return dbus.Array(c.dbus_object_path

2695

for c in

2696

tcp_server.clients.itervalues())

2697

3286

return dbus.Array(c.dbus_object_path for c in

3287

tcp_server.clients.values())

3288

3289

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

3290

"true"})

2698

3291

@dbus.service.method(_interface,

2699

3292

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

2700

3293

def GetAllClientsWithProperties(self):

2701

3294

"D-Bus method"

2702

3295

return dbus.Dictionary(

2703

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

2704

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

3296

{c.dbus_object_path: c.GetAll(

3297

"se.recompile.Mandos.Client")

3298

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

2705

3299

signature="oa{sv}")

2706

3300

2707

3301

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

2708

3302

def RemoveClient(self, object_path):

2709

3303

"D-Bus method"

2710

for c in tcp_server.clients.itervalues():

3304

for c in tcp_server.clients.values():

2711

3305

if c.dbus_object_path == object_path:

2712

3306

del tcp_server.clients[c.name]

2713

3307

c.remove_from_connection()

2714

# Don't signal anything except ClientRemoved

3308

# Don't signal the disabling

2715

3309

c.disable(quiet=True)

2716

# Emit D-Bus signal

2717

self.ClientRemoved(object_path, c.name)

3310

# Emit D-Bus signal for removal

3311

self.client_removed_signal(c)

2718

3312

return

2719

3313

raise KeyError(object_path)

2720

3314

2721

3315

del _interface

2722

3316

3317

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3318

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

3319

def GetManagedObjects(self):

3320

"""D-Bus method"""

3321

return dbus.Dictionary(

3322

{client.dbus_object_path:

3323

dbus.Dictionary(

3324

{interface: client.GetAll(interface)

3325

for interface in

3326

client._get_all_interface_names()})

3327

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

3328

3329

def client_added_signal(self, client):

3330

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

3331

if use_dbus:

3332

# New standard signal

3333

self.InterfacesAdded(

3334

client.dbus_object_path,

3335

dbus.Dictionary(

3336

{interface: client.GetAll(interface)

3337

for interface in

3338

client._get_all_interface_names()}))

3339

# Old signal

3340

self.ClientAdded(client.dbus_object_path)

3341

3342

def client_removed_signal(self, client):

3343

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

3344

if use_dbus:

3345

# New standard signal

3346

self.InterfacesRemoved(

3347

client.dbus_object_path,

3348

client._get_all_interface_names())

3349

# Old signal

3350

self.ClientRemoved(client.dbus_object_path,

3351

client.name)

3352

2723

3353

mandos_dbus_service = MandosDBusService()

2724

3354

3355

# Save modules to variables to exempt the modules from being

3356

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

3357

mp = multiprocessing

3358

wn = wnull

3359

2725

3360

def cleanup():

2726

3361

"Cleanup function; run on exit"

2727

service.cleanup()

2728

2729

multiprocessing.active_children()

2730

wnull.close()

3362

if zeroconf:

3363

service.cleanup()

3364

3365

mp.active_children()

3366

wn.close()

2731

3367

if not (tcp_server.clients or client_settings):

2732

3368

return

2733

3369

2734

3370

# Store client before exiting. Secrets are encrypted with key

2735

3371

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

2736

3372

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

2737

3373

clients = {}

2738

3374

with PGPEngine() as pgp:

2739

for client in tcp_server.clients.itervalues():

3375

for client in tcp_server.clients.values():

2740

3376

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

2741

3377

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

2742

3378

key)

2743

3379

client_dict = {}

2744

3380

2745

3381

# A list of attributes that can not be pickled

2746

3382

# + secret.

2747

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

2748

"checker", "server_settings"))

2749

for name, typ in (inspect.getmembers

2750

(dbus.service.Object)):

3383

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

3384

"checker", "server_settings"}

3385

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

3386

.Object):

2751

3387

exclude.add(name)

2752

3388

2753

3389

client_dict["encrypted_secret"] = (client

2754

3390

.encrypted_secret)

2755

3391

for attr in client.client_structure:

2756

3392

if attr not in exclude:

2757

3393

client_dict[attr] = getattr(client, attr)

2758

3394

2759

3395

clients[client.name] = client_dict

2760

3396

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

2761

3397

2762

3398

try:

2763

with (tempfile.NamedTemporaryFile

2764

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

2765

dir=os.path.dirname(stored_state_path),

2766

delete=False)) as stored_state:

2767

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

2768

tempname=stored_state.name

3399

with tempfile.NamedTemporaryFile(

3400

mode='wb',

3401

suffix=".pickle",

3402

prefix='clients-',

3403

dir=os.path.dirname(stored_state_path),

3404

delete=False) as stored_state:

3405

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

3406

protocol=2)

3407

tempname = stored_state.name

2769

3408

os.rename(tempname, stored_state_path)

2770

3409

except (IOError, OSError) as e:

2771

3410

if not debug:

2774

3413

except NameError:

2775

3414

pass

2776

3415

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

2777

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

3416

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

2778

3417

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

2779

3418

else:

2780

3419

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

2781

3420

exc_info=e)

2782

raise e

2783

3421

raise

3422

2784

3423

# Delete all clients, and settings from config

2785

3424

while tcp_server.clients:

2786

3425

name, client = tcp_server.clients.popitem()

2787

3426

if use_dbus:

2788

3427

client.remove_from_connection()

2789

# Don't signal anything except ClientRemoved

3428

# Don't signal the disabling

2790

3429

client.disable(quiet=True)

3430

# Emit D-Bus signal for removal

2791

3431

if use_dbus:

2792

# Emit D-Bus signal

2793

mandos_dbus_service.ClientRemoved(client

2794

.dbus_object_path,

2795

client.name)

3432

mandos_dbus_service.client_removed_signal(client)

2796

3433

client_settings.clear()

2797

3434

2798

3435

atexit.register(cleanup)

2799

2800

for client in tcp_server.clients.itervalues():

3436

3437

for client in tcp_server.clients.values():

2801

3438

if use_dbus:

2802

# Emit D-Bus signal

2803

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3439

# Emit D-Bus signal for adding

3440

mandos_dbus_service.client_added_signal(client)

2804

3441

# Need to initiate checking of clients

2805

3442

if client.enabled:

2806

3443

client.init_checker()

2807

3444

2808

3445

tcp_server.enable()

2809

3446

tcp_server.server_activate()

2810

3447

2811

3448

# Find out what port we got

2812

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

3449

if zeroconf:

3450

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

2813

3451

if use_ipv6:

2814

3452

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

2815

3453

" flowinfo %d, scope_id %d",

2817

3455

else: # IPv4

2818

3456

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

2819

3457

*tcp_server.socket.getsockname())

2820

2821

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

2822

3458

3459

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

3460

2823

3461

try:

2824

# From the Avahi example code

2825

try:

2826

service.activate()

2827

except dbus.exceptions.DBusException as error:

2828

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

2829

cleanup()

2830

sys.exit(1)

2831

# End of Avahi example code

2832

2833

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

2834

lambda *args, **kwargs:

2835

(tcp_server.handle_request

2836

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

2837

3462

if zeroconf:

3463

# From the Avahi example code

3464

try:

3465

service.activate()

3466

except dbus.exceptions.DBusException as error:

3467

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

3468

cleanup()

3469

sys.exit(1)

3470

# End of Avahi example code

3471

3472

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

3473

lambda *args, **kwargs:

3474

(tcp_server.handle_request

3475

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

3476

2838

3477

logger.debug("Starting main loop")

2839

3478

main_loop.run()

2840

3479

except AvahiError as error:

2849

3488

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

2850

3489

cleanup()

2851

3490

3491

2852

3492

if __name__ == '__main__':

2853

3493

main()