/mandos/release : revision 237.7.471

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

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(self, *args,

500

**kwargs)

501

syslogger.setFormatter(logging.Formatter(

502

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

503

.format(self.name)))

392

504

return ret

393

505

394

506

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

507

# Pretend that we have a GnuTLS module

508

class GnuTLS(object):

509

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

510

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

511

512

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

513

if library is None:

514

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

515

_library = ctypes.cdll.LoadLibrary(library)

516

del library

517

_need_version = b"3.3.0"

518

519

def __init__(self):

520

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

521

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

522

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

523

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

524

.format(self._need_version))

525

526

# Unless otherwise indicated, the constants and types below are

527

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

528

529

# Constants

530

E_SUCCESS = 0

531

E_INTERRUPTED = -52

532

E_AGAIN = -28

533

CRT_OPENPGP = 2

534

CLIENT = 2

535

SHUT_RDWR = 0

536

CRD_CERTIFICATE = 1

537

E_NO_CERTIFICATE_FOUND = -49

538

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

539

540

# Types

541

class session_int(ctypes.Structure):

542

_fields_ = []

543

session_t = ctypes.POINTER(session_int)

544

545

class certificate_credentials_st(ctypes.Structure):

546

_fields_ = []

547

certificate_credentials_t = ctypes.POINTER(

548

certificate_credentials_st)

549

certificate_type_t = ctypes.c_int

550

551

class datum_t(ctypes.Structure):

552

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

553

('size', ctypes.c_uint)]

554

555

class openpgp_crt_int(ctypes.Structure):

556

_fields_ = []

557

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

558

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

559

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

560

credentials_type_t = ctypes.c_int

561

transport_ptr_t = ctypes.c_void_p

562

close_request_t = ctypes.c_int

563

564

# Exceptions

565

class Error(Exception):

566

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

567

# exception might be raised from within GnuTLS.__init__,

568

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

569

# global variable has happened.

570

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

571

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

572

# code is passed, convert it to a string with

573

# gnutls.strerror()

574

self.code = code

575

if message is None and code is not None:

576

message = GnuTLS.strerror(code)

577

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

578

message, *args)

579

580

class CertificateSecurityError(Error):

581

pass

582

583

# Classes

584

class Credentials(object):

585

def __init__(self):

586

self._c_object = gnutls.certificate_credentials_t()

587

gnutls.certificate_allocate_credentials(

588

ctypes.byref(self._c_object))

589

self.type = gnutls.CRD_CERTIFICATE

590

591

def __del__(self):

592

gnutls.certificate_free_credentials(self._c_object)

593

594

class ClientSession(object):

595

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

596

self._c_object = gnutls.session_t()

597

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

598

gnutls.set_default_priority(self._c_object)

599

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

600

gnutls.handshake_set_private_extensions(self._c_object,

601

True)

602

self.socket = socket

603

if credentials is None:

604

credentials = gnutls.Credentials()

605

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

606

ctypes.cast(credentials._c_object,

607

ctypes.c_void_p))

608

self.credentials = credentials

609

610

def __del__(self):

611

gnutls.deinit(self._c_object)

612

613

def handshake(self):

614

return gnutls.handshake(self._c_object)

615

616

def send(self, data):

617

data = bytes(data)

618

data_len = len(data)

619

while data_len > 0:

620

data_len -= gnutls.record_send(self._c_object,

621

data[-data_len:],

622

data_len)

623

624

def bye(self):

625

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

626

627

# Error handling functions

628

def _error_code(result):

629

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

630

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

631

if result >= 0:

632

return result

633

if result == gnutls.E_NO_CERTIFICATE_FOUND:

634

raise gnutls.CertificateSecurityError(code=result)

635

raise gnutls.Error(code=result)

636

637

def _retry_on_error(result, func, arguments):

638

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

639

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

640

while result < 0:

641

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

642

return _error_code(result)

643

result = func(*arguments)

644

return result

645

646

# Unless otherwise indicated, the function declarations below are

647

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

648

649

# Functions

650

priority_set_direct = _library.gnutls_priority_set_direct

651

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

652

ctypes.POINTER(ctypes.c_char_p)]

653

priority_set_direct.restype = _error_code

654

655

init = _library.gnutls_init

656

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

657

init.restype = _error_code

658

659

set_default_priority = _library.gnutls_set_default_priority

660

set_default_priority.argtypes = [session_t]

661

set_default_priority.restype = _error_code

662

663

record_send = _library.gnutls_record_send

664

record_send.argtypes = [session_t, ctypes.c_void_p,

665

ctypes.c_size_t]

666

record_send.restype = ctypes.c_ssize_t

667

record_send.errcheck = _retry_on_error

668

669

certificate_allocate_credentials = (

670

_library.gnutls_certificate_allocate_credentials)

671

certificate_allocate_credentials.argtypes = [

672

ctypes.POINTER(certificate_credentials_t)]

673

certificate_allocate_credentials.restype = _error_code

674

675

certificate_free_credentials = (

676

_library.gnutls_certificate_free_credentials)

677

certificate_free_credentials.argtypes = [

678

certificate_credentials_t]

679

certificate_free_credentials.restype = None

680

681

handshake_set_private_extensions = (

682

_library.gnutls_handshake_set_private_extensions)

683

handshake_set_private_extensions.argtypes = [session_t,

684

ctypes.c_int]

685

handshake_set_private_extensions.restype = None

686

687

credentials_set = _library.gnutls_credentials_set

688

credentials_set.argtypes = [session_t, credentials_type_t,

689

ctypes.c_void_p]

690

credentials_set.restype = _error_code

691

692

strerror = _library.gnutls_strerror

693

strerror.argtypes = [ctypes.c_int]

694

strerror.restype = ctypes.c_char_p

695

696

certificate_type_get = _library.gnutls_certificate_type_get

697

certificate_type_get.argtypes = [session_t]

698

certificate_type_get.restype = _error_code

699

700

certificate_get_peers = _library.gnutls_certificate_get_peers

701

certificate_get_peers.argtypes = [session_t,

702

ctypes.POINTER(ctypes.c_uint)]

703

certificate_get_peers.restype = ctypes.POINTER(datum_t)

704

705

global_set_log_level = _library.gnutls_global_set_log_level

706

global_set_log_level.argtypes = [ctypes.c_int]

707

global_set_log_level.restype = None

708

709

global_set_log_function = _library.gnutls_global_set_log_function

710

global_set_log_function.argtypes = [log_func]

711

global_set_log_function.restype = None

712

713

deinit = _library.gnutls_deinit

714

deinit.argtypes = [session_t]

715

deinit.restype = None

716

717

handshake = _library.gnutls_handshake

718

handshake.argtypes = [session_t]

719

handshake.restype = _error_code

720

handshake.errcheck = _retry_on_error

721

722

transport_set_ptr = _library.gnutls_transport_set_ptr

723

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

724

transport_set_ptr.restype = None

725

726

bye = _library.gnutls_bye

727

bye.argtypes = [session_t, close_request_t]

728

bye.restype = _error_code

729

bye.errcheck = _retry_on_error

730

731

check_version = _library.gnutls_check_version

732

check_version.argtypes = [ctypes.c_char_p]

733

check_version.restype = ctypes.c_char_p

734

735

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

736

737

openpgp_crt_init = _library.gnutls_openpgp_crt_init

738

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

739

openpgp_crt_init.restype = _error_code

740

741

openpgp_crt_import = _library.gnutls_openpgp_crt_import

742

openpgp_crt_import.argtypes = [openpgp_crt_t,

743

ctypes.POINTER(datum_t),

744

openpgp_crt_fmt_t]

745

openpgp_crt_import.restype = _error_code

746

747

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

748

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

749

ctypes.POINTER(ctypes.c_uint)]

750

openpgp_crt_verify_self.restype = _error_code

751

752

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

753

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

754

openpgp_crt_deinit.restype = None

755

756

openpgp_crt_get_fingerprint = (

757

_library.gnutls_openpgp_crt_get_fingerprint)

758

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

759

ctypes.c_void_p,

760

ctypes.POINTER(

761

ctypes.c_size_t)]

762

openpgp_crt_get_fingerprint.restype = _error_code

763

764

# Remove non-public functions

765

del _error_code, _retry_on_error

766

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

767

gnutls = GnuTLS()

768

769

770

def call_pipe(connection, # : multiprocessing.Connection

771

func, *args, **kwargs):

772

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

773

774

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

775

return value on the provided multiprocessing.Connection.

776

"""

777

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

778

connection.close()

400

779

401

780

402

781

class Client(object):

403

782

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

404

783

405

784

Attributes:

406

785

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

407

786

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

409

788

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

410

789

to see if the client lives.

411

790

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

791

checker_callback_tag: a GLib event source tag, or None

413

792

checker_command: string; External command which is run to check

414

793

if client lives. %() expansions are done at

415

794

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

416

795

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

417

checker_initiator_tag: a gobject event source tag, or None

796

checker_initiator_tag: a GLib event source tag, or None

418

797

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

419

798

client_structure: Object describing what attributes a client has

420

799

and is used for storing the client at exit

421

800

current_checker_command: string; current running checker_command

422

disable_initiator_tag: a gobject event source tag, or None

801

disable_initiator_tag: a GLib event source tag, or None

423

802

enabled: bool()

424

803

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

425

804

uniquely identify the client

430

809

last_checker_status: integer between 0 and 255 reflecting exit

431

810

status of last checker. -1 reflects crashed

432

811

checker, -2 means no checker completed yet.

812

last_checker_signal: The signal which killed the last checker, if

813

last_checker_status is -1

433

814

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

434

815

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

435

816

D-Bus identifiers

442

823

disabled, or None

443

824

server_settings: The server_settings dict from main()

444

825

"""

445

826

446

827

runtime_expansions = ("approval_delay", "approval_duration",

447

828

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

448

829

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

449

830

"last_approval_request", "last_checked_ok",

450

831

"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

832

client_defaults = {

833

"timeout": "PT5M",

834

"extended_timeout": "PT15M",

835

"interval": "PT2M",

836

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

837

"host": "",

838

"approval_delay": "PT0S",

839

"approval_duration": "PT1S",

840

"approved_by_default": "True",

841

"enabled": "True",

842

}

843

477

844

@staticmethod

478

845

def config_parser(config):

479

846

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

486

853

for client_name in config.sections():

487

854

section = dict(config.items(client_name))

488

855

client = settings[client_name] = {}

489

856

490

857

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

491

858

# Reformat values from string types to Python types

492

859

client["approved_by_default"] = config.getboolean(

493

860

client_name, "approved_by_default")

494

861

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

495

862

"enabled")

496

863

864

# Uppercase and remove spaces from fingerprint for later

865

# comparison purposes with return value from the

866

# fingerprint() function

497

867

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

498

868

.replace(" ", ""))

499

869

if "secret" in section:

500

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

870

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

871

.encode("utf-8"),

872

"base64")

501

873

elif "secfile" in section:

502

874

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

503

875

(section["secfile"])),

504

876

"rb") as secfile:

505

877

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

506

878

else:

507

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

879

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

508

880

.format(section))

509

881

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

510

882

client["extended_timeout"] = string_to_delta(

518

890

client["last_approval_request"] = None

519

891

client["last_checked_ok"] = None

520

892

client["last_checker_status"] = -2

521

893

522

894

return settings

523

524

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

895

896

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

525

897

self.name = name

526

898

if server_settings is None:

527

899

server_settings = {}

528

900

self.server_settings = server_settings

529

901

# adding all client settings

530

for setting, value in settings.iteritems():

902

for setting, value in settings.items():

531

903

setattr(self, setting, value)

532

904

533

905

if self.enabled:

534

906

if not hasattr(self, "last_enabled"):

535

907

self.last_enabled = datetime.datetime.utcnow()

539

911

else:

540

912

self.last_enabled = None

541

913

self.expires = None

542

914

543

915

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

916

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

548

917

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

549

918

datetime.datetime.utcnow())

550

919

551

920

# attributes specific for this server instance

552

921

self.checker = None

553

922

self.checker_initiator_tag = None

556

925

self.current_checker_command = None

557

926

self.approved = None

558

927

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

928

self.changedstate = multiprocessing_manager.Condition(

929

multiprocessing_manager.Lock())

930

self.client_structure = [attr

931

for attr in self.__dict__.keys()

564

932

if not attr.startswith("_")]

565

933

self.client_structure.append("client_structure")

566

567

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

568

lambda obj:

569

isinstance(obj,

570

property)):

934

935

for name, t in inspect.getmembers(

936

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

571

937

if not name.startswith("_"):

572

938

self.client_structure.append(name)

573

939

574

940

# Send notice to process children that client state has changed

575

941

def send_changedstate(self):

576

942

with self.changedstate:

577

943

self.changedstate.notify_all()

578

944

579

945

def enable(self):

580

946

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

581

947

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

586

952

self.last_enabled = datetime.datetime.utcnow()

587

953

self.init_checker()

588

954

self.send_changedstate()

589

955

590

956

def disable(self, quiet=True):

591

957

"""Disable this client."""

592

958

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

594

960

if not quiet:

595

961

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

596

962

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

597

gobject.source_remove(self.disable_initiator_tag)

963

GLib.source_remove(self.disable_initiator_tag)

598

964

self.disable_initiator_tag = None

599

965

self.expires = None

600

966

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

601

gobject.source_remove(self.checker_initiator_tag)

967

GLib.source_remove(self.checker_initiator_tag)

602

968

self.checker_initiator_tag = None

603

969

self.stop_checker()

604

970

self.enabled = False

605

971

if not quiet:

606

972

self.send_changedstate()

607

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

973

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

608

974

return False

609

975

610

976

def __del__(self):

611

977

self.disable()

612

978

613

979

def init_checker(self):

614

980

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

615

981

# and every interval from then on.

616

982

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

983

GLib.source_remove(self.checker_initiator_tag)

984

self.checker_initiator_tag = GLib.timeout_add(

985

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

986

self.start_checker)

621

987

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

622

988

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

989

GLib.source_remove(self.disable_initiator_tag)

990

self.disable_initiator_tag = GLib.timeout_add(

991

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

627

992

# Also start a new checker *right now*.

628

993

self.start_checker()

629

630

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

994

995

def checker_callback(self, source, condition, connection,

996

command):

631

997

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

632

998

self.checker_callback_tag = None

633

999

self.checker = None

634

if os.WIFEXITED(condition):

635

self.last_checker_status = os.WEXITSTATUS(condition)

1000

# Read return code from connection (see call_pipe)

1001

returncode = connection.recv()

1002

connection.close()

1003

1004

if returncode >= 0:

1005

self.last_checker_status = returncode

1006

self.last_checker_signal = None

636

1007

if self.last_checker_status == 0:

637

1008

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

638

1009

vars(self))

639

1010

self.checked_ok()

640

1011

else:

641

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

642

vars(self))

1012

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

643

1013

else:

644

1014

self.last_checker_status = -1

1015

self.last_checker_signal = -returncode

645

1016

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

646

1017

vars(self))

647

1018

return False

1019

648

1020

def checked_ok(self):

649

1021

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

650

1022

self.last_checked_ok = datetime.datetime.utcnow()

651

1023

self.last_checker_status = 0

1024

self.last_checker_signal = None

652

1025

self.bump_timeout()

653

1026

654

1027

def bump_timeout(self, timeout=None):

655

1028

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

656

1029

if timeout is None:

657

1030

timeout = self.timeout

658

1031

if self.disable_initiator_tag is not None:

659

gobject.source_remove(self.disable_initiator_tag)

1032

GLib.source_remove(self.disable_initiator_tag)

660

1033

self.disable_initiator_tag = None

661

1034

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

662

self.disable_initiator_tag = (gobject.timeout_add

663

(timedelta_to_milliseconds

664

(timeout), self.disable))

1035

self.disable_initiator_tag = GLib.timeout_add(

1036

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

665

1037

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

666

1038

667

1039

def need_approval(self):

668

1040

self.last_approval_request = datetime.datetime.utcnow()

669

1041

670

1042

def start_checker(self):

671

1043

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

672

1044

673

1045

If a checker already exists, leave it running and do

674

1046

nothing."""

675

1047

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

680

1052

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

681

1053

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

682

1054

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

1055

1056

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

1057

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

1058

self.checker.join()

1059

self.checker = None

697

1060

# Start a new checker if needed

698

1061

if self.checker is None:

699

1062

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

1063

escaped_attrs = {

1064

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

1065

for attr in self.runtime_expansions}

704

1066

try:

705

1067

command = self.checker_command % escaped_attrs

706

1068

except TypeError as error:

707

1069

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

708

self.checker_command, exc_info=error)

709

return True # Try again later

1070

self.checker_command,

1071

exc_info=error)

1072

return True # Try again later

710

1073

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

1074

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

1075

self.name)

1076

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

1077

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

1078

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

1079

# always replaced by /dev/null.)

1080

# The exception is when not debugging but nevertheless

1081

# running in the foreground; use the previously

1082

# created wnull.

1083

popen_args = {"close_fds": True,

1084

"shell": True,

1085

"cwd": "/"}

1086

if (not self.server_settings["debug"]

1087

and self.server_settings["foreground"]):

1088

popen_args.update({"stdout": wnull,

1089

"stderr": wnull})

1090

pipe = multiprocessing.Pipe(duplex=False)

1091

self.checker = multiprocessing.Process(

1092

target=call_pipe,

1093

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

1094

kwargs=popen_args)

1095

self.checker.start()

1096

self.checker_callback_tag = GLib.io_add_watch(

1097

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

1098

self.checker_callback, pipe[0], command)

1099

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

753

1100

return True

754

1101

755

1102

def stop_checker(self):

756

1103

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

757

1104

if self.checker_callback_tag:

758

gobject.source_remove(self.checker_callback_tag)

1105

GLib.source_remove(self.checker_callback_tag)

759

1106

self.checker_callback_tag = None

760

1107

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

761

1108

return

762

1109

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

1110

self.checker.terminate()

771

1111

self.checker = None

772

1112

773

1113

774

def dbus_service_property(dbus_interface, signature="v",

775

access="readwrite", byte_arrays=False):

1114

def dbus_service_property(dbus_interface,

1115

signature="v",

1116

access="readwrite",

1117

byte_arrays=False):

776

1118

"""Decorators for marking methods of a DBusObjectWithProperties to

777

1119

become properties on the D-Bus.

778

1120

779

1121

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

780

1122

and with one argument by "Set".

781

1123

782

1124

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

783

1125

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

784

1126

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

787

1129

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

788

1130

if byte_arrays and signature != "ay":

789

1131

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

790

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

1132

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

1133

791

1134

def decorator(func):

792

1135

func._dbus_is_property = True

793

1136

func._dbus_interface = dbus_interface

796

1139

func._dbus_name = func.__name__

797

1140

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

798

1141

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

799

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1142

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

800

1143

return func

1144

801

1145

return decorator

802

1146

803

1147

804

1148

def dbus_interface_annotations(dbus_interface):

805

1149

"""Decorator for marking functions returning interface annotations

806

1150

807

1151

Usage:

808

1152

809

1153

@dbus_interface_annotations("org.example.Interface")

810

1154

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

811

1155

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

812

1156

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

813

1157

"false"}

814

1158

"""

1159

815

1160

def decorator(func):

816

1161

func._dbus_is_interface = True

817

1162

func._dbus_interface = dbus_interface

818

1163

func._dbus_name = dbus_interface

819

1164

return func

1165

820

1166

return decorator

821

1167

822

1168

823

1169

def dbus_annotations(annotations):

824

1170

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

825

1171

Usage:

826

1172

1173

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

1174

"org.freedesktop.DBus.Property."

1175

"EmitsChangedSignal": "false"})

827

1176

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

828

1177

access="r")

829

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

830

"org.freedesktop.DBus.Property."

831

"EmitsChangedSignal": "false"})

832

1178

def Property_dbus_property(self):

833

1179

return dbus.Boolean(False)

1180

1181

See also the DBusObjectWithAnnotations class.

834

1182

"""

1183

835

1184

def decorator(func):

836

1185

func._dbus_annotations = annotations

837

1186

return func

1187

838

1188

return decorator

839

1189

840

1190

841

1191

class DBusPropertyException(dbus.exceptions.DBusException):

842

1192

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

843

1193

"""

844

def __unicode__(self):

845

return unicode(str(self))

1194

pass

846

1195

847

1196

848

1197

class DBusPropertyAccessException(DBusPropertyException):

857

1206

pass

858

1207

859

1208

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.

1209

class DBusObjectWithAnnotations(dbus.service.Object):

1210

"""A D-Bus object with annotations.

1211

1212

Classes inheriting from this can use the dbus_annotations

1213

decorator to add annotations to methods or signals.

866

1214

"""

867

1215

868

1216

@staticmethod

869

1217

def _is_dbus_thing(thing):

870

1218

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

871

1219

872

1220

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

873

1221

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

874

1222

"""

875

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

1223

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

876

1224

False)

877

1225

878

1226

def _get_all_dbus_things(self, thing):

879

1227

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

880

1228

"""

881

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

882

name),

1229

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

883

1230

athing.__get__(self))

884

1231

for cls in self.__class__.__mro__

885

1232

for name, athing in

886

inspect.getmembers(cls,

887

self._is_dbus_thing(thing)))

888

1233

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

1234

1235

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1236

out_signature="s",

1237

path_keyword='object_path',

1238

connection_keyword='connection')

1239

def Introspect(self, object_path, connection):

1240

"""Overloading of standard D-Bus method.

1241

1242

Inserts annotation tags on methods and signals.

1243

"""

1244

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

1245

connection)

1246

try:

1247

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

1248

1249

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

1250

# Add annotation tags

1251

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

1252

for tag in if_tag.getElementsByTagName(typ):

1253

annots = dict()

1254

for name, prop in (self.

1255

_get_all_dbus_things(typ)):

1256

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

1257

and prop._dbus_interface

1258

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

1259

annots.update(getattr(

1260

prop, "_dbus_annotations", {}))

1261

for name, value in annots.items():

1262

ann_tag = document.createElement(

1263

"annotation")

1264

ann_tag.setAttribute("name", name)

1265

ann_tag.setAttribute("value", value)

1266

tag.appendChild(ann_tag)

1267

# Add interface annotation tags

1268

for annotation, value in dict(

1269

itertools.chain.from_iterable(

1270

annotations().items()

1271

for name, annotations

1272

in self._get_all_dbus_things("interface")

1273

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

1274

)).items():

1275

ann_tag = document.createElement("annotation")

1276

ann_tag.setAttribute("name", annotation)

1277

ann_tag.setAttribute("value", value)

1278

if_tag.appendChild(ann_tag)

1279

# Fix argument name for the Introspect method itself

1280

if (if_tag.getAttribute("name")

1281

== dbus.INTROSPECTABLE_IFACE):

1282

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

1283

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

1284

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

1285

if (arg.getAttribute("direction")

1286

== "out"):

1287

arg.setAttribute("name",

1288

"xml_data")

1289

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

1290

document.unlink()

1291

except (AttributeError, xml.dom.DOMException,

1292

xml.parsers.expat.ExpatError) as error:

1293

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

1294

exc_info=error)

1295

return xmlstring

1296

1297

1298

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1299

"""A D-Bus object with properties.

1300

1301

Classes inheriting from this can use the dbus_service_property

1302

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

1303

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

1304

"""

1305

889

1306

def _get_dbus_property(self, interface_name, property_name):

890

1307

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

891

1308

property with the specified name and interface.

892

1309

"""

893

for cls in self.__class__.__mro__:

894

for name, value in (inspect.getmembers

895

(cls,

896

self._is_dbus_thing("property"))):

1310

for cls in self.__class__.__mro__:

1311

for name, value in inspect.getmembers(

1312

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

897

1313

if (value._dbus_name == property_name

898

1314

and value._dbus_interface == interface_name):

899

1315

return value.__get__(self)

900

1316

901

1317

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

1318

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

1319

self.dbus_object_path, interface_name, property_name))

1320

1321

@classmethod

1322

def _get_all_interface_names(cls):

1323

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

1324

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

1325

"_dbus_interface", None)

1326

for x in (inspect.getmro(cls))

1327

for attr in dir(x))

1328

if name is not None)

1329

1330

@dbus.service.method(dbus.PROPERTIES_IFACE,

1331

in_signature="ss",

907

1332

out_signature="v")

908

1333

def Get(self, interface_name, property_name):

909

1334

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

915

1340

if not hasattr(value, "variant_level"):

916

1341

return value

917

1342

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

918

1343

919

1344

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

920

1345

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

921

1346

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

927

1352

# The byte_arrays option is not supported yet on

928

1353

# signatures other than "ay".

929

1354

if prop._dbus_signature != "ay":

930

raise ValueError

1355

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

1356

"'ay' signature {!r}"

1357

.format(prop._dbus_signature))

931

1358

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

932

1359

for byte in value))

933

1360

prop(value)

934

935

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

1361

1362

@dbus.service.method(dbus.PROPERTIES_IFACE,

1363

in_signature="s",

936

1364

out_signature="a{sv}")

937

1365

def GetAll(self, interface_name):

938

1366

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

939

1367

standard.

940

1368

941

1369

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

942

1370

"""

943

1371

properties = {}

953

1381

if not hasattr(value, "variant_level"):

954

1382

properties[name] = value

955

1383

continue

956

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

957

value.variant_level+1)

1384

properties[name] = type(value)(

1385

value, variant_level=value.variant_level + 1)

958

1386

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

959

1387

1388

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

1389

def PropertiesChanged(self, interface_name, changed_properties,

1390

invalidated_properties):

1391

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

1392

standard.

1393

"""

1394

pass

1395

960

1396

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

961

1397

out_signature="s",

962

1398

path_keyword='object_path',

963

1399

connection_keyword='connection')

964

1400

def Introspect(self, object_path, connection):

965

1401

"""Overloading of standard D-Bus method.

966

1402

967

1403

Inserts property tags and interface annotation tags.

968

1404

"""

969

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

970

connection)

1405

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1406

object_path,

1407

connection)

971

1408

try:

972

1409

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

1410

973

1411

def make_tag(document, name, prop):

974

1412

e = document.createElement("property")

975

1413

e.setAttribute("name", name)

976

1414

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

977

1415

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

978

1416

return e

1417

979

1418

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

980

1419

# Add property tags

981

1420

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

984

1423

if prop._dbus_interface

985

1424

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

986

1425

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)

1426

# Add annotation tags for properties

1427

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

1428

annots = dict()

1429

for name, prop in self._get_all_dbus_things(

1430

"property"):

1431

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

1432

and prop._dbus_interface

1433

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

1434

annots.update(getattr(

1435

prop, "_dbus_annotations", {}))

1436

for name, value in annots.items():

1437

ann_tag = document.createElement(

1438

"annotation")

1439

ann_tag.setAttribute("name", name)

1440

ann_tag.setAttribute("value", value)

1441

tag.appendChild(ann_tag)

1018

1442

# Add the names to the return values for the

1019

1443

# "org.freedesktop.DBus.Properties" methods

1020

1444

if (if_tag.getAttribute("name")

1039

1463

return xmlstring

1040

1464

1041

1465

1466

try:

1467

dbus.OBJECT_MANAGER_IFACE

1468

except AttributeError:

1469

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

1470

1471

1472

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1473

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

1474

1475

Classes inheriting from this exposes the standard

1476

GetManagedObjects call and the InterfacesAdded and

1477

InterfacesRemoved signals on the standard

1478

"org.freedesktop.DBus.ObjectManager" interface.

1479

1480

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

1481

manually.

1482

"""

1483

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1484

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

1485

def GetManagedObjects(self):

1486

"""This function must be overridden"""

1487

raise NotImplementedError()

1488

1489

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1490

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

1491

def InterfacesAdded(self, object_path, interfaces_and_properties):

1492

pass

1493

1494

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

1495

def InterfacesRemoved(self, object_path, interfaces):

1496

pass

1497

1498

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1499

out_signature="s",

1500

path_keyword='object_path',

1501

connection_keyword='connection')

1502

def Introspect(self, object_path, connection):

1503

"""Overloading of standard D-Bus method.

1504

1505

Override return argument name of GetManagedObjects to be

1506

"objpath_interfaces_and_properties"

1507

"""

1508

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1509

object_path,

1510

connection)

1511

try:

1512

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

1513

1514

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

1515

# Fix argument name for the GetManagedObjects method

1516

if (if_tag.getAttribute("name")

1517

== dbus.OBJECT_MANAGER_IFACE):

1518

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

1519

if (cn.getAttribute("name")

1520

== "GetManagedObjects"):

1521

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

1522

if (arg.getAttribute("direction")

1523

== "out"):

1524

arg.setAttribute(

1525

"name",

1526

"objpath_interfaces"

1527

"_and_properties")

1528

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

1529

document.unlink()

1530

except (AttributeError, xml.dom.DOMException,

1531

xml.parsers.expat.ExpatError) as error:

1532

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

1533

exc_info=error)

1534

return xmlstring

1535

1536

1042

1537

def datetime_to_dbus(dt, variant_level=0):

1043

1538

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

1044

1539

if dt is None:

1045

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

1046

return dbus.String(dt.isoformat(),

1047

variant_level=variant_level)

1540

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

1541

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

1048

1542

1049

1543

1050

1544

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1052

1546

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

1053

1547

interface names according to the "alt_interface_names" mapping.

1054

1548

Usage:

1055

1549

1056

1550

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

1057

1551

"net.example.AlternateInterface"})

1058

1552

class SampleDBusObject(dbus.service.Object):

1059

1553

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

1060

1554

def SampleDBusMethod():

1061

1555

pass

1062

1556

1063

1557

The above "SampleDBusMethod" on "SampleDBusObject" will be

1064

1558

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

1065

1559

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

1066

1560

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

1067

1561

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

1068

1562

1069

1563

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

1070

1564

(from DBusObjectWithProperties) and interfaces (from the

1071

1565

dbus_interface_annotations decorator).

1072

1566

"""

1567

1073

1568

def wrapper(cls):

1074

1569

for orig_interface_name, alt_interface_name in (

1075

alt_interface_names.iteritems()):

1570

alt_interface_names.items()):

1076

1571

attr = {}

1077

1572

interface_names = set()

1078

1573

# Go though all attributes of the class

1080

1575

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

1081

1576

# with the wrong interface name

1082

1577

if (not hasattr(attribute, "_dbus_interface")

1083

or not attribute._dbus_interface

1084

.startswith(orig_interface_name)):

1578

or not attribute._dbus_interface.startswith(

1579

orig_interface_name)):

1085

1580

continue

1086

1581

# Create an alternate D-Bus interface name based on

1087

1582

# the current name

1088

alt_interface = (attribute._dbus_interface

1089

.replace(orig_interface_name,

1090

alt_interface_name))

1583

alt_interface = attribute._dbus_interface.replace(

1584

orig_interface_name, alt_interface_name)

1091

1585

interface_names.add(alt_interface)

1092

1586

# Is this a D-Bus signal?

1093

1587

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

1094

1588

# Extract the original non-method undecorated

1095

1589

# function by black magic

1096

nonmethod_func = (dict(

1590

if sys.version_info.major == 2:

1591

nonmethod_func = (dict(

1097

1592

zip(attribute.func_code.co_freevars,

1098

attribute.__closure__))["func"]

1099

.cell_contents)

1593

attribute.__closure__))

1594

["func"].cell_contents)

1595

else:

1596

nonmethod_func = (dict(

1597

zip(attribute.__code__.co_freevars,

1598

attribute.__closure__))

1599

["func"].cell_contents)

1100

1600

# Create a new, but exactly alike, function

1101

1601

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

1102

1602

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

1603

new_function = copy_function(nonmethod_func)

1604

new_function = (dbus.service.signal(

1605

alt_interface,

1606

attribute._dbus_signature)(new_function))

1112

1607

# Copy annotations, if any

1113

1608

try:

1114

new_function._dbus_annotations = (

1115

dict(attribute._dbus_annotations))

1609

new_function._dbus_annotations = dict(

1610

attribute._dbus_annotations)

1116

1611

except AttributeError:

1117

1612

pass

1613

1118

1614

# Define a creator of a function to call both the

1119

1615

# original and alternate functions, so both the

1120

1616

# original and alternate signals gets sent when

1123

1619

"""This function is a scope container to pass

1124

1620

func1 and func2 to the "call_both" function

1125

1621

outside of its arguments"""

1622

1623

@functools.wraps(func2)

1126

1624

def call_both(*args, **kwargs):

1127

1625

"""This function will emit two D-Bus

1128

1626

signals by calling func1 and func2"""

1129

1627

func1(*args, **kwargs)

1130

1628

func2(*args, **kwargs)

1629

# Make wrapper function look like a D-Bus

1630

# signal

1631

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

1632

if name.startswith("_dbus_"):

1633

setattr(call_both, name, attr)

1634

1131

1635

return call_both

1132

1636

# Create the "call_both" function and add it to

1133

1637

# the class

1138

1642

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

1139

1643

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

1140

1644

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

1645

attr[attrname] = (

1646

dbus.service.method(

1647

alt_interface,

1648

attribute._dbus_in_signature,

1649

attribute._dbus_out_signature)

1650

(copy_function(attribute)))

1151

1651

# Copy annotations, if any

1152

1652

try:

1153

attr[attrname]._dbus_annotations = (

1154

dict(attribute._dbus_annotations))

1653

attr[attrname]._dbus_annotations = dict(

1654

attribute._dbus_annotations)

1155

1655

except AttributeError:

1156

1656

pass

1157

1657

# Is this a D-Bus property?

1160

1660

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

1161

1661

# property with the alternate D-Bus interface

1162

1662

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

1663

attr[attrname] = (dbus_service_property(

1664

alt_interface, attribute._dbus_signature,

1665

attribute._dbus_access,

1666

attribute._dbus_get_args_options

1667

["byte_arrays"])

1668

(copy_function(attribute)))

1176

1669

# Copy annotations, if any

1177

1670

try:

1178

attr[attrname]._dbus_annotations = (

1179

dict(attribute._dbus_annotations))

1671

attr[attrname]._dbus_annotations = dict(

1672

attribute._dbus_annotations)

1180

1673

except AttributeError:

1181

1674

pass

1182

1675

# Is this a D-Bus interface?

1185

1678

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

1186

1679

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

1187

1680

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

1681

attr[attrname] = (

1682

dbus_interface_annotations(alt_interface)

1683

(copy_function(attribute)))

1196

1684

if deprecate:

1197

1685

# Deprecate all alternate interfaces

1198

iname="_AlternateDBusNames_interface_annotation{0}"

1686

iname = "_AlternateDBusNames_interface_annotation{}"

1199

1687

for interface_name in interface_names:

1688

1200

1689

@dbus_interface_annotations(interface_name)

1201

1690

def func(self):

1202

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

1203

"true" }

1691

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

1692

"true"}

1204

1693

# Find an unused name

1205

1694

for aname in (iname.format(i)

1206

1695

for i in itertools.count()):

1210

1699

if interface_names:

1211

1700

# Replace the class with a new subclass of it with

1212

1701

# methods, signals, etc. as created above.

1213

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

1214

(cls,), attr)

1702

if sys.version_info.major == 2:

1703

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

1704

(cls, ), attr)

1705

else:

1706

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

1707

(cls, ), attr)

1215

1708

return cls

1709

1216

1710

return wrapper

1217

1711

1218

1712

1219

1713

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

1220

"se.bsnet.fukt.Mandos"})

1714

"se.bsnet.fukt.Mandos"})

1221

1715

class ClientDBus(Client, DBusObjectWithProperties):

1222

1716

"""A Client class using D-Bus

1223

1717

1224

1718

Attributes:

1225

1719

dbus_object_path: dbus.ObjectPath

1226

1720

bus: dbus.SystemBus()

1227

1721

"""

1228

1722

1229

1723

runtime_expansions = (Client.runtime_expansions

1230

+ ("dbus_object_path",))

1231

1724

+ ("dbus_object_path", ))

1725

1726

_interface = "se.recompile.Mandos.Client"

1727

1232

1728

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

1233

1234

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

1729

1730

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

1235

1731

self.bus = bus

1236

1732

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

1237

1733

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

1238

1734

# the D-Bus

1239

client_object_name = unicode(self.name).translate(

1735

client_object_name = str(self.name).translate(

1240

1736

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

1241

1737

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

1242

self.dbus_object_path = (dbus.ObjectPath

1243

("/clients/" + client_object_name))

1738

self.dbus_object_path = dbus.ObjectPath(

1739

"/clients/" + client_object_name)

1244

1740

DBusObjectWithProperties.__init__(self, self.bus,

1245

1741

self.dbus_object_path)

1246

1247

def notifychangeproperty(transform_func,

1248

dbus_name, type_func=lambda x: x,

1249

variant_level=1):

1742

1743

def notifychangeproperty(transform_func, dbus_name,

1744

type_func=lambda x: x,

1745

variant_level=1,

1746

invalidate_only=False,

1747

_interface=_interface):

1250

1748

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

1251

1749

its changes to DBus.

1252

1750

1253

1751

transform_fun: Function that takes a value and a variant_level

1254

1752

and transforms it to a D-Bus type.

1255

1753

dbus_name: D-Bus name of the variable

1257

1755

to the D-Bus. Default: no transform

1258

1756

variant_level: D-Bus variant level. Default: 1

1259

1757

"""

1260

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

1758

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

1759

1261

1760

def setter(self, value):

1262

1761

if hasattr(self, "dbus_object_path"):

1263

1762

if (not hasattr(self, attrname) or

1264

1763

type_func(getattr(self, attrname, None))

1265

1764

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

1765

if invalidate_only:

1766

self.PropertiesChanged(

1767

_interface, dbus.Dictionary(),

1768

dbus.Array((dbus_name, )))

1769

else:

1770

dbus_value = transform_func(

1771

type_func(value),

1772

variant_level=variant_level)

1773

self.PropertyChanged(dbus.String(dbus_name),

1774

dbus_value)

1775

self.PropertiesChanged(

1776

_interface,

1777

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

1778

dbus_value}),

1779

dbus.Array())

1271

1780

setattr(self, attrname, value)

1272

1781

1273

1782

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

1274

1783

1275

1784

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1276

1785

approvals_pending = notifychangeproperty(dbus.Boolean,

1277

1786

"ApprovalPending",

1278

type_func = bool)

1787

type_func=bool)

1279

1788

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

1280

1789

last_enabled = notifychangeproperty(datetime_to_dbus,

1281

1790

"LastEnabled")

1282

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

1283

type_func = lambda checker:

1284

checker is not None)

1791

checker = notifychangeproperty(

1792

dbus.Boolean, "CheckerRunning",

1793

type_func=lambda checker: checker is not None)

1285

1794

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1286

1795

"LastCheckedOK")

1287

1796

last_checker_status = notifychangeproperty(dbus.Int16,

1290

1799

datetime_to_dbus, "LastApprovalRequest")

1291

1800

approved_by_default = notifychangeproperty(dbus.Boolean,

1292

1801

"ApprovedByDefault")

1293

approval_delay = notifychangeproperty(dbus.UInt64,

1294

"ApprovalDelay",

1295

type_func =

1296

timedelta_to_milliseconds)

1802

approval_delay = notifychangeproperty(

1803

dbus.UInt64, "ApprovalDelay",

1804

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

1297

1805

approval_duration = notifychangeproperty(

1298

1806

dbus.UInt64, "ApprovalDuration",

1299

type_func = timedelta_to_milliseconds)

1807

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

1300

1808

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

1301

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

1302

type_func =

1303

timedelta_to_milliseconds)

1809

timeout = notifychangeproperty(

1810

dbus.UInt64, "Timeout",

1811

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

1304

1812

extended_timeout = notifychangeproperty(

1305

1813

dbus.UInt64, "ExtendedTimeout",

1306

type_func = timedelta_to_milliseconds)

1307

interval = notifychangeproperty(dbus.UInt64,

1308

"Interval",

1309

type_func =

1310

timedelta_to_milliseconds)

1814

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

1815

interval = notifychangeproperty(

1816

dbus.UInt64, "Interval",

1817

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

1311

1818

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

1312

1819

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

1820

invalidate_only=True)

1821

1313

1822

del notifychangeproperty

1314

1823

1315

1824

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

1316

1825

try:

1317

1826

self.remove_from_connection()

1320

1829

if hasattr(DBusObjectWithProperties, "__del__"):

1321

1830

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

1322

1831

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)

1832

1833

def checker_callback(self, source, condition,

1834

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

1835

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

1836

connection, command, *args,

1837

**kwargs)

1838

exitstatus = self.last_checker_status

1839

if exitstatus >= 0:

1330

1840

# Emit D-Bus signal

1331

1841

self.CheckerCompleted(dbus.Int16(exitstatus),

1332

dbus.Int64(condition),

1842

# This is specific to GNU libC

1843

dbus.Int64(exitstatus << 8),

1333

1844

dbus.String(command))

1334

1845

else:

1335

1846

# Emit D-Bus signal

1336

1847

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

1337

dbus.Int64(condition),

1848

dbus.Int64(

1849

# This is specific to GNU libC

1850

(exitstatus << 8)

1851

| self.last_checker_signal),

1338

1852

dbus.String(command))

1339

1340

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

1341

*args, **kwargs)

1342

1853

return ret

1854

1343

1855

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

1856

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

1349

1857

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

1350

1858

# Only if new checker process was started

1351

1859

if (self.checker is not None

1353

1861

# Emit D-Bus signal

1354

1862

self.CheckerStarted(self.current_checker_command)

1355

1863

return r

1356

1864

1357

1865

def _reset_approved(self):

1358

1866

self.approved = None

1359

1867

return False

1360

1868

1361

1869

def approve(self, value=True):

1362

1870

self.approved = value

1363

gobject.timeout_add(timedelta_to_milliseconds

1364

(self.approval_duration),

1365

self._reset_approved)

1871

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

1872

* 1000), self._reset_approved)

1366

1873

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

1874

1875

# D-Bus methods, signals & properties

1876

1877

# Interfaces

1878

1879

# Signals

1880

1380

1881

# CheckerCompleted - signal

1381

1882

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

1382

1883

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

1383

1884

"D-Bus signal"

1384

1885

pass

1385

1886

1386

1887

# CheckerStarted - signal

1387

1888

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

1388

1889

def CheckerStarted(self, command):

1389

1890

"D-Bus signal"

1390

1891

pass

1391

1892

1392

1893

# PropertyChanged - signal

1894

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

1393

1895

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

1394

1896

def PropertyChanged(self, property, value):

1395

1897

"D-Bus signal"

1396

1898

pass

1397

1899

1398

1900

# GotSecret - signal

1399

1901

@dbus.service.signal(_interface)

1400

1902

def GotSecret(self):

1403

1905

server to mandos-client

1404

1906

"""

1405

1907

pass

1406

1908

1407

1909

# Rejected - signal

1408

1910

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

1409

1911

def Rejected(self, reason):

1410

1912

"D-Bus signal"

1411

1913

pass

1412

1914

1413

1915

# NeedApproval - signal

1414

1916

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

1415

1917

def NeedApproval(self, timeout, default):

1416

1918

"D-Bus signal"

1417

1919

return self.need_approval()

1418

1419

## Methods

1420

1920

1921

# Methods

1922

1421

1923

# Approve - method

1422

1924

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

1423

1925

def Approve(self, value):

1424

1926

self.approve(value)

1425

1927

1426

1928

# CheckedOK - method

1427

1929

@dbus.service.method(_interface)

1428

1930

def CheckedOK(self):

1429

1931

self.checked_ok()

1430

1932

1431

1933

# Enable - method

1934

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

1432

1935

@dbus.service.method(_interface)

1433

1936

def Enable(self):

1434

1937

"D-Bus method"

1435

1938

self.enable()

1436

1939

1437

1940

# StartChecker - method

1941

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

1438

1942

@dbus.service.method(_interface)

1439

1943

def StartChecker(self):

1440

1944

"D-Bus method"

1441

1945

self.start_checker()

1442

1946

1443

1947

# Disable - method

1948

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

1444

1949

@dbus.service.method(_interface)

1445

1950

def Disable(self):

1446

1951

"D-Bus method"

1447

1952

self.disable()

1448

1953

1449

1954

# StopChecker - method

1955

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

1450

1956

@dbus.service.method(_interface)

1451

1957

def StopChecker(self):

1452

1958

self.stop_checker()

1453

1454

## Properties

1455

1959

1960

# Properties

1961

1456

1962

# ApprovalPending - property

1457

1963

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

1458

1964

def ApprovalPending_dbus_property(self):

1459

1965

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

1460

1966

1461

1967

# ApprovedByDefault - property

1462

@dbus_service_property(_interface, signature="b",

1968

@dbus_service_property(_interface,

1969

signature="b",

1463

1970

access="readwrite")

1464

1971

def ApprovedByDefault_dbus_property(self, value=None):

1465

1972

if value is None: # get

1466

1973

return dbus.Boolean(self.approved_by_default)

1467

1974

self.approved_by_default = bool(value)

1468

1975

1469

1976

# ApprovalDelay - property

1470

@dbus_service_property(_interface, signature="t",

1977

@dbus_service_property(_interface,

1978

signature="t",

1471

1979

access="readwrite")

1472

1980

def ApprovalDelay_dbus_property(self, value=None):

1473

1981

if value is None: # get

1474

return dbus.UInt64(self.approval_delay_milliseconds())

1982

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

1983

* 1000)

1475

1984

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

1476

1985

1477

1986

# ApprovalDuration - property

1478

@dbus_service_property(_interface, signature="t",

1987

@dbus_service_property(_interface,

1988

signature="t",

1479

1989

access="readwrite")

1480

1990

def ApprovalDuration_dbus_property(self, value=None):

1481

1991

if value is None: # get

1482

return dbus.UInt64(timedelta_to_milliseconds(

1483

self.approval_duration))

1992

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

1993

* 1000)

1484

1994

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

1485

1995

1486

1996

# Name - property

1997

@dbus_annotations(

1998

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

1487

1999

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

1488

2000

def Name_dbus_property(self):

1489

2001

return dbus.String(self.name)

1490

2002

1491

2003

# Fingerprint - property

2004

@dbus_annotations(

2005

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

1492

2006

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

1493

2007

def Fingerprint_dbus_property(self):

1494

2008

return dbus.String(self.fingerprint)

1495

2009

1496

2010

# Host - property

1497

@dbus_service_property(_interface, signature="s",

2011

@dbus_service_property(_interface,

2012

signature="s",

1498

2013

access="readwrite")

1499

2014

def Host_dbus_property(self, value=None):

1500

2015

if value is None: # get

1501

2016

return dbus.String(self.host)

1502

self.host = unicode(value)

1503

2017

self.host = str(value)

2018

1504

2019

# Created - property

2020

@dbus_annotations(

2021

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

1505

2022

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

1506

2023

def Created_dbus_property(self):

1507

2024

return datetime_to_dbus(self.created)

1508

2025

1509

2026

# LastEnabled - property

1510

2027

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

1511

2028

def LastEnabled_dbus_property(self):

1512

2029

return datetime_to_dbus(self.last_enabled)

1513

2030

1514

2031

# Enabled - property

1515

@dbus_service_property(_interface, signature="b",

2032

@dbus_service_property(_interface,

2033

signature="b",

1516

2034

access="readwrite")

1517

2035

def Enabled_dbus_property(self, value=None):

1518

2036

if value is None: # get

1521

2039

self.enable()

1522

2040

else:

1523

2041

self.disable()

1524

2042

1525

2043

# LastCheckedOK - property

1526

@dbus_service_property(_interface, signature="s",

2044

@dbus_service_property(_interface,

2045

signature="s",

1527

2046

access="readwrite")

1528

2047

def LastCheckedOK_dbus_property(self, value=None):

1529

2048

if value is not None:

1530

2049

self.checked_ok()

1531

2050

return

1532

2051

return datetime_to_dbus(self.last_checked_ok)

1533

2052

1534

2053

# LastCheckerStatus - property

1535

@dbus_service_property(_interface, signature="n",

1536

access="read")

2054

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

1537

2055

def LastCheckerStatus_dbus_property(self):

1538

2056

return dbus.Int16(self.last_checker_status)

1539

2057

1540

2058

# Expires - property

1541

2059

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

1542

2060

def Expires_dbus_property(self):

1543

2061

return datetime_to_dbus(self.expires)

1544

2062

1545

2063

# LastApprovalRequest - property

1546

2064

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

1547

2065

def LastApprovalRequest_dbus_property(self):

1548

2066

return datetime_to_dbus(self.last_approval_request)

1549

2067

1550

2068

# Timeout - property

1551

@dbus_service_property(_interface, signature="t",

2069

@dbus_service_property(_interface,

2070

signature="t",

1552

2071

access="readwrite")

1553

2072

def Timeout_dbus_property(self, value=None):

1554

2073

if value is None: # get

1555

return dbus.UInt64(self.timeout_milliseconds())

2074

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

1556

2075

old_timeout = self.timeout

1557

2076

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

1558

2077

# Reschedule disabling

1566

2085

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

1567

2086

is None):

1568

2087

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

2088

GLib.source_remove(self.disable_initiator_tag)

2089

self.disable_initiator_tag = GLib.timeout_add(

2090

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

2091

self.disable)

2092

1575

2093

# ExtendedTimeout - property

1576

@dbus_service_property(_interface, signature="t",

2094

@dbus_service_property(_interface,

2095

signature="t",

1577

2096

access="readwrite")

1578

2097

def ExtendedTimeout_dbus_property(self, value=None):

1579

2098

if value is None: # get

1580

return dbus.UInt64(self.extended_timeout_milliseconds())

2099

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

2100

* 1000)

1581

2101

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

1582

2102

1583

2103

# Interval - property

1584

@dbus_service_property(_interface, signature="t",

2104

@dbus_service_property(_interface,

2105

signature="t",

1585

2106

access="readwrite")

1586

2107

def Interval_dbus_property(self, value=None):

1587

2108

if value is None: # get

1588

return dbus.UInt64(self.interval_milliseconds())

2109

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

1589

2110

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

1590

2111

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

1591

2112

return

1592

2113

if self.enabled:

1593

2114

# 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

2115

GLib.source_remove(self.checker_initiator_tag)

2116

self.checker_initiator_tag = GLib.timeout_add(

2117

value, self.start_checker)

2118

self.start_checker() # Start one now, too

2119

1599

2120

# Checker - property

1600

@dbus_service_property(_interface, signature="s",

2121

@dbus_service_property(_interface,

2122

signature="s",

1601

2123

access="readwrite")

1602

2124

def Checker_dbus_property(self, value=None):

1603

2125

if value is None: # get

1604

2126

return dbus.String(self.checker_command)

1605

self.checker_command = unicode(value)

1606

2127

self.checker_command = str(value)

2128

1607

2129

# CheckerRunning - property

1608

@dbus_service_property(_interface, signature="b",

2130

@dbus_service_property(_interface,

2131

signature="b",

1609

2132

access="readwrite")

1610

2133

def CheckerRunning_dbus_property(self, value=None):

1611

2134

if value is None: # get

1614

2137

self.start_checker()

1615

2138

else:

1616

2139

self.stop_checker()

1617

2140

1618

2141

# ObjectPath - property

2142

@dbus_annotations(

2143

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

2144

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

1619

2145

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

1620

2146

def ObjectPath_dbus_property(self):

1621

return self.dbus_object_path # is already a dbus.ObjectPath

1622

2147

return self.dbus_object_path # is already a dbus.ObjectPath

2148

1623

2149

# Secret = property

1624

@dbus_service_property(_interface, signature="ay",

1625

access="write", byte_arrays=True)

2150

@dbus_annotations(

2151

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

2152

"invalidates"})

2153

@dbus_service_property(_interface,

2154

signature="ay",

2155

access="write",

2156

byte_arrays=True)

1626

2157

def Secret_dbus_property(self, value):

1627

self.secret = str(value)

1628

2158

self.secret = bytes(value)

2159

1629

2160

del _interface

1630

2161

1631

2162

1634

2165

self._pipe = child_pipe

1635

2166

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

1636

2167

if not self._pipe.recv():

1637

raise KeyError()

1638

2168

raise KeyError(fpr)

2169

1639

2170

def __getattribute__(self, name):

1640

2171

if name == '_pipe':

1641

2172

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

1644

2175

if data[0] == 'data':

1645

2176

return data[1]

1646

2177

if data[0] == 'function':

2178

1647

2179

def func(*args, **kwargs):

1648

2180

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

1649

2181

return self._pipe.recv()[1]

2182

1650

2183

return func

1651

2184

1652

2185

def __setattr__(self, name, value):

1653

2186

if name == '_pipe':

1654

2187

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

1657

2190

1658

2191

class ClientHandler(socketserver.BaseRequestHandler, object):

1659

2192

"""A class to handle client connections.

1660

2193

1661

2194

Instantiated once for each connection to handle it.

1662

2195

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

1663

2196

1664

2197

def handle(self):

1665

2198

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

1666

2199

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

1667

unicode(self.client_address))

2200

str(self.client_address))

1668

2201

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

1669

2202

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

2203

2204

session = gnutls.ClientSession(self.request)

2205

2206

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

2207

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

2208

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

2209

# "+DHE-DSS"))

1685

2210

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

1686

2211

priority = self.server.gnutls_priority

1687

2212

if priority is None:

1688

2213

priority = "NORMAL"

1689

(gnutls.library.functions

1690

.gnutls_priority_set_direct(session._c_object,

1691

priority, None))

1692

2214

gnutls.priority_set_direct(session._c_object,

2215

priority.encode("utf-8"),

2216

None)

2217

1693

2218

# Start communication using the Mandos protocol

1694

2219

# Get protocol number

1695

2220

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

1696

2221

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

1697

2222

try:

1698

2223

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

1699

raise RuntimeError

2224

raise RuntimeError(line)

1700

2225

except (ValueError, IndexError, RuntimeError) as error:

1701

2226

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

1702

2227

return

1703

2228

1704

2229

# Start GnuTLS connection

1705

2230

try:

1706

2231

session.handshake()

1707

except gnutls.errors.GNUTLSError as error:

2232

except gnutls.Error as error:

1708

2233

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

1709

2234

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

1710

2235

# established. Just abandon the request.

1711

2236

return

1712

2237

logger.debug("Handshake succeeded")

1713

2238

1714

2239

approval_required = False

1715

2240

try:

1716

2241

try:

1717

fpr = self.fingerprint(self.peer_certificate

1718

(session))

1719

except (TypeError,

1720

gnutls.errors.GNUTLSError) as error:

2242

fpr = self.fingerprint(

2243

self.peer_certificate(session))

2244

except (TypeError, gnutls.Error) as error:

1721

2245

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

1722

2246

return

1723

2247

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

1724

2248

1725

2249

try:

1726

2250

client = ProxyClient(child_pipe, fpr,

1727

2251

self.client_address)

1728

2252

except KeyError:

1729

2253

return

1730

2254

1731

2255

if client.approval_delay:

1732

2256

delay = client.approval_delay

1733

2257

client.approvals_pending += 1

1734

2258

approval_required = True

1735

2259

1736

2260

while True:

1737

2261

if not client.enabled:

1738

2262

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

1739

client.name)

2263

client.name)

1740

2264

if self.server.use_dbus:

1741

2265

# Emit D-Bus signal

1742

2266

client.Rejected("Disabled")

1743

2267

return

1744

2268

1745

2269

if client.approved or not client.approval_delay:

1746

#We are approved or approval is disabled

2270

# We are approved or approval is disabled

1747

2271

break

1748

2272

elif client.approved is None:

1749

2273

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

1751

2275

if self.server.use_dbus:

1752

2276

# Emit D-Bus signal

1753

2277

client.NeedApproval(

1754

client.approval_delay_milliseconds(),

1755

client.approved_by_default)

2278

client.approval_delay.total_seconds()

2279

* 1000, client.approved_by_default)

1756

2280

else:

1757

2281

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

1758

2282

client.name)

1760

2284

# Emit D-Bus signal

1761

2285

client.Rejected("Denied")

1762

2286

return

1763

1764

#wait until timeout or approved

2287

2288

# wait until timeout or approved

1765

2289

time = datetime.datetime.now()

1766

2290

client.changedstate.acquire()

1767

client.changedstate.wait(

1768

float(timedelta_to_milliseconds(delay)

1769

/ 1000))

2291

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

1770

2292

client.changedstate.release()

1771

2293

time2 = datetime.datetime.now()

1772

2294

if (time2 - time) >= delay:

1782

2304

break

1783

2305

else:

1784

2306

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

2307

2308

try:

2309

session.send(client.secret)

2310

except gnutls.Error as error:

2311

logger.warning("gnutls send failed",

2312

exc_info=error)

2313

return

2314

1799

2315

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

1800

2316

# bump the timeout using extended_timeout

1801

2317

client.bump_timeout(client.extended_timeout)

1802

2318

if self.server.use_dbus:

1803

2319

# Emit D-Bus signal

1804

2320

client.GotSecret()

1805

2321

1806

2322

finally:

1807

2323

if approval_required:

1808

2324

client.approvals_pending -= 1

1809

2325

try:

1810

2326

session.bye()

1811

except gnutls.errors.GNUTLSError as error:

2327

except gnutls.Error as error:

1812

2328

logger.warning("GnuTLS bye failed",

1813

2329

exc_info=error)

1814

2330

1815

2331

@staticmethod

1816

2332

def peer_certificate(session):

1817

2333

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

1818

2334

# 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

2335

if (gnutls.certificate_type_get(session._c_object)

2336

!= gnutls.CRT_OPENPGP):

2337

# ...return invalid data

2338

return b""

1824

2339

list_size = ctypes.c_uint(1)

1825

cert_list = (gnutls.library.functions

1826

.gnutls_certificate_get_peers

2340

cert_list = (gnutls.certificate_get_peers

1827

2341

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

1828

2342

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

1829

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

1830

" certificate")

2343

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

1831

2344

if list_size.value == 0:

1832

2345

return None

1833

2346

cert = cert_list[0]

1834

2347

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

1835

2348

1836

2349

@staticmethod

1837

2350

def fingerprint(openpgp):

1838

2351

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1839

2352

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

2353

datum = gnutls.datum_t(

2354

ctypes.cast(ctypes.c_char_p(openpgp),

2355

ctypes.POINTER(ctypes.c_ubyte)),

2356

ctypes.c_uint(len(openpgp)))

1845

2357

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

2358

crt = gnutls.openpgp_crt_t()

2359

gnutls.openpgp_crt_init(ctypes.byref(crt))

1849

2360

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

2361

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

2362

gnutls.OPENPGP_FMT_RAW)

1854

2363

# Verify the self signature in the key

1855

2364

crtverify = ctypes.c_uint()

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_verify_self(crt, 0,

1858

ctypes.byref(crtverify)))

2365

gnutls.openpgp_crt_verify_self(crt, 0,

2366

ctypes.byref(crtverify))

1859

2367

if crtverify.value != 0:

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1861

raise (gnutls.errors.CertificateSecurityError

1862

("Verify failed"))

2368

gnutls.openpgp_crt_deinit(crt)

2369

raise gnutls.CertificateSecurityError("Verify failed")

1863

2370

# New buffer for the fingerprint

1864

2371

buf = ctypes.create_string_buffer(20)

1865

2372

buf_len = ctypes.c_size_t()

1866

2373

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

2374

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

2375

ctypes.byref(buf_len))

1870

2376

# Deinit the certificate

1871

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2377

gnutls.openpgp_crt_deinit(crt)

1872

2378

# Convert the buffer to a Python bytestring

1873

2379

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

1874

2380

# Convert the bytestring to hexadecimal notation

1878

2384

1879

2385

class MultiprocessingMixIn(object):

1880

2386

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

2387

1881

2388

def sub_process_main(self, request, address):

1882

2389

try:

1883

2390

self.finish_request(request, address)

1884

2391

except Exception:

1885

2392

self.handle_error(request, address)

1886

2393

self.close_request(request)

1887

2394

1888

2395

def process_request(self, request, address):

1889

2396

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

1890

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

1891

args = (request, address))

2397

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

2398

args=(request, address))

1892

2399

proc.start()

1893

2400

return proc

1894

2401

1895

2402

1896

2403

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1897

2404

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

2405

1898

2406

def process_request(self, request, client_address):

1899

2407

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

1900

2408

1901

2409

This function creates a new pipe in self.pipe

1902

2410

"""

1903

2411

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1904

2412

1905

2413

proc = MultiprocessingMixIn.process_request(self, request,

1906

2414

client_address)

1907

2415

self.child_pipe.close()

1908

2416

self.add_pipe(parent_pipe, proc)

1909

2417

1910

2418

def add_pipe(self, parent_pipe, proc):

1911

2419

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

1912

raise NotImplementedError

2420

raise NotImplementedError()

1913

2421

1914

2422

1915

2423

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1916

2424

socketserver.TCPServer, object):

1917

2425

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

1918

2426

1919

2427

Attributes:

1920

2428

enabled: Boolean; whether this server is activated yet

1921

2429

interface: None or a network interface name (string)

1922

2430

use_ipv6: Boolean; to use IPv6 or not

1923

2431

"""

2432

1924

2433

def __init__(self, server_address, RequestHandlerClass,

1925

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

2434

interface=None,

2435

use_ipv6=True,

2436

socketfd=None):

1926

2437

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

1927

2438

creating a new one with socket.socket().

1928

2439

"""

1934

2445

self.socketfd = socketfd

1935

2446

# Save the original socket.socket() function

1936

2447

self.socket_socket = socket.socket

2448

1937

2449

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

1938

#

2450

#

1939

2451

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

1940

2452

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

1941

2453

# patching socket.socket.)

1942

#

2454

#

1943

2455

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

1944

2456

@functools.wraps(socket.socket)

1945

2457

def socket_wrapper(*args, **kwargs):

1957

2469

# socket_wrapper(), if socketfd was set.

1958

2470

socketserver.TCPServer.__init__(self, server_address,

1959

2471

RequestHandlerClass)

1960

2472

1961

2473

def server_bind(self):

1962

2474

"""This overrides the normal server_bind() function

1963

2475

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

1964

2476

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

2477

global SO_BINDTODEVICE

1965

2478

if self.interface is not None:

1966

2479

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

2480

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

2481

# common enough.

2482

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

2483

SO_BINDTODEVICE = 25

2484

try:

2485

self.socket.setsockopt(

2486

socket.SOL_SOCKET, SO_BINDTODEVICE,

2487

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

2488

except socket.error as error:

2489

if error.errno == errno.EPERM:

2490

logger.error("No permission to bind to"

2491

" interface %s", self.interface)

2492

elif error.errno == errno.ENOPROTOOPT:

2493

logger.error("SO_BINDTODEVICE not available;"

2494

" cannot bind to interface %s",

2495

self.interface)

2496

elif error.errno == errno.ENODEV:

2497

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

2498

" cannot bind", self.interface)

2499

else:

2500

raise

1988

2501

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

1989

2502

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

1990

2503

if not self.server_address[0]:

1991

2504

if self.address_family == socket.AF_INET6:

1992

any_address = "::" # in6addr_any

2505

any_address = "::" # in6addr_any

1993

2506

else:

1994

any_address = "0.0.0.0" # INADDR_ANY

2507

any_address = "0.0.0.0" # INADDR_ANY

1995

2508

self.server_address = (any_address,

1996

2509

self.server_address[1])

1997

2510

elif not self.server_address[1]:

1998

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

1999

0)

2511

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

2000

2512

# if self.interface:

2001

2513

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

2002

2514

# 0, # port

2008

2520

2009

2521

class MandosServer(IPv6_TCPServer):

2010

2522

"""Mandos server.

2011

2523

2012

2524

Attributes:

2013

2525

clients: set of Client objects

2014

2526

gnutls_priority GnuTLS priority string

2015

2527

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

2016

2017

Assumes a gobject.MainLoop event loop.

2528

2529

Assumes a GLib.MainLoop event loop.

2018

2530

"""

2531

2019

2532

def __init__(self, server_address, RequestHandlerClass,

2020

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

2021

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

2533

interface=None,

2534

use_ipv6=True,

2535

clients=None,

2536

gnutls_priority=None,

2537

use_dbus=True,

2538

socketfd=None):

2022

2539

self.enabled = False

2023

2540

self.clients = clients

2024

2541

if self.clients is None:

2027

2544

self.gnutls_priority = gnutls_priority

2028

2545

IPv6_TCPServer.__init__(self, server_address,

2029

2546

RequestHandlerClass,

2030

interface = interface,

2031

use_ipv6 = use_ipv6,

2032

socketfd = socketfd)

2547

interface=interface,

2548

use_ipv6=use_ipv6,

2549

socketfd=socketfd)

2550

2033

2551

def server_activate(self):

2034

2552

if self.enabled:

2035

2553

return socketserver.TCPServer.server_activate(self)

2036

2554

2037

2555

def enable(self):

2038

2556

self.enabled = True

2039

2557

2040

2558

def add_pipe(self, parent_pipe, proc):

2041

2559

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

2560

GLib.io_add_watch(

2561

parent_pipe.fileno(),

2562

GLib.IO_IN | GLib.IO_HUP,

2563

functools.partial(self.handle_ipc,

2564

parent_pipe=parent_pipe,

2565

proc=proc))

2566

2567

def handle_ipc(self, source, condition,

2568

parent_pipe=None,

2569

proc=None,

2570

client_object=None):

2051

2571

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

2052

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

2572

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

2053

2573

# Wait for other process to exit

2054

2574

proc.join()

2055

2575

return False

2056

2576

2057

2577

# Read a request from the child

2058

2578

request = parent_pipe.recv()

2059

2579

command = request[0]

2060

2580

2061

2581

if command == 'init':

2062

fpr = request[1]

2582

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

2063

2583

address = request[2]

2064

2065

for c in self.clients.itervalues():

2584

2585

for c in self.clients.values():

2066

2586

if c.fingerprint == fpr:

2067

2587

client = c

2068

2588

break

2075

2595

address[0])

2076

2596

parent_pipe.send(False)

2077

2597

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

2598

2599

GLib.io_add_watch(

2600

parent_pipe.fileno(),

2601

GLib.IO_IN | GLib.IO_HUP,

2602

functools.partial(self.handle_ipc,

2603

parent_pipe=parent_pipe,

2604

proc=proc,

2605

client_object=client))

2087

2606

parent_pipe.send(True)

2088

2607

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

2089

2608

# same fileno

2092

2611

funcname = request[1]

2093

2612

args = request[2]

2094

2613

kwargs = request[3]

2095

2614

2096

2615

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

2097

2616

funcname)(*args,

2098

**kwargs)))

2099

2617

**kwargs)))

2618

2100

2619

if command == 'getattr':

2101

2620

attrname = request[1]

2102

if callable(client_object.__getattribute__(attrname)):

2103

parent_pipe.send(('function',))

2621

if isinstance(client_object.__getattribute__(attrname),

2622

collections.Callable):

2623

parent_pipe.send(('function', ))

2104

2624

else:

2105

parent_pipe.send(('data', client_object

2106

.__getattribute__(attrname)))

2107

2625

parent_pipe.send((

2626

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

2627

2108

2628

if command == 'setattr':

2109

2629

attrname = request[1]

2110

2630

value = request[2]

2111

2631

setattr(client_object, attrname, value)

2112

2632

2113

2633

return True

2114

2634

2115

2635

2116

2636

def rfc3339_duration_to_delta(duration):

2117

2637

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

2118

2638

2119

2639

>>> rfc3339_duration_to_delta("P7D")

2120

2640

datetime.timedelta(7)

2121

2641

>>> rfc3339_duration_to_delta("PT60S")

2131

2651

>>> rfc3339_duration_to_delta("P1DT3M20S")

2132

2652

datetime.timedelta(1, 200)

2133

2653

"""

2134

2654

2135

2655

# Parsing an RFC 3339 duration with regular expressions is not

2136

2656

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

2137

2657

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

2138

2658

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

2139

2659

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

2140

2660

# avoid excessive use of external libraries.

2141

2661

2142

2662

# 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

2663

Token = collections.namedtuple("Token", (

2664

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

2665

# a "group" containing digits

2666

"value", # datetime.timedelta or None

2667

"followers")) # Tokens valid after this token

2152

2668

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

2153

2669

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

2154

2670

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

2155

2671

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

2156

2672

datetime.timedelta(seconds=1),

2157

frozenset((token_end,)))

2673

frozenset((token_end, )))

2158

2674

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

2159

2675

datetime.timedelta(minutes=1),

2160

2676

frozenset((token_second, token_end)))

2176

2692

frozenset((token_month, token_end)))

2177

2693

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

2178

2694

datetime.timedelta(weeks=1),

2179

frozenset((token_end,)))

2695

frozenset((token_end, )))

2180

2696

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

2181

2697

frozenset((token_year, token_month,

2182

2698

token_day, token_time,

2183

token_week))),

2184

# Define starting values

2185

value = datetime.timedelta() # Value so far

2699

token_week)))

2700

# Define starting values:

2701

# Value so far

2702

value = datetime.timedelta()

2186

2703

found_token = None

2187

followers = frozenset(token_duration,) # Following valid tokens

2188

s = duration # String left to parse

2704

# Following valid tokens

2705

followers = frozenset((token_duration, ))

2706

# String left to parse

2707

s = duration

2189

2708

# Loop until end token is found

2190

2709

while found_token is not token_end:

2191

2710

# Search for any currently valid tokens

2207

2726

break

2208

2727

else:

2209

2728

# No currently valid tokens were found

2210

raise ValueError("Invalid RFC 3339 duration")

2729

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

2730

.format(duration))

2211

2731

# End token found

2212

2732

return value

2213

2733

2214

2734

2215

2735

def string_to_delta(interval):

2216

2736

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

2217

2737

2218

2738

>>> string_to_delta('7d')

2219

2739

datetime.timedelta(7)

2220

2740

>>> string_to_delta('60s')

2228

2748

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

2229

2749

datetime.timedelta(0, 330)

2230

2750

"""

2231

2751

2232

2752

try:

2233

2753

return rfc3339_duration_to_delta(interval)

2234

2754

except ValueError:

2235

2755

pass

2236

2756

2237

2757

timevalue = datetime.timedelta(0)

2238

2758

for s in interval.split():

2239

2759

try:

2240

suffix = unicode(s[-1])

2760

suffix = s[-1]

2241

2761

value = int(s[:-1])

2242

2762

if suffix == "d":

2243

2763

delta = datetime.timedelta(value)

2250

2770

elif suffix == "w":

2251

2771

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

2252

2772

else:

2253

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

2254

.format(suffix))

2255

except (ValueError, IndexError) as e:

2773

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

2774

except IndexError as e:

2256

2775

raise ValueError(*(e.args))

2257

2776

timevalue += delta

2258

2777

return timevalue

2259

2778

2260

2779

2261

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

2780

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

2262

2781

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

2263

2782

2264

2783

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

2265

2784

if os.fork():

2266

2785

sys.exit()

2274

2793

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

2275

2794

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

2276

2795

raise OSError(errno.ENODEV,

2277

"{0} not a character device"

2796

"{} not a character device"

2278

2797

.format(os.devnull))

2279

2798

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

2280

2799

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

2284

2803

2285

2804

2286

2805

def main():

2287

2806

2288

2807

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

2289

2808

# Parsing of options, both command line and config file

2290

2809

2291

2810

parser = argparse.ArgumentParser()

2292

2811

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

2293

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

2812

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

2294

2813

help="show version number and exit")

2295

2814

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

2296

2815

help="Bind to interface IF")

2329

2848

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

2330

2849

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

2331

2850

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

2332

2851

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

2852

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

2853

default=None)

2854

2333

2855

options = parser.parse_args()

2334

2856

2335

2857

if options.check:

2336

2858

import doctest

2337

doctest.testmod()

2338

sys.exit()

2339

2859

fail_count, test_count = doctest.testmod()

2860

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

2861

2340

2862

# Default values for config file for server-global settings

2341

server_defaults = { "interface": "",

2342

"address": "",

2343

"port": "",

2344

"debug": "False",

2345

"priority":

2346

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

2347

"servicename": "Mandos",

2348

"use_dbus": "True",

2349

"use_ipv6": "True",

2350

"debuglevel": "",

2351

"restore": "True",

2352

"socket": "",

2353

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

2354

"foreground": "False",

2355

}

2356

2863

server_defaults = {"interface": "",

2864

"address": "",

2865

"port": "",

2866

"debug": "False",

2867

"priority":

2868

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

2869

":+SIGN-DSA-SHA256",

2870

"servicename": "Mandos",

2871

"use_dbus": "True",

2872

"use_ipv6": "True",

2873

"debuglevel": "",

2874

"restore": "True",

2875

"socket": "",

2876

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

2877

"foreground": "False",

2878

"zeroconf": "True",

2879

}

2880

2357

2881

# Parse config file for server-global settings

2358

2882

server_config = configparser.SafeConfigParser(server_defaults)

2359

2883

del server_defaults

2360

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

2361

"mandos.conf"))

2884

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

2362

2885

# Convert the SafeConfigParser object to a dict

2363

2886

server_settings = server_config.defaults()

2364

2887

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

2365

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

2888

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

2889

"foreground", "zeroconf"):

2366

2890

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

2367

2891

option)

2368

2892

if server_settings["port"]:

2378

2902

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

2379

2903

["socket"])

2380

2904

del server_config

2381

2905

2382

2906

# Override the settings from the config file with command line

2383

2907

# options, if set.

2384

2908

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

2385

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

2386

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

2387

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

2909

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

2910

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

2911

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

2388

2912

value = getattr(options, option)

2389

2913

if value is not None:

2390

2914

server_settings[option] = value

2391

2915

del options

2392

2916

# Force all strings to be unicode

2393

2917

for option in server_settings.keys():

2394

if type(server_settings[option]) is str:

2395

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

2918

if isinstance(server_settings[option], bytes):

2919

server_settings[option] = (server_settings[option]

2920

.decode("utf-8"))

2396

2921

# Force all boolean options to be boolean

2397

2922

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

2398

"foreground"):

2923

"foreground", "zeroconf"):

2399

2924

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

2400

2925

# Debug implies foreground

2401

2926

if server_settings["debug"]:

2402

2927

server_settings["foreground"] = True

2403

2928

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

2404

2929

2405

2930

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

2406

2931

2932

if (not server_settings["zeroconf"]

2933

and not (server_settings["port"]

2934

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

2935

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

2936

2407

2937

# For convenience

2408

2938

debug = server_settings["debug"]

2409

2939

debuglevel = server_settings["debuglevel"]

2412

2942

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

2413

2943

stored_state_file)

2414

2944

foreground = server_settings["foreground"]

2415

2945

zeroconf = server_settings["zeroconf"]

2946

2416

2947

if debug:

2417

2948

initlogger(debug, logging.DEBUG)

2418

2949

else:

2421

2952

else:

2422

2953

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

2423

2954

initlogger(debug, level)

2424

2955

2425

2956

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

2426

syslogger.setFormatter(logging.Formatter

2427

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

2428

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

2429

.format(server_settings

2430

["servicename"])))

2431

2957

syslogger.setFormatter(

2958

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

2959

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

2960

server_settings["servicename"])))

2961

2432

2962

# Parse config file with clients

2433

2963

client_config = configparser.SafeConfigParser(Client

2434

2964

.client_defaults)

2435

2965

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

2436

2966

"clients.conf"))

2437

2967

2438

2968

global mandos_dbus_service

2439

2969

mandos_dbus_service = None

2440

2441

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

2442

server_settings["port"]),

2443

ClientHandler,

2444

interface=(server_settings["interface"]

2445

or None),

2446

use_ipv6=use_ipv6,

2447

gnutls_priority=

2448

server_settings["priority"],

2449

use_dbus=use_dbus,

2450

socketfd=(server_settings["socket"]

2451

or None))

2970

2971

socketfd = None

2972

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

2973

socketfd = server_settings["socket"]

2974

tcp_server = MandosServer(

2975

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

2976

ClientHandler,

2977

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

2978

use_ipv6=use_ipv6,

2979

gnutls_priority=server_settings["priority"],

2980

use_dbus=use_dbus,

2981

socketfd=socketfd)

2452

2982

if not foreground:

2453

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

2983

pidfilename = "/run/mandos.pid"

2984

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

2985

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

2454

2986

pidfile = None

2455

2987

try:

2456

pidfile = open(pidfilename, "w")

2988

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

2457

2989

except IOError as e:

2458

2990

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

2459

2991

exc_info=e)

2460

2461

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

2992

2993

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

2994

("mandos", "mandos"),

2995

("nobody", "nogroup")):

2462

2996

try:

2463

2997

uid = pwd.getpwnam(name).pw_uid

2464

gid = pwd.getpwnam(name).pw_gid

2998

gid = pwd.getpwnam(group).pw_gid

2465

2999

break

2466

3000

except KeyError:

2467

3001

continue

2471

3005

try:

2472

3006

os.setgid(gid)

2473

3007

os.setuid(uid)

3008

if debug:

3009

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

3010

gid))

2474

3011

except OSError as error:

3012

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

3013

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

2475

3014

if error.errno != errno.EPERM:

2476

raise error

2477

3015

raise

3016

2478

3017

if debug:

2479

3018

# Enable all possible GnuTLS debugging

2480

3019

2481

3020

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

2482

3021

# - GnuTLS manual

2483

gnutls.library.functions.gnutls_global_set_log_level(11)

2484

2485

@gnutls.library.types.gnutls_log_func

3022

gnutls.global_set_log_level(11)

3023

3024

@gnutls.log_func

2486

3025

def debug_gnutls(level, string):

2487

3026

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

2488

2489

(gnutls.library.functions

2490

.gnutls_global_set_log_function(debug_gnutls))

2491

3027

3028

gnutls.global_set_log_function(debug_gnutls)

3029

2492

3030

# Redirect stdin so all checkers get /dev/null

2493

3031

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

2494

3032

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

2495

3033

if null > 2:

2496

3034

os.close(null)

2497

3035

2498

3036

# Need to fork before connecting to D-Bus

2499

3037

if not foreground:

2500

3038

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

2501

3039

daemon()

2502

2503

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

2504

# need to inform gobject that threads will be used.

2505

gobject.threads_init()

2506

3040

3041

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

3042

# to inform GLib that threads will be used.

3043

GLib.threads_init()

3044

2507

3045

global main_loop

2508

3046

# From the Avahi example code

2509

3047

DBusGMainLoop(set_as_default=True)

2510

main_loop = gobject.MainLoop()

3048

main_loop = GLib.MainLoop()

2511

3049

bus = dbus.SystemBus()

2512

3050

# End of Avahi example code

2513

3051

if use_dbus:

2514

3052

try:

2515

3053

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

2516

bus, do_not_queue=True)

2517

old_bus_name = (dbus.service.BusName

2518

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

2519

do_not_queue=True))

2520

except dbus.exceptions.NameExistsException as e:

3054

bus,

3055

do_not_queue=True)

3056

old_bus_name = dbus.service.BusName(

3057

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

3058

do_not_queue=True)

3059

except dbus.exceptions.DBusException as e:

2521

3060

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

2522

3061

use_dbus = False

2523

3062

server_settings["use_dbus"] = False

2524

3063

tcp_server.use_dbus = False

2525

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2526

service = AvahiServiceToSyslog(name =

2527

server_settings["servicename"],

2528

servicetype = "_mandos._tcp",

2529

protocol = protocol, bus = bus)

2530

if server_settings["interface"]:

2531

service.interface = (if_nametoindex

2532

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

2533

3064

if zeroconf:

3065

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3066

service = AvahiServiceToSyslog(

3067

name=server_settings["servicename"],

3068

servicetype="_mandos._tcp",

3069

protocol=protocol,

3070

bus=bus)

3071

if server_settings["interface"]:

3072

service.interface = if_nametoindex(

3073

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

3074

2534

3075

global multiprocessing_manager

2535

3076

multiprocessing_manager = multiprocessing.Manager()

2536

3077

2537

3078

client_class = Client

2538

3079

if use_dbus:

2539

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

2540

3080

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

3081

2541

3082

client_settings = Client.config_parser(client_config)

2542

3083

old_client_settings = {}

2543

3084

clients_data = {}

2544

3085

2545

3086

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

2546

3087

global wnull

2547

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

3088

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

2548

3089

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

2549

3090

# mode

2550

3091

if debug or not foreground:

2551

3092

wnull.close()

2552

3093

2553

3094

# Get client data and settings from last running state.

2554

3095

if server_settings["restore"]:

2555

3096

try:

2556

3097

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

2557

clients_data, old_client_settings = (pickle.load

2558

(stored_state))

3098

if sys.version_info.major == 2:

3099

clients_data, old_client_settings = pickle.load(

3100

stored_state)

3101

else:

3102

bytes_clients_data, bytes_old_client_settings = (

3103

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

3104

# Fix bytes to strings

3105

# clients_data

3106

# .keys()

3107

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

3108

if isinstance(key, bytes)

3109

else key): value

3110

for key, value in

3111

bytes_clients_data.items()}

3112

del bytes_clients_data

3113

for key in clients_data:

3114

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

3115

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

3116

for k, v in

3117

clients_data[key].items()}

3118

clients_data[key] = value

3119

# .client_structure

3120

value["client_structure"] = [

3121

(s.decode("utf-8")

3122

if isinstance(s, bytes)

3123

else s) for s in

3124

value["client_structure"]]

3125

# .name & .host

3126

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

3127

if isinstance(value[k], bytes):

3128

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

3129

# old_client_settings

3130

# .keys()

3131

old_client_settings = {

3132

(key.decode("utf-8")

3133

if isinstance(key, bytes)

3134

else key): value

3135

for key, value in

3136

bytes_old_client_settings.items()}

3137

del bytes_old_client_settings

3138

# .host

3139

for value in old_client_settings.values():

3140

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

3141

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

3142

.decode("utf-8"))

2559

3143

os.remove(stored_state_path)

2560

3144

except IOError as e:

2561

3145

if e.errno == errno.ENOENT:

2562

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

2563

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

3146

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

3147

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

2564

3148

else:

2565

3149

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

2566

3150

exc_info=e)

2567

3151

raise

2568

3152

except EOFError as e:

2569

3153

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

2570

"EOFError:", exc_info=e)

2571

3154

"EOFError:",

3155

exc_info=e)

3156

2572

3157

with PGPEngine() as pgp:

2573

for client_name, client in clients_data.iteritems():

3158

for client_name, client in clients_data.items():

2574

3159

# Skip removed clients

2575

3160

if client_name not in client_settings:

2576

3161

continue

2577

3162

2578

3163

# Decide which value to use after restoring saved state.

2579

3164

# We have three different values: Old config file,

2580

3165

# new config file, and saved state.

2585

3170

# For each value in new config, check if it

2586

3171

# differs from the old config value (Except for

2587

3172

# the "secret" attribute)

2588

if (name != "secret" and

2589

value != old_client_settings[client_name]

2590

[name]):

3173

if (name != "secret"

3174

and (value !=

3175

old_client_settings[client_name][name])):

2591

3176

client[name] = value

2592

3177

except KeyError:

2593

3178

pass

2594

3179

2595

3180

# Clients who has passed its expire date can still be

2596

# enabled if its last checker was successful. Clients

3181

# enabled if its last checker was successful. A Client

2597

3182

# whose checker succeeded before we stored its state is

2598

3183

# assumed to have successfully run all checkers during

2599

3184

# downtime.

2601

3186

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

2602

3187

if not client["last_checked_ok"]:

2603

3188

logger.warning(

2604

"disabling client {0} - Client never "

2605

"performed a successful checker"

2606

.format(client_name))

3189

"disabling client {} - Client never "

3190

"performed a successful checker".format(

3191

client_name))

2607

3192

client["enabled"] = False

2608

3193

elif client["last_checker_status"] != 0:

2609

3194

logger.warning(

2610

"disabling client {0} - Client "

2611

"last checker failed with error code {1}"

2612

.format(client_name,

2613

client["last_checker_status"]))

3195

"disabling client {} - Client last"

3196

" checker failed with error code"

3197

" {}".format(

3198

client_name,

3199

client["last_checker_status"]))

2614

3200

client["enabled"] = False

2615

3201

else:

2616

client["expires"] = (datetime.datetime

2617

.utcnow()

2618

+ client["timeout"])

3202

client["expires"] = (

3203

datetime.datetime.utcnow()

3204

+ client["timeout"])

2619

3205

logger.debug("Last checker succeeded,"

2620

" keeping {0} enabled"

2621

.format(client_name))

3206

" keeping {} enabled".format(

3207

client_name))

2622

3208

try:

2623

client["secret"] = (

2624

pgp.decrypt(client["encrypted_secret"],

2625

client_settings[client_name]

2626

["secret"]))

3209

client["secret"] = pgp.decrypt(

3210

client["encrypted_secret"],

3211

client_settings[client_name]["secret"])

2627

3212

except PGPError:

2628

3213

# If decryption fails, we use secret from new settings

2629

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

2630

.format(client_name))

2631

client["secret"] = (

2632

client_settings[client_name]["secret"])

2633

3214

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

3215

client_name))

3216

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

3217

["secret"])

3218

2634

3219

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

2635

3220

for client_name in (set(old_client_settings)

2636

3221

- set(client_settings)):

2638

3223

for client_name in (set(client_settings)

2639

3224

- set(old_client_settings)):

2640

3225

clients_data[client_name] = client_settings[client_name]

2641

3226

2642

3227

# Create all client objects

2643

for client_name, client in clients_data.iteritems():

3228

for client_name, client in clients_data.items():

2644

3229

tcp_server.clients[client_name] = client_class(

2645

name = client_name, settings = client,

2646

server_settings = server_settings)

2647

3230

name=client_name,

3231

settings=client,

3232

server_settings=server_settings)

3233

2648

3234

if not tcp_server.clients:

2649

3235

logger.warning("No clients defined")

2650

3236

2651

3237

if not foreground:

2652

3238

if pidfile is not None:

3239

pid = os.getpid()

2653

3240

try:

2654

3241

with pidfile:

2655

pid = os.getpid()

2656

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

3242

print(pid, file=pidfile)

2657

3243

except IOError:

2658

3244

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

2659

3245

pidfilename, pid)

2660

3246

del pidfile

2661

3247

del pidfilename

2662

2663

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

2664

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

2665

3248

3249

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

3250

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3251

lambda: main_loop.quit() and False)

3252

2666

3253

if use_dbus:

2667

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

2668

"se.bsnet.fukt.Mandos"})

2669

class MandosDBusService(DBusObjectWithProperties):

3254

3255

@alternate_dbus_interfaces(

3256

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

3257

class MandosDBusService(DBusObjectWithObjectManager):

2670

3258

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

3259

2671

3260

def __init__(self):

2672

3261

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

3262

2673

3263

_interface = "se.recompile.Mandos"

2674

2675

@dbus_interface_annotations(_interface)

2676

def _foo(self):

2677

return { "org.freedesktop.DBus.Property"

2678

".EmitsChangedSignal":

2679

"false"}

2680

3264

2681

3265

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

2682

3266

def ClientAdded(self, objpath):

2683

3267

"D-Bus signal"

2684

3268

pass

2685

3269

2686

3270

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

2687

3271

def ClientNotFound(self, fingerprint, address):

2688

3272

"D-Bus signal"

2689

3273

pass

2690

3274

3275

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

3276

"true"})

2691

3277

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

2692

3278

def ClientRemoved(self, objpath, name):

2693

3279

"D-Bus signal"

2694

3280

pass

2695

3281

3282

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

3283

"true"})

2696

3284

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

2697

3285

def GetAllClients(self):

2698

3286

"D-Bus method"

2699

return dbus.Array(c.dbus_object_path

2700

for c in

2701

tcp_server.clients.itervalues())

2702

3287

return dbus.Array(c.dbus_object_path for c in

3288

tcp_server.clients.values())

3289

3290

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

3291

"true"})

2703

3292

@dbus.service.method(_interface,

2704

3293

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

2705

3294

def GetAllClientsWithProperties(self):

2706

3295

"D-Bus method"

2707

3296

return dbus.Dictionary(

2708

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

2709

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

3297

{c.dbus_object_path: c.GetAll(

3298

"se.recompile.Mandos.Client")

3299

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

2710

3300

signature="oa{sv}")

2711

3301

2712

3302

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

2713

3303

def RemoveClient(self, object_path):

2714

3304

"D-Bus method"

2715

for c in tcp_server.clients.itervalues():

3305

for c in tcp_server.clients.values():

2716

3306

if c.dbus_object_path == object_path:

2717

3307

del tcp_server.clients[c.name]

2718

3308

c.remove_from_connection()

2719

# Don't signal anything except ClientRemoved

3309

# Don't signal the disabling

2720

3310

c.disable(quiet=True)

2721

# Emit D-Bus signal

2722

self.ClientRemoved(object_path, c.name)

3311

# Emit D-Bus signal for removal

3312

self.client_removed_signal(c)

2723

3313

return

2724

3314

raise KeyError(object_path)

2725

3315

2726

3316

del _interface

2727

3317

3318

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3319

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

3320

def GetManagedObjects(self):

3321

"""D-Bus method"""

3322

return dbus.Dictionary(

3323

{client.dbus_object_path:

3324

dbus.Dictionary(

3325

{interface: client.GetAll(interface)

3326

for interface in

3327

client._get_all_interface_names()})

3328

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

3329

3330

def client_added_signal(self, client):

3331

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

3332

if use_dbus:

3333

# New standard signal

3334

self.InterfacesAdded(

3335

client.dbus_object_path,

3336

dbus.Dictionary(

3337

{interface: client.GetAll(interface)

3338

for interface in

3339

client._get_all_interface_names()}))

3340

# Old signal

3341

self.ClientAdded(client.dbus_object_path)

3342

3343

def client_removed_signal(self, client):

3344

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

3345

if use_dbus:

3346

# New standard signal

3347

self.InterfacesRemoved(

3348

client.dbus_object_path,

3349

client._get_all_interface_names())

3350

# Old signal

3351

self.ClientRemoved(client.dbus_object_path,

3352

client.name)

3353

2728

3354

mandos_dbus_service = MandosDBusService()

2729

3355

3356

# Save modules to variables to exempt the modules from being

3357

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

3358

mp = multiprocessing

3359

wn = wnull

3360

2730

3361

def cleanup():

2731

3362

"Cleanup function; run on exit"

2732

service.cleanup()

2733

2734

multiprocessing.active_children()

2735

wnull.close()

3363

if zeroconf:

3364

service.cleanup()

3365

3366

mp.active_children()

3367

wn.close()

2736

3368

if not (tcp_server.clients or client_settings):

2737

3369

return

2738

3370

2739

3371

# Store client before exiting. Secrets are encrypted with key

2740

3372

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

2741

3373

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

2742

3374

clients = {}

2743

3375

with PGPEngine() as pgp:

2744

for client in tcp_server.clients.itervalues():

3376

for client in tcp_server.clients.values():

2745

3377

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

2746

3378

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

2747

3379

key)

2748

3380

client_dict = {}

2749

3381

2750

3382

# A list of attributes that can not be pickled

2751

3383

# + secret.

2752

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

2753

"checker", "server_settings"))

2754

for name, typ in (inspect.getmembers

2755

(dbus.service.Object)):

3384

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

3385

"checker", "server_settings"}

3386

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

3387

.Object):

2756

3388

exclude.add(name)

2757

3389

2758

3390

client_dict["encrypted_secret"] = (client

2759

3391

.encrypted_secret)

2760

3392

for attr in client.client_structure:

2761

3393

if attr not in exclude:

2762

3394

client_dict[attr] = getattr(client, attr)

2763

3395

2764

3396

clients[client.name] = client_dict

2765

3397

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

2766

3398

2767

3399

try:

2768

with (tempfile.NamedTemporaryFile

2769

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

2770

dir=os.path.dirname(stored_state_path),

2771

delete=False)) as stored_state:

2772

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

2773

tempname=stored_state.name

3400

with tempfile.NamedTemporaryFile(

3401

mode='wb',

3402

suffix=".pickle",

3403

prefix='clients-',

3404

dir=os.path.dirname(stored_state_path),

3405

delete=False) as stored_state:

3406

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

3407

protocol=2)

3408

tempname = stored_state.name

2774

3409

os.rename(tempname, stored_state_path)

2775

3410

except (IOError, OSError) as e:

2776

3411

if not debug:

2779

3414

except NameError:

2780

3415

pass

2781

3416

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

2782

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

3417

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

2783

3418

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

2784

3419

else:

2785

3420

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

2786

3421

exc_info=e)

2787

raise e

2788

3422

raise

3423

2789

3424

# Delete all clients, and settings from config

2790

3425

while tcp_server.clients:

2791

3426

name, client = tcp_server.clients.popitem()

2792

3427

if use_dbus:

2793

3428

client.remove_from_connection()

2794

# Don't signal anything except ClientRemoved

3429

# Don't signal the disabling

2795

3430

client.disable(quiet=True)

3431

# Emit D-Bus signal for removal

2796

3432

if use_dbus:

2797

# Emit D-Bus signal

2798

mandos_dbus_service.ClientRemoved(client

2799

.dbus_object_path,

2800

client.name)

3433

mandos_dbus_service.client_removed_signal(client)

2801

3434

client_settings.clear()

2802

3435

2803

3436

atexit.register(cleanup)

2804

2805

for client in tcp_server.clients.itervalues():

3437

3438

for client in tcp_server.clients.values():

2806

3439

if use_dbus:

2807

# Emit D-Bus signal

2808

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3440

# Emit D-Bus signal for adding

3441

mandos_dbus_service.client_added_signal(client)

2809

3442

# Need to initiate checking of clients

2810

3443

if client.enabled:

2811

3444

client.init_checker()

2812

3445

2813

3446

tcp_server.enable()

2814

3447

tcp_server.server_activate()

2815

3448

2816

3449

# Find out what port we got

2817

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

3450

if zeroconf:

3451

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

2818

3452

if use_ipv6:

2819

3453

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

2820

3454

" flowinfo %d, scope_id %d",

2822

3456

else: # IPv4

2823

3457

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

2824

3458

*tcp_server.socket.getsockname())

2825

2826

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

2827

3459

3460

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

3461

2828

3462

try:

2829

# From the Avahi example code

2830

try:

2831

service.activate()

2832

except dbus.exceptions.DBusException as error:

2833

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

2834

cleanup()

2835

sys.exit(1)

2836

# End of Avahi example code

2837

2838

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

2839

lambda *args, **kwargs:

2840

(tcp_server.handle_request

2841

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

2842

3463

if zeroconf:

3464

# From the Avahi example code

3465

try:

3466

service.activate()

3467

except dbus.exceptions.DBusException as error:

3468

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

3469

cleanup()

3470

sys.exit(1)

3471

# End of Avahi example code

3472

3473

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

3474

lambda *args, **kwargs:

3475

(tcp_server.handle_request

3476

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

3477

2843

3478

logger.debug("Starting main loop")

2844

3479

main_loop.run()

2845

3480

except AvahiError as error:

2854

3489

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

2855

3490

cleanup()

2856

3491

3492

2857

3493

if __name__ == '__main__':

2858

3494

main()