/mandos/trunk : revision 237.4.99

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

72

80

73

81

import dbus

74

82

import dbus.service

75

import gobject

76

import avahi

83

from gi.repository import GLib

77

84

from dbus.mainloop.glib import DBusGMainLoop

78

85

import ctypes

79

86

import ctypes.util

80

87

import xml.dom.minidom

81

88

import inspect

82

89

90

# Try to find the value of SO_BINDTODEVICE:

83

91

try:

92

# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and

93

# newer, and it is also the most natural place for it:

84

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

95

except AttributeError:

86

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

87

99

from IN import SO_BINDTODEVICE

88

100

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.5"

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

92

119

stored_state_file = "clients.pickle"

93

120

94

121

logger = logging.getLogger()

95

122

syslogger = None

96

123

97

124

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

101

127

except (OSError, AttributeError):

128

102

129

def if_nametoindex(interface):

103

130

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

104

131

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

105

132

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

106

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

134

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

135

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

111

136

return interface_index

112

137

113

138

139

def copy_function(func):

140

"""Make a copy of a function"""

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

114

155

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

115

156

"""init logger and add loglevel"""

116

117

syslogger = (logging.handlers.SysLogHandler

118

(facility =

119

logging.handlers.SysLogHandler.LOG_DAEMON,

120

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

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

121

162

syslogger.setFormatter(logging.Formatter

122

163

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

123

164

' %(message)s'))

124

165

logger.addHandler(syslogger)

125

166

126

167

if debug:

127

168

console = logging.StreamHandler()

128

169

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

140

181

141

182

class PGPEngine(object):

142

183

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

184

143

185

def __init__(self):

144

186

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

187

self.gpg = "gpg"

188

try:

189

output = subprocess.check_output(["gpgconf"])

190

for line in output.splitlines():

191

name, text, path = line.split(b":")

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

145

198

self.gnupgargs = ['--batch',

146

'--home', self.tempdir,

199

'--homedir', self.tempdir,

147

200

'--force-mdc',

148

'--quiet',

149

'--no-use-agent']

150

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

151

206

def __enter__(self):

152

207

return self

153

208

154

209

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

155

210

self._cleanup()

156

211

return False

157

212

158

213

def __del__(self):

159

214

self._cleanup()

160

215

161

216

def _cleanup(self):

162

217

if self.tempdir is not None:

163

218

# Delete contents of tempdir

164

219

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

165

topdown = False):

220

topdown=False):

166

221

for filename in files:

167

222

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

168

223

for dirname in dirs:

170

225

# Remove tempdir

171

226

os.rmdir(self.tempdir)

172

227

self.tempdir = None

173

228

174

229

def password_encode(self, password):

175

230

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

176

231

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

181

236

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

182

237

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

183

238

return encoded

184

239

185

240

def encrypt(self, data, password):

186

241

passphrase = self.password_encode(password)

187

with tempfile.NamedTemporaryFile(dir=self.tempdir

188

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

189

244

passfile.write(passphrase)

190

245

passfile.flush()

191

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

246

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

192

247

'--passphrase-file',

193

248

passfile.name]

194

249

+ self.gnupgargs,

195

stdin = subprocess.PIPE,

196

stdout = subprocess.PIPE,

197

stderr = subprocess.PIPE)

198

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

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

199

254

if proc.returncode != 0:

200

255

raise PGPError(err)

201

256

return ciphertext

202

257

203

258

def decrypt(self, data, password):

204

259

passphrase = self.password_encode(password)

205

with tempfile.NamedTemporaryFile(dir = self.tempdir

206

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

207

262

passfile.write(passphrase)

208

263

passfile.flush()

209

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

264

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

210

265

'--passphrase-file',

211

266

passfile.name]

212

267

+ self.gnupgargs,

213

stdin = subprocess.PIPE,

214

stdout = subprocess.PIPE,

215

stderr = subprocess.PIPE)

216

decrypted_plaintext, err = proc.communicate(input

217

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

218

272

if proc.returncode != 0:

219

273

raise PGPError(err)

220

274

return decrypted_plaintext

221

275

222

276

277

# Pretend that we have an Avahi module

278

class Avahi(object):

279

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

280

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

281

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

282

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

283

PROTO_INET = 0 # avahi-common/address.h

284

PROTO_INET6 = 1 # avahi-common/address.h

285

DBUS_NAME = "org.freedesktop.Avahi"

286

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

287

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

288

DBUS_PATH_SERVER = "/"

289

290

def string_array_to_txt_array(self, t):

291

return dbus.Array((dbus.ByteArray(s.encode("utf-8"))

292

for s in t), signature="ay")

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

avahi = Avahi()

302

303

223

304

class AvahiError(Exception):

224

305

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

225

306

self.value = value

226

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

227

def __unicode__(self):

228

return unicode(repr(self.value))

307

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

308

**kwargs)

309

229

310

230

311

class AvahiServiceError(AvahiError):

231

312

pass

232

313

314

233

315

class AvahiGroupError(AvahiError):

234

316

pass

235

317

236

318

237

319

class AvahiService(object):

238

320

"""An Avahi (Zeroconf) service.

239

321

240

322

Attributes:

241

323

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

242

324

Used to optionally bind to the specified interface.

254

336

server: D-Bus Server

255

337

bus: dbus.SystemBus()

256

338

"""

257

258

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

259

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

260

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

261

protocol = avahi.PROTO_UNSPEC, bus = None):

339

340

def __init__(self,

341

interface=avahi.IF_UNSPEC,

342

name=None,

343

servicetype=None,

344

port=None,

345

TXT=None,

346

domain="",

347

host="",

348

max_renames=32768,

349

protocol=avahi.PROTO_UNSPEC,

350

bus=None):

262

351

self.interface = interface

263

352

self.name = name

264

353

self.type = servicetype

273

362

self.server = None

274

363

self.bus = bus

275

364

self.entry_group_state_changed_match = None

276

277

def rename(self):

365

366

def rename(self, remove=True):

278

367

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

279

368

if self.rename_count >= self.max_renames:

280

369

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

281

370

" after %i retries, exiting.",

282

371

self.rename_count)

283

372

raise AvahiServiceError("Too many renames")

284

self.name = unicode(self.server

285

.GetAlternativeServiceName(self.name))

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

286

376

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

287

377

self.name)

288

self.remove()

378

if remove:

379

self.remove()

289

380

try:

290

381

self.add()

291

382

except dbus.exceptions.DBusException as error:

292

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

293

self.cleanup()

294

os._exit(1)

295

self.rename_count += 1

296

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

297

392

def remove(self):

298

393

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

299

394

if self.entry_group_state_changed_match is not None:

301

396

self.entry_group_state_changed_match = None

302

397

if self.group is not None:

303

398

self.group.Reset()

304

399

305

400

def add(self):

306

401

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

307

402

self.remove()

324

419

dbus.UInt16(self.port),

325

420

avahi.string_array_to_txt_array(self.TXT))

326

421

self.group.Commit()

327

422

328

423

def entry_group_state_changed(self, state, error):

329

424

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

330

425

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

331

426

332

427

if state == avahi.ENTRY_GROUP_ESTABLISHED:

333

428

logger.debug("Zeroconf service established.")

334

429

elif state == avahi.ENTRY_GROUP_COLLISION:

336

431

self.rename()

337

432

elif state == avahi.ENTRY_GROUP_FAILURE:

338

433

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

339

unicode(error))

340

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

341

.format(error))

342

434

str(error))

435

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

436

343

437

def cleanup(self):

344

438

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

345

439

if self.group is not None:

350

444

pass

351

445

self.group = None

352

446

self.remove()

353

447

354

448

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

355

449

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

356

450

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

357

bad_states = { avahi.SERVER_INVALID:

358

"Zeroconf server invalid",

359

avahi.SERVER_REGISTERING: None,

360

avahi.SERVER_COLLISION:

361

"Zeroconf server name collision",

362

avahi.SERVER_FAILURE:

363

"Zeroconf server failure" }

451

bad_states = {

452

avahi.SERVER_INVALID: "Zeroconf server invalid",

453

avahi.SERVER_REGISTERING: None,

454

avahi.SERVER_COLLISION: "Zeroconf server name collision",

455

avahi.SERVER_FAILURE: "Zeroconf server failure",

456

}

364

457

if state in bad_states:

365

458

if bad_states[state] is not None:

366

459

if error is None:

369

462

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

370

463

self.cleanup()

371

464

elif state == avahi.SERVER_RUNNING:

372

self.add()

465

try:

466

self.add()

467

except dbus.exceptions.DBusException as error:

468

if (error.get_dbus_name()

469

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

470

logger.info("Local Zeroconf service name"

471

" collision.")

472

return self.rename(remove=False)

473

else:

474

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

475

self.cleanup()

476

os._exit(1)

373

477

else:

374

478

if error is None:

375

479

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

376

480

else:

377

481

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

378

482

379

483

def activate(self):

380

484

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

381

485

if self.server is None:

385

489

follow_name_owner_changes=True),

386

490

avahi.DBUS_INTERFACE_SERVER)

387

491

self.server.connect_to_signal("StateChanged",

388

self.server_state_changed)

492

self.server_state_changed)

389

493

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

390

494

391

495

392

496

class AvahiServiceToSyslog(AvahiService):

393

def rename(self):

497

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

394

498

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

395

ret = AvahiService.rename(self)

396

syslogger.setFormatter(logging.Formatter

397

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

398

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

399

.format(self.name)))

499

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

500

syslogger.setFormatter(logging.Formatter(

501

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

502

.format(self.name)))

400

503

return ret

401

504

402

505

403

def timedelta_to_milliseconds(td):

404

"Convert a datetime.timedelta() to milliseconds"

405

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

406

+ (td.seconds * 1000)

407

+ (td.microseconds // 1000))

506

# Pretend that we have a GnuTLS module

507

class GnuTLS(object):

508

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

509

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

510

511

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

512

if library is None:

513

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

514

_library = ctypes.cdll.LoadLibrary(library)

515

del library

516

_need_version = b"3.3.0"

517

518

def __init__(self):

519

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

520

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

521

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

522

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

523

.format(self._need_version))

524

525

# Unless otherwise indicated, the constants and types below are

526

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

527

528

# Constants

529

E_SUCCESS = 0

530

E_INTERRUPTED = -52

531

E_AGAIN = -28

532

CRT_OPENPGP = 2

533

CLIENT = 2

534

SHUT_RDWR = 0

535

CRD_CERTIFICATE = 1

536

E_NO_CERTIFICATE_FOUND = -49

537

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

538

539

# Types

540

class session_int(ctypes.Structure):

541

_fields_ = []

542

session_t = ctypes.POINTER(session_int)

543

544

class certificate_credentials_st(ctypes.Structure):

545

_fields_ = []

546

certificate_credentials_t = ctypes.POINTER(

547

certificate_credentials_st)

548

certificate_type_t = ctypes.c_int

549

550

class datum_t(ctypes.Structure):

551

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

552

('size', ctypes.c_uint)]

553

554

class openpgp_crt_int(ctypes.Structure):

555

_fields_ = []

556

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

557

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

558

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

559

credentials_type_t = ctypes.c_int

560

transport_ptr_t = ctypes.c_void_p

561

close_request_t = ctypes.c_int

562

563

# Exceptions

564

class Error(Exception):

565

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

566

# exception might be raised from within GnuTLS.__init__,

567

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

568

# global variable has happened.

569

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

570

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

571

# code is passed, convert it to a string with

572

# gnutls.strerror()

573

self.code = code

574

if message is None and code is not None:

575

message = GnuTLS.strerror(code)

576

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

577

message, *args)

578

579

class CertificateSecurityError(Error):

580

pass

581

582

# Classes

583

class Credentials(object):

584

def __init__(self):

585

self._c_object = gnutls.certificate_credentials_t()

586

gnutls.certificate_allocate_credentials(

587

ctypes.byref(self._c_object))

588

self.type = gnutls.CRD_CERTIFICATE

589

590

def __del__(self):

591

gnutls.certificate_free_credentials(self._c_object)

592

593

class ClientSession(object):

594

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

595

self._c_object = gnutls.session_t()

596

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

597

gnutls.set_default_priority(self._c_object)

598

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

599

gnutls.handshake_set_private_extensions(self._c_object,

600

True)

601

self.socket = socket

602

if credentials is None:

603

credentials = gnutls.Credentials()

604

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

605

ctypes.cast(credentials._c_object,

606

ctypes.c_void_p))

607

self.credentials = credentials

608

609

def __del__(self):

610

gnutls.deinit(self._c_object)

611

612

def handshake(self):

613

return gnutls.handshake(self._c_object)

614

615

def send(self, data):

616

data = bytes(data)

617

data_len = len(data)

618

while data_len > 0:

619

data_len -= gnutls.record_send(self._c_object,

620

data[-data_len:],

621

data_len)

622

623

def bye(self):

624

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

625

626

# Error handling functions

627

def _error_code(result):

628

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

629

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

630

if result >= 0:

631

return result

632

if result == gnutls.E_NO_CERTIFICATE_FOUND:

633

raise gnutls.CertificateSecurityError(code=result)

634

raise gnutls.Error(code=result)

635

636

def _retry_on_error(result, func, arguments):

637

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

638

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

639

while result < 0:

640

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

641

return _error_code(result)

642

result = func(*arguments)

643

return result

644

645

# Unless otherwise indicated, the function declarations below are

646

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

647

648

# Functions

649

priority_set_direct = _library.gnutls_priority_set_direct

650

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

651

ctypes.POINTER(ctypes.c_char_p)]

652

priority_set_direct.restype = _error_code

653

654

init = _library.gnutls_init

655

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

656

init.restype = _error_code

657

658

set_default_priority = _library.gnutls_set_default_priority

659

set_default_priority.argtypes = [session_t]

660

set_default_priority.restype = _error_code

661

662

record_send = _library.gnutls_record_send

663

record_send.argtypes = [session_t, ctypes.c_void_p,

664

ctypes.c_size_t]

665

record_send.restype = ctypes.c_ssize_t

666

record_send.errcheck = _retry_on_error

667

668

certificate_allocate_credentials = (

669

_library.gnutls_certificate_allocate_credentials)

670

certificate_allocate_credentials.argtypes = [

671

ctypes.POINTER(certificate_credentials_t)]

672

certificate_allocate_credentials.restype = _error_code

673

674

certificate_free_credentials = (

675

_library.gnutls_certificate_free_credentials)

676

certificate_free_credentials.argtypes = [

677

certificate_credentials_t]

678

certificate_free_credentials.restype = None

679

680

handshake_set_private_extensions = (

681

_library.gnutls_handshake_set_private_extensions)

682

handshake_set_private_extensions.argtypes = [session_t,

683

ctypes.c_int]

684

handshake_set_private_extensions.restype = None

685

686

credentials_set = _library.gnutls_credentials_set

687

credentials_set.argtypes = [session_t, credentials_type_t,

688

ctypes.c_void_p]

689

credentials_set.restype = _error_code

690

691

strerror = _library.gnutls_strerror

692

strerror.argtypes = [ctypes.c_int]

693

strerror.restype = ctypes.c_char_p

694

695

certificate_type_get = _library.gnutls_certificate_type_get

696

certificate_type_get.argtypes = [session_t]

697

certificate_type_get.restype = _error_code

698

699

certificate_get_peers = _library.gnutls_certificate_get_peers

700

certificate_get_peers.argtypes = [session_t,

701

ctypes.POINTER(ctypes.c_uint)]

702

certificate_get_peers.restype = ctypes.POINTER(datum_t)

703

704

global_set_log_level = _library.gnutls_global_set_log_level

705

global_set_log_level.argtypes = [ctypes.c_int]

706

global_set_log_level.restype = None

707

708

global_set_log_function = _library.gnutls_global_set_log_function

709

global_set_log_function.argtypes = [log_func]

710

global_set_log_function.restype = None

711

712

deinit = _library.gnutls_deinit

713

deinit.argtypes = [session_t]

714

deinit.restype = None

715

716

handshake = _library.gnutls_handshake

717

handshake.argtypes = [session_t]

718

handshake.restype = _error_code

719

handshake.errcheck = _retry_on_error

720

721

transport_set_ptr = _library.gnutls_transport_set_ptr

722

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

723

transport_set_ptr.restype = None

724

725

bye = _library.gnutls_bye

726

bye.argtypes = [session_t, close_request_t]

727

bye.restype = _error_code

728

bye.errcheck = _retry_on_error

729

730

check_version = _library.gnutls_check_version

731

check_version.argtypes = [ctypes.c_char_p]

732

check_version.restype = ctypes.c_char_p

733

734

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

735

736

openpgp_crt_init = _library.gnutls_openpgp_crt_init

737

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

738

openpgp_crt_init.restype = _error_code

739

740

openpgp_crt_import = _library.gnutls_openpgp_crt_import

741

openpgp_crt_import.argtypes = [openpgp_crt_t,

742

ctypes.POINTER(datum_t),

743

openpgp_crt_fmt_t]

744

openpgp_crt_import.restype = _error_code

745

746

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

747

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

748

ctypes.POINTER(ctypes.c_uint)]

749

openpgp_crt_verify_self.restype = _error_code

750

751

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

752

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

753

openpgp_crt_deinit.restype = None

754

755

openpgp_crt_get_fingerprint = (

756

_library.gnutls_openpgp_crt_get_fingerprint)

757

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

758

ctypes.c_void_p,

759

ctypes.POINTER(

760

ctypes.c_size_t)]

761

openpgp_crt_get_fingerprint.restype = _error_code

762

763

# Remove non-public functions

764

del _error_code, _retry_on_error

765

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

766

gnutls = GnuTLS()

767

768

769

def call_pipe(connection, # : multiprocessing.Connection

770

func, *args, **kwargs):

771

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

772

773

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

774

return value on the provided multiprocessing.Connection.

775

"""

776

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

777

connection.close()

408

778

409

779

410

780

class Client(object):

411

781

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

412

782

413

783

Attributes:

414

784

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

415

785

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

417

787

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

418

788

to see if the client lives.

419

789

'None' if no process is running.

420

checker_callback_tag: a gobject event source tag, or None

790

checker_callback_tag: a GLib event source tag, or None

421

791

checker_command: string; External command which is run to check

422

792

if client lives. %() expansions are done at

423

793

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

424

794

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

425

checker_initiator_tag: a gobject event source tag, or None

795

checker_initiator_tag: a GLib event source tag, or None

426

796

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

427

797

client_structure: Object describing what attributes a client has

428

798

and is used for storing the client at exit

429

799

current_checker_command: string; current running checker_command

430

disable_initiator_tag: a gobject event source tag, or None

800

disable_initiator_tag: a GLib event source tag, or None

431

801

enabled: bool()

432

802

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

433

803

uniquely identify the client

438

808

last_checker_status: integer between 0 and 255 reflecting exit

439

809

status of last checker. -1 reflects crashed

440

810

checker, -2 means no checker completed yet.

811

last_checker_signal: The signal which killed the last checker, if

812

last_checker_status is -1

441

813

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

442

814

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

443

815

D-Bus identifiers

450

822

disabled, or None

451

823

server_settings: The server_settings dict from main()

452

824

"""

453

825

454

826

runtime_expansions = ("approval_delay", "approval_duration",

455

827

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

456

828

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

457

829

"last_approval_request", "last_checked_ok",

458

830

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

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

462

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

463

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

466

"approved_by_default": "True",

467

"enabled": "True",

468

}

469

470

def timeout_milliseconds(self):

471

"Return the 'timeout' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.timeout)

473

474

def extended_timeout_milliseconds(self):

475

"Return the 'extended_timeout' attribute in milliseconds"

476

return timedelta_to_milliseconds(self.extended_timeout)

477

478

def interval_milliseconds(self):

479

"Return the 'interval' attribute in milliseconds"

480

return timedelta_to_milliseconds(self.interval)

481

482

def approval_delay_milliseconds(self):

483

return timedelta_to_milliseconds(self.approval_delay)

484

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

485

843

@staticmethod

486

844

def config_parser(config):

487

845

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

494

852

for client_name in config.sections():

495

853

section = dict(config.items(client_name))

496

854

client = settings[client_name] = {}

497

855

498

856

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

499

857

# Reformat values from string types to Python types

500

858

client["approved_by_default"] = config.getboolean(

501

859

client_name, "approved_by_default")

502

860

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

503

861

"enabled")

504

862

863

# Uppercase and remove spaces from fingerprint for later

864

# comparison purposes with return value from the

865

# fingerprint() function

505

866

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

506

867

.replace(" ", ""))

507

868

if "secret" in section:

508

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

869

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

870

.encode("utf-8"),

871

"base64")

509

872

elif "secfile" in section:

510

873

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

511

874

(section["secfile"])),

512

875

"rb") as secfile:

513

876

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

514

877

else:

515

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

878

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

516

879

.format(section))

517

880

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

518

881

client["extended_timeout"] = string_to_delta(

526

889

client["last_approval_request"] = None

527

890

client["last_checked_ok"] = None

528

891

client["last_checker_status"] = -2

529

892

530

893

return settings

531

532

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

894

895

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

533

896

self.name = name

534

897

if server_settings is None:

535

898

server_settings = {}

536

899

self.server_settings = server_settings

537

900

# adding all client settings

538

for setting, value in settings.iteritems():

901

for setting, value in settings.items():

539

902

setattr(self, setting, value)

540

903

541

904

if self.enabled:

542

905

if not hasattr(self, "last_enabled"):

543

906

self.last_enabled = datetime.datetime.utcnow()

547

910

else:

548

911

self.last_enabled = None

549

912

self.expires = None

550

913

551

914

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

552

# Uppercase and remove spaces from fingerprint for later

553

# comparison purposes with return value from the fingerprint()

554

# function

555

915

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

556

916

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

557

917

datetime.datetime.utcnow())

558

918

559

919

# attributes specific for this server instance

560

920

self.checker = None

561

921

self.checker_initiator_tag = None

564

924

self.current_checker_command = None

565

925

self.approved = None

566

926

self.approvals_pending = 0

567

self.changedstate = (multiprocessing_manager

568

.Condition(multiprocessing_manager

569

.Lock()))

570

self.client_structure = [attr for attr in

571

self.__dict__.iterkeys()

927

self.changedstate = multiprocessing_manager.Condition(

928

multiprocessing_manager.Lock())

929

self.client_structure = [attr

930

for attr in self.__dict__.keys()

572

931

if not attr.startswith("_")]

573

932

self.client_structure.append("client_structure")

574

575

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

576

lambda obj:

577

isinstance(obj,

578

property)):

933

934

for name, t in inspect.getmembers(

935

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

579

936

if not name.startswith("_"):

580

937

self.client_structure.append(name)

581

938

582

939

# Send notice to process children that client state has changed

583

940

def send_changedstate(self):

584

941

with self.changedstate:

585

942

self.changedstate.notify_all()

586

943

587

944

def enable(self):

588

945

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

589

946

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

594

951

self.last_enabled = datetime.datetime.utcnow()

595

952

self.init_checker()

596

953

self.send_changedstate()

597

954

598

955

def disable(self, quiet=True):

599

956

"""Disable this client."""

600

957

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

602

959

if not quiet:

603

960

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

604

961

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

605

gobject.source_remove(self.disable_initiator_tag)

962

GLib.source_remove(self.disable_initiator_tag)

606

963

self.disable_initiator_tag = None

607

964

self.expires = None

608

965

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

609

gobject.source_remove(self.checker_initiator_tag)

966

GLib.source_remove(self.checker_initiator_tag)

610

967

self.checker_initiator_tag = None

611

968

self.stop_checker()

612

969

self.enabled = False

613

970

if not quiet:

614

971

self.send_changedstate()

615

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

972

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

616

973

return False

617

974

618

975

def __del__(self):

619

976

self.disable()

620

977

621

978

def init_checker(self):

622

979

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

623

980

# and every interval from then on.

624

981

if self.checker_initiator_tag is not None:

625

gobject.source_remove(self.checker_initiator_tag)

626

self.checker_initiator_tag = (gobject.timeout_add

627

(self.interval_milliseconds(),

628

self.start_checker))

982

GLib.source_remove(self.checker_initiator_tag)

983

self.checker_initiator_tag = GLib.timeout_add(

984

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

985

self.start_checker)

629

986

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

630

987

if self.disable_initiator_tag is not None:

631

gobject.source_remove(self.disable_initiator_tag)

632

self.disable_initiator_tag = (gobject.timeout_add

633

(self.timeout_milliseconds(),

634

self.disable))

988

GLib.source_remove(self.disable_initiator_tag)

989

self.disable_initiator_tag = GLib.timeout_add(

990

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

635

991

# Also start a new checker *right now*.

636

992

self.start_checker()

637

638

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

993

994

def checker_callback(self, source, condition, connection,

995

command):

639

996

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

640

997

self.checker_callback_tag = None

641

998

self.checker = None

642

if os.WIFEXITED(condition):

643

self.last_checker_status = os.WEXITSTATUS(condition)

999

# Read return code from connection (see call_pipe)

1000

returncode = connection.recv()

1001

connection.close()

1002

1003

if returncode >= 0:

1004

self.last_checker_status = returncode

1005

self.last_checker_signal = None

644

1006

if self.last_checker_status == 0:

645

1007

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

646

1008

vars(self))

647

1009

self.checked_ok()

648

1010

else:

649

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

650

vars(self))

1011

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

651

1012

else:

652

1013

self.last_checker_status = -1

1014

self.last_checker_signal = -returncode

653

1015

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

654

1016

vars(self))

655

1017

return False

1018

656

1019

def checked_ok(self):

657

1020

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

658

1021

self.last_checked_ok = datetime.datetime.utcnow()

659

1022

self.last_checker_status = 0

1023

self.last_checker_signal = None

660

1024

self.bump_timeout()

661

1025

662

1026

def bump_timeout(self, timeout=None):

663

1027

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

664

1028

if timeout is None:

665

1029

timeout = self.timeout

666

1030

if self.disable_initiator_tag is not None:

667

gobject.source_remove(self.disable_initiator_tag)

1031

GLib.source_remove(self.disable_initiator_tag)

668

1032

self.disable_initiator_tag = None

669

1033

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

670

self.disable_initiator_tag = (gobject.timeout_add

671

(timedelta_to_milliseconds

672

(timeout), self.disable))

1034

self.disable_initiator_tag = GLib.timeout_add(

1035

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

673

1036

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

674

1037

675

1038

def need_approval(self):

676

1039

self.last_approval_request = datetime.datetime.utcnow()

677

1040

678

1041

def start_checker(self):

679

1042

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

680

1043

681

1044

If a checker already exists, leave it running and do

682

1045

nothing."""

683

1046

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

688

1051

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

689

1052

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

690

1053

# should be.

691

692

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

693

try:

694

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

695

except AttributeError:

696

pass

697

except OSError as error:

698

if error.errno != errno.ECHILD:

699

raise

700

else:

701

if pid:

702

logger.warning("Checker was a zombie")

703

gobject.source_remove(self.checker_callback_tag)

704

self.checker_callback(pid, status,

705

self.current_checker_command)

1054

1055

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

1056

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

1057

self.checker.join()

1058

self.checker = None

706

1059

# Start a new checker if needed

707

1060

if self.checker is None:

708

1061

# Escape attributes for the shell

709

escaped_attrs = dict(

710

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

711

for attr in

712

self.runtime_expansions)

1062

escaped_attrs = {

1063

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

1064

for attr in self.runtime_expansions}

713

1065

try:

714

1066

command = self.checker_command % escaped_attrs

715

1067

except TypeError as error:

716

1068

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

717

self.checker_command, exc_info=error)

718

return True # Try again later

1069

self.checker_command,

1070

exc_info=error)

1071

return True # Try again later

719

1072

self.current_checker_command = command

720

try:

721

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

722

command, self.name)

723

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

724

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

725

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

726

# always replaced by /dev/null.)

727

# The exception is when not debugging but nevertheless

728

# running in the foreground; use the previously

729

# created wnull.

730

popen_args = {}

731

if (not self.server_settings["debug"]

732

and self.server_settings["foreground"]):

733

popen_args.update({"stdout": wnull,

734

"stderr": wnull })

735

self.checker = subprocess.Popen(command,

736

close_fds=True,

737

shell=True, cwd="/",

738

**popen_args)

739

except OSError as error:

740

logger.error("Failed to start subprocess",

741

exc_info=error)

742

return True

743

self.checker_callback_tag = (gobject.child_watch_add

744

(self.checker.pid,

745

self.checker_callback,

746

data=command))

747

# The checker may have completed before the gobject

748

# watch was added. Check for this.

749

try:

750

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

751

except OSError as error:

752

if error.errno == errno.ECHILD:

753

# This should never happen

754

logger.error("Child process vanished",

755

exc_info=error)

756

return True

757

raise

758

if pid:

759

gobject.source_remove(self.checker_callback_tag)

760

self.checker_callback(pid, status, command)

761

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

1073

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

1074

self.name)

1075

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

1076

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

1077

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

1078

# always replaced by /dev/null.)

1079

# The exception is when not debugging but nevertheless

1080

# running in the foreground; use the previously

1081

# created wnull.

1082

popen_args = {"close_fds": True,

1083

"shell": True,

1084

"cwd": "/"}

1085

if (not self.server_settings["debug"]

1086

and self.server_settings["foreground"]):

1087

popen_args.update({"stdout": wnull,

1088

"stderr": wnull})

1089

pipe = multiprocessing.Pipe(duplex=False)

1090

self.checker = multiprocessing.Process(

1091

target=call_pipe,

1092

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

1093

kwargs=popen_args)

1094

self.checker.start()

1095

self.checker_callback_tag = GLib.io_add_watch(

1096

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

1097

self.checker_callback, pipe[0], command)

1098

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

762

1099

return True

763

1100

764

1101

def stop_checker(self):

765

1102

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

766

1103

if self.checker_callback_tag:

767

gobject.source_remove(self.checker_callback_tag)

1104

GLib.source_remove(self.checker_callback_tag)

768

1105

self.checker_callback_tag = None

769

1106

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

770

1107

return

771

1108

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

772

try:

773

self.checker.terminate()

774

#time.sleep(0.5)

775

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

776

# self.checker.kill()

777

except OSError as error:

778

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

779

raise

1109

self.checker.terminate()

780

1110

self.checker = None

781

1111

782

1112

783

def dbus_service_property(dbus_interface, signature="v",

784

access="readwrite", byte_arrays=False):

1113

def dbus_service_property(dbus_interface,

1114

signature="v",

1115

access="readwrite",

1116

byte_arrays=False):

785

1117

"""Decorators for marking methods of a DBusObjectWithProperties to

786

1118

become properties on the D-Bus.

787

1119

788

1120

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

789

1121

and with one argument by "Set".

790

1122

791

1123

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

792

1124

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

793

1125

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

796

1128

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

797

1129

if byte_arrays and signature != "ay":

798

1130

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

799

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

1131

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

1132

800

1133

def decorator(func):

801

1134

func._dbus_is_property = True

802

1135

func._dbus_interface = dbus_interface

805

1138

func._dbus_name = func.__name__

806

1139

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

807

1140

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

808

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1141

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

809

1142

return func

1143

810

1144

return decorator

811

1145

812

1146

813

1147

def dbus_interface_annotations(dbus_interface):

814

1148

"""Decorator for marking functions returning interface annotations

815

1149

816

1150

Usage:

817

1151

818

1152

@dbus_interface_annotations("org.example.Interface")

819

1153

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

820

1154

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

821

1155

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

822

1156

"false"}

823

1157

"""

1158

824

1159

def decorator(func):

825

1160

func._dbus_is_interface = True

826

1161

func._dbus_interface = dbus_interface

827

1162

func._dbus_name = dbus_interface

828

1163

return func

1164

829

1165

return decorator

830

1166

831

1167

832

1168

def dbus_annotations(annotations):

833

1169

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

834

1170

Usage:

835

1171

1172

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

1173

"org.freedesktop.DBus.Property."

1174

"EmitsChangedSignal": "false"})

836

1175

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

837

1176

access="r")

838

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

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

841

1177

def Property_dbus_property(self):

842

1178

return dbus.Boolean(False)

1179

1180

See also the DBusObjectWithAnnotations class.

843

1181

"""

1182

844

1183

def decorator(func):

845

1184

func._dbus_annotations = annotations

846

1185

return func

1186

847

1187

return decorator

848

1188

849

1189

850

1190

class DBusPropertyException(dbus.exceptions.DBusException):

851

1191

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

852

1192

"""

853

def __unicode__(self):

854

return unicode(str(self))

1193

pass

855

1194

856

1195

857

1196

class DBusPropertyAccessException(DBusPropertyException):

866

1205

pass

867

1206

868

1207

869

class DBusObjectWithProperties(dbus.service.Object):

870

"""A D-Bus object with properties.

871

872

Classes inheriting from this can use the dbus_service_property

873

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

874

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

1208

class DBusObjectWithAnnotations(dbus.service.Object):

1209

"""A D-Bus object with annotations.

1210

1211

Classes inheriting from this can use the dbus_annotations

1212

decorator to add annotations to methods or signals.

875

1213

"""

876

1214

877

1215

@staticmethod

878

1216

def _is_dbus_thing(thing):

879

1217

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

880

1218

881

1219

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

882

1220

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

883

1221

"""

884

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

1222

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

885

1223

False)

886

1224

887

1225

def _get_all_dbus_things(self, thing):

888

1226

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

889

1227

"""

890

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

891

name),

1228

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

892

1229

athing.__get__(self))

893

1230

for cls in self.__class__.__mro__

894

1231

for name, athing in

895

inspect.getmembers(cls,

896

self._is_dbus_thing(thing)))

897

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

898

1305

def _get_dbus_property(self, interface_name, property_name):

899

1306

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

900

1307

property with the specified name and interface.

901

1308

"""

902

for cls in self.__class__.__mro__:

903

for name, value in (inspect.getmembers

904

(cls,

905

self._is_dbus_thing("property"))):

1309

for cls in self.__class__.__mro__:

1310

for name, value in inspect.getmembers(

1311

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

906

1312

if (value._dbus_name == property_name

907

1313

and value._dbus_interface == interface_name):

908

1314

return value.__get__(self)

909

1315

910

1316

# No such property

911

raise DBusPropertyNotFound(self.dbus_object_path + ":"

912

+ interface_name + "."

913

+ property_name)

914

915

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

1317

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

1318

self.dbus_object_path, interface_name, property_name))

1319

1320

@classmethod

1321

def _get_all_interface_names(cls):

1322

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

1323

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

1324

"_dbus_interface", None)

1325

for x in (inspect.getmro(cls))

1326

for attr in dir(x))

1327

if name is not None)

1328

1329

@dbus.service.method(dbus.PROPERTIES_IFACE,

1330

in_signature="ss",

916

1331

out_signature="v")

917

1332

def Get(self, interface_name, property_name):

918

1333

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

924

1339

if not hasattr(value, "variant_level"):

925

1340

return value

926

1341

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

927

1342

928

1343

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

929

1344

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

930

1345

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

937

1352

# signatures other than "ay".

938

1353

if prop._dbus_signature != "ay":

939

1354

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

940

"'ay' signature {0!r}"

1355

"'ay' signature {!r}"

941

1356

.format(prop._dbus_signature))

942

1357

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

943

1358

for byte in value))

944

1359

prop(value)

945

946

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

1360

1361

@dbus.service.method(dbus.PROPERTIES_IFACE,

1362

in_signature="s",

947

1363

out_signature="a{sv}")

948

1364

def GetAll(self, interface_name):

949

1365

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

950

1366

standard.

951

1367

952

1368

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

953

1369

"""

954

1370

properties = {}

964

1380

if not hasattr(value, "variant_level"):

965

1381

properties[name] = value

966

1382

continue

967

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

968

value.variant_level+1)

1383

properties[name] = type(value)(

1384

value, variant_level=value.variant_level + 1)

969

1385

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

970

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

971

1395

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

972

1396

out_signature="s",

973

1397

path_keyword='object_path',

974

1398

connection_keyword='connection')

975

1399

def Introspect(self, object_path, connection):

976

1400

"""Overloading of standard D-Bus method.

977

1401

978

1402

Inserts property tags and interface annotation tags.

979

1403

"""

980

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

981

connection)

1404

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1405

object_path,

1406

connection)

982

1407

try:

983

1408

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

1409

984

1410

def make_tag(document, name, prop):

985

1411

e = document.createElement("property")

986

1412

e.setAttribute("name", name)

987

1413

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

988

1414

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

989

1415

return e

1416

990

1417

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

991

1418

# Add property tags

992

1419

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

995

1422

if prop._dbus_interface

996

1423

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

997

1424

if_tag.appendChild(tag)

998

# Add annotation tags

999

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

1000

for tag in if_tag.getElementsByTagName(typ):

1001

annots = dict()

1002

for name, prop in (self.

1003

_get_all_dbus_things(typ)):

1004

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

1005

and prop._dbus_interface

1006

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

1007

annots.update(getattr

1008

(prop,

1009

"_dbus_annotations",

1010

{}))

1011

for name, value in annots.iteritems():

1012

ann_tag = document.createElement(

1013

"annotation")

1014

ann_tag.setAttribute("name", name)

1015

ann_tag.setAttribute("value", value)

1016

tag.appendChild(ann_tag)

1017

# Add interface annotation tags

1018

for annotation, value in dict(

1019

itertools.chain.from_iterable(

1020

annotations().iteritems()

1021

for name, annotations in

1022

self._get_all_dbus_things("interface")

1023

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

1024

)).iteritems():

1025

ann_tag = document.createElement("annotation")

1026

ann_tag.setAttribute("name", annotation)

1027

ann_tag.setAttribute("value", value)

1028

if_tag.appendChild(ann_tag)

1425

# Add annotation tags for properties

1426

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

1427

annots = dict()

1428

for name, prop in self._get_all_dbus_things(

1429

"property"):

1430

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

1431

and prop._dbus_interface

1432

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

1433

annots.update(getattr(

1434

prop, "_dbus_annotations", {}))

1435

for name, value in annots.items():

1436

ann_tag = document.createElement(

1437

"annotation")

1438

ann_tag.setAttribute("name", name)

1439

ann_tag.setAttribute("value", value)

1440

tag.appendChild(ann_tag)

1029

1441

# Add the names to the return values for the

1030

1442

# "org.freedesktop.DBus.Properties" methods

1031

1443

if (if_tag.getAttribute("name")

1050

1462

return xmlstring

1051

1463

1052

1464

1465

try:

1466

dbus.OBJECT_MANAGER_IFACE

1467

except AttributeError:

1468

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

1469

1470

1471

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1472

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

1473

1474

Classes inheriting from this exposes the standard

1475

GetManagedObjects call and the InterfacesAdded and

1476

InterfacesRemoved signals on the standard

1477

"org.freedesktop.DBus.ObjectManager" interface.

1478

1479

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

1480

manually.

1481

"""

1482

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1483

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

1484

def GetManagedObjects(self):

1485

"""This function must be overridden"""

1486

raise NotImplementedError()

1487

1488

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1489

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

1490

def InterfacesAdded(self, object_path, interfaces_and_properties):

1491

pass

1492

1493

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

1494

def InterfacesRemoved(self, object_path, interfaces):

1495

pass

1496

1497

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1498

out_signature="s",

1499

path_keyword='object_path',

1500

connection_keyword='connection')

1501

def Introspect(self, object_path, connection):

1502

"""Overloading of standard D-Bus method.

1503

1504

Override return argument name of GetManagedObjects to be

1505

"objpath_interfaces_and_properties"

1506

"""

1507

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1508

object_path,

1509

connection)

1510

try:

1511

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

1512

1513

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

1514

# Fix argument name for the GetManagedObjects method

1515

if (if_tag.getAttribute("name")

1516

== dbus.OBJECT_MANAGER_IFACE):

1517

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

1518

if (cn.getAttribute("name")

1519

== "GetManagedObjects"):

1520

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

1521

if (arg.getAttribute("direction")

1522

== "out"):

1523

arg.setAttribute(

1524

"name",

1525

"objpath_interfaces"

1526

"_and_properties")

1527

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

1528

document.unlink()

1529

except (AttributeError, xml.dom.DOMException,

1530

xml.parsers.expat.ExpatError) as error:

1531

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

1532

exc_info=error)

1533

return xmlstring

1534

1535

1053

1536

def datetime_to_dbus(dt, variant_level=0):

1054

1537

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

1055

1538

if dt is None:

1056

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

1057

return dbus.String(dt.isoformat(),

1058

variant_level=variant_level)

1539

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

1540

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

1059

1541

1060

1542

1061

1543

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1063

1545

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

1064

1546

interface names according to the "alt_interface_names" mapping.

1065

1547

Usage:

1066

1548

1067

1549

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

1068

1550

"net.example.AlternateInterface"})

1069

1551

class SampleDBusObject(dbus.service.Object):

1070

1552

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

1071

1553

def SampleDBusMethod():

1072

1554

pass

1073

1555

1074

1556

The above "SampleDBusMethod" on "SampleDBusObject" will be

1075

1557

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

1076

1558

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

1077

1559

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

1078

1560

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

1079

1561

1080

1562

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

1081

1563

(from DBusObjectWithProperties) and interfaces (from the

1082

1564

dbus_interface_annotations decorator).

1083

1565

"""

1566

1084

1567

def wrapper(cls):

1085

1568

for orig_interface_name, alt_interface_name in (

1086

alt_interface_names.iteritems()):

1569

alt_interface_names.items()):

1087

1570

attr = {}

1088

1571

interface_names = set()

1089

1572

# Go though all attributes of the class

1091

1574

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

1092

1575

# with the wrong interface name

1093

1576

if (not hasattr(attribute, "_dbus_interface")

1094

or not attribute._dbus_interface

1095

.startswith(orig_interface_name)):

1577

or not attribute._dbus_interface.startswith(

1578

orig_interface_name)):

1096

1579

continue

1097

1580

# Create an alternate D-Bus interface name based on

1098

1581

# the current name

1099

alt_interface = (attribute._dbus_interface

1100

.replace(orig_interface_name,

1101

alt_interface_name))

1582

alt_interface = attribute._dbus_interface.replace(

1583

orig_interface_name, alt_interface_name)

1102

1584

interface_names.add(alt_interface)

1103

1585

# Is this a D-Bus signal?

1104

1586

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

1105

1587

# Extract the original non-method undecorated

1106

1588

# function by black magic

1107

nonmethod_func = (dict(

1589

if sys.version_info.major == 2:

1590

nonmethod_func = (dict(

1108

1591

zip(attribute.func_code.co_freevars,

1109

attribute.__closure__))["func"]

1110

.cell_contents)

1592

attribute.__closure__))

1593

["func"].cell_contents)

1594

else:

1595

nonmethod_func = (dict(

1596

zip(attribute.__code__.co_freevars,

1597

attribute.__closure__))

1598

["func"].cell_contents)

1111

1599

# Create a new, but exactly alike, function

1112

1600

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

1113

1601

# with the alternate D-Bus interface name

1114

new_function = (dbus.service.signal

1115

(alt_interface,

1116

attribute._dbus_signature)

1117

(types.FunctionType(

1118

nonmethod_func.func_code,

1119

nonmethod_func.func_globals,

1120

nonmethod_func.func_name,

1121

nonmethod_func.func_defaults,

1122

nonmethod_func.func_closure)))

1602

new_function = copy_function(nonmethod_func)

1603

new_function = (dbus.service.signal(

1604

alt_interface,

1605

attribute._dbus_signature)(new_function))

1123

1606

# Copy annotations, if any

1124

1607

try:

1125

new_function._dbus_annotations = (

1126

dict(attribute._dbus_annotations))

1608

new_function._dbus_annotations = dict(

1609

attribute._dbus_annotations)

1127

1610

except AttributeError:

1128

1611

pass

1612

1129

1613

# Define a creator of a function to call both the

1130

1614

# original and alternate functions, so both the

1131

1615

# original and alternate signals gets sent when

1134

1618

"""This function is a scope container to pass

1135

1619

func1 and func2 to the "call_both" function

1136

1620

outside of its arguments"""

1621

1622

@functools.wraps(func2)

1137

1623

def call_both(*args, **kwargs):

1138

1624

"""This function will emit two D-Bus

1139

1625

signals by calling func1 and func2"""

1140

1626

func1(*args, **kwargs)

1141

1627

func2(*args, **kwargs)

1628

# Make wrapper function look like a D-Bus

1629

# signal

1630

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

1631

if name.startswith("_dbus_"):

1632

setattr(call_both, name, attr)

1633

1142

1634

return call_both

1143

1635

# Create the "call_both" function and add it to

1144

1636

# the class

1149

1641

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

1150

1642

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

1151

1643

# to the class.

1152

attr[attrname] = (dbus.service.method

1153

(alt_interface,

1154

attribute._dbus_in_signature,

1155

attribute._dbus_out_signature)

1156

(types.FunctionType

1157

(attribute.func_code,

1158

attribute.func_globals,

1159

attribute.func_name,

1160

attribute.func_defaults,

1161

attribute.func_closure)))

1644

attr[attrname] = (

1645

dbus.service.method(

1646

alt_interface,

1647

attribute._dbus_in_signature,

1648

attribute._dbus_out_signature)

1649

(copy_function(attribute)))

1162

1650

# Copy annotations, if any

1163

1651

try:

1164

attr[attrname]._dbus_annotations = (

1165

dict(attribute._dbus_annotations))

1652

attr[attrname]._dbus_annotations = dict(

1653

attribute._dbus_annotations)

1166

1654

except AttributeError:

1167

1655

pass

1168

1656

# Is this a D-Bus property?

1171

1659

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

1172

1660

# property with the alternate D-Bus interface

1173

1661

# name. Add it to the class.

1174

attr[attrname] = (dbus_service_property

1175

(alt_interface,

1176

attribute._dbus_signature,

1177

attribute._dbus_access,

1178

attribute

1179

._dbus_get_args_options

1180

["byte_arrays"])

1181

(types.FunctionType

1182

(attribute.func_code,

1183

attribute.func_globals,

1184

attribute.func_name,

1185

attribute.func_defaults,

1186

attribute.func_closure)))

1662

attr[attrname] = (dbus_service_property(

1663

alt_interface, attribute._dbus_signature,

1664

attribute._dbus_access,

1665

attribute._dbus_get_args_options

1666

["byte_arrays"])

1667

(copy_function(attribute)))

1187

1668

# Copy annotations, if any

1188

1669

try:

1189

attr[attrname]._dbus_annotations = (

1190

dict(attribute._dbus_annotations))

1670

attr[attrname]._dbus_annotations = dict(

1671

attribute._dbus_annotations)

1191

1672

except AttributeError:

1192

1673

pass

1193

1674

# Is this a D-Bus interface?

1196

1677

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

1197

1678

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

1198

1679

# to the class.

1199

attr[attrname] = (dbus_interface_annotations

1200

(alt_interface)

1201

(types.FunctionType

1202

(attribute.func_code,

1203

attribute.func_globals,

1204

attribute.func_name,

1205

attribute.func_defaults,

1206

attribute.func_closure)))

1680

attr[attrname] = (

1681

dbus_interface_annotations(alt_interface)

1682

(copy_function(attribute)))

1207

1683

if deprecate:

1208

1684

# Deprecate all alternate interfaces

1209

iname="_AlternateDBusNames_interface_annotation{0}"

1685

iname = "_AlternateDBusNames_interface_annotation{}"

1210

1686

for interface_name in interface_names:

1687

1211

1688

@dbus_interface_annotations(interface_name)

1212

1689

def func(self):

1213

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

1214

"true" }

1690

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

1691

"true"}

1215

1692

# Find an unused name

1216

1693

for aname in (iname.format(i)

1217

1694

for i in itertools.count()):

1221

1698

if interface_names:

1222

1699

# Replace the class with a new subclass of it with

1223

1700

# methods, signals, etc. as created above.

1224

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

1225

(cls,), attr)

1701

if sys.version_info.major == 2:

1702

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

1703

(cls, ), attr)

1704

else:

1705

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

1706

(cls, ), attr)

1226

1707

return cls

1708

1227

1709

return wrapper

1228

1710

1229

1711

1230

1712

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

1231

"se.bsnet.fukt.Mandos"})

1713

"se.bsnet.fukt.Mandos"})

1232

1714

class ClientDBus(Client, DBusObjectWithProperties):

1233

1715

"""A Client class using D-Bus

1234

1716

1235

1717

Attributes:

1236

1718

dbus_object_path: dbus.ObjectPath

1237

1719

bus: dbus.SystemBus()

1238

1720

"""

1239

1721

1240

1722

runtime_expansions = (Client.runtime_expansions

1241

+ ("dbus_object_path",))

1242

1723

+ ("dbus_object_path", ))

1724

1725

_interface = "se.recompile.Mandos.Client"

1726

1243

1727

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

1244

1245

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

1728

1729

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

1246

1730

self.bus = bus

1247

1731

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

1248

1732

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

1249

1733

# the D-Bus

1250

client_object_name = unicode(self.name).translate(

1734

client_object_name = str(self.name).translate(

1251

1735

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

1252

1736

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

1253

self.dbus_object_path = (dbus.ObjectPath

1254

("/clients/" + client_object_name))

1737

self.dbus_object_path = dbus.ObjectPath(

1738

"/clients/" + client_object_name)

1255

1739

DBusObjectWithProperties.__init__(self, self.bus,

1256

1740

self.dbus_object_path)

1257

1258

def notifychangeproperty(transform_func,

1259

dbus_name, type_func=lambda x: x,

1260

variant_level=1):

1741

1742

def notifychangeproperty(transform_func, dbus_name,

1743

type_func=lambda x: x,

1744

variant_level=1,

1745

invalidate_only=False,

1746

_interface=_interface):

1261

1747

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

1262

1748

its changes to DBus.

1263

1749

1264

1750

transform_fun: Function that takes a value and a variant_level

1265

1751

and transforms it to a D-Bus type.

1266

1752

dbus_name: D-Bus name of the variable

1268

1754

to the D-Bus. Default: no transform

1269

1755

variant_level: D-Bus variant level. Default: 1

1270

1756

"""

1271

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

1757

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

1758

1272

1759

def setter(self, value):

1273

1760

if hasattr(self, "dbus_object_path"):

1274

1761

if (not hasattr(self, attrname) or

1275

1762

type_func(getattr(self, attrname, None))

1276

1763

!= type_func(value)):

1277

dbus_value = transform_func(type_func(value),

1278

variant_level

1279

=variant_level)

1280

self.PropertyChanged(dbus.String(dbus_name),

1281

dbus_value)

1764

if invalidate_only:

1765

self.PropertiesChanged(

1766

_interface, dbus.Dictionary(),

1767

dbus.Array((dbus_name, )))

1768

else:

1769

dbus_value = transform_func(

1770

type_func(value),

1771

variant_level=variant_level)

1772

self.PropertyChanged(dbus.String(dbus_name),

1773

dbus_value)

1774

self.PropertiesChanged(

1775

_interface,

1776

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

1777

dbus_value}),

1778

dbus.Array())

1282

1779

setattr(self, attrname, value)

1283

1780

1284

1781

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

1285

1782

1286

1783

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1287

1784

approvals_pending = notifychangeproperty(dbus.Boolean,

1288

1785

"ApprovalPending",

1289

type_func = bool)

1786

type_func=bool)

1290

1787

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

1291

1788

last_enabled = notifychangeproperty(datetime_to_dbus,

1292

1789

"LastEnabled")

1293

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

1294

type_func = lambda checker:

1295

checker is not None)

1790

checker = notifychangeproperty(

1791

dbus.Boolean, "CheckerRunning",

1792

type_func=lambda checker: checker is not None)

1296

1793

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1297

1794

"LastCheckedOK")

1298

1795

last_checker_status = notifychangeproperty(dbus.Int16,

1301

1798

datetime_to_dbus, "LastApprovalRequest")

1302

1799

approved_by_default = notifychangeproperty(dbus.Boolean,

1303

1800

"ApprovedByDefault")

1304

approval_delay = notifychangeproperty(dbus.UInt64,

1305

"ApprovalDelay",

1306

type_func =

1307

timedelta_to_milliseconds)

1801

approval_delay = notifychangeproperty(

1802

dbus.UInt64, "ApprovalDelay",

1803

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

1308

1804

approval_duration = notifychangeproperty(

1309

1805

dbus.UInt64, "ApprovalDuration",

1310

type_func = timedelta_to_milliseconds)

1806

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

1311

1807

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

1312

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

1313

type_func =

1314

timedelta_to_milliseconds)

1808

timeout = notifychangeproperty(

1809

dbus.UInt64, "Timeout",

1810

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

1315

1811

extended_timeout = notifychangeproperty(

1316

1812

dbus.UInt64, "ExtendedTimeout",

1317

type_func = timedelta_to_milliseconds)

1318

interval = notifychangeproperty(dbus.UInt64,

1319

"Interval",

1320

type_func =

1321

timedelta_to_milliseconds)

1813

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

1814

interval = notifychangeproperty(

1815

dbus.UInt64, "Interval",

1816

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

1322

1817

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

1323

1818

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

1819

invalidate_only=True)

1820

1324

1821

del notifychangeproperty

1325

1822

1326

1823

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

1327

1824

try:

1328

1825

self.remove_from_connection()

1331

1828

if hasattr(DBusObjectWithProperties, "__del__"):

1332

1829

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

1333

1830

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

1334

1335

def checker_callback(self, pid, condition, command,

1336

*args, **kwargs):

1337

self.checker_callback_tag = None

1338

self.checker = None

1339

if os.WIFEXITED(condition):

1340

exitstatus = os.WEXITSTATUS(condition)

1831

1832

def checker_callback(self, source, condition,

1833

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

1834

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

1835

connection, command, *args,

1836

**kwargs)

1837

exitstatus = self.last_checker_status

1838

if exitstatus >= 0:

1341

1839

# Emit D-Bus signal

1342

1840

self.CheckerCompleted(dbus.Int16(exitstatus),

1343

dbus.Int64(condition),

1841

# This is specific to GNU libC

1842

dbus.Int64(exitstatus << 8),

1344

1843

dbus.String(command))

1345

1844

else:

1346

1845

# Emit D-Bus signal

1347

1846

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

1348

dbus.Int64(condition),

1847

dbus.Int64(

1848

# This is specific to GNU libC

1849

(exitstatus << 8)

1850

| self.last_checker_signal),

1349

1851

dbus.String(command))

1350

1351

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

1352

*args, **kwargs)

1353

1852

return ret

1853

1354

1854

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

1355

1855

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

1356

1856

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

1360

1860

# Emit D-Bus signal

1361

1861

self.CheckerStarted(self.current_checker_command)

1362

1862

return r

1363

1863

1364

1864

def _reset_approved(self):

1365

1865

self.approved = None

1366

1866

return False

1367

1867

1368

1868

def approve(self, value=True):

1369

1869

self.approved = value

1370

gobject.timeout_add(timedelta_to_milliseconds

1371

(self.approval_duration),

1372

self._reset_approved)

1870

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

1871

* 1000), self._reset_approved)

1373

1872

self.send_changedstate()

1374

1375

## D-Bus methods, signals & properties

1376

_interface = "se.recompile.Mandos.Client"

1377

1378

## Interfaces

1379

1380

@dbus_interface_annotations(_interface)

1381

def _foo(self):

1382

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

1383

"false"}

1384

1385

## Signals

1386

1873

1874

# D-Bus methods, signals & properties

1875

1876

# Interfaces

1877

1878

# Signals

1879

1387

1880

# CheckerCompleted - signal

1388

1881

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

1389

1882

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

1390

1883

"D-Bus signal"

1391

1884

pass

1392

1885

1393

1886

# CheckerStarted - signal

1394

1887

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

1395

1888

def CheckerStarted(self, command):

1396

1889

"D-Bus signal"

1397

1890

pass

1398

1891

1399

1892

# PropertyChanged - signal

1893

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

1400

1894

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

1401

1895

def PropertyChanged(self, property, value):

1402

1896

"D-Bus signal"

1403

1897

pass

1404

1898

1405

1899

# GotSecret - signal

1406

1900

@dbus.service.signal(_interface)

1407

1901

def GotSecret(self):

1410

1904

server to mandos-client

1411

1905

"""

1412

1906

pass

1413

1907

1414

1908

# Rejected - signal

1415

1909

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

1416

1910

def Rejected(self, reason):

1417

1911

"D-Bus signal"

1418

1912

pass

1419

1913

1420

1914

# NeedApproval - signal

1421

1915

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

1422

1916

def NeedApproval(self, timeout, default):

1423

1917

"D-Bus signal"

1424

1918

return self.need_approval()

1425

1426

## Methods

1427

1919

1920

# Methods

1921

1428

1922

# Approve - method

1429

1923

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

1430

1924

def Approve(self, value):

1431

1925

self.approve(value)

1432

1926

1433

1927

# CheckedOK - method

1434

1928

@dbus.service.method(_interface)

1435

1929

def CheckedOK(self):

1436

1930

self.checked_ok()

1437

1931

1438

1932

# Enable - method

1933

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

1439

1934

@dbus.service.method(_interface)

1440

1935

def Enable(self):

1441

1936

"D-Bus method"

1442

1937

self.enable()

1443

1938

1444

1939

# StartChecker - method

1940

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

1445

1941

@dbus.service.method(_interface)

1446

1942

def StartChecker(self):

1447

1943

"D-Bus method"

1448

1944

self.start_checker()

1449

1945

1450

1946

# Disable - method

1947

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

1451

1948

@dbus.service.method(_interface)

1452

1949

def Disable(self):

1453

1950

"D-Bus method"

1454

1951

self.disable()

1455

1952

1456

1953

# StopChecker - method

1954

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

1457

1955

@dbus.service.method(_interface)

1458

1956

def StopChecker(self):

1459

1957

self.stop_checker()

1460

1461

## Properties

1462

1958

1959

# Properties

1960

1463

1961

# ApprovalPending - property

1464

1962

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

1465

1963

def ApprovalPending_dbus_property(self):

1466

1964

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

1467

1965

1468

1966

# ApprovedByDefault - property

1469

@dbus_service_property(_interface, signature="b",

1967

@dbus_service_property(_interface,

1968

signature="b",

1470

1969

access="readwrite")

1471

1970

def ApprovedByDefault_dbus_property(self, value=None):

1472

1971

if value is None: # get

1473

1972

return dbus.Boolean(self.approved_by_default)

1474

1973

self.approved_by_default = bool(value)

1475

1974

1476

1975

# ApprovalDelay - property

1477

@dbus_service_property(_interface, signature="t",

1976

@dbus_service_property(_interface,

1977

signature="t",

1478

1978

access="readwrite")

1479

1979

def ApprovalDelay_dbus_property(self, value=None):

1480

1980

if value is None: # get

1481

return dbus.UInt64(self.approval_delay_milliseconds())

1981

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

1982

* 1000)

1482

1983

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

1483

1984

1484

1985

# ApprovalDuration - property

1485

@dbus_service_property(_interface, signature="t",

1986

@dbus_service_property(_interface,

1987

signature="t",

1486

1988

access="readwrite")

1487

1989

def ApprovalDuration_dbus_property(self, value=None):

1488

1990

if value is None: # get

1489

return dbus.UInt64(timedelta_to_milliseconds(

1490

self.approval_duration))

1991

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

1992

* 1000)

1491

1993

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

1492

1994

1493

1995

# Name - property

1996

@dbus_annotations(

1997

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

1494

1998

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

1495

1999

def Name_dbus_property(self):

1496

2000

return dbus.String(self.name)

1497

2001

1498

2002

# Fingerprint - property

2003

@dbus_annotations(

2004

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

1499

2005

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

1500

2006

def Fingerprint_dbus_property(self):

1501

2007

return dbus.String(self.fingerprint)

1502

2008

1503

2009

# Host - property

1504

@dbus_service_property(_interface, signature="s",

2010

@dbus_service_property(_interface,

2011

signature="s",

1505

2012

access="readwrite")

1506

2013

def Host_dbus_property(self, value=None):

1507

2014

if value is None: # get

1508

2015

return dbus.String(self.host)

1509

self.host = unicode(value)

1510

2016

self.host = str(value)

2017

1511

2018

# Created - property

2019

@dbus_annotations(

2020

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

1512

2021

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

1513

2022

def Created_dbus_property(self):

1514

2023

return datetime_to_dbus(self.created)

1515

2024

1516

2025

# LastEnabled - property

1517

2026

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

1518

2027

def LastEnabled_dbus_property(self):

1519

2028

return datetime_to_dbus(self.last_enabled)

1520

2029

1521

2030

# Enabled - property

1522

@dbus_service_property(_interface, signature="b",

2031

@dbus_service_property(_interface,

2032

signature="b",

1523

2033

access="readwrite")

1524

2034

def Enabled_dbus_property(self, value=None):

1525

2035

if value is None: # get

1528

2038

self.enable()

1529

2039

else:

1530

2040

self.disable()

1531

2041

1532

2042

# LastCheckedOK - property

1533

@dbus_service_property(_interface, signature="s",

2043

@dbus_service_property(_interface,

2044

signature="s",

1534

2045

access="readwrite")

1535

2046

def LastCheckedOK_dbus_property(self, value=None):

1536

2047

if value is not None:

1537

2048

self.checked_ok()

1538

2049

return

1539

2050

return datetime_to_dbus(self.last_checked_ok)

1540

2051

1541

2052

# LastCheckerStatus - property

1542

@dbus_service_property(_interface, signature="n",

1543

access="read")

2053

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

1544

2054

def LastCheckerStatus_dbus_property(self):

1545

2055

return dbus.Int16(self.last_checker_status)

1546

2056

1547

2057

# Expires - property

1548

2058

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

1549

2059

def Expires_dbus_property(self):

1550

2060

return datetime_to_dbus(self.expires)

1551

2061

1552

2062

# LastApprovalRequest - property

1553

2063

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

1554

2064

def LastApprovalRequest_dbus_property(self):

1555

2065

return datetime_to_dbus(self.last_approval_request)

1556

2066

1557

2067

# Timeout - property

1558

@dbus_service_property(_interface, signature="t",

2068

@dbus_service_property(_interface,

2069

signature="t",

1559

2070

access="readwrite")

1560

2071

def Timeout_dbus_property(self, value=None):

1561

2072

if value is None: # get

1562

return dbus.UInt64(self.timeout_milliseconds())

2073

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

1563

2074

old_timeout = self.timeout

1564

2075

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

1565

2076

# Reschedule disabling

1573

2084

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

1574

2085

is None):

1575

2086

return

1576

gobject.source_remove(self.disable_initiator_tag)

1577

self.disable_initiator_tag = (

1578

gobject.timeout_add(

1579

timedelta_to_milliseconds(self.expires - now),

1580

self.disable))

1581

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

1582

2092

# ExtendedTimeout - property

1583

@dbus_service_property(_interface, signature="t",

2093

@dbus_service_property(_interface,

2094

signature="t",

1584

2095

access="readwrite")

1585

2096

def ExtendedTimeout_dbus_property(self, value=None):

1586

2097

if value is None: # get

1587

return dbus.UInt64(self.extended_timeout_milliseconds())

2098

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

2099

* 1000)

1588

2100

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

1589

2101

1590

2102

# Interval - property

1591

@dbus_service_property(_interface, signature="t",

2103

@dbus_service_property(_interface,

2104

signature="t",

1592

2105

access="readwrite")

1593

2106

def Interval_dbus_property(self, value=None):

1594

2107

if value is None: # get

1595

return dbus.UInt64(self.interval_milliseconds())

2108

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

1596

2109

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

1597

2110

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

1598

2111

return

1599

2112

if self.enabled:

1600

2113

# Reschedule checker run

1601

gobject.source_remove(self.checker_initiator_tag)

1602

self.checker_initiator_tag = (gobject.timeout_add

1603

(value, self.start_checker))

1604

self.start_checker() # Start one now, too

1605

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

1606

2119

# Checker - property

1607

@dbus_service_property(_interface, signature="s",

2120

@dbus_service_property(_interface,

2121

signature="s",

1608

2122

access="readwrite")

1609

2123

def Checker_dbus_property(self, value=None):

1610

2124

if value is None: # get

1611

2125

return dbus.String(self.checker_command)

1612

self.checker_command = unicode(value)

1613

2126

self.checker_command = str(value)

2127

1614

2128

# CheckerRunning - property

1615

@dbus_service_property(_interface, signature="b",

2129

@dbus_service_property(_interface,

2130

signature="b",

1616

2131

access="readwrite")

1617

2132

def CheckerRunning_dbus_property(self, value=None):

1618

2133

if value is None: # get

1621

2136

self.start_checker()

1622

2137

else:

1623

2138

self.stop_checker()

1624

2139

1625

2140

# ObjectPath - property

2141

@dbus_annotations(

2142

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

2143

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

1626

2144

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

1627

2145

def ObjectPath_dbus_property(self):

1628

return self.dbus_object_path # is already a dbus.ObjectPath

1629

2146

return self.dbus_object_path # is already a dbus.ObjectPath

2147

1630

2148

# Secret = property

1631

@dbus_service_property(_interface, signature="ay",

1632

access="write", byte_arrays=True)

2149

@dbus_annotations(

2150

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

2151

"invalidates"})

2152

@dbus_service_property(_interface,

2153

signature="ay",

2154

access="write",

2155

byte_arrays=True)

1633

2156

def Secret_dbus_property(self, value):

1634

self.secret = str(value)

1635

2157

self.secret = bytes(value)

2158

1636

2159

del _interface

1637

2160

1638

2161

1641

2164

self._pipe = child_pipe

1642

2165

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

1643

2166

if not self._pipe.recv():

1644

raise KeyError()

1645

2167

raise KeyError(fpr)

2168

1646

2169

def __getattribute__(self, name):

1647

2170

if name == '_pipe':

1648

2171

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

1651

2174

if data[0] == 'data':

1652

2175

return data[1]

1653

2176

if data[0] == 'function':

2177

1654

2178

def func(*args, **kwargs):

1655

2179

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

1656

2180

return self._pipe.recv()[1]

2181

1657

2182

return func

1658

2183

1659

2184

def __setattr__(self, name, value):

1660

2185

if name == '_pipe':

1661

2186

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

1664

2189

1665

2190

class ClientHandler(socketserver.BaseRequestHandler, object):

1666

2191

"""A class to handle client connections.

1667

2192

1668

2193

Instantiated once for each connection to handle it.

1669

2194

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

1670

2195

1671

2196

def handle(self):

1672

2197

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

1673

2198

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

1674

unicode(self.client_address))

2199

str(self.client_address))

1675

2200

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

1676

2201

self.server.child_pipe.fileno())

1677

1678

session = (gnutls.connection

1679

.ClientSession(self.request,

1680

gnutls.connection

1681

.X509Credentials()))

1682

1683

# Note: gnutls.connection.X509Credentials is really a

1684

# generic GnuTLS certificate credentials object so long as

1685

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

1686

# here despite using OpenPGP certificates.

1687

1688

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

1689

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

1690

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

1691

# "+DHE-DSS"))

2202

2203

session = gnutls.ClientSession(self.request)

2204

2205

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

2206

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

2207

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

2208

# "+DHE-DSS"))

1692

2209

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

1693

2210

priority = self.server.gnutls_priority

1694

2211

if priority is None:

1695

2212

priority = "NORMAL"

1696

(gnutls.library.functions

1697

.gnutls_priority_set_direct(session._c_object,

1698

priority, None))

1699

2213

gnutls.priority_set_direct(session._c_object,

2214

priority.encode("utf-8"),

2215

None)

2216

1700

2217

# Start communication using the Mandos protocol

1701

2218

# Get protocol number

1702

2219

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

1707

2224

except (ValueError, IndexError, RuntimeError) as error:

1708

2225

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

1709

2226

return

1710

2227

1711

2228

# Start GnuTLS connection

1712

2229

try:

1713

2230

session.handshake()

1714

except gnutls.errors.GNUTLSError as error:

2231

except gnutls.Error as error:

1715

2232

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

1716

2233

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

1717

2234

# established. Just abandon the request.

1718

2235

return

1719

2236

logger.debug("Handshake succeeded")

1720

2237

1721

2238

approval_required = False

1722

2239

try:

1723

2240

try:

1724

fpr = self.fingerprint(self.peer_certificate

1725

(session))

1726

except (TypeError,

1727

gnutls.errors.GNUTLSError) as error:

2241

fpr = self.fingerprint(

2242

self.peer_certificate(session))

2243

except (TypeError, gnutls.Error) as error:

1728

2244

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

1729

2245

return

1730

2246

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

1731

2247

1732

2248

try:

1733

2249

client = ProxyClient(child_pipe, fpr,

1734

2250

self.client_address)

1735

2251

except KeyError:

1736

2252

return

1737

2253

1738

2254

if client.approval_delay:

1739

2255

delay = client.approval_delay

1740

2256

client.approvals_pending += 1

1741

2257

approval_required = True

1742

2258

1743

2259

while True:

1744

2260

if not client.enabled:

1745

2261

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

1746

client.name)

2262

client.name)

1747

2263

if self.server.use_dbus:

1748

2264

# Emit D-Bus signal

1749

2265

client.Rejected("Disabled")

1750

2266

return

1751

2267

1752

2268

if client.approved or not client.approval_delay:

1753

#We are approved or approval is disabled

2269

# We are approved or approval is disabled

1754

2270

break

1755

2271

elif client.approved is None:

1756

2272

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

1758

2274

if self.server.use_dbus:

1759

2275

# Emit D-Bus signal

1760

2276

client.NeedApproval(

1761

client.approval_delay_milliseconds(),

1762

client.approved_by_default)

2277

client.approval_delay.total_seconds()

2278

* 1000, client.approved_by_default)

1763

2279

else:

1764

2280

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

1765

2281

client.name)

1767

2283

# Emit D-Bus signal

1768

2284

client.Rejected("Denied")

1769

2285

return

1770

1771

#wait until timeout or approved

2286

2287

# wait until timeout or approved

1772

2288

time = datetime.datetime.now()

1773

2289

client.changedstate.acquire()

1774

client.changedstate.wait(

1775

float(timedelta_to_milliseconds(delay)

1776

/ 1000))

2290

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

1777

2291

client.changedstate.release()

1778

2292

time2 = datetime.datetime.now()

1779

2293

if (time2 - time) >= delay:

1789

2303

break

1790

2304

else:

1791

2305

delay -= time2 - time

1792

1793

sent_size = 0

1794

while sent_size < len(client.secret):

1795

try:

1796

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

1797

except gnutls.errors.GNUTLSError as error:

1798

logger.warning("gnutls send failed",

1799

exc_info=error)

1800

return

1801

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

1802

sent, len(client.secret)

1803

- (sent_size + sent))

1804

sent_size += sent

1805

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

1806

2314

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

1807

2315

# bump the timeout using extended_timeout

1808

2316

client.bump_timeout(client.extended_timeout)

1809

2317

if self.server.use_dbus:

1810

2318

# Emit D-Bus signal

1811

2319

client.GotSecret()

1812

2320

1813

2321

finally:

1814

2322

if approval_required:

1815

2323

client.approvals_pending -= 1

1816

2324

try:

1817

2325

session.bye()

1818

except gnutls.errors.GNUTLSError as error:

2326

except gnutls.Error as error:

1819

2327

logger.warning("GnuTLS bye failed",

1820

2328

exc_info=error)

1821

2329

1822

2330

@staticmethod

1823

2331

def peer_certificate(session):

1824

2332

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

1825

2333

# If not an OpenPGP certificate...

1826

if (gnutls.library.functions

1827

.gnutls_certificate_type_get(session._c_object)

1828

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1829

# ...do the normal thing

1830

return session.peer_certificate

2334

if (gnutls.certificate_type_get(session._c_object)

2335

!= gnutls.CRT_OPENPGP):

2336

# ...return invalid data

2337

return b""

1831

2338

list_size = ctypes.c_uint(1)

1832

cert_list = (gnutls.library.functions

1833

.gnutls_certificate_get_peers

2339

cert_list = (gnutls.certificate_get_peers

1834

2340

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

1835

2341

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

1836

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

1837

" certificate")

2342

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

1838

2343

if list_size.value == 0:

1839

2344

return None

1840

2345

cert = cert_list[0]

1841

2346

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

1842

2347

1843

2348

@staticmethod

1844

2349

def fingerprint(openpgp):

1845

2350

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1846

2351

# New GnuTLS "datum" with the OpenPGP public key

1847

datum = (gnutls.library.types

1848

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

1849

ctypes.POINTER

1850

(ctypes.c_ubyte)),

1851

ctypes.c_uint(len(openpgp))))

2352

datum = gnutls.datum_t(

2353

ctypes.cast(ctypes.c_char_p(openpgp),

2354

ctypes.POINTER(ctypes.c_ubyte)),

2355

ctypes.c_uint(len(openpgp)))

1852

2356

# New empty GnuTLS certificate

1853

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1854

(gnutls.library.functions

1855

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2357

crt = gnutls.openpgp_crt_t()

2358

gnutls.openpgp_crt_init(ctypes.byref(crt))

1856

2359

# Import the OpenPGP public key into the certificate

1857

(gnutls.library.functions

1858

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

1859

gnutls.library.constants

1860

.GNUTLS_OPENPGP_FMT_RAW))

2360

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

2361

gnutls.OPENPGP_FMT_RAW)

1861

2362

# Verify the self signature in the key

1862

2363

crtverify = ctypes.c_uint()

1863

(gnutls.library.functions

1864

.gnutls_openpgp_crt_verify_self(crt, 0,

1865

ctypes.byref(crtverify)))

2364

gnutls.openpgp_crt_verify_self(crt, 0,

2365

ctypes.byref(crtverify))

1866

2366

if crtverify.value != 0:

1867

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1868

raise (gnutls.errors.CertificateSecurityError

1869

("Verify failed"))

2367

gnutls.openpgp_crt_deinit(crt)

2368

raise gnutls.CertificateSecurityError(code

2369

=crtverify.value)

1870

2370

# New buffer for the fingerprint

1871

2371

buf = ctypes.create_string_buffer(20)

1872

2372

buf_len = ctypes.c_size_t()

1873

2373

# Get the fingerprint from the certificate into the buffer

1874

(gnutls.library.functions

1875

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

1876

ctypes.byref(buf_len)))

2374

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

2375

ctypes.byref(buf_len))

1877

2376

# Deinit the certificate

1878

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2377

gnutls.openpgp_crt_deinit(crt)

1879

2378

# Convert the buffer to a Python bytestring

1880

2379

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

1881

2380

# Convert the bytestring to hexadecimal notation

1885

2384

1886

2385

class MultiprocessingMixIn(object):

1887

2386

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

2387

1888

2388

def sub_process_main(self, request, address):

1889

2389

try:

1890

2390

self.finish_request(request, address)

1891

2391

except Exception:

1892

2392

self.handle_error(request, address)

1893

2393

self.close_request(request)

1894

2394

1895

2395

def process_request(self, request, address):

1896

2396

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

1897

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

1898

args = (request, address))

2397

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

2398

args=(request, address))

1899

2399

proc.start()

1900

2400

return proc

1901

2401

1902

2402

1903

2403

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1904

2404

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

2405

1905

2406

def process_request(self, request, client_address):

1906

2407

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

1907

2408

1908

2409

This function creates a new pipe in self.pipe

1909

2410

"""

1910

2411

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1911

2412

1912

2413

proc = MultiprocessingMixIn.process_request(self, request,

1913

2414

client_address)

1914

2415

self.child_pipe.close()

1915

2416

self.add_pipe(parent_pipe, proc)

1916

2417

1917

2418

def add_pipe(self, parent_pipe, proc):

1918

2419

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

1919

2420

raise NotImplementedError()

1922

2423

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1923

2424

socketserver.TCPServer, object):

1924

2425

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

1925

2426

1926

2427

Attributes:

1927

2428

enabled: Boolean; whether this server is activated yet

1928

2429

interface: None or a network interface name (string)

1929

2430

use_ipv6: Boolean; to use IPv6 or not

1930

2431

"""

2432

1931

2433

def __init__(self, server_address, RequestHandlerClass,

1932

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

2434

interface=None,

2435

use_ipv6=True,

2436

socketfd=None):

1933

2437

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

1934

2438

creating a new one with socket.socket().

1935

2439

"""

1941

2445

self.socketfd = socketfd

1942

2446

# Save the original socket.socket() function

1943

2447

self.socket_socket = socket.socket

2448

1944

2449

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

1945

#

2450

#

1946

2451

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

1947

2452

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

1948

2453

# patching socket.socket.)

1949

#

2454

#

1950

2455

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

1951

2456

@functools.wraps(socket.socket)

1952

2457

def socket_wrapper(*args, **kwargs):

1964

2469

# socket_wrapper(), if socketfd was set.

1965

2470

socketserver.TCPServer.__init__(self, server_address,

1966

2471

RequestHandlerClass)

1967

2472

1968

2473

def server_bind(self):

1969

2474

"""This overrides the normal server_bind() function

1970

2475

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

1971

2476

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

2477

global SO_BINDTODEVICE

1972

2478

if self.interface is not None:

1973

2479

if SO_BINDTODEVICE is None:

1974

logger.error("SO_BINDTODEVICE does not exist;"

1975

" cannot bind to interface %s",

1976

self.interface)

1977

else:

1978

try:

1979

self.socket.setsockopt(socket.SOL_SOCKET,

1980

SO_BINDTODEVICE,

1981

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

1982

except socket.error as error:

1983

if error.errno == errno.EPERM:

1984

logger.error("No permission to bind to"

1985

" interface %s", self.interface)

1986

elif error.errno == errno.ENOPROTOOPT:

1987

logger.error("SO_BINDTODEVICE not available;"

1988

" cannot bind to interface %s",

1989

self.interface)

1990

elif error.errno == errno.ENODEV:

1991

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

1992

" cannot bind", self.interface)

1993

else:

1994

raise

2480

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

2481

# common enough.

2482

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

2483

SO_BINDTODEVICE = 25

2484

try:

2485

self.socket.setsockopt(

2486

socket.SOL_SOCKET, SO_BINDTODEVICE,

2487

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

2488

except socket.error as error:

2489

if error.errno == errno.EPERM:

2490

logger.error("No permission to bind to"

2491

" interface %s", self.interface)

2492

elif error.errno == errno.ENOPROTOOPT:

2493

logger.error("SO_BINDTODEVICE not available;"

2494

" cannot bind to interface %s",

2495

self.interface)

2496

elif error.errno == errno.ENODEV:

2497

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

2498

" cannot bind", self.interface)

2499

else:

2500

raise

1995

2501

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

1996

2502

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

1997

2503

if not self.server_address[0]:

1998

2504

if self.address_family == socket.AF_INET6:

1999

any_address = "::" # in6addr_any

2505

any_address = "::" # in6addr_any

2000

2506

else:

2001

any_address = "0.0.0.0" # INADDR_ANY

2507

any_address = "0.0.0.0" # INADDR_ANY

2002

2508

self.server_address = (any_address,

2003

2509

self.server_address[1])

2004

2510

elif not self.server_address[1]:

2005

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

2006

0)

2511

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

2007

2512

# if self.interface:

2008

2513

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

2009

2514

# 0, # port

2015

2520

2016

2521

class MandosServer(IPv6_TCPServer):

2017

2522

"""Mandos server.

2018

2523

2019

2524

Attributes:

2020

2525

clients: set of Client objects

2021

2526

gnutls_priority GnuTLS priority string

2022

2527

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

2023

2024

Assumes a gobject.MainLoop event loop.

2528

2529

Assumes a GLib.MainLoop event loop.

2025

2530

"""

2531

2026

2532

def __init__(self, server_address, RequestHandlerClass,

2027

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

2028

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

2533

interface=None,

2534

use_ipv6=True,

2535

clients=None,

2536

gnutls_priority=None,

2537

use_dbus=True,

2538

socketfd=None):

2029

2539

self.enabled = False

2030

2540

self.clients = clients

2031

2541

if self.clients is None:

2034

2544

self.gnutls_priority = gnutls_priority

2035

2545

IPv6_TCPServer.__init__(self, server_address,

2036

2546

RequestHandlerClass,

2037

interface = interface,

2038

use_ipv6 = use_ipv6,

2039

socketfd = socketfd)

2547

interface=interface,

2548

use_ipv6=use_ipv6,

2549

socketfd=socketfd)

2550

2040

2551

def server_activate(self):

2041

2552

if self.enabled:

2042

2553

return socketserver.TCPServer.server_activate(self)

2043

2554

2044

2555

def enable(self):

2045

2556

self.enabled = True

2046

2557

2047

2558

def add_pipe(self, parent_pipe, proc):

2048

2559

# Call "handle_ipc" for both data and EOF events

2049

gobject.io_add_watch(parent_pipe.fileno(),

2050

gobject.IO_IN | gobject.IO_HUP,

2051

functools.partial(self.handle_ipc,

2052

parent_pipe =

2053

parent_pipe,

2054

proc = proc))

2055

2056

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

2057

proc = None, client_object=None):

2560

GLib.io_add_watch(

2561

parent_pipe.fileno(),

2562

GLib.IO_IN | GLib.IO_HUP,

2563

functools.partial(self.handle_ipc,

2564

parent_pipe=parent_pipe,

2565

proc=proc))

2566

2567

def handle_ipc(self, source, condition,

2568

parent_pipe=None,

2569

proc=None,

2570

client_object=None):

2058

2571

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

2059

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

2572

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

2060

2573

# Wait for other process to exit

2061

2574

proc.join()

2062

2575

return False

2063

2576

2064

2577

# Read a request from the child

2065

2578

request = parent_pipe.recv()

2066

2579

command = request[0]

2067

2580

2068

2581

if command == 'init':

2069

fpr = request[1]

2582

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

2070

2583

address = request[2]

2071

2072

for c in self.clients.itervalues():

2584

2585

for c in self.clients.values():

2073

2586

if c.fingerprint == fpr:

2074

2587

client = c

2075

2588

break

2082

2595

address[0])

2083

2596

parent_pipe.send(False)

2084

2597

return False

2085

2086

gobject.io_add_watch(parent_pipe.fileno(),

2087

gobject.IO_IN | gobject.IO_HUP,

2088

functools.partial(self.handle_ipc,

2089

parent_pipe =

2090

parent_pipe,

2091

proc = proc,

2092

client_object =

2093

client))

2598

2599

GLib.io_add_watch(

2600

parent_pipe.fileno(),

2601

GLib.IO_IN | GLib.IO_HUP,

2602

functools.partial(self.handle_ipc,

2603

parent_pipe=parent_pipe,

2604

proc=proc,

2605

client_object=client))

2094

2606

parent_pipe.send(True)

2095

2607

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

2096

2608

# same fileno

2099

2611

funcname = request[1]

2100

2612

args = request[2]

2101

2613

kwargs = request[3]

2102

2614

2103

2615

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

2104

2616

funcname)(*args,

2105

**kwargs)))

2106

2617

**kwargs)))

2618

2107

2619

if command == 'getattr':

2108

2620

attrname = request[1]

2109

if callable(client_object.__getattribute__(attrname)):

2110

parent_pipe.send(('function',))

2621

if isinstance(client_object.__getattribute__(attrname),

2622

collections.Callable):

2623

parent_pipe.send(('function', ))

2111

2624

else:

2112

parent_pipe.send(('data', client_object

2113

.__getattribute__(attrname)))

2114

2625

parent_pipe.send((

2626

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

2627

2115

2628

if command == 'setattr':

2116

2629

attrname = request[1]

2117

2630

value = request[2]

2118

2631

setattr(client_object, attrname, value)

2119

2632

2120

2633

return True

2121

2634

2122

2635

2123

2636

def rfc3339_duration_to_delta(duration):

2124

2637

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

2125

2638

2126

2639

>>> rfc3339_duration_to_delta("P7D")

2127

2640

datetime.timedelta(7)

2128

2641

>>> rfc3339_duration_to_delta("PT60S")

2138

2651

>>> rfc3339_duration_to_delta("P1DT3M20S")

2139

2652

datetime.timedelta(1, 200)

2140

2653

"""

2141

2654

2142

2655

# Parsing an RFC 3339 duration with regular expressions is not

2143

2656

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

2144

2657

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

2145

2658

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

2146

2659

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

2147

2660

# avoid excessive use of external libraries.

2148

2661

2149

2662

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

2150

Token = collections.namedtuple("Token",

2151

("regexp", # To match token; if

2152

# "value" is not None,

2153

# must have a "group"

2154

# containing digits

2155

"value", # datetime.timedelta or

2156

# None

2157

"followers")) # Tokens valid after

2158

# this token

2663

Token = collections.namedtuple("Token", (

2664

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

2665

# a "group" containing digits

2666

"value", # datetime.timedelta or None

2667

"followers")) # Tokens valid after this token

2159

2668

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

2160

2669

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

2161

2670

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

2162

2671

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

2163

2672

datetime.timedelta(seconds=1),

2164

frozenset((token_end,)))

2673

frozenset((token_end, )))

2165

2674

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

2166

2675

datetime.timedelta(minutes=1),

2167

2676

frozenset((token_second, token_end)))

2183

2692

frozenset((token_month, token_end)))

2184

2693

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

2185

2694

datetime.timedelta(weeks=1),

2186

frozenset((token_end,)))

2695

frozenset((token_end, )))

2187

2696

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

2188

2697

frozenset((token_year, token_month,

2189

2698

token_day, token_time,

2190

token_week))),

2191

# Define starting values

2192

value = datetime.timedelta() # Value so far

2699

token_week)))

2700

# Define starting values:

2701

# Value so far

2702

value = datetime.timedelta()

2193

2703

found_token = None

2194

followers = frozenset(token_duration,) # Following valid tokens

2195

s = duration # String left to parse

2704

# Following valid tokens

2705

followers = frozenset((token_duration, ))

2706

# String left to parse

2707

s = duration

2196

2708

# Loop until end token is found

2197

2709

while found_token is not token_end:

2198

2710

# Search for any currently valid tokens

2214

2726

break

2215

2727

else:

2216

2728

# No currently valid tokens were found

2217

raise ValueError("Invalid RFC 3339 duration")

2729

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

2730

.format(duration))

2218

2731

# End token found

2219

2732

return value

2220

2733

2221

2734

2222

2735

def string_to_delta(interval):

2223

2736

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

2224

2737

2225

2738

>>> string_to_delta('7d')

2226

2739

datetime.timedelta(7)

2227

2740

>>> string_to_delta('60s')

2235

2748

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

2236

2749

datetime.timedelta(0, 330)

2237

2750

"""

2238

2751

2239

2752

try:

2240

2753

return rfc3339_duration_to_delta(interval)

2241

2754

except ValueError:

2242

2755

pass

2243

2756

2244

2757

timevalue = datetime.timedelta(0)

2245

2758

for s in interval.split():

2246

2759

try:

2247

suffix = unicode(s[-1])

2760

suffix = s[-1]

2248

2761

value = int(s[:-1])

2249

2762

if suffix == "d":

2250

2763

delta = datetime.timedelta(value)

2257

2770

elif suffix == "w":

2258

2771

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

2259

2772

else:

2260

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

2261

.format(suffix))

2773

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

2262

2774

except IndexError as e:

2263

2775

raise ValueError(*(e.args))

2264

2776

timevalue += delta

2265

2777

return timevalue

2266

2778

2267

2779

2268

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

2780

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

2269

2781

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

2270

2782

2271

2783

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

2272

2784

if os.fork():

2273

2785

sys.exit()

2281

2793

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

2282

2794

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

2283

2795

raise OSError(errno.ENODEV,

2284

"{0} not a character device"

2796

"{} not a character device"

2285

2797

.format(os.devnull))

2286

2798

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

2287

2799

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

2291

2803

2292

2804

2293

2805

def main():

2294

2806

2295

2807

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

2296

2808

# Parsing of options, both command line and config file

2297

2809

2298

2810

parser = argparse.ArgumentParser()

2299

2811

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

2300

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

2812

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

2301

2813

help="show version number and exit")

2302

2814

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

2303

2815

help="Bind to interface IF")

2336

2848

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

2337

2849

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

2338

2850

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

2339

2851

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

2852

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

2853

default=None)

2854

2340

2855

options = parser.parse_args()

2341

2856

2342

2857

if options.check:

2343

2858

import doctest

2344

2859

fail_count, test_count = doctest.testmod()

2345

2860

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

2346

2861

2347

2862

# Default values for config file for server-global settings

2348

server_defaults = { "interface": "",

2349

"address": "",

2350

"port": "",

2351

"debug": "False",

2352

"priority":

2353

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

2354

"servicename": "Mandos",

2355

"use_dbus": "True",

2356

"use_ipv6": "True",

2357

"debuglevel": "",

2358

"restore": "True",

2359

"socket": "",

2360

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

2361

"foreground": "False",

2362

}

2363

2863

server_defaults = {"interface": "",

2864

"address": "",

2865

"port": "",

2866

"debug": "False",

2867

"priority":

2868

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

2869

":+SIGN-DSA-SHA256",

2870

"servicename": "Mandos",

2871

"use_dbus": "True",

2872

"use_ipv6": "True",

2873

"debuglevel": "",

2874

"restore": "True",

2875

"socket": "",

2876

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

2877

"foreground": "False",

2878

"zeroconf": "True",

2879

}

2880

2364

2881

# Parse config file for server-global settings

2365

2882

server_config = configparser.SafeConfigParser(server_defaults)

2366

2883

del server_defaults

2367

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

2368

"mandos.conf"))

2884

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

2369

2885

# Convert the SafeConfigParser object to a dict

2370

2886

server_settings = server_config.defaults()

2371

2887

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

2372

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

2888

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

2889

"foreground", "zeroconf"):

2373

2890

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

2374

2891

option)

2375

2892

if server_settings["port"]:

2385

2902

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

2386

2903

["socket"])

2387

2904

del server_config

2388

2905

2389

2906

# Override the settings from the config file with command line

2390

2907

# options, if set.

2391

2908

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

2392

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

2393

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

2394

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

2909

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

2910

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

2911

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

2395

2912

value = getattr(options, option)

2396

2913

if value is not None:

2397

2914

server_settings[option] = value

2398

2915

del options

2399

2916

# Force all strings to be unicode

2400

2917

for option in server_settings.keys():

2401

if type(server_settings[option]) is str:

2402

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

2918

if isinstance(server_settings[option], bytes):

2919

server_settings[option] = (server_settings[option]

2920

.decode("utf-8"))

2403

2921

# Force all boolean options to be boolean

2404

2922

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

2405

"foreground"):

2923

"foreground", "zeroconf"):

2406

2924

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

2407

2925

# Debug implies foreground

2408

2926

if server_settings["debug"]:

2409

2927

server_settings["foreground"] = True

2410

2928

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

2411

2929

2412

2930

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

2413

2931

2932

if (not server_settings["zeroconf"]

2933

and not (server_settings["port"]

2934

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

2935

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

2936

2414

2937

# For convenience

2415

2938

debug = server_settings["debug"]

2416

2939

debuglevel = server_settings["debuglevel"]

2419

2942

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

2420

2943

stored_state_file)

2421

2944

foreground = server_settings["foreground"]

2422

2945

zeroconf = server_settings["zeroconf"]

2946

2423

2947

if debug:

2424

2948

initlogger(debug, logging.DEBUG)

2425

2949

else:

2428

2952

else:

2429

2953

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

2430

2954

initlogger(debug, level)

2431

2955

2432

2956

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

2433

syslogger.setFormatter(logging.Formatter

2434

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

2435

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

2436

.format(server_settings

2437

["servicename"])))

2438

2957

syslogger.setFormatter(

2958

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

2959

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

2960

server_settings["servicename"])))

2961

2439

2962

# Parse config file with clients

2440

2963

client_config = configparser.SafeConfigParser(Client

2441

2964

.client_defaults)

2442

2965

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

2443

2966

"clients.conf"))

2444

2967

2445

2968

global mandos_dbus_service

2446

2969

mandos_dbus_service = None

2447

2448

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

2449

server_settings["port"]),

2450

ClientHandler,

2451

interface=(server_settings["interface"]

2452

or None),

2453

use_ipv6=use_ipv6,

2454

gnutls_priority=

2455

server_settings["priority"],

2456

use_dbus=use_dbus,

2457

socketfd=(server_settings["socket"]

2458

or None))

2970

2971

socketfd = None

2972

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

2973

socketfd = server_settings["socket"]

2974

tcp_server = MandosServer(

2975

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

2976

ClientHandler,

2977

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

2978

use_ipv6=use_ipv6,

2979

gnutls_priority=server_settings["priority"],

2980

use_dbus=use_dbus,

2981

socketfd=socketfd)

2459

2982

if not foreground:

2460

2983

pidfilename = "/run/mandos.pid"

2461

2984

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

2462

2985

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

2463

2986

pidfile = None

2464

2987

try:

2465

pidfile = open(pidfilename, "w")

2988

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

2466

2989

except IOError as e:

2467

2990

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

2468

2991

exc_info=e)

2469

2470

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

2992

2993

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

2994

("mandos", "mandos"),

2995

("nobody", "nogroup")):

2471

2996

try:

2472

2997

uid = pwd.getpwnam(name).pw_uid

2473

gid = pwd.getpwnam(name).pw_gid

2998

gid = pwd.getpwnam(group).pw_gid

2474

2999

break

2475

3000

except KeyError:

2476

3001

continue

2480

3005

try:

2481

3006

os.setgid(gid)

2482

3007

os.setuid(uid)

3008

if debug:

3009

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

3010

gid))

2483

3011

except OSError as error:

3012

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

3013

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

2484

3014

if error.errno != errno.EPERM:

2485

3015

raise

2486

3016

2487

3017

if debug:

2488

3018

# Enable all possible GnuTLS debugging

2489

3019

2490

3020

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

2491

3021

# - GnuTLS manual

2492

gnutls.library.functions.gnutls_global_set_log_level(11)

2493

2494

@gnutls.library.types.gnutls_log_func

3022

gnutls.global_set_log_level(11)

3023

3024

@gnutls.log_func

2495

3025

def debug_gnutls(level, string):

2496

3026

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

2497

2498

(gnutls.library.functions

2499

.gnutls_global_set_log_function(debug_gnutls))

2500

3027

3028

gnutls.global_set_log_function(debug_gnutls)

3029

2501

3030

# Redirect stdin so all checkers get /dev/null

2502

3031

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

2503

3032

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

2504

3033

if null > 2:

2505

3034

os.close(null)

2506

3035

2507

3036

# Need to fork before connecting to D-Bus

2508

3037

if not foreground:

2509

3038

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

2510

3039

daemon()

2511

2512

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

2513

# need to inform gobject that threads will be used.

2514

gobject.threads_init()

2515

3040

3041

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

3042

# to inform GLib that threads will be used.

3043

GLib.threads_init()

3044

2516

3045

global main_loop

2517

3046

# From the Avahi example code

2518

3047

DBusGMainLoop(set_as_default=True)

2519

main_loop = gobject.MainLoop()

3048

main_loop = GLib.MainLoop()

2520

3049

bus = dbus.SystemBus()

2521

3050

# End of Avahi example code

2522

3051

if use_dbus:

2523

3052

try:

2524

3053

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

2525

bus, do_not_queue=True)

2526

old_bus_name = (dbus.service.BusName

2527

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

2528

do_not_queue=True))

2529

except dbus.exceptions.NameExistsException as e:

3054

bus,

3055

do_not_queue=True)

3056

old_bus_name = dbus.service.BusName(

3057

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

3058

do_not_queue=True)

3059

except dbus.exceptions.DBusException as e:

2530

3060

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

2531

3061

use_dbus = False

2532

3062

server_settings["use_dbus"] = False

2533

3063

tcp_server.use_dbus = False

2534

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2535

service = AvahiServiceToSyslog(name =

2536

server_settings["servicename"],

2537

servicetype = "_mandos._tcp",

2538

protocol = protocol, bus = bus)

2539

if server_settings["interface"]:

2540

service.interface = (if_nametoindex

2541

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

2542

3064

if zeroconf:

3065

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3066

service = AvahiServiceToSyslog(

3067

name=server_settings["servicename"],

3068

servicetype="_mandos._tcp",

3069

protocol=protocol,

3070

bus=bus)

3071

if server_settings["interface"]:

3072

service.interface = if_nametoindex(

3073

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

3074

2543

3075

global multiprocessing_manager

2544

3076

multiprocessing_manager = multiprocessing.Manager()

2545

3077

2546

3078

client_class = Client

2547

3079

if use_dbus:

2548

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

2549

3080

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

3081

2550

3082

client_settings = Client.config_parser(client_config)

2551

3083

old_client_settings = {}

2552

3084

clients_data = {}

2553

3085

2554

3086

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

2555

3087

global wnull

2556

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

3088

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

2557

3089

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

2558

3090

# mode

2559

3091

if debug or not foreground:

2560

3092

wnull.close()

2561

3093

2562

3094

# Get client data and settings from last running state.

2563

3095

if server_settings["restore"]:

2564

3096

try:

2565

3097

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

2566

clients_data, old_client_settings = (pickle.load

2567

(stored_state))

3098

if sys.version_info.major == 2:

3099

clients_data, old_client_settings = pickle.load(

3100

stored_state)

3101

else:

3102

bytes_clients_data, bytes_old_client_settings = (

3103

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

3104

# Fix bytes to strings

3105

# clients_data

3106

# .keys()

3107

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

3108

if isinstance(key, bytes)

3109

else key): value

3110

for key, value in

3111

bytes_clients_data.items()}

3112

del bytes_clients_data

3113

for key in clients_data:

3114

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

3115

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

3116

for k, v in

3117

clients_data[key].items()}

3118

clients_data[key] = value

3119

# .client_structure

3120

value["client_structure"] = [

3121

(s.decode("utf-8")

3122

if isinstance(s, bytes)

3123

else s) for s in

3124

value["client_structure"]]

3125

# .name & .host

3126

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

3127

if isinstance(value[k], bytes):

3128

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

3129

# old_client_settings

3130

# .keys()

3131

old_client_settings = {

3132

(key.decode("utf-8")

3133

if isinstance(key, bytes)

3134

else key): value

3135

for key, value in

3136

bytes_old_client_settings.items()}

3137

del bytes_old_client_settings

3138

# .host

3139

for value in old_client_settings.values():

3140

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

3141

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

3142

.decode("utf-8"))

2568

3143

os.remove(stored_state_path)

2569

3144

except IOError as e:

2570

3145

if e.errno == errno.ENOENT:

2571

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

2572

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

3146

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

3147

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

2573

3148

else:

2574

3149

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

2575

3150

exc_info=e)

2576

3151

raise

2577

3152

except EOFError as e:

2578

3153

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

2579

"EOFError:", exc_info=e)

2580

3154

"EOFError:",

3155

exc_info=e)

3156

2581

3157

with PGPEngine() as pgp:

2582

for client_name, client in clients_data.iteritems():

3158

for client_name, client in clients_data.items():

2583

3159

# Skip removed clients

2584

3160

if client_name not in client_settings:

2585

3161

continue

2586

3162

2587

3163

# Decide which value to use after restoring saved state.

2588

3164

# We have three different values: Old config file,

2589

3165

# new config file, and saved state.

2594

3170

# For each value in new config, check if it

2595

3171

# differs from the old config value (Except for

2596

3172

# the "secret" attribute)

2597

if (name != "secret" and

2598

value != old_client_settings[client_name]

2599

[name]):

3173

if (name != "secret"

3174

and (value !=

3175

old_client_settings[client_name][name])):

2600

3176

client[name] = value

2601

3177

except KeyError:

2602

3178

pass

2603

3179

2604

3180

# Clients who has passed its expire date can still be

2605

# enabled if its last checker was successful. Clients

3181

# enabled if its last checker was successful. A Client

2606

3182

# whose checker succeeded before we stored its state is

2607

3183

# assumed to have successfully run all checkers during

2608

3184

# downtime.

2610

3186

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

2611

3187

if not client["last_checked_ok"]:

2612

3188

logger.warning(

2613

"disabling client {0} - Client never "

2614

"performed a successful checker"

2615

.format(client_name))

3189

"disabling client {} - Client never "

3190

"performed a successful checker".format(

3191

client_name))

2616

3192

client["enabled"] = False

2617

3193

elif client["last_checker_status"] != 0:

2618

3194

logger.warning(

2619

"disabling client {0} - Client "

2620

"last checker failed with error code {1}"

2621

.format(client_name,

2622

client["last_checker_status"]))

3195

"disabling client {} - Client last"

3196

" checker failed with error code"

3197

" {}".format(

3198

client_name,

3199

client["last_checker_status"]))

2623

3200

client["enabled"] = False

2624

3201

else:

2625

client["expires"] = (datetime.datetime

2626

.utcnow()

2627

+ client["timeout"])

3202

client["expires"] = (

3203

datetime.datetime.utcnow()

3204

+ client["timeout"])

2628

3205

logger.debug("Last checker succeeded,"

2629

" keeping {0} enabled"

2630

.format(client_name))

3206

" keeping {} enabled".format(

3207

client_name))

2631

3208

try:

2632

client["secret"] = (

2633

pgp.decrypt(client["encrypted_secret"],

2634

client_settings[client_name]

2635

["secret"]))

3209

client["secret"] = pgp.decrypt(

3210

client["encrypted_secret"],

3211

client_settings[client_name]["secret"])

2636

3212

except PGPError:

2637

3213

# If decryption fails, we use secret from new settings

2638

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

2639

.format(client_name))

2640

client["secret"] = (

2641

client_settings[client_name]["secret"])

2642

3214

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

3215

client_name))

3216

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

3217

["secret"])

3218

2643

3219

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

2644

3220

for client_name in (set(old_client_settings)

2645

3221

- set(client_settings)):

2647

3223

for client_name in (set(client_settings)

2648

3224

- set(old_client_settings)):

2649

3225

clients_data[client_name] = client_settings[client_name]

2650

3226

2651

3227

# Create all client objects

2652

for client_name, client in clients_data.iteritems():

3228

for client_name, client in clients_data.items():

2653

3229

tcp_server.clients[client_name] = client_class(

2654

name = client_name, settings = client,

2655

server_settings = server_settings)

2656

3230

name=client_name,

3231

settings=client,

3232

server_settings=server_settings)

3233

2657

3234

if not tcp_server.clients:

2658

3235

logger.warning("No clients defined")

2659

3236

2660

3237

if not foreground:

2661

3238

if pidfile is not None:

3239

pid = os.getpid()

2662

3240

try:

2663

3241

with pidfile:

2664

pid = os.getpid()

2665

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

3242

print(pid, file=pidfile)

2666

3243

except IOError:

2667

3244

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

2668

3245

pidfilename, pid)

2669

3246

del pidfile

2670

3247

del pidfilename

2671

2672

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

2673

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

2674

3248

3249

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

3250

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3251

lambda: main_loop.quit() and False)

3252

2675

3253

if use_dbus:

2676

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

2677

"se.bsnet.fukt.Mandos"})

2678

class MandosDBusService(DBusObjectWithProperties):

3254

3255

@alternate_dbus_interfaces(

3256

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

3257

class MandosDBusService(DBusObjectWithObjectManager):

2679

3258

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

3259

2680

3260

def __init__(self):

2681

3261

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

3262

2682

3263

_interface = "se.recompile.Mandos"

2683

2684

@dbus_interface_annotations(_interface)

2685

def _foo(self):

2686

return { "org.freedesktop.DBus.Property"

2687

".EmitsChangedSignal":

2688

"false"}

2689

3264

2690

3265

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

2691

3266

def ClientAdded(self, objpath):

2692

3267

"D-Bus signal"

2693

3268

pass

2694

3269

2695

3270

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

2696

3271

def ClientNotFound(self, fingerprint, address):

2697

3272

"D-Bus signal"

2698

3273

pass

2699

3274

3275

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

3276

"true"})

2700

3277

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

2701

3278

def ClientRemoved(self, objpath, name):

2702

3279

"D-Bus signal"

2703

3280

pass

2704

3281

3282

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

3283

"true"})

2705

3284

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

2706

3285

def GetAllClients(self):

2707

3286

"D-Bus method"

2708

return dbus.Array(c.dbus_object_path

2709

for c in

2710

tcp_server.clients.itervalues())

2711

3287

return dbus.Array(c.dbus_object_path for c in

3288

tcp_server.clients.values())

3289

3290

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

3291

"true"})

2712

3292

@dbus.service.method(_interface,

2713

3293

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

2714

3294

def GetAllClientsWithProperties(self):

2715

3295

"D-Bus method"

2716

3296

return dbus.Dictionary(

2717

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

2718

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

3297

{c.dbus_object_path: c.GetAll(

3298

"se.recompile.Mandos.Client")

3299

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

2719

3300

signature="oa{sv}")

2720

3301

2721

3302

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

2722

3303

def RemoveClient(self, object_path):

2723

3304

"D-Bus method"

2724

for c in tcp_server.clients.itervalues():

3305

for c in tcp_server.clients.values():

2725

3306

if c.dbus_object_path == object_path:

2726

3307

del tcp_server.clients[c.name]

2727

3308

c.remove_from_connection()

2728

# Don't signal anything except ClientRemoved

3309

# Don't signal the disabling

2729

3310

c.disable(quiet=True)

2730

# Emit D-Bus signal

2731

self.ClientRemoved(object_path, c.name)

3311

# Emit D-Bus signal for removal

3312

self.client_removed_signal(c)

2732

3313

return

2733

3314

raise KeyError(object_path)

2734

3315

2735

3316

del _interface

2736

3317

3318

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3319

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

3320

def GetManagedObjects(self):

3321

"""D-Bus method"""

3322

return dbus.Dictionary(

3323

{client.dbus_object_path:

3324

dbus.Dictionary(

3325

{interface: client.GetAll(interface)

3326

for interface in

3327

client._get_all_interface_names()})

3328

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

3329

3330

def client_added_signal(self, client):

3331

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

3332

if use_dbus:

3333

# New standard signal

3334

self.InterfacesAdded(

3335

client.dbus_object_path,

3336

dbus.Dictionary(

3337

{interface: client.GetAll(interface)

3338

for interface in

3339

client._get_all_interface_names()}))

3340

# Old signal

3341

self.ClientAdded(client.dbus_object_path)

3342

3343

def client_removed_signal(self, client):

3344

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

3345

if use_dbus:

3346

# New standard signal

3347

self.InterfacesRemoved(

3348

client.dbus_object_path,

3349

client._get_all_interface_names())

3350

# Old signal

3351

self.ClientRemoved(client.dbus_object_path,

3352

client.name)

3353

2737

3354

mandos_dbus_service = MandosDBusService()

2738

3355

3356

# Save modules to variables to exempt the modules from being

3357

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

3358

mp = multiprocessing

3359

wn = wnull

3360

2739

3361

def cleanup():

2740

3362

"Cleanup function; run on exit"

2741

service.cleanup()

2742

2743

multiprocessing.active_children()

2744

wnull.close()

3363

if zeroconf:

3364

service.cleanup()

3365

3366

mp.active_children()

3367

wn.close()

2745

3368

if not (tcp_server.clients or client_settings):

2746

3369

return

2747

3370

2748

3371

# Store client before exiting. Secrets are encrypted with key

2749

3372

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

2750

3373

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

2751

3374

clients = {}

2752

3375

with PGPEngine() as pgp:

2753

for client in tcp_server.clients.itervalues():

3376

for client in tcp_server.clients.values():

2754

3377

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

2755

3378

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

2756

3379

key)

2757

3380

client_dict = {}

2758

3381

2759

3382

# A list of attributes that can not be pickled

2760

3383

# + secret.

2761

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

2762

"checker", "server_settings"))

2763

for name, typ in (inspect.getmembers

2764

(dbus.service.Object)):

3384

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

3385

"checker", "server_settings"}

3386

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

3387

.Object):

2765

3388

exclude.add(name)

2766

3389

2767

3390

client_dict["encrypted_secret"] = (client

2768

3391

.encrypted_secret)

2769

3392

for attr in client.client_structure:

2770

3393

if attr not in exclude:

2771

3394

client_dict[attr] = getattr(client, attr)

2772

3395

2773

3396

clients[client.name] = client_dict

2774

3397

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

2775

3398

2776

3399

try:

2777

with (tempfile.NamedTemporaryFile

2778

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

2779

dir=os.path.dirname(stored_state_path),

2780

delete=False)) as stored_state:

2781

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

2782

tempname=stored_state.name

3400

with tempfile.NamedTemporaryFile(

3401

mode='wb',

3402

suffix=".pickle",

3403

prefix='clients-',

3404

dir=os.path.dirname(stored_state_path),

3405

delete=False) as stored_state:

3406

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

3407

protocol=2)

3408

tempname = stored_state.name

2783

3409

os.rename(tempname, stored_state_path)

2784

3410

except (IOError, OSError) as e:

2785

3411

if not debug:

2788

3414

except NameError:

2789

3415

pass

2790

3416

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

2791

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

3417

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

2792

3418

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

2793

3419

else:

2794

3420

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

2795

3421

exc_info=e)

2796

3422

raise

2797

3423

2798

3424

# Delete all clients, and settings from config

2799

3425

while tcp_server.clients:

2800

3426

name, client = tcp_server.clients.popitem()

2801

3427

if use_dbus:

2802

3428

client.remove_from_connection()

2803

# Don't signal anything except ClientRemoved

3429

# Don't signal the disabling

2804

3430

client.disable(quiet=True)

3431

# Emit D-Bus signal for removal

2805

3432

if use_dbus:

2806

# Emit D-Bus signal

2807

mandos_dbus_service.ClientRemoved(client

2808

.dbus_object_path,

2809

client.name)

3433

mandos_dbus_service.client_removed_signal(client)

2810

3434

client_settings.clear()

2811

3435

2812

3436

atexit.register(cleanup)

2813

2814

for client in tcp_server.clients.itervalues():

3437

3438

for client in tcp_server.clients.values():

2815

3439

if use_dbus:

2816

# Emit D-Bus signal

2817

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3440

# Emit D-Bus signal for adding

3441

mandos_dbus_service.client_added_signal(client)

2818

3442

# Need to initiate checking of clients

2819

3443

if client.enabled:

2820

3444

client.init_checker()

2821

3445

2822

3446

tcp_server.enable()

2823

3447

tcp_server.server_activate()

2824

3448

2825

3449

# Find out what port we got

2826

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

3450

if zeroconf:

3451

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

2827

3452

if use_ipv6:

2828

3453

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

2829

3454

" flowinfo %d, scope_id %d",

2831

3456

else: # IPv4

2832

3457

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

2833

3458

*tcp_server.socket.getsockname())

2834

2835

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

2836

3459

3460

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

3461

2837

3462

try:

2838

# From the Avahi example code

2839

try:

2840

service.activate()

2841

except dbus.exceptions.DBusException as error:

2842

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

2843

cleanup()

2844

sys.exit(1)

2845

# End of Avahi example code

2846

2847

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

2848

lambda *args, **kwargs:

2849

(tcp_server.handle_request

2850

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

2851

3463

if zeroconf:

3464

# From the Avahi example code

3465

try:

3466

service.activate()

3467

except dbus.exceptions.DBusException as error:

3468

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

3469

cleanup()

3470

sys.exit(1)

3471

# End of Avahi example code

3472

3473

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

3474

lambda *args, **kwargs:

3475

(tcp_server.handle_request

3476

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

3477

2852

3478

logger.debug("Starting main loop")

2853

3479

main_loop.run()

2854

3480

except AvahiError as error:

2863

3489

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

2864

3490

cleanup()

2865

3491

3492

2866

3493

if __name__ == '__main__':

2867

3494

main()