/mandos/trunk : revision 659

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

89

SO_BINDTODEVICE = None

90

91

version = "1.6.4"

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

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

116

117

syslogger = (logging.handlers.SysLogHandler

118

(facility =

119

logging.handlers.SysLogHandler.LOG_DAEMON,

120

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

162

121

syslogger.setFormatter(logging.Formatter

163

122

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

164

123

' %(message)s'))

165

124

logger.addHandler(syslogger)

166

125

167

126

if debug:

168

127

console = logging.StreamHandler()

169

128

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

181

140

182

141

class PGPEngine(object):

183

142

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

184

185

143

def __init__(self):

186

144

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

145

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

146

'--home', self.tempdir,

200

147

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

148

'--quiet',

149

'--no-use-agent']

150

206

151

def __enter__(self):

207

152

return self

208

153

209

154

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

210

155

self._cleanup()

211

156

return False

212

157

213

158

def __del__(self):

214

159

self._cleanup()

215

160

216

161

def _cleanup(self):

217

162

if self.tempdir is not None:

218

163

# Delete contents of tempdir

219

164

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

220

topdown=False):

165

topdown = False):

221

166

for filename in files:

222

167

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

223

168

for dirname in dirs:

225

170

# Remove tempdir

226

171

os.rmdir(self.tempdir)

227

172

self.tempdir = None

228

173

229

174

def password_encode(self, password):

230

175

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

231

176

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

236

181

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

237

182

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

238

183

return encoded

239

184

240

185

def encrypt(self, data, password):

241

186

passphrase = self.password_encode(password)

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

187

with tempfile.NamedTemporaryFile(dir=self.tempdir

188

) as passfile:

244

189

passfile.write(passphrase)

245

190

passfile.flush()

246

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

191

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

247

192

'--passphrase-file',

248

193

passfile.name]

249

194

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

195

stdin = subprocess.PIPE,

196

stdout = subprocess.PIPE,

197

stderr = subprocess.PIPE)

198

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

254

199

if proc.returncode != 0:

255

200

raise PGPError(err)

256

201

return ciphertext

257

202

258

203

def decrypt(self, data, password):

259

204

passphrase = self.password_encode(password)

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

205

with tempfile.NamedTemporaryFile(dir = self.tempdir

206

) as passfile:

262

207

passfile.write(passphrase)

263

208

passfile.flush()

264

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

209

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

265

210

'--passphrase-file',

266

211

passfile.name]

267

212

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

213

stdin = subprocess.PIPE,

214

stdout = subprocess.PIPE,

215

stderr = subprocess.PIPE)

216

decrypted_plaintext, err = proc.communicate(input

217

= data)

272

218

if proc.returncode != 0:

273

219

raise PGPError(err)

274

220

return decrypted_plaintext

275

221

276

222

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

223

class AvahiError(Exception):

305

224

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

306

225

self.value = value

307

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

308

**kwargs)

309

226

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

227

def __unicode__(self):

228

return unicode(repr(self.value))

310

229

311

230

class AvahiServiceError(AvahiError):

312

231

pass

313

232

314

315

233

class AvahiGroupError(AvahiError):

316

234

pass

317

235

318

236

319

237

class AvahiService(object):

320

238

"""An Avahi (Zeroconf) service.

321

239

322

240

Attributes:

323

241

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

324

242

Used to optionally bind to the specified interface.

336

254

server: D-Bus Server

337

255

bus: dbus.SystemBus()

338

256

"""

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

257

258

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

259

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

260

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

261

protocol = avahi.PROTO_UNSPEC, bus = None):

351

262

self.interface = interface

352

263

self.name = name

353

264

self.type = servicetype

362

273

self.server = None

363

274

self.bus = bus

364

275

self.entry_group_state_changed_match = None

365

366

def rename(self, remove=True):

276

277

def rename(self):

367

278

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

368

279

if self.rename_count >= self.max_renames:

369

280

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

370

281

" after %i retries, exiting.",

371

282

self.rename_count)

372

283

raise AvahiServiceError("Too many renames")

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

284

self.name = unicode(self.server

285

.GetAlternativeServiceName(self.name))

376

286

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

377

287

self.name)

378

if remove:

379

self.remove()

288

self.remove()

380

289

try:

381

290

self.add()

382

291

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

292

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

293

self.cleanup()

294

os._exit(1)

295

self.rename_count += 1

296

392

297

def remove(self):

393

298

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

394

299

if self.entry_group_state_changed_match is not None:

396

301

self.entry_group_state_changed_match = None

397

302

if self.group is not None:

398

303

self.group.Reset()

399

304

400

305

def add(self):

401

306

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

402

307

self.remove()

419

324

dbus.UInt16(self.port),

420

325

avahi.string_array_to_txt_array(self.TXT))

421

326

self.group.Commit()

422

327

423

328

def entry_group_state_changed(self, state, error):

424

329

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

425

330

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

426

331

427

332

if state == avahi.ENTRY_GROUP_ESTABLISHED:

428

333

logger.debug("Zeroconf service established.")

429

334

elif state == avahi.ENTRY_GROUP_COLLISION:

431

336

self.rename()

432

337

elif state == avahi.ENTRY_GROUP_FAILURE:

433

338

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

434

str(error))

435

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

436

339

unicode(error))

340

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

341

.format(error))

342

437

343

def cleanup(self):

438

344

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

439

345

if self.group is not None:

444

350

pass

445

351

self.group = None

446

352

self.remove()

447

353

448

354

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

449

355

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

450

356

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

}

357

bad_states = { avahi.SERVER_INVALID:

358

"Zeroconf server invalid",

359

avahi.SERVER_REGISTERING: None,

360

avahi.SERVER_COLLISION:

361

"Zeroconf server name collision",

362

avahi.SERVER_FAILURE:

363

"Zeroconf server failure" }

457

364

if state in bad_states:

458

365

if bad_states[state] is not None:

459

366

if error is None:

462

369

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

463

370

self.cleanup()

464

371

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)

372

self.add()

477

373

else:

478

374

if error is None:

479

375

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

480

376

else:

481

377

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

482

378

483

379

def activate(self):

484

380

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

485

381

if self.server is None:

489

385

follow_name_owner_changes=True),

490

386

avahi.DBUS_INTERFACE_SERVER)

491

387

self.server.connect_to_signal("StateChanged",

492

self.server_state_changed)

388

self.server_state_changed)

493

389

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

494

390

495

391

496

392

class AvahiServiceToSyslog(AvahiService):

497

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

393

def rename(self):

498

394

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

499

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

500

**kwargs)

501

syslogger.setFormatter(logging.Formatter(

502

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

503

.format(self.name)))

395

ret = AvahiService.rename(self)

396

syslogger.setFormatter(logging.Formatter

397

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

398

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

399

.format(self.name)))

504

400

return ret

505

401

506

402

507

# Pretend that we have a GnuTLS module

508

class GnuTLS(object):

509

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

510

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

511

512

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

513

if library is None:

514

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

515

_library = ctypes.cdll.LoadLibrary(library)

516

del library

517

_need_version = b"3.3.0"

518

519

def __init__(self):

520

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

521

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

522

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

523

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

524

.format(self._need_version))

525

526

# Unless otherwise indicated, the constants and types below are

527

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

528

529

# Constants

530

E_SUCCESS = 0

531

E_INTERRUPTED = -52

532

E_AGAIN = -28

533

CRT_OPENPGP = 2

534

CLIENT = 2

535

SHUT_RDWR = 0

536

CRD_CERTIFICATE = 1

537

E_NO_CERTIFICATE_FOUND = -49

538

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

539

540

# Types

541

class session_int(ctypes.Structure):

542

_fields_ = []

543

session_t = ctypes.POINTER(session_int)

544

545

class certificate_credentials_st(ctypes.Structure):

546

_fields_ = []

547

certificate_credentials_t = ctypes.POINTER(

548

certificate_credentials_st)

549

certificate_type_t = ctypes.c_int

550

551

class datum_t(ctypes.Structure):

552

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

553

('size', ctypes.c_uint)]

554

555

class openpgp_crt_int(ctypes.Structure):

556

_fields_ = []

557

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

558

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

559

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

560

credentials_type_t = ctypes.c_int

561

transport_ptr_t = ctypes.c_void_p

562

close_request_t = ctypes.c_int

563

564

# Exceptions

565

class Error(Exception):

566

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

567

# exception might be raised from within GnuTLS.__init__,

568

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

569

# global variable has happened.

570

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

571

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

572

# code is passed, convert it to a string with

573

# gnutls.strerror()

574

self.code = code

575

if message is None and code is not None:

576

message = GnuTLS.strerror(code)

577

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

578

message, *args)

579

580

class CertificateSecurityError(Error):

581

pass

582

583

# Classes

584

class Credentials(object):

585

def __init__(self):

586

self._c_object = gnutls.certificate_credentials_t()

587

gnutls.certificate_allocate_credentials(

588

ctypes.byref(self._c_object))

589

self.type = gnutls.CRD_CERTIFICATE

590

591

def __del__(self):

592

gnutls.certificate_free_credentials(self._c_object)

593

594

class ClientSession(object):

595

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

596

self._c_object = gnutls.session_t()

597

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

598

gnutls.set_default_priority(self._c_object)

599

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

600

gnutls.handshake_set_private_extensions(self._c_object,

601

True)

602

self.socket = socket

603

if credentials is None:

604

credentials = gnutls.Credentials()

605

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

606

ctypes.cast(credentials._c_object,

607

ctypes.c_void_p))

608

self.credentials = credentials

609

610

def __del__(self):

611

gnutls.deinit(self._c_object)

612

613

def handshake(self):

614

return gnutls.handshake(self._c_object)

615

616

def send(self, data):

617

data = bytes(data)

618

data_len = len(data)

619

while data_len > 0:

620

data_len -= gnutls.record_send(self._c_object,

621

data[-data_len:],

622

data_len)

623

624

def bye(self):

625

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

626

627

# Error handling functions

628

def _error_code(result):

629

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

630

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

631

if result >= 0:

632

return result

633

if result == gnutls.E_NO_CERTIFICATE_FOUND:

634

raise gnutls.CertificateSecurityError(code=result)

635

raise gnutls.Error(code=result)

636

637

def _retry_on_error(result, func, arguments):

638

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

639

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

640

while result < 0:

641

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

642

return _error_code(result)

643

result = func(*arguments)

644

return result

645

646

# Unless otherwise indicated, the function declarations below are

647

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

648

649

# Functions

650

priority_set_direct = _library.gnutls_priority_set_direct

651

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

652

ctypes.POINTER(ctypes.c_char_p)]

653

priority_set_direct.restype = _error_code

654

655

init = _library.gnutls_init

656

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

657

init.restype = _error_code

658

659

set_default_priority = _library.gnutls_set_default_priority

660

set_default_priority.argtypes = [session_t]

661

set_default_priority.restype = _error_code

662

663

record_send = _library.gnutls_record_send

664

record_send.argtypes = [session_t, ctypes.c_void_p,

665

ctypes.c_size_t]

666

record_send.restype = ctypes.c_ssize_t

667

record_send.errcheck = _retry_on_error

668

669

certificate_allocate_credentials = (

670

_library.gnutls_certificate_allocate_credentials)

671

certificate_allocate_credentials.argtypes = [

672

ctypes.POINTER(certificate_credentials_t)]

673

certificate_allocate_credentials.restype = _error_code

674

675

certificate_free_credentials = (

676

_library.gnutls_certificate_free_credentials)

677

certificate_free_credentials.argtypes = [

678

certificate_credentials_t]

679

certificate_free_credentials.restype = None

680

681

handshake_set_private_extensions = (

682

_library.gnutls_handshake_set_private_extensions)

683

handshake_set_private_extensions.argtypes = [session_t,

684

ctypes.c_int]

685

handshake_set_private_extensions.restype = None

686

687

credentials_set = _library.gnutls_credentials_set

688

credentials_set.argtypes = [session_t, credentials_type_t,

689

ctypes.c_void_p]

690

credentials_set.restype = _error_code

691

692

strerror = _library.gnutls_strerror

693

strerror.argtypes = [ctypes.c_int]

694

strerror.restype = ctypes.c_char_p

695

696

certificate_type_get = _library.gnutls_certificate_type_get

697

certificate_type_get.argtypes = [session_t]

698

certificate_type_get.restype = _error_code

699

700

certificate_get_peers = _library.gnutls_certificate_get_peers

701

certificate_get_peers.argtypes = [session_t,

702

ctypes.POINTER(ctypes.c_uint)]

703

certificate_get_peers.restype = ctypes.POINTER(datum_t)

704

705

global_set_log_level = _library.gnutls_global_set_log_level

706

global_set_log_level.argtypes = [ctypes.c_int]

707

global_set_log_level.restype = None

708

709

global_set_log_function = _library.gnutls_global_set_log_function

710

global_set_log_function.argtypes = [log_func]

711

global_set_log_function.restype = None

712

713

deinit = _library.gnutls_deinit

714

deinit.argtypes = [session_t]

715

deinit.restype = None

716

717

handshake = _library.gnutls_handshake

718

handshake.argtypes = [session_t]

719

handshake.restype = _error_code

720

handshake.errcheck = _retry_on_error

721

722

transport_set_ptr = _library.gnutls_transport_set_ptr

723

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

724

transport_set_ptr.restype = None

725

726

bye = _library.gnutls_bye

727

bye.argtypes = [session_t, close_request_t]

728

bye.restype = _error_code

729

bye.errcheck = _retry_on_error

730

731

check_version = _library.gnutls_check_version

732

check_version.argtypes = [ctypes.c_char_p]

733

check_version.restype = ctypes.c_char_p

734

735

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

736

737

openpgp_crt_init = _library.gnutls_openpgp_crt_init

738

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

739

openpgp_crt_init.restype = _error_code

740

741

openpgp_crt_import = _library.gnutls_openpgp_crt_import

742

openpgp_crt_import.argtypes = [openpgp_crt_t,

743

ctypes.POINTER(datum_t),

744

openpgp_crt_fmt_t]

745

openpgp_crt_import.restype = _error_code

746

747

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

748

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

749

ctypes.POINTER(ctypes.c_uint)]

750

openpgp_crt_verify_self.restype = _error_code

751

752

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

753

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

754

openpgp_crt_deinit.restype = None

755

756

openpgp_crt_get_fingerprint = (

757

_library.gnutls_openpgp_crt_get_fingerprint)

758

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

759

ctypes.c_void_p,

760

ctypes.POINTER(

761

ctypes.c_size_t)]

762

openpgp_crt_get_fingerprint.restype = _error_code

763

764

# Remove non-public functions

765

del _error_code, _retry_on_error

766

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

767

gnutls = GnuTLS()

768

769

770

def call_pipe(connection, # : multiprocessing.Connection

771

func, *args, **kwargs):

772

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

773

774

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

775

return value on the provided multiprocessing.Connection.

776

"""

777

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

778

connection.close()

403

def timedelta_to_milliseconds(td):

404

"Convert a datetime.timedelta() to milliseconds"

405

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

406

+ (td.seconds * 1000)

407

+ (td.microseconds // 1000))

779

408

780

409

781

410

class Client(object):

782

411

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

783

412

784

413

Attributes:

785

414

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

786

415

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

788

417

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

789

418

to see if the client lives.

790

419

'None' if no process is running.

791

checker_callback_tag: a GLib event source tag, or None

420

checker_callback_tag: a gobject event source tag, or None

792

421

checker_command: string; External command which is run to check

793

422

if client lives. %() expansions are done at

794

423

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

795

424

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

796

checker_initiator_tag: a GLib event source tag, or None

425

checker_initiator_tag: a gobject event source tag, or None

797

426

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

798

427

client_structure: Object describing what attributes a client has

799

428

and is used for storing the client at exit

800

429

current_checker_command: string; current running checker_command

801

disable_initiator_tag: a GLib event source tag, or None

430

disable_initiator_tag: a gobject event source tag, or None

802

431

enabled: bool()

803

432

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

804

433

uniquely identify the client

809

438

last_checker_status: integer between 0 and 255 reflecting exit

810

439

status of last checker. -1 reflects crashed

811

440

checker, -2 means no checker completed yet.

812

last_checker_signal: The signal which killed the last checker, if

813

last_checker_status is -1

814

441

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

815

442

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

816

443

D-Bus identifiers

823

450

disabled, or None

824

451

server_settings: The server_settings dict from main()

825

452

"""

826

453

827

454

runtime_expansions = ("approval_delay", "approval_duration",

828

455

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

829

456

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

830

457

"last_approval_request", "last_checked_ok",

831

458

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

832

client_defaults = {

833

"timeout": "PT5M",

834

"extended_timeout": "PT15M",

835

"interval": "PT2M",

836

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

837

"host": "",

838

"approval_delay": "PT0S",

839

"approval_duration": "PT1S",

840

"approved_by_default": "True",

841

"enabled": "True",

842

}

843

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

462

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

463

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

466

"approved_by_default": "True",

467

"enabled": "True",

468

}

469

470

def timeout_milliseconds(self):

471

"Return the 'timeout' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.timeout)

473

474

def extended_timeout_milliseconds(self):

475

"Return the 'extended_timeout' attribute in milliseconds"

476

return timedelta_to_milliseconds(self.extended_timeout)

477

478

def interval_milliseconds(self):

479

"Return the 'interval' attribute in milliseconds"

480

return timedelta_to_milliseconds(self.interval)

481

482

def approval_delay_milliseconds(self):

483

return timedelta_to_milliseconds(self.approval_delay)

484

844

485

@staticmethod

845

486

def config_parser(config):

846

487

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

853

494

for client_name in config.sections():

854

495

section = dict(config.items(client_name))

855

496

client = settings[client_name] = {}

856

497

857

498

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

858

499

# Reformat values from string types to Python types

859

500

client["approved_by_default"] = config.getboolean(

860

501

client_name, "approved_by_default")

861

502

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

862

503

"enabled")

863

864

# Uppercase and remove spaces from fingerprint for later

865

# comparison purposes with return value from the

866

# fingerprint() function

504

867

505

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

868

506

.replace(" ", ""))

869

507

if "secret" in section:

870

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

871

.encode("utf-8"),

872

"base64")

508

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

873

509

elif "secfile" in section:

874

510

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

875

511

(section["secfile"])),

876

512

"rb") as secfile:

877

513

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

878

514

else:

879

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

515

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

880

516

.format(section))

881

517

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

882

518

client["extended_timeout"] = string_to_delta(

890

526

client["last_approval_request"] = None

891

527

client["last_checked_ok"] = None

892

528

client["last_checker_status"] = -2

893

529

894

530

return settings

895

896

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

531

532

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

897

533

self.name = name

898

534

if server_settings is None:

899

535

server_settings = {}

900

536

self.server_settings = server_settings

901

537

# adding all client settings

902

for setting, value in settings.items():

538

for setting, value in settings.iteritems():

903

539

setattr(self, setting, value)

904

540

905

541

if self.enabled:

906

542

if not hasattr(self, "last_enabled"):

907

543

self.last_enabled = datetime.datetime.utcnow()

911

547

else:

912

548

self.last_enabled = None

913

549

self.expires = None

914

550

915

551

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

552

# Uppercase and remove spaces from fingerprint for later

553

# comparison purposes with return value from the fingerprint()

554

# function

916

555

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

917

556

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

918

557

datetime.datetime.utcnow())

919

558

920

559

# attributes specific for this server instance

921

560

self.checker = None

922

561

self.checker_initiator_tag = None

925

564

self.current_checker_command = None

926

565

self.approved = None

927

566

self.approvals_pending = 0

928

self.changedstate = multiprocessing_manager.Condition(

929

multiprocessing_manager.Lock())

930

self.client_structure = [attr

931

for attr in self.__dict__.keys()

567

self.changedstate = (multiprocessing_manager

568

.Condition(multiprocessing_manager

569

.Lock()))

570

self.client_structure = [attr for attr in

571

self.__dict__.iterkeys()

932

572

if not attr.startswith("_")]

933

573

self.client_structure.append("client_structure")

934

935

for name, t in inspect.getmembers(

936

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

574

575

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

576

lambda obj:

577

isinstance(obj,

578

property)):

937

579

if not name.startswith("_"):

938

580

self.client_structure.append(name)

939

581

940

582

# Send notice to process children that client state has changed

941

583

def send_changedstate(self):

942

584

with self.changedstate:

943

585

self.changedstate.notify_all()

944

586

945

587

def enable(self):

946

588

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

947

589

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

952

594

self.last_enabled = datetime.datetime.utcnow()

953

595

self.init_checker()

954

596

self.send_changedstate()

955

597

956

598

def disable(self, quiet=True):

957

599

"""Disable this client."""

958

600

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

960

602

if not quiet:

961

603

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

962

604

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

963

GLib.source_remove(self.disable_initiator_tag)

605

gobject.source_remove(self.disable_initiator_tag)

964

606

self.disable_initiator_tag = None

965

607

self.expires = None

966

608

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

967

GLib.source_remove(self.checker_initiator_tag)

609

gobject.source_remove(self.checker_initiator_tag)

968

610

self.checker_initiator_tag = None

969

611

self.stop_checker()

970

612

self.enabled = False

971

613

if not quiet:

972

614

self.send_changedstate()

973

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

615

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

974

616

return False

975

617

976

618

def __del__(self):

977

619

self.disable()

978

620

979

621

def init_checker(self):

980

622

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

981

623

# and every interval from then on.

982

624

if self.checker_initiator_tag is not None:

983

GLib.source_remove(self.checker_initiator_tag)

984

self.checker_initiator_tag = GLib.timeout_add(

985

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

986

self.start_checker)

625

gobject.source_remove(self.checker_initiator_tag)

626

self.checker_initiator_tag = (gobject.timeout_add

627

(self.interval_milliseconds(),

628

self.start_checker))

987

629

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

988

630

if self.disable_initiator_tag is not None:

989

GLib.source_remove(self.disable_initiator_tag)

990

self.disable_initiator_tag = GLib.timeout_add(

991

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

631

gobject.source_remove(self.disable_initiator_tag)

632

self.disable_initiator_tag = (gobject.timeout_add

633

(self.timeout_milliseconds(),

634

self.disable))

992

635

# Also start a new checker *right now*.

993

636

self.start_checker()

994

995

def checker_callback(self, source, condition, connection,

996

command):

637

638

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

997

639

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

998

640

self.checker_callback_tag = None

999

641

self.checker = None

1000

# Read return code from connection (see call_pipe)

1001

returncode = connection.recv()

1002

connection.close()

1003

1004

if returncode >= 0:

1005

self.last_checker_status = returncode

1006

self.last_checker_signal = None

642

if os.WIFEXITED(condition):

643

self.last_checker_status = os.WEXITSTATUS(condition)

1007

644

if self.last_checker_status == 0:

1008

645

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

1009

646

vars(self))

1010

647

self.checked_ok()

1011

648

else:

1012

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

649

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

650

vars(self))

1013

651

else:

1014

652

self.last_checker_status = -1

1015

self.last_checker_signal = -returncode

1016

653

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

1017

654

vars(self))

1018

return False

1019

655

1020

656

def checked_ok(self):

1021

657

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

1022

658

self.last_checked_ok = datetime.datetime.utcnow()

1023

659

self.last_checker_status = 0

1024

self.last_checker_signal = None

1025

660

self.bump_timeout()

1026

661

1027

662

def bump_timeout(self, timeout=None):

1028

663

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

1029

664

if timeout is None:

1030

665

timeout = self.timeout

1031

666

if self.disable_initiator_tag is not None:

1032

GLib.source_remove(self.disable_initiator_tag)

667

gobject.source_remove(self.disable_initiator_tag)

1033

668

self.disable_initiator_tag = None

1034

669

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

1035

self.disable_initiator_tag = GLib.timeout_add(

1036

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

670

self.disable_initiator_tag = (gobject.timeout_add

671

(timedelta_to_milliseconds

672

(timeout), self.disable))

1037

673

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

1038

674

1039

675

def need_approval(self):

1040

676

self.last_approval_request = datetime.datetime.utcnow()

1041

677

1042

678

def start_checker(self):

1043

679

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

1044

680

1045

681

If a checker already exists, leave it running and do

1046

682

nothing."""

1047

683

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

1052

688

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

1053

689

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

1054

690

# should be.

1055

1056

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

1057

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

1058

self.checker.join()

1059

self.checker = None

691

692

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

693

try:

694

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

695

except AttributeError:

696

pass

697

except OSError as error:

698

if error.errno != errno.ECHILD:

699

raise

700

else:

701

if pid:

702

logger.warning("Checker was a zombie")

703

gobject.source_remove(self.checker_callback_tag)

704

self.checker_callback(pid, status,

705

self.current_checker_command)

1060

706

# Start a new checker if needed

1061

707

if self.checker is None:

1062

708

# Escape attributes for the shell

1063

escaped_attrs = {

1064

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

1065

for attr in self.runtime_expansions}

709

escaped_attrs = dict(

710

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

711

for attr in

712

self.runtime_expansions)

1066

713

try:

1067

714

command = self.checker_command % escaped_attrs

1068

715

except TypeError as error:

1069

716

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

1070

self.checker_command,

717

self.checker_command, exc_info=error)

718

return True # Try again later

719

self.current_checker_command = command

720

try:

721

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

722

command, self.name)

723

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

724

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

725

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

726

# always replaced by /dev/null.)

727

# The exception is when not debugging but nevertheless

728

# running in the foreground; use the previously

729

# created wnull.

730

popen_args = {}

731

if (not self.server_settings["debug"]

732

and self.server_settings["foreground"]):

733

popen_args.update({"stdout": wnull,

734

"stderr": wnull })

735

self.checker = subprocess.Popen(command,

736

close_fds=True,

737

shell=True, cwd="/",

738

**popen_args)

739

except OSError as error:

740

logger.error("Failed to start subprocess",

1071

741

exc_info=error)

1072

return True # Try again later

1073

self.current_checker_command = command

1074

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

1075

self.name)

1076

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

1077

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

1078

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

1079

# always replaced by /dev/null.)

1080

# The exception is when not debugging but nevertheless

1081

# running in the foreground; use the previously

1082

# created wnull.

1083

popen_args = {"close_fds": True,

1084

"shell": True,

1085

"cwd": "/"}

1086

if (not self.server_settings["debug"]

1087

and self.server_settings["foreground"]):

1088

popen_args.update({"stdout": wnull,

1089

"stderr": wnull})

1090

pipe = multiprocessing.Pipe(duplex=False)

1091

self.checker = multiprocessing.Process(

1092

target=call_pipe,

1093

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

1094

kwargs=popen_args)

1095

self.checker.start()

1096

self.checker_callback_tag = GLib.io_add_watch(

1097

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

1098

self.checker_callback, pipe[0], command)

1099

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

742

return True

743

self.checker_callback_tag = (gobject.child_watch_add

744

(self.checker.pid,

745

self.checker_callback,

746

data=command))

747

# The checker may have completed before the gobject

748

# watch was added. Check for this.

749

try:

750

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

751

except OSError as error:

752

if error.errno == errno.ECHILD:

753

# This should never happen

754

logger.error("Child process vanished",

755

exc_info=error)

756

return True

757

raise

758

if pid:

759

gobject.source_remove(self.checker_callback_tag)

760

self.checker_callback(pid, status, command)

761

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

1100

762

return True

1101

763

1102

764

def stop_checker(self):

1103

765

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

1104

766

if self.checker_callback_tag:

1105

GLib.source_remove(self.checker_callback_tag)

767

gobject.source_remove(self.checker_callback_tag)

1106

768

self.checker_callback_tag = None

1107

769

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

1108

770

return

1109

771

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

1110

self.checker.terminate()

772

try:

773

self.checker.terminate()

774

#time.sleep(0.5)

775

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

776

# self.checker.kill()

777

except OSError as error:

778

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

779

raise

1111

780

self.checker = None

1112

781

1113

782

1114

def dbus_service_property(dbus_interface,

1115

signature="v",

1116

access="readwrite",

1117

byte_arrays=False):

783

def dbus_service_property(dbus_interface, signature="v",

784

access="readwrite", byte_arrays=False):

1118

785

"""Decorators for marking methods of a DBusObjectWithProperties to

1119

786

become properties on the D-Bus.

1120

787

1121

788

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

1122

789

and with one argument by "Set".

1123

790

1124

791

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

1125

792

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

1126

793

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

1129

796

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

1130

797

if byte_arrays and signature != "ay":

1131

798

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

1132

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

1133

799

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

1134

800

def decorator(func):

1135

801

func._dbus_is_property = True

1136

802

func._dbus_interface = dbus_interface

1139

805

func._dbus_name = func.__name__

1140

806

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

1141

807

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

1142

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

808

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1143

809

return func

1144

1145

810

return decorator

1146

811

1147

812

1148

813

def dbus_interface_annotations(dbus_interface):

1149

814

"""Decorator for marking functions returning interface annotations

1150

815

1151

816

Usage:

1152

817

1153

818

@dbus_interface_annotations("org.example.Interface")

1154

819

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

1155

820

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

1156

821

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

1157

822

"false"}

1158

823

"""

1159

1160

824

def decorator(func):

1161

825

func._dbus_is_interface = True

1162

826

func._dbus_interface = dbus_interface

1163

827

func._dbus_name = dbus_interface

1164

828

return func

1165

1166

829

return decorator

1167

830

1168

831

1169

832

def dbus_annotations(annotations):

1170

833

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

1171

834

Usage:

1172

1173

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

1174

"org.freedesktop.DBus.Property."

1175

"EmitsChangedSignal": "false"})

835

1176

836

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

1177

837

access="r")

838

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

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

1178

841

def Property_dbus_property(self):

1179

842

return dbus.Boolean(False)

1180

1181

See also the DBusObjectWithAnnotations class.

1182

843

"""

1183

1184

844

def decorator(func):

1185

845

func._dbus_annotations = annotations

1186

846

return func

1187

1188

847

return decorator

1189

848

1190

849

1191

850

class DBusPropertyException(dbus.exceptions.DBusException):

1192

851

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

1193

852

"""

1194

pass

853

def __unicode__(self):

854

return unicode(str(self))

1195

855

1196

856

1197

857

class DBusPropertyAccessException(DBusPropertyException):

1206

866

pass

1207

867

1208

868

1209

class DBusObjectWithAnnotations(dbus.service.Object):

1210

"""A D-Bus object with annotations.

1211

1212

Classes inheriting from this can use the dbus_annotations

1213

decorator to add annotations to methods or signals.

869

class DBusObjectWithProperties(dbus.service.Object):

870

"""A D-Bus object with properties.

871

872

Classes inheriting from this can use the dbus_service_property

873

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

874

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

1214

875

"""

1215

876

1216

877

@staticmethod

1217

878

def _is_dbus_thing(thing):

1218

879

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

1219

880

1220

881

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

1221

882

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

1222

883

"""

1223

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

884

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

1224

885

False)

1225

886

1226

887

def _get_all_dbus_things(self, thing):

1227

888

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

1228

889

"""

1229

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

890

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

891

name),

1230

892

athing.__get__(self))

1231

893

for cls in self.__class__.__mro__

1232

894

for name, athing in

1233

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

1234

1235

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1236

out_signature="s",

1237

path_keyword='object_path',

1238

connection_keyword='connection')

1239

def Introspect(self, object_path, connection):

1240

"""Overloading of standard D-Bus method.

1241

1242

Inserts annotation tags on methods and signals.

1243

"""

1244

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

1245

connection)

1246

try:

1247

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

1248

1249

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

1250

# Add annotation tags

1251

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

1252

for tag in if_tag.getElementsByTagName(typ):

1253

annots = dict()

1254

for name, prop in (self.

1255

_get_all_dbus_things(typ)):

1256

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

1257

and prop._dbus_interface

1258

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

1259

annots.update(getattr(

1260

prop, "_dbus_annotations", {}))

1261

for name, value in annots.items():

1262

ann_tag = document.createElement(

1263

"annotation")

1264

ann_tag.setAttribute("name", name)

1265

ann_tag.setAttribute("value", value)

1266

tag.appendChild(ann_tag)

1267

# Add interface annotation tags

1268

for annotation, value in dict(

1269

itertools.chain.from_iterable(

1270

annotations().items()

1271

for name, annotations

1272

in self._get_all_dbus_things("interface")

1273

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

1274

)).items():

1275

ann_tag = document.createElement("annotation")

1276

ann_tag.setAttribute("name", annotation)

1277

ann_tag.setAttribute("value", value)

1278

if_tag.appendChild(ann_tag)

1279

# Fix argument name for the Introspect method itself

1280

if (if_tag.getAttribute("name")

1281

== dbus.INTROSPECTABLE_IFACE):

1282

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

1283

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

1284

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

1285

if (arg.getAttribute("direction")

1286

== "out"):

1287

arg.setAttribute("name",

1288

"xml_data")

1289

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

1290

document.unlink()

1291

except (AttributeError, xml.dom.DOMException,

1292

xml.parsers.expat.ExpatError) as error:

1293

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

1294

exc_info=error)

1295

return xmlstring

1296

1297

1298

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1299

"""A D-Bus object with properties.

1300

1301

Classes inheriting from this can use the dbus_service_property

1302

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

1303

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

1304

"""

1305

895

inspect.getmembers(cls,

896

self._is_dbus_thing(thing)))

897

1306

898

def _get_dbus_property(self, interface_name, property_name):

1307

899

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

1308

900

property with the specified name and interface.

1309

901

"""

1310

for cls in self.__class__.__mro__:

1311

for name, value in inspect.getmembers(

1312

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

902

for cls in self.__class__.__mro__:

903

for name, value in (inspect.getmembers

904

(cls,

905

self._is_dbus_thing("property"))):

1313

906

if (value._dbus_name == property_name

1314

907

and value._dbus_interface == interface_name):

1315

908

return value.__get__(self)

1316

909

1317

910

# No such property

1318

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

1319

self.dbus_object_path, interface_name, property_name))

1320

1321

@classmethod

1322

def _get_all_interface_names(cls):

1323

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

1324

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

1325

"_dbus_interface", None)

1326

for x in (inspect.getmro(cls))

1327

for attr in dir(x))

1328

if name is not None)

1329

1330

@dbus.service.method(dbus.PROPERTIES_IFACE,

1331

in_signature="ss",

911

raise DBusPropertyNotFound(self.dbus_object_path + ":"

912

+ interface_name + "."

913

+ property_name)

914

915

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

1332

916

out_signature="v")

1333

917

def Get(self, interface_name, property_name):

1334

918

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

1340

924

if not hasattr(value, "variant_level"):

1341

925

return value

1342

926

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

1343

927

1344

928

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

1345

929

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

1346

930

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

1353

937

# signatures other than "ay".

1354

938

if prop._dbus_signature != "ay":

1355

939

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

1356

"'ay' signature {!r}"

940

"'ay' signature {0!r}"

1357

941

.format(prop._dbus_signature))

1358

942

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

1359

943

for byte in value))

1360

944

prop(value)

1361

1362

@dbus.service.method(dbus.PROPERTIES_IFACE,

1363

in_signature="s",

945

946

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

1364

947

out_signature="a{sv}")

1365

948

def GetAll(self, interface_name):

1366

949

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

1367

950

standard.

1368

951

1369

952

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

1370

953

"""

1371

954

properties = {}

1381

964

if not hasattr(value, "variant_level"):

1382

965

properties[name] = value

1383

966

continue

1384

properties[name] = type(value)(

1385

value, variant_level=value.variant_level + 1)

967

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

968

value.variant_level+1)

1386

969

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

1387

1388

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

1389

def PropertiesChanged(self, interface_name, changed_properties,

1390

invalidated_properties):

1391

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

1392

standard.

1393

"""

1394

pass

1395

970

1396

971

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1397

972

out_signature="s",

1398

973

path_keyword='object_path',

1399

974

connection_keyword='connection')

1400

975

def Introspect(self, object_path, connection):

1401

976

"""Overloading of standard D-Bus method.

1402

977

1403

978

Inserts property tags and interface annotation tags.

1404

979

"""

1405

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1406

object_path,

1407

connection)

980

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

981

connection)

1408

982

try:

1409

983

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

1410

1411

984

def make_tag(document, name, prop):

1412

985

e = document.createElement("property")

1413

986

e.setAttribute("name", name)

1414

987

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

1415

988

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

1416

989

return e

1417

1418

990

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

1419

991

# Add property tags

1420

992

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

1423

995

if prop._dbus_interface

1424

996

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

1425

997

if_tag.appendChild(tag)

1426

# Add annotation tags for properties

1427

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

1428

annots = dict()

1429

for name, prop in self._get_all_dbus_things(

1430

"property"):

1431

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

1432

and prop._dbus_interface

1433

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

1434

annots.update(getattr(

1435

prop, "_dbus_annotations", {}))

1436

for name, value in annots.items():

1437

ann_tag = document.createElement(

1438

"annotation")

1439

ann_tag.setAttribute("name", name)

1440

ann_tag.setAttribute("value", value)

1441

tag.appendChild(ann_tag)

998

# Add annotation tags

999

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

1000

for tag in if_tag.getElementsByTagName(typ):

1001

annots = dict()

1002

for name, prop in (self.

1003

_get_all_dbus_things(typ)):

1004

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

1005

and prop._dbus_interface

1006

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

1007

annots.update(getattr

1008

(prop,

1009

"_dbus_annotations",

1010

{}))

1011

for name, value in annots.iteritems():

1012

ann_tag = document.createElement(

1013

"annotation")

1014

ann_tag.setAttribute("name", name)

1015

ann_tag.setAttribute("value", value)

1016

tag.appendChild(ann_tag)

1017

# Add interface annotation tags

1018

for annotation, value in dict(

1019

itertools.chain.from_iterable(

1020

annotations().iteritems()

1021

for name, annotations in

1022

self._get_all_dbus_things("interface")

1023

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

1024

)).iteritems():

1025

ann_tag = document.createElement("annotation")

1026

ann_tag.setAttribute("name", annotation)

1027

ann_tag.setAttribute("value", value)

1028

if_tag.appendChild(ann_tag)

1442

1029

# Add the names to the return values for the

1443

1030

# "org.freedesktop.DBus.Properties" methods

1444

1031

if (if_tag.getAttribute("name")

1463

1050

return xmlstring

1464

1051

1465

1052

1466

try:

1467

dbus.OBJECT_MANAGER_IFACE

1468

except AttributeError:

1469

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

1470

1471

1472

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1473

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

1474

1475

Classes inheriting from this exposes the standard

1476

GetManagedObjects call and the InterfacesAdded and

1477

InterfacesRemoved signals on the standard

1478

"org.freedesktop.DBus.ObjectManager" interface.

1479

1480

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

1481

manually.

1482

"""

1483

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1484

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

1485

def GetManagedObjects(self):

1486

"""This function must be overridden"""

1487

raise NotImplementedError()

1488

1489

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1490

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

1491

def InterfacesAdded(self, object_path, interfaces_and_properties):

1492

pass

1493

1494

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

1495

def InterfacesRemoved(self, object_path, interfaces):

1496

pass

1497

1498

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1499

out_signature="s",

1500

path_keyword='object_path',

1501

connection_keyword='connection')

1502

def Introspect(self, object_path, connection):

1503

"""Overloading of standard D-Bus method.

1504

1505

Override return argument name of GetManagedObjects to be

1506

"objpath_interfaces_and_properties"

1507

"""

1508

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1509

object_path,

1510

connection)

1511

try:

1512

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

1513

1514

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

1515

# Fix argument name for the GetManagedObjects method

1516

if (if_tag.getAttribute("name")

1517

== dbus.OBJECT_MANAGER_IFACE):

1518

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

1519

if (cn.getAttribute("name")

1520

== "GetManagedObjects"):

1521

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

1522

if (arg.getAttribute("direction")

1523

== "out"):

1524

arg.setAttribute(

1525

"name",

1526

"objpath_interfaces"

1527

"_and_properties")

1528

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

1529

document.unlink()

1530

except (AttributeError, xml.dom.DOMException,

1531

xml.parsers.expat.ExpatError) as error:

1532

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

1533

exc_info=error)

1534

return xmlstring

1535

1536

1537

1053

def datetime_to_dbus(dt, variant_level=0):

1538

1054

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

1539

1055

if dt is None:

1540

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

1541

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

1056

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

1057

return dbus.String(dt.isoformat(),

1058

variant_level=variant_level)

1542

1059

1543

1060

1544

1061

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1546

1063

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

1547

1064

interface names according to the "alt_interface_names" mapping.

1548

1065

Usage:

1549

1066

1550

1067

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

1551

1068

"net.example.AlternateInterface"})

1552

1069

class SampleDBusObject(dbus.service.Object):

1553

1070

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

1554

1071

def SampleDBusMethod():

1555

1072

pass

1556

1073

1557

1074

The above "SampleDBusMethod" on "SampleDBusObject" will be

1558

1075

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

1559

1076

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

1560

1077

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

1561

1078

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

1562

1079

1563

1080

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

1564

1081

(from DBusObjectWithProperties) and interfaces (from the

1565

1082

dbus_interface_annotations decorator).

1566

1083

"""

1567

1568

1084

def wrapper(cls):

1569

1085

for orig_interface_name, alt_interface_name in (

1570

alt_interface_names.items()):

1086

alt_interface_names.iteritems()):

1571

1087

attr = {}

1572

1088

interface_names = set()

1573

1089

# Go though all attributes of the class

1575

1091

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

1576

1092

# with the wrong interface name

1577

1093

if (not hasattr(attribute, "_dbus_interface")

1578

or not attribute._dbus_interface.startswith(

1579

orig_interface_name)):

1094

or not attribute._dbus_interface

1095

.startswith(orig_interface_name)):

1580

1096

continue

1581

1097

# Create an alternate D-Bus interface name based on

1582

1098

# the current name

1583

alt_interface = attribute._dbus_interface.replace(

1584

orig_interface_name, alt_interface_name)

1099

alt_interface = (attribute._dbus_interface

1100

.replace(orig_interface_name,

1101

alt_interface_name))

1585

1102

interface_names.add(alt_interface)

1586

1103

# Is this a D-Bus signal?

1587

1104

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

1588

1105

# Extract the original non-method undecorated

1589

1106

# function by black magic

1590

if sys.version_info.major == 2:

1591

nonmethod_func = (dict(

1107

nonmethod_func = (dict(

1592

1108

zip(attribute.func_code.co_freevars,

1593

attribute.__closure__))

1594

["func"].cell_contents)

1595

else:

1596

nonmethod_func = (dict(

1597

zip(attribute.__code__.co_freevars,

1598

attribute.__closure__))

1599

["func"].cell_contents)

1109

attribute.__closure__))["func"]

1110

.cell_contents)

1600

1111

# Create a new, but exactly alike, function

1601

1112

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

1602

1113

# with the alternate D-Bus interface name

1603

new_function = copy_function(nonmethod_func)

1604

new_function = (dbus.service.signal(

1605

alt_interface,

1606

attribute._dbus_signature)(new_function))

1114

new_function = (dbus.service.signal

1115

(alt_interface,

1116

attribute._dbus_signature)

1117

(types.FunctionType(

1118

nonmethod_func.func_code,

1119

nonmethod_func.func_globals,

1120

nonmethod_func.func_name,

1121

nonmethod_func.func_defaults,

1122

nonmethod_func.func_closure)))

1607

1123

# Copy annotations, if any

1608

1124

try:

1609

new_function._dbus_annotations = dict(

1610

attribute._dbus_annotations)

1125

new_function._dbus_annotations = (

1126

dict(attribute._dbus_annotations))

1611

1127

except AttributeError:

1612

1128

pass

1613

1614

1129

# Define a creator of a function to call both the

1615

1130

# original and alternate functions, so both the

1616

1131

# original and alternate signals gets sent when

1619

1134

"""This function is a scope container to pass

1620

1135

func1 and func2 to the "call_both" function

1621

1136

outside of its arguments"""

1622

1623

@functools.wraps(func2)

1624

1137

def call_both(*args, **kwargs):

1625

1138

"""This function will emit two D-Bus

1626

1139

signals by calling func1 and func2"""

1627

1140

func1(*args, **kwargs)

1628

1141

func2(*args, **kwargs)

1629

# Make wrapper function look like a D-Bus

1630

# signal

1631

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

1632

if name.startswith("_dbus_"):

1633

setattr(call_both, name, attr)

1634

1635

1142

return call_both

1636

1143

# Create the "call_both" function and add it to

1637

1144

# the class

1642

1149

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

1643

1150

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

1644

1151

# to the class.

1645

attr[attrname] = (

1646

dbus.service.method(

1647

alt_interface,

1648

attribute._dbus_in_signature,

1649

attribute._dbus_out_signature)

1650

(copy_function(attribute)))

1152

attr[attrname] = (dbus.service.method

1153

(alt_interface,

1154

attribute._dbus_in_signature,

1155

attribute._dbus_out_signature)

1156

(types.FunctionType

1157

(attribute.func_code,

1158

attribute.func_globals,

1159

attribute.func_name,

1160

attribute.func_defaults,

1161

attribute.func_closure)))

1651

1162

# Copy annotations, if any

1652

1163

try:

1653

attr[attrname]._dbus_annotations = dict(

1654

attribute._dbus_annotations)

1164

attr[attrname]._dbus_annotations = (

1165

dict(attribute._dbus_annotations))

1655

1166

except AttributeError:

1656

1167

pass

1657

1168

# Is this a D-Bus property?

1660

1171

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

1661

1172

# property with the alternate D-Bus interface

1662

1173

# name. Add it to the class.

1663

attr[attrname] = (dbus_service_property(

1664

alt_interface, attribute._dbus_signature,

1665

attribute._dbus_access,

1666

attribute._dbus_get_args_options

1667

["byte_arrays"])

1668

(copy_function(attribute)))

1174

attr[attrname] = (dbus_service_property

1175

(alt_interface,

1176

attribute._dbus_signature,

1177

attribute._dbus_access,

1178

attribute

1179

._dbus_get_args_options

1180

["byte_arrays"])

1181

(types.FunctionType

1182

(attribute.func_code,

1183

attribute.func_globals,

1184

attribute.func_name,

1185

attribute.func_defaults,

1186

attribute.func_closure)))

1669

1187

# Copy annotations, if any

1670

1188

try:

1671

attr[attrname]._dbus_annotations = dict(

1672

attribute._dbus_annotations)

1189

attr[attrname]._dbus_annotations = (

1190

dict(attribute._dbus_annotations))

1673

1191

except AttributeError:

1674

1192

pass

1675

1193

# Is this a D-Bus interface?

1678

1196

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

1679

1197

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

1680

1198

# to the class.

1681

attr[attrname] = (

1682

dbus_interface_annotations(alt_interface)

1683

(copy_function(attribute)))

1199

attr[attrname] = (dbus_interface_annotations

1200

(alt_interface)

1201

(types.FunctionType

1202

(attribute.func_code,

1203

attribute.func_globals,

1204

attribute.func_name,

1205

attribute.func_defaults,

1206

attribute.func_closure)))

1684

1207

if deprecate:

1685

1208

# Deprecate all alternate interfaces

1686

iname = "_AlternateDBusNames_interface_annotation{}"

1209

iname="_AlternateDBusNames_interface_annotation{0}"

1687

1210

for interface_name in interface_names:

1688

1689

1211

@dbus_interface_annotations(interface_name)

1690

1212

def func(self):

1691

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

1692

"true"}

1213

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

1214

"true" }

1693

1215

# Find an unused name

1694

1216

for aname in (iname.format(i)

1695

1217

for i in itertools.count()):

1699

1221

if interface_names:

1700

1222

# Replace the class with a new subclass of it with

1701

1223

# methods, signals, etc. as created above.

1702

if sys.version_info.major == 2:

1703

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

1704

(cls, ), attr)

1705

else:

1706

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

1707

(cls, ), attr)

1224

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

1225

(cls,), attr)

1708

1226

return cls

1709

1710

1227

return wrapper

1711

1228

1712

1229

1713

1230

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

1714

"se.bsnet.fukt.Mandos"})

1231

"se.bsnet.fukt.Mandos"})

1715

1232

class ClientDBus(Client, DBusObjectWithProperties):

1716

1233

"""A Client class using D-Bus

1717

1234

1718

1235

Attributes:

1719

1236

dbus_object_path: dbus.ObjectPath

1720

1237

bus: dbus.SystemBus()

1721

1238

"""

1722

1239

1723

1240

runtime_expansions = (Client.runtime_expansions

1724

+ ("dbus_object_path", ))

1725

1726

_interface = "se.recompile.Mandos.Client"

1727

1241

+ ("dbus_object_path",))

1242

1728

1243

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

1729

1730

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

1244

1245

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

1731

1246

self.bus = bus

1732

1247

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

1733

1248

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

1734

1249

# the D-Bus

1735

client_object_name = str(self.name).translate(

1250

client_object_name = unicode(self.name).translate(

1736

1251

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

1737

1252

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

1738

self.dbus_object_path = dbus.ObjectPath(

1739

"/clients/" + client_object_name)

1253

self.dbus_object_path = (dbus.ObjectPath

1254

("/clients/" + client_object_name))

1740

1255

DBusObjectWithProperties.__init__(self, self.bus,

1741

1256

self.dbus_object_path)

1742

1743

def notifychangeproperty(transform_func, dbus_name,

1744

type_func=lambda x: x,

1745

variant_level=1,

1746

invalidate_only=False,

1747

_interface=_interface):

1257

1258

def notifychangeproperty(transform_func,

1259

dbus_name, type_func=lambda x: x,

1260

variant_level=1):

1748

1261

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

1749

1262

its changes to DBus.

1750

1263

1751

1264

transform_fun: Function that takes a value and a variant_level

1752

1265

and transforms it to a D-Bus type.

1753

1266

dbus_name: D-Bus name of the variable

1755

1268

to the D-Bus. Default: no transform

1756

1269

variant_level: D-Bus variant level. Default: 1

1757

1270

"""

1758

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

1759

1271

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

1760

1272

def setter(self, value):

1761

1273

if hasattr(self, "dbus_object_path"):

1762

1274

if (not hasattr(self, attrname) or

1763

1275

type_func(getattr(self, attrname, None))

1764

1276

!= type_func(value)):

1765

if invalidate_only:

1766

self.PropertiesChanged(

1767

_interface, dbus.Dictionary(),

1768

dbus.Array((dbus_name, )))

1769

else:

1770

dbus_value = transform_func(

1771

type_func(value),

1772

variant_level=variant_level)

1773

self.PropertyChanged(dbus.String(dbus_name),

1774

dbus_value)

1775

self.PropertiesChanged(

1776

_interface,

1777

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

1778

dbus_value}),

1779

dbus.Array())

1277

dbus_value = transform_func(type_func(value),

1278

variant_level

1279

=variant_level)

1280

self.PropertyChanged(dbus.String(dbus_name),

1281

dbus_value)

1780

1282

setattr(self, attrname, value)

1781

1283

1782

1284

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

1783

1285

1784

1286

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1785

1287

approvals_pending = notifychangeproperty(dbus.Boolean,

1786

1288

"ApprovalPending",

1787

type_func=bool)

1289

type_func = bool)

1788

1290

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

1789

1291

last_enabled = notifychangeproperty(datetime_to_dbus,

1790

1292

"LastEnabled")

1791

checker = notifychangeproperty(

1792

dbus.Boolean, "CheckerRunning",

1793

type_func=lambda checker: checker is not None)

1293

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

1294

type_func = lambda checker:

1295

checker is not None)

1794

1296

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1795

1297

"LastCheckedOK")

1796

1298

last_checker_status = notifychangeproperty(dbus.Int16,

1799

1301

datetime_to_dbus, "LastApprovalRequest")

1800

1302

approved_by_default = notifychangeproperty(dbus.Boolean,

1801

1303

"ApprovedByDefault")

1802

approval_delay = notifychangeproperty(

1803

dbus.UInt64, "ApprovalDelay",

1804

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

1304

approval_delay = notifychangeproperty(dbus.UInt64,

1305

"ApprovalDelay",

1306

type_func =

1307

timedelta_to_milliseconds)

1805

1308

approval_duration = notifychangeproperty(

1806

1309

dbus.UInt64, "ApprovalDuration",

1807

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

1310

type_func = timedelta_to_milliseconds)

1808

1311

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

1809

timeout = notifychangeproperty(

1810

dbus.UInt64, "Timeout",

1811

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

1312

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

1313

type_func =

1314

timedelta_to_milliseconds)

1812

1315

extended_timeout = notifychangeproperty(

1813

1316

dbus.UInt64, "ExtendedTimeout",

1814

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

1815

interval = notifychangeproperty(

1816

dbus.UInt64, "Interval",

1817

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

1317

type_func = timedelta_to_milliseconds)

1318

interval = notifychangeproperty(dbus.UInt64,

1319

"Interval",

1320

type_func =

1321

timedelta_to_milliseconds)

1818

1322

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

1819

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

1820

invalidate_only=True)

1821

1323

1822

1324

del notifychangeproperty

1823

1325

1824

1326

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

1825

1327

try:

1826

1328

self.remove_from_connection()

1829

1331

if hasattr(DBusObjectWithProperties, "__del__"):

1830

1332

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

1831

1333

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

1832

1833

def checker_callback(self, source, condition,

1834

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

1835

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

1836

connection, command, *args,

1837

**kwargs)

1838

exitstatus = self.last_checker_status

1839

if exitstatus >= 0:

1334

1335

def checker_callback(self, pid, condition, command,

1336

*args, **kwargs):

1337

self.checker_callback_tag = None

1338

self.checker = None

1339

if os.WIFEXITED(condition):

1340

exitstatus = os.WEXITSTATUS(condition)

1840

1341

# Emit D-Bus signal

1841

1342

self.CheckerCompleted(dbus.Int16(exitstatus),

1842

# This is specific to GNU libC

1843

dbus.Int64(exitstatus << 8),

1343

dbus.Int64(condition),

1844

1344

dbus.String(command))

1845

1345

else:

1846

1346

# Emit D-Bus signal

1847

1347

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

1848

dbus.Int64(

1849

# This is specific to GNU libC

1850

(exitstatus << 8)

1851

| self.last_checker_signal),

1348

dbus.Int64(condition),

1852

1349

dbus.String(command))

1853

return ret

1854

1350

1351

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

1352

*args, **kwargs)

1353

1855

1354

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

1856

1355

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

1857

1356

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

1861

1360

# Emit D-Bus signal

1862

1361

self.CheckerStarted(self.current_checker_command)

1863

1362

return r

1864

1363

1865

1364

def _reset_approved(self):

1866

1365

self.approved = None

1867

1366

return False

1868

1367

1869

1368

def approve(self, value=True):

1870

1369

self.approved = value

1871

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

1872

* 1000), self._reset_approved)

1370

gobject.timeout_add(timedelta_to_milliseconds

1371

(self.approval_duration),

1372

self._reset_approved)

1873

1373

self.send_changedstate()

1874

1875

# D-Bus methods, signals & properties

1876

1877

# Interfaces

1878

1879

# Signals

1880

1374

1375

## D-Bus methods, signals & properties

1376

_interface = "se.recompile.Mandos.Client"

1377

1378

## Interfaces

1379

1380

@dbus_interface_annotations(_interface)

1381

def _foo(self):

1382

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

1383

"false"}

1384

1385

## Signals

1386

1881

1387

# CheckerCompleted - signal

1882

1388

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

1883

1389

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

1884

1390

"D-Bus signal"

1885

1391

pass

1886

1392

1887

1393

# CheckerStarted - signal

1888

1394

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

1889

1395

def CheckerStarted(self, command):

1890

1396

"D-Bus signal"

1891

1397

pass

1892

1398

1893

1399

# PropertyChanged - signal

1894

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

1895

1400

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

1896

1401

def PropertyChanged(self, property, value):

1897

1402

"D-Bus signal"

1898

1403

pass

1899

1404

1900

1405

# GotSecret - signal

1901

1406

@dbus.service.signal(_interface)

1902

1407

def GotSecret(self):

1905

1410

server to mandos-client

1906

1411

"""

1907

1412

pass

1908

1413

1909

1414

# Rejected - signal

1910

1415

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

1911

1416

def Rejected(self, reason):

1912

1417

"D-Bus signal"

1913

1418

pass

1914

1419

1915

1420

# NeedApproval - signal

1916

1421

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

1917

1422

def NeedApproval(self, timeout, default):

1918

1423

"D-Bus signal"

1919

1424

return self.need_approval()

1920

1921

# Methods

1922

1425

1426

## Methods

1427

1923

1428

# Approve - method

1924

1429

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

1925

1430

def Approve(self, value):

1926

1431

self.approve(value)

1927

1432

1928

1433

# CheckedOK - method

1929

1434

@dbus.service.method(_interface)

1930

1435

def CheckedOK(self):

1931

1436

self.checked_ok()

1932

1437

1933

1438

# Enable - method

1934

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

1935

1439

@dbus.service.method(_interface)

1936

1440

def Enable(self):

1937

1441

"D-Bus method"

1938

1442

self.enable()

1939

1443

1940

1444

# StartChecker - method

1941

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

1942

1445

@dbus.service.method(_interface)

1943

1446

def StartChecker(self):

1944

1447

"D-Bus method"

1945

1448

self.start_checker()

1946

1449

1947

1450

# Disable - method

1948

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

1949

1451

@dbus.service.method(_interface)

1950

1452

def Disable(self):

1951

1453

"D-Bus method"

1952

1454

self.disable()

1953

1455

1954

1456

# StopChecker - method

1955

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

1956

1457

@dbus.service.method(_interface)

1957

1458

def StopChecker(self):

1958

1459

self.stop_checker()

1959

1960

# Properties

1961

1460

1461

## Properties

1462

1962

1463

# ApprovalPending - property

1963

1464

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

1964

1465

def ApprovalPending_dbus_property(self):

1965

1466

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

1966

1467

1967

1468

# ApprovedByDefault - property

1968

@dbus_service_property(_interface,

1969

signature="b",

1469

@dbus_service_property(_interface, signature="b",

1970

1470

access="readwrite")

1971

1471

def ApprovedByDefault_dbus_property(self, value=None):

1972

1472

if value is None: # get

1973

1473

return dbus.Boolean(self.approved_by_default)

1974

1474

self.approved_by_default = bool(value)

1975

1475

1976

1476

# ApprovalDelay - property

1977

@dbus_service_property(_interface,

1978

signature="t",

1477

@dbus_service_property(_interface, signature="t",

1979

1478

access="readwrite")

1980

1479

def ApprovalDelay_dbus_property(self, value=None):

1981

1480

if value is None: # get

1982

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

1983

* 1000)

1481

return dbus.UInt64(self.approval_delay_milliseconds())

1984

1482

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

1985

1483

1986

1484

# ApprovalDuration - property

1987

@dbus_service_property(_interface,

1988

signature="t",

1485

@dbus_service_property(_interface, signature="t",

1989

1486

access="readwrite")

1990

1487

def ApprovalDuration_dbus_property(self, value=None):

1991

1488

if value is None: # get

1992

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

1993

* 1000)

1489

return dbus.UInt64(timedelta_to_milliseconds(

1490

self.approval_duration))

1994

1491

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

1995

1492

1996

1493

# Name - property

1997

@dbus_annotations(

1998

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

1999

1494

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

2000

1495

def Name_dbus_property(self):

2001

1496

return dbus.String(self.name)

2002

1497

2003

1498

# Fingerprint - property

2004

@dbus_annotations(

2005

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

2006

1499

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

2007

1500

def Fingerprint_dbus_property(self):

2008

1501

return dbus.String(self.fingerprint)

2009

1502

2010

1503

# Host - property

2011

@dbus_service_property(_interface,

2012

signature="s",

1504

@dbus_service_property(_interface, signature="s",

2013

1505

access="readwrite")

2014

1506

def Host_dbus_property(self, value=None):

2015

1507

if value is None: # get

2016

1508

return dbus.String(self.host)

2017

self.host = str(value)

2018

1509

self.host = unicode(value)

1510

2019

1511

# Created - property

2020

@dbus_annotations(

2021

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

2022

1512

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

2023

1513

def Created_dbus_property(self):

2024

1514

return datetime_to_dbus(self.created)

2025

1515

2026

1516

# LastEnabled - property

2027

1517

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

2028

1518

def LastEnabled_dbus_property(self):

2029

1519

return datetime_to_dbus(self.last_enabled)

2030

1520

2031

1521

# Enabled - property

2032

@dbus_service_property(_interface,

2033

signature="b",

1522

@dbus_service_property(_interface, signature="b",

2034

1523

access="readwrite")

2035

1524

def Enabled_dbus_property(self, value=None):

2036

1525

if value is None: # get

2039

1528

self.enable()

2040

1529

else:

2041

1530

self.disable()

2042

1531

2043

1532

# LastCheckedOK - property

2044

@dbus_service_property(_interface,

2045

signature="s",

1533

@dbus_service_property(_interface, signature="s",

2046

1534

access="readwrite")

2047

1535

def LastCheckedOK_dbus_property(self, value=None):

2048

1536

if value is not None:

2049

1537

self.checked_ok()

2050

1538

return

2051

1539

return datetime_to_dbus(self.last_checked_ok)

2052

1540

2053

1541

# LastCheckerStatus - property

2054

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

1542

@dbus_service_property(_interface, signature="n",

1543

access="read")

2055

1544

def LastCheckerStatus_dbus_property(self):

2056

1545

return dbus.Int16(self.last_checker_status)

2057

1546

2058

1547

# Expires - property

2059

1548

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

2060

1549

def Expires_dbus_property(self):

2061

1550

return datetime_to_dbus(self.expires)

2062

1551

2063

1552

# LastApprovalRequest - property

2064

1553

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

2065

1554

def LastApprovalRequest_dbus_property(self):

2066

1555

return datetime_to_dbus(self.last_approval_request)

2067

1556

2068

1557

# Timeout - property

2069

@dbus_service_property(_interface,

2070

signature="t",

1558

@dbus_service_property(_interface, signature="t",

2071

1559

access="readwrite")

2072

1560

def Timeout_dbus_property(self, value=None):

2073

1561

if value is None: # get

2074

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

1562

return dbus.UInt64(self.timeout_milliseconds())

2075

1563

old_timeout = self.timeout

2076

1564

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

2077

1565

# Reschedule disabling

2085

1573

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

2086

1574

is None):

2087

1575

return

2088

GLib.source_remove(self.disable_initiator_tag)

2089

self.disable_initiator_tag = GLib.timeout_add(

2090

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

2091

self.disable)

2092

1576

gobject.source_remove(self.disable_initiator_tag)

1577

self.disable_initiator_tag = (

1578

gobject.timeout_add(

1579

timedelta_to_milliseconds(self.expires - now),

1580

self.disable))

1581

2093

1582

# ExtendedTimeout - property

2094

@dbus_service_property(_interface,

2095

signature="t",

1583

@dbus_service_property(_interface, signature="t",

2096

1584

access="readwrite")

2097

1585

def ExtendedTimeout_dbus_property(self, value=None):

2098

1586

if value is None: # get

2099

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

2100

* 1000)

1587

return dbus.UInt64(self.extended_timeout_milliseconds())

2101

1588

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

2102

1589

2103

1590

# Interval - property

2104

@dbus_service_property(_interface,

2105

signature="t",

1591

@dbus_service_property(_interface, signature="t",

2106

1592

access="readwrite")

2107

1593

def Interval_dbus_property(self, value=None):

2108

1594

if value is None: # get

2109

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

1595

return dbus.UInt64(self.interval_milliseconds())

2110

1596

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

2111

1597

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

2112

1598

return

2113

1599

if self.enabled:

2114

1600

# Reschedule checker run

2115

GLib.source_remove(self.checker_initiator_tag)

2116

self.checker_initiator_tag = GLib.timeout_add(

2117

value, self.start_checker)

2118

self.start_checker() # Start one now, too

2119

1601

gobject.source_remove(self.checker_initiator_tag)

1602

self.checker_initiator_tag = (gobject.timeout_add

1603

(value, self.start_checker))

1604

self.start_checker() # Start one now, too

1605

2120

1606

# Checker - property

2121

@dbus_service_property(_interface,

2122

signature="s",

1607

@dbus_service_property(_interface, signature="s",

2123

1608

access="readwrite")

2124

1609

def Checker_dbus_property(self, value=None):

2125

1610

if value is None: # get

2126

1611

return dbus.String(self.checker_command)

2127

self.checker_command = str(value)

2128

1612

self.checker_command = unicode(value)

1613

2129

1614

# CheckerRunning - property

2130

@dbus_service_property(_interface,

2131

signature="b",

1615

@dbus_service_property(_interface, signature="b",

2132

1616

access="readwrite")

2133

1617

def CheckerRunning_dbus_property(self, value=None):

2134

1618

if value is None: # get

2137

1621

self.start_checker()

2138

1622

else:

2139

1623

self.stop_checker()

2140

1624

2141

1625

# ObjectPath - property

2142

@dbus_annotations(

2143

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

2144

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

2145

1626

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

2146

1627

def ObjectPath_dbus_property(self):

2147

return self.dbus_object_path # is already a dbus.ObjectPath

2148

1628

return self.dbus_object_path # is already a dbus.ObjectPath

1629

2149

1630

# Secret = property

2150

@dbus_annotations(

2151

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

2152

"invalidates"})

2153

@dbus_service_property(_interface,

2154

signature="ay",

2155

access="write",

2156

byte_arrays=True)

1631

@dbus_service_property(_interface, signature="ay",

1632

access="write", byte_arrays=True)

2157

1633

def Secret_dbus_property(self, value):

2158

self.secret = bytes(value)

2159

1634

self.secret = str(value)

1635

2160

1636

del _interface

2161

1637

2162

1638

2165

1641

self._pipe = child_pipe

2166

1642

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

2167

1643

if not self._pipe.recv():

2168

raise KeyError(fpr)

2169

1644

raise KeyError()

1645

2170

1646

def __getattribute__(self, name):

2171

1647

if name == '_pipe':

2172

1648

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

2175

1651

if data[0] == 'data':

2176

1652

return data[1]

2177

1653

if data[0] == 'function':

2178

2179

1654

def func(*args, **kwargs):

2180

1655

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

2181

1656

return self._pipe.recv()[1]

2182

2183

1657

return func

2184

1658

2185

1659

def __setattr__(self, name, value):

2186

1660

if name == '_pipe':

2187

1661

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

2190

1664

2191

1665

class ClientHandler(socketserver.BaseRequestHandler, object):

2192

1666

"""A class to handle client connections.

2193

1667

2194

1668

Instantiated once for each connection to handle it.

2195

1669

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

2196

1670

2197

1671

def handle(self):

2198

1672

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

2199

1673

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

2200

str(self.client_address))

1674

unicode(self.client_address))

2201

1675

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

2202

1676

self.server.child_pipe.fileno())

2203

2204

session = gnutls.ClientSession(self.request)

2205

2206

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

2207

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

2208

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

2209

# "+DHE-DSS"))

1677

1678

session = (gnutls.connection

1679

.ClientSession(self.request,

1680

gnutls.connection

1681

.X509Credentials()))

1682

1683

# Note: gnutls.connection.X509Credentials is really a

1684

# generic GnuTLS certificate credentials object so long as

1685

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

1686

# here despite using OpenPGP certificates.

1687

1688

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

1689

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

1690

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

1691

# "+DHE-DSS"))

2210

1692

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

2211

1693

priority = self.server.gnutls_priority

2212

1694

if priority is None:

2213

1695

priority = "NORMAL"

2214

gnutls.priority_set_direct(session._c_object,

2215

priority.encode("utf-8"),

2216

None)

2217

1696

(gnutls.library.functions

1697

.gnutls_priority_set_direct(session._c_object,

1698

priority, None))

1699

2218

1700

# Start communication using the Mandos protocol

2219

1701

# Get protocol number

2220

1702

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

2225

1707

except (ValueError, IndexError, RuntimeError) as error:

2226

1708

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

2227

1709

return

2228

1710

2229

1711

# Start GnuTLS connection

2230

1712

try:

2231

1713

session.handshake()

2232

except gnutls.Error as error:

1714

except gnutls.errors.GNUTLSError as error:

2233

1715

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

2234

1716

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

2235

1717

# established. Just abandon the request.

2236

1718

return

2237

1719

logger.debug("Handshake succeeded")

2238

1720

2239

1721

approval_required = False

2240

1722

try:

2241

1723

try:

2242

fpr = self.fingerprint(

2243

self.peer_certificate(session))

2244

except (TypeError, gnutls.Error) as error:

1724

fpr = self.fingerprint(self.peer_certificate

1725

(session))

1726

except (TypeError,

1727

gnutls.errors.GNUTLSError) as error:

2245

1728

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

2246

1729

return

2247

1730

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

2248

1731

2249

1732

try:

2250

1733

client = ProxyClient(child_pipe, fpr,

2251

1734

self.client_address)

2252

1735

except KeyError:

2253

1736

return

2254

1737

2255

1738

if client.approval_delay:

2256

1739

delay = client.approval_delay

2257

1740

client.approvals_pending += 1

2258

1741

approval_required = True

2259

1742

2260

1743

while True:

2261

1744

if not client.enabled:

2262

1745

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

2263

client.name)

1746

client.name)

2264

1747

if self.server.use_dbus:

2265

1748

# Emit D-Bus signal

2266

1749

client.Rejected("Disabled")

2267

1750

return

2268

1751

2269

1752

if client.approved or not client.approval_delay:

2270

# We are approved or approval is disabled

1753

#We are approved or approval is disabled

2271

1754

break

2272

1755

elif client.approved is None:

2273

1756

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

2275

1758

if self.server.use_dbus:

2276

1759

# Emit D-Bus signal

2277

1760

client.NeedApproval(

2278

client.approval_delay.total_seconds()

2279

* 1000, client.approved_by_default)

1761

client.approval_delay_milliseconds(),

1762

client.approved_by_default)

2280

1763

else:

2281

1764

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

2282

1765

client.name)

2284

1767

# Emit D-Bus signal

2285

1768

client.Rejected("Denied")

2286

1769

return

2287

2288

# wait until timeout or approved

1770

1771

#wait until timeout or approved

2289

1772

time = datetime.datetime.now()

2290

1773

client.changedstate.acquire()

2291

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

1774

client.changedstate.wait(

1775

float(timedelta_to_milliseconds(delay)

1776

/ 1000))

2292

1777

client.changedstate.release()

2293

1778

time2 = datetime.datetime.now()

2294

1779

if (time2 - time) >= delay:

2304

1789

break

2305

1790

else:

2306

1791

delay -= time2 - time

2307

2308

try:

2309

session.send(client.secret)

2310

except gnutls.Error as error:

2311

logger.warning("gnutls send failed",

2312

exc_info=error)

2313

return

2314

1792

1793

sent_size = 0

1794

while sent_size < len(client.secret):

1795

try:

1796

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

1797

except gnutls.errors.GNUTLSError as error:

1798

logger.warning("gnutls send failed",

1799

exc_info=error)

1800

return

1801

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

1802

sent, len(client.secret)

1803

- (sent_size + sent))

1804

sent_size += sent

1805

2315

1806

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

2316

1807

# bump the timeout using extended_timeout

2317

1808

client.bump_timeout(client.extended_timeout)

2318

1809

if self.server.use_dbus:

2319

1810

# Emit D-Bus signal

2320

1811

client.GotSecret()

2321

1812

2322

1813

finally:

2323

1814

if approval_required:

2324

1815

client.approvals_pending -= 1

2325

1816

try:

2326

1817

session.bye()

2327

except gnutls.Error as error:

1818

except gnutls.errors.GNUTLSError as error:

2328

1819

logger.warning("GnuTLS bye failed",

2329

1820

exc_info=error)

2330

1821

2331

1822

@staticmethod

2332

1823

def peer_certificate(session):

2333

1824

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

2334

1825

# If not an OpenPGP certificate...

2335

if (gnutls.certificate_type_get(session._c_object)

2336

!= gnutls.CRT_OPENPGP):

2337

# ...return invalid data

2338

return b""

1826

if (gnutls.library.functions

1827

.gnutls_certificate_type_get(session._c_object)

1828

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1829

# ...do the normal thing

1830

return session.peer_certificate

2339

1831

list_size = ctypes.c_uint(1)

2340

cert_list = (gnutls.certificate_get_peers

1832

cert_list = (gnutls.library.functions

1833

.gnutls_certificate_get_peers

2341

1834

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

2342

1835

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

2343

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

1836

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

1837

" certificate")

2344

1838

if list_size.value == 0:

2345

1839

return None

2346

1840

cert = cert_list[0]

2347

1841

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

2348

1842

2349

1843

@staticmethod

2350

1844

def fingerprint(openpgp):

2351

1845

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2352

1846

# New GnuTLS "datum" with the OpenPGP public key

2353

datum = gnutls.datum_t(

2354

ctypes.cast(ctypes.c_char_p(openpgp),

2355

ctypes.POINTER(ctypes.c_ubyte)),

2356

ctypes.c_uint(len(openpgp)))

1847

datum = (gnutls.library.types

1848

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

1849

ctypes.POINTER

1850

(ctypes.c_ubyte)),

1851

ctypes.c_uint(len(openpgp))))

2357

1852

# New empty GnuTLS certificate

2358

crt = gnutls.openpgp_crt_t()

2359

gnutls.openpgp_crt_init(ctypes.byref(crt))

1853

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1854

(gnutls.library.functions

1855

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2360

1856

# Import the OpenPGP public key into the certificate

2361

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

2362

gnutls.OPENPGP_FMT_RAW)

1857

(gnutls.library.functions

1858

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

1859

gnutls.library.constants

1860

.GNUTLS_OPENPGP_FMT_RAW))

2363

1861

# Verify the self signature in the key

2364

1862

crtverify = ctypes.c_uint()

2365

gnutls.openpgp_crt_verify_self(crt, 0,

2366

ctypes.byref(crtverify))

1863

(gnutls.library.functions

1864

.gnutls_openpgp_crt_verify_self(crt, 0,

1865

ctypes.byref(crtverify)))

2367

1866

if crtverify.value != 0:

2368

gnutls.openpgp_crt_deinit(crt)

2369

raise gnutls.CertificateSecurityError("Verify failed")

1867

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1868

raise (gnutls.errors.CertificateSecurityError

1869

("Verify failed"))

2370

1870

# New buffer for the fingerprint

2371

1871

buf = ctypes.create_string_buffer(20)

2372

1872

buf_len = ctypes.c_size_t()

2373

1873

# Get the fingerprint from the certificate into the buffer

2374

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

2375

ctypes.byref(buf_len))

1874

(gnutls.library.functions

1875

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

1876

ctypes.byref(buf_len)))

2376

1877

# Deinit the certificate

2377

gnutls.openpgp_crt_deinit(crt)

1878

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2378

1879

# Convert the buffer to a Python bytestring

2379

1880

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

2380

1881

# Convert the bytestring to hexadecimal notation

2384

1885

2385

1886

class MultiprocessingMixIn(object):

2386

1887

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

2387

2388

1888

def sub_process_main(self, request, address):

2389

1889

try:

2390

1890

self.finish_request(request, address)

2391

1891

except Exception:

2392

1892

self.handle_error(request, address)

2393

1893

self.close_request(request)

2394

1894

2395

1895

def process_request(self, request, address):

2396

1896

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

2397

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

2398

args=(request, address))

1897

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

1898

args = (request, address))

2399

1899

proc.start()

2400

1900

return proc

2401

1901

2402

1902

2403

1903

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2404

1904

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

2405

2406

1905

def process_request(self, request, client_address):

2407

1906

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

2408

1907

2409

1908

This function creates a new pipe in self.pipe

2410

1909

"""

2411

1910

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2412

1911

2413

1912

proc = MultiprocessingMixIn.process_request(self, request,

2414

1913

client_address)

2415

1914

self.child_pipe.close()

2416

1915

self.add_pipe(parent_pipe, proc)

2417

1916

2418

1917

def add_pipe(self, parent_pipe, proc):

2419

1918

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

2420

1919

raise NotImplementedError()

2423

1922

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2424

1923

socketserver.TCPServer, object):

2425

1924

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

2426

1925

2427

1926

Attributes:

2428

1927

enabled: Boolean; whether this server is activated yet

2429

1928

interface: None or a network interface name (string)

2430

1929

use_ipv6: Boolean; to use IPv6 or not

2431

1930

"""

2432

2433

1931

def __init__(self, server_address, RequestHandlerClass,

2434

interface=None,

2435

use_ipv6=True,

2436

socketfd=None):

1932

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

2437

1933

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

2438

1934

creating a new one with socket.socket().

2439

1935

"""

2445

1941

self.socketfd = socketfd

2446

1942

# Save the original socket.socket() function

2447

1943

self.socket_socket = socket.socket

2448

2449

1944

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

2450

#

1945

#

2451

1946

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

2452

1947

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

2453

1948

# patching socket.socket.)

2454

#

1949

#

2455

1950

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

2456

1951

@functools.wraps(socket.socket)

2457

1952

def socket_wrapper(*args, **kwargs):

2469

1964

# socket_wrapper(), if socketfd was set.

2470

1965

socketserver.TCPServer.__init__(self, server_address,

2471

1966

RequestHandlerClass)

2472

1967

2473

1968

def server_bind(self):

2474

1969

"""This overrides the normal server_bind() function

2475

1970

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

2476

1971

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

2477

global SO_BINDTODEVICE

2478

1972

if self.interface is not None:

2479

1973

if SO_BINDTODEVICE is None:

2480

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

2481

# common enough.

2482

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

2483

SO_BINDTODEVICE = 25

2484

try:

2485

self.socket.setsockopt(

2486

socket.SOL_SOCKET, SO_BINDTODEVICE,

2487

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

2488

except socket.error as error:

2489

if error.errno == errno.EPERM:

2490

logger.error("No permission to bind to"

2491

" interface %s", self.interface)

2492

elif error.errno == errno.ENOPROTOOPT:

2493

logger.error("SO_BINDTODEVICE not available;"

2494

" cannot bind to interface %s",

2495

self.interface)

2496

elif error.errno == errno.ENODEV:

2497

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

2498

" cannot bind", self.interface)

2499

else:

2500

raise

1974

logger.error("SO_BINDTODEVICE does not exist;"

1975

" cannot bind to interface %s",

1976

self.interface)

1977

else:

1978

try:

1979

self.socket.setsockopt(socket.SOL_SOCKET,

1980

SO_BINDTODEVICE,

1981

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

1982

except socket.error as error:

1983

if error.errno == errno.EPERM:

1984

logger.error("No permission to bind to"

1985

" interface %s", self.interface)

1986

elif error.errno == errno.ENOPROTOOPT:

1987

logger.error("SO_BINDTODEVICE not available;"

1988

" cannot bind to interface %s",

1989

self.interface)

1990

elif error.errno == errno.ENODEV:

1991

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

1992

" cannot bind", self.interface)

1993

else:

1994

raise

2501

1995

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

2502

1996

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

2503

1997

if not self.server_address[0]:

2504

1998

if self.address_family == socket.AF_INET6:

2505

any_address = "::" # in6addr_any

1999

any_address = "::" # in6addr_any

2506

2000

else:

2507

any_address = "0.0.0.0" # INADDR_ANY

2001

any_address = "0.0.0.0" # INADDR_ANY

2508

2002

self.server_address = (any_address,

2509

2003

self.server_address[1])

2510

2004

elif not self.server_address[1]:

2511

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

2005

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

2006

0)

2512

2007

# if self.interface:

2513

2008

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

2514

2009

# 0, # port

2520

2015

2521

2016

class MandosServer(IPv6_TCPServer):

2522

2017

"""Mandos server.

2523

2018

2524

2019

Attributes:

2525

2020

clients: set of Client objects

2526

2021

gnutls_priority GnuTLS priority string

2527

2022

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

2528

2529

Assumes a GLib.MainLoop event loop.

2023

2024

Assumes a gobject.MainLoop event loop.

2530

2025

"""

2531

2532

2026

def __init__(self, server_address, RequestHandlerClass,

2533

interface=None,

2534

use_ipv6=True,

2535

clients=None,

2536

gnutls_priority=None,

2537

use_dbus=True,

2538

socketfd=None):

2027

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

2028

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

2539

2029

self.enabled = False

2540

2030

self.clients = clients

2541

2031

if self.clients is None:

2544

2034

self.gnutls_priority = gnutls_priority

2545

2035

IPv6_TCPServer.__init__(self, server_address,

2546

2036

RequestHandlerClass,

2547

interface=interface,

2548

use_ipv6=use_ipv6,

2549

socketfd=socketfd)

2550

2037

interface = interface,

2038

use_ipv6 = use_ipv6,

2039

socketfd = socketfd)

2551

2040

def server_activate(self):

2552

2041

if self.enabled:

2553

2042

return socketserver.TCPServer.server_activate(self)

2554

2043

2555

2044

def enable(self):

2556

2045

self.enabled = True

2557

2046

2558

2047

def add_pipe(self, parent_pipe, proc):

2559

2048

# Call "handle_ipc" for both data and EOF events

2560

GLib.io_add_watch(

2561

parent_pipe.fileno(),

2562

GLib.IO_IN | GLib.IO_HUP,

2563

functools.partial(self.handle_ipc,

2564

parent_pipe=parent_pipe,

2565

proc=proc))

2566

2567

def handle_ipc(self, source, condition,

2568

parent_pipe=None,

2569

proc=None,

2570

client_object=None):

2049

gobject.io_add_watch(parent_pipe.fileno(),

2050

gobject.IO_IN | gobject.IO_HUP,

2051

functools.partial(self.handle_ipc,

2052

parent_pipe =

2053

parent_pipe,

2054

proc = proc))

2055

2056

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

2057

proc = None, client_object=None):

2571

2058

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

2572

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

2059

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

2573

2060

# Wait for other process to exit

2574

2061

proc.join()

2575

2062

return False

2576

2063

2577

2064

# Read a request from the child

2578

2065

request = parent_pipe.recv()

2579

2066

command = request[0]

2580

2067

2581

2068

if command == 'init':

2582

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

2069

fpr = request[1]

2583

2070

address = request[2]

2584

2585

for c in self.clients.values():

2071

2072

for c in self.clients.itervalues():

2586

2073

if c.fingerprint == fpr:

2587

2074

client = c

2588

2075

break

2595

2082

address[0])

2596

2083

parent_pipe.send(False)

2597

2084

return False

2598

2599

GLib.io_add_watch(

2600

parent_pipe.fileno(),

2601

GLib.IO_IN | GLib.IO_HUP,

2602

functools.partial(self.handle_ipc,

2603

parent_pipe=parent_pipe,

2604

proc=proc,

2605

client_object=client))

2085

2086

gobject.io_add_watch(parent_pipe.fileno(),

2087

gobject.IO_IN | gobject.IO_HUP,

2088

functools.partial(self.handle_ipc,

2089

parent_pipe =

2090

parent_pipe,

2091

proc = proc,

2092

client_object =

2093

client))

2606

2094

parent_pipe.send(True)

2607

2095

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

2608

2096

# same fileno

2611

2099

funcname = request[1]

2612

2100

args = request[2]

2613

2101

kwargs = request[3]

2614

2102

2615

2103

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

2616

2104

funcname)(*args,

2617

**kwargs)))

2618

2105

**kwargs)))

2106

2619

2107

if command == 'getattr':

2620

2108

attrname = request[1]

2621

if isinstance(client_object.__getattribute__(attrname),

2622

collections.Callable):

2623

parent_pipe.send(('function', ))

2109

if callable(client_object.__getattribute__(attrname)):

2110

parent_pipe.send(('function',))

2624

2111

else:

2625

parent_pipe.send((

2626

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

2627

2112

parent_pipe.send(('data', client_object

2113

.__getattribute__(attrname)))

2114

2628

2115

if command == 'setattr':

2629

2116

attrname = request[1]

2630

2117

value = request[2]

2631

2118

setattr(client_object, attrname, value)

2632

2119

2633

2120

return True

2634

2121

2635

2122

2636

2123

def rfc3339_duration_to_delta(duration):

2637

2124

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

2638

2125

2639

2126

>>> rfc3339_duration_to_delta("P7D")

2640

2127

datetime.timedelta(7)

2641

2128

>>> rfc3339_duration_to_delta("PT60S")

2651

2138

>>> rfc3339_duration_to_delta("P1DT3M20S")

2652

2139

datetime.timedelta(1, 200)

2653

2140

"""

2654

2141

2655

2142

# Parsing an RFC 3339 duration with regular expressions is not

2656

2143

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

2657

2144

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

2658

2145

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

2659

2146

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

2660

2147

# avoid excessive use of external libraries.

2661

2148

2662

2149

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

2663

Token = collections.namedtuple("Token", (

2664

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

2665

# a "group" containing digits

2666

"value", # datetime.timedelta or None

2667

"followers")) # Tokens valid after this token

2150

Token = collections.namedtuple("Token",

2151

("regexp", # To match token; if

2152

# "value" is not None,

2153

# must have a "group"

2154

# containing digits

2155

"value", # datetime.timedelta or

2156

# None

2157

"followers")) # Tokens valid after

2158

# this token

2668

2159

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

2669

2160

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

2670

2161

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

2671

2162

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

2672

2163

datetime.timedelta(seconds=1),

2673

frozenset((token_end, )))

2164

frozenset((token_end,)))

2674

2165

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

2675

2166

datetime.timedelta(minutes=1),

2676

2167

frozenset((token_second, token_end)))

2692

2183

frozenset((token_month, token_end)))

2693

2184

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

2694

2185

datetime.timedelta(weeks=1),

2695

frozenset((token_end, )))

2186

frozenset((token_end,)))

2696

2187

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

2697

2188

frozenset((token_year, token_month,

2698

2189

token_day, token_time,

2699

token_week)))

2700

# Define starting values:

2701

# Value so far

2702

value = datetime.timedelta()

2190

token_week))),

2191

# Define starting values

2192

value = datetime.timedelta() # Value so far

2703

2193

found_token = None

2704

# Following valid tokens

2705

followers = frozenset((token_duration, ))

2706

# String left to parse

2707

s = duration

2194

followers = frozenset(token_duration,) # Following valid tokens

2195

s = duration # String left to parse

2708

2196

# Loop until end token is found

2709

2197

while found_token is not token_end:

2710

2198

# Search for any currently valid tokens

2726

2214

break

2727

2215

else:

2728

2216

# No currently valid tokens were found

2729

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

2730

.format(duration))

2217

raise ValueError("Invalid RFC 3339 duration")

2731

2218

# End token found

2732

2219

return value

2733

2220

2734

2221

2735

2222

def string_to_delta(interval):

2736

2223

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

2737

2224

2738

2225

>>> string_to_delta('7d')

2739

2226

datetime.timedelta(7)

2740

2227

>>> string_to_delta('60s')

2748

2235

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

2749

2236

datetime.timedelta(0, 330)

2750

2237

"""

2751

2238

2752

2239

try:

2753

2240

return rfc3339_duration_to_delta(interval)

2754

2241

except ValueError:

2755

2242

pass

2756

2243

2757

2244

timevalue = datetime.timedelta(0)

2758

2245

for s in interval.split():

2759

2246

try:

2760

suffix = s[-1]

2247

suffix = unicode(s[-1])

2761

2248

value = int(s[:-1])

2762

2249

if suffix == "d":

2763

2250

delta = datetime.timedelta(value)

2770

2257

elif suffix == "w":

2771

2258

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

2772

2259

else:

2773

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

2260

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

2261

.format(suffix))

2774

2262

except IndexError as e:

2775

2263

raise ValueError(*(e.args))

2776

2264

timevalue += delta

2777

2265

return timevalue

2778

2266

2779

2267

2780

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

2268

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

2781

2269

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

2782

2270

2783

2271

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

2784

2272

if os.fork():

2785

2273

sys.exit()

2793

2281

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

2794

2282

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

2795

2283

raise OSError(errno.ENODEV,

2796

"{} not a character device"

2284

"{0} not a character device"

2797

2285

.format(os.devnull))

2798

2286

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

2799

2287

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

2803

2291

2804

2292

2805

2293

def main():

2806

2294

2807

2295

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

2808

2296

# Parsing of options, both command line and config file

2809

2297

2810

2298

parser = argparse.ArgumentParser()

2811

2299

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

2812

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

2300

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

2813

2301

help="show version number and exit")

2814

2302

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

2815

2303

help="Bind to interface IF")

2848

2336

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

2849

2337

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

2850

2338

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

2851

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

2852

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

2853

default=None)

2854

2339

2855

2340

options = parser.parse_args()

2856

2341

2857

2342

if options.check:

2858

2343

import doctest

2859

2344

fail_count, test_count = doctest.testmod()

2860

2345

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

2861

2346

2862

2347

# Default values for config file for server-global settings

2863

server_defaults = {"interface": "",

2864

"address": "",

2865

"port": "",

2866

"debug": "False",

2867

"priority":

2868

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

2869

":+SIGN-DSA-SHA256",

2870

"servicename": "Mandos",

2871

"use_dbus": "True",

2872

"use_ipv6": "True",

2873

"debuglevel": "",

2874

"restore": "True",

2875

"socket": "",

2876

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

2877

"foreground": "False",

2878

"zeroconf": "True",

2879

}

2880

2348

server_defaults = { "interface": "",

2349

"address": "",

2350

"port": "",

2351

"debug": "False",

2352

"priority":

2353

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

2354

"servicename": "Mandos",

2355

"use_dbus": "True",

2356

"use_ipv6": "True",

2357

"debuglevel": "",

2358

"restore": "True",

2359

"socket": "",

2360

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

2361

"foreground": "False",

2362

}

2363

2881

2364

# Parse config file for server-global settings

2882

2365

server_config = configparser.SafeConfigParser(server_defaults)

2883

2366

del server_defaults

2884

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

2367

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

2368

"mandos.conf"))

2885

2369

# Convert the SafeConfigParser object to a dict

2886

2370

server_settings = server_config.defaults()

2887

2371

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

2888

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

2889

"foreground", "zeroconf"):

2372

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

2890

2373

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

2891

2374

option)

2892

2375

if server_settings["port"]:

2902

2385

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

2903

2386

["socket"])

2904

2387

del server_config

2905

2388

2906

2389

# Override the settings from the config file with command line

2907

2390

# options, if set.

2908

2391

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

2909

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

2910

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

2911

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

2392

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

2393

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

2394

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

2912

2395

value = getattr(options, option)

2913

2396

if value is not None:

2914

2397

server_settings[option] = value

2915

2398

del options

2916

2399

# Force all strings to be unicode

2917

2400

for option in server_settings.keys():

2918

if isinstance(server_settings[option], bytes):

2919

server_settings[option] = (server_settings[option]

2920

.decode("utf-8"))

2401

if type(server_settings[option]) is str:

2402

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

2921

2403

# Force all boolean options to be boolean

2922

2404

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

2923

"foreground", "zeroconf"):

2405

"foreground"):

2924

2406

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

2925

2407

# Debug implies foreground

2926

2408

if server_settings["debug"]:

2927

2409

server_settings["foreground"] = True

2928

2410

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

2929

2411

2930

2412

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

2931

2932

if (not server_settings["zeroconf"]

2933

and not (server_settings["port"]

2934

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

2935

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

2936

2413

2937

2414

# For convenience

2938

2415

debug = server_settings["debug"]

2939

2416

debuglevel = server_settings["debuglevel"]

2942

2419

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

2943

2420

stored_state_file)

2944

2421

foreground = server_settings["foreground"]

2945

zeroconf = server_settings["zeroconf"]

2946

2422

2947

2423

if debug:

2948

2424

initlogger(debug, logging.DEBUG)

2949

2425

else:

2952

2428

else:

2953

2429

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

2954

2430

initlogger(debug, level)

2955

2431

2956

2432

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

2957

syslogger.setFormatter(

2958

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

2959

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

2960

server_settings["servicename"])))

2961

2433

syslogger.setFormatter(logging.Formatter

2434

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

2435

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

2436

.format(server_settings

2437

["servicename"])))

2438

2962

2439

# Parse config file with clients

2963

2440

client_config = configparser.SafeConfigParser(Client

2964

2441

.client_defaults)

2965

2442

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

2966

2443

"clients.conf"))

2967

2444

2968

2445

global mandos_dbus_service

2969

2446

mandos_dbus_service = None

2970

2971

socketfd = None

2972

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

2973

socketfd = server_settings["socket"]

2974

tcp_server = MandosServer(

2975

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

2976

ClientHandler,

2977

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

2978

use_ipv6=use_ipv6,

2979

gnutls_priority=server_settings["priority"],

2980

use_dbus=use_dbus,

2981

socketfd=socketfd)

2447

2448

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

2449

server_settings["port"]),

2450

ClientHandler,

2451

interface=(server_settings["interface"]

2452

or None),

2453

use_ipv6=use_ipv6,

2454

gnutls_priority=

2455

server_settings["priority"],

2456

use_dbus=use_dbus,

2457

socketfd=(server_settings["socket"]

2458

or None))

2982

2459

if not foreground:

2983

2460

pidfilename = "/run/mandos.pid"

2984

2461

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

2985

2462

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

2986

2463

pidfile = None

2987

2464

try:

2988

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

2465

pidfile = open(pidfilename, "w")

2989

2466

except IOError as e:

2990

2467

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

2991

2468

exc_info=e)

2992

2993

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

2994

("mandos", "mandos"),

2995

("nobody", "nogroup")):

2469

2470

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

2996

2471

try:

2997

2472

uid = pwd.getpwnam(name).pw_uid

2998

gid = pwd.getpwnam(group).pw_gid

2473

gid = pwd.getpwnam(name).pw_gid

2999

2474

break

3000

2475

except KeyError:

3001

2476

continue

3005

2480

try:

3006

2481

os.setgid(gid)

3007

2482

os.setuid(uid)

3008

if debug:

3009

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

3010

gid))

3011

2483

except OSError as error:

3012

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

3013

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

3014

2484

if error.errno != errno.EPERM:

3015

2485

raise

3016

2486

3017

2487

if debug:

3018

2488

# Enable all possible GnuTLS debugging

3019

2489

3020

2490

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

3021

2491

# - GnuTLS manual

3022

gnutls.global_set_log_level(11)

3023

3024

@gnutls.log_func

2492

gnutls.library.functions.gnutls_global_set_log_level(11)

2493

2494

@gnutls.library.types.gnutls_log_func

3025

2495

def debug_gnutls(level, string):

3026

2496

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

3027

3028

gnutls.global_set_log_function(debug_gnutls)

3029

2497

2498

(gnutls.library.functions

2499

.gnutls_global_set_log_function(debug_gnutls))

2500

3030

2501

# Redirect stdin so all checkers get /dev/null

3031

2502

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

3032

2503

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

3033

2504

if null > 2:

3034

2505

os.close(null)

3035

2506

3036

2507

# Need to fork before connecting to D-Bus

3037

2508

if not foreground:

3038

2509

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

3039

2510

daemon()

3040

3041

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

3042

# to inform GLib that threads will be used.

3043

GLib.threads_init()

3044

2511

2512

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

2513

# need to inform gobject that threads will be used.

2514

gobject.threads_init()

2515

3045

2516

global main_loop

3046

2517

# From the Avahi example code

3047

2518

DBusGMainLoop(set_as_default=True)

3048

main_loop = GLib.MainLoop()

2519

main_loop = gobject.MainLoop()

3049

2520

bus = dbus.SystemBus()

3050

2521

# End of Avahi example code

3051

2522

if use_dbus:

3052

2523

try:

3053

2524

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

3054

bus,

3055

do_not_queue=True)

3056

old_bus_name = dbus.service.BusName(

3057

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

3058

do_not_queue=True)

3059

except dbus.exceptions.DBusException as e:

2525

bus, do_not_queue=True)

2526

old_bus_name = (dbus.service.BusName

2527

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

2528

do_not_queue=True))

2529

except dbus.exceptions.NameExistsException as e:

3060

2530

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

3061

2531

use_dbus = False

3062

2532

server_settings["use_dbus"] = False

3063

2533

tcp_server.use_dbus = False

3064

if zeroconf:

3065

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3066

service = AvahiServiceToSyslog(

3067

name=server_settings["servicename"],

3068

servicetype="_mandos._tcp",

3069

protocol=protocol,

3070

bus=bus)

3071

if server_settings["interface"]:

3072

service.interface = if_nametoindex(

3073

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

3074

2534

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2535

service = AvahiServiceToSyslog(name =

2536

server_settings["servicename"],

2537

servicetype = "_mandos._tcp",

2538

protocol = protocol, bus = bus)

2539

if server_settings["interface"]:

2540

service.interface = (if_nametoindex

2541

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

2542

3075

2543

global multiprocessing_manager

3076

2544

multiprocessing_manager = multiprocessing.Manager()

3077

2545

3078

2546

client_class = Client

3079

2547

if use_dbus:

3080

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

3081

2548

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

2549

3082

2550

client_settings = Client.config_parser(client_config)

3083

2551

old_client_settings = {}

3084

2552

clients_data = {}

3085

2553

3086

2554

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

3087

2555

global wnull

3088

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

2556

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

3089

2557

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

3090

2558

# mode

3091

2559

if debug or not foreground:

3092

2560

wnull.close()

3093

2561

3094

2562

# Get client data and settings from last running state.

3095

2563

if server_settings["restore"]:

3096

2564

try:

3097

2565

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

3098

if sys.version_info.major == 2:

3099

clients_data, old_client_settings = pickle.load(

3100

stored_state)

3101

else:

3102

bytes_clients_data, bytes_old_client_settings = (

3103

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

3104

# Fix bytes to strings

3105

# clients_data

3106

# .keys()

3107

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

3108

if isinstance(key, bytes)

3109

else key): value

3110

for key, value in

3111

bytes_clients_data.items()}

3112

del bytes_clients_data

3113

for key in clients_data:

3114

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

3115

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

3116

for k, v in

3117

clients_data[key].items()}

3118

clients_data[key] = value

3119

# .client_structure

3120

value["client_structure"] = [

3121

(s.decode("utf-8")

3122

if isinstance(s, bytes)

3123

else s) for s in

3124

value["client_structure"]]

3125

# .name & .host

3126

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

3127

if isinstance(value[k], bytes):

3128

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

3129

# old_client_settings

3130

# .keys()

3131

old_client_settings = {

3132

(key.decode("utf-8")

3133

if isinstance(key, bytes)

3134

else key): value

3135

for key, value in

3136

bytes_old_client_settings.items()}

3137

del bytes_old_client_settings

3138

# .host

3139

for value in old_client_settings.values():

3140

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

3141

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

3142

.decode("utf-8"))

2566

clients_data, old_client_settings = (pickle.load

2567

(stored_state))

3143

2568

os.remove(stored_state_path)

3144

2569

except IOError as e:

3145

2570

if e.errno == errno.ENOENT:

3146

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

3147

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

2571

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

2572

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

3148

2573

else:

3149

2574

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

3150

2575

exc_info=e)

3151

2576

raise

3152

2577

except EOFError as e:

3153

2578

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

3154

"EOFError:",

3155

exc_info=e)

3156

2579

"EOFError:", exc_info=e)

2580

3157

2581

with PGPEngine() as pgp:

3158

for client_name, client in clients_data.items():

2582

for client_name, client in clients_data.iteritems():

3159

2583

# Skip removed clients

3160

2584

if client_name not in client_settings:

3161

2585

continue

3162

2586

3163

2587

# Decide which value to use after restoring saved state.

3164

2588

# We have three different values: Old config file,

3165

2589

# new config file, and saved state.

3170

2594

# For each value in new config, check if it

3171

2595

# differs from the old config value (Except for

3172

2596

# the "secret" attribute)

3173

if (name != "secret"

3174

and (value !=

3175

old_client_settings[client_name][name])):

2597

if (name != "secret" and

2598

value != old_client_settings[client_name]

2599

[name]):

3176

2600

client[name] = value

3177

2601

except KeyError:

3178

2602

pass

3179

2603

3180

2604

# Clients who has passed its expire date can still be

3181

# enabled if its last checker was successful. A Client

2605

# enabled if its last checker was successful. Clients

3182

2606

# whose checker succeeded before we stored its state is

3183

2607

# assumed to have successfully run all checkers during

3184

2608

# downtime.

3186

2610

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

3187

2611

if not client["last_checked_ok"]:

3188

2612

logger.warning(

3189

"disabling client {} - Client never "

3190

"performed a successful checker".format(

3191

client_name))

2613

"disabling client {0} - Client never "

2614

"performed a successful checker"

2615

.format(client_name))

3192

2616

client["enabled"] = False

3193

2617

elif client["last_checker_status"] != 0:

3194

2618

logger.warning(

3195

"disabling client {} - Client last"

3196

" checker failed with error code"

3197

" {}".format(

3198

client_name,

3199

client["last_checker_status"]))

2619

"disabling client {0} - Client "

2620

"last checker failed with error code {1}"

2621

.format(client_name,

2622

client["last_checker_status"]))

3200

2623

client["enabled"] = False

3201

2624

else:

3202

client["expires"] = (

3203

datetime.datetime.utcnow()

3204

+ client["timeout"])

2625

client["expires"] = (datetime.datetime

2626

.utcnow()

2627

+ client["timeout"])

3205

2628

logger.debug("Last checker succeeded,"

3206

" keeping {} enabled".format(

3207

client_name))

2629

" keeping {0} enabled"

2630

.format(client_name))

3208

2631

try:

3209

client["secret"] = pgp.decrypt(

3210

client["encrypted_secret"],

3211

client_settings[client_name]["secret"])

2632

client["secret"] = (

2633

pgp.decrypt(client["encrypted_secret"],

2634

client_settings[client_name]

2635

["secret"]))

3212

2636

except PGPError:

3213

2637

# If decryption fails, we use secret from new settings

3214

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

3215

client_name))

3216

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

3217

["secret"])

3218

2638

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

2639

.format(client_name))

2640

client["secret"] = (

2641

client_settings[client_name]["secret"])

2642

3219

2643

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

3220

2644

for client_name in (set(old_client_settings)

3221

2645

- set(client_settings)):

3223

2647

for client_name in (set(client_settings)

3224

2648

- set(old_client_settings)):

3225

2649

clients_data[client_name] = client_settings[client_name]

3226

2650

3227

2651

# Create all client objects

3228

for client_name, client in clients_data.items():

2652

for client_name, client in clients_data.iteritems():

3229

2653

tcp_server.clients[client_name] = client_class(

3230

name=client_name,

3231

settings=client,

3232

server_settings=server_settings)

3233

2654

name = client_name, settings = client,

2655

server_settings = server_settings)

2656

3234

2657

if not tcp_server.clients:

3235

2658

logger.warning("No clients defined")

3236

2659

3237

2660

if not foreground:

3238

2661

if pidfile is not None:

3239

pid = os.getpid()

3240

2662

try:

3241

2663

with pidfile:

3242

print(pid, file=pidfile)

2664

pid = os.getpid()

2665

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

3243

2666

except IOError:

3244

2667

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

3245

2668

pidfilename, pid)

3246

2669

del pidfile

3247

2670

del pidfilename

3248

3249

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

3250

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3251

lambda: main_loop.quit() and False)

3252

2671

2672

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

2673

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

2674

3253

2675

if use_dbus:

3254

3255

@alternate_dbus_interfaces(

3256

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

3257

class MandosDBusService(DBusObjectWithObjectManager):

2676

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

2677

"se.bsnet.fukt.Mandos"})

2678

class MandosDBusService(DBusObjectWithProperties):

3258

2679

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

3259

3260

2680

def __init__(self):

3261

2681

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

3262

3263

2682

_interface = "se.recompile.Mandos"

3264

2683

2684

@dbus_interface_annotations(_interface)

2685

def _foo(self):

2686

return { "org.freedesktop.DBus.Property"

2687

".EmitsChangedSignal":

2688

"false"}

2689

3265

2690

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

3266

2691

def ClientAdded(self, objpath):

3267

2692

"D-Bus signal"

3268

2693

pass

3269

2694

3270

2695

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

3271

2696

def ClientNotFound(self, fingerprint, address):

3272

2697

"D-Bus signal"

3273

2698

pass

3274

3275

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

3276

"true"})

2699

3277

2700

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

3278

2701

def ClientRemoved(self, objpath, name):

3279

2702

"D-Bus signal"

3280

2703

pass

3281

3282

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

3283

"true"})

2704

3284

2705

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

3285

2706

def GetAllClients(self):

3286

2707

"D-Bus method"

3287

return dbus.Array(c.dbus_object_path for c in

3288

tcp_server.clients.values())

3289

3290

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

3291

"true"})

2708

return dbus.Array(c.dbus_object_path

2709

for c in

2710

tcp_server.clients.itervalues())

2711

3292

2712

@dbus.service.method(_interface,

3293

2713

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

3294

2714

def GetAllClientsWithProperties(self):

3295

2715

"D-Bus method"

3296

2716

return dbus.Dictionary(

3297

{c.dbus_object_path: c.GetAll(

3298

"se.recompile.Mandos.Client")

3299

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

2717

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

2718

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

3300

2719

signature="oa{sv}")

3301

2720

3302

2721

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

3303

2722

def RemoveClient(self, object_path):

3304

2723

"D-Bus method"

3305

for c in tcp_server.clients.values():

2724

for c in tcp_server.clients.itervalues():

3306

2725

if c.dbus_object_path == object_path:

3307

2726

del tcp_server.clients[c.name]

3308

2727

c.remove_from_connection()

3309

# Don't signal the disabling

2728

# Don't signal anything except ClientRemoved

3310

2729

c.disable(quiet=True)

3311

# Emit D-Bus signal for removal

3312

self.client_removed_signal(c)

2730

# Emit D-Bus signal

2731

self.ClientRemoved(object_path, c.name)

3313

2732

return

3314

2733

raise KeyError(object_path)

3315

2734

3316

2735

del _interface

3317

3318

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3319

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

3320

def GetManagedObjects(self):

3321

"""D-Bus method"""

3322

return dbus.Dictionary(

3323

{client.dbus_object_path:

3324

dbus.Dictionary(

3325

{interface: client.GetAll(interface)

3326

for interface in

3327

client._get_all_interface_names()})

3328

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

3329

3330

def client_added_signal(self, client):

3331

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

3332

if use_dbus:

3333

# New standard signal

3334

self.InterfacesAdded(

3335

client.dbus_object_path,

3336

dbus.Dictionary(

3337

{interface: client.GetAll(interface)

3338

for interface in

3339

client._get_all_interface_names()}))

3340

# Old signal

3341

self.ClientAdded(client.dbus_object_path)

3342

3343

def client_removed_signal(self, client):

3344

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

3345

if use_dbus:

3346

# New standard signal

3347

self.InterfacesRemoved(

3348

client.dbus_object_path,

3349

client._get_all_interface_names())

3350

# Old signal

3351

self.ClientRemoved(client.dbus_object_path,

3352

client.name)

3353

2736

3354

2737

mandos_dbus_service = MandosDBusService()

3355

3356

# Save modules to variables to exempt the modules from being

3357

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

3358

mp = multiprocessing

3359

wn = wnull

3360

2738

3361

2739

def cleanup():

3362

2740

"Cleanup function; run on exit"

3363

if zeroconf:

3364

service.cleanup()

3365

3366

mp.active_children()

3367

wn.close()

2741

service.cleanup()

2742

2743

multiprocessing.active_children()

2744

wnull.close()

3368

2745

if not (tcp_server.clients or client_settings):

3369

2746

return

3370

2747

3371

2748

# Store client before exiting. Secrets are encrypted with key

3372

2749

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

3373

2750

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

3374

2751

clients = {}

3375

2752

with PGPEngine() as pgp:

3376

for client in tcp_server.clients.values():

2753

for client in tcp_server.clients.itervalues():

3377

2754

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

3378

2755

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

3379

2756

key)

3380

2757

client_dict = {}

3381

2758

3382

2759

# A list of attributes that can not be pickled

3383

2760

# + secret.

3384

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

3385

"checker", "server_settings"}

3386

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

3387

.Object):

2761

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

2762

"checker", "server_settings"))

2763

for name, typ in (inspect.getmembers

2764

(dbus.service.Object)):

3388

2765

exclude.add(name)

3389

2766

3390

2767

client_dict["encrypted_secret"] = (client

3391

2768

.encrypted_secret)

3392

2769

for attr in client.client_structure:

3393

2770

if attr not in exclude:

3394

2771

client_dict[attr] = getattr(client, attr)

3395

2772

3396

2773

clients[client.name] = client_dict

3397

2774

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

3398

2775

3399

2776

try:

3400

with tempfile.NamedTemporaryFile(

3401

mode='wb',

3402

suffix=".pickle",

3403

prefix='clients-',

3404

dir=os.path.dirname(stored_state_path),

3405

delete=False) as stored_state:

3406

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

3407

protocol=2)

3408

tempname = stored_state.name

2777

with (tempfile.NamedTemporaryFile

2778

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

2779

dir=os.path.dirname(stored_state_path),

2780

delete=False)) as stored_state:

2781

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

2782

tempname=stored_state.name

3409

2783

os.rename(tempname, stored_state_path)

3410

2784

except (IOError, OSError) as e:

3411

2785

if not debug:

3414

2788

except NameError:

3415

2789

pass

3416

2790

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

3417

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

2791

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

3418

2792

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

3419

2793

else:

3420

2794

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

3421

2795

exc_info=e)

3422

2796

raise

3423

2797

3424

2798

# Delete all clients, and settings from config

3425

2799

while tcp_server.clients:

3426

2800

name, client = tcp_server.clients.popitem()

3427

2801

if use_dbus:

3428

2802

client.remove_from_connection()

3429

# Don't signal the disabling

2803

# Don't signal anything except ClientRemoved

3430

2804

client.disable(quiet=True)

3431

# Emit D-Bus signal for removal

3432

2805

if use_dbus:

3433

mandos_dbus_service.client_removed_signal(client)

2806

# Emit D-Bus signal

2807

mandos_dbus_service.ClientRemoved(client

2808

.dbus_object_path,

2809

client.name)

3434

2810

client_settings.clear()

3435

2811

3436

2812

atexit.register(cleanup)

3437

3438

for client in tcp_server.clients.values():

2813

2814

for client in tcp_server.clients.itervalues():

3439

2815

if use_dbus:

3440

# Emit D-Bus signal for adding

3441

mandos_dbus_service.client_added_signal(client)

2816

# Emit D-Bus signal

2817

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3442

2818

# Need to initiate checking of clients

3443

2819

if client.enabled:

3444

2820

client.init_checker()

3445

2821

3446

2822

tcp_server.enable()

3447

2823

tcp_server.server_activate()

3448

2824

3449

2825

# Find out what port we got

3450

if zeroconf:

3451

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

2826

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

3452

2827

if use_ipv6:

3453

2828

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

3454

2829

" flowinfo %d, scope_id %d",

3456

2831

else: # IPv4

3457

2832

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

3458

2833

*tcp_server.socket.getsockname())

3459

3460

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

3461

2834

2835

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

2836

3462

2837

try:

3463

if zeroconf:

3464

# From the Avahi example code

3465

try:

3466

service.activate()

3467

except dbus.exceptions.DBusException as error:

3468

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

3469

cleanup()

3470

sys.exit(1)

3471

# End of Avahi example code

3472

3473

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

3474

lambda *args, **kwargs:

3475

(tcp_server.handle_request

3476

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

3477

2838

# From the Avahi example code

2839

try:

2840

service.activate()

2841

except dbus.exceptions.DBusException as error:

2842

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

2843

cleanup()

2844

sys.exit(1)

2845

# End of Avahi example code

2846

2847

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

2848

lambda *args, **kwargs:

2849

(tcp_server.handle_request

2850

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

2851

3478

2852

logger.debug("Starting main loop")

3479

2853

main_loop.run()

3480

2854

except AvahiError as error:

3489

2863

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

3490

2864

cleanup()

3491

2865

3492

3493

2866

if __name__ == '__main__':

3494

2867

main()