/mandos/trunk : revision 633

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

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

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

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

72

81

73

import dbus

82

74

import dbus.service

83

from gi.repository import GLib

75

import gobject

76

import avahi

84

77

from dbus.mainloop.glib import DBusGMainLoop

85

78

import ctypes

86

79

import ctypes.util

87

80

import xml.dom.minidom

88

81

import inspect

89

82

90

# Try to find the value of SO_BINDTODEVICE:

91

83

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:

94

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

95

85

except AttributeError:

96

86

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

99

87

from IN import SO_BINDTODEVICE

100

88

except ImportError:

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

89

SO_BINDTODEVICE = None

90

91

version = "1.6.1"

119

92

stored_state_file = "clients.pickle"

120

93

121

94

logger = logging.getLogger()

122

syslogger = None

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

123

98

124

99

try:

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

127

103

except (OSError, AttributeError):

128

129

104

def if_nametoindex(interface):

130

105

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

131

106

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

132

107

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

133

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

134

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

135

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

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

136

113

return interface_index

137

114

138

115

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

155

116

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

156

117

"""init logger and add loglevel"""

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

118

162

119

syslogger.setFormatter(logging.Formatter

163

120

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

164

121

' %(message)s'))

165

122

logger.addHandler(syslogger)

166

123

167

124

if debug:

168

125

console = logging.StreamHandler()

169

126

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

181

138

182

139

class PGPEngine(object):

183

140

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

184

185

141

def __init__(self):

186

142

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

198

143

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

144

'--home', self.tempdir,

200

145

'--force-mdc',

201

'--quiet']

202

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

203

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

204

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

205

146

'--quiet',

147

'--no-use-agent']

148

206

149

def __enter__(self):

207

150

return self

208

151

209

152

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

210

153

self._cleanup()

211

154

return False

212

155

213

156

def __del__(self):

214

157

self._cleanup()

215

158

216

159

def _cleanup(self):

217

160

if self.tempdir is not None:

218

161

# Delete contents of tempdir

219

162

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

220

topdown=False):

163

topdown = False):

221

164

for filename in files:

222

165

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

223

166

for dirname in dirs:

225

168

# Remove tempdir

226

169

os.rmdir(self.tempdir)

227

170

self.tempdir = None

228

171

229

172

def password_encode(self, password):

230

173

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

231

174

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

236

179

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

237

180

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

238

181

return encoded

239

182

240

183

def encrypt(self, data, password):

241

184

passphrase = self.password_encode(password)

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

185

with tempfile.NamedTemporaryFile(dir=self.tempdir

186

) as passfile:

244

187

passfile.write(passphrase)

245

188

passfile.flush()

246

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

189

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

247

190

'--passphrase-file',

248

191

passfile.name]

249

192

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

193

stdin = subprocess.PIPE,

194

stdout = subprocess.PIPE,

195

stderr = subprocess.PIPE)

196

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

254

197

if proc.returncode != 0:

255

198

raise PGPError(err)

256

199

return ciphertext

257

200

258

201

def decrypt(self, data, password):

259

202

passphrase = self.password_encode(password)

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

203

with tempfile.NamedTemporaryFile(dir = self.tempdir

204

) as passfile:

262

205

passfile.write(passphrase)

263

206

passfile.flush()

264

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

207

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

265

208

'--passphrase-file',

266

209

passfile.name]

267

210

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

211

stdin = subprocess.PIPE,

212

stdout = subprocess.PIPE,

213

stderr = subprocess.PIPE)

214

decrypted_plaintext, err = proc.communicate(input

215

= data)

272

216

if proc.returncode != 0:

273

217

raise PGPError(err)

274

218

return decrypted_plaintext

275

219

276

220

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

304

221

class AvahiError(Exception):

305

222

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

306

223

self.value = value

307

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

308

**kwargs)

309

224

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

225

def __unicode__(self):

226

return unicode(repr(self.value))

310

227

311

228

class AvahiServiceError(AvahiError):

312

229

pass

313

230

314

315

231

class AvahiGroupError(AvahiError):

316

232

pass

317

233

318

234

319

235

class AvahiService(object):

320

236

"""An Avahi (Zeroconf) service.

321

237

322

238

Attributes:

323

239

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

324

240

Used to optionally bind to the specified interface.

336

252

server: D-Bus Server

337

253

bus: dbus.SystemBus()

338

254

"""

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

255

256

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

257

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

258

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

259

protocol = avahi.PROTO_UNSPEC, bus = None):

351

260

self.interface = interface

352

261

self.name = name

353

262

self.type = servicetype

362

271

self.server = None

363

272

self.bus = bus

364

273

self.entry_group_state_changed_match = None

365

366

def rename(self, remove=True):

274

275

def rename(self):

367

276

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

368

277

if self.rename_count >= self.max_renames:

369

278

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

370

279

" after %i retries, exiting.",

371

280

self.rename_count)

372

281

raise AvahiServiceError("Too many renames")

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

282

self.name = unicode(self.server

283

.GetAlternativeServiceName(self.name))

376

284

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

377

285

self.name)

378

if remove:

379

self.remove()

286

self.remove()

380

287

try:

381

288

self.add()

382

289

except dbus.exceptions.DBusException as error:

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

290

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

291

self.cleanup()

292

os._exit(1)

293

self.rename_count += 1

294

392

295

def remove(self):

393

296

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

394

297

if self.entry_group_state_changed_match is not None:

396

299

self.entry_group_state_changed_match = None

397

300

if self.group is not None:

398

301

self.group.Reset()

399

302

400

303

def add(self):

401

304

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

402

305

self.remove()

419

322

dbus.UInt16(self.port),

420

323

avahi.string_array_to_txt_array(self.TXT))

421

324

self.group.Commit()

422

325

423

326

def entry_group_state_changed(self, state, error):

424

327

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

425

328

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

426

329

427

330

if state == avahi.ENTRY_GROUP_ESTABLISHED:

428

331

logger.debug("Zeroconf service established.")

429

332

elif state == avahi.ENTRY_GROUP_COLLISION:

431

334

self.rename()

432

335

elif state == avahi.ENTRY_GROUP_FAILURE:

433

336

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

434

str(error))

435

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

436

337

unicode(error))

338

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

339

.format(error))

340

437

341

def cleanup(self):

438

342

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

439

343

if self.group is not None:

444

348

pass

445

349

self.group = None

446

350

self.remove()

447

351

448

352

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

449

353

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

450

354

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

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

}

355

bad_states = { avahi.SERVER_INVALID:

356

"Zeroconf server invalid",

357

avahi.SERVER_REGISTERING: None,

358

avahi.SERVER_COLLISION:

359

"Zeroconf server name collision",

360

avahi.SERVER_FAILURE:

361

"Zeroconf server failure" }

457

362

if state in bad_states:

458

363

if bad_states[state] is not None:

459

364

if error is None:

462

367

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

463

368

self.cleanup()

464

369

elif state == avahi.SERVER_RUNNING:

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)

370

self.add()

477

371

else:

478

372

if error is None:

479

373

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

480

374

else:

481

375

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

482

376

483

377

def activate(self):

484

378

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

485

379

if self.server is None:

489

383

follow_name_owner_changes=True),

490

384

avahi.DBUS_INTERFACE_SERVER)

491

385

self.server.connect_to_signal("StateChanged",

492

self.server_state_changed)

386

self.server_state_changed)

493

387

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

494

388

495

389

496

390

class AvahiServiceToSyslog(AvahiService):

497

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

391

def rename(self):

498

392

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

499

ret = AvahiService.rename(self, *args, **kwargs)

500

syslogger.setFormatter(logging.Formatter(

501

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

502

.format(self.name)))

393

ret = AvahiService.rename(self)

394

syslogger.setFormatter(logging.Formatter

395

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

396

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

397

.format(self.name)))

503

398

return ret

504

399

505

400

506

# Pretend that we have a GnuTLS module

507

class GnuTLS(object):

508

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

509

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

510

511

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

512

if library is None:

513

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

514

_library = ctypes.cdll.LoadLibrary(library)

515

del library

516

_need_version = b"3.3.0"

517

518

def __init__(self):

519

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

520

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

521

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

522

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

523

.format(self._need_version))

524

525

# Unless otherwise indicated, the constants and types below are

526

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

527

528

# Constants

529

E_SUCCESS = 0

530

E_INTERRUPTED = -52

531

E_AGAIN = -28

532

CRT_OPENPGP = 2

533

CLIENT = 2

534

SHUT_RDWR = 0

535

CRD_CERTIFICATE = 1

536

E_NO_CERTIFICATE_FOUND = -49

537

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

538

539

# Types

540

class session_int(ctypes.Structure):

541

_fields_ = []

542

session_t = ctypes.POINTER(session_int)

543

544

class certificate_credentials_st(ctypes.Structure):

545

_fields_ = []

546

certificate_credentials_t = ctypes.POINTER(

547

certificate_credentials_st)

548

certificate_type_t = ctypes.c_int

549

550

class datum_t(ctypes.Structure):

551

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

552

('size', ctypes.c_uint)]

553

554

class openpgp_crt_int(ctypes.Structure):

555

_fields_ = []

556

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

557

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

558

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

559

credentials_type_t = ctypes.c_int

560

transport_ptr_t = ctypes.c_void_p

561

close_request_t = ctypes.c_int

562

563

# Exceptions

564

class Error(Exception):

565

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

566

# exception might be raised from within GnuTLS.__init__,

567

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

568

# global variable has happened.

569

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

570

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

571

# code is passed, convert it to a string with

572

# gnutls.strerror()

573

self.code = code

574

if message is None and code is not None:

575

message = GnuTLS.strerror(code)

576

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

577

message, *args)

578

579

class CertificateSecurityError(Error):

580

pass

581

582

# Classes

583

class Credentials(object):

584

def __init__(self):

585

self._c_object = gnutls.certificate_credentials_t()

586

gnutls.certificate_allocate_credentials(

587

ctypes.byref(self._c_object))

588

self.type = gnutls.CRD_CERTIFICATE

589

590

def __del__(self):

591

gnutls.certificate_free_credentials(self._c_object)

592

593

class ClientSession(object):

594

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

595

self._c_object = gnutls.session_t()

596

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

597

gnutls.set_default_priority(self._c_object)

598

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

599

gnutls.handshake_set_private_extensions(self._c_object,

600

True)

601

self.socket = socket

602

if credentials is None:

603

credentials = gnutls.Credentials()

604

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

605

ctypes.cast(credentials._c_object,

606

ctypes.c_void_p))

607

self.credentials = credentials

608

609

def __del__(self):

610

gnutls.deinit(self._c_object)

611

612

def handshake(self):

613

return gnutls.handshake(self._c_object)

614

615

def send(self, data):

616

data = bytes(data)

617

data_len = len(data)

618

while data_len > 0:

619

data_len -= gnutls.record_send(self._c_object,

620

data[-data_len:],

621

data_len)

622

623

def bye(self):

624

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

625

626

# Error handling functions

627

def _error_code(result):

628

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

629

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

630

if result >= 0:

631

return result

632

if result == gnutls.E_NO_CERTIFICATE_FOUND:

633

raise gnutls.CertificateSecurityError(code=result)

634

raise gnutls.Error(code=result)

635

636

def _retry_on_error(result, func, arguments):

637

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

638

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

639

while result < 0:

640

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

641

return _error_code(result)

642

result = func(*arguments)

643

return result

644

645

# Unless otherwise indicated, the function declarations below are

646

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

647

648

# Functions

649

priority_set_direct = _library.gnutls_priority_set_direct

650

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

651

ctypes.POINTER(ctypes.c_char_p)]

652

priority_set_direct.restype = _error_code

653

654

init = _library.gnutls_init

655

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

656

init.restype = _error_code

657

658

set_default_priority = _library.gnutls_set_default_priority

659

set_default_priority.argtypes = [session_t]

660

set_default_priority.restype = _error_code

661

662

record_send = _library.gnutls_record_send

663

record_send.argtypes = [session_t, ctypes.c_void_p,

664

ctypes.c_size_t]

665

record_send.restype = ctypes.c_ssize_t

666

record_send.errcheck = _retry_on_error

667

668

certificate_allocate_credentials = (

669

_library.gnutls_certificate_allocate_credentials)

670

certificate_allocate_credentials.argtypes = [

671

ctypes.POINTER(certificate_credentials_t)]

672

certificate_allocate_credentials.restype = _error_code

673

674

certificate_free_credentials = (

675

_library.gnutls_certificate_free_credentials)

676

certificate_free_credentials.argtypes = [

677

certificate_credentials_t]

678

certificate_free_credentials.restype = None

679

680

handshake_set_private_extensions = (

681

_library.gnutls_handshake_set_private_extensions)

682

handshake_set_private_extensions.argtypes = [session_t,

683

ctypes.c_int]

684

handshake_set_private_extensions.restype = None

685

686

credentials_set = _library.gnutls_credentials_set

687

credentials_set.argtypes = [session_t, credentials_type_t,

688

ctypes.c_void_p]

689

credentials_set.restype = _error_code

690

691

strerror = _library.gnutls_strerror

692

strerror.argtypes = [ctypes.c_int]

693

strerror.restype = ctypes.c_char_p

694

695

certificate_type_get = _library.gnutls_certificate_type_get

696

certificate_type_get.argtypes = [session_t]

697

certificate_type_get.restype = _error_code

698

699

certificate_get_peers = _library.gnutls_certificate_get_peers

700

certificate_get_peers.argtypes = [session_t,

701

ctypes.POINTER(ctypes.c_uint)]

702

certificate_get_peers.restype = ctypes.POINTER(datum_t)

703

704

global_set_log_level = _library.gnutls_global_set_log_level

705

global_set_log_level.argtypes = [ctypes.c_int]

706

global_set_log_level.restype = None

707

708

global_set_log_function = _library.gnutls_global_set_log_function

709

global_set_log_function.argtypes = [log_func]

710

global_set_log_function.restype = None

711

712

deinit = _library.gnutls_deinit

713

deinit.argtypes = [session_t]

714

deinit.restype = None

715

716

handshake = _library.gnutls_handshake

717

handshake.argtypes = [session_t]

718

handshake.restype = _error_code

719

handshake.errcheck = _retry_on_error

720

721

transport_set_ptr = _library.gnutls_transport_set_ptr

722

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

723

transport_set_ptr.restype = None

724

725

bye = _library.gnutls_bye

726

bye.argtypes = [session_t, close_request_t]

727

bye.restype = _error_code

728

bye.errcheck = _retry_on_error

729

730

check_version = _library.gnutls_check_version

731

check_version.argtypes = [ctypes.c_char_p]

732

check_version.restype = ctypes.c_char_p

733

734

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

735

736

openpgp_crt_init = _library.gnutls_openpgp_crt_init

737

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

738

openpgp_crt_init.restype = _error_code

739

740

openpgp_crt_import = _library.gnutls_openpgp_crt_import

741

openpgp_crt_import.argtypes = [openpgp_crt_t,

742

ctypes.POINTER(datum_t),

743

openpgp_crt_fmt_t]

744

openpgp_crt_import.restype = _error_code

745

746

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

747

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

748

ctypes.POINTER(ctypes.c_uint)]

749

openpgp_crt_verify_self.restype = _error_code

750

751

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

752

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

753

openpgp_crt_deinit.restype = None

754

755

openpgp_crt_get_fingerprint = (

756

_library.gnutls_openpgp_crt_get_fingerprint)

757

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

758

ctypes.c_void_p,

759

ctypes.POINTER(

760

ctypes.c_size_t)]

761

openpgp_crt_get_fingerprint.restype = _error_code

762

763

# Remove non-public functions

764

del _error_code, _retry_on_error

765

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

766

gnutls = GnuTLS()

767

768

769

def call_pipe(connection, # : multiprocessing.Connection

770

func, *args, **kwargs):

771

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

772

773

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

774

return value on the provided multiprocessing.Connection.

775

"""

776

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

777

connection.close()

401

def timedelta_to_milliseconds(td):

402

"Convert a datetime.timedelta() to milliseconds"

403

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

404

+ (td.seconds * 1000)

405

+ (td.microseconds // 1000))

778

406

779

407

780

408

class Client(object):

781

409

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

782

410

783

411

Attributes:

784

412

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

785

413

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

787

415

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

788

416

to see if the client lives.

789

417

'None' if no process is running.

790

checker_callback_tag: a GLib event source tag, or None

418

checker_callback_tag: a gobject event source tag, or None

791

419

checker_command: string; External command which is run to check

792

420

if client lives. %() expansions are done at

793

421

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

794

422

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

795

checker_initiator_tag: a GLib event source tag, or None

423

checker_initiator_tag: a gobject event source tag, or None

796

424

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

797

425

client_structure: Object describing what attributes a client has

798

426

and is used for storing the client at exit

799

427

current_checker_command: string; current running checker_command

800

disable_initiator_tag: a GLib event source tag, or None

428

disable_initiator_tag: a gobject event source tag, or None

801

429

enabled: bool()

802

430

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

803

431

uniquely identify the client

808

436

last_checker_status: integer between 0 and 255 reflecting exit

809

437

status of last checker. -1 reflects crashed

810

438

checker, -2 means no checker completed yet.

811

last_checker_signal: The signal which killed the last checker, if

812

last_checker_status is -1

813

439

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

814

440

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

815

441

D-Bus identifiers

822

448

disabled, or None

823

449

server_settings: The server_settings dict from main()

824

450

"""

825

451

826

452

runtime_expansions = ("approval_delay", "approval_duration",

827

453

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

828

454

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

829

455

"last_approval_request", "last_checked_ok",

830

456

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

831

client_defaults = {

832

"timeout": "PT5M",

833

"extended_timeout": "PT15M",

834

"interval": "PT2M",

835

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

836

"host": "",

837

"approval_delay": "PT0S",

838

"approval_duration": "PT1S",

839

"approved_by_default": "True",

840

"enabled": "True",

841

}

842

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

460

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

461

"host": "",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

464

"approved_by_default": "True",

465

"enabled": "True",

466

}

467

468

def timeout_milliseconds(self):

469

"Return the 'timeout' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.timeout)

471

472

def extended_timeout_milliseconds(self):

473

"Return the 'extended_timeout' attribute in milliseconds"

474

return timedelta_to_milliseconds(self.extended_timeout)

475

476

def interval_milliseconds(self):

477

"Return the 'interval' attribute in milliseconds"

478

return timedelta_to_milliseconds(self.interval)

479

480

def approval_delay_milliseconds(self):

481

return timedelta_to_milliseconds(self.approval_delay)

482

843

483

@staticmethod

844

484

def config_parser(config):

845

485

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

852

492

for client_name in config.sections():

853

493

section = dict(config.items(client_name))

854

494

client = settings[client_name] = {}

855

495

856

496

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

857

497

# Reformat values from string types to Python types

858

498

client["approved_by_default"] = config.getboolean(

859

499

client_name, "approved_by_default")

860

500

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

861

501

"enabled")

862

863

# Uppercase and remove spaces from fingerprint for later

864

# comparison purposes with return value from the

865

# fingerprint() function

502

866

503

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

867

504

.replace(" ", ""))

868

505

if "secret" in section:

869

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

870

.encode("utf-8"),

871

"base64")

506

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

872

507

elif "secfile" in section:

873

508

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

874

509

(section["secfile"])),

875

510

"rb") as secfile:

876

511

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

877

512

else:

878

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

513

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

879

514

.format(section))

880

515

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

881

516

client["extended_timeout"] = string_to_delta(

889

524

client["last_approval_request"] = None

890

525

client["last_checked_ok"] = None

891

526

client["last_checker_status"] = -2

892

527

893

528

return settings

894

895

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

529

530

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

896

531

self.name = name

897

532

if server_settings is None:

898

533

server_settings = {}

899

534

self.server_settings = server_settings

900

535

# adding all client settings

901

for setting, value in settings.items():

536

for setting, value in settings.iteritems():

902

537

setattr(self, setting, value)

903

538

904

539

if self.enabled:

905

540

if not hasattr(self, "last_enabled"):

906

541

self.last_enabled = datetime.datetime.utcnow()

910

545

else:

911

546

self.last_enabled = None

912

547

self.expires = None

913

548

914

549

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

550

# Uppercase and remove spaces from fingerprint for later

551

# comparison purposes with return value from the fingerprint()

552

# function

915

553

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

916

554

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

917

555

datetime.datetime.utcnow())

918

556

919

557

# attributes specific for this server instance

920

558

self.checker = None

921

559

self.checker_initiator_tag = None

924

562

self.current_checker_command = None

925

563

self.approved = None

926

564

self.approvals_pending = 0

927

self.changedstate = multiprocessing_manager.Condition(

928

multiprocessing_manager.Lock())

929

self.client_structure = [attr

930

for attr in self.__dict__.keys()

565

self.changedstate = (multiprocessing_manager

566

.Condition(multiprocessing_manager

567

.Lock()))

568

self.client_structure = [attr for attr in

569

self.__dict__.iterkeys()

931

570

if not attr.startswith("_")]

932

571

self.client_structure.append("client_structure")

933

934

for name, t in inspect.getmembers(

935

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

572

573

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

574

lambda obj:

575

isinstance(obj,

576

property)):

936

577

if not name.startswith("_"):

937

578

self.client_structure.append(name)

938

579

939

580

# Send notice to process children that client state has changed

940

581

def send_changedstate(self):

941

582

with self.changedstate:

942

583

self.changedstate.notify_all()

943

584

944

585

def enable(self):

945

586

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

946

587

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

951

592

self.last_enabled = datetime.datetime.utcnow()

952

593

self.init_checker()

953

594

self.send_changedstate()

954

595

955

596

def disable(self, quiet=True):

956

597

"""Disable this client."""

957

598

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

959

600

if not quiet:

960

601

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

961

602

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

962

GLib.source_remove(self.disable_initiator_tag)

603

gobject.source_remove(self.disable_initiator_tag)

963

604

self.disable_initiator_tag = None

964

605

self.expires = None

965

606

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

966

GLib.source_remove(self.checker_initiator_tag)

607

gobject.source_remove(self.checker_initiator_tag)

967

608

self.checker_initiator_tag = None

968

609

self.stop_checker()

969

610

self.enabled = False

970

611

if not quiet:

971

612

self.send_changedstate()

972

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

613

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

973

614

return False

974

615

975

616

def __del__(self):

976

617

self.disable()

977

618

978

619

def init_checker(self):

979

620

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

980

621

# and every interval from then on.

981

622

if self.checker_initiator_tag is not None:

982

GLib.source_remove(self.checker_initiator_tag)

983

self.checker_initiator_tag = GLib.timeout_add(

984

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

985

self.start_checker)

623

gobject.source_remove(self.checker_initiator_tag)

624

self.checker_initiator_tag = (gobject.timeout_add

625

(self.interval_milliseconds(),

626

self.start_checker))

986

627

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

987

628

if self.disable_initiator_tag is not None:

988

GLib.source_remove(self.disable_initiator_tag)

989

self.disable_initiator_tag = GLib.timeout_add(

990

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

629

gobject.source_remove(self.disable_initiator_tag)

630

self.disable_initiator_tag = (gobject.timeout_add

631

(self.timeout_milliseconds(),

632

self.disable))

991

633

# Also start a new checker *right now*.

992

634

self.start_checker()

993

994

def checker_callback(self, source, condition, connection,

995

command):

635

636

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

996

637

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

997

638

self.checker_callback_tag = None

998

639

self.checker = None

999

# Read return code from connection (see call_pipe)

1000

returncode = connection.recv()

1001

connection.close()

1002

1003

if returncode >= 0:

1004

self.last_checker_status = returncode

1005

self.last_checker_signal = None

640

if os.WIFEXITED(condition):

641

self.last_checker_status = os.WEXITSTATUS(condition)

1006

642

if self.last_checker_status == 0:

1007

643

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

1008

644

vars(self))

1009

645

self.checked_ok()

1010

646

else:

1011

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

647

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

648

vars(self))

1012

649

else:

1013

650

self.last_checker_status = -1

1014

self.last_checker_signal = -returncode

1015

651

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

1016

652

vars(self))

1017

return False

1018

653

1019

654

def checked_ok(self):

1020

655

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

1021

656

self.last_checked_ok = datetime.datetime.utcnow()

1022

657

self.last_checker_status = 0

1023

self.last_checker_signal = None

1024

658

self.bump_timeout()

1025

659

1026

660

def bump_timeout(self, timeout=None):

1027

661

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

1028

662

if timeout is None:

1029

663

timeout = self.timeout

1030

664

if self.disable_initiator_tag is not None:

1031

GLib.source_remove(self.disable_initiator_tag)

665

gobject.source_remove(self.disable_initiator_tag)

1032

666

self.disable_initiator_tag = None

1033

667

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

1034

self.disable_initiator_tag = GLib.timeout_add(

1035

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

668

self.disable_initiator_tag = (gobject.timeout_add

669

(timedelta_to_milliseconds

670

(timeout), self.disable))

1036

671

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

1037

672

1038

673

def need_approval(self):

1039

674

self.last_approval_request = datetime.datetime.utcnow()

1040

675

1041

676

def start_checker(self):

1042

677

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

1043

678

1044

679

If a checker already exists, leave it running and do

1045

680

nothing."""

1046

681

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

1051

686

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

1052

687

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

1053

688

# should be.

1054

1055

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

1056

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

1057

self.checker.join()

1058

self.checker = None

689

690

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

691

try:

692

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

693

except (AttributeError, OSError) as error:

694

if (isinstance(error, OSError)

695

and error.errno != errno.ECHILD):

696

raise error

697

else:

698

if pid:

699

logger.warning("Checker was a zombie")

700

gobject.source_remove(self.checker_callback_tag)

701

self.checker_callback(pid, status,

702

self.current_checker_command)

1059

703

# Start a new checker if needed

1060

704

if self.checker is None:

1061

705

# Escape attributes for the shell

1062

escaped_attrs = {

1063

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

1064

for attr in self.runtime_expansions}

706

escaped_attrs = dict(

707

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

708

for attr in

709

self.runtime_expansions)

1065

710

try:

1066

711

command = self.checker_command % escaped_attrs

1067

712

except TypeError as error:

1068

713

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

1069

self.checker_command,

714

self.checker_command, exc_info=error)

715

return True # Try again later

716

self.current_checker_command = command

717

try:

718

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

719

command, self.name)

720

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

721

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

722

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

723

# always replaced by /dev/null.)

724

# The exception is when not debugging but nevertheless

725

# running in the foreground; use the previously

726

# created wnull.

727

popen_args = {}

728

if (not self.server_settings["debug"]

729

and self.server_settings["foreground"]):

730

popen_args.update({"stdout": wnull,

731

"stderr": wnull })

732

self.checker = subprocess.Popen(command,

733

close_fds=True,

734

shell=True, cwd="/",

735

**popen_args)

736

except OSError as error:

737

logger.error("Failed to start subprocess",

1070

738

exc_info=error)

1071

return True # Try again later

1072

self.current_checker_command = command

1073

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

1074

self.name)

1075

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

1076

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

1077

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

1078

# always replaced by /dev/null.)

1079

# The exception is when not debugging but nevertheless

1080

# running in the foreground; use the previously

1081

# created wnull.

1082

popen_args = {"close_fds": True,

1083

"shell": True,

1084

"cwd": "/"}

1085

if (not self.server_settings["debug"]

1086

and self.server_settings["foreground"]):

1087

popen_args.update({"stdout": wnull,

1088

"stderr": wnull})

1089

pipe = multiprocessing.Pipe(duplex=False)

1090

self.checker = multiprocessing.Process(

1091

target=call_pipe,

1092

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

1093

kwargs=popen_args)

1094

self.checker.start()

1095

self.checker_callback_tag = GLib.io_add_watch(

1096

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

1097

self.checker_callback, pipe[0], command)

1098

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

739

return True

740

self.checker_callback_tag = (gobject.child_watch_add

741

(self.checker.pid,

742

self.checker_callback,

743

data=command))

744

# The checker may have completed before the gobject

745

# watch was added. Check for this.

746

try:

747

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

748

except OSError as error:

749

if error.errno == errno.ECHILD:

750

# This should never happen

751

logger.error("Child process vanished",

752

exc_info=error)

753

return True

754

raise

755

if pid:

756

gobject.source_remove(self.checker_callback_tag)

757

self.checker_callback(pid, status, command)

758

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

1099

759

return True

1100

760

1101

761

def stop_checker(self):

1102

762

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

1103

763

if self.checker_callback_tag:

1104

GLib.source_remove(self.checker_callback_tag)

764

gobject.source_remove(self.checker_callback_tag)

1105

765

self.checker_callback_tag = None

1106

766

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

1107

767

return

1108

768

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

1109

self.checker.terminate()

769

try:

770

self.checker.terminate()

771

#time.sleep(0.5)

772

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

773

# self.checker.kill()

774

except OSError as error:

775

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

776

raise

1110

777

self.checker = None

1111

778

1112

779

1113

def dbus_service_property(dbus_interface,

1114

signature="v",

1115

access="readwrite",

1116

byte_arrays=False):

780

def dbus_service_property(dbus_interface, signature="v",

781

access="readwrite", byte_arrays=False):

1117

782

"""Decorators for marking methods of a DBusObjectWithProperties to

1118

783

become properties on the D-Bus.

1119

784

1120

785

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

1121

786

and with one argument by "Set".

1122

787

1123

788

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

1124

789

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

1125

790

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

1128

793

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

1129

794

if byte_arrays and signature != "ay":

1130

795

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

1131

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

1132

796

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

1133

797

def decorator(func):

1134

798

func._dbus_is_property = True

1135

799

func._dbus_interface = dbus_interface

1138

802

func._dbus_name = func.__name__

1139

803

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

1140

804

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

1141

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

805

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1142

806

return func

1143

1144

807

return decorator

1145

808

1146

809

1147

810

def dbus_interface_annotations(dbus_interface):

1148

811

"""Decorator for marking functions returning interface annotations

1149

812

1150

813

Usage:

1151

814

1152

815

@dbus_interface_annotations("org.example.Interface")

1153

816

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

1154

817

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

1155

818

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

1156

819

"false"}

1157

820

"""

1158

1159

821

def decorator(func):

1160

822

func._dbus_is_interface = True

1161

823

func._dbus_interface = dbus_interface

1162

824

func._dbus_name = dbus_interface

1163

825

return func

1164

1165

826

return decorator

1166

827

1167

828

1168

829

def dbus_annotations(annotations):

1169

830

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

1170

831

Usage:

1171

1172

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

1173

"org.freedesktop.DBus.Property."

1174

"EmitsChangedSignal": "false"})

832

1175

833

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

1176

834

access="r")

835

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

836

"org.freedesktop.DBus.Property."

837

"EmitsChangedSignal": "false"})

1177

838

def Property_dbus_property(self):

1178

839

return dbus.Boolean(False)

1179

1180

See also the DBusObjectWithAnnotations class.

1181

840

"""

1182

1183

841

def decorator(func):

1184

842

func._dbus_annotations = annotations

1185

843

return func

1186

1187

844

return decorator

1188

845

1189

846

1190

847

class DBusPropertyException(dbus.exceptions.DBusException):

1191

848

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

1192

849

"""

1193

pass

850

def __unicode__(self):

851

return unicode(str(self))

1194

852

1195

853

1196

854

class DBusPropertyAccessException(DBusPropertyException):

1205

863

pass

1206

864

1207

865

1208

class DBusObjectWithAnnotations(dbus.service.Object):

1209

"""A D-Bus object with annotations.

1210

1211

Classes inheriting from this can use the dbus_annotations

1212

decorator to add annotations to methods or signals.

866

class DBusObjectWithProperties(dbus.service.Object):

867

"""A D-Bus object with properties.

868

869

Classes inheriting from this can use the dbus_service_property

870

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

871

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

1213

872

"""

1214

873

1215

874

@staticmethod

1216

875

def _is_dbus_thing(thing):

1217

876

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

1218

877

1219

878

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

1220

879

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

1221

880

"""

1222

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

881

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

1223

882

False)

1224

883

1225

884

def _get_all_dbus_things(self, thing):

1226

885

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

1227

886

"""

1228

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

887

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

888

name),

1229

889

athing.__get__(self))

1230

890

for cls in self.__class__.__mro__

1231

891

for name, athing in

1232

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

1233

1234

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1235

out_signature="s",

1236

path_keyword='object_path',

1237

connection_keyword='connection')

1238

def Introspect(self, object_path, connection):

1239

"""Overloading of standard D-Bus method.

1240

1241

Inserts annotation tags on methods and signals.

1242

"""

1243

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

1244

connection)

1245

try:

1246

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

1247

1248

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

1249

# Add annotation tags

1250

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

1251

for tag in if_tag.getElementsByTagName(typ):

1252

annots = dict()

1253

for name, prop in (self.

1254

_get_all_dbus_things(typ)):

1255

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

1256

and prop._dbus_interface

1257

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

1258

annots.update(getattr(

1259

prop, "_dbus_annotations", {}))

1260

for name, value in annots.items():

1261

ann_tag = document.createElement(

1262

"annotation")

1263

ann_tag.setAttribute("name", name)

1264

ann_tag.setAttribute("value", value)

1265

tag.appendChild(ann_tag)

1266

# Add interface annotation tags

1267

for annotation, value in dict(

1268

itertools.chain.from_iterable(

1269

annotations().items()

1270

for name, annotations

1271

in self._get_all_dbus_things("interface")

1272

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

1273

)).items():

1274

ann_tag = document.createElement("annotation")

1275

ann_tag.setAttribute("name", annotation)

1276

ann_tag.setAttribute("value", value)

1277

if_tag.appendChild(ann_tag)

1278

# Fix argument name for the Introspect method itself

1279

if (if_tag.getAttribute("name")

1280

== dbus.INTROSPECTABLE_IFACE):

1281

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

1282

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

1283

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

1284

if (arg.getAttribute("direction")

1285

== "out"):

1286

arg.setAttribute("name",

1287

"xml_data")

1288

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

1289

document.unlink()

1290

except (AttributeError, xml.dom.DOMException,

1291

xml.parsers.expat.ExpatError) as error:

1292

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

1293

exc_info=error)

1294

return xmlstring

1295

1296

1297

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1298

"""A D-Bus object with properties.

1299

1300

Classes inheriting from this can use the dbus_service_property

1301

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

1302

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

1303

"""

1304

892

inspect.getmembers(cls,

893

self._is_dbus_thing(thing)))

894

1305

895

def _get_dbus_property(self, interface_name, property_name):

1306

896

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

1307

897

property with the specified name and interface.

1308

898

"""

1309

for cls in self.__class__.__mro__:

1310

for name, value in inspect.getmembers(

1311

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

899

for cls in self.__class__.__mro__:

900

for name, value in (inspect.getmembers

901

(cls,

902

self._is_dbus_thing("property"))):

1312

903

if (value._dbus_name == property_name

1313

904

and value._dbus_interface == interface_name):

1314

905

return value.__get__(self)

1315

906

1316

907

# No such property

1317

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

1318

self.dbus_object_path, interface_name, property_name))

1319

1320

@classmethod

1321

def _get_all_interface_names(cls):

1322

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

1323

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

1324

"_dbus_interface", None)

1325

for x in (inspect.getmro(cls))

1326

for attr in dir(x))

1327

if name is not None)

1328

1329

@dbus.service.method(dbus.PROPERTIES_IFACE,

1330

in_signature="ss",

908

raise DBusPropertyNotFound(self.dbus_object_path + ":"

909

+ interface_name + "."

910

+ property_name)

911

912

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

1331

913

out_signature="v")

1332

914

def Get(self, interface_name, property_name):

1333

915

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

1339

921

if not hasattr(value, "variant_level"):

1340

922

return value

1341

923

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

1342

924

1343

925

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

1344

926

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

1345

927

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

1351

933

# The byte_arrays option is not supported yet on

1352

934

# signatures other than "ay".

1353

935

if prop._dbus_signature != "ay":

1354

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

1355

"'ay' signature {!r}"

1356

.format(prop._dbus_signature))

936

raise ValueError

1357

937

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

1358

938

for byte in value))

1359

939

prop(value)

1360

1361

@dbus.service.method(dbus.PROPERTIES_IFACE,

1362

in_signature="s",

940

941

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

1363

942

out_signature="a{sv}")

1364

943

def GetAll(self, interface_name):

1365

944

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

1366

945

standard.

1367

946

1368

947

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

1369

948

"""

1370

949

properties = {}

1380

959

if not hasattr(value, "variant_level"):

1381

960

properties[name] = value

1382

961

continue

1383

properties[name] = type(value)(

1384

value, variant_level=value.variant_level + 1)

962

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

963

value.variant_level+1)

1385

964

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

1386

1387

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

1388

def PropertiesChanged(self, interface_name, changed_properties,

1389

invalidated_properties):

1390

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

1391

standard.

1392

"""

1393

pass

1394

965

1395

966

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1396

967

out_signature="s",

1397

968

path_keyword='object_path',

1398

969

connection_keyword='connection')

1399

970

def Introspect(self, object_path, connection):

1400

971

"""Overloading of standard D-Bus method.

1401

972

1402

973

Inserts property tags and interface annotation tags.

1403

974

"""

1404

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1405

object_path,

1406

connection)

975

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

976

connection)

1407

977

try:

1408

978

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

1409

1410

979

def make_tag(document, name, prop):

1411

980

e = document.createElement("property")

1412

981

e.setAttribute("name", name)

1413

982

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

1414

983

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

1415

984

return e

1416

1417

985

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

1418

986

# Add property tags

1419

987

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

1422

990

if prop._dbus_interface

1423

991

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

1424

992

if_tag.appendChild(tag)

1425

# Add annotation tags for properties

1426

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

1427

annots = dict()

1428

for name, prop in self._get_all_dbus_things(

1429

"property"):

1430

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

1431

and prop._dbus_interface

1432

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

1433

annots.update(getattr(

1434

prop, "_dbus_annotations", {}))

1435

for name, value in annots.items():

1436

ann_tag = document.createElement(

1437

"annotation")

1438

ann_tag.setAttribute("name", name)

1439

ann_tag.setAttribute("value", value)

1440

tag.appendChild(ann_tag)

993

# Add annotation tags

994

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

995

for tag in if_tag.getElementsByTagName(typ):

996

annots = dict()

997

for name, prop in (self.

998

_get_all_dbus_things(typ)):

999

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

1000

and prop._dbus_interface

1001

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

1002

annots.update(getattr

1003

(prop,

1004

"_dbus_annotations",

1005

{}))

1006

for name, value in annots.iteritems():

1007

ann_tag = document.createElement(

1008

"annotation")

1009

ann_tag.setAttribute("name", name)

1010

ann_tag.setAttribute("value", value)

1011

tag.appendChild(ann_tag)

1012

# Add interface annotation tags

1013

for annotation, value in dict(

1014

itertools.chain.from_iterable(

1015

annotations().iteritems()

1016

for name, annotations in

1017

self._get_all_dbus_things("interface")

1018

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

1019

)).iteritems():

1020

ann_tag = document.createElement("annotation")

1021

ann_tag.setAttribute("name", annotation)

1022

ann_tag.setAttribute("value", value)

1023

if_tag.appendChild(ann_tag)

1441

1024

# Add the names to the return values for the

1442

1025

# "org.freedesktop.DBus.Properties" methods

1443

1026

if (if_tag.getAttribute("name")

1462

1045

return xmlstring

1463

1046

1464

1047

1465

try:

1466

dbus.OBJECT_MANAGER_IFACE

1467

except AttributeError:

1468

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

1469

1470

1471

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1472

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

1473

1474

Classes inheriting from this exposes the standard

1475

GetManagedObjects call and the InterfacesAdded and

1476

InterfacesRemoved signals on the standard

1477

"org.freedesktop.DBus.ObjectManager" interface.

1478

1479

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

1480

manually.

1481

"""

1482

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1483

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

1484

def GetManagedObjects(self):

1485

"""This function must be overridden"""

1486

raise NotImplementedError()

1487

1488

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1489

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

1490

def InterfacesAdded(self, object_path, interfaces_and_properties):

1491

pass

1492

1493

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

1494

def InterfacesRemoved(self, object_path, interfaces):

1495

pass

1496

1497

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1498

out_signature="s",

1499

path_keyword='object_path',

1500

connection_keyword='connection')

1501

def Introspect(self, object_path, connection):

1502

"""Overloading of standard D-Bus method.

1503

1504

Override return argument name of GetManagedObjects to be

1505

"objpath_interfaces_and_properties"

1506

"""

1507

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1508

object_path,

1509

connection)

1510

try:

1511

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

1512

1513

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

1514

# Fix argument name for the GetManagedObjects method

1515

if (if_tag.getAttribute("name")

1516

== dbus.OBJECT_MANAGER_IFACE):

1517

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

1518

if (cn.getAttribute("name")

1519

== "GetManagedObjects"):

1520

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

1521

if (arg.getAttribute("direction")

1522

== "out"):

1523

arg.setAttribute(

1524

"name",

1525

"objpath_interfaces"

1526

"_and_properties")

1527

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

1528

document.unlink()

1529

except (AttributeError, xml.dom.DOMException,

1530

xml.parsers.expat.ExpatError) as error:

1531

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

1532

exc_info=error)

1533

return xmlstring

1534

1535

1536

1048

def datetime_to_dbus(dt, variant_level=0):

1537

1049

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

1538

1050

if dt is None:

1539

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

1540

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

1051

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

1052

return dbus.String(dt.isoformat(),

1053

variant_level=variant_level)

1541

1054

1542

1055

1543

1056

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1545

1058

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

1546

1059

interface names according to the "alt_interface_names" mapping.

1547

1060

Usage:

1548

1061

1549

1062

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

1550

1063

"net.example.AlternateInterface"})

1551

1064

class SampleDBusObject(dbus.service.Object):

1552

1065

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

1553

1066

def SampleDBusMethod():

1554

1067

pass

1555

1068

1556

1069

The above "SampleDBusMethod" on "SampleDBusObject" will be

1557

1070

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

1558

1071

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

1559

1072

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

1560

1073

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

1561

1074

1562

1075

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

1563

1076

(from DBusObjectWithProperties) and interfaces (from the

1564

1077

dbus_interface_annotations decorator).

1565

1078

"""

1566

1567

1079

def wrapper(cls):

1568

1080

for orig_interface_name, alt_interface_name in (

1569

alt_interface_names.items()):

1081

alt_interface_names.iteritems()):

1570

1082

attr = {}

1571

1083

interface_names = set()

1572

1084

# Go though all attributes of the class

1574

1086

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

1575

1087

# with the wrong interface name

1576

1088

if (not hasattr(attribute, "_dbus_interface")

1577

or not attribute._dbus_interface.startswith(

1578

orig_interface_name)):

1089

or not attribute._dbus_interface

1090

.startswith(orig_interface_name)):

1579

1091

continue

1580

1092

# Create an alternate D-Bus interface name based on

1581

1093

# the current name

1582

alt_interface = attribute._dbus_interface.replace(

1583

orig_interface_name, alt_interface_name)

1094

alt_interface = (attribute._dbus_interface

1095

.replace(orig_interface_name,

1096

alt_interface_name))

1584

1097

interface_names.add(alt_interface)

1585

1098

# Is this a D-Bus signal?

1586

1099

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

1587

1100

# Extract the original non-method undecorated

1588

1101

# function by black magic

1589

if sys.version_info.major == 2:

1590

nonmethod_func = (dict(

1102

nonmethod_func = (dict(

1591

1103

zip(attribute.func_code.co_freevars,

1592

attribute.__closure__))

1593

["func"].cell_contents)

1594

else:

1595

nonmethod_func = (dict(

1596

zip(attribute.__code__.co_freevars,

1597

attribute.__closure__))

1598

["func"].cell_contents)

1104

attribute.__closure__))["func"]

1105

.cell_contents)

1599

1106

# Create a new, but exactly alike, function

1600

1107

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

1601

1108

# with the alternate D-Bus interface name

1602

new_function = copy_function(nonmethod_func)

1603

new_function = (dbus.service.signal(

1604

alt_interface,

1605

attribute._dbus_signature)(new_function))

1109

new_function = (dbus.service.signal

1110

(alt_interface,

1111

attribute._dbus_signature)

1112

(types.FunctionType(

1113

nonmethod_func.func_code,

1114

nonmethod_func.func_globals,

1115

nonmethod_func.func_name,

1116

nonmethod_func.func_defaults,

1117

nonmethod_func.func_closure)))

1606

1118

# Copy annotations, if any

1607

1119

try:

1608

new_function._dbus_annotations = dict(

1609

attribute._dbus_annotations)

1120

new_function._dbus_annotations = (

1121

dict(attribute._dbus_annotations))

1610

1122

except AttributeError:

1611

1123

pass

1612

1613

1124

# Define a creator of a function to call both the

1614

1125

# original and alternate functions, so both the

1615

1126

# original and alternate signals gets sent when

1618

1129

"""This function is a scope container to pass

1619

1130

func1 and func2 to the "call_both" function

1620

1131

outside of its arguments"""

1621

1622

@functools.wraps(func2)

1623

1132

def call_both(*args, **kwargs):

1624

1133

"""This function will emit two D-Bus

1625

1134

signals by calling func1 and func2"""

1626

1135

func1(*args, **kwargs)

1627

1136

func2(*args, **kwargs)

1628

# Make wrapper function look like a D-Bus

1629

# signal

1630

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

1631

if name.startswith("_dbus_"):

1632

setattr(call_both, name, attr)

1633

1634

1137

return call_both

1635

1138

# Create the "call_both" function and add it to

1636

1139

# the class

1641

1144

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

1642

1145

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

1643

1146

# to the class.

1644

attr[attrname] = (

1645

dbus.service.method(

1646

alt_interface,

1647

attribute._dbus_in_signature,

1648

attribute._dbus_out_signature)

1649

(copy_function(attribute)))

1147

attr[attrname] = (dbus.service.method

1148

(alt_interface,

1149

attribute._dbus_in_signature,

1150

attribute._dbus_out_signature)

1151

(types.FunctionType

1152

(attribute.func_code,

1153

attribute.func_globals,

1154

attribute.func_name,

1155

attribute.func_defaults,

1156

attribute.func_closure)))

1650

1157

# Copy annotations, if any

1651

1158

try:

1652

attr[attrname]._dbus_annotations = dict(

1653

attribute._dbus_annotations)

1159

attr[attrname]._dbus_annotations = (

1160

dict(attribute._dbus_annotations))

1654

1161

except AttributeError:

1655

1162

pass

1656

1163

# Is this a D-Bus property?

1659

1166

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

1660

1167

# property with the alternate D-Bus interface

1661

1168

# name. Add it to the class.

1662

attr[attrname] = (dbus_service_property(

1663

alt_interface, attribute._dbus_signature,

1664

attribute._dbus_access,

1665

attribute._dbus_get_args_options

1666

["byte_arrays"])

1667

(copy_function(attribute)))

1169

attr[attrname] = (dbus_service_property

1170

(alt_interface,

1171

attribute._dbus_signature,

1172

attribute._dbus_access,

1173

attribute

1174

._dbus_get_args_options

1175

["byte_arrays"])

1176

(types.FunctionType

1177

(attribute.func_code,

1178

attribute.func_globals,

1179

attribute.func_name,

1180

attribute.func_defaults,

1181

attribute.func_closure)))

1668

1182

# Copy annotations, if any

1669

1183

try:

1670

attr[attrname]._dbus_annotations = dict(

1671

attribute._dbus_annotations)

1184

attr[attrname]._dbus_annotations = (

1185

dict(attribute._dbus_annotations))

1672

1186

except AttributeError:

1673

1187

pass

1674

1188

# Is this a D-Bus interface?

1677

1191

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

1678

1192

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

1679

1193

# to the class.

1680

attr[attrname] = (

1681

dbus_interface_annotations(alt_interface)

1682

(copy_function(attribute)))

1194

attr[attrname] = (dbus_interface_annotations

1195

(alt_interface)

1196

(types.FunctionType

1197

(attribute.func_code,

1198

attribute.func_globals,

1199

attribute.func_name,

1200

attribute.func_defaults,

1201

attribute.func_closure)))

1683

1202

if deprecate:

1684

1203

# Deprecate all alternate interfaces

1685

iname = "_AlternateDBusNames_interface_annotation{}"

1204

iname="_AlternateDBusNames_interface_annotation{0}"

1686

1205

for interface_name in interface_names:

1687

1688

1206

@dbus_interface_annotations(interface_name)

1689

1207

def func(self):

1690

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

1691

"true"}

1208

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

1209

"true" }

1692

1210

# Find an unused name

1693

1211

for aname in (iname.format(i)

1694

1212

for i in itertools.count()):

1698

1216

if interface_names:

1699

1217

# Replace the class with a new subclass of it with

1700

1218

# methods, signals, etc. as created above.

1701

if sys.version_info.major == 2:

1702

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

1703

(cls, ), attr)

1704

else:

1705

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

1706

(cls, ), attr)

1219

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

1220

(cls,), attr)

1707

1221

return cls

1708

1709

1222

return wrapper

1710

1223

1711

1224

1712

1225

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

1713

"se.bsnet.fukt.Mandos"})

1226

"se.bsnet.fukt.Mandos"})

1714

1227

class ClientDBus(Client, DBusObjectWithProperties):

1715

1228

"""A Client class using D-Bus

1716

1229

1717

1230

Attributes:

1718

1231

dbus_object_path: dbus.ObjectPath

1719

1232

bus: dbus.SystemBus()

1720

1233

"""

1721

1234

1722

1235

runtime_expansions = (Client.runtime_expansions

1723

+ ("dbus_object_path", ))

1724

1725

_interface = "se.recompile.Mandos.Client"

1726

1236

+ ("dbus_object_path",))

1237

1727

1238

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

1728

1729

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

1239

1240

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

1730

1241

self.bus = bus

1731

1242

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

1732

1243

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

1733

1244

# the D-Bus

1734

client_object_name = str(self.name).translate(

1245

client_object_name = unicode(self.name).translate(

1735

1246

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

1736

1247

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

1737

self.dbus_object_path = dbus.ObjectPath(

1738

"/clients/" + client_object_name)

1248

self.dbus_object_path = (dbus.ObjectPath

1249

("/clients/" + client_object_name))

1739

1250

DBusObjectWithProperties.__init__(self, self.bus,

1740

1251

self.dbus_object_path)

1741

1742

def notifychangeproperty(transform_func, dbus_name,

1743

type_func=lambda x: x,

1744

variant_level=1,

1745

invalidate_only=False,

1746

_interface=_interface):

1252

1253

def notifychangeproperty(transform_func,

1254

dbus_name, type_func=lambda x: x,

1255

variant_level=1):

1747

1256

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

1748

1257

its changes to DBus.

1749

1258

1750

1259

transform_fun: Function that takes a value and a variant_level

1751

1260

and transforms it to a D-Bus type.

1752

1261

dbus_name: D-Bus name of the variable

1754

1263

to the D-Bus. Default: no transform

1755

1264

variant_level: D-Bus variant level. Default: 1

1756

1265

"""

1757

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

1758

1266

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

1759

1267

def setter(self, value):

1760

1268

if hasattr(self, "dbus_object_path"):

1761

1269

if (not hasattr(self, attrname) or

1762

1270

type_func(getattr(self, attrname, None))

1763

1271

!= type_func(value)):

1764

if invalidate_only:

1765

self.PropertiesChanged(

1766

_interface, dbus.Dictionary(),

1767

dbus.Array((dbus_name, )))

1768

else:

1769

dbus_value = transform_func(

1770

type_func(value),

1771

variant_level=variant_level)

1772

self.PropertyChanged(dbus.String(dbus_name),

1773

dbus_value)

1774

self.PropertiesChanged(

1775

_interface,

1776

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

1777

dbus_value}),

1778

dbus.Array())

1272

dbus_value = transform_func(type_func(value),

1273

variant_level

1274

=variant_level)

1275

self.PropertyChanged(dbus.String(dbus_name),

1276

dbus_value)

1779

1277

setattr(self, attrname, value)

1780

1278

1781

1279

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

1782

1280

1783

1281

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1784

1282

approvals_pending = notifychangeproperty(dbus.Boolean,

1785

1283

"ApprovalPending",

1786

type_func=bool)

1284

type_func = bool)

1787

1285

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

1788

1286

last_enabled = notifychangeproperty(datetime_to_dbus,

1789

1287

"LastEnabled")

1790

checker = notifychangeproperty(

1791

dbus.Boolean, "CheckerRunning",

1792

type_func=lambda checker: checker is not None)

1288

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

1289

type_func = lambda checker:

1290

checker is not None)

1793

1291

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1794

1292

"LastCheckedOK")

1795

1293

last_checker_status = notifychangeproperty(dbus.Int16,

1798

1296

datetime_to_dbus, "LastApprovalRequest")

1799

1297

approved_by_default = notifychangeproperty(dbus.Boolean,

1800

1298

"ApprovedByDefault")

1801

approval_delay = notifychangeproperty(

1802

dbus.UInt64, "ApprovalDelay",

1803

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

1299

approval_delay = notifychangeproperty(dbus.UInt64,

1300

"ApprovalDelay",

1301

type_func =

1302

timedelta_to_milliseconds)

1804

1303

approval_duration = notifychangeproperty(

1805

1304

dbus.UInt64, "ApprovalDuration",

1806

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

1305

type_func = timedelta_to_milliseconds)

1807

1306

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

1808

timeout = notifychangeproperty(

1809

dbus.UInt64, "Timeout",

1810

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

1307

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

1308

type_func =

1309

timedelta_to_milliseconds)

1811

1310

extended_timeout = notifychangeproperty(

1812

1311

dbus.UInt64, "ExtendedTimeout",

1813

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

1814

interval = notifychangeproperty(

1815

dbus.UInt64, "Interval",

1816

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

1312

type_func = timedelta_to_milliseconds)

1313

interval = notifychangeproperty(dbus.UInt64,

1314

"Interval",

1315

type_func =

1316

timedelta_to_milliseconds)

1817

1317

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

1818

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

1819

invalidate_only=True)

1820

1318

1821

1319

del notifychangeproperty

1822

1320

1823

1321

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

1824

1322

try:

1825

1323

self.remove_from_connection()

1828

1326

if hasattr(DBusObjectWithProperties, "__del__"):

1829

1327

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

1830

1328

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

1831

1832

def checker_callback(self, source, condition,

1833

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

1834

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

1835

connection, command, *args,

1836

**kwargs)

1837

exitstatus = self.last_checker_status

1838

if exitstatus >= 0:

1329

1330

def checker_callback(self, pid, condition, command,

1331

*args, **kwargs):

1332

self.checker_callback_tag = None

1333

self.checker = None

1334

if os.WIFEXITED(condition):

1335

exitstatus = os.WEXITSTATUS(condition)

1839

1336

# Emit D-Bus signal

1840

1337

self.CheckerCompleted(dbus.Int16(exitstatus),

1841

# This is specific to GNU libC

1842

dbus.Int64(exitstatus << 8),

1338

dbus.Int64(condition),

1843

1339

dbus.String(command))

1844

1340

else:

1845

1341

# Emit D-Bus signal

1846

1342

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

1847

dbus.Int64(

1848

# This is specific to GNU libC

1849

(exitstatus << 8)

1850

| self.last_checker_signal),

1343

dbus.Int64(condition),

1851

1344

dbus.String(command))

1852

return ret

1853

1345

1346

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

1347

*args, **kwargs)

1348

1854

1349

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

1855

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

1350

old_checker = self.checker

1351

if self.checker is not None:

1352

old_checker_pid = self.checker.pid

1353

else:

1354

old_checker_pid = None

1856

1355

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

1857

1356

# Only if new checker process was started

1858

1357

if (self.checker is not None

1860

1359

# Emit D-Bus signal

1861

1360

self.CheckerStarted(self.current_checker_command)

1862

1361

return r

1863

1362

1864

1363

def _reset_approved(self):

1865

1364

self.approved = None

1866

1365

return False

1867

1366

1868

1367

def approve(self, value=True):

1869

1368

self.approved = value

1870

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

1871

* 1000), self._reset_approved)

1369

gobject.timeout_add(timedelta_to_milliseconds

1370

(self.approval_duration),

1371

self._reset_approved)

1872

1372

self.send_changedstate()

1873

1874

# D-Bus methods, signals & properties

1875

1876

# Interfaces

1877

1878

# Signals

1879

1373

1374

## D-Bus methods, signals & properties

1375

_interface = "se.recompile.Mandos.Client"

1376

1377

## Interfaces

1378

1379

@dbus_interface_annotations(_interface)

1380

def _foo(self):

1381

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

1382

"false"}

1383

1384

## Signals

1385

1880

1386

# CheckerCompleted - signal

1881

1387

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

1882

1388

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

1883

1389

"D-Bus signal"

1884

1390

pass

1885

1391

1886

1392

# CheckerStarted - signal

1887

1393

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

1888

1394

def CheckerStarted(self, command):

1889

1395

"D-Bus signal"

1890

1396

pass

1891

1397

1892

1398

# PropertyChanged - signal

1893

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

1894

1399

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

1895

1400

def PropertyChanged(self, property, value):

1896

1401

"D-Bus signal"

1897

1402

pass

1898

1403

1899

1404

# GotSecret - signal

1900

1405

@dbus.service.signal(_interface)

1901

1406

def GotSecret(self):

1904

1409

server to mandos-client

1905

1410

"""

1906

1411

pass

1907

1412

1908

1413

# Rejected - signal

1909

1414

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

1910

1415

def Rejected(self, reason):

1911

1416

"D-Bus signal"

1912

1417

pass

1913

1418

1914

1419

# NeedApproval - signal

1915

1420

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

1916

1421

def NeedApproval(self, timeout, default):

1917

1422

"D-Bus signal"

1918

1423

return self.need_approval()

1919

1920

# Methods

1921

1424

1425

## Methods

1426

1922

1427

# Approve - method

1923

1428

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

1924

1429

def Approve(self, value):

1925

1430

self.approve(value)

1926

1431

1927

1432

# CheckedOK - method

1928

1433

@dbus.service.method(_interface)

1929

1434

def CheckedOK(self):

1930

1435

self.checked_ok()

1931

1436

1932

1437

# Enable - method

1933

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

1934

1438

@dbus.service.method(_interface)

1935

1439

def Enable(self):

1936

1440

"D-Bus method"

1937

1441

self.enable()

1938

1442

1939

1443

# StartChecker - method

1940

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

1941

1444

@dbus.service.method(_interface)

1942

1445

def StartChecker(self):

1943

1446

"D-Bus method"

1944

1447

self.start_checker()

1945

1448

1946

1449

# Disable - method

1947

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

1948

1450

@dbus.service.method(_interface)

1949

1451

def Disable(self):

1950

1452

"D-Bus method"

1951

1453

self.disable()

1952

1454

1953

1455

# StopChecker - method

1954

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

1955

1456

@dbus.service.method(_interface)

1956

1457

def StopChecker(self):

1957

1458

self.stop_checker()

1958

1959

# Properties

1960

1459

1460

## Properties

1461

1961

1462

# ApprovalPending - property

1962

1463

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

1963

1464

def ApprovalPending_dbus_property(self):

1964

1465

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

1965

1466

1966

1467

# ApprovedByDefault - property

1967

@dbus_service_property(_interface,

1968

signature="b",

1468

@dbus_service_property(_interface, signature="b",

1969

1469

access="readwrite")

1970

1470

def ApprovedByDefault_dbus_property(self, value=None):

1971

1471

if value is None: # get

1972

1472

return dbus.Boolean(self.approved_by_default)

1973

1473

self.approved_by_default = bool(value)

1974

1474

1975

1475

# ApprovalDelay - property

1976

@dbus_service_property(_interface,

1977

signature="t",

1476

@dbus_service_property(_interface, signature="t",

1978

1477

access="readwrite")

1979

1478

def ApprovalDelay_dbus_property(self, value=None):

1980

1479

if value is None: # get

1981

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

1982

* 1000)

1480

return dbus.UInt64(self.approval_delay_milliseconds())

1983

1481

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

1984

1482

1985

1483

# ApprovalDuration - property

1986

@dbus_service_property(_interface,

1987

signature="t",

1484

@dbus_service_property(_interface, signature="t",

1988

1485

access="readwrite")

1989

1486

def ApprovalDuration_dbus_property(self, value=None):

1990

1487

if value is None: # get

1991

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

1992

* 1000)

1488

return dbus.UInt64(timedelta_to_milliseconds(

1489

self.approval_duration))

1993

1490

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

1994

1491

1995

1492

# Name - property

1996

@dbus_annotations(

1997

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

1998

1493

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

1999

1494

def Name_dbus_property(self):

2000

1495

return dbus.String(self.name)

2001

1496

2002

1497

# Fingerprint - property

2003

@dbus_annotations(

2004

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

2005

1498

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

2006

1499

def Fingerprint_dbus_property(self):

2007

1500

return dbus.String(self.fingerprint)

2008

1501

2009

1502

# Host - property

2010

@dbus_service_property(_interface,

2011

signature="s",

1503

@dbus_service_property(_interface, signature="s",

2012

1504

access="readwrite")

2013

1505

def Host_dbus_property(self, value=None):

2014

1506

if value is None: # get

2015

1507

return dbus.String(self.host)

2016

self.host = str(value)

2017

1508

self.host = unicode(value)

1509

2018

1510

# Created - property

2019

@dbus_annotations(

2020

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

2021

1511

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

2022

1512

def Created_dbus_property(self):

2023

1513

return datetime_to_dbus(self.created)

2024

1514

2025

1515

# LastEnabled - property

2026

1516

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

2027

1517

def LastEnabled_dbus_property(self):

2028

1518

return datetime_to_dbus(self.last_enabled)

2029

1519

2030

1520

# Enabled - property

2031

@dbus_service_property(_interface,

2032

signature="b",

1521

@dbus_service_property(_interface, signature="b",

2033

1522

access="readwrite")

2034

1523

def Enabled_dbus_property(self, value=None):

2035

1524

if value is None: # get

2038

1527

self.enable()

2039

1528

else:

2040

1529

self.disable()

2041

1530

2042

1531

# LastCheckedOK - property

2043

@dbus_service_property(_interface,

2044

signature="s",

1532

@dbus_service_property(_interface, signature="s",

2045

1533

access="readwrite")

2046

1534

def LastCheckedOK_dbus_property(self, value=None):

2047

1535

if value is not None:

2048

1536

self.checked_ok()

2049

1537

return

2050

1538

return datetime_to_dbus(self.last_checked_ok)

2051

1539

2052

1540

# LastCheckerStatus - property

2053

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

1541

@dbus_service_property(_interface, signature="n",

1542

access="read")

2054

1543

def LastCheckerStatus_dbus_property(self):

2055

1544

return dbus.Int16(self.last_checker_status)

2056

1545

2057

1546

# Expires - property

2058

1547

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

2059

1548

def Expires_dbus_property(self):

2060

1549

return datetime_to_dbus(self.expires)

2061

1550

2062

1551

# LastApprovalRequest - property

2063

1552

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

2064

1553

def LastApprovalRequest_dbus_property(self):

2065

1554

return datetime_to_dbus(self.last_approval_request)

2066

1555

2067

1556

# Timeout - property

2068

@dbus_service_property(_interface,

2069

signature="t",

1557

@dbus_service_property(_interface, signature="t",

2070

1558

access="readwrite")

2071

1559

def Timeout_dbus_property(self, value=None):

2072

1560

if value is None: # get

2073

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

1561

return dbus.UInt64(self.timeout_milliseconds())

2074

1562

old_timeout = self.timeout

2075

1563

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

2076

1564

# Reschedule disabling

2084

1572

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

2085

1573

is None):

2086

1574

return

2087

GLib.source_remove(self.disable_initiator_tag)

2088

self.disable_initiator_tag = GLib.timeout_add(

2089

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

2090

self.disable)

2091

1575

gobject.source_remove(self.disable_initiator_tag)

1576

self.disable_initiator_tag = (

1577

gobject.timeout_add(

1578

timedelta_to_milliseconds(self.expires - now),

1579

self.disable))

1580

2092

1581

# ExtendedTimeout - property

2093

@dbus_service_property(_interface,

2094

signature="t",

1582

@dbus_service_property(_interface, signature="t",

2095

1583

access="readwrite")

2096

1584

def ExtendedTimeout_dbus_property(self, value=None):

2097

1585

if value is None: # get

2098

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

2099

* 1000)

1586

return dbus.UInt64(self.extended_timeout_milliseconds())

2100

1587

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

2101

1588

2102

1589

# Interval - property

2103

@dbus_service_property(_interface,

2104

signature="t",

1590

@dbus_service_property(_interface, signature="t",

2105

1591

access="readwrite")

2106

1592

def Interval_dbus_property(self, value=None):

2107

1593

if value is None: # get

2108

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

1594

return dbus.UInt64(self.interval_milliseconds())

2109

1595

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

2110

1596

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

2111

1597

return

2112

1598

if self.enabled:

2113

1599

# Reschedule checker run

2114

GLib.source_remove(self.checker_initiator_tag)

2115

self.checker_initiator_tag = GLib.timeout_add(

2116

value, self.start_checker)

2117

self.start_checker() # Start one now, too

2118

1600

gobject.source_remove(self.checker_initiator_tag)

1601

self.checker_initiator_tag = (gobject.timeout_add

1602

(value, self.start_checker))

1603

self.start_checker() # Start one now, too

1604

2119

1605

# Checker - property

2120

@dbus_service_property(_interface,

2121

signature="s",

1606

@dbus_service_property(_interface, signature="s",

2122

1607

access="readwrite")

2123

1608

def Checker_dbus_property(self, value=None):

2124

1609

if value is None: # get

2125

1610

return dbus.String(self.checker_command)

2126

self.checker_command = str(value)

2127

1611

self.checker_command = unicode(value)

1612

2128

1613

# CheckerRunning - property

2129

@dbus_service_property(_interface,

2130

signature="b",

1614

@dbus_service_property(_interface, signature="b",

2131

1615

access="readwrite")

2132

1616

def CheckerRunning_dbus_property(self, value=None):

2133

1617

if value is None: # get

2136

1620

self.start_checker()

2137

1621

else:

2138

1622

self.stop_checker()

2139

1623

2140

1624

# ObjectPath - property

2141

@dbus_annotations(

2142

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

2143

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

2144

1625

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

2145

1626

def ObjectPath_dbus_property(self):

2146

return self.dbus_object_path # is already a dbus.ObjectPath

2147

1627

return self.dbus_object_path # is already a dbus.ObjectPath

1628

2148

1629

# Secret = property

2149

@dbus_annotations(

2150

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

2151

"invalidates"})

2152

@dbus_service_property(_interface,

2153

signature="ay",

2154

access="write",

2155

byte_arrays=True)

1630

@dbus_service_property(_interface, signature="ay",

1631

access="write", byte_arrays=True)

2156

1632

def Secret_dbus_property(self, value):

2157

self.secret = bytes(value)

2158

1633

self.secret = str(value)

1634

2159

1635

del _interface

2160

1636

2161

1637

2164

1640

self._pipe = child_pipe

2165

1641

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

2166

1642

if not self._pipe.recv():

2167

raise KeyError(fpr)

2168

1643

raise KeyError()

1644

2169

1645

def __getattribute__(self, name):

2170

1646

if name == '_pipe':

2171

1647

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

2174

1650

if data[0] == 'data':

2175

1651

return data[1]

2176

1652

if data[0] == 'function':

2177

2178

1653

def func(*args, **kwargs):

2179

1654

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

2180

1655

return self._pipe.recv()[1]

2181

2182

1656

return func

2183

1657

2184

1658

def __setattr__(self, name, value):

2185

1659

if name == '_pipe':

2186

1660

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

2189

1663

2190

1664

class ClientHandler(socketserver.BaseRequestHandler, object):

2191

1665

"""A class to handle client connections.

2192

1666

2193

1667

Instantiated once for each connection to handle it.

2194

1668

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

2195

1669

2196

1670

def handle(self):

2197

1671

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

2198

1672

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

2199

str(self.client_address))

1673

unicode(self.client_address))

2200

1674

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

2201

1675

self.server.child_pipe.fileno())

2202

2203

session = gnutls.ClientSession(self.request)

2204

2205

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

2206

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

2207

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

2208

# "+DHE-DSS"))

1676

1677

session = (gnutls.connection

1678

.ClientSession(self.request,

1679

gnutls.connection

1680

.X509Credentials()))

1681

1682

# Note: gnutls.connection.X509Credentials is really a

1683

# generic GnuTLS certificate credentials object so long as

1684

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

1685

# here despite using OpenPGP certificates.

1686

1687

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

1688

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

1689

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

1690

# "+DHE-DSS"))

2209

1691

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

2210

1692

priority = self.server.gnutls_priority

2211

1693

if priority is None:

2212

1694

priority = "NORMAL"

2213

gnutls.priority_set_direct(session._c_object,

2214

priority.encode("utf-8"),

2215

None)

2216

1695

(gnutls.library.functions

1696

.gnutls_priority_set_direct(session._c_object,

1697

priority, None))

1698

2217

1699

# Start communication using the Mandos protocol

2218

1700

# Get protocol number

2219

1701

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

2220

1702

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

2221

1703

try:

2222

1704

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

2223

raise RuntimeError(line)

1705

raise RuntimeError

2224

1706

except (ValueError, IndexError, RuntimeError) as error:

2225

1707

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

2226

1708

return

2227

1709

2228

1710

# Start GnuTLS connection

2229

1711

try:

2230

1712

session.handshake()

2231

except gnutls.Error as error:

1713

except gnutls.errors.GNUTLSError as error:

2232

1714

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

2233

1715

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

2234

1716

# established. Just abandon the request.

2235

1717

return

2236

1718

logger.debug("Handshake succeeded")

2237

1719

2238

1720

approval_required = False

2239

1721

try:

2240

1722

try:

2241

fpr = self.fingerprint(

2242

self.peer_certificate(session))

2243

except (TypeError, gnutls.Error) as error:

1723

fpr = self.fingerprint(self.peer_certificate

1724

(session))

1725

except (TypeError,

1726

gnutls.errors.GNUTLSError) as error:

2244

1727

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

2245

1728

return

2246

1729

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

2247

1730

2248

1731

try:

2249

1732

client = ProxyClient(child_pipe, fpr,

2250

1733

self.client_address)

2251

1734

except KeyError:

2252

1735

return

2253

1736

2254

1737

if client.approval_delay:

2255

1738

delay = client.approval_delay

2256

1739

client.approvals_pending += 1

2257

1740

approval_required = True

2258

1741

2259

1742

while True:

2260

1743

if not client.enabled:

2261

1744

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

2262

client.name)

1745

client.name)

2263

1746

if self.server.use_dbus:

2264

1747

# Emit D-Bus signal

2265

1748

client.Rejected("Disabled")

2266

1749

return

2267

1750

2268

1751

if client.approved or not client.approval_delay:

2269

# We are approved or approval is disabled

1752

#We are approved or approval is disabled

2270

1753

break

2271

1754

elif client.approved is None:

2272

1755

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

2274

1757

if self.server.use_dbus:

2275

1758

# Emit D-Bus signal

2276

1759

client.NeedApproval(

2277

client.approval_delay.total_seconds()

2278

* 1000, client.approved_by_default)

1760

client.approval_delay_milliseconds(),

1761

client.approved_by_default)

2279

1762

else:

2280

1763

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

2281

1764

client.name)

2283

1766

# Emit D-Bus signal

2284

1767

client.Rejected("Denied")

2285

1768

return

2286

2287

# wait until timeout or approved

1769

1770

#wait until timeout or approved

2288

1771

time = datetime.datetime.now()

2289

1772

client.changedstate.acquire()

2290

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

1773

client.changedstate.wait(

1774

float(timedelta_to_milliseconds(delay)

1775

/ 1000))

2291

1776

client.changedstate.release()

2292

1777

time2 = datetime.datetime.now()

2293

1778

if (time2 - time) >= delay:

2303

1788

break

2304

1789

else:

2305

1790

delay -= time2 - time

2306

2307

try:

2308

session.send(client.secret)

2309

except gnutls.Error as error:

2310

logger.warning("gnutls send failed",

2311

exc_info=error)

2312

return

2313

1791

1792

sent_size = 0

1793

while sent_size < len(client.secret):

1794

try:

1795

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

1796

except gnutls.errors.GNUTLSError as error:

1797

logger.warning("gnutls send failed",

1798

exc_info=error)

1799

return

1800

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

1801

sent, len(client.secret)

1802

- (sent_size + sent))

1803

sent_size += sent

1804

2314

1805

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

2315

1806

# bump the timeout using extended_timeout

2316

1807

client.bump_timeout(client.extended_timeout)

2317

1808

if self.server.use_dbus:

2318

1809

# Emit D-Bus signal

2319

1810

client.GotSecret()

2320

1811

2321

1812

finally:

2322

1813

if approval_required:

2323

1814

client.approvals_pending -= 1

2324

1815

try:

2325

1816

session.bye()

2326

except gnutls.Error as error:

1817

except gnutls.errors.GNUTLSError as error:

2327

1818

logger.warning("GnuTLS bye failed",

2328

1819

exc_info=error)

2329

1820

2330

1821

@staticmethod

2331

1822

def peer_certificate(session):

2332

1823

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

2333

1824

# If not an OpenPGP certificate...

2334

if (gnutls.certificate_type_get(session._c_object)

2335

!= gnutls.CRT_OPENPGP):

2336

# ...return invalid data

2337

return b""

1825

if (gnutls.library.functions

1826

.gnutls_certificate_type_get(session._c_object)

1827

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1828

# ...do the normal thing

1829

return session.peer_certificate

2338

1830

list_size = ctypes.c_uint(1)

2339

cert_list = (gnutls.certificate_get_peers

1831

cert_list = (gnutls.library.functions

1832

.gnutls_certificate_get_peers

2340

1833

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

2341

1834

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

2342

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

1835

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

1836

" certificate")

2343

1837

if list_size.value == 0:

2344

1838

return None

2345

1839

cert = cert_list[0]

2346

1840

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

2347

1841

2348

1842

@staticmethod

2349

1843

def fingerprint(openpgp):

2350

1844

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2351

1845

# New GnuTLS "datum" with the OpenPGP public key

2352

datum = gnutls.datum_t(

2353

ctypes.cast(ctypes.c_char_p(openpgp),

2354

ctypes.POINTER(ctypes.c_ubyte)),

2355

ctypes.c_uint(len(openpgp)))

1846

datum = (gnutls.library.types

1847

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

1848

ctypes.POINTER

1849

(ctypes.c_ubyte)),

1850

ctypes.c_uint(len(openpgp))))

2356

1851

# New empty GnuTLS certificate

2357

crt = gnutls.openpgp_crt_t()

2358

gnutls.openpgp_crt_init(ctypes.byref(crt))

1852

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1853

(gnutls.library.functions

1854

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2359

1855

# Import the OpenPGP public key into the certificate

2360

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

2361

gnutls.OPENPGP_FMT_RAW)

1856

(gnutls.library.functions

1857

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

1858

gnutls.library.constants

1859

.GNUTLS_OPENPGP_FMT_RAW))

2362

1860

# Verify the self signature in the key

2363

1861

crtverify = ctypes.c_uint()

2364

gnutls.openpgp_crt_verify_self(crt, 0,

2365

ctypes.byref(crtverify))

1862

(gnutls.library.functions

1863

.gnutls_openpgp_crt_verify_self(crt, 0,

1864

ctypes.byref(crtverify)))

2366

1865

if crtverify.value != 0:

2367

gnutls.openpgp_crt_deinit(crt)

2368

raise gnutls.CertificateSecurityError("Verify failed")

1866

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1867

raise (gnutls.errors.CertificateSecurityError

1868

("Verify failed"))

2369

1869

# New buffer for the fingerprint

2370

1870

buf = ctypes.create_string_buffer(20)

2371

1871

buf_len = ctypes.c_size_t()

2372

1872

# Get the fingerprint from the certificate into the buffer

2373

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

2374

ctypes.byref(buf_len))

1873

(gnutls.library.functions

1874

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

1875

ctypes.byref(buf_len)))

2375

1876

# Deinit the certificate

2376

gnutls.openpgp_crt_deinit(crt)

1877

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2377

1878

# Convert the buffer to a Python bytestring

2378

1879

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

2379

1880

# Convert the bytestring to hexadecimal notation

2383

1884

2384

1885

class MultiprocessingMixIn(object):

2385

1886

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

2386

2387

1887

def sub_process_main(self, request, address):

2388

1888

try:

2389

1889

self.finish_request(request, address)

2390

1890

except Exception:

2391

1891

self.handle_error(request, address)

2392

1892

self.close_request(request)

2393

1893

2394

1894

def process_request(self, request, address):

2395

1895

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

2396

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

2397

args=(request, address))

1896

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

1897

args = (request, address))

2398

1898

proc.start()

2399

1899

return proc

2400

1900

2401

1901

2402

1902

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2403

1903

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

2404

2405

1904

def process_request(self, request, client_address):

2406

1905

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

2407

1906

2408

1907

This function creates a new pipe in self.pipe

2409

1908

"""

2410

1909

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2411

1910

2412

1911

proc = MultiprocessingMixIn.process_request(self, request,

2413

1912

client_address)

2414

1913

self.child_pipe.close()

2415

1914

self.add_pipe(parent_pipe, proc)

2416

1915

2417

1916

def add_pipe(self, parent_pipe, proc):

2418

1917

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

2419

raise NotImplementedError()

1918

raise NotImplementedError

2420

1919

2421

1920

2422

1921

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2423

1922

socketserver.TCPServer, object):

2424

1923

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

2425

1924

2426

1925

Attributes:

2427

1926

enabled: Boolean; whether this server is activated yet

2428

1927

interface: None or a network interface name (string)

2429

1928

use_ipv6: Boolean; to use IPv6 or not

2430

1929

"""

2431

2432

1930

def __init__(self, server_address, RequestHandlerClass,

2433

interface=None,

2434

use_ipv6=True,

2435

socketfd=None):

1931

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

2436

1932

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

2437

1933

creating a new one with socket.socket().

2438

1934

"""

2444

1940

self.socketfd = socketfd

2445

1941

# Save the original socket.socket() function

2446

1942

self.socket_socket = socket.socket

2447

2448

1943

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

2449

#

1944

#

2450

1945

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

2451

1946

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

2452

1947

# patching socket.socket.)

2453

#

1948

#

2454

1949

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

2455

1950

@functools.wraps(socket.socket)

2456

1951

def socket_wrapper(*args, **kwargs):

2468

1963

# socket_wrapper(), if socketfd was set.

2469

1964

socketserver.TCPServer.__init__(self, server_address,

2470

1965

RequestHandlerClass)

2471

1966

2472

1967

def server_bind(self):

2473

1968

"""This overrides the normal server_bind() function

2474

1969

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

2475

1970

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

2476

global SO_BINDTODEVICE

2477

1971

if self.interface is not None:

2478

1972

if SO_BINDTODEVICE is None:

2479

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

2480

# common enough.

2481

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

2482

SO_BINDTODEVICE = 25

2483

try:

2484

self.socket.setsockopt(

2485

socket.SOL_SOCKET, SO_BINDTODEVICE,

2486

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

2487

except socket.error as error:

2488

if error.errno == errno.EPERM:

2489

logger.error("No permission to bind to"

2490

" interface %s", self.interface)

2491

elif error.errno == errno.ENOPROTOOPT:

2492

logger.error("SO_BINDTODEVICE not available;"

2493

" cannot bind to interface %s",

2494

self.interface)

2495

elif error.errno == errno.ENODEV:

2496

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

2497

" cannot bind", self.interface)

2498

else:

2499

raise

1973

logger.error("SO_BINDTODEVICE does not exist;"

1974

" cannot bind to interface %s",

1975

self.interface)

1976

else:

1977

try:

1978

self.socket.setsockopt(socket.SOL_SOCKET,

1979

SO_BINDTODEVICE,

1980

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

1981

except socket.error as error:

1982

if error.errno == errno.EPERM:

1983

logger.error("No permission to bind to"

1984

" interface %s", self.interface)

1985

elif error.errno == errno.ENOPROTOOPT:

1986

logger.error("SO_BINDTODEVICE not available;"

1987

" cannot bind to interface %s",

1988

self.interface)

1989

elif error.errno == errno.ENODEV:

1990

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

1991

" cannot bind", self.interface)

1992

else:

1993

raise

2500

1994

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

2501

1995

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

2502

1996

if not self.server_address[0]:

2503

1997

if self.address_family == socket.AF_INET6:

2504

any_address = "::" # in6addr_any

1998

any_address = "::" # in6addr_any

2505

1999

else:

2506

any_address = "0.0.0.0" # INADDR_ANY

2000

any_address = "0.0.0.0" # INADDR_ANY

2507

2001

self.server_address = (any_address,

2508

2002

self.server_address[1])

2509

2003

elif not self.server_address[1]:

2510

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

2004

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

2005

0)

2511

2006

# if self.interface:

2512

2007

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

2513

2008

# 0, # port

2519

2014

2520

2015

class MandosServer(IPv6_TCPServer):

2521

2016

"""Mandos server.

2522

2017

2523

2018

Attributes:

2524

2019

clients: set of Client objects

2525

2020

gnutls_priority GnuTLS priority string

2526

2021

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

2527

2528

Assumes a GLib.MainLoop event loop.

2022

2023

Assumes a gobject.MainLoop event loop.

2529

2024

"""

2530

2531

2025

def __init__(self, server_address, RequestHandlerClass,

2532

interface=None,

2533

use_ipv6=True,

2534

clients=None,

2535

gnutls_priority=None,

2536

use_dbus=True,

2537

socketfd=None):

2026

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

2027

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

2538

2028

self.enabled = False

2539

2029

self.clients = clients

2540

2030

if self.clients is None:

2543

2033

self.gnutls_priority = gnutls_priority

2544

2034

IPv6_TCPServer.__init__(self, server_address,

2545

2035

RequestHandlerClass,

2546

interface=interface,

2547

use_ipv6=use_ipv6,

2548

socketfd=socketfd)

2549

2036

interface = interface,

2037

use_ipv6 = use_ipv6,

2038

socketfd = socketfd)

2550

2039

def server_activate(self):

2551

2040

if self.enabled:

2552

2041

return socketserver.TCPServer.server_activate(self)

2553

2042

2554

2043

def enable(self):

2555

2044

self.enabled = True

2556

2045

2557

2046

def add_pipe(self, parent_pipe, proc):

2558

2047

# Call "handle_ipc" for both data and EOF events

2559

GLib.io_add_watch(

2560

parent_pipe.fileno(),

2561

GLib.IO_IN | GLib.IO_HUP,

2562

functools.partial(self.handle_ipc,

2563

parent_pipe=parent_pipe,

2564

proc=proc))

2565

2566

def handle_ipc(self, source, condition,

2567

parent_pipe=None,

2568

proc=None,

2569

client_object=None):

2048

gobject.io_add_watch(parent_pipe.fileno(),

2049

gobject.IO_IN | gobject.IO_HUP,

2050

functools.partial(self.handle_ipc,

2051

parent_pipe =

2052

parent_pipe,

2053

proc = proc))

2054

2055

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

2056

proc = None, client_object=None):

2570

2057

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

2571

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

2058

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

2572

2059

# Wait for other process to exit

2573

2060

proc.join()

2574

2061

return False

2575

2062

2576

2063

# Read a request from the child

2577

2064

request = parent_pipe.recv()

2578

2065

command = request[0]

2579

2066

2580

2067

if command == 'init':

2581

2068

fpr = request[1]

2582

2069

address = request[2]

2583

2584

for c in self.clients.values():

2070

2071

for c in self.clients.itervalues():

2585

2072

if c.fingerprint == fpr:

2586

2073

client = c

2587

2074

break

2594

2081

address[0])

2595

2082

parent_pipe.send(False)

2596

2083

return False

2597

2598

GLib.io_add_watch(

2599

parent_pipe.fileno(),

2600

GLib.IO_IN | GLib.IO_HUP,

2601

functools.partial(self.handle_ipc,

2602

parent_pipe=parent_pipe,

2603

proc=proc,

2604

client_object=client))

2084

2085

gobject.io_add_watch(parent_pipe.fileno(),

2086

gobject.IO_IN | gobject.IO_HUP,

2087

functools.partial(self.handle_ipc,

2088

parent_pipe =

2089

parent_pipe,

2090

proc = proc,

2091

client_object =

2092

client))

2605

2093

parent_pipe.send(True)

2606

2094

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

2607

2095

# same fileno

2610

2098

funcname = request[1]

2611

2099

args = request[2]

2612

2100

kwargs = request[3]

2613

2101

2614

2102

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

2615

2103

funcname)(*args,

2616

**kwargs)))

2617

2104

**kwargs)))

2105

2618

2106

if command == 'getattr':

2619

2107

attrname = request[1]

2620

if isinstance(client_object.__getattribute__(attrname),

2621

collections.Callable):

2622

parent_pipe.send(('function', ))

2108

if callable(client_object.__getattribute__(attrname)):

2109

parent_pipe.send(('function',))

2623

2110

else:

2624

parent_pipe.send((

2625

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

2626

2111

parent_pipe.send(('data', client_object

2112

.__getattribute__(attrname)))

2113

2627

2114

if command == 'setattr':

2628

2115

attrname = request[1]

2629

2116

value = request[2]

2630

2117

setattr(client_object, attrname, value)

2631

2118

2632

2119

return True

2633

2120

2634

2121

2635

2122

def rfc3339_duration_to_delta(duration):

2636

2123

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

2637

2124

2638

2125

>>> rfc3339_duration_to_delta("P7D")

2639

2126

datetime.timedelta(7)

2640

2127

>>> rfc3339_duration_to_delta("PT60S")

2650

2137

>>> rfc3339_duration_to_delta("P1DT3M20S")

2651

2138

datetime.timedelta(1, 200)

2652

2139

"""

2653

2140

2654

2141

# Parsing an RFC 3339 duration with regular expressions is not

2655

2142

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

2656

2143

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

2657

2144

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

2658

2145

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

2659

2146

# avoid excessive use of external libraries.

2660

2147

2661

2148

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

2662

Token = collections.namedtuple("Token", (

2663

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

2664

# a "group" containing digits

2665

"value", # datetime.timedelta or None

2666

"followers")) # Tokens valid after this token

2149

Token = collections.namedtuple("Token",

2150

("regexp", # To match token; if

2151

# "value" is not None,

2152

# must have a "group"

2153

# containing digits

2154

"value", # datetime.timedelta or

2155

# None

2156

"followers")) # Tokens valid after

2157

# this token

2667

2158

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

2668

2159

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

2669

2160

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

2670

2161

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

2671

2162

datetime.timedelta(seconds=1),

2672

frozenset((token_end, )))

2163

frozenset((token_end,)))

2673

2164

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

2674

2165

datetime.timedelta(minutes=1),

2675

2166

frozenset((token_second, token_end)))

2691

2182

frozenset((token_month, token_end)))

2692

2183

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

2693

2184

datetime.timedelta(weeks=1),

2694

frozenset((token_end, )))

2185

frozenset((token_end,)))

2695

2186

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

2696

2187

frozenset((token_year, token_month,

2697

2188

token_day, token_time,

2698

token_week)))

2699

# Define starting values:

2700

# Value so far

2701

value = datetime.timedelta()

2189

token_week))),

2190

# Define starting values

2191

value = datetime.timedelta() # Value so far

2702

2192

found_token = None

2703

# Following valid tokens

2704

followers = frozenset((token_duration, ))

2705

# String left to parse

2706

s = duration

2193

followers = frozenset(token_duration,) # Following valid tokens

2194

s = duration # String left to parse

2707

2195

# Loop until end token is found

2708

2196

while found_token is not token_end:

2709

2197

# Search for any currently valid tokens

2725

2213

break

2726

2214

else:

2727

2215

# No currently valid tokens were found

2728

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

2729

.format(duration))

2216

raise ValueError("Invalid RFC 3339 duration")

2730

2217

# End token found

2731

2218

return value

2732

2219

2733

2220

2734

2221

def string_to_delta(interval):

2735

2222

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

2736

2223

2737

2224

>>> string_to_delta('7d')

2738

2225

datetime.timedelta(7)

2739

2226

>>> string_to_delta('60s')

2747

2234

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

2748

2235

datetime.timedelta(0, 330)

2749

2236

"""

2750

2237

2751

2238

try:

2752

2239

return rfc3339_duration_to_delta(interval)

2753

2240

except ValueError:

2754

2241

pass

2755

2242

2756

2243

timevalue = datetime.timedelta(0)

2757

2244

for s in interval.split():

2758

2245

try:

2759

suffix = s[-1]

2246

suffix = unicode(s[-1])

2760

2247

value = int(s[:-1])

2761

2248

if suffix == "d":

2762

2249

delta = datetime.timedelta(value)

2769

2256

elif suffix == "w":

2770

2257

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

2771

2258

else:

2772

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

2773

except IndexError as e:

2259

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

2260

.format(suffix))

2261

except (ValueError, IndexError) as e:

2774

2262

raise ValueError(*(e.args))

2775

2263

timevalue += delta

2776

2264

return timevalue

2777

2265

2778

2266

2779

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

2267

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

2780

2268

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

2781

2269

2782

2270

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

2783

2271

if os.fork():

2784

2272

sys.exit()

2792

2280

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

2793

2281

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

2794

2282

raise OSError(errno.ENODEV,

2795

"{} not a character device"

2283

"{0} not a character device"

2796

2284

.format(os.devnull))

2797

2285

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

2798

2286

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

2802

2290

2803

2291

2804

2292

def main():

2805

2293

2806

2294

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

2807

2295

# Parsing of options, both command line and config file

2808

2296

2809

2297

parser = argparse.ArgumentParser()

2810

2298

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

2811

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

2299

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

2812

2300

help="show version number and exit")

2813

2301

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

2814

2302

help="Bind to interface IF")

2847

2335

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

2848

2336

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

2849

2337

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

2850

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

2851

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

2852

default=None)

2853

2338

2854

2339

options = parser.parse_args()

2855

2340

2856

2341

if options.check:

2857

2342

import doctest

2858

fail_count, test_count = doctest.testmod()

2859

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

2860

2343

doctest.testmod()

2344

sys.exit()

2345

2861

2346

# Default values for config file for server-global settings

2862

server_defaults = {"interface": "",

2863

"address": "",

2864

"port": "",

2865

"debug": "False",

2866

"priority":

2867

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

2868

":+SIGN-DSA-SHA256",

2869

"servicename": "Mandos",

2870

"use_dbus": "True",

2871

"use_ipv6": "True",

2872

"debuglevel": "",

2873

"restore": "True",

2874

"socket": "",

2875

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

2876

"foreground": "False",

2877

"zeroconf": "True",

2878

}

2879

2347

server_defaults = { "interface": "",

2348

"address": "",

2349

"port": "",

2350

"debug": "False",

2351

"priority":

2352

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

2353

"servicename": "Mandos",

2354

"use_dbus": "True",

2355

"use_ipv6": "True",

2356

"debuglevel": "",

2357

"restore": "True",

2358

"socket": "",

2359

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

2360

"foreground": "False",

2361

}

2362

2880

2363

# Parse config file for server-global settings

2881

2364

server_config = configparser.SafeConfigParser(server_defaults)

2882

2365

del server_defaults

2883

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

2366

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

2367

"mandos.conf"))

2884

2368

# Convert the SafeConfigParser object to a dict

2885

2369

server_settings = server_config.defaults()

2886

2370

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

2887

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

2888

"foreground", "zeroconf"):

2371

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

2889

2372

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

2890

2373

option)

2891

2374

if server_settings["port"]:

2901

2384

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

2902

2385

["socket"])

2903

2386

del server_config

2904

2387

2905

2388

# Override the settings from the config file with command line

2906

2389

# options, if set.

2907

2390

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

2908

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

2909

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

2910

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

2391

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

2392

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

2393

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

2911

2394

value = getattr(options, option)

2912

2395

if value is not None:

2913

2396

server_settings[option] = value

2914

2397

del options

2915

2398

# Force all strings to be unicode

2916

2399

for option in server_settings.keys():

2917

if isinstance(server_settings[option], bytes):

2918

server_settings[option] = (server_settings[option]

2919

.decode("utf-8"))

2400

if type(server_settings[option]) is str:

2401

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

2920

2402

# Force all boolean options to be boolean

2921

2403

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

2922

"foreground", "zeroconf"):

2404

"foreground"):

2923

2405

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

2924

2406

# Debug implies foreground

2925

2407

if server_settings["debug"]:

2926

2408

server_settings["foreground"] = True

2927

2409

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

2928

2410

2929

2411

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

2930

2931

if (not server_settings["zeroconf"]

2932

and not (server_settings["port"]

2933

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

2934

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

2935

2412

2936

2413

# For convenience

2937

2414

debug = server_settings["debug"]

2938

2415

debuglevel = server_settings["debuglevel"]

2941

2418

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

2942

2419

stored_state_file)

2943

2420

foreground = server_settings["foreground"]

2944

zeroconf = server_settings["zeroconf"]

2945

2421

2946

2422

if debug:

2947

2423

initlogger(debug, logging.DEBUG)

2948

2424

else:

2951

2427

else:

2952

2428

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

2953

2429

initlogger(debug, level)

2954

2430

2955

2431

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

2956

syslogger.setFormatter(

2957

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

2958

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

2959

server_settings["servicename"])))

2960

2432

syslogger.setFormatter(logging.Formatter

2433

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

2434

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

2435

.format(server_settings

2436

["servicename"])))

2437

2961

2438

# Parse config file with clients

2962

2439

client_config = configparser.SafeConfigParser(Client

2963

2440

.client_defaults)

2964

2441

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

2965

2442

"clients.conf"))

2966

2443

2967

2444

global mandos_dbus_service

2968

2445

mandos_dbus_service = None

2969

2970

socketfd = None

2971

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

2972

socketfd = server_settings["socket"]

2973

tcp_server = MandosServer(

2974

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

2975

ClientHandler,

2976

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

2977

use_ipv6=use_ipv6,

2978

gnutls_priority=server_settings["priority"],

2979

use_dbus=use_dbus,

2980

socketfd=socketfd)

2446

2447

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

2448

server_settings["port"]),

2449

ClientHandler,

2450

interface=(server_settings["interface"]

2451

or None),

2452

use_ipv6=use_ipv6,

2453

gnutls_priority=

2454

server_settings["priority"],

2455

use_dbus=use_dbus,

2456

socketfd=(server_settings["socket"]

2457

or None))

2981

2458

if not foreground:

2982

2459

pidfilename = "/run/mandos.pid"

2983

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

2984

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

2985

2460

pidfile = None

2986

2461

try:

2987

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

2462

pidfile = open(pidfilename, "w")

2988

2463

except IOError as e:

2989

2464

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

2990

2465

exc_info=e)

2991

2992

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

2993

("mandos", "mandos"),

2994

("nobody", "nogroup")):

2466

2467

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

2995

2468

try:

2996

2469

uid = pwd.getpwnam(name).pw_uid

2997

gid = pwd.getpwnam(group).pw_gid

2470

gid = pwd.getpwnam(name).pw_gid

2998

2471

break

2999

2472

except KeyError:

3000

2473

continue

3004

2477

try:

3005

2478

os.setgid(gid)

3006

2479

os.setuid(uid)

3007

if debug:

3008

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

3009

gid))

3010

2480

except OSError as error:

3011

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

3012

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

3013

2481

if error.errno != errno.EPERM:

3014

raise

3015

2482

raise error

2483

3016

2484

if debug:

3017

2485

# Enable all possible GnuTLS debugging

3018

2486

3019

2487

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

3020

2488

# - GnuTLS manual

3021

gnutls.global_set_log_level(11)

3022

3023

@gnutls.log_func

2489

gnutls.library.functions.gnutls_global_set_log_level(11)

2490

2491

@gnutls.library.types.gnutls_log_func

3024

2492

def debug_gnutls(level, string):

3025

2493

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

3026

3027

gnutls.global_set_log_function(debug_gnutls)

3028

2494

2495

(gnutls.library.functions

2496

.gnutls_global_set_log_function(debug_gnutls))

2497

3029

2498

# Redirect stdin so all checkers get /dev/null

3030

2499

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

3031

2500

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

3032

2501

if null > 2:

3033

2502

os.close(null)

3034

2503

3035

2504

# Need to fork before connecting to D-Bus

3036

2505

if not foreground:

3037

2506

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

3038

2507

daemon()

3039

3040

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

3041

# to inform GLib that threads will be used.

3042

GLib.threads_init()

3043

2508

2509

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

2510

# need to inform gobject that threads will be used.

2511

gobject.threads_init()

2512

3044

2513

global main_loop

3045

2514

# From the Avahi example code

3046

2515

DBusGMainLoop(set_as_default=True)

3047

main_loop = GLib.MainLoop()

2516

main_loop = gobject.MainLoop()

3048

2517

bus = dbus.SystemBus()

3049

2518

# End of Avahi example code

3050

2519

if use_dbus:

3051

2520

try:

3052

2521

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

3053

bus,

3054

do_not_queue=True)

3055

old_bus_name = dbus.service.BusName(

3056

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

3057

do_not_queue=True)

3058

except dbus.exceptions.DBusException as e:

2522

bus, do_not_queue=True)

2523

old_bus_name = (dbus.service.BusName

2524

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

2525

do_not_queue=True))

2526

except dbus.exceptions.NameExistsException as e:

3059

2527

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

3060

2528

use_dbus = False

3061

2529

server_settings["use_dbus"] = False

3062

2530

tcp_server.use_dbus = False

3063

if zeroconf:

3064

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3065

service = AvahiServiceToSyslog(

3066

name=server_settings["servicename"],

3067

servicetype="_mandos._tcp",

3068

protocol=protocol,

3069

bus=bus)

3070

if server_settings["interface"]:

3071

service.interface = if_nametoindex(

3072

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

3073

2531

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2532

service = AvahiServiceToSyslog(name =

2533

server_settings["servicename"],

2534

servicetype = "_mandos._tcp",

2535

protocol = protocol, bus = bus)

2536

if server_settings["interface"]:

2537

service.interface = (if_nametoindex

2538

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

2539

3074

2540

global multiprocessing_manager

3075

2541

multiprocessing_manager = multiprocessing.Manager()

3076

2542

3077

2543

client_class = Client

3078

2544

if use_dbus:

3079

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

3080

2545

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

2546

3081

2547

client_settings = Client.config_parser(client_config)

3082

2548

old_client_settings = {}

3083

2549

clients_data = {}

3084

2550

3085

2551

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

3086

2552

global wnull

3087

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

2553

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

3088

2554

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

3089

2555

# mode

3090

2556

if debug or not foreground:

3091

2557

wnull.close()

3092

2558

3093

2559

# Get client data and settings from last running state.

3094

2560

if server_settings["restore"]:

3095

2561

try:

3096

2562

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

3097

if sys.version_info.major == 2:

3098

clients_data, old_client_settings = pickle.load(

3099

stored_state)

3100

else:

3101

bytes_clients_data, bytes_old_client_settings = (

3102

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

3103

# Fix bytes to strings

3104

# clients_data

3105

# .keys()

3106

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

3107

if isinstance(key, bytes)

3108

else key): value

3109

for key, value in

3110

bytes_clients_data.items()}

3111

del bytes_clients_data

3112

for key in clients_data:

3113

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

3114

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

3115

for k, v in

3116

clients_data[key].items()}

3117

clients_data[key] = value

3118

# .client_structure

3119

value["client_structure"] = [

3120

(s.decode("utf-8")

3121

if isinstance(s, bytes)

3122

else s) for s in

3123

value["client_structure"]]

3124

# .name & .host

3125

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

3126

if isinstance(value[k], bytes):

3127

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

3128

# old_client_settings

3129

# .keys()

3130

old_client_settings = {

3131

(key.decode("utf-8")

3132

if isinstance(key, bytes)

3133

else key): value

3134

for key, value in

3135

bytes_old_client_settings.items()}

3136

del bytes_old_client_settings

3137

# .host

3138

for value in old_client_settings.values():

3139

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

3140

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

3141

.decode("utf-8"))

2563

clients_data, old_client_settings = (pickle.load

2564

(stored_state))

3142

2565

os.remove(stored_state_path)

3143

2566

except IOError as e:

3144

2567

if e.errno == errno.ENOENT:

3145

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

3146

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

2568

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

2569

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

3147

2570

else:

3148

2571

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

3149

2572

exc_info=e)

3150

2573

raise

3151

2574

except EOFError as e:

3152

2575

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

3153

"EOFError:",

3154

exc_info=e)

3155

2576

"EOFError:", exc_info=e)

2577

3156

2578

with PGPEngine() as pgp:

3157

for client_name, client in clients_data.items():

2579

for client_name, client in clients_data.iteritems():

3158

2580

# Skip removed clients

3159

2581

if client_name not in client_settings:

3160

2582

continue

3161

2583

3162

2584

# Decide which value to use after restoring saved state.

3163

2585

# We have three different values: Old config file,

3164

2586

# new config file, and saved state.

3169

2591

# For each value in new config, check if it

3170

2592

# differs from the old config value (Except for

3171

2593

# the "secret" attribute)

3172

if (name != "secret"

3173

and (value !=

3174

old_client_settings[client_name][name])):

2594

if (name != "secret" and

2595

value != old_client_settings[client_name]

2596

[name]):

3175

2597

client[name] = value

3176

2598

except KeyError:

3177

2599

pass

3178

2600

3179

2601

# Clients who has passed its expire date can still be

3180

# enabled if its last checker was successful. A Client

2602

# enabled if its last checker was successful. Clients

3181

2603

# whose checker succeeded before we stored its state is

3182

2604

# assumed to have successfully run all checkers during

3183

2605

# downtime.

3185

2607

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

3186

2608

if not client["last_checked_ok"]:

3187

2609

logger.warning(

3188

"disabling client {} - Client never "

3189

"performed a successful checker".format(

3190

client_name))

2610

"disabling client {0} - Client never "

2611

"performed a successful checker"

2612

.format(client_name))

3191

2613

client["enabled"] = False

3192

2614

elif client["last_checker_status"] != 0:

3193

2615

logger.warning(

3194

"disabling client {} - Client last"

3195

" checker failed with error code"

3196

" {}".format(

3197

client_name,

3198

client["last_checker_status"]))

2616

"disabling client {0} - Client "

2617

"last checker failed with error code {1}"

2618

.format(client_name,

2619

client["last_checker_status"]))

3199

2620

client["enabled"] = False

3200

2621

else:

3201

client["expires"] = (

3202

datetime.datetime.utcnow()

3203

+ client["timeout"])

2622

client["expires"] = (datetime.datetime

2623

.utcnow()

2624

+ client["timeout"])

3204

2625

logger.debug("Last checker succeeded,"

3205

" keeping {} enabled".format(

3206

client_name))

2626

" keeping {0} enabled"

2627

.format(client_name))

3207

2628

try:

3208

client["secret"] = pgp.decrypt(

3209

client["encrypted_secret"],

3210

client_settings[client_name]["secret"])

2629

client["secret"] = (

2630

pgp.decrypt(client["encrypted_secret"],

2631

client_settings[client_name]

2632

["secret"]))

3211

2633

except PGPError:

3212

2634

# If decryption fails, we use secret from new settings

3213

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

3214

client_name))

3215

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

3216

["secret"])

3217

2635

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

2636

.format(client_name))

2637

client["secret"] = (

2638

client_settings[client_name]["secret"])

2639

3218

2640

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

3219

2641

for client_name in (set(old_client_settings)

3220

2642

- set(client_settings)):

3222

2644

for client_name in (set(client_settings)

3223

2645

- set(old_client_settings)):

3224

2646

clients_data[client_name] = client_settings[client_name]

3225

2647

3226

2648

# Create all client objects

3227

for client_name, client in clients_data.items():

2649

for client_name, client in clients_data.iteritems():

3228

2650

tcp_server.clients[client_name] = client_class(

3229

name=client_name,

3230

settings=client,

3231

server_settings=server_settings)

3232

2651

name = client_name, settings = client,

2652

server_settings = server_settings)

2653

3233

2654

if not tcp_server.clients:

3234

2655

logger.warning("No clients defined")

3235

2656

3236

2657

if not foreground:

3237

2658

if pidfile is not None:

3238

pid = os.getpid()

3239

2659

try:

3240

2660

with pidfile:

3241

print(pid, file=pidfile)

2661

pid = os.getpid()

2662

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

3242

2663

except IOError:

3243

2664

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

3244

2665

pidfilename, pid)

3245

2666

del pidfile

3246

2667

del pidfilename

3247

3248

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

3249

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3250

lambda: main_loop.quit() and False)

3251

2668

2669

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

2670

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

2671

3252

2672

if use_dbus:

3253

3254

@alternate_dbus_interfaces(

3255

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

3256

class MandosDBusService(DBusObjectWithObjectManager):

2673

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

2674

"se.bsnet.fukt.Mandos"})

2675

class MandosDBusService(DBusObjectWithProperties):

3257

2676

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

3258

3259

2677

def __init__(self):

3260

2678

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

3261

3262

2679

_interface = "se.recompile.Mandos"

3263

2680

2681

@dbus_interface_annotations(_interface)

2682

def _foo(self):

2683

return { "org.freedesktop.DBus.Property"

2684

".EmitsChangedSignal":

2685

"false"}

2686

3264

2687

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

3265

2688

def ClientAdded(self, objpath):

3266

2689

"D-Bus signal"

3267

2690

pass

3268

2691

3269

2692

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

3270

2693

def ClientNotFound(self, fingerprint, address):

3271

2694

"D-Bus signal"

3272

2695

pass

3273

3274

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

3275

"true"})

2696

3276

2697

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

3277

2698

def ClientRemoved(self, objpath, name):

3278

2699

"D-Bus signal"

3279

2700

pass

3280

3281

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

3282

"true"})

2701

3283

2702

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

3284

2703

def GetAllClients(self):

3285

2704

"D-Bus method"

3286

return dbus.Array(c.dbus_object_path for c in

3287

tcp_server.clients.values())

3288

3289

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

3290

"true"})

2705

return dbus.Array(c.dbus_object_path

2706

for c in

2707

tcp_server.clients.itervalues())

2708

3291

2709

@dbus.service.method(_interface,

3292

2710

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

3293

2711

def GetAllClientsWithProperties(self):

3294

2712

"D-Bus method"

3295

2713

return dbus.Dictionary(

3296

{c.dbus_object_path: c.GetAll(

3297

"se.recompile.Mandos.Client")

3298

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

2714

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

2715

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

3299

2716

signature="oa{sv}")

3300

2717

3301

2718

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

3302

2719

def RemoveClient(self, object_path):

3303

2720

"D-Bus method"

3304

for c in tcp_server.clients.values():

2721

for c in tcp_server.clients.itervalues():

3305

2722

if c.dbus_object_path == object_path:

3306

2723

del tcp_server.clients[c.name]

3307

2724

c.remove_from_connection()

3308

# Don't signal the disabling

2725

# Don't signal anything except ClientRemoved

3309

2726

c.disable(quiet=True)

3310

# Emit D-Bus signal for removal

3311

self.client_removed_signal(c)

2727

# Emit D-Bus signal

2728

self.ClientRemoved(object_path, c.name)

3312

2729

return

3313

2730

raise KeyError(object_path)

3314

2731

3315

2732

del _interface

3316

3317

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3318

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

3319

def GetManagedObjects(self):

3320

"""D-Bus method"""

3321

return dbus.Dictionary(

3322

{client.dbus_object_path:

3323

dbus.Dictionary(

3324

{interface: client.GetAll(interface)

3325

for interface in

3326

client._get_all_interface_names()})

3327

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

3328

3329

def client_added_signal(self, client):

3330

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

3331

if use_dbus:

3332

# New standard signal

3333

self.InterfacesAdded(

3334

client.dbus_object_path,

3335

dbus.Dictionary(

3336

{interface: client.GetAll(interface)

3337

for interface in

3338

client._get_all_interface_names()}))

3339

# Old signal

3340

self.ClientAdded(client.dbus_object_path)

3341

3342

def client_removed_signal(self, client):

3343

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

3344

if use_dbus:

3345

# New standard signal

3346

self.InterfacesRemoved(

3347

client.dbus_object_path,

3348

client._get_all_interface_names())

3349

# Old signal

3350

self.ClientRemoved(client.dbus_object_path,

3351

client.name)

3352

2733

3353

2734

mandos_dbus_service = MandosDBusService()

3354

3355

# Save modules to variables to exempt the modules from being

3356

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

3357

mp = multiprocessing

3358

wn = wnull

3359

2735

3360

2736

def cleanup():

3361

2737

"Cleanup function; run on exit"

3362

if zeroconf:

3363

service.cleanup()

3364

3365

mp.active_children()

3366

wn.close()

2738

service.cleanup()

2739

2740

multiprocessing.active_children()

2741

wnull.close()

3367

2742

if not (tcp_server.clients or client_settings):

3368

2743

return

3369

2744

3370

2745

# Store client before exiting. Secrets are encrypted with key

3371

2746

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

3372

2747

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

3373

2748

clients = {}

3374

2749

with PGPEngine() as pgp:

3375

for client in tcp_server.clients.values():

2750

for client in tcp_server.clients.itervalues():

3376

2751

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

3377

2752

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

3378

2753

key)

3379

2754

client_dict = {}

3380

2755

3381

2756

# A list of attributes that can not be pickled

3382

2757

# + secret.

3383

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

3384

"checker", "server_settings"}

3385

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

3386

.Object):

2758

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

2759

"checker", "server_settings"))

2760

for name, typ in (inspect.getmembers

2761

(dbus.service.Object)):

3387

2762

exclude.add(name)

3388

2763

3389

2764

client_dict["encrypted_secret"] = (client

3390

2765

.encrypted_secret)

3391

2766

for attr in client.client_structure:

3392

2767

if attr not in exclude:

3393

2768

client_dict[attr] = getattr(client, attr)

3394

2769

3395

2770

clients[client.name] = client_dict

3396

2771

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

3397

2772

3398

2773

try:

3399

with tempfile.NamedTemporaryFile(

3400

mode='wb',

3401

suffix=".pickle",

3402

prefix='clients-',

3403

dir=os.path.dirname(stored_state_path),

3404

delete=False) as stored_state:

3405

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

3406

protocol=2)

3407

tempname = stored_state.name

2774

with (tempfile.NamedTemporaryFile

2775

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

2776

dir=os.path.dirname(stored_state_path),

2777

delete=False)) as stored_state:

2778

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

2779

tempname=stored_state.name

3408

2780

os.rename(tempname, stored_state_path)

3409

2781

except (IOError, OSError) as e:

3410

2782

if not debug:

3413

2785

except NameError:

3414

2786

pass

3415

2787

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

3416

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

2788

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

3417

2789

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

3418

2790

else:

3419

2791

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

3420

2792

exc_info=e)

3421

raise

3422

2793

raise e

2794

3423

2795

# Delete all clients, and settings from config

3424

2796

while tcp_server.clients:

3425

2797

name, client = tcp_server.clients.popitem()

3426

2798

if use_dbus:

3427

2799

client.remove_from_connection()

3428

# Don't signal the disabling

2800

# Don't signal anything except ClientRemoved

3429

2801

client.disable(quiet=True)

3430

# Emit D-Bus signal for removal

3431

2802

if use_dbus:

3432

mandos_dbus_service.client_removed_signal(client)

2803

# Emit D-Bus signal

2804

mandos_dbus_service.ClientRemoved(client

2805

.dbus_object_path,

2806

client.name)

3433

2807

client_settings.clear()

3434

2808

3435

2809

atexit.register(cleanup)

3436

3437

for client in tcp_server.clients.values():

2810

2811

for client in tcp_server.clients.itervalues():

3438

2812

if use_dbus:

3439

# Emit D-Bus signal for adding

3440

mandos_dbus_service.client_added_signal(client)

2813

# Emit D-Bus signal

2814

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3441

2815

# Need to initiate checking of clients

3442

2816

if client.enabled:

3443

2817

client.init_checker()

3444

2818

3445

2819

tcp_server.enable()

3446

2820

tcp_server.server_activate()

3447

2821

3448

2822

# Find out what port we got

3449

if zeroconf:

3450

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

2823

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

3451

2824

if use_ipv6:

3452

2825

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

3453

2826

" flowinfo %d, scope_id %d",

3455

2828

else: # IPv4

3456

2829

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

3457

2830

*tcp_server.socket.getsockname())

3458

3459

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

3460

2831

2832

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

2833

3461

2834

try:

3462

if zeroconf:

3463

# From the Avahi example code

3464

try:

3465

service.activate()

3466

except dbus.exceptions.DBusException as error:

3467

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

3468

cleanup()

3469

sys.exit(1)

3470

# End of Avahi example code

3471

3472

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

3473

lambda *args, **kwargs:

3474

(tcp_server.handle_request

3475

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

3476

2835

# From the Avahi example code

2836

try:

2837

service.activate()

2838

except dbus.exceptions.DBusException as error:

2839

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

2840

cleanup()

2841

sys.exit(1)

2842

# End of Avahi example code

2843

2844

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

2845

lambda *args, **kwargs:

2846

(tcp_server.handle_request

2847

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

2848

3477

2849

logger.debug("Starting main loop")

3478

2850

main_loop.run()

3479

2851

except AvahiError as error:

3488

2860

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

3489

2861

cleanup()

3490

2862

3491

3492

2863

if __name__ == '__main__':

3493

2864

main()