/mandos/trunk : revision 237.4.51

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

72

81

73

import dbus

82

74

import dbus.service

83

from gi.repository import GLib

75

import gobject

76

import avahi

84

77

from dbus.mainloop.glib import DBusGMainLoop

85

78

import ctypes

86

79

import ctypes.util

87

80

import xml.dom.minidom

88

81

import inspect

89

82

90

# Try to find the value of SO_BINDTODEVICE:

91

83

try:

92

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

93

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

94

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

95

85

except AttributeError:

96

86

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

99

87

from IN import SO_BINDTODEVICE

100

88

except ImportError:

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.7.15"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.7"

119

92

stored_state_file = "clients.pickle"

120

93

121

94

logger = logging.getLogger()

122

95

syslogger = None

123

96

124

97

try:

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

127

101

except (OSError, AttributeError):

128

129

102

def if_nametoindex(interface):

130

103

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

131

104

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

132

105

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

133

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

134

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

135

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

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

136

111

return interface_index

137

112

138

113

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

155

114

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

156

115

"""init logger and add loglevel"""

157

116

158

117

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

162

122

syslogger.setFormatter(logging.Formatter

163

123

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

164

124

' %(message)s'))

165

125

logger.addHandler(syslogger)

166

126

167

127

if debug:

168

128

console = logging.StreamHandler()

169

129

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

181

141

182

142

class PGPEngine(object):

183

143

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

184

185

144

def __init__(self):

186

145

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

198

146

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

147

'--home', self.tempdir,

200

148

'--force-mdc',

201

'--quiet']

202

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

203

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

204

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

205

149

'--quiet',

150

'--no-use-agent']

151

206

152

def __enter__(self):

207

153

return self

208

154

209

155

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

210

156

self._cleanup()

211

157

return False

212

158

213

159

def __del__(self):

214

160

self._cleanup()

215

161

216

162

def _cleanup(self):

217

163

if self.tempdir is not None:

218

164

# Delete contents of tempdir

219

165

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

220

topdown=False):

166

topdown = False):

221

167

for filename in files:

222

168

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

223

169

for dirname in dirs:

225

171

# Remove tempdir

226

172

os.rmdir(self.tempdir)

227

173

self.tempdir = None

228

174

229

175

def password_encode(self, password):

230

176

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

231

177

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

236

182

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

237

183

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

238

184

return encoded

239

185

240

186

def encrypt(self, data, password):

241

187

passphrase = self.password_encode(password)

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

244

190

passfile.write(passphrase)

245

191

passfile.flush()

246

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

192

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

247

193

'--passphrase-file',

248

194

passfile.name]

249

195

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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

254

200

if proc.returncode != 0:

255

201

raise PGPError(err)

256

202

return ciphertext

257

203

258

204

def decrypt(self, data, password):

259

205

passphrase = self.password_encode(password)

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

262

208

passfile.write(passphrase)

263

209

passfile.flush()

264

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

210

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

265

211

'--passphrase-file',

266

212

passfile.name]

267

213

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

272

219

if proc.returncode != 0:

273

220

raise PGPError(err)

274

221

return decrypted_plaintext

275

222

276

223

277

# Pretend that we have an Avahi module

278

class Avahi(object):

279

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

280

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

281

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

282

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

283

PROTO_INET = 0 # avahi-common/address.h

284

PROTO_INET6 = 1 # avahi-common/address.h

285

DBUS_NAME = "org.freedesktop.Avahi"

286

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

287

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

288

DBUS_PATH_SERVER = "/"

289

290

def string_array_to_txt_array(self, t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

avahi = Avahi()

302

303

304

224

class AvahiError(Exception):

305

225

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

306

226

self.value = value

307

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

308

**kwargs)

309

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

310

230

311

231

class AvahiServiceError(AvahiError):

312

232

pass

313

233

314

315

234

class AvahiGroupError(AvahiError):

316

235

pass

317

236

318

237

319

238

class AvahiService(object):

320

239

"""An Avahi (Zeroconf) service.

321

240

322

241

Attributes:

323

242

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

324

243

Used to optionally bind to the specified interface.

336

255

server: D-Bus Server

337

256

bus: dbus.SystemBus()

338

257

"""

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

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

351

263

self.interface = interface

352

264

self.name = name

353

265

self.type = servicetype

362

274

self.server = None

363

275

self.bus = bus

364

276

self.entry_group_state_changed_match = None

365

366

def rename(self, remove=True):

277

278

def rename(self):

367

279

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

368

280

if self.rename_count >= self.max_renames:

369

281

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

370

282

" after %i retries, exiting.",

371

283

self.rename_count)

372

284

raise AvahiServiceError("Too many renames")

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

376

287

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

377

288

self.name)

378

if remove:

379

self.remove()

289

self.remove()

380

290

try:

381

291

self.add()

382

292

except dbus.exceptions.DBusException as error:

383

if (error.get_dbus_name()

384

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

385

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

386

return self.rename(remove=False)

387

else:

388

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

389

self.cleanup()

390

os._exit(1)

391

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

392

298

def remove(self):

393

299

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

394

300

if self.entry_group_state_changed_match is not None:

396

302

self.entry_group_state_changed_match = None

397

303

if self.group is not None:

398

304

self.group.Reset()

399

305

400

306

def add(self):

401

307

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

402

308

self.remove()

419

325

dbus.UInt16(self.port),

420

326

avahi.string_array_to_txt_array(self.TXT))

421

327

self.group.Commit()

422

328

423

329

def entry_group_state_changed(self, state, error):

424

330

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

425

331

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

426

332

427

333

if state == avahi.ENTRY_GROUP_ESTABLISHED:

428

334

logger.debug("Zeroconf service established.")

429

335

elif state == avahi.ENTRY_GROUP_COLLISION:

431

337

self.rename()

432

338

elif state == avahi.ENTRY_GROUP_FAILURE:

433

339

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

434

str(error))

435

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

436

340

unicode(error))

341

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

342

.format(error))

343

437

344

def cleanup(self):

438

345

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

439

346

if self.group is not None:

444

351

pass

445

352

self.group = None

446

353

self.remove()

447

354

448

355

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

449

356

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

450

357

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

451

bad_states = {

452

avahi.SERVER_INVALID: "Zeroconf server invalid",

453

avahi.SERVER_REGISTERING: None,

454

avahi.SERVER_COLLISION: "Zeroconf server name collision",

455

avahi.SERVER_FAILURE: "Zeroconf server failure",

456

}

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"Zeroconf server failure" }

457

365

if state in bad_states:

458

366

if bad_states[state] is not None:

459

367

if error is None:

462

370

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

463

371

self.cleanup()

464

372

elif state == avahi.SERVER_RUNNING:

465

try:

466

self.add()

467

except dbus.exceptions.DBusException as error:

468

if (error.get_dbus_name()

469

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

470

logger.info("Local Zeroconf service name"

471

" collision.")

472

return self.rename(remove=False)

473

else:

474

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

475

self.cleanup()

476

os._exit(1)

373

self.add()

477

374

else:

478

375

if error is None:

479

376

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

480

377

else:

481

378

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

482

379

483

380

def activate(self):

484

381

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

485

382

if self.server is None:

489

386

follow_name_owner_changes=True),

490

387

avahi.DBUS_INTERFACE_SERVER)

491

388

self.server.connect_to_signal("StateChanged",

492

self.server_state_changed)

389

self.server_state_changed)

493

390

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

494

391

495

392

496

393

class AvahiServiceToSyslog(AvahiService):

497

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

394

def rename(self):

498

395

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

499

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

500

syslogger.setFormatter(logging.Formatter(

501

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

502

.format(self.name)))

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

.format(self.name)))

503

401

return ret

504

402

505

403

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

404

def timedelta_to_milliseconds(td):

405

"Convert a datetime.timedelta() to milliseconds"

406

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

407

+ (td.seconds * 1000)

408

+ (td.microseconds // 1000))

778

409

779

410

780

411

class Client(object):

781

412

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

782

413

783

414

Attributes:

784

415

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

785

416

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

787

418

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

788

419

to see if the client lives.

789

420

'None' if no process is running.

790

checker_callback_tag: a GLib event source tag, or None

421

checker_callback_tag: a gobject event source tag, or None

791

422

checker_command: string; External command which is run to check

792

423

if client lives. %() expansions are done at

793

424

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

794

425

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

795

checker_initiator_tag: a GLib event source tag, or None

426

checker_initiator_tag: a gobject event source tag, or None

796

427

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

797

428

client_structure: Object describing what attributes a client has

798

429

and is used for storing the client at exit

799

430

current_checker_command: string; current running checker_command

800

disable_initiator_tag: a GLib event source tag, or None

431

disable_initiator_tag: a gobject event source tag, or None

801

432

enabled: bool()

802

433

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

803

434

uniquely identify the client

808

439

last_checker_status: integer between 0 and 255 reflecting exit

809

440

status of last checker. -1 reflects crashed

810

441

checker, -2 means no checker completed yet.

811

last_checker_signal: The signal which killed the last checker, if

812

last_checker_status is -1

813

442

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

814

443

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

815

444

D-Bus identifiers

822

451

disabled, or None

823

452

server_settings: The server_settings dict from main()

824

453

"""

825

454

826

455

runtime_expansions = ("approval_delay", "approval_duration",

827

456

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

828

457

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

829

458

"last_approval_request", "last_checked_ok",

830

459

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

831

client_defaults = {

832

"timeout": "PT5M",

833

"extended_timeout": "PT15M",

834

"interval": "PT2M",

835

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

836

"host": "",

837

"approval_delay": "PT0S",

838

"approval_duration": "PT1S",

839

"approved_by_default": "True",

840

"enabled": "True",

841

}

842

460

client_defaults = { "timeout": "PT5M",

461

"extended_timeout": "PT15M",

462

"interval": "PT2M",

463

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

464

"host": "",

465

"approval_delay": "PT0S",

466

"approval_duration": "PT1S",

467

"approved_by_default": "True",

468

"enabled": "True",

469

}

470

471

def timeout_milliseconds(self):

472

"Return the 'timeout' attribute in milliseconds"

473

return timedelta_to_milliseconds(self.timeout)

474

475

def extended_timeout_milliseconds(self):

476

"Return the 'extended_timeout' attribute in milliseconds"

477

return timedelta_to_milliseconds(self.extended_timeout)

478

479

def interval_milliseconds(self):

480

"Return the 'interval' attribute in milliseconds"

481

return timedelta_to_milliseconds(self.interval)

482

483

def approval_delay_milliseconds(self):

484

return timedelta_to_milliseconds(self.approval_delay)

485

843

486

@staticmethod

844

487

def config_parser(config):

845

488

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

852

495

for client_name in config.sections():

853

496

section = dict(config.items(client_name))

854

497

client = settings[client_name] = {}

855

498

856

499

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

857

500

# Reformat values from string types to Python types

858

501

client["approved_by_default"] = config.getboolean(

859

502

client_name, "approved_by_default")

860

503

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

861

504

"enabled")

862

863

# Uppercase and remove spaces from fingerprint for later

864

# comparison purposes with return value from the

865

# fingerprint() function

505

866

506

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

867

507

.replace(" ", ""))

868

508

if "secret" in section:

869

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

870

.encode("utf-8"),

871

"base64")

509

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

872

510

elif "secfile" in section:

873

511

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

874

512

(section["secfile"])),

875

513

"rb") as secfile:

876

514

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

877

515

else:

878

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

516

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

879

517

.format(section))

880

518

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

881

519

client["extended_timeout"] = string_to_delta(

889

527

client["last_approval_request"] = None

890

528

client["last_checked_ok"] = None

891

529

client["last_checker_status"] = -2

892

530

893

531

return settings

894

895

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

532

533

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

896

534

self.name = name

897

535

if server_settings is None:

898

536

server_settings = {}

899

537

self.server_settings = server_settings

900

538

# adding all client settings

901

for setting, value in settings.items():

539

for setting, value in settings.iteritems():

902

540

setattr(self, setting, value)

903

541

904

542

if self.enabled:

905

543

if not hasattr(self, "last_enabled"):

906

544

self.last_enabled = datetime.datetime.utcnow()

910

548

else:

911

549

self.last_enabled = None

912

550

self.expires = None

913

551

914

552

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

553

# Uppercase and remove spaces from fingerprint for later

554

# comparison purposes with return value from the fingerprint()

555

# function

915

556

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

916

557

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

917

558

datetime.datetime.utcnow())

918

559

919

560

# attributes specific for this server instance

920

561

self.checker = None

921

562

self.checker_initiator_tag = None

924

565

self.current_checker_command = None

925

566

self.approved = None

926

567

self.approvals_pending = 0

927

self.changedstate = multiprocessing_manager.Condition(

928

multiprocessing_manager.Lock())

929

self.client_structure = [attr

930

for attr in self.__dict__.keys()

568

self.changedstate = (multiprocessing_manager

569

.Condition(multiprocessing_manager

570

.Lock()))

571

self.client_structure = [attr for attr in

572

self.__dict__.iterkeys()

931

573

if not attr.startswith("_")]

932

574

self.client_structure.append("client_structure")

933

934

for name, t in inspect.getmembers(

935

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

575

576

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

577

lambda obj:

578

isinstance(obj,

579

property)):

936

580

if not name.startswith("_"):

937

581

self.client_structure.append(name)

938

582

939

583

# Send notice to process children that client state has changed

940

584

def send_changedstate(self):

941

585

with self.changedstate:

942

586

self.changedstate.notify_all()

943

587

944

588

def enable(self):

945

589

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

946

590

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

951

595

self.last_enabled = datetime.datetime.utcnow()

952

596

self.init_checker()

953

597

self.send_changedstate()

954

598

955

599

def disable(self, quiet=True):

956

600

"""Disable this client."""

957

601

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

959

603

if not quiet:

960

604

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

961

605

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

962

GLib.source_remove(self.disable_initiator_tag)

606

gobject.source_remove(self.disable_initiator_tag)

963

607

self.disable_initiator_tag = None

964

608

self.expires = None

965

609

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

966

GLib.source_remove(self.checker_initiator_tag)

610

gobject.source_remove(self.checker_initiator_tag)

967

611

self.checker_initiator_tag = None

968

612

self.stop_checker()

969

613

self.enabled = False

970

614

if not quiet:

971

615

self.send_changedstate()

972

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

616

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

973

617

return False

974

618

975

619

def __del__(self):

976

620

self.disable()

977

621

978

622

def init_checker(self):

979

623

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

980

624

# and every interval from then on.

981

625

if self.checker_initiator_tag is not None:

982

GLib.source_remove(self.checker_initiator_tag)

983

self.checker_initiator_tag = GLib.timeout_add(

984

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

985

self.start_checker)

626

gobject.source_remove(self.checker_initiator_tag)

627

self.checker_initiator_tag = (gobject.timeout_add

628

(self.interval_milliseconds(),

629

self.start_checker))

986

630

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

987

631

if self.disable_initiator_tag is not None:

988

GLib.source_remove(self.disable_initiator_tag)

989

self.disable_initiator_tag = GLib.timeout_add(

990

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

632

gobject.source_remove(self.disable_initiator_tag)

633

self.disable_initiator_tag = (gobject.timeout_add

634

(self.timeout_milliseconds(),

635

self.disable))

991

636

# Also start a new checker *right now*.

992

637

self.start_checker()

993

994

def checker_callback(self, source, condition, connection,

995

command):

638

639

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

996

640

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

997

641

self.checker_callback_tag = None

998

642

self.checker = None

999

# Read return code from connection (see call_pipe)

1000

returncode = connection.recv()

1001

connection.close()

1002

1003

if returncode >= 0:

1004

self.last_checker_status = returncode

1005

self.last_checker_signal = None

643

if os.WIFEXITED(condition):

644

self.last_checker_status = os.WEXITSTATUS(condition)

1006

645

if self.last_checker_status == 0:

1007

646

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

1008

647

vars(self))

1009

648

self.checked_ok()

1010

649

else:

1011

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

650

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

651

vars(self))

1012

652

else:

1013

653

self.last_checker_status = -1

1014

self.last_checker_signal = -returncode

1015

654

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

1016

655

vars(self))

1017

return False

1018

656

1019

657

def checked_ok(self):

1020

658

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

1021

659

self.last_checked_ok = datetime.datetime.utcnow()

1022

660

self.last_checker_status = 0

1023

self.last_checker_signal = None

1024

661

self.bump_timeout()

1025

662

1026

663

def bump_timeout(self, timeout=None):

1027

664

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

1028

665

if timeout is None:

1029

666

timeout = self.timeout

1030

667

if self.disable_initiator_tag is not None:

1031

GLib.source_remove(self.disable_initiator_tag)

668

gobject.source_remove(self.disable_initiator_tag)

1032

669

self.disable_initiator_tag = None

1033

670

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

1034

self.disable_initiator_tag = GLib.timeout_add(

1035

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

671

self.disable_initiator_tag = (gobject.timeout_add

672

(timedelta_to_milliseconds

673

(timeout), self.disable))

1036

674

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

1037

675

1038

676

def need_approval(self):

1039

677

self.last_approval_request = datetime.datetime.utcnow()

1040

678

1041

679

def start_checker(self):

1042

680

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

1043

681

1044

682

If a checker already exists, leave it running and do

1045

683

nothing."""

1046

684

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

1051

689

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

1052

690

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

1053

691

# should be.

1054

1055

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

1056

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

1057

self.checker.join()

1058

self.checker = None

692

693

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

694

try:

695

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

696

except AttributeError:

697

pass

698

except OSError as error:

699

if error.errno != errno.ECHILD:

700

raise

701

else:

702

if pid:

703

logger.warning("Checker was a zombie")

704

gobject.source_remove(self.checker_callback_tag)

705

self.checker_callback(pid, status,

706

self.current_checker_command)

1059

707

# Start a new checker if needed

1060

708

if self.checker is None:

1061

709

# Escape attributes for the shell

1062

escaped_attrs = {

1063

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

1064

for attr in self.runtime_expansions}

710

escaped_attrs = dict(

711

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

712

for attr in

713

self.runtime_expansions)

1065

714

try:

1066

715

command = self.checker_command % escaped_attrs

1067

716

except TypeError as error:

1068

717

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

1069

self.checker_command,

718

self.checker_command, exc_info=error)

719

return True # Try again later

720

self.current_checker_command = command

721

try:

722

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

723

command, self.name)

724

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

725

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

726

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

727

# always replaced by /dev/null.)

728

# The exception is when not debugging but nevertheless

729

# running in the foreground; use the previously

730

# created wnull.

731

popen_args = {}

732

if (not self.server_settings["debug"]

733

and self.server_settings["foreground"]):

734

popen_args.update({"stdout": wnull,

735

"stderr": wnull })

736

self.checker = subprocess.Popen(command,

737

close_fds=True,

738

shell=True, cwd="/",

739

**popen_args)

740

except OSError as error:

741

logger.error("Failed to start subprocess",

1070

742

exc_info=error)

1071

return True # Try again later

1072

self.current_checker_command = command

1073

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

1074

self.name)

1075

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

1076

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

1077

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

1078

# always replaced by /dev/null.)

1079

# The exception is when not debugging but nevertheless

1080

# running in the foreground; use the previously

1081

# created wnull.

1082

popen_args = {"close_fds": True,

1083

"shell": True,

1084

"cwd": "/"}

1085

if (not self.server_settings["debug"]

1086

and self.server_settings["foreground"]):

1087

popen_args.update({"stdout": wnull,

1088

"stderr": wnull})

1089

pipe = multiprocessing.Pipe(duplex=False)

1090

self.checker = multiprocessing.Process(

1091

target=call_pipe,

1092

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

1093

kwargs=popen_args)

1094

self.checker.start()

1095

self.checker_callback_tag = GLib.io_add_watch(

1096

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

1097

self.checker_callback, pipe[0], command)

1098

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

743

return True

744

self.checker_callback_tag = (gobject.child_watch_add

745

(self.checker.pid,

746

self.checker_callback,

747

data=command))

748

# The checker may have completed before the gobject

749

# watch was added. Check for this.

750

try:

751

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

752

except OSError as error:

753

if error.errno == errno.ECHILD:

754

# This should never happen

755

logger.error("Child process vanished",

756

exc_info=error)

757

return True

758

raise

759

if pid:

760

gobject.source_remove(self.checker_callback_tag)

761

self.checker_callback(pid, status, command)

762

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

1099

763

return True

1100

764

1101

765

def stop_checker(self):

1102

766

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

1103

767

if self.checker_callback_tag:

1104

GLib.source_remove(self.checker_callback_tag)

768

gobject.source_remove(self.checker_callback_tag)

1105

769

self.checker_callback_tag = None

1106

770

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

1107

771

return

1108

772

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

1109

self.checker.terminate()

773

try:

774

self.checker.terminate()

775

#time.sleep(0.5)

776

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

777

# self.checker.kill()

778

except OSError as error:

779

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

780

raise

1110

781

self.checker = None

1111

782

1112

783

1113

def dbus_service_property(dbus_interface,

1114

signature="v",

1115

access="readwrite",

1116

byte_arrays=False):

784

def dbus_service_property(dbus_interface, signature="v",

785

access="readwrite", byte_arrays=False):

1117

786

"""Decorators for marking methods of a DBusObjectWithProperties to

1118

787

become properties on the D-Bus.

1119

788

1120

789

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

1121

790

and with one argument by "Set".

1122

791

1123

792

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

1124

793

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

1125

794

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

1128

797

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

1129

798

if byte_arrays and signature != "ay":

1130

799

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

1131

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

1132

800

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

1133

801

def decorator(func):

1134

802

func._dbus_is_property = True

1135

803

func._dbus_interface = dbus_interface

1138

806

func._dbus_name = func.__name__

1139

807

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

1140

808

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

1141

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

809

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1142

810

return func

1143

1144

811

return decorator

1145

812

1146

813

1147

814

def dbus_interface_annotations(dbus_interface):

1148

815

"""Decorator for marking functions returning interface annotations

1149

816

1150

817

Usage:

1151

818

1152

819

@dbus_interface_annotations("org.example.Interface")

1153

820

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

1154

821

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

1155

822

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

1156

823

"false"}

1157

824

"""

1158

1159

825

def decorator(func):

1160

826

func._dbus_is_interface = True

1161

827

func._dbus_interface = dbus_interface

1162

828

func._dbus_name = dbus_interface

1163

829

return func

1164

1165

830

return decorator

1166

831

1167

832

1168

833

def dbus_annotations(annotations):

1169

834

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

1170

835

Usage:

1171

1172

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

1173

"org.freedesktop.DBus.Property."

1174

"EmitsChangedSignal": "false"})

836

1175

837

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

1176

838

access="r")

839

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

840

"org.freedesktop.DBus.Property."

841

"EmitsChangedSignal": "false"})

1177

842

def Property_dbus_property(self):

1178

843

return dbus.Boolean(False)

1179

1180

See also the DBusObjectWithAnnotations class.

1181

844

"""

1182

1183

845

def decorator(func):

1184

846

func._dbus_annotations = annotations

1185

847

return func

1186

1187

848

return decorator

1188

849

1189

850

1190

851

class DBusPropertyException(dbus.exceptions.DBusException):

1191

852

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

1192

853

"""

1193

pass

854

def __unicode__(self):

855

return unicode(str(self))

1194

856

1195

857

1196

858

class DBusPropertyAccessException(DBusPropertyException):

1205

867

pass

1206

868

1207

869

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.

870

class DBusObjectWithProperties(dbus.service.Object):

871

"""A D-Bus object with properties.

872

873

Classes inheriting from this can use the dbus_service_property

874

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

875

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

1213

876

"""

1214

877

1215

878

@staticmethod

1216

879

def _is_dbus_thing(thing):

1217

880

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

1218

881

1219

882

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

1220

883

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

1221

884

"""

1222

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

885

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

1223

886

False)

1224

887

1225

888

def _get_all_dbus_things(self, thing):

1226

889

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

1227

890

"""

1228

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

891

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

892

name),

1229

893

athing.__get__(self))

1230

894

for cls in self.__class__.__mro__

1231

895

for name, athing in

1232

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

1233

1234

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1235

out_signature="s",

1236

path_keyword='object_path',

1237

connection_keyword='connection')

1238

def Introspect(self, object_path, connection):

1239

"""Overloading of standard D-Bus method.

1240

1241

Inserts annotation tags on methods and signals.

1242

"""

1243

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

1244

connection)

1245

try:

1246

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

1247

1248

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

1249

# Add annotation tags

1250

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

1251

for tag in if_tag.getElementsByTagName(typ):

1252

annots = dict()

1253

for name, prop in (self.

1254

_get_all_dbus_things(typ)):

1255

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

1256

and prop._dbus_interface

1257

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

1258

annots.update(getattr(

1259

prop, "_dbus_annotations", {}))

1260

for name, value in annots.items():

1261

ann_tag = document.createElement(

1262

"annotation")

1263

ann_tag.setAttribute("name", name)

1264

ann_tag.setAttribute("value", value)

1265

tag.appendChild(ann_tag)

1266

# Add interface annotation tags

1267

for annotation, value in dict(

1268

itertools.chain.from_iterable(

1269

annotations().items()

1270

for name, annotations

1271

in self._get_all_dbus_things("interface")

1272

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

1273

)).items():

1274

ann_tag = document.createElement("annotation")

1275

ann_tag.setAttribute("name", annotation)

1276

ann_tag.setAttribute("value", value)

1277

if_tag.appendChild(ann_tag)

1278

# Fix argument name for the Introspect method itself

1279

if (if_tag.getAttribute("name")

1280

== dbus.INTROSPECTABLE_IFACE):

1281

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

1282

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

1283

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

1284

if (arg.getAttribute("direction")

1285

== "out"):

1286

arg.setAttribute("name",

1287

"xml_data")

1288

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

1289

document.unlink()

1290

except (AttributeError, xml.dom.DOMException,

1291

xml.parsers.expat.ExpatError) as error:

1292

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

1293

exc_info=error)

1294

return xmlstring

1295

1296

1297

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1298

"""A D-Bus object with properties.

1299

1300

Classes inheriting from this can use the dbus_service_property

1301

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

1302

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

1303

"""

1304

896

inspect.getmembers(cls,

897

self._is_dbus_thing(thing)))

898

1305

899

def _get_dbus_property(self, interface_name, property_name):

1306

900

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

1307

901

property with the specified name and interface.

1308

902

"""

1309

for cls in self.__class__.__mro__:

1310

for name, value in inspect.getmembers(

1311

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

903

for cls in self.__class__.__mro__:

904

for name, value in (inspect.getmembers

905

(cls,

906

self._is_dbus_thing("property"))):

1312

907

if (value._dbus_name == property_name

1313

908

and value._dbus_interface == interface_name):

1314

909

return value.__get__(self)

1315

910

1316

911

# No such property

1317

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

1318

self.dbus_object_path, interface_name, property_name))

1319

1320

@classmethod

1321

def _get_all_interface_names(cls):

1322

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

1323

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

1324

"_dbus_interface", None)

1325

for x in (inspect.getmro(cls))

1326

for attr in dir(x))

1327

if name is not None)

1328

1329

@dbus.service.method(dbus.PROPERTIES_IFACE,

1330

in_signature="ss",

912

raise DBusPropertyNotFound(self.dbus_object_path + ":"

913

+ interface_name + "."

914

+ property_name)

915

916

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

1331

917

out_signature="v")

1332

918

def Get(self, interface_name, property_name):

1333

919

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

1339

925

if not hasattr(value, "variant_level"):

1340

926

return value

1341

927

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

1342

928

1343

929

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

1344

930

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

1345

931

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

1352

938

# signatures other than "ay".

1353

939

if prop._dbus_signature != "ay":

1354

940

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

1355

"'ay' signature {!r}"

941

"'ay' signature {0!r}"

1356

942

.format(prop._dbus_signature))

1357

943

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

1358

944

for byte in value))

1359

945

prop(value)

1360

1361

@dbus.service.method(dbus.PROPERTIES_IFACE,

1362

in_signature="s",

946

947

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

1363

948

out_signature="a{sv}")

1364

949

def GetAll(self, interface_name):

1365

950

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

1366

951

standard.

1367

952

1368

953

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

1369

954

"""

1370

955

properties = {}

1380

965

if not hasattr(value, "variant_level"):

1381

966

properties[name] = value

1382

967

continue

1383

properties[name] = type(value)(

1384

value, variant_level=value.variant_level + 1)

968

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

969

value.variant_level+1)

1385

970

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

1386

1387

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

1388

def PropertiesChanged(self, interface_name, changed_properties,

1389

invalidated_properties):

1390

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

1391

standard.

1392

"""

1393

pass

1394

971

1395

972

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1396

973

out_signature="s",

1397

974

path_keyword='object_path',

1398

975

connection_keyword='connection')

1399

976

def Introspect(self, object_path, connection):

1400

977

"""Overloading of standard D-Bus method.

1401

978

1402

979

Inserts property tags and interface annotation tags.

1403

980

"""

1404

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1405

object_path,

1406

connection)

981

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

982

connection)

1407

983

try:

1408

984

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

1409

1410

985

def make_tag(document, name, prop):

1411

986

e = document.createElement("property")

1412

987

e.setAttribute("name", name)

1413

988

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

1414

989

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

1415

990

return e

1416

1417

991

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

1418

992

# Add property tags

1419

993

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

1422

996

if prop._dbus_interface

1423

997

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

1424

998

if_tag.appendChild(tag)

1425

# Add annotation tags for properties

1426

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

1427

annots = dict()

1428

for name, prop in self._get_all_dbus_things(

1429

"property"):

1430

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

1431

and prop._dbus_interface

1432

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

1433

annots.update(getattr(

1434

prop, "_dbus_annotations", {}))

1435

for name, value in annots.items():

1436

ann_tag = document.createElement(

1437

"annotation")

1438

ann_tag.setAttribute("name", name)

1439

ann_tag.setAttribute("value", value)

1440

tag.appendChild(ann_tag)

999

# Add annotation tags

1000

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

1001

for tag in if_tag.getElementsByTagName(typ):

1002

annots = dict()

1003

for name, prop in (self.

1004

_get_all_dbus_things(typ)):

1005

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

1006

and prop._dbus_interface

1007

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

1008

annots.update(getattr

1009

(prop,

1010

"_dbus_annotations",

1011

{}))

1012

for name, value in annots.iteritems():

1013

ann_tag = document.createElement(

1014

"annotation")

1015

ann_tag.setAttribute("name", name)

1016

ann_tag.setAttribute("value", value)

1017

tag.appendChild(ann_tag)

1018

# Add interface annotation tags

1019

for annotation, value in dict(

1020

itertools.chain.from_iterable(

1021

annotations().iteritems()

1022

for name, annotations in

1023

self._get_all_dbus_things("interface")

1024

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

1025

)).iteritems():

1026

ann_tag = document.createElement("annotation")

1027

ann_tag.setAttribute("name", annotation)

1028

ann_tag.setAttribute("value", value)

1029

if_tag.appendChild(ann_tag)

1441

1030

# Add the names to the return values for the

1442

1031

# "org.freedesktop.DBus.Properties" methods

1443

1032

if (if_tag.getAttribute("name")

1462

1051

return xmlstring

1463

1052

1464

1053

1465

try:

1466

dbus.OBJECT_MANAGER_IFACE

1467

except AttributeError:

1468

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

1469

1470

1471

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1472

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

1473

1474

Classes inheriting from this exposes the standard

1475

GetManagedObjects call and the InterfacesAdded and

1476

InterfacesRemoved signals on the standard

1477

"org.freedesktop.DBus.ObjectManager" interface.

1478

1479

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

1480

manually.

1481

"""

1482

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1483

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

1484

def GetManagedObjects(self):

1485

"""This function must be overridden"""

1486

raise NotImplementedError()

1487

1488

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1489

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

1490

def InterfacesAdded(self, object_path, interfaces_and_properties):

1491

pass

1492

1493

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

1494

def InterfacesRemoved(self, object_path, interfaces):

1495

pass

1496

1497

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1498

out_signature="s",

1499

path_keyword='object_path',

1500

connection_keyword='connection')

1501

def Introspect(self, object_path, connection):

1502

"""Overloading of standard D-Bus method.

1503

1504

Override return argument name of GetManagedObjects to be

1505

"objpath_interfaces_and_properties"

1506

"""

1507

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1508

object_path,

1509

connection)

1510

try:

1511

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

1512

1513

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

1514

# Fix argument name for the GetManagedObjects method

1515

if (if_tag.getAttribute("name")

1516

== dbus.OBJECT_MANAGER_IFACE):

1517

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

1518

if (cn.getAttribute("name")

1519

== "GetManagedObjects"):

1520

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

1521

if (arg.getAttribute("direction")

1522

== "out"):

1523

arg.setAttribute(

1524

"name",

1525

"objpath_interfaces"

1526

"_and_properties")

1527

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

1528

document.unlink()

1529

except (AttributeError, xml.dom.DOMException,

1530

xml.parsers.expat.ExpatError) as error:

1531

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

1532

exc_info=error)

1533

return xmlstring

1534

1535

1536

1054

def datetime_to_dbus(dt, variant_level=0):

1537

1055

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

1538

1056

if dt is None:

1539

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

1540

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

1057

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

1058

return dbus.String(dt.isoformat(),

1059

variant_level=variant_level)

1541

1060

1542

1061

1543

1062

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1545

1064

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

1546

1065

interface names according to the "alt_interface_names" mapping.

1547

1066

Usage:

1548

1067

1549

1068

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

1550

1069

"net.example.AlternateInterface"})

1551

1070

class SampleDBusObject(dbus.service.Object):

1552

1071

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

1553

1072

def SampleDBusMethod():

1554

1073

pass

1555

1074

1556

1075

The above "SampleDBusMethod" on "SampleDBusObject" will be

1557

1076

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

1558

1077

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

1559

1078

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

1560

1079

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

1561

1080

1562

1081

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

1563

1082

(from DBusObjectWithProperties) and interfaces (from the

1564

1083

dbus_interface_annotations decorator).

1565

1084

"""

1566

1567

1085

def wrapper(cls):

1568

1086

for orig_interface_name, alt_interface_name in (

1569

alt_interface_names.items()):

1087

alt_interface_names.iteritems()):

1570

1088

attr = {}

1571

1089

interface_names = set()

1572

1090

# Go though all attributes of the class

1574

1092

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

1575

1093

# with the wrong interface name

1576

1094

if (not hasattr(attribute, "_dbus_interface")

1577

or not attribute._dbus_interface.startswith(

1578

orig_interface_name)):

1095

or not attribute._dbus_interface

1096

.startswith(orig_interface_name)):

1579

1097

continue

1580

1098

# Create an alternate D-Bus interface name based on

1581

1099

# the current name

1582

alt_interface = attribute._dbus_interface.replace(

1583

orig_interface_name, alt_interface_name)

1100

alt_interface = (attribute._dbus_interface

1101

.replace(orig_interface_name,

1102

alt_interface_name))

1584

1103

interface_names.add(alt_interface)

1585

1104

# Is this a D-Bus signal?

1586

1105

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

1587

1106

# Extract the original non-method undecorated

1588

1107

# function by black magic

1589

if sys.version_info.major == 2:

1590

nonmethod_func = (dict(

1108

nonmethod_func = (dict(

1591

1109

zip(attribute.func_code.co_freevars,

1592

attribute.__closure__))

1593

["func"].cell_contents)

1594

else:

1595

nonmethod_func = (dict(

1596

zip(attribute.__code__.co_freevars,

1597

attribute.__closure__))

1598

["func"].cell_contents)

1110

attribute.__closure__))["func"]

1111

.cell_contents)

1599

1112

# Create a new, but exactly alike, function

1600

1113

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

1601

1114

# with the alternate D-Bus interface name

1602

new_function = copy_function(nonmethod_func)

1603

new_function = (dbus.service.signal(

1604

alt_interface,

1605

attribute._dbus_signature)(new_function))

1115

new_function = (dbus.service.signal

1116

(alt_interface,

1117

attribute._dbus_signature)

1118

(types.FunctionType(

1119

nonmethod_func.func_code,

1120

nonmethod_func.func_globals,

1121

nonmethod_func.func_name,

1122

nonmethod_func.func_defaults,

1123

nonmethod_func.func_closure)))

1606

1124

# Copy annotations, if any

1607

1125

try:

1608

new_function._dbus_annotations = dict(

1609

attribute._dbus_annotations)

1126

new_function._dbus_annotations = (

1127

dict(attribute._dbus_annotations))

1610

1128

except AttributeError:

1611

1129

pass

1612

1613

1130

# Define a creator of a function to call both the

1614

1131

# original and alternate functions, so both the

1615

1132

# original and alternate signals gets sent when

1618

1135

"""This function is a scope container to pass

1619

1136

func1 and func2 to the "call_both" function

1620

1137

outside of its arguments"""

1621

1622

@functools.wraps(func2)

1623

1138

def call_both(*args, **kwargs):

1624

1139

"""This function will emit two D-Bus

1625

1140

signals by calling func1 and func2"""

1626

1141

func1(*args, **kwargs)

1627

1142

func2(*args, **kwargs)

1628

# Make wrapper function look like a D-Bus

1629

# signal

1630

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

1631

if name.startswith("_dbus_"):

1632

setattr(call_both, name, attr)

1633

1634

1143

return call_both

1635

1144

# Create the "call_both" function and add it to

1636

1145

# the class

1641

1150

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

1642

1151

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

1643

1152

# to the class.

1644

attr[attrname] = (

1645

dbus.service.method(

1646

alt_interface,

1647

attribute._dbus_in_signature,

1648

attribute._dbus_out_signature)

1649

(copy_function(attribute)))

1153

attr[attrname] = (dbus.service.method

1154

(alt_interface,

1155

attribute._dbus_in_signature,

1156

attribute._dbus_out_signature)

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1650

1163

# Copy annotations, if any

1651

1164

try:

1652

attr[attrname]._dbus_annotations = dict(

1653

attribute._dbus_annotations)

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1654

1167

except AttributeError:

1655

1168

pass

1656

1169

# Is this a D-Bus property?

1659

1172

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

1660

1173

# property with the alternate D-Bus interface

1661

1174

# name. Add it to the class.

1662

attr[attrname] = (dbus_service_property(

1663

alt_interface, attribute._dbus_signature,

1664

attribute._dbus_access,

1665

attribute._dbus_get_args_options

1666

["byte_arrays"])

1667

(copy_function(attribute)))

1175

attr[attrname] = (dbus_service_property

1176

(alt_interface,

1177

attribute._dbus_signature,

1178

attribute._dbus_access,

1179

attribute

1180

._dbus_get_args_options

1181

["byte_arrays"])

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

attribute.func_closure)))

1668

1188

# Copy annotations, if any

1669

1189

try:

1670

attr[attrname]._dbus_annotations = dict(

1671

attribute._dbus_annotations)

1190

attr[attrname]._dbus_annotations = (

1191

dict(attribute._dbus_annotations))

1672

1192

except AttributeError:

1673

1193

pass

1674

1194

# Is this a D-Bus interface?

1677

1197

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

1678

1198

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

1679

1199

# to the class.

1680

attr[attrname] = (

1681

dbus_interface_annotations(alt_interface)

1682

(copy_function(attribute)))

1200

attr[attrname] = (dbus_interface_annotations

1201

(alt_interface)

1202

(types.FunctionType

1203

(attribute.func_code,

1204

attribute.func_globals,

1205

attribute.func_name,

1206

attribute.func_defaults,

1207

attribute.func_closure)))

1683

1208

if deprecate:

1684

1209

# Deprecate all alternate interfaces

1685

iname = "_AlternateDBusNames_interface_annotation{}"

1210

iname="_AlternateDBusNames_interface_annotation{0}"

1686

1211

for interface_name in interface_names:

1687

1688

1212

@dbus_interface_annotations(interface_name)

1689

1213

def func(self):

1690

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

1691

"true"}

1214

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

1215

"true" }

1692

1216

# Find an unused name

1693

1217

for aname in (iname.format(i)

1694

1218

for i in itertools.count()):

1698

1222

if interface_names:

1699

1223

# Replace the class with a new subclass of it with

1700

1224

# methods, signals, etc. as created above.

1701

if sys.version_info.major == 2:

1702

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

1703

(cls, ), attr)

1704

else:

1705

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

1706

(cls, ), attr)

1225

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

1226

(cls,), attr)

1707

1227

return cls

1708

1709

1228

return wrapper

1710

1229

1711

1230

1712

1231

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

1713

"se.bsnet.fukt.Mandos"})

1232

"se.bsnet.fukt.Mandos"})

1714

1233

class ClientDBus(Client, DBusObjectWithProperties):

1715

1234

"""A Client class using D-Bus

1716

1235

1717

1236

Attributes:

1718

1237

dbus_object_path: dbus.ObjectPath

1719

1238

bus: dbus.SystemBus()

1720

1239

"""

1721

1240

1722

1241

runtime_expansions = (Client.runtime_expansions

1723

+ ("dbus_object_path", ))

1724

1725

_interface = "se.recompile.Mandos.Client"

1726

1242

+ ("dbus_object_path",))

1243

1727

1244

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

1728

1729

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

1245

1246

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

1730

1247

self.bus = bus

1731

1248

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

1732

1249

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

1733

1250

# the D-Bus

1734

client_object_name = str(self.name).translate(

1251

client_object_name = unicode(self.name).translate(

1735

1252

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

1736

1253

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

1737

self.dbus_object_path = dbus.ObjectPath(

1738

"/clients/" + client_object_name)

1254

self.dbus_object_path = (dbus.ObjectPath

1255

("/clients/" + client_object_name))

1739

1256

DBusObjectWithProperties.__init__(self, self.bus,

1740

1257

self.dbus_object_path)

1741

1742

def notifychangeproperty(transform_func, dbus_name,

1743

type_func=lambda x: x,

1744

variant_level=1,

1745

invalidate_only=False,

1746

_interface=_interface):

1258

1259

def notifychangeproperty(transform_func,

1260

dbus_name, type_func=lambda x: x,

1261

variant_level=1):

1747

1262

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

1748

1263

its changes to DBus.

1749

1264

1750

1265

transform_fun: Function that takes a value and a variant_level

1751

1266

and transforms it to a D-Bus type.

1752

1267

dbus_name: D-Bus name of the variable

1754

1269

to the D-Bus. Default: no transform

1755

1270

variant_level: D-Bus variant level. Default: 1

1756

1271

"""

1757

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

1758

1272

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

1759

1273

def setter(self, value):

1760

1274

if hasattr(self, "dbus_object_path"):

1761

1275

if (not hasattr(self, attrname) or

1762

1276

type_func(getattr(self, attrname, None))

1763

1277

!= type_func(value)):

1764

if invalidate_only:

1765

self.PropertiesChanged(

1766

_interface, dbus.Dictionary(),

1767

dbus.Array((dbus_name, )))

1768

else:

1769

dbus_value = transform_func(

1770

type_func(value),

1771

variant_level=variant_level)

1772

self.PropertyChanged(dbus.String(dbus_name),

1773

dbus_value)

1774

self.PropertiesChanged(

1775

_interface,

1776

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

1777

dbus_value}),

1778

dbus.Array())

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1281

self.PropertyChanged(dbus.String(dbus_name),

1282

dbus_value)

1779

1283

setattr(self, attrname, value)

1780

1284

1781

1285

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

1782

1286

1783

1287

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1784

1288

approvals_pending = notifychangeproperty(dbus.Boolean,

1785

1289

"ApprovalPending",

1786

type_func=bool)

1290

type_func = bool)

1787

1291

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

1788

1292

last_enabled = notifychangeproperty(datetime_to_dbus,

1789

1293

"LastEnabled")

1790

checker = notifychangeproperty(

1791

dbus.Boolean, "CheckerRunning",

1792

type_func=lambda checker: checker is not None)

1294

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

1295

type_func = lambda checker:

1296

checker is not None)

1793

1297

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1794

1298

"LastCheckedOK")

1795

1299

last_checker_status = notifychangeproperty(dbus.Int16,

1798

1302

datetime_to_dbus, "LastApprovalRequest")

1799

1303

approved_by_default = notifychangeproperty(dbus.Boolean,

1800

1304

"ApprovedByDefault")

1801

approval_delay = notifychangeproperty(

1802

dbus.UInt64, "ApprovalDelay",

1803

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

1305

approval_delay = notifychangeproperty(dbus.UInt64,

1306

"ApprovalDelay",

1307

type_func =

1308

timedelta_to_milliseconds)

1804

1309

approval_duration = notifychangeproperty(

1805

1310

dbus.UInt64, "ApprovalDuration",

1806

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

1311

type_func = timedelta_to_milliseconds)

1807

1312

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

1808

timeout = notifychangeproperty(

1809

dbus.UInt64, "Timeout",

1810

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

1313

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

1314

type_func =

1315

timedelta_to_milliseconds)

1811

1316

extended_timeout = notifychangeproperty(

1812

1317

dbus.UInt64, "ExtendedTimeout",

1813

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

1814

interval = notifychangeproperty(

1815

dbus.UInt64, "Interval",

1816

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

1318

type_func = timedelta_to_milliseconds)

1319

interval = notifychangeproperty(dbus.UInt64,

1320

"Interval",

1321

type_func =

1322

timedelta_to_milliseconds)

1817

1323

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

1818

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

1819

invalidate_only=True)

1820

1324

1821

1325

del notifychangeproperty

1822

1326

1823

1327

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

1824

1328

try:

1825

1329

self.remove_from_connection()

1828

1332

if hasattr(DBusObjectWithProperties, "__del__"):

1829

1333

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

1830

1334

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

1831

1832

def checker_callback(self, source, condition,

1833

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

1834

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

1835

connection, command, *args,

1836

**kwargs)

1837

exitstatus = self.last_checker_status

1838

if exitstatus >= 0:

1335

1336

def checker_callback(self, pid, condition, command,

1337

*args, **kwargs):

1338

self.checker_callback_tag = None

1339

self.checker = None

1340

if os.WIFEXITED(condition):

1341

exitstatus = os.WEXITSTATUS(condition)

1839

1342

# Emit D-Bus signal

1840

1343

self.CheckerCompleted(dbus.Int16(exitstatus),

1841

# This is specific to GNU libC

1842

dbus.Int64(exitstatus << 8),

1344

dbus.Int64(condition),

1843

1345

dbus.String(command))

1844

1346

else:

1845

1347

# Emit D-Bus signal

1846

1348

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

1847

dbus.Int64(

1848

# This is specific to GNU libC

1849

(exitstatus << 8)

1850

| self.last_checker_signal),

1349

dbus.Int64(condition),

1851

1350

dbus.String(command))

1852

return ret

1853

1351

1352

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

1353

*args, **kwargs)

1354

1854

1355

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

1855

1356

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

1856

1357

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

1860

1361

# Emit D-Bus signal

1861

1362

self.CheckerStarted(self.current_checker_command)

1862

1363

return r

1863

1364

1864

1365

def _reset_approved(self):

1865

1366

self.approved = None

1866

1367

return False

1867

1368

1868

1369

def approve(self, value=True):

1869

1370

self.approved = value

1870

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

1871

* 1000), self._reset_approved)

1371

gobject.timeout_add(timedelta_to_milliseconds

1372

(self.approval_duration),

1373

self._reset_approved)

1872

1374

self.send_changedstate()

1873

1874

# D-Bus methods, signals & properties

1875

1876

# Interfaces

1877

1878

# Signals

1879

1375

1376

## D-Bus methods, signals & properties

1377

_interface = "se.recompile.Mandos.Client"

1378

1379

## Interfaces

1380

1381

@dbus_interface_annotations(_interface)

1382

def _foo(self):

1383

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

1384

"false"}

1385

1386

## Signals

1387

1880

1388

# CheckerCompleted - signal

1881

1389

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

1882

1390

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

1883

1391

"D-Bus signal"

1884

1392

pass

1885

1393

1886

1394

# CheckerStarted - signal

1887

1395

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

1888

1396

def CheckerStarted(self, command):

1889

1397

"D-Bus signal"

1890

1398

pass

1891

1399

1892

1400

# PropertyChanged - signal

1893

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

1894

1401

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

1895

1402

def PropertyChanged(self, property, value):

1896

1403

"D-Bus signal"

1897

1404

pass

1898

1405

1899

1406

# GotSecret - signal

1900

1407

@dbus.service.signal(_interface)

1901

1408

def GotSecret(self):

1904

1411

server to mandos-client

1905

1412

"""

1906

1413

pass

1907

1414

1908

1415

# Rejected - signal

1909

1416

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

1910

1417

def Rejected(self, reason):

1911

1418

"D-Bus signal"

1912

1419

pass

1913

1420

1914

1421

# NeedApproval - signal

1915

1422

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

1916

1423

def NeedApproval(self, timeout, default):

1917

1424

"D-Bus signal"

1918

1425

return self.need_approval()

1919

1920

# Methods

1921

1426

1427

## Methods

1428

1922

1429

# Approve - method

1923

1430

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

1924

1431

def Approve(self, value):

1925

1432

self.approve(value)

1926

1433

1927

1434

# CheckedOK - method

1928

1435

@dbus.service.method(_interface)

1929

1436

def CheckedOK(self):

1930

1437

self.checked_ok()

1931

1438

1932

1439

# Enable - method

1933

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

1934

1440

@dbus.service.method(_interface)

1935

1441

def Enable(self):

1936

1442

"D-Bus method"

1937

1443

self.enable()

1938

1444

1939

1445

# StartChecker - method

1940

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

1941

1446

@dbus.service.method(_interface)

1942

1447

def StartChecker(self):

1943

1448

"D-Bus method"

1944

1449

self.start_checker()

1945

1450

1946

1451

# Disable - method

1947

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

1948

1452

@dbus.service.method(_interface)

1949

1453

def Disable(self):

1950

1454

"D-Bus method"

1951

1455

self.disable()

1952

1456

1953

1457

# StopChecker - method

1954

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

1955

1458

@dbus.service.method(_interface)

1956

1459

def StopChecker(self):

1957

1460

self.stop_checker()

1958

1959

# Properties

1960

1461

1462

## Properties

1463

1961

1464

# ApprovalPending - property

1962

1465

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

1963

1466

def ApprovalPending_dbus_property(self):

1964

1467

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

1965

1468

1966

1469

# ApprovedByDefault - property

1967

@dbus_service_property(_interface,

1968

signature="b",

1470

@dbus_service_property(_interface, signature="b",

1969

1471

access="readwrite")

1970

1472

def ApprovedByDefault_dbus_property(self, value=None):

1971

1473

if value is None: # get

1972

1474

return dbus.Boolean(self.approved_by_default)

1973

1475

self.approved_by_default = bool(value)

1974

1476

1975

1477

# ApprovalDelay - property

1976

@dbus_service_property(_interface,

1977

signature="t",

1478

@dbus_service_property(_interface, signature="t",

1978

1479

access="readwrite")

1979

1480

def ApprovalDelay_dbus_property(self, value=None):

1980

1481

if value is None: # get

1981

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

1982

* 1000)

1482

return dbus.UInt64(self.approval_delay_milliseconds())

1983

1483

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

1984

1484

1985

1485

# ApprovalDuration - property

1986

@dbus_service_property(_interface,

1987

signature="t",

1486

@dbus_service_property(_interface, signature="t",

1988

1487

access="readwrite")

1989

1488

def ApprovalDuration_dbus_property(self, value=None):

1990

1489

if value is None: # get

1991

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

1992

* 1000)

1490

return dbus.UInt64(timedelta_to_milliseconds(

1491

self.approval_duration))

1993

1492

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

1994

1493

1995

1494

# Name - property

1996

@dbus_annotations(

1997

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

1998

1495

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

1999

1496

def Name_dbus_property(self):

2000

1497

return dbus.String(self.name)

2001

1498

2002

1499

# Fingerprint - property

2003

@dbus_annotations(

2004

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

2005

1500

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

2006

1501

def Fingerprint_dbus_property(self):

2007

1502

return dbus.String(self.fingerprint)

2008

1503

2009

1504

# Host - property

2010

@dbus_service_property(_interface,

2011

signature="s",

1505

@dbus_service_property(_interface, signature="s",

2012

1506

access="readwrite")

2013

1507

def Host_dbus_property(self, value=None):

2014

1508

if value is None: # get

2015

1509

return dbus.String(self.host)

2016

self.host = str(value)

2017

1510

self.host = unicode(value)

1511

2018

1512

# Created - property

2019

@dbus_annotations(

2020

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

2021

1513

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

2022

1514

def Created_dbus_property(self):

2023

1515

return datetime_to_dbus(self.created)

2024

1516

2025

1517

# LastEnabled - property

2026

1518

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

2027

1519

def LastEnabled_dbus_property(self):

2028

1520

return datetime_to_dbus(self.last_enabled)

2029

1521

2030

1522

# Enabled - property

2031

@dbus_service_property(_interface,

2032

signature="b",

1523

@dbus_service_property(_interface, signature="b",

2033

1524

access="readwrite")

2034

1525

def Enabled_dbus_property(self, value=None):

2035

1526

if value is None: # get

2038

1529

self.enable()

2039

1530

else:

2040

1531

self.disable()

2041

1532

2042

1533

# LastCheckedOK - property

2043

@dbus_service_property(_interface,

2044

signature="s",

1534

@dbus_service_property(_interface, signature="s",

2045

1535

access="readwrite")

2046

1536

def LastCheckedOK_dbus_property(self, value=None):

2047

1537

if value is not None:

2048

1538

self.checked_ok()

2049

1539

return

2050

1540

return datetime_to_dbus(self.last_checked_ok)

2051

1541

2052

1542

# LastCheckerStatus - property

2053

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

1543

@dbus_service_property(_interface, signature="n",

1544

access="read")

2054

1545

def LastCheckerStatus_dbus_property(self):

2055

1546

return dbus.Int16(self.last_checker_status)

2056

1547

2057

1548

# Expires - property

2058

1549

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

2059

1550

def Expires_dbus_property(self):

2060

1551

return datetime_to_dbus(self.expires)

2061

1552

2062

1553

# LastApprovalRequest - property

2063

1554

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

2064

1555

def LastApprovalRequest_dbus_property(self):

2065

1556

return datetime_to_dbus(self.last_approval_request)

2066

1557

2067

1558

# Timeout - property

2068

@dbus_service_property(_interface,

2069

signature="t",

1559

@dbus_service_property(_interface, signature="t",

2070

1560

access="readwrite")

2071

1561

def Timeout_dbus_property(self, value=None):

2072

1562

if value is None: # get

2073

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

1563

return dbus.UInt64(self.timeout_milliseconds())

2074

1564

old_timeout = self.timeout

2075

1565

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

2076

1566

# Reschedule disabling

2084

1574

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

2085

1575

is None):

2086

1576

return

2087

GLib.source_remove(self.disable_initiator_tag)

2088

self.disable_initiator_tag = GLib.timeout_add(

2089

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

2090

self.disable)

2091

1577

gobject.source_remove(self.disable_initiator_tag)

1578

self.disable_initiator_tag = (

1579

gobject.timeout_add(

1580

timedelta_to_milliseconds(self.expires - now),

1581

self.disable))

1582

2092

1583

# ExtendedTimeout - property

2093

@dbus_service_property(_interface,

2094

signature="t",

1584

@dbus_service_property(_interface, signature="t",

2095

1585

access="readwrite")

2096

1586

def ExtendedTimeout_dbus_property(self, value=None):

2097

1587

if value is None: # get

2098

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

2099

* 1000)

1588

return dbus.UInt64(self.extended_timeout_milliseconds())

2100

1589

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

2101

1590

2102

1591

# Interval - property

2103

@dbus_service_property(_interface,

2104

signature="t",

1592

@dbus_service_property(_interface, signature="t",

2105

1593

access="readwrite")

2106

1594

def Interval_dbus_property(self, value=None):

2107

1595

if value is None: # get

2108

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

1596

return dbus.UInt64(self.interval_milliseconds())

2109

1597

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

2110

1598

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

2111

1599

return

2112

1600

if self.enabled:

2113

1601

# Reschedule checker run

2114

GLib.source_remove(self.checker_initiator_tag)

2115

self.checker_initiator_tag = GLib.timeout_add(

2116

value, self.start_checker)

2117

self.start_checker() # Start one now, too

2118

1602

gobject.source_remove(self.checker_initiator_tag)

1603

self.checker_initiator_tag = (gobject.timeout_add

1604

(value, self.start_checker))

1605

self.start_checker() # Start one now, too

1606

2119

1607

# Checker - property

2120

@dbus_service_property(_interface,

2121

signature="s",

1608

@dbus_service_property(_interface, signature="s",

2122

1609

access="readwrite")

2123

1610

def Checker_dbus_property(self, value=None):

2124

1611

if value is None: # get

2125

1612

return dbus.String(self.checker_command)

2126

self.checker_command = str(value)

2127

1613

self.checker_command = unicode(value)

1614

2128

1615

# CheckerRunning - property

2129

@dbus_service_property(_interface,

2130

signature="b",

1616

@dbus_service_property(_interface, signature="b",

2131

1617

access="readwrite")

2132

1618

def CheckerRunning_dbus_property(self, value=None):

2133

1619

if value is None: # get

2136

1622

self.start_checker()

2137

1623

else:

2138

1624

self.stop_checker()

2139

1625

2140

1626

# ObjectPath - property

2141

@dbus_annotations(

2142

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

2143

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

2144

1627

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

2145

1628

def ObjectPath_dbus_property(self):

2146

return self.dbus_object_path # is already a dbus.ObjectPath

2147

1629

return self.dbus_object_path # is already a dbus.ObjectPath

1630

2148

1631

# Secret = property

2149

@dbus_annotations(

2150

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

2151

"invalidates"})

2152

@dbus_service_property(_interface,

2153

signature="ay",

2154

access="write",

2155

byte_arrays=True)

1632

@dbus_service_property(_interface, signature="ay",

1633

access="write", byte_arrays=True)

2156

1634

def Secret_dbus_property(self, value):

2157

self.secret = bytes(value)

2158

1635

self.secret = str(value)

1636

2159

1637

del _interface

2160

1638

2161

1639

2164

1642

self._pipe = child_pipe

2165

1643

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

2166

1644

if not self._pipe.recv():

2167

raise KeyError(fpr)

2168

1645

raise KeyError()

1646

2169

1647

def __getattribute__(self, name):

2170

1648

if name == '_pipe':

2171

1649

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

2174

1652

if data[0] == 'data':

2175

1653

return data[1]

2176

1654

if data[0] == 'function':

2177

2178

1655

def func(*args, **kwargs):

2179

1656

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

2180

1657

return self._pipe.recv()[1]

2181

2182

1658

return func

2183

1659

2184

1660

def __setattr__(self, name, value):

2185

1661

if name == '_pipe':

2186

1662

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

2189

1665

2190

1666

class ClientHandler(socketserver.BaseRequestHandler, object):

2191

1667

"""A class to handle client connections.

2192

1668

2193

1669

Instantiated once for each connection to handle it.

2194

1670

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

2195

1671

2196

1672

def handle(self):

2197

1673

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

2198

1674

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

2199

str(self.client_address))

1675

unicode(self.client_address))

2200

1676

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

2201

1677

self.server.child_pipe.fileno())

2202

2203

session = gnutls.ClientSession(self.request)

2204

2205

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

2206

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

2207

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

2208

# "+DHE-DSS"))

1678

1679

session = (gnutls.connection

1680

.ClientSession(self.request,

1681

gnutls.connection

1682

.X509Credentials()))

1683

1684

# Note: gnutls.connection.X509Credentials is really a

1685

# generic GnuTLS certificate credentials object so long as

1686

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

1687

# here despite using OpenPGP certificates.

1688

1689

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

1690

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

1691

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

1692

# "+DHE-DSS"))

2209

1693

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

2210

1694

priority = self.server.gnutls_priority

2211

1695

if priority is None:

2212

1696

priority = "NORMAL"

2213

gnutls.priority_set_direct(session._c_object,

2214

priority.encode("utf-8"),

2215

None)

2216

1697

(gnutls.library.functions

1698

.gnutls_priority_set_direct(session._c_object,

1699

priority, None))

1700

2217

1701

# Start communication using the Mandos protocol

2218

1702

# Get protocol number

2219

1703

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

2224

1708

except (ValueError, IndexError, RuntimeError) as error:

2225

1709

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

2226

1710

return

2227

1711

2228

1712

# Start GnuTLS connection

2229

1713

try:

2230

1714

session.handshake()

2231

except gnutls.Error as error:

1715

except gnutls.errors.GNUTLSError as error:

2232

1716

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

2233

1717

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

2234

1718

# established. Just abandon the request.

2235

1719

return

2236

1720

logger.debug("Handshake succeeded")

2237

1721

2238

1722

approval_required = False

2239

1723

try:

2240

1724

try:

2241

fpr = self.fingerprint(

2242

self.peer_certificate(session))

2243

except (TypeError, gnutls.Error) as error:

1725

fpr = self.fingerprint(self.peer_certificate

1726

(session))

1727

except (TypeError,

1728

gnutls.errors.GNUTLSError) as error:

2244

1729

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

2245

1730

return

2246

1731

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

2247

1732

2248

1733

try:

2249

1734

client = ProxyClient(child_pipe, fpr,

2250

1735

self.client_address)

2251

1736

except KeyError:

2252

1737

return

2253

1738

2254

1739

if client.approval_delay:

2255

1740

delay = client.approval_delay

2256

1741

client.approvals_pending += 1

2257

1742

approval_required = True

2258

1743

2259

1744

while True:

2260

1745

if not client.enabled:

2261

1746

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

2262

client.name)

1747

client.name)

2263

1748

if self.server.use_dbus:

2264

1749

# Emit D-Bus signal

2265

1750

client.Rejected("Disabled")

2266

1751

return

2267

1752

2268

1753

if client.approved or not client.approval_delay:

2269

# We are approved or approval is disabled

1754

#We are approved or approval is disabled

2270

1755

break

2271

1756

elif client.approved is None:

2272

1757

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

2274

1759

if self.server.use_dbus:

2275

1760

# Emit D-Bus signal

2276

1761

client.NeedApproval(

2277

client.approval_delay.total_seconds()

2278

* 1000, client.approved_by_default)

1762

client.approval_delay_milliseconds(),

1763

client.approved_by_default)

2279

1764

else:

2280

1765

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

2281

1766

client.name)

2283

1768

# Emit D-Bus signal

2284

1769

client.Rejected("Denied")

2285

1770

return

2286

2287

# wait until timeout or approved

1771

1772

#wait until timeout or approved

2288

1773

time = datetime.datetime.now()

2289

1774

client.changedstate.acquire()

2290

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

1775

client.changedstate.wait(

1776

float(timedelta_to_milliseconds(delay)

1777

/ 1000))

2291

1778

client.changedstate.release()

2292

1779

time2 = datetime.datetime.now()

2293

1780

if (time2 - time) >= delay:

2303

1790

break

2304

1791

else:

2305

1792

delay -= time2 - time

2306

2307

try:

2308

session.send(client.secret)

2309

except gnutls.Error as error:

2310

logger.warning("gnutls send failed",

2311

exc_info=error)

2312

return

2313

1793

1794

sent_size = 0

1795

while sent_size < len(client.secret):

1796

try:

1797

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

1798

except gnutls.errors.GNUTLSError as error:

1799

logger.warning("gnutls send failed",

1800

exc_info=error)

1801

return

1802

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

1803

sent, len(client.secret)

1804

- (sent_size + sent))

1805

sent_size += sent

1806

2314

1807

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

2315

1808

# bump the timeout using extended_timeout

2316

1809

client.bump_timeout(client.extended_timeout)

2317

1810

if self.server.use_dbus:

2318

1811

# Emit D-Bus signal

2319

1812

client.GotSecret()

2320

1813

2321

1814

finally:

2322

1815

if approval_required:

2323

1816

client.approvals_pending -= 1

2324

1817

try:

2325

1818

session.bye()

2326

except gnutls.Error as error:

1819

except gnutls.errors.GNUTLSError as error:

2327

1820

logger.warning("GnuTLS bye failed",

2328

1821

exc_info=error)

2329

1822

2330

1823

@staticmethod

2331

1824

def peer_certificate(session):

2332

1825

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

2333

1826

# If not an OpenPGP certificate...

2334

if (gnutls.certificate_type_get(session._c_object)

2335

!= gnutls.CRT_OPENPGP):

2336

# ...return invalid data

2337

return b""

1827

if (gnutls.library.functions

1828

.gnutls_certificate_type_get(session._c_object)

1829

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1830

# ...do the normal thing

1831

return session.peer_certificate

2338

1832

list_size = ctypes.c_uint(1)

2339

cert_list = (gnutls.certificate_get_peers

1833

cert_list = (gnutls.library.functions

1834

.gnutls_certificate_get_peers

2340

1835

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

2341

1836

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

2342

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

1837

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

1838

" certificate")

2343

1839

if list_size.value == 0:

2344

1840

return None

2345

1841

cert = cert_list[0]

2346

1842

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

2347

1843

2348

1844

@staticmethod

2349

1845

def fingerprint(openpgp):

2350

1846

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2351

1847

# New GnuTLS "datum" with the OpenPGP public key

2352

datum = gnutls.datum_t(

2353

ctypes.cast(ctypes.c_char_p(openpgp),

2354

ctypes.POINTER(ctypes.c_ubyte)),

2355

ctypes.c_uint(len(openpgp)))

1848

datum = (gnutls.library.types

1849

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

1850

ctypes.POINTER

1851

(ctypes.c_ubyte)),

1852

ctypes.c_uint(len(openpgp))))

2356

1853

# New empty GnuTLS certificate

2357

crt = gnutls.openpgp_crt_t()

2358

gnutls.openpgp_crt_init(ctypes.byref(crt))

1854

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1855

(gnutls.library.functions

1856

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2359

1857

# Import the OpenPGP public key into the certificate

2360

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

2361

gnutls.OPENPGP_FMT_RAW)

1858

(gnutls.library.functions

1859

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

1860

gnutls.library.constants

1861

.GNUTLS_OPENPGP_FMT_RAW))

2362

1862

# Verify the self signature in the key

2363

1863

crtverify = ctypes.c_uint()

2364

gnutls.openpgp_crt_verify_self(crt, 0,

2365

ctypes.byref(crtverify))

1864

(gnutls.library.functions

1865

.gnutls_openpgp_crt_verify_self(crt, 0,

1866

ctypes.byref(crtverify)))

2366

1867

if crtverify.value != 0:

2367

gnutls.openpgp_crt_deinit(crt)

2368

raise gnutls.CertificateSecurityError("Verify failed")

1868

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1869

raise (gnutls.errors.CertificateSecurityError

1870

("Verify failed"))

2369

1871

# New buffer for the fingerprint

2370

1872

buf = ctypes.create_string_buffer(20)

2371

1873

buf_len = ctypes.c_size_t()

2372

1874

# Get the fingerprint from the certificate into the buffer

2373

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

2374

ctypes.byref(buf_len))

1875

(gnutls.library.functions

1876

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

1877

ctypes.byref(buf_len)))

2375

1878

# Deinit the certificate

2376

gnutls.openpgp_crt_deinit(crt)

1879

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2377

1880

# Convert the buffer to a Python bytestring

2378

1881

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

2379

1882

# Convert the bytestring to hexadecimal notation

2383

1886

2384

1887

class MultiprocessingMixIn(object):

2385

1888

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

2386

2387

1889

def sub_process_main(self, request, address):

2388

1890

try:

2389

1891

self.finish_request(request, address)

2390

1892

except Exception:

2391

1893

self.handle_error(request, address)

2392

1894

self.close_request(request)

2393

1895

2394

1896

def process_request(self, request, address):

2395

1897

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

2396

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

2397

args=(request, address))

1898

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

1899

args = (request, address))

2398

1900

proc.start()

2399

1901

return proc

2400

1902

2401

1903

2402

1904

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2403

1905

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

2404

2405

1906

def process_request(self, request, client_address):

2406

1907

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

2407

1908

2408

1909

This function creates a new pipe in self.pipe

2409

1910

"""

2410

1911

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2411

1912

2412

1913

proc = MultiprocessingMixIn.process_request(self, request,

2413

1914

client_address)

2414

1915

self.child_pipe.close()

2415

1916

self.add_pipe(parent_pipe, proc)

2416

1917

2417

1918

def add_pipe(self, parent_pipe, proc):

2418

1919

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

2419

1920

raise NotImplementedError()

2422

1923

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2423

1924

socketserver.TCPServer, object):

2424

1925

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

2425

1926

2426

1927

Attributes:

2427

1928

enabled: Boolean; whether this server is activated yet

2428

1929

interface: None or a network interface name (string)

2429

1930

use_ipv6: Boolean; to use IPv6 or not

2430

1931

"""

2431

2432

1932

def __init__(self, server_address, RequestHandlerClass,

2433

interface=None,

2434

use_ipv6=True,

2435

socketfd=None):

1933

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

2436

1934

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

2437

1935

creating a new one with socket.socket().

2438

1936

"""

2444

1942

self.socketfd = socketfd

2445

1943

# Save the original socket.socket() function

2446

1944

self.socket_socket = socket.socket

2447

2448

1945

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

2449

#

1946

#

2450

1947

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

2451

1948

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

2452

1949

# patching socket.socket.)

2453

#

1950

#

2454

1951

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

2455

1952

@functools.wraps(socket.socket)

2456

1953

def socket_wrapper(*args, **kwargs):

2468

1965

# socket_wrapper(), if socketfd was set.

2469

1966

socketserver.TCPServer.__init__(self, server_address,

2470

1967

RequestHandlerClass)

2471

1968

2472

1969

def server_bind(self):

2473

1970

"""This overrides the normal server_bind() function

2474

1971

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

2475

1972

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

2476

global SO_BINDTODEVICE

2477

1973

if self.interface is not None:

2478

1974

if SO_BINDTODEVICE is None:

2479

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

2480

# common enough.

2481

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

2482

SO_BINDTODEVICE = 25

2483

try:

2484

self.socket.setsockopt(

2485

socket.SOL_SOCKET, SO_BINDTODEVICE,

2486

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

2487

except socket.error as error:

2488

if error.errno == errno.EPERM:

2489

logger.error("No permission to bind to"

2490

" interface %s", self.interface)

2491

elif error.errno == errno.ENOPROTOOPT:

2492

logger.error("SO_BINDTODEVICE not available;"

2493

" cannot bind to interface %s",

2494

self.interface)

2495

elif error.errno == errno.ENODEV:

2496

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

2497

" cannot bind", self.interface)

2498

else:

2499

raise

1975

logger.error("SO_BINDTODEVICE does not exist;"

1976

" cannot bind to interface %s",

1977

self.interface)

1978

else:

1979

try:

1980

self.socket.setsockopt(socket.SOL_SOCKET,

1981

SO_BINDTODEVICE,

1982

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

1983

except socket.error as error:

1984

if error.errno == errno.EPERM:

1985

logger.error("No permission to bind to"

1986

" interface %s", self.interface)

1987

elif error.errno == errno.ENOPROTOOPT:

1988

logger.error("SO_BINDTODEVICE not available;"

1989

" cannot bind to interface %s",

1990

self.interface)

1991

elif error.errno == errno.ENODEV:

1992

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

1993

" cannot bind", self.interface)

1994

else:

1995

raise

2500

1996

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

2501

1997

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

2502

1998

if not self.server_address[0]:

2503

1999

if self.address_family == socket.AF_INET6:

2504

any_address = "::" # in6addr_any

2000

any_address = "::" # in6addr_any

2505

2001

else:

2506

any_address = "0.0.0.0" # INADDR_ANY

2002

any_address = "0.0.0.0" # INADDR_ANY

2507

2003

self.server_address = (any_address,

2508

2004

self.server_address[1])

2509

2005

elif not self.server_address[1]:

2510

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

2006

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

2007

0)

2511

2008

# if self.interface:

2512

2009

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

2513

2010

# 0, # port

2519

2016

2520

2017

class MandosServer(IPv6_TCPServer):

2521

2018

"""Mandos server.

2522

2019

2523

2020

Attributes:

2524

2021

clients: set of Client objects

2525

2022

gnutls_priority GnuTLS priority string

2526

2023

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

2527

2528

Assumes a GLib.MainLoop event loop.

2024

2025

Assumes a gobject.MainLoop event loop.

2529

2026

"""

2530

2531

2027

def __init__(self, server_address, RequestHandlerClass,

2532

interface=None,

2533

use_ipv6=True,

2534

clients=None,

2535

gnutls_priority=None,

2536

use_dbus=True,

2537

socketfd=None):

2028

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

2029

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

2538

2030

self.enabled = False

2539

2031

self.clients = clients

2540

2032

if self.clients is None:

2543

2035

self.gnutls_priority = gnutls_priority

2544

2036

IPv6_TCPServer.__init__(self, server_address,

2545

2037

RequestHandlerClass,

2546

interface=interface,

2547

use_ipv6=use_ipv6,

2548

socketfd=socketfd)

2549

2038

interface = interface,

2039

use_ipv6 = use_ipv6,

2040

socketfd = socketfd)

2550

2041

def server_activate(self):

2551

2042

if self.enabled:

2552

2043

return socketserver.TCPServer.server_activate(self)

2553

2044

2554

2045

def enable(self):

2555

2046

self.enabled = True

2556

2047

2557

2048

def add_pipe(self, parent_pipe, proc):

2558

2049

# Call "handle_ipc" for both data and EOF events

2559

GLib.io_add_watch(

2560

parent_pipe.fileno(),

2561

GLib.IO_IN | GLib.IO_HUP,

2562

functools.partial(self.handle_ipc,

2563

parent_pipe=parent_pipe,

2564

proc=proc))

2565

2566

def handle_ipc(self, source, condition,

2567

parent_pipe=None,

2568

proc=None,

2569

client_object=None):

2050

gobject.io_add_watch(parent_pipe.fileno(),

2051

gobject.IO_IN | gobject.IO_HUP,

2052

functools.partial(self.handle_ipc,

2053

parent_pipe =

2054

parent_pipe,

2055

proc = proc))

2056

2057

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

2058

proc = None, client_object=None):

2570

2059

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

2571

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

2060

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

2572

2061

# Wait for other process to exit

2573

2062

proc.join()

2574

2063

return False

2575

2064

2576

2065

# Read a request from the child

2577

2066

request = parent_pipe.recv()

2578

2067

command = request[0]

2579

2068

2580

2069

if command == 'init':

2581

2070

fpr = request[1]

2582

2071

address = request[2]

2583

2584

for c in self.clients.values():

2072

2073

for c in self.clients.itervalues():

2585

2074

if c.fingerprint == fpr:

2586

2075

client = c

2587

2076

break

2594

2083

address[0])

2595

2084

parent_pipe.send(False)

2596

2085

return False

2597

2598

GLib.io_add_watch(

2599

parent_pipe.fileno(),

2600

GLib.IO_IN | GLib.IO_HUP,

2601

functools.partial(self.handle_ipc,

2602

parent_pipe=parent_pipe,

2603

proc=proc,

2604

client_object=client))

2086

2087

gobject.io_add_watch(parent_pipe.fileno(),

2088

gobject.IO_IN | gobject.IO_HUP,

2089

functools.partial(self.handle_ipc,

2090

parent_pipe =

2091

parent_pipe,

2092

proc = proc,

2093

client_object =

2094

client))

2605

2095

parent_pipe.send(True)

2606

2096

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

2607

2097

# same fileno

2610

2100

funcname = request[1]

2611

2101

args = request[2]

2612

2102

kwargs = request[3]

2613

2103

2614

2104

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

2615

2105

funcname)(*args,

2616

**kwargs)))

2617

2106

**kwargs)))

2107

2618

2108

if command == 'getattr':

2619

2109

attrname = request[1]

2620

if isinstance(client_object.__getattribute__(attrname),

2621

collections.Callable):

2622

parent_pipe.send(('function', ))

2110

if callable(client_object.__getattribute__(attrname)):

2111

parent_pipe.send(('function',))

2623

2112

else:

2624

parent_pipe.send((

2625

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

2626

2113

parent_pipe.send(('data', client_object

2114

.__getattribute__(attrname)))

2115

2627

2116

if command == 'setattr':

2628

2117

attrname = request[1]

2629

2118

value = request[2]

2630

2119

setattr(client_object, attrname, value)

2631

2120

2632

2121

return True

2633

2122

2634

2123

2635

2124

def rfc3339_duration_to_delta(duration):

2636

2125

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

2637

2126

2638

2127

>>> rfc3339_duration_to_delta("P7D")

2639

2128

datetime.timedelta(7)

2640

2129

>>> rfc3339_duration_to_delta("PT60S")

2650

2139

>>> rfc3339_duration_to_delta("P1DT3M20S")

2651

2140

datetime.timedelta(1, 200)

2652

2141

"""

2653

2142

2654

2143

# Parsing an RFC 3339 duration with regular expressions is not

2655

2144

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

2656

2145

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

2657

2146

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

2658

2147

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

2659

2148

# avoid excessive use of external libraries.

2660

2149

2661

2150

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

2662

Token = collections.namedtuple("Token", (

2663

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

2664

# a "group" containing digits

2665

"value", # datetime.timedelta or None

2666

"followers")) # Tokens valid after this token

2151

Token = collections.namedtuple("Token",

2152

("regexp", # To match token; if

2153

# "value" is not None,

2154

# must have a "group"

2155

# containing digits

2156

"value", # datetime.timedelta or

2157

# None

2158

"followers")) # Tokens valid after

2159

# this token

2667

2160

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

2668

2161

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

2669

2162

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

2670

2163

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

2671

2164

datetime.timedelta(seconds=1),

2672

frozenset((token_end, )))

2165

frozenset((token_end,)))

2673

2166

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

2674

2167

datetime.timedelta(minutes=1),

2675

2168

frozenset((token_second, token_end)))

2691

2184

frozenset((token_month, token_end)))

2692

2185

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

2693

2186

datetime.timedelta(weeks=1),

2694

frozenset((token_end, )))

2187

frozenset((token_end,)))

2695

2188

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

2696

2189

frozenset((token_year, token_month,

2697

2190

token_day, token_time,

2698

token_week)))

2699

# Define starting values:

2700

# Value so far

2701

value = datetime.timedelta()

2191

token_week))),

2192

# Define starting values

2193

value = datetime.timedelta() # Value so far

2702

2194

found_token = None

2703

# Following valid tokens

2704

followers = frozenset((token_duration, ))

2705

# String left to parse

2706

s = duration

2195

followers = frozenset(token_duration,) # Following valid tokens

2196

s = duration # String left to parse

2707

2197

# Loop until end token is found

2708

2198

while found_token is not token_end:

2709

2199

# Search for any currently valid tokens

2725

2215

break

2726

2216

else:

2727

2217

# No currently valid tokens were found

2728

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

2729

.format(duration))

2218

raise ValueError("Invalid RFC 3339 duration")

2730

2219

# End token found

2731

2220

return value

2732

2221

2733

2222

2734

2223

def string_to_delta(interval):

2735

2224

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

2736

2225

2737

2226

>>> string_to_delta('7d')

2738

2227

datetime.timedelta(7)

2739

2228

>>> string_to_delta('60s')

2747

2236

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

2748

2237

datetime.timedelta(0, 330)

2749

2238

"""

2750

2239

2751

2240

try:

2752

2241

return rfc3339_duration_to_delta(interval)

2753

2242

except ValueError:

2754

2243

pass

2755

2244

2756

2245

timevalue = datetime.timedelta(0)

2757

2246

for s in interval.split():

2758

2247

try:

2759

suffix = s[-1]

2248

suffix = unicode(s[-1])

2760

2249

value = int(s[:-1])

2761

2250

if suffix == "d":

2762

2251

delta = datetime.timedelta(value)

2769

2258

elif suffix == "w":

2770

2259

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

2771

2260

else:

2772

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

2261

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

2262

.format(suffix))

2773

2263

except IndexError as e:

2774

2264

raise ValueError(*(e.args))

2775

2265

timevalue += delta

2776

2266

return timevalue

2777

2267

2778

2268

2779

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

2269

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

2780

2270

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

2781

2271

2782

2272

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

2783

2273

if os.fork():

2784

2274

sys.exit()

2792

2282

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

2793

2283

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

2794

2284

raise OSError(errno.ENODEV,

2795

"{} not a character device"

2285

"{0} not a character device"

2796

2286

.format(os.devnull))

2797

2287

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

2798

2288

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

2802

2292

2803

2293

2804

2294

def main():

2805

2295

2806

2296

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

2807

2297

# Parsing of options, both command line and config file

2808

2298

2809

2299

parser = argparse.ArgumentParser()

2810

2300

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

2811

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

2301

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

2812

2302

help="show version number and exit")

2813

2303

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

2814

2304

help="Bind to interface IF")

2850

2340

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

2851

2341

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

2852

2342

default=None)

2853

2343

2854

2344

options = parser.parse_args()

2855

2345

2856

2346

if options.check:

2857

2347

import doctest

2858

2348

fail_count, test_count = doctest.testmod()

2859

2349

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

2860

2350

2861

2351

# Default values for config file for server-global settings

2862

server_defaults = {"interface": "",

2863

"address": "",

2864

"port": "",

2865

"debug": "False",

2866

"priority":

2867

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

2868

":+SIGN-DSA-SHA256",

2869

"servicename": "Mandos",

2870

"use_dbus": "True",

2871

"use_ipv6": "True",

2872

"debuglevel": "",

2873

"restore": "True",

2874

"socket": "",

2875

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

2876

"foreground": "False",

2877

"zeroconf": "True",

2878

}

2879

2352

server_defaults = { "interface": "",

2353

"address": "",

2354

"port": "",

2355

"debug": "False",

2356

"priority":

2357

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

2358

"servicename": "Mandos",

2359

"use_dbus": "True",

2360

"use_ipv6": "True",

2361

"debuglevel": "",

2362

"restore": "True",

2363

"socket": "",

2364

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

2365

"foreground": "False",

2366

"zeroconf": "True",

2367

}

2368

2880

2369

# Parse config file for server-global settings

2881

2370

server_config = configparser.SafeConfigParser(server_defaults)

2882

2371

del server_defaults

2883

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

2372

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

2373

"mandos.conf"))

2884

2374

# Convert the SafeConfigParser object to a dict

2885

2375

server_settings = server_config.defaults()

2886

2376

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

2887

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

2888

"foreground", "zeroconf"):

2377

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

2889

2378

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

2890

2379

option)

2891

2380

if server_settings["port"]:

2901

2390

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

2902

2391

["socket"])

2903

2392

del server_config

2904

2393

2905

2394

# Override the settings from the config file with command line

2906

2395

# options, if set.

2907

2396

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

2908

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

2909

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

2910

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

2397

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

2398

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

2399

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

2911

2400

value = getattr(options, option)

2912

2401

if value is not None:

2913

2402

server_settings[option] = value

2914

2403

del options

2915

2404

# Force all strings to be unicode

2916

2405

for option in server_settings.keys():

2917

if isinstance(server_settings[option], bytes):

2918

server_settings[option] = (server_settings[option]

2919

.decode("utf-8"))

2406

if type(server_settings[option]) is str:

2407

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

2920

2408

# Force all boolean options to be boolean

2921

2409

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

2922

2410

"foreground", "zeroconf"):

2925

2413

if server_settings["debug"]:

2926

2414

server_settings["foreground"] = True

2927

2415

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

2928

2416

2929

2417

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

2930

2931

if (not server_settings["zeroconf"]

2932

and not (server_settings["port"]

2933

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

2934

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

2935

2418

2419

if (not server_settings["zeroconf"] and

2420

not (server_settings["port"]

2421

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

2422

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

2423

" Zeroconf")

2424

2936

2425

# For convenience

2937

2426

debug = server_settings["debug"]

2938

2427

debuglevel = server_settings["debuglevel"]

2942

2431

stored_state_file)

2943

2432

foreground = server_settings["foreground"]

2944

2433

zeroconf = server_settings["zeroconf"]

2945

2434

2946

2435

if debug:

2947

2436

initlogger(debug, logging.DEBUG)

2948

2437

else:

2951

2440

else:

2952

2441

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

2953

2442

initlogger(debug, level)

2954

2443

2955

2444

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

2956

syslogger.setFormatter(

2957

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

2958

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

2959

server_settings["servicename"])))

2960

2445

syslogger.setFormatter(logging.Formatter

2446

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

2447

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

2448

.format(server_settings

2449

["servicename"])))

2450

2961

2451

# Parse config file with clients

2962

2452

client_config = configparser.SafeConfigParser(Client

2963

2453

.client_defaults)

2964

2454

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

2965

2455

"clients.conf"))

2966

2456

2967

2457

global mandos_dbus_service

2968

2458

mandos_dbus_service = None

2969

2459

2970

2460

socketfd = None

2971

2461

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

2972

2462

socketfd = server_settings["socket"]

2973

tcp_server = MandosServer(

2974

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

2975

ClientHandler,

2976

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

2977

use_ipv6=use_ipv6,

2978

gnutls_priority=server_settings["priority"],

2979

use_dbus=use_dbus,

2980

socketfd=socketfd)

2463

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

2464

server_settings["port"]),

2465

ClientHandler,

2466

interface=(server_settings["interface"]

2467

or None),

2468

use_ipv6=use_ipv6,

2469

gnutls_priority=

2470

server_settings["priority"],

2471

use_dbus=use_dbus,

2472

socketfd=socketfd)

2981

2473

if not foreground:

2982

2474

pidfilename = "/run/mandos.pid"

2983

2475

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

2984

2476

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

2985

2477

pidfile = None

2986

2478

try:

2987

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

2479

pidfile = open(pidfilename, "w")

2988

2480

except IOError as e:

2989

2481

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

2990

2482

exc_info=e)

2991

2992

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

2993

("mandos", "mandos"),

2994

("nobody", "nogroup")):

2483

2484

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

2995

2485

try:

2996

2486

uid = pwd.getpwnam(name).pw_uid

2997

gid = pwd.getpwnam(group).pw_gid

2487

gid = pwd.getpwnam(name).pw_gid

2998

2488

break

2999

2489

except KeyError:

3000

2490

continue

3004

2494

try:

3005

2495

os.setgid(gid)

3006

2496

os.setuid(uid)

3007

if debug:

3008

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

3009

gid))

3010

2497

except OSError as error:

3011

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

3012

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

3013

2498

if error.errno != errno.EPERM:

3014

2499

raise

3015

2500

3016

2501

if debug:

3017

2502

# Enable all possible GnuTLS debugging

3018

2503

3019

2504

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

3020

2505

# - GnuTLS manual

3021

gnutls.global_set_log_level(11)

3022

3023

@gnutls.log_func

2506

gnutls.library.functions.gnutls_global_set_log_level(11)

2507

2508

@gnutls.library.types.gnutls_log_func

3024

2509

def debug_gnutls(level, string):

3025

2510

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

3026

3027

gnutls.global_set_log_function(debug_gnutls)

3028

2511

2512

(gnutls.library.functions

2513

.gnutls_global_set_log_function(debug_gnutls))

2514

3029

2515

# Redirect stdin so all checkers get /dev/null

3030

2516

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

3031

2517

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

3032

2518

if null > 2:

3033

2519

os.close(null)

3034

2520

3035

2521

# Need to fork before connecting to D-Bus

3036

2522

if not foreground:

3037

2523

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

3038

2524

daemon()

3039

3040

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

3041

# to inform GLib that threads will be used.

3042

GLib.threads_init()

3043

2525

2526

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

2527

# need to inform gobject that threads will be used.

2528

gobject.threads_init()

2529

3044

2530

global main_loop

3045

2531

# From the Avahi example code

3046

2532

DBusGMainLoop(set_as_default=True)

3047

main_loop = GLib.MainLoop()

2533

main_loop = gobject.MainLoop()

3048

2534

bus = dbus.SystemBus()

3049

2535

# End of Avahi example code

3050

2536

if use_dbus:

3051

2537

try:

3052

2538

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

3053

bus,

3054

do_not_queue=True)

3055

old_bus_name = dbus.service.BusName(

3056

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

3057

do_not_queue=True)

3058

except dbus.exceptions.DBusException as e:

2539

bus, do_not_queue=True)

2540

old_bus_name = (dbus.service.BusName

2541

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

2542

do_not_queue=True))

2543

except dbus.exceptions.NameExistsException as e:

3059

2544

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

3060

2545

use_dbus = False

3061

2546

server_settings["use_dbus"] = False

3062

2547

tcp_server.use_dbus = False

3063

2548

if zeroconf:

3064

2549

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3065

service = AvahiServiceToSyslog(

3066

name=server_settings["servicename"],

3067

servicetype="_mandos._tcp",

3068

protocol=protocol,

3069

bus=bus)

2550

service = AvahiServiceToSyslog(name =

2551

server_settings["servicename"],

2552

servicetype = "_mandos._tcp",

2553

protocol = protocol, bus = bus)

3070

2554

if server_settings["interface"]:

3071

service.interface = if_nametoindex(

3072

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

3073

2555

service.interface = (if_nametoindex

2556

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

2557

3074

2558

global multiprocessing_manager

3075

2559

multiprocessing_manager = multiprocessing.Manager()

3076

2560

3077

2561

client_class = Client

3078

2562

if use_dbus:

3079

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

3080

2563

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

2564

3081

2565

client_settings = Client.config_parser(client_config)

3082

2566

old_client_settings = {}

3083

2567

clients_data = {}

3084

2568

3085

2569

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

3086

2570

global wnull

3087

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

2571

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

3088

2572

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

3089

2573

# mode

3090

2574

if debug or not foreground:

3091

2575

wnull.close()

3092

2576

3093

2577

# Get client data and settings from last running state.

3094

2578

if server_settings["restore"]:

3095

2579

try:

3096

2580

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

3097

if sys.version_info.major == 2:

3098

clients_data, old_client_settings = pickle.load(

3099

stored_state)

3100

else:

3101

bytes_clients_data, bytes_old_client_settings = (

3102

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

3103

# Fix bytes to strings

3104

# clients_data

3105

# .keys()

3106

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

3107

if isinstance(key, bytes)

3108

else key): value

3109

for key, value in

3110

bytes_clients_data.items()}

3111

del bytes_clients_data

3112

for key in clients_data:

3113

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

3114

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

3115

for k, v in

3116

clients_data[key].items()}

3117

clients_data[key] = value

3118

# .client_structure

3119

value["client_structure"] = [

3120

(s.decode("utf-8")

3121

if isinstance(s, bytes)

3122

else s) for s in

3123

value["client_structure"]]

3124

# .name & .host

3125

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

3126

if isinstance(value[k], bytes):

3127

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

3128

# old_client_settings

3129

# .keys()

3130

old_client_settings = {

3131

(key.decode("utf-8")

3132

if isinstance(key, bytes)

3133

else key): value

3134

for key, value in

3135

bytes_old_client_settings.items()}

3136

del bytes_old_client_settings

3137

# .host

3138

for value in old_client_settings.values():

3139

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

3140

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

3141

.decode("utf-8"))

2581

clients_data, old_client_settings = (pickle.load

2582

(stored_state))

3142

2583

os.remove(stored_state_path)

3143

2584

except IOError as e:

3144

2585

if e.errno == errno.ENOENT:

3145

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

3146

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

2586

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

2587

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

3147

2588

else:

3148

2589

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

3149

2590

exc_info=e)

3150

2591

raise

3151

2592

except EOFError as e:

3152

2593

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

3153

"EOFError:",

3154

exc_info=e)

3155

2594

"EOFError:", exc_info=e)

2595

3156

2596

with PGPEngine() as pgp:

3157

for client_name, client in clients_data.items():

2597

for client_name, client in clients_data.iteritems():

3158

2598

# Skip removed clients

3159

2599

if client_name not in client_settings:

3160

2600

continue

3161

2601

3162

2602

# Decide which value to use after restoring saved state.

3163

2603

# We have three different values: Old config file,

3164

2604

# new config file, and saved state.

3169

2609

# For each value in new config, check if it

3170

2610

# differs from the old config value (Except for

3171

2611

# the "secret" attribute)

3172

if (name != "secret"

3173

and (value !=

3174

old_client_settings[client_name][name])):

2612

if (name != "secret" and

2613

value != old_client_settings[client_name]

2614

[name]):

3175

2615

client[name] = value

3176

2616

except KeyError:

3177

2617

pass

3178

2618

3179

2619

# Clients who has passed its expire date can still be

3180

# enabled if its last checker was successful. A Client

2620

# enabled if its last checker was successful. Clients

3181

2621

# whose checker succeeded before we stored its state is

3182

2622

# assumed to have successfully run all checkers during

3183

2623

# downtime.

3185

2625

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

3186

2626

if not client["last_checked_ok"]:

3187

2627

logger.warning(

3188

"disabling client {} - Client never "

3189

"performed a successful checker".format(

3190

client_name))

2628

"disabling client {0} - Client never "

2629

"performed a successful checker"

2630

.format(client_name))

3191

2631

client["enabled"] = False

3192

2632

elif client["last_checker_status"] != 0:

3193

2633

logger.warning(

3194

"disabling client {} - Client last"

3195

" checker failed with error code"

3196

" {}".format(

3197

client_name,

3198

client["last_checker_status"]))

2634

"disabling client {0} - Client "

2635

"last checker failed with error code {1}"

2636

.format(client_name,

2637

client["last_checker_status"]))

3199

2638

client["enabled"] = False

3200

2639

else:

3201

client["expires"] = (

3202

datetime.datetime.utcnow()

3203

+ client["timeout"])

2640

client["expires"] = (datetime.datetime

2641

.utcnow()

2642

+ client["timeout"])

3204

2643

logger.debug("Last checker succeeded,"

3205

" keeping {} enabled".format(

3206

client_name))

2644

" keeping {0} enabled"

2645

.format(client_name))

3207

2646

try:

3208

client["secret"] = pgp.decrypt(

3209

client["encrypted_secret"],

3210

client_settings[client_name]["secret"])

2647

client["secret"] = (

2648

pgp.decrypt(client["encrypted_secret"],

2649

client_settings[client_name]

2650

["secret"]))

3211

2651

except PGPError:

3212

2652

# If decryption fails, we use secret from new settings

3213

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

3214

client_name))

3215

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

3216

["secret"])

3217

2653

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

2654

.format(client_name))

2655

client["secret"] = (

2656

client_settings[client_name]["secret"])

2657

3218

2658

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

3219

2659

for client_name in (set(old_client_settings)

3220

2660

- set(client_settings)):

3222

2662

for client_name in (set(client_settings)

3223

2663

- set(old_client_settings)):

3224

2664

clients_data[client_name] = client_settings[client_name]

3225

2665

3226

2666

# Create all client objects

3227

for client_name, client in clients_data.items():

2667

for client_name, client in clients_data.iteritems():

3228

2668

tcp_server.clients[client_name] = client_class(

3229

name=client_name,

3230

settings=client,

3231

server_settings=server_settings)

3232

2669

name = client_name, settings = client,

2670

server_settings = server_settings)

2671

3233

2672

if not tcp_server.clients:

3234

2673

logger.warning("No clients defined")

3235

2674

3236

2675

if not foreground:

3237

2676

if pidfile is not None:

3238

pid = os.getpid()

3239

2677

try:

3240

2678

with pidfile:

3241

print(pid, file=pidfile)

2679

pid = os.getpid()

2680

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

3242

2681

except IOError:

3243

2682

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

3244

2683

pidfilename, pid)

3245

2684

del pidfile

3246

2685

del pidfilename

3247

3248

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

3249

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3250

lambda: main_loop.quit() and False)

3251

2686

2687

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

2688

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

2689

3252

2690

if use_dbus:

3253

3254

@alternate_dbus_interfaces(

3255

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

3256

class MandosDBusService(DBusObjectWithObjectManager):

2691

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

2692

"se.bsnet.fukt.Mandos"})

2693

class MandosDBusService(DBusObjectWithProperties):

3257

2694

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

3258

3259

2695

def __init__(self):

3260

2696

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

3261

3262

2697

_interface = "se.recompile.Mandos"

3263

2698

2699

@dbus_interface_annotations(_interface)

2700

def _foo(self):

2701

return { "org.freedesktop.DBus.Property"

2702

".EmitsChangedSignal":

2703

"false"}

2704

3264

2705

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

3265

2706

def ClientAdded(self, objpath):

3266

2707

"D-Bus signal"

3267

2708

pass

3268

2709

3269

2710

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

3270

2711

def ClientNotFound(self, fingerprint, address):

3271

2712

"D-Bus signal"

3272

2713

pass

3273

3274

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

3275

"true"})

2714

3276

2715

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

3277

2716

def ClientRemoved(self, objpath, name):

3278

2717

"D-Bus signal"

3279

2718

pass

3280

3281

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

3282

"true"})

2719

3283

2720

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

3284

2721

def GetAllClients(self):

3285

2722

"D-Bus method"

3286

return dbus.Array(c.dbus_object_path for c in

3287

tcp_server.clients.values())

3288

3289

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

3290

"true"})

2723

return dbus.Array(c.dbus_object_path

2724

for c in

2725

tcp_server.clients.itervalues())

2726

3291

2727

@dbus.service.method(_interface,

3292

2728

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

3293

2729

def GetAllClientsWithProperties(self):

3294

2730

"D-Bus method"

3295

2731

return dbus.Dictionary(

3296

{c.dbus_object_path: c.GetAll(

3297

"se.recompile.Mandos.Client")

3298

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

2732

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

2733

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

3299

2734

signature="oa{sv}")

3300

2735

3301

2736

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

3302

2737

def RemoveClient(self, object_path):

3303

2738

"D-Bus method"

3304

for c in tcp_server.clients.values():

2739

for c in tcp_server.clients.itervalues():

3305

2740

if c.dbus_object_path == object_path:

3306

2741

del tcp_server.clients[c.name]

3307

2742

c.remove_from_connection()

3308

# Don't signal the disabling

2743

# Don't signal anything except ClientRemoved

3309

2744

c.disable(quiet=True)

3310

# Emit D-Bus signal for removal

3311

self.client_removed_signal(c)

2745

# Emit D-Bus signal

2746

self.ClientRemoved(object_path, c.name)

3312

2747

return

3313

2748

raise KeyError(object_path)

3314

2749

3315

2750

del _interface

3316

3317

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3318

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

3319

def GetManagedObjects(self):

3320

"""D-Bus method"""

3321

return dbus.Dictionary(

3322

{client.dbus_object_path:

3323

dbus.Dictionary(

3324

{interface: client.GetAll(interface)

3325

for interface in

3326

client._get_all_interface_names()})

3327

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

3328

3329

def client_added_signal(self, client):

3330

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

3331

if use_dbus:

3332

# New standard signal

3333

self.InterfacesAdded(

3334

client.dbus_object_path,

3335

dbus.Dictionary(

3336

{interface: client.GetAll(interface)

3337

for interface in

3338

client._get_all_interface_names()}))

3339

# Old signal

3340

self.ClientAdded(client.dbus_object_path)

3341

3342

def client_removed_signal(self, client):

3343

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

3344

if use_dbus:

3345

# New standard signal

3346

self.InterfacesRemoved(

3347

client.dbus_object_path,

3348

client._get_all_interface_names())

3349

# Old signal

3350

self.ClientRemoved(client.dbus_object_path,

3351

client.name)

3352

2751

3353

2752

mandos_dbus_service = MandosDBusService()

3354

3355

# Save modules to variables to exempt the modules from being

3356

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

3357

mp = multiprocessing

3358

wn = wnull

3359

2753

3360

2754

def cleanup():

3361

2755

"Cleanup function; run on exit"

3362

2756

if zeroconf:

3363

2757

service.cleanup()

3364

3365

mp.active_children()

3366

wn.close()

2758

2759

multiprocessing.active_children()

2760

wnull.close()

3367

2761

if not (tcp_server.clients or client_settings):

3368

2762

return

3369

2763

3370

2764

# Store client before exiting. Secrets are encrypted with key

3371

2765

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

3372

2766

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

3373

2767

clients = {}

3374

2768

with PGPEngine() as pgp:

3375

for client in tcp_server.clients.values():

2769

for client in tcp_server.clients.itervalues():

3376

2770

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

3377

2771

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

3378

2772

key)

3379

2773

client_dict = {}

3380

2774

3381

2775

# A list of attributes that can not be pickled

3382

2776

# + secret.

3383

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

3384

"checker", "server_settings"}

3385

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

3386

.Object):

2777

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

2778

"checker", "server_settings"))

2779

for name, typ in (inspect.getmembers

2780

(dbus.service.Object)):

3387

2781

exclude.add(name)

3388

2782

3389

2783

client_dict["encrypted_secret"] = (client

3390

2784

.encrypted_secret)

3391

2785

for attr in client.client_structure:

3392

2786

if attr not in exclude:

3393

2787

client_dict[attr] = getattr(client, attr)

3394

2788

3395

2789

clients[client.name] = client_dict

3396

2790

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

3397

2791

3398

2792

try:

3399

with tempfile.NamedTemporaryFile(

3400

mode='wb',

3401

suffix=".pickle",

3402

prefix='clients-',

3403

dir=os.path.dirname(stored_state_path),

3404

delete=False) as stored_state:

3405

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

3406

protocol=2)

3407

tempname = stored_state.name

2793

with (tempfile.NamedTemporaryFile

2794

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

2795

dir=os.path.dirname(stored_state_path),

2796

delete=False)) as stored_state:

2797

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

2798

tempname=stored_state.name

3408

2799

os.rename(tempname, stored_state_path)

3409

2800

except (IOError, OSError) as e:

3410

2801

if not debug:

3413

2804

except NameError:

3414

2805

pass

3415

2806

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

3416

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

2807

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

3417

2808

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

3418

2809

else:

3419

2810

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

3420

2811

exc_info=e)

3421

2812

raise

3422

2813

3423

2814

# Delete all clients, and settings from config

3424

2815

while tcp_server.clients:

3425

2816

name, client = tcp_server.clients.popitem()

3426

2817

if use_dbus:

3427

2818

client.remove_from_connection()

3428

# Don't signal the disabling

2819

# Don't signal anything except ClientRemoved

3429

2820

client.disable(quiet=True)

3430

# Emit D-Bus signal for removal

3431

2821

if use_dbus:

3432

mandos_dbus_service.client_removed_signal(client)

2822

# Emit D-Bus signal

2823

mandos_dbus_service.ClientRemoved(client

2824

.dbus_object_path,

2825

client.name)

3433

2826

client_settings.clear()

3434

2827

3435

2828

atexit.register(cleanup)

3436

3437

for client in tcp_server.clients.values():

2829

2830

for client in tcp_server.clients.itervalues():

3438

2831

if use_dbus:

3439

# Emit D-Bus signal for adding

3440

mandos_dbus_service.client_added_signal(client)

2832

# Emit D-Bus signal

2833

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3441

2834

# Need to initiate checking of clients

3442

2835

if client.enabled:

3443

2836

client.init_checker()

3444

2837

3445

2838

tcp_server.enable()

3446

2839

tcp_server.server_activate()

3447

2840

3448

2841

# Find out what port we got

3449

2842

if zeroconf:

3450

2843

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

3455

2848

else: # IPv4

3456

2849

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

3457

2850

*tcp_server.socket.getsockname())

3458

3459

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

3460

2851

2852

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

2853

3461

2854

try:

3462

2855

if zeroconf:

3463

2856

# From the Avahi example code

3468

2861

cleanup()

3469

2862

sys.exit(1)

3470

2863

# End of Avahi example code

3471

3472

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

3473

lambda *args, **kwargs:

3474

(tcp_server.handle_request

3475

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

3476

2864

2865

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

2866

lambda *args, **kwargs:

2867

(tcp_server.handle_request

2868

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

2869

3477

2870

logger.debug("Starting main loop")

3478

2871

main_loop.run()

3479

2872

except AvahiError as error:

3488

2881

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

3489

2882

cleanup()

3490

2883

3491

3492

2884

if __name__ == '__main__':

3493

2885

main()