/mandos/trunk : revision 921

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

72

80

73

81

import dbus

74

82

import dbus.service

75

import gobject

76

import avahi

83

from gi.repository import GLib

77

84

from dbus.mainloop.glib import DBusGMainLoop

78

85

import ctypes

79

86

import ctypes.util

80

87

import xml.dom.minidom

81

88

import inspect

82

89

90

# Try to find the value of SO_BINDTODEVICE:

83

91

try:

92

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

93

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

84

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

95

except AttributeError:

86

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

87

99

from IN import SO_BINDTODEVICE

88

100

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.2"

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.7.16"

92

119

stored_state_file = "clients.pickle"

93

120

94

121

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

122

syslogger = None

98

123

99

124

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

103

127

except (OSError, AttributeError):

128

104

129

def if_nametoindex(interface):

105

130

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

106

131

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

107

132

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

108

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

134

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

135

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

113

136

return interface_index

114

137

115

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

116

155

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

117

156

"""init logger and add loglevel"""

118

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

119

162

syslogger.setFormatter(logging.Formatter

120

163

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

121

164

' %(message)s'))

122

165

logger.addHandler(syslogger)

123

166

124

167

if debug:

125

168

console = logging.StreamHandler()

126

169

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

138

181

139

182

class PGPEngine(object):

140

183

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

184

141

185

def __init__(self):

142

186

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

143

198

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

199

'--homedir', self.tempdir,

145

200

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

148

201

'--quiet']

202

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

203

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

204

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

205

149

206

def __enter__(self):

150

207

return self

151

208

152

209

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

153

210

self._cleanup()

154

211

return False

155

212

156

213

def __del__(self):

157

214

self._cleanup()

158

215

159

216

def _cleanup(self):

160

217

if self.tempdir is not None:

161

218

# Delete contents of tempdir

162

219

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

163

topdown = False):

220

topdown=False):

164

221

for filename in files:

165

222

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

166

223

for dirname in dirs:

168

225

# Remove tempdir

169

226

os.rmdir(self.tempdir)

170

227

self.tempdir = None

171

228

172

229

def password_encode(self, password):

173

230

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

174

231

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

179

236

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

180

237

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

181

238

return encoded

182

239

183

240

def encrypt(self, data, password):

184

241

passphrase = self.password_encode(password)

185

with tempfile.NamedTemporaryFile(dir=self.tempdir

186

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

187

244

passfile.write(passphrase)

188

245

passfile.flush()

189

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

246

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

190

247

'--passphrase-file',

191

248

passfile.name]

192

249

+ self.gnupgargs,

193

stdin = subprocess.PIPE,

194

stdout = subprocess.PIPE,

195

stderr = subprocess.PIPE)

196

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

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

197

254

if proc.returncode != 0:

198

255

raise PGPError(err)

199

256

return ciphertext

200

257

201

258

def decrypt(self, data, password):

202

259

passphrase = self.password_encode(password)

203

with tempfile.NamedTemporaryFile(dir = self.tempdir

204

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

205

262

passfile.write(passphrase)

206

263

passfile.flush()

207

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

264

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

208

265

'--passphrase-file',

209

266

passfile.name]

210

267

+ self.gnupgargs,

211

stdin = subprocess.PIPE,

212

stdout = subprocess.PIPE,

213

stderr = subprocess.PIPE)

214

decrypted_plaintext, err = proc.communicate(input

215

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

216

272

if proc.returncode != 0:

217

273

raise PGPError(err)

218

274

return decrypted_plaintext

219

275

220

276

277

# Pretend that we have an Avahi module

278

class Avahi(object):

279

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

280

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

281

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

282

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

283

PROTO_INET = 0 # avahi-common/address.h

284

PROTO_INET6 = 1 # avahi-common/address.h

285

DBUS_NAME = "org.freedesktop.Avahi"

286

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

287

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

288

DBUS_PATH_SERVER = "/"

289

290

def string_array_to_txt_array(self, t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

avahi = Avahi()

302

303

221

304

class AvahiError(Exception):

222

305

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

223

306

self.value = value

224

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

225

def __unicode__(self):

226

return unicode(repr(self.value))

307

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

308

**kwargs)

309

227

310

228

311

class AvahiServiceError(AvahiError):

229

312

pass

230

313

314

231

315

class AvahiGroupError(AvahiError):

232

316

pass

233

317

234

318

235

319

class AvahiService(object):

236

320

"""An Avahi (Zeroconf) service.

237

321

238

322

Attributes:

239

323

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

240

324

Used to optionally bind to the specified interface.

252

336

server: D-Bus Server

253

337

bus: dbus.SystemBus()

254

338

"""

255

256

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

257

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

258

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

259

protocol = avahi.PROTO_UNSPEC, bus = None):

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

260

351

self.interface = interface

261

352

self.name = name

262

353

self.type = servicetype

271

362

self.server = None

272

363

self.bus = bus

273

364

self.entry_group_state_changed_match = None

274

275

def rename(self):

365

366

def rename(self, remove=True):

276

367

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

277

368

if self.rename_count >= self.max_renames:

278

369

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

279

370

" after %i retries, exiting.",

280

371

self.rename_count)

281

372

raise AvahiServiceError("Too many renames")

282

self.name = unicode(self.server

283

.GetAlternativeServiceName(self.name))

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

284

376

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

285

377

self.name)

286

self.remove()

378

if remove:

379

self.remove()

287

380

try:

288

381

self.add()

289

382

except dbus.exceptions.DBusException as error:

290

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

291

self.cleanup()

292

os._exit(1)

293

self.rename_count += 1

294

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

295

392

def remove(self):

296

393

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

297

394

if self.entry_group_state_changed_match is not None:

299

396

self.entry_group_state_changed_match = None

300

397

if self.group is not None:

301

398

self.group.Reset()

302

399

303

400

def add(self):

304

401

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

305

402

self.remove()

322

419

dbus.UInt16(self.port),

323

420

avahi.string_array_to_txt_array(self.TXT))

324

421

self.group.Commit()

325

422

326

423

def entry_group_state_changed(self, state, error):

327

424

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

328

425

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

329

426

330

427

if state == avahi.ENTRY_GROUP_ESTABLISHED:

331

428

logger.debug("Zeroconf service established.")

332

429

elif state == avahi.ENTRY_GROUP_COLLISION:

334

431

self.rename()

335

432

elif state == avahi.ENTRY_GROUP_FAILURE:

336

433

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

337

unicode(error))

338

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

339

.format(error))

340

434

str(error))

435

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

436

341

437

def cleanup(self):

342

438

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

343

439

if self.group is not None:

348

444

pass

349

445

self.group = None

350

446

self.remove()

351

447

352

448

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

353

449

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

354

450

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

355

bad_states = { avahi.SERVER_INVALID:

356

"Zeroconf server invalid",

357

avahi.SERVER_REGISTERING: None,

358

avahi.SERVER_COLLISION:

359

"Zeroconf server name collision",

360

avahi.SERVER_FAILURE:

361

"Zeroconf server failure" }

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

}

362

457

if state in bad_states:

363

458

if bad_states[state] is not None:

364

459

if error is None:

367

462

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

368

463

self.cleanup()

369

464

elif state == avahi.SERVER_RUNNING:

370

self.add()

465

try:

466

self.add()

467

except dbus.exceptions.DBusException as error:

468

if (error.get_dbus_name()

469

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

470

logger.info("Local Zeroconf service name"

471

" collision.")

472

return self.rename(remove=False)

473

else:

474

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

475

self.cleanup()

476

os._exit(1)

371

477

else:

372

478

if error is None:

373

479

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

374

480

else:

375

481

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

376

482

377

483

def activate(self):

378

484

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

379

485

if self.server is None:

383

489

follow_name_owner_changes=True),

384

490

avahi.DBUS_INTERFACE_SERVER)

385

491

self.server.connect_to_signal("StateChanged",

386

self.server_state_changed)

492

self.server_state_changed)

387

493

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

388

494

389

495

390

496

class AvahiServiceToSyslog(AvahiService):

391

def rename(self):

497

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

392

498

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

393

ret = AvahiService.rename(self)

394

syslogger.setFormatter(logging.Formatter

395

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

396

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

397

.format(self.name)))

499

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

500

**kwargs)

501

syslogger.setFormatter(logging.Formatter(

502

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

503

.format(self.name)))

398

504

return ret

399

505

400

506

401

def timedelta_to_milliseconds(td):

402

"Convert a datetime.timedelta() to milliseconds"

403

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

404

+ (td.seconds * 1000)

405

+ (td.microseconds // 1000))

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

406

779

407

780

408

781

class Client(object):

409

782

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

410

783

411

784

Attributes:

412

785

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

413

786

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

415

788

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

416

789

to see if the client lives.

417

790

'None' if no process is running.

418

checker_callback_tag: a gobject event source tag, or None

791

checker_callback_tag: a GLib event source tag, or None

419

792

checker_command: string; External command which is run to check

420

793

if client lives. %() expansions are done at

421

794

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

422

795

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

423

checker_initiator_tag: a gobject event source tag, or None

796

checker_initiator_tag: a GLib event source tag, or None

424

797

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

425

798

client_structure: Object describing what attributes a client has

426

799

and is used for storing the client at exit

427

800

current_checker_command: string; current running checker_command

428

disable_initiator_tag: a gobject event source tag, or None

801

disable_initiator_tag: a GLib event source tag, or None

429

802

enabled: bool()

430

803

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

431

804

uniquely identify the client

436

809

last_checker_status: integer between 0 and 255 reflecting exit

437

810

status of last checker. -1 reflects crashed

438

811

checker, -2 means no checker completed yet.

812

last_checker_signal: The signal which killed the last checker, if

813

last_checker_status is -1

439

814

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

440

815

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

441

816

D-Bus identifiers

448

823

disabled, or None

449

824

server_settings: The server_settings dict from main()

450

825

"""

451

826

452

827

runtime_expansions = ("approval_delay", "approval_duration",

453

828

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

454

829

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

455

830

"last_approval_request", "last_checked_ok",

456

831

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

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

460

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

461

"host": "",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

464

"approved_by_default": "True",

465

"enabled": "True",

466

}

467

468

def timeout_milliseconds(self):

469

"Return the 'timeout' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.timeout)

471

472

def extended_timeout_milliseconds(self):

473

"Return the 'extended_timeout' attribute in milliseconds"

474

return timedelta_to_milliseconds(self.extended_timeout)

475

476

def interval_milliseconds(self):

477

"Return the 'interval' attribute in milliseconds"

478

return timedelta_to_milliseconds(self.interval)

479

480

def approval_delay_milliseconds(self):

481

return timedelta_to_milliseconds(self.approval_delay)

482

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

483

844

@staticmethod

484

845

def config_parser(config):

485

846

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

492

853

for client_name in config.sections():

493

854

section = dict(config.items(client_name))

494

855

client = settings[client_name] = {}

495

856

496

857

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

497

858

# Reformat values from string types to Python types

498

859

client["approved_by_default"] = config.getboolean(

499

860

client_name, "approved_by_default")

500

861

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

501

862

"enabled")

502

863

864

# Uppercase and remove spaces from fingerprint for later

865

# comparison purposes with return value from the

866

# fingerprint() function

503

867

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

504

868

.replace(" ", ""))

505

869

if "secret" in section:

506

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

870

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

871

.encode("utf-8"),

872

"base64")

507

873

elif "secfile" in section:

508

874

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

509

875

(section["secfile"])),

510

876

"rb") as secfile:

511

877

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

512

878

else:

513

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

879

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

514

880

.format(section))

515

881

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

516

882

client["extended_timeout"] = string_to_delta(

524

890

client["last_approval_request"] = None

525

891

client["last_checked_ok"] = None

526

892

client["last_checker_status"] = -2

527

893

528

894

return settings

529

530

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

895

896

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

531

897

self.name = name

532

898

if server_settings is None:

533

899

server_settings = {}

534

900

self.server_settings = server_settings

535

901

# adding all client settings

536

for setting, value in settings.iteritems():

902

for setting, value in settings.items():

537

903

setattr(self, setting, value)

538

904

539

905

if self.enabled:

540

906

if not hasattr(self, "last_enabled"):

541

907

self.last_enabled = datetime.datetime.utcnow()

545

911

else:

546

912

self.last_enabled = None

547

913

self.expires = None

548

914

549

915

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

550

# Uppercase and remove spaces from fingerprint for later

551

# comparison purposes with return value from the fingerprint()

552

# function

553

916

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

554

917

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

555

918

datetime.datetime.utcnow())

556

919

557

920

# attributes specific for this server instance

558

921

self.checker = None

559

922

self.checker_initiator_tag = None

562

925

self.current_checker_command = None

563

926

self.approved = None

564

927

self.approvals_pending = 0

565

self.changedstate = (multiprocessing_manager

566

.Condition(multiprocessing_manager

567

.Lock()))

568

self.client_structure = [attr for attr in

569

self.__dict__.iterkeys()

928

self.changedstate = multiprocessing_manager.Condition(

929

multiprocessing_manager.Lock())

930

self.client_structure = [attr

931

for attr in self.__dict__.keys()

570

932

if not attr.startswith("_")]

571

933

self.client_structure.append("client_structure")

572

573

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

574

lambda obj:

575

isinstance(obj,

576

property)):

934

935

for name, t in inspect.getmembers(

936

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

577

937

if not name.startswith("_"):

578

938

self.client_structure.append(name)

579

939

580

940

# Send notice to process children that client state has changed

581

941

def send_changedstate(self):

582

942

with self.changedstate:

583

943

self.changedstate.notify_all()

584

944

585

945

def enable(self):

586

946

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

587

947

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

592

952

self.last_enabled = datetime.datetime.utcnow()

593

953

self.init_checker()

594

954

self.send_changedstate()

595

955

596

956

def disable(self, quiet=True):

597

957

"""Disable this client."""

598

958

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

600

960

if not quiet:

601

961

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

602

962

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

603

gobject.source_remove(self.disable_initiator_tag)

963

GLib.source_remove(self.disable_initiator_tag)

604

964

self.disable_initiator_tag = None

605

965

self.expires = None

606

966

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

607

gobject.source_remove(self.checker_initiator_tag)

967

GLib.source_remove(self.checker_initiator_tag)

608

968

self.checker_initiator_tag = None

609

969

self.stop_checker()

610

970

self.enabled = False

611

971

if not quiet:

612

972

self.send_changedstate()

613

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

973

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

614

974

return False

615

975

616

976

def __del__(self):

617

977

self.disable()

618

978

619

979

def init_checker(self):

620

980

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

621

981

# and every interval from then on.

622

982

if self.checker_initiator_tag is not None:

623

gobject.source_remove(self.checker_initiator_tag)

624

self.checker_initiator_tag = (gobject.timeout_add

625

(self.interval_milliseconds(),

626

self.start_checker))

983

GLib.source_remove(self.checker_initiator_tag)

984

self.checker_initiator_tag = GLib.timeout_add(

985

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

986

self.start_checker)

627

987

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

628

988

if self.disable_initiator_tag is not None:

629

gobject.source_remove(self.disable_initiator_tag)

630

self.disable_initiator_tag = (gobject.timeout_add

631

(self.timeout_milliseconds(),

632

self.disable))

989

GLib.source_remove(self.disable_initiator_tag)

990

self.disable_initiator_tag = GLib.timeout_add(

991

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

633

992

# Also start a new checker *right now*.

634

993

self.start_checker()

635

636

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

994

995

def checker_callback(self, source, condition, connection,

996

command):

637

997

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

638

998

self.checker_callback_tag = None

639

999

self.checker = None

640

if os.WIFEXITED(condition):

641

self.last_checker_status = os.WEXITSTATUS(condition)

1000

# Read return code from connection (see call_pipe)

1001

returncode = connection.recv()

1002

connection.close()

1003

1004

if returncode >= 0:

1005

self.last_checker_status = returncode

1006

self.last_checker_signal = None

642

1007

if self.last_checker_status == 0:

643

1008

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

644

1009

vars(self))

645

1010

self.checked_ok()

646

1011

else:

647

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

648

vars(self))

1012

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

649

1013

else:

650

1014

self.last_checker_status = -1

1015

self.last_checker_signal = -returncode

651

1016

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

652

1017

vars(self))

653

1018

return False

1019

654

1020

def checked_ok(self):

655

1021

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

656

1022

self.last_checked_ok = datetime.datetime.utcnow()

657

1023

self.last_checker_status = 0

1024

self.last_checker_signal = None

658

1025

self.bump_timeout()

659

1026

660

1027

def bump_timeout(self, timeout=None):

661

1028

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

662

1029

if timeout is None:

663

1030

timeout = self.timeout

664

1031

if self.disable_initiator_tag is not None:

665

gobject.source_remove(self.disable_initiator_tag)

1032

GLib.source_remove(self.disable_initiator_tag)

666

1033

self.disable_initiator_tag = None

667

1034

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

668

self.disable_initiator_tag = (gobject.timeout_add

669

(timedelta_to_milliseconds

670

(timeout), self.disable))

1035

self.disable_initiator_tag = GLib.timeout_add(

1036

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

671

1037

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

672

1038

673

1039

def need_approval(self):

674

1040

self.last_approval_request = datetime.datetime.utcnow()

675

1041

676

1042

def start_checker(self):

677

1043

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

678

1044

679

1045

If a checker already exists, leave it running and do

680

1046

nothing."""

681

1047

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

686

1052

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

687

1053

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

688

1054

# should be.

689

690

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

691

try:

692

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

693

except AttributeError:

694

pass

695

except OSError as error:

696

if error.errno != errno.ECHILD:

697

raise

698

else:

699

if pid:

700

logger.warning("Checker was a zombie")

701

gobject.source_remove(self.checker_callback_tag)

702

self.checker_callback(pid, status,

703

self.current_checker_command)

1055

1056

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

1057

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

1058

self.checker.join()

1059

self.checker = None

704

1060

# Start a new checker if needed

705

1061

if self.checker is None:

706

1062

# Escape attributes for the shell

707

escaped_attrs = dict(

708

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

709

for attr in

710

self.runtime_expansions)

1063

escaped_attrs = {

1064

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

1065

for attr in self.runtime_expansions}

711

1066

try:

712

1067

command = self.checker_command % escaped_attrs

713

1068

except TypeError as error:

714

1069

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

715

self.checker_command, exc_info=error)

716

return True # Try again later

1070

self.checker_command,

1071

exc_info=error)

1072

return True # Try again later

717

1073

self.current_checker_command = command

718

try:

719

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

720

command, self.name)

721

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

722

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

723

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

724

# always replaced by /dev/null.)

725

# The exception is when not debugging but nevertheless

726

# running in the foreground; use the previously

727

# created wnull.

728

popen_args = {}

729

if (not self.server_settings["debug"]

730

and self.server_settings["foreground"]):

731

popen_args.update({"stdout": wnull,

732

"stderr": wnull })

733

self.checker = subprocess.Popen(command,

734

close_fds=True,

735

shell=True, cwd="/",

736

**popen_args)

737

except OSError as error:

738

logger.error("Failed to start subprocess",

739

exc_info=error)

740

return True

741

self.checker_callback_tag = (gobject.child_watch_add

742

(self.checker.pid,

743

self.checker_callback,

744

data=command))

745

# The checker may have completed before the gobject

746

# watch was added. Check for this.

747

try:

748

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

749

except OSError as error:

750

if error.errno == errno.ECHILD:

751

# This should never happen

752

logger.error("Child process vanished",

753

exc_info=error)

754

return True

755

raise

756

if pid:

757

gobject.source_remove(self.checker_callback_tag)

758

self.checker_callback(pid, status, command)

759

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

1074

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

1075

self.name)

1076

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

1077

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

1078

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

1079

# always replaced by /dev/null.)

1080

# The exception is when not debugging but nevertheless

1081

# running in the foreground; use the previously

1082

# created wnull.

1083

popen_args = {"close_fds": True,

1084

"shell": True,

1085

"cwd": "/"}

1086

if (not self.server_settings["debug"]

1087

and self.server_settings["foreground"]):

1088

popen_args.update({"stdout": wnull,

1089

"stderr": wnull})

1090

pipe = multiprocessing.Pipe(duplex=False)

1091

self.checker = multiprocessing.Process(

1092

target=call_pipe,

1093

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

1094

kwargs=popen_args)

1095

self.checker.start()

1096

self.checker_callback_tag = GLib.io_add_watch(

1097

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

1098

self.checker_callback, pipe[0], command)

1099

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

760

1100

return True

761

1101

762

1102

def stop_checker(self):

763

1103

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

764

1104

if self.checker_callback_tag:

765

gobject.source_remove(self.checker_callback_tag)

1105

GLib.source_remove(self.checker_callback_tag)

766

1106

self.checker_callback_tag = None

767

1107

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

768

1108

return

769

1109

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

770

try:

771

self.checker.terminate()

772

#time.sleep(0.5)

773

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

774

# self.checker.kill()

775

except OSError as error:

776

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

777

raise

1110

self.checker.terminate()

778

1111

self.checker = None

779

1112

780

1113

781

def dbus_service_property(dbus_interface, signature="v",

782

access="readwrite", byte_arrays=False):

1114

def dbus_service_property(dbus_interface,

1115

signature="v",

1116

access="readwrite",

1117

byte_arrays=False):

783

1118

"""Decorators for marking methods of a DBusObjectWithProperties to

784

1119

become properties on the D-Bus.

785

1120

786

1121

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

787

1122

and with one argument by "Set".

788

1123

789

1124

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

790

1125

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

791

1126

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

794

1129

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

795

1130

if byte_arrays and signature != "ay":

796

1131

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

797

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

1132

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

1133

798

1134

def decorator(func):

799

1135

func._dbus_is_property = True

800

1136

func._dbus_interface = dbus_interface

803

1139

func._dbus_name = func.__name__

804

1140

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

805

1141

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

806

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1142

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

807

1143

return func

1144

808

1145

return decorator

809

1146

810

1147

811

1148

def dbus_interface_annotations(dbus_interface):

812

1149

"""Decorator for marking functions returning interface annotations

813

1150

814

1151

Usage:

815

1152

816

1153

@dbus_interface_annotations("org.example.Interface")

817

1154

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

818

1155

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

819

1156

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

820

1157

"false"}

821

1158

"""

1159

822

1160

def decorator(func):

823

1161

func._dbus_is_interface = True

824

1162

func._dbus_interface = dbus_interface

825

1163

func._dbus_name = dbus_interface

826

1164

return func

1165

827

1166

return decorator

828

1167

829

1168

830

1169

def dbus_annotations(annotations):

831

1170

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

832

1171

Usage:

833

1172

1173

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

1174

"org.freedesktop.DBus.Property."

1175

"EmitsChangedSignal": "false"})

834

1176

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

835

1177

access="r")

836

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

837

"org.freedesktop.DBus.Property."

838

"EmitsChangedSignal": "false"})

839

1178

def Property_dbus_property(self):

840

1179

return dbus.Boolean(False)

1180

1181

See also the DBusObjectWithAnnotations class.

841

1182

"""

1183

842

1184

def decorator(func):

843

1185

func._dbus_annotations = annotations

844

1186

return func

1187

845

1188

return decorator

846

1189

847

1190

848

1191

class DBusPropertyException(dbus.exceptions.DBusException):

849

1192

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

850

1193

"""

851

def __unicode__(self):

852

return unicode(str(self))

1194

pass

853

1195

854

1196

855

1197

class DBusPropertyAccessException(DBusPropertyException):

864

1206

pass

865

1207

866

1208

867

class DBusObjectWithProperties(dbus.service.Object):

868

"""A D-Bus object with properties.

869

870

Classes inheriting from this can use the dbus_service_property

871

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

872

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

1209

class DBusObjectWithAnnotations(dbus.service.Object):

1210

"""A D-Bus object with annotations.

1211

1212

Classes inheriting from this can use the dbus_annotations

1213

decorator to add annotations to methods or signals.

873

1214

"""

874

1215

875

1216

@staticmethod

876

1217

def _is_dbus_thing(thing):

877

1218

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

878

1219

879

1220

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

880

1221

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

881

1222

"""

882

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

1223

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

883

1224

False)

884

1225

885

1226

def _get_all_dbus_things(self, thing):

886

1227

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

887

1228

"""

888

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

889

name),

1229

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

890

1230

athing.__get__(self))

891

1231

for cls in self.__class__.__mro__

892

1232

for name, athing in

893

inspect.getmembers(cls,

894

self._is_dbus_thing(thing)))

895

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

896

1306

def _get_dbus_property(self, interface_name, property_name):

897

1307

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

898

1308

property with the specified name and interface.

899

1309

"""

900

for cls in self.__class__.__mro__:

901

for name, value in (inspect.getmembers

902

(cls,

903

self._is_dbus_thing("property"))):

1310

for cls in self.__class__.__mro__:

1311

for name, value in inspect.getmembers(

1312

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

904

1313

if (value._dbus_name == property_name

905

1314

and value._dbus_interface == interface_name):

906

1315

return value.__get__(self)

907

1316

908

1317

# No such property

909

raise DBusPropertyNotFound(self.dbus_object_path + ":"

910

+ interface_name + "."

911

+ property_name)

912

913

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

1318

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

1319

self.dbus_object_path, interface_name, property_name))

1320

1321

@classmethod

1322

def _get_all_interface_names(cls):

1323

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

1324

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

1325

"_dbus_interface", None)

1326

for x in (inspect.getmro(cls))

1327

for attr in dir(x))

1328

if name is not None)

1329

1330

@dbus.service.method(dbus.PROPERTIES_IFACE,

1331

in_signature="ss",

914

1332

out_signature="v")

915

1333

def Get(self, interface_name, property_name):

916

1334

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

922

1340

if not hasattr(value, "variant_level"):

923

1341

return value

924

1342

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

925

1343

926

1344

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

927

1345

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

928

1346

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

935

1353

# signatures other than "ay".

936

1354

if prop._dbus_signature != "ay":

937

1355

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

938

"'ay' signature {0!r}"

1356

"'ay' signature {!r}"

939

1357

.format(prop._dbus_signature))

940

1358

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

941

1359

for byte in value))

942

1360

prop(value)

943

944

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

1361

1362

@dbus.service.method(dbus.PROPERTIES_IFACE,

1363

in_signature="s",

945

1364

out_signature="a{sv}")

946

1365

def GetAll(self, interface_name):

947

1366

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

948

1367

standard.

949

1368

950

1369

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

951

1370

"""

952

1371

properties = {}

962

1381

if not hasattr(value, "variant_level"):

963

1382

properties[name] = value

964

1383

continue

965

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

966

value.variant_level+1)

1384

properties[name] = type(value)(

1385

value, variant_level=value.variant_level + 1)

967

1386

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

968

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

969

1396

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

970

1397

out_signature="s",

971

1398

path_keyword='object_path',

972

1399

connection_keyword='connection')

973

1400

def Introspect(self, object_path, connection):

974

1401

"""Overloading of standard D-Bus method.

975

1402

976

1403

Inserts property tags and interface annotation tags.

977

1404

"""

978

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

979

connection)

1405

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1406

object_path,

1407

connection)

980

1408

try:

981

1409

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

1410

982

1411

def make_tag(document, name, prop):

983

1412

e = document.createElement("property")

984

1413

e.setAttribute("name", name)

985

1414

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

986

1415

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

987

1416

return e

1417

988

1418

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

989

1419

# Add property tags

990

1420

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

993

1423

if prop._dbus_interface

994

1424

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

995

1425

if_tag.appendChild(tag)

996

# Add annotation tags

997

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

998

for tag in if_tag.getElementsByTagName(typ):

999

annots = dict()

1000

for name, prop in (self.

1001

_get_all_dbus_things(typ)):

1002

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

1003

and prop._dbus_interface

1004

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

1005

annots.update(getattr

1006

(prop,

1007

"_dbus_annotations",

1008

{}))

1009

for name, value in annots.iteritems():

1010

ann_tag = document.createElement(

1011

"annotation")

1012

ann_tag.setAttribute("name", name)

1013

ann_tag.setAttribute("value", value)

1014

tag.appendChild(ann_tag)

1015

# Add interface annotation tags

1016

for annotation, value in dict(

1017

itertools.chain.from_iterable(

1018

annotations().iteritems()

1019

for name, annotations in

1020

self._get_all_dbus_things("interface")

1021

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

1022

)).iteritems():

1023

ann_tag = document.createElement("annotation")

1024

ann_tag.setAttribute("name", annotation)

1025

ann_tag.setAttribute("value", value)

1026

if_tag.appendChild(ann_tag)

1426

# Add annotation tags for properties

1427

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

1428

annots = dict()

1429

for name, prop in self._get_all_dbus_things(

1430

"property"):

1431

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

1432

and prop._dbus_interface

1433

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

1434

annots.update(getattr(

1435

prop, "_dbus_annotations", {}))

1436

for name, value in annots.items():

1437

ann_tag = document.createElement(

1438

"annotation")

1439

ann_tag.setAttribute("name", name)

1440

ann_tag.setAttribute("value", value)

1441

tag.appendChild(ann_tag)

1027

1442

# Add the names to the return values for the

1028

1443

# "org.freedesktop.DBus.Properties" methods

1029

1444

if (if_tag.getAttribute("name")

1048

1463

return xmlstring

1049

1464

1050

1465

1466

try:

1467

dbus.OBJECT_MANAGER_IFACE

1468

except AttributeError:

1469

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

1470

1471

1472

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1473

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

1474

1475

Classes inheriting from this exposes the standard

1476

GetManagedObjects call and the InterfacesAdded and

1477

InterfacesRemoved signals on the standard

1478

"org.freedesktop.DBus.ObjectManager" interface.

1479

1480

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

1481

manually.

1482

"""

1483

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1484

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

1485

def GetManagedObjects(self):

1486

"""This function must be overridden"""

1487

raise NotImplementedError()

1488

1489

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1490

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

1491

def InterfacesAdded(self, object_path, interfaces_and_properties):

1492

pass

1493

1494

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

1495

def InterfacesRemoved(self, object_path, interfaces):

1496

pass

1497

1498

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1499

out_signature="s",

1500

path_keyword='object_path',

1501

connection_keyword='connection')

1502

def Introspect(self, object_path, connection):

1503

"""Overloading of standard D-Bus method.

1504

1505

Override return argument name of GetManagedObjects to be

1506

"objpath_interfaces_and_properties"

1507

"""

1508

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1509

object_path,

1510

connection)

1511

try:

1512

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

1513

1514

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

1515

# Fix argument name for the GetManagedObjects method

1516

if (if_tag.getAttribute("name")

1517

== dbus.OBJECT_MANAGER_IFACE):

1518

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

1519

if (cn.getAttribute("name")

1520

== "GetManagedObjects"):

1521

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

1522

if (arg.getAttribute("direction")

1523

== "out"):

1524

arg.setAttribute(

1525

"name",

1526

"objpath_interfaces"

1527

"_and_properties")

1528

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

1529

document.unlink()

1530

except (AttributeError, xml.dom.DOMException,

1531

xml.parsers.expat.ExpatError) as error:

1532

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

1533

exc_info=error)

1534

return xmlstring

1535

1536

1051

1537

def datetime_to_dbus(dt, variant_level=0):

1052

1538

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

1053

1539

if dt is None:

1054

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

1055

return dbus.String(dt.isoformat(),

1056

variant_level=variant_level)

1540

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

1541

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

1057

1542

1058

1543

1059

1544

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1061

1546

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

1062

1547

interface names according to the "alt_interface_names" mapping.

1063

1548

Usage:

1064

1549

1065

1550

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

1066

1551

"net.example.AlternateInterface"})

1067

1552

class SampleDBusObject(dbus.service.Object):

1068

1553

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

1069

1554

def SampleDBusMethod():

1070

1555

pass

1071

1556

1072

1557

The above "SampleDBusMethod" on "SampleDBusObject" will be

1073

1558

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

1074

1559

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

1075

1560

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

1076

1561

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

1077

1562

1078

1563

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

1079

1564

(from DBusObjectWithProperties) and interfaces (from the

1080

1565

dbus_interface_annotations decorator).

1081

1566

"""

1567

1082

1568

def wrapper(cls):

1083

1569

for orig_interface_name, alt_interface_name in (

1084

alt_interface_names.iteritems()):

1570

alt_interface_names.items()):

1085

1571

attr = {}

1086

1572

interface_names = set()

1087

1573

# Go though all attributes of the class

1089

1575

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

1090

1576

# with the wrong interface name

1091

1577

if (not hasattr(attribute, "_dbus_interface")

1092

or not attribute._dbus_interface

1093

.startswith(orig_interface_name)):

1578

or not attribute._dbus_interface.startswith(

1579

orig_interface_name)):

1094

1580

continue

1095

1581

# Create an alternate D-Bus interface name based on

1096

1582

# the current name

1097

alt_interface = (attribute._dbus_interface

1098

.replace(orig_interface_name,

1099

alt_interface_name))

1583

alt_interface = attribute._dbus_interface.replace(

1584

orig_interface_name, alt_interface_name)

1100

1585

interface_names.add(alt_interface)

1101

1586

# Is this a D-Bus signal?

1102

1587

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

1103

1588

# Extract the original non-method undecorated

1104

1589

# function by black magic

1105

nonmethod_func = (dict(

1590

if sys.version_info.major == 2:

1591

nonmethod_func = (dict(

1106

1592

zip(attribute.func_code.co_freevars,

1107

attribute.__closure__))["func"]

1108

.cell_contents)

1593

attribute.__closure__))

1594

["func"].cell_contents)

1595

else:

1596

nonmethod_func = (dict(

1597

zip(attribute.__code__.co_freevars,

1598

attribute.__closure__))

1599

["func"].cell_contents)

1109

1600

# Create a new, but exactly alike, function

1110

1601

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

1111

1602

# with the alternate D-Bus interface name

1112

new_function = (dbus.service.signal

1113

(alt_interface,

1114

attribute._dbus_signature)

1115

(types.FunctionType(

1116

nonmethod_func.func_code,

1117

nonmethod_func.func_globals,

1118

nonmethod_func.func_name,

1119

nonmethod_func.func_defaults,

1120

nonmethod_func.func_closure)))

1603

new_function = copy_function(nonmethod_func)

1604

new_function = (dbus.service.signal(

1605

alt_interface,

1606

attribute._dbus_signature)(new_function))

1121

1607

# Copy annotations, if any

1122

1608

try:

1123

new_function._dbus_annotations = (

1124

dict(attribute._dbus_annotations))

1609

new_function._dbus_annotations = dict(

1610

attribute._dbus_annotations)

1125

1611

except AttributeError:

1126

1612

pass

1613

1127

1614

# Define a creator of a function to call both the

1128

1615

# original and alternate functions, so both the

1129

1616

# original and alternate signals gets sent when

1132

1619

"""This function is a scope container to pass

1133

1620

func1 and func2 to the "call_both" function

1134

1621

outside of its arguments"""

1622

1623

@functools.wraps(func2)

1135

1624

def call_both(*args, **kwargs):

1136

1625

"""This function will emit two D-Bus

1137

1626

signals by calling func1 and func2"""

1138

1627

func1(*args, **kwargs)

1139

1628

func2(*args, **kwargs)

1629

# Make wrapper function look like a D-Bus

1630

# signal

1631

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

1632

if name.startswith("_dbus_"):

1633

setattr(call_both, name, attr)

1634

1140

1635

return call_both

1141

1636

# Create the "call_both" function and add it to

1142

1637

# the class

1147

1642

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

1148

1643

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

1149

1644

# to the class.

1150

attr[attrname] = (dbus.service.method

1151

(alt_interface,

1152

attribute._dbus_in_signature,

1153

attribute._dbus_out_signature)

1154

(types.FunctionType

1155

(attribute.func_code,

1156

attribute.func_globals,

1157

attribute.func_name,

1158

attribute.func_defaults,

1159

attribute.func_closure)))

1645

attr[attrname] = (

1646

dbus.service.method(

1647

alt_interface,

1648

attribute._dbus_in_signature,

1649

attribute._dbus_out_signature)

1650

(copy_function(attribute)))

1160

1651

# Copy annotations, if any

1161

1652

try:

1162

attr[attrname]._dbus_annotations = (

1163

dict(attribute._dbus_annotations))

1653

attr[attrname]._dbus_annotations = dict(

1654

attribute._dbus_annotations)

1164

1655

except AttributeError:

1165

1656

pass

1166

1657

# Is this a D-Bus property?

1169

1660

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

1170

1661

# property with the alternate D-Bus interface

1171

1662

# name. Add it to the class.

1172

attr[attrname] = (dbus_service_property

1173

(alt_interface,

1174

attribute._dbus_signature,

1175

attribute._dbus_access,

1176

attribute

1177

._dbus_get_args_options

1178

["byte_arrays"])

1179

(types.FunctionType

1180

(attribute.func_code,

1181

attribute.func_globals,

1182

attribute.func_name,

1183

attribute.func_defaults,

1184

attribute.func_closure)))

1663

attr[attrname] = (dbus_service_property(

1664

alt_interface, attribute._dbus_signature,

1665

attribute._dbus_access,

1666

attribute._dbus_get_args_options

1667

["byte_arrays"])

1668

(copy_function(attribute)))

1185

1669

# Copy annotations, if any

1186

1670

try:

1187

attr[attrname]._dbus_annotations = (

1188

dict(attribute._dbus_annotations))

1671

attr[attrname]._dbus_annotations = dict(

1672

attribute._dbus_annotations)

1189

1673

except AttributeError:

1190

1674

pass

1191

1675

# Is this a D-Bus interface?

1194

1678

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

1195

1679

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

1196

1680

# to the class.

1197

attr[attrname] = (dbus_interface_annotations

1198

(alt_interface)

1199

(types.FunctionType

1200

(attribute.func_code,

1201

attribute.func_globals,

1202

attribute.func_name,

1203

attribute.func_defaults,

1204

attribute.func_closure)))

1681

attr[attrname] = (

1682

dbus_interface_annotations(alt_interface)

1683

(copy_function(attribute)))

1205

1684

if deprecate:

1206

1685

# Deprecate all alternate interfaces

1207

iname="_AlternateDBusNames_interface_annotation{0}"

1686

iname = "_AlternateDBusNames_interface_annotation{}"

1208

1687

for interface_name in interface_names:

1688

1209

1689

@dbus_interface_annotations(interface_name)

1210

1690

def func(self):

1211

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

1212

"true" }

1691

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

1692

"true"}

1213

1693

# Find an unused name

1214

1694

for aname in (iname.format(i)

1215

1695

for i in itertools.count()):

1219

1699

if interface_names:

1220

1700

# Replace the class with a new subclass of it with

1221

1701

# methods, signals, etc. as created above.

1222

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

1223

(cls,), attr)

1702

if sys.version_info.major == 2:

1703

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

1704

(cls, ), attr)

1705

else:

1706

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

1707

(cls, ), attr)

1224

1708

return cls

1709

1225

1710

return wrapper

1226

1711

1227

1712

1228

1713

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

1229

"se.bsnet.fukt.Mandos"})

1714

"se.bsnet.fukt.Mandos"})

1230

1715

class ClientDBus(Client, DBusObjectWithProperties):

1231

1716

"""A Client class using D-Bus

1232

1717

1233

1718

Attributes:

1234

1719

dbus_object_path: dbus.ObjectPath

1235

1720

bus: dbus.SystemBus()

1236

1721

"""

1237

1722

1238

1723

runtime_expansions = (Client.runtime_expansions

1239

+ ("dbus_object_path",))

1240

1724

+ ("dbus_object_path", ))

1725

1726

_interface = "se.recompile.Mandos.Client"

1727

1241

1728

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

1242

1243

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

1729

1730

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

1244

1731

self.bus = bus

1245

1732

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

1246

1733

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

1247

1734

# the D-Bus

1248

client_object_name = unicode(self.name).translate(

1735

client_object_name = str(self.name).translate(

1249

1736

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

1250

1737

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

1251

self.dbus_object_path = (dbus.ObjectPath

1252

("/clients/" + client_object_name))

1738

self.dbus_object_path = dbus.ObjectPath(

1739

"/clients/" + client_object_name)

1253

1740

DBusObjectWithProperties.__init__(self, self.bus,

1254

1741

self.dbus_object_path)

1255

1256

def notifychangeproperty(transform_func,

1257

dbus_name, type_func=lambda x: x,

1258

variant_level=1):

1742

1743

def notifychangeproperty(transform_func, dbus_name,

1744

type_func=lambda x: x,

1745

variant_level=1,

1746

invalidate_only=False,

1747

_interface=_interface):

1259

1748

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

1260

1749

its changes to DBus.

1261

1750

1262

1751

transform_fun: Function that takes a value and a variant_level

1263

1752

and transforms it to a D-Bus type.

1264

1753

dbus_name: D-Bus name of the variable

1266

1755

to the D-Bus. Default: no transform

1267

1756

variant_level: D-Bus variant level. Default: 1

1268

1757

"""

1269

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

1758

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

1759

1270

1760

def setter(self, value):

1271

1761

if hasattr(self, "dbus_object_path"):

1272

1762

if (not hasattr(self, attrname) or

1273

1763

type_func(getattr(self, attrname, None))

1274

1764

!= type_func(value)):

1275

dbus_value = transform_func(type_func(value),

1276

variant_level

1277

=variant_level)

1278

self.PropertyChanged(dbus.String(dbus_name),

1279

dbus_value)

1765

if invalidate_only:

1766

self.PropertiesChanged(

1767

_interface, dbus.Dictionary(),

1768

dbus.Array((dbus_name, )))

1769

else:

1770

dbus_value = transform_func(

1771

type_func(value),

1772

variant_level=variant_level)

1773

self.PropertyChanged(dbus.String(dbus_name),

1774

dbus_value)

1775

self.PropertiesChanged(

1776

_interface,

1777

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

1778

dbus_value}),

1779

dbus.Array())

1280

1780

setattr(self, attrname, value)

1281

1781

1282

1782

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

1283

1783

1284

1784

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1285

1785

approvals_pending = notifychangeproperty(dbus.Boolean,

1286

1786

"ApprovalPending",

1287

type_func = bool)

1787

type_func=bool)

1288

1788

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

1289

1789

last_enabled = notifychangeproperty(datetime_to_dbus,

1290

1790

"LastEnabled")

1291

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

1292

type_func = lambda checker:

1293

checker is not None)

1791

checker = notifychangeproperty(

1792

dbus.Boolean, "CheckerRunning",

1793

type_func=lambda checker: checker is not None)

1294

1794

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1295

1795

"LastCheckedOK")

1296

1796

last_checker_status = notifychangeproperty(dbus.Int16,

1299

1799

datetime_to_dbus, "LastApprovalRequest")

1300

1800

approved_by_default = notifychangeproperty(dbus.Boolean,

1301

1801

"ApprovedByDefault")

1302

approval_delay = notifychangeproperty(dbus.UInt64,

1303

"ApprovalDelay",

1304

type_func =

1305

timedelta_to_milliseconds)

1802

approval_delay = notifychangeproperty(

1803

dbus.UInt64, "ApprovalDelay",

1804

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

1306

1805

approval_duration = notifychangeproperty(

1307

1806

dbus.UInt64, "ApprovalDuration",

1308

type_func = timedelta_to_milliseconds)

1807

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

1309

1808

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

1310

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

1311

type_func =

1312

timedelta_to_milliseconds)

1809

timeout = notifychangeproperty(

1810

dbus.UInt64, "Timeout",

1811

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

1313

1812

extended_timeout = notifychangeproperty(

1314

1813

dbus.UInt64, "ExtendedTimeout",

1315

type_func = timedelta_to_milliseconds)

1316

interval = notifychangeproperty(dbus.UInt64,

1317

"Interval",

1318

type_func =

1319

timedelta_to_milliseconds)

1814

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

1815

interval = notifychangeproperty(

1816

dbus.UInt64, "Interval",

1817

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

1320

1818

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

1321

1819

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

1820

invalidate_only=True)

1821

1322

1822

del notifychangeproperty

1323

1823

1324

1824

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

1325

1825

try:

1326

1826

self.remove_from_connection()

1329

1829

if hasattr(DBusObjectWithProperties, "__del__"):

1330

1830

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

1331

1831

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

1332

1333

def checker_callback(self, pid, condition, command,

1334

*args, **kwargs):

1335

self.checker_callback_tag = None

1336

self.checker = None

1337

if os.WIFEXITED(condition):

1338

exitstatus = os.WEXITSTATUS(condition)

1832

1833

def checker_callback(self, source, condition,

1834

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

1835

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

1836

connection, command, *args,

1837

**kwargs)

1838

exitstatus = self.last_checker_status

1839

if exitstatus >= 0:

1339

1840

# Emit D-Bus signal

1340

1841

self.CheckerCompleted(dbus.Int16(exitstatus),

1341

dbus.Int64(condition),

1842

# This is specific to GNU libC

1843

dbus.Int64(exitstatus << 8),

1342

1844

dbus.String(command))

1343

1845

else:

1344

1846

# Emit D-Bus signal

1345

1847

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

1346

dbus.Int64(condition),

1848

dbus.Int64(

1849

# This is specific to GNU libC

1850

(exitstatus << 8)

1851

| self.last_checker_signal),

1347

1852

dbus.String(command))

1348

1349

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

1350

*args, **kwargs)

1351

1853

return ret

1854

1352

1855

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

1353

old_checker = self.checker

1354

if self.checker is not None:

1355

old_checker_pid = self.checker.pid

1356

else:

1357

old_checker_pid = None

1856

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

1358

1857

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

1359

1858

# Only if new checker process was started

1360

1859

if (self.checker is not None

1362

1861

# Emit D-Bus signal

1363

1862

self.CheckerStarted(self.current_checker_command)

1364

1863

return r

1365

1864

1366

1865

def _reset_approved(self):

1367

1866

self.approved = None

1368

1867

return False

1369

1868

1370

1869

def approve(self, value=True):

1371

1870

self.approved = value

1372

gobject.timeout_add(timedelta_to_milliseconds

1373

(self.approval_duration),

1374

self._reset_approved)

1871

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

1872

* 1000), self._reset_approved)

1375

1873

self.send_changedstate()

1376

1377

## D-Bus methods, signals & properties

1378

_interface = "se.recompile.Mandos.Client"

1379

1380

## Interfaces

1381

1382

@dbus_interface_annotations(_interface)

1383

def _foo(self):

1384

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

1385

"false"}

1386

1387

## Signals

1388

1874

1875

# D-Bus methods, signals & properties

1876

1877

# Interfaces

1878

1879

# Signals

1880

1389

1881

# CheckerCompleted - signal

1390

1882

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

1391

1883

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

1392

1884

"D-Bus signal"

1393

1885

pass

1394

1886

1395

1887

# CheckerStarted - signal

1396

1888

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

1397

1889

def CheckerStarted(self, command):

1398

1890

"D-Bus signal"

1399

1891

pass

1400

1892

1401

1893

# PropertyChanged - signal

1894

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

1402

1895

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

1403

1896

def PropertyChanged(self, property, value):

1404

1897

"D-Bus signal"

1405

1898

pass

1406

1899

1407

1900

# GotSecret - signal

1408

1901

@dbus.service.signal(_interface)

1409

1902

def GotSecret(self):

1412

1905

server to mandos-client

1413

1906

"""

1414

1907

pass

1415

1908

1416

1909

# Rejected - signal

1417

1910

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

1418

1911

def Rejected(self, reason):

1419

1912

"D-Bus signal"

1420

1913

pass

1421

1914

1422

1915

# NeedApproval - signal

1423

1916

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

1424

1917

def NeedApproval(self, timeout, default):

1425

1918

"D-Bus signal"

1426

1919

return self.need_approval()

1427

1428

## Methods

1429

1920

1921

# Methods

1922

1430

1923

# Approve - method

1431

1924

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

1432

1925

def Approve(self, value):

1433

1926

self.approve(value)

1434

1927

1435

1928

# CheckedOK - method

1436

1929

@dbus.service.method(_interface)

1437

1930

def CheckedOK(self):

1438

1931

self.checked_ok()

1439

1932

1440

1933

# Enable - method

1934

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

1441

1935

@dbus.service.method(_interface)

1442

1936

def Enable(self):

1443

1937

"D-Bus method"

1444

1938

self.enable()

1445

1939

1446

1940

# StartChecker - method

1941

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

1447

1942

@dbus.service.method(_interface)

1448

1943

def StartChecker(self):

1449

1944

"D-Bus method"

1450

1945

self.start_checker()

1451

1946

1452

1947

# Disable - method

1948

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

1453

1949

@dbus.service.method(_interface)

1454

1950

def Disable(self):

1455

1951

"D-Bus method"

1456

1952

self.disable()

1457

1953

1458

1954

# StopChecker - method

1955

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

1459

1956

@dbus.service.method(_interface)

1460

1957

def StopChecker(self):

1461

1958

self.stop_checker()

1462

1463

## Properties

1464

1959

1960

# Properties

1961

1465

1962

# ApprovalPending - property

1466

1963

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

1467

1964

def ApprovalPending_dbus_property(self):

1468

1965

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

1469

1966

1470

1967

# ApprovedByDefault - property

1471

@dbus_service_property(_interface, signature="b",

1968

@dbus_service_property(_interface,

1969

signature="b",

1472

1970

access="readwrite")

1473

1971

def ApprovedByDefault_dbus_property(self, value=None):

1474

1972

if value is None: # get

1475

1973

return dbus.Boolean(self.approved_by_default)

1476

1974

self.approved_by_default = bool(value)

1477

1975

1478

1976

# ApprovalDelay - property

1479

@dbus_service_property(_interface, signature="t",

1977

@dbus_service_property(_interface,

1978

signature="t",

1480

1979

access="readwrite")

1481

1980

def ApprovalDelay_dbus_property(self, value=None):

1482

1981

if value is None: # get

1483

return dbus.UInt64(self.approval_delay_milliseconds())

1982

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

1983

* 1000)

1484

1984

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

1485

1985

1486

1986

# ApprovalDuration - property

1487

@dbus_service_property(_interface, signature="t",

1987

@dbus_service_property(_interface,

1988

signature="t",

1488

1989

access="readwrite")

1489

1990

def ApprovalDuration_dbus_property(self, value=None):

1490

1991

if value is None: # get

1491

return dbus.UInt64(timedelta_to_milliseconds(

1492

self.approval_duration))

1992

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

1993

* 1000)

1493

1994

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

1494

1995

1495

1996

# Name - property

1997

@dbus_annotations(

1998

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

1496

1999

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

1497

2000

def Name_dbus_property(self):

1498

2001

return dbus.String(self.name)

1499

2002

1500

2003

# Fingerprint - property

2004

@dbus_annotations(

2005

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

1501

2006

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

1502

2007

def Fingerprint_dbus_property(self):

1503

2008

return dbus.String(self.fingerprint)

1504

2009

1505

2010

# Host - property

1506

@dbus_service_property(_interface, signature="s",

2011

@dbus_service_property(_interface,

2012

signature="s",

1507

2013

access="readwrite")

1508

2014

def Host_dbus_property(self, value=None):

1509

2015

if value is None: # get

1510

2016

return dbus.String(self.host)

1511

self.host = unicode(value)

1512

2017

self.host = str(value)

2018

1513

2019

# Created - property

2020

@dbus_annotations(

2021

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

1514

2022

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

1515

2023

def Created_dbus_property(self):

1516

2024

return datetime_to_dbus(self.created)

1517

2025

1518

2026

# LastEnabled - property

1519

2027

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

1520

2028

def LastEnabled_dbus_property(self):

1521

2029

return datetime_to_dbus(self.last_enabled)

1522

2030

1523

2031

# Enabled - property

1524

@dbus_service_property(_interface, signature="b",

2032

@dbus_service_property(_interface,

2033

signature="b",

1525

2034

access="readwrite")

1526

2035

def Enabled_dbus_property(self, value=None):

1527

2036

if value is None: # get

1530

2039

self.enable()

1531

2040

else:

1532

2041

self.disable()

1533

2042

1534

2043

# LastCheckedOK - property

1535

@dbus_service_property(_interface, signature="s",

2044

@dbus_service_property(_interface,

2045

signature="s",

1536

2046

access="readwrite")

1537

2047

def LastCheckedOK_dbus_property(self, value=None):

1538

2048

if value is not None:

1539

2049

self.checked_ok()

1540

2050

return

1541

2051

return datetime_to_dbus(self.last_checked_ok)

1542

2052

1543

2053

# LastCheckerStatus - property

1544

@dbus_service_property(_interface, signature="n",

1545

access="read")

2054

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

1546

2055

def LastCheckerStatus_dbus_property(self):

1547

2056

return dbus.Int16(self.last_checker_status)

1548

2057

1549

2058

# Expires - property

1550

2059

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

1551

2060

def Expires_dbus_property(self):

1552

2061

return datetime_to_dbus(self.expires)

1553

2062

1554

2063

# LastApprovalRequest - property

1555

2064

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

1556

2065

def LastApprovalRequest_dbus_property(self):

1557

2066

return datetime_to_dbus(self.last_approval_request)

1558

2067

1559

2068

# Timeout - property

1560

@dbus_service_property(_interface, signature="t",

2069

@dbus_service_property(_interface,

2070

signature="t",

1561

2071

access="readwrite")

1562

2072

def Timeout_dbus_property(self, value=None):

1563

2073

if value is None: # get

1564

return dbus.UInt64(self.timeout_milliseconds())

2074

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

1565

2075

old_timeout = self.timeout

1566

2076

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

1567

2077

# Reschedule disabling

1575

2085

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

1576

2086

is None):

1577

2087

return

1578

gobject.source_remove(self.disable_initiator_tag)

1579

self.disable_initiator_tag = (

1580

gobject.timeout_add(

1581

timedelta_to_milliseconds(self.expires - now),

1582

self.disable))

1583

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

1584

2093

# ExtendedTimeout - property

1585

@dbus_service_property(_interface, signature="t",

2094

@dbus_service_property(_interface,

2095

signature="t",

1586

2096

access="readwrite")

1587

2097

def ExtendedTimeout_dbus_property(self, value=None):

1588

2098

if value is None: # get

1589

return dbus.UInt64(self.extended_timeout_milliseconds())

2099

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

2100

* 1000)

1590

2101

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

1591

2102

1592

2103

# Interval - property

1593

@dbus_service_property(_interface, signature="t",

2104

@dbus_service_property(_interface,

2105

signature="t",

1594

2106

access="readwrite")

1595

2107

def Interval_dbus_property(self, value=None):

1596

2108

if value is None: # get

1597

return dbus.UInt64(self.interval_milliseconds())

2109

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

1598

2110

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

1599

2111

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

1600

2112

return

1601

2113

if self.enabled:

1602

2114

# Reschedule checker run

1603

gobject.source_remove(self.checker_initiator_tag)

1604

self.checker_initiator_tag = (gobject.timeout_add

1605

(value, self.start_checker))

1606

self.start_checker() # Start one now, too

1607

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

1608

2120

# Checker - property

1609

@dbus_service_property(_interface, signature="s",

2121

@dbus_service_property(_interface,

2122

signature="s",

1610

2123

access="readwrite")

1611

2124

def Checker_dbus_property(self, value=None):

1612

2125

if value is None: # get

1613

2126

return dbus.String(self.checker_command)

1614

self.checker_command = unicode(value)

1615

2127

self.checker_command = str(value)

2128

1616

2129

# CheckerRunning - property

1617

@dbus_service_property(_interface, signature="b",

2130

@dbus_service_property(_interface,

2131

signature="b",

1618

2132

access="readwrite")

1619

2133

def CheckerRunning_dbus_property(self, value=None):

1620

2134

if value is None: # get

1623

2137

self.start_checker()

1624

2138

else:

1625

2139

self.stop_checker()

1626

2140

1627

2141

# ObjectPath - property

2142

@dbus_annotations(

2143

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

2144

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

1628

2145

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

1629

2146

def ObjectPath_dbus_property(self):

1630

return self.dbus_object_path # is already a dbus.ObjectPath

1631

2147

return self.dbus_object_path # is already a dbus.ObjectPath

2148

1632

2149

# Secret = property

1633

@dbus_service_property(_interface, signature="ay",

1634

access="write", byte_arrays=True)

2150

@dbus_annotations(

2151

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

2152

"invalidates"})

2153

@dbus_service_property(_interface,

2154

signature="ay",

2155

access="write",

2156

byte_arrays=True)

1635

2157

def Secret_dbus_property(self, value):

1636

self.secret = str(value)

1637

2158

self.secret = bytes(value)

2159

1638

2160

del _interface

1639

2161

1640

2162

1643

2165

self._pipe = child_pipe

1644

2166

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

1645

2167

if not self._pipe.recv():

1646

raise KeyError()

1647

2168

raise KeyError(fpr)

2169

1648

2170

def __getattribute__(self, name):

1649

2171

if name == '_pipe':

1650

2172

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

1653

2175

if data[0] == 'data':

1654

2176

return data[1]

1655

2177

if data[0] == 'function':

2178

1656

2179

def func(*args, **kwargs):

1657

2180

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

1658

2181

return self._pipe.recv()[1]

2182

1659

2183

return func

1660

2184

1661

2185

def __setattr__(self, name, value):

1662

2186

if name == '_pipe':

1663

2187

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

1666

2190

1667

2191

class ClientHandler(socketserver.BaseRequestHandler, object):

1668

2192

"""A class to handle client connections.

1669

2193

1670

2194

Instantiated once for each connection to handle it.

1671

2195

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

1672

2196

1673

2197

def handle(self):

1674

2198

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

1675

2199

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

1676

unicode(self.client_address))

2200

str(self.client_address))

1677

2201

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

1678

2202

self.server.child_pipe.fileno())

1679

1680

session = (gnutls.connection

1681

.ClientSession(self.request,

1682

gnutls.connection

1683

.X509Credentials()))

1684

1685

# Note: gnutls.connection.X509Credentials is really a

1686

# generic GnuTLS certificate credentials object so long as

1687

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

1688

# here despite using OpenPGP certificates.

1689

1690

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

1691

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

1692

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

1693

# "+DHE-DSS"))

2203

2204

session = gnutls.ClientSession(self.request)

2205

2206

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

2207

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

2208

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

2209

# "+DHE-DSS"))

1694

2210

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

1695

2211

priority = self.server.gnutls_priority

1696

2212

if priority is None:

1697

2213

priority = "NORMAL"

1698

(gnutls.library.functions

1699

.gnutls_priority_set_direct(session._c_object,

1700

priority, None))

1701

2214

gnutls.priority_set_direct(session._c_object,

2215

priority.encode("utf-8"),

2216

None)

2217

1702

2218

# Start communication using the Mandos protocol

1703

2219

# Get protocol number

1704

2220

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

1709

2225

except (ValueError, IndexError, RuntimeError) as error:

1710

2226

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

1711

2227

return

1712

2228

1713

2229

# Start GnuTLS connection

1714

2230

try:

1715

2231

session.handshake()

1716

except gnutls.errors.GNUTLSError as error:

2232

except gnutls.Error as error:

1717

2233

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

1718

2234

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

1719

2235

# established. Just abandon the request.

1720

2236

return

1721

2237

logger.debug("Handshake succeeded")

1722

2238

1723

2239

approval_required = False

1724

2240

try:

1725

2241

try:

1726

fpr = self.fingerprint(self.peer_certificate

1727

(session))

1728

except (TypeError,

1729

gnutls.errors.GNUTLSError) as error:

2242

fpr = self.fingerprint(

2243

self.peer_certificate(session))

2244

except (TypeError, gnutls.Error) as error:

1730

2245

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

1731

2246

return

1732

2247

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

1733

2248

1734

2249

try:

1735

2250

client = ProxyClient(child_pipe, fpr,

1736

2251

self.client_address)

1737

2252

except KeyError:

1738

2253

return

1739

2254

1740

2255

if client.approval_delay:

1741

2256

delay = client.approval_delay

1742

2257

client.approvals_pending += 1

1743

2258

approval_required = True

1744

2259

1745

2260

while True:

1746

2261

if not client.enabled:

1747

2262

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

1748

client.name)

2263

client.name)

1749

2264

if self.server.use_dbus:

1750

2265

# Emit D-Bus signal

1751

2266

client.Rejected("Disabled")

1752

2267

return

1753

2268

1754

2269

if client.approved or not client.approval_delay:

1755

#We are approved or approval is disabled

2270

# We are approved or approval is disabled

1756

2271

break

1757

2272

elif client.approved is None:

1758

2273

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

1760

2275

if self.server.use_dbus:

1761

2276

# Emit D-Bus signal

1762

2277

client.NeedApproval(

1763

client.approval_delay_milliseconds(),

1764

client.approved_by_default)

2278

client.approval_delay.total_seconds()

2279

* 1000, client.approved_by_default)

1765

2280

else:

1766

2281

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

1767

2282

client.name)

1769

2284

# Emit D-Bus signal

1770

2285

client.Rejected("Denied")

1771

2286

return

1772

1773

#wait until timeout or approved

2287

2288

# wait until timeout or approved

1774

2289

time = datetime.datetime.now()

1775

2290

client.changedstate.acquire()

1776

client.changedstate.wait(

1777

float(timedelta_to_milliseconds(delay)

1778

/ 1000))

2291

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

1779

2292

client.changedstate.release()

1780

2293

time2 = datetime.datetime.now()

1781

2294

if (time2 - time) >= delay:

1791

2304

break

1792

2305

else:

1793

2306

delay -= time2 - time

1794

1795

sent_size = 0

1796

while sent_size < len(client.secret):

1797

try:

1798

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

1799

except gnutls.errors.GNUTLSError as error:

1800

logger.warning("gnutls send failed",

1801

exc_info=error)

1802

return

1803

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

1804

sent, len(client.secret)

1805

- (sent_size + sent))

1806

sent_size += sent

1807

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

1808

2315

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

1809

2316

# bump the timeout using extended_timeout

1810

2317

client.bump_timeout(client.extended_timeout)

1811

2318

if self.server.use_dbus:

1812

2319

# Emit D-Bus signal

1813

2320

client.GotSecret()

1814

2321

1815

2322

finally:

1816

2323

if approval_required:

1817

2324

client.approvals_pending -= 1

1818

2325

try:

1819

2326

session.bye()

1820

except gnutls.errors.GNUTLSError as error:

2327

except gnutls.Error as error:

1821

2328

logger.warning("GnuTLS bye failed",

1822

2329

exc_info=error)

1823

2330

1824

2331

@staticmethod

1825

2332

def peer_certificate(session):

1826

2333

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

1827

2334

# If not an OpenPGP certificate...

1828

if (gnutls.library.functions

1829

.gnutls_certificate_type_get(session._c_object)

1830

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1831

# ...do the normal thing

1832

return session.peer_certificate

2335

if (gnutls.certificate_type_get(session._c_object)

2336

!= gnutls.CRT_OPENPGP):

2337

# ...return invalid data

2338

return b""

1833

2339

list_size = ctypes.c_uint(1)

1834

cert_list = (gnutls.library.functions

1835

.gnutls_certificate_get_peers

2340

cert_list = (gnutls.certificate_get_peers

1836

2341

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

1837

2342

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

1838

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

1839

" certificate")

2343

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

1840

2344

if list_size.value == 0:

1841

2345

return None

1842

2346

cert = cert_list[0]

1843

2347

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

1844

2348

1845

2349

@staticmethod

1846

2350

def fingerprint(openpgp):

1847

2351

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1848

2352

# New GnuTLS "datum" with the OpenPGP public key

1849

datum = (gnutls.library.types

1850

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

1851

ctypes.POINTER

1852

(ctypes.c_ubyte)),

1853

ctypes.c_uint(len(openpgp))))

2353

datum = gnutls.datum_t(

2354

ctypes.cast(ctypes.c_char_p(openpgp),

2355

ctypes.POINTER(ctypes.c_ubyte)),

2356

ctypes.c_uint(len(openpgp)))

1854

2357

# New empty GnuTLS certificate

1855

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2358

crt = gnutls.openpgp_crt_t()

2359

gnutls.openpgp_crt_init(ctypes.byref(crt))

1858

2360

# Import the OpenPGP public key into the certificate

1859

(gnutls.library.functions

1860

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

1861

gnutls.library.constants

1862

.GNUTLS_OPENPGP_FMT_RAW))

2361

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

2362

gnutls.OPENPGP_FMT_RAW)

1863

2363

# Verify the self signature in the key

1864

2364

crtverify = ctypes.c_uint()

1865

(gnutls.library.functions

1866

.gnutls_openpgp_crt_verify_self(crt, 0,

1867

ctypes.byref(crtverify)))

2365

gnutls.openpgp_crt_verify_self(crt, 0,

2366

ctypes.byref(crtverify))

1868

2367

if crtverify.value != 0:

1869

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1870

raise (gnutls.errors.CertificateSecurityError

1871

("Verify failed"))

2368

gnutls.openpgp_crt_deinit(crt)

2369

raise gnutls.CertificateSecurityError("Verify failed")

1872

2370

# New buffer for the fingerprint

1873

2371

buf = ctypes.create_string_buffer(20)

1874

2372

buf_len = ctypes.c_size_t()

1875

2373

# Get the fingerprint from the certificate into the buffer

1876

(gnutls.library.functions

1877

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

1878

ctypes.byref(buf_len)))

2374

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

2375

ctypes.byref(buf_len))

1879

2376

# Deinit the certificate

1880

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2377

gnutls.openpgp_crt_deinit(crt)

1881

2378

# Convert the buffer to a Python bytestring

1882

2379

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

1883

2380

# Convert the bytestring to hexadecimal notation

1887

2384

1888

2385

class MultiprocessingMixIn(object):

1889

2386

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

2387

1890

2388

def sub_process_main(self, request, address):

1891

2389

try:

1892

2390

self.finish_request(request, address)

1893

2391

except Exception:

1894

2392

self.handle_error(request, address)

1895

2393

self.close_request(request)

1896

2394

1897

2395

def process_request(self, request, address):

1898

2396

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

1899

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

1900

args = (request, address))

2397

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

2398

args=(request, address))

1901

2399

proc.start()

1902

2400

return proc

1903

2401

1904

2402

1905

2403

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1906

2404

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

2405

1907

2406

def process_request(self, request, client_address):

1908

2407

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

1909

2408

1910

2409

This function creates a new pipe in self.pipe

1911

2410

"""

1912

2411

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1913

2412

1914

2413

proc = MultiprocessingMixIn.process_request(self, request,

1915

2414

client_address)

1916

2415

self.child_pipe.close()

1917

2416

self.add_pipe(parent_pipe, proc)

1918

2417

1919

2418

def add_pipe(self, parent_pipe, proc):

1920

2419

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

1921

2420

raise NotImplementedError()

1924

2423

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1925

2424

socketserver.TCPServer, object):

1926

2425

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

1927

2426

1928

2427

Attributes:

1929

2428

enabled: Boolean; whether this server is activated yet

1930

2429

interface: None or a network interface name (string)

1931

2430

use_ipv6: Boolean; to use IPv6 or not

1932

2431

"""

2432

1933

2433

def __init__(self, server_address, RequestHandlerClass,

1934

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

2434

interface=None,

2435

use_ipv6=True,

2436

socketfd=None):

1935

2437

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

1936

2438

creating a new one with socket.socket().

1937

2439

"""

1943

2445

self.socketfd = socketfd

1944

2446

# Save the original socket.socket() function

1945

2447

self.socket_socket = socket.socket

2448

1946

2449

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

1947

#

2450

#

1948

2451

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

1949

2452

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

1950

2453

# patching socket.socket.)

1951

#

2454

#

1952

2455

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

1953

2456

@functools.wraps(socket.socket)

1954

2457

def socket_wrapper(*args, **kwargs):

1966

2469

# socket_wrapper(), if socketfd was set.

1967

2470

socketserver.TCPServer.__init__(self, server_address,

1968

2471

RequestHandlerClass)

1969

2472

1970

2473

def server_bind(self):

1971

2474

"""This overrides the normal server_bind() function

1972

2475

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

1973

2476

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

2477

global SO_BINDTODEVICE

1974

2478

if self.interface is not None:

1975

2479

if SO_BINDTODEVICE is None:

1976

logger.error("SO_BINDTODEVICE does not exist;"

1977

" cannot bind to interface %s",

1978

self.interface)

1979

else:

1980

try:

1981

self.socket.setsockopt(socket.SOL_SOCKET,

1982

SO_BINDTODEVICE,

1983

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

1984

except socket.error as error:

1985

if error.errno == errno.EPERM:

1986

logger.error("No permission to bind to"

1987

" interface %s", self.interface)

1988

elif error.errno == errno.ENOPROTOOPT:

1989

logger.error("SO_BINDTODEVICE not available;"

1990

" cannot bind to interface %s",

1991

self.interface)

1992

elif error.errno == errno.ENODEV:

1993

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

1994

" cannot bind", self.interface)

1995

else:

1996

raise

2480

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

2481

# common enough.

2482

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

2483

SO_BINDTODEVICE = 25

2484

try:

2485

self.socket.setsockopt(

2486

socket.SOL_SOCKET, SO_BINDTODEVICE,

2487

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

2488

except socket.error as error:

2489

if error.errno == errno.EPERM:

2490

logger.error("No permission to bind to"

2491

" interface %s", self.interface)

2492

elif error.errno == errno.ENOPROTOOPT:

2493

logger.error("SO_BINDTODEVICE not available;"

2494

" cannot bind to interface %s",

2495

self.interface)

2496

elif error.errno == errno.ENODEV:

2497

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

2498

" cannot bind", self.interface)

2499

else:

2500

raise

1997

2501

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

1998

2502

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

1999

2503

if not self.server_address[0]:

2000

2504

if self.address_family == socket.AF_INET6:

2001

any_address = "::" # in6addr_any

2505

any_address = "::" # in6addr_any

2002

2506

else:

2003

any_address = "0.0.0.0" # INADDR_ANY

2507

any_address = "0.0.0.0" # INADDR_ANY

2004

2508

self.server_address = (any_address,

2005

2509

self.server_address[1])

2006

2510

elif not self.server_address[1]:

2007

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

2008

0)

2511

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

2009

2512

# if self.interface:

2010

2513

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

2011

2514

# 0, # port

2017

2520

2018

2521

class MandosServer(IPv6_TCPServer):

2019

2522

"""Mandos server.

2020

2523

2021

2524

Attributes:

2022

2525

clients: set of Client objects

2023

2526

gnutls_priority GnuTLS priority string

2024

2527

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

2025

2026

Assumes a gobject.MainLoop event loop.

2528

2529

Assumes a GLib.MainLoop event loop.

2027

2530

"""

2531

2028

2532

def __init__(self, server_address, RequestHandlerClass,

2029

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

2030

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

2533

interface=None,

2534

use_ipv6=True,

2535

clients=None,

2536

gnutls_priority=None,

2537

use_dbus=True,

2538

socketfd=None):

2031

2539

self.enabled = False

2032

2540

self.clients = clients

2033

2541

if self.clients is None:

2036

2544

self.gnutls_priority = gnutls_priority

2037

2545

IPv6_TCPServer.__init__(self, server_address,

2038

2546

RequestHandlerClass,

2039

interface = interface,

2040

use_ipv6 = use_ipv6,

2041

socketfd = socketfd)

2547

interface=interface,

2548

use_ipv6=use_ipv6,

2549

socketfd=socketfd)

2550

2042

2551

def server_activate(self):

2043

2552

if self.enabled:

2044

2553

return socketserver.TCPServer.server_activate(self)

2045

2554

2046

2555

def enable(self):

2047

2556

self.enabled = True

2048

2557

2049

2558

def add_pipe(self, parent_pipe, proc):

2050

2559

# Call "handle_ipc" for both data and EOF events

2051

gobject.io_add_watch(parent_pipe.fileno(),

2052

gobject.IO_IN | gobject.IO_HUP,

2053

functools.partial(self.handle_ipc,

2054

parent_pipe =

2055

parent_pipe,

2056

proc = proc))

2057

2058

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

2059

proc = None, client_object=None):

2560

GLib.io_add_watch(

2561

parent_pipe.fileno(),

2562

GLib.IO_IN | GLib.IO_HUP,

2563

functools.partial(self.handle_ipc,

2564

parent_pipe=parent_pipe,

2565

proc=proc))

2566

2567

def handle_ipc(self, source, condition,

2568

parent_pipe=None,

2569

proc=None,

2570

client_object=None):

2060

2571

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

2061

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

2572

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

2062

2573

# Wait for other process to exit

2063

2574

proc.join()

2064

2575

return False

2065

2576

2066

2577

# Read a request from the child

2067

2578

request = parent_pipe.recv()

2068

2579

command = request[0]

2069

2580

2070

2581

if command == 'init':

2071

fpr = request[1]

2582

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

2072

2583

address = request[2]

2073

2074

for c in self.clients.itervalues():

2584

2585

for c in self.clients.values():

2075

2586

if c.fingerprint == fpr:

2076

2587

client = c

2077

2588

break

2084

2595

address[0])

2085

2596

parent_pipe.send(False)

2086

2597

return False

2087

2088

gobject.io_add_watch(parent_pipe.fileno(),

2089

gobject.IO_IN | gobject.IO_HUP,

2090

functools.partial(self.handle_ipc,

2091

parent_pipe =

2092

parent_pipe,

2093

proc = proc,

2094

client_object =

2095

client))

2598

2599

GLib.io_add_watch(

2600

parent_pipe.fileno(),

2601

GLib.IO_IN | GLib.IO_HUP,

2602

functools.partial(self.handle_ipc,

2603

parent_pipe=parent_pipe,

2604

proc=proc,

2605

client_object=client))

2096

2606

parent_pipe.send(True)

2097

2607

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

2098

2608

# same fileno

2101

2611

funcname = request[1]

2102

2612

args = request[2]

2103

2613

kwargs = request[3]

2104

2614

2105

2615

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

2106

2616

funcname)(*args,

2107

**kwargs)))

2108

2617

**kwargs)))

2618

2109

2619

if command == 'getattr':

2110

2620

attrname = request[1]

2111

if callable(client_object.__getattribute__(attrname)):

2112

parent_pipe.send(('function',))

2621

if isinstance(client_object.__getattribute__(attrname),

2622

collections.Callable):

2623

parent_pipe.send(('function', ))

2113

2624

else:

2114

parent_pipe.send(('data', client_object

2115

.__getattribute__(attrname)))

2116

2625

parent_pipe.send((

2626

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

2627

2117

2628

if command == 'setattr':

2118

2629

attrname = request[1]

2119

2630

value = request[2]

2120

2631

setattr(client_object, attrname, value)

2121

2632

2122

2633

return True

2123

2634

2124

2635

2125

2636

def rfc3339_duration_to_delta(duration):

2126

2637

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

2127

2638

2128

2639

>>> rfc3339_duration_to_delta("P7D")

2129

2640

datetime.timedelta(7)

2130

2641

>>> rfc3339_duration_to_delta("PT60S")

2140

2651

>>> rfc3339_duration_to_delta("P1DT3M20S")

2141

2652

datetime.timedelta(1, 200)

2142

2653

"""

2143

2654

2144

2655

# Parsing an RFC 3339 duration with regular expressions is not

2145

2656

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

2146

2657

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

2147

2658

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

2148

2659

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

2149

2660

# avoid excessive use of external libraries.

2150

2661

2151

2662

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

2152

Token = collections.namedtuple("Token",

2153

("regexp", # To match token; if

2154

# "value" is not None,

2155

# must have a "group"

2156

# containing digits

2157

"value", # datetime.timedelta or

2158

# None

2159

"followers")) # Tokens valid after

2160

# this token

2663

Token = collections.namedtuple("Token", (

2664

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

2665

# a "group" containing digits

2666

"value", # datetime.timedelta or None

2667

"followers")) # Tokens valid after this token

2161

2668

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

2162

2669

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

2163

2670

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

2164

2671

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

2165

2672

datetime.timedelta(seconds=1),

2166

frozenset((token_end,)))

2673

frozenset((token_end, )))

2167

2674

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

2168

2675

datetime.timedelta(minutes=1),

2169

2676

frozenset((token_second, token_end)))

2185

2692

frozenset((token_month, token_end)))

2186

2693

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

2187

2694

datetime.timedelta(weeks=1),

2188

frozenset((token_end,)))

2695

frozenset((token_end, )))

2189

2696

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

2190

2697

frozenset((token_year, token_month,

2191

2698

token_day, token_time,

2192

token_week))),

2193

# Define starting values

2194

value = datetime.timedelta() # Value so far

2699

token_week)))

2700

# Define starting values:

2701

# Value so far

2702

value = datetime.timedelta()

2195

2703

found_token = None

2196

followers = frozenset(token_duration,) # Following valid tokens

2197

s = duration # String left to parse

2704

# Following valid tokens

2705

followers = frozenset((token_duration, ))

2706

# String left to parse

2707

s = duration

2198

2708

# Loop until end token is found

2199

2709

while found_token is not token_end:

2200

2710

# Search for any currently valid tokens

2216

2726

break

2217

2727

else:

2218

2728

# No currently valid tokens were found

2219

raise ValueError("Invalid RFC 3339 duration")

2729

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

2730

.format(duration))

2220

2731

# End token found

2221

2732

return value

2222

2733

2223

2734

2224

2735

def string_to_delta(interval):

2225

2736

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

2226

2737

2227

2738

>>> string_to_delta('7d')

2228

2739

datetime.timedelta(7)

2229

2740

>>> string_to_delta('60s')

2237

2748

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

2238

2749

datetime.timedelta(0, 330)

2239

2750

"""

2240

2751

2241

2752

try:

2242

2753

return rfc3339_duration_to_delta(interval)

2243

2754

except ValueError:

2244

2755

pass

2245

2756

2246

2757

timevalue = datetime.timedelta(0)

2247

2758

for s in interval.split():

2248

2759

try:

2249

suffix = unicode(s[-1])

2760

suffix = s[-1]

2250

2761

value = int(s[:-1])

2251

2762

if suffix == "d":

2252

2763

delta = datetime.timedelta(value)

2259

2770

elif suffix == "w":

2260

2771

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

2261

2772

else:

2262

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

2263

.format(suffix))

2773

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

2264

2774

except IndexError as e:

2265

2775

raise ValueError(*(e.args))

2266

2776

timevalue += delta

2267

2777

return timevalue

2268

2778

2269

2779

2270

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

2780

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

2271

2781

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

2272

2782

2273

2783

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

2274

2784

if os.fork():

2275

2785

sys.exit()

2283

2793

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

2284

2794

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

2285

2795

raise OSError(errno.ENODEV,

2286

"{0} not a character device"

2796

"{} not a character device"

2287

2797

.format(os.devnull))

2288

2798

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

2289

2799

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

2293

2803

2294

2804

2295

2805

def main():

2296

2806

2297

2807

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

2298

2808

# Parsing of options, both command line and config file

2299

2809

2300

2810

parser = argparse.ArgumentParser()

2301

2811

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

2302

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

2812

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

2303

2813

help="show version number and exit")

2304

2814

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

2305

2815

help="Bind to interface IF")

2338

2848

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

2339

2849

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

2340

2850

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

2341

2851

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

2852

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

2853

default=None)

2854

2342

2855

options = parser.parse_args()

2343

2856

2344

2857

if options.check:

2345

2858

import doctest

2346

doctest.testmod()

2347

sys.exit()

2348

2859

fail_count, test_count = doctest.testmod()

2860

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

2861

2349

2862

# Default values for config file for server-global settings

2350

server_defaults = { "interface": "",

2351

"address": "",

2352

"port": "",

2353

"debug": "False",

2354

"priority":

2355

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

2356

"servicename": "Mandos",

2357

"use_dbus": "True",

2358

"use_ipv6": "True",

2359

"debuglevel": "",

2360

"restore": "True",

2361

"socket": "",

2362

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

2363

"foreground": "False",

2364

}

2365

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

2366

2881

# Parse config file for server-global settings

2367

2882

server_config = configparser.SafeConfigParser(server_defaults)

2368

2883

del server_defaults

2369

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

2370

"mandos.conf"))

2884

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

2371

2885

# Convert the SafeConfigParser object to a dict

2372

2886

server_settings = server_config.defaults()

2373

2887

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

2374

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

2888

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

2889

"foreground", "zeroconf"):

2375

2890

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

2376

2891

option)

2377

2892

if server_settings["port"]:

2387

2902

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

2388

2903

["socket"])

2389

2904

del server_config

2390

2905

2391

2906

# Override the settings from the config file with command line

2392

2907

# options, if set.

2393

2908

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

2394

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

2395

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

2396

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

2909

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

2910

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

2911

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

2397

2912

value = getattr(options, option)

2398

2913

if value is not None:

2399

2914

server_settings[option] = value

2400

2915

del options

2401

2916

# Force all strings to be unicode

2402

2917

for option in server_settings.keys():

2403

if type(server_settings[option]) is str:

2404

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

2918

if isinstance(server_settings[option], bytes):

2919

server_settings[option] = (server_settings[option]

2920

.decode("utf-8"))

2405

2921

# Force all boolean options to be boolean

2406

2922

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

2407

"foreground"):

2923

"foreground", "zeroconf"):

2408

2924

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

2409

2925

# Debug implies foreground

2410

2926

if server_settings["debug"]:

2411

2927

server_settings["foreground"] = True

2412

2928

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

2413

2929

2414

2930

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

2415

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

2416

2937

# For convenience

2417

2938

debug = server_settings["debug"]

2418

2939

debuglevel = server_settings["debuglevel"]

2421

2942

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

2422

2943

stored_state_file)

2423

2944

foreground = server_settings["foreground"]

2424

2945

zeroconf = server_settings["zeroconf"]

2946

2425

2947

if debug:

2426

2948

initlogger(debug, logging.DEBUG)

2427

2949

else:

2430

2952

else:

2431

2953

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

2432

2954

initlogger(debug, level)

2433

2955

2434

2956

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

2435

syslogger.setFormatter(logging.Formatter

2436

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

2437

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

2438

.format(server_settings

2439

["servicename"])))

2440

2957

syslogger.setFormatter(

2958

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

2959

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

2960

server_settings["servicename"])))

2961

2441

2962

# Parse config file with clients

2442

2963

client_config = configparser.SafeConfigParser(Client

2443

2964

.client_defaults)

2444

2965

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

2445

2966

"clients.conf"))

2446

2967

2447

2968

global mandos_dbus_service

2448

2969

mandos_dbus_service = None

2449

2450

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

2451

server_settings["port"]),

2452

ClientHandler,

2453

interface=(server_settings["interface"]

2454

or None),

2455

use_ipv6=use_ipv6,

2456

gnutls_priority=

2457

server_settings["priority"],

2458

use_dbus=use_dbus,

2459

socketfd=(server_settings["socket"]

2460

or None))

2970

2971

socketfd = None

2972

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

2973

socketfd = server_settings["socket"]

2974

tcp_server = MandosServer(

2975

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

2976

ClientHandler,

2977

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

2978

use_ipv6=use_ipv6,

2979

gnutls_priority=server_settings["priority"],

2980

use_dbus=use_dbus,

2981

socketfd=socketfd)

2461

2982

if not foreground:

2462

2983

pidfilename = "/run/mandos.pid"

2463

2984

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

2464

2985

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

2465

2986

pidfile = None

2466

2987

try:

2467

pidfile = open(pidfilename, "w")

2988

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

2468

2989

except IOError as e:

2469

2990

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

2470

2991

exc_info=e)

2471

2472

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

2992

2993

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

2994

("mandos", "mandos"),

2995

("nobody", "nogroup")):

2473

2996

try:

2474

2997

uid = pwd.getpwnam(name).pw_uid

2475

gid = pwd.getpwnam(name).pw_gid

2998

gid = pwd.getpwnam(group).pw_gid

2476

2999

break

2477

3000

except KeyError:

2478

3001

continue

2482

3005

try:

2483

3006

os.setgid(gid)

2484

3007

os.setuid(uid)

3008

if debug:

3009

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

3010

gid))

2485

3011

except OSError as error:

3012

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

3013

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

2486

3014

if error.errno != errno.EPERM:

2487

3015

raise

2488

3016

2489

3017

if debug:

2490

3018

# Enable all possible GnuTLS debugging

2491

3019

2492

3020

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

2493

3021

# - GnuTLS manual

2494

gnutls.library.functions.gnutls_global_set_log_level(11)

2495

2496

@gnutls.library.types.gnutls_log_func

3022

gnutls.global_set_log_level(11)

3023

3024

@gnutls.log_func

2497

3025

def debug_gnutls(level, string):

2498

3026

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

2499

2500

(gnutls.library.functions

2501

.gnutls_global_set_log_function(debug_gnutls))

2502

3027

3028

gnutls.global_set_log_function(debug_gnutls)

3029

2503

3030

# Redirect stdin so all checkers get /dev/null

2504

3031

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

2505

3032

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

2506

3033

if null > 2:

2507

3034

os.close(null)

2508

3035

2509

3036

# Need to fork before connecting to D-Bus

2510

3037

if not foreground:

2511

3038

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

2512

3039

daemon()

2513

2514

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

2515

# need to inform gobject that threads will be used.

2516

gobject.threads_init()

2517

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

2518

3045

global main_loop

2519

3046

# From the Avahi example code

2520

3047

DBusGMainLoop(set_as_default=True)

2521

main_loop = gobject.MainLoop()

3048

main_loop = GLib.MainLoop()

2522

3049

bus = dbus.SystemBus()

2523

3050

# End of Avahi example code

2524

3051

if use_dbus:

2525

3052

try:

2526

3053

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

2527

bus, do_not_queue=True)

2528

old_bus_name = (dbus.service.BusName

2529

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

2530

do_not_queue=True))

2531

except dbus.exceptions.NameExistsException as e:

3054

bus,

3055

do_not_queue=True)

3056

old_bus_name = dbus.service.BusName(

3057

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

3058

do_not_queue=True)

3059

except dbus.exceptions.DBusException as e:

2532

3060

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

2533

3061

use_dbus = False

2534

3062

server_settings["use_dbus"] = False

2535

3063

tcp_server.use_dbus = False

2536

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2537

service = AvahiServiceToSyslog(name =

2538

server_settings["servicename"],

2539

servicetype = "_mandos._tcp",

2540

protocol = protocol, bus = bus)

2541

if server_settings["interface"]:

2542

service.interface = (if_nametoindex

2543

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

2544

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

2545

3075

global multiprocessing_manager

2546

3076

multiprocessing_manager = multiprocessing.Manager()

2547

3077

2548

3078

client_class = Client

2549

3079

if use_dbus:

2550

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

2551

3080

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

3081

2552

3082

client_settings = Client.config_parser(client_config)

2553

3083

old_client_settings = {}

2554

3084

clients_data = {}

2555

3085

2556

3086

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

2557

3087

global wnull

2558

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

3088

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

2559

3089

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

2560

3090

# mode

2561

3091

if debug or not foreground:

2562

3092

wnull.close()

2563

3093

2564

3094

# Get client data and settings from last running state.

2565

3095

if server_settings["restore"]:

2566

3096

try:

2567

3097

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

2568

clients_data, old_client_settings = (pickle.load

2569

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

2570

3143

os.remove(stored_state_path)

2571

3144

except IOError as e:

2572

3145

if e.errno == errno.ENOENT:

2573

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

2574

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

3146

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

3147

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

2575

3148

else:

2576

3149

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

2577

3150

exc_info=e)

2578

3151

raise

2579

3152

except EOFError as e:

2580

3153

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

2581

"EOFError:", exc_info=e)

2582

3154

"EOFError:",

3155

exc_info=e)

3156

2583

3157

with PGPEngine() as pgp:

2584

for client_name, client in clients_data.iteritems():

3158

for client_name, client in clients_data.items():

2585

3159

# Skip removed clients

2586

3160

if client_name not in client_settings:

2587

3161

continue

2588

3162

2589

3163

# Decide which value to use after restoring saved state.

2590

3164

# We have three different values: Old config file,

2591

3165

# new config file, and saved state.

2596

3170

# For each value in new config, check if it

2597

3171

# differs from the old config value (Except for

2598

3172

# the "secret" attribute)

2599

if (name != "secret" and

2600

value != old_client_settings[client_name]

2601

[name]):

3173

if (name != "secret"

3174

and (value !=

3175

old_client_settings[client_name][name])):

2602

3176

client[name] = value

2603

3177

except KeyError:

2604

3178

pass

2605

3179

2606

3180

# Clients who has passed its expire date can still be

2607

# enabled if its last checker was successful. Clients

3181

# enabled if its last checker was successful. A Client

2608

3182

# whose checker succeeded before we stored its state is

2609

3183

# assumed to have successfully run all checkers during

2610

3184

# downtime.

2612

3186

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

2613

3187

if not client["last_checked_ok"]:

2614

3188

logger.warning(

2615

"disabling client {0} - Client never "

2616

"performed a successful checker"

2617

.format(client_name))

3189

"disabling client {} - Client never "

3190

"performed a successful checker".format(

3191

client_name))

2618

3192

client["enabled"] = False

2619

3193

elif client["last_checker_status"] != 0:

2620

3194

logger.warning(

2621

"disabling client {0} - Client "

2622

"last checker failed with error code {1}"

2623

.format(client_name,

2624

client["last_checker_status"]))

3195

"disabling client {} - Client last"

3196

" checker failed with error code"

3197

" {}".format(

3198

client_name,

3199

client["last_checker_status"]))

2625

3200

client["enabled"] = False

2626

3201

else:

2627

client["expires"] = (datetime.datetime

2628

.utcnow()

2629

+ client["timeout"])

3202

client["expires"] = (

3203

datetime.datetime.utcnow()

3204

+ client["timeout"])

2630

3205

logger.debug("Last checker succeeded,"

2631

" keeping {0} enabled"

2632

.format(client_name))

3206

" keeping {} enabled".format(

3207

client_name))

2633

3208

try:

2634

client["secret"] = (

2635

pgp.decrypt(client["encrypted_secret"],

2636

client_settings[client_name]

2637

["secret"]))

3209

client["secret"] = pgp.decrypt(

3210

client["encrypted_secret"],

3211

client_settings[client_name]["secret"])

2638

3212

except PGPError:

2639

3213

# If decryption fails, we use secret from new settings

2640

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

2641

.format(client_name))

2642

client["secret"] = (

2643

client_settings[client_name]["secret"])

2644

3214

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

3215

client_name))

3216

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

3217

["secret"])

3218

2645

3219

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

2646

3220

for client_name in (set(old_client_settings)

2647

3221

- set(client_settings)):

2649

3223

for client_name in (set(client_settings)

2650

3224

- set(old_client_settings)):

2651

3225

clients_data[client_name] = client_settings[client_name]

2652

3226

2653

3227

# Create all client objects

2654

for client_name, client in clients_data.iteritems():

3228

for client_name, client in clients_data.items():

2655

3229

tcp_server.clients[client_name] = client_class(

2656

name = client_name, settings = client,

2657

server_settings = server_settings)

2658

3230

name=client_name,

3231

settings=client,

3232

server_settings=server_settings)

3233

2659

3234

if not tcp_server.clients:

2660

3235

logger.warning("No clients defined")

2661

3236

2662

3237

if not foreground:

2663

3238

if pidfile is not None:

3239

pid = os.getpid()

2664

3240

try:

2665

3241

with pidfile:

2666

pid = os.getpid()

2667

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

3242

print(pid, file=pidfile)

2668

3243

except IOError:

2669

3244

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

2670

3245

pidfilename, pid)

2671

3246

del pidfile

2672

3247

del pidfilename

2673

2674

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

2675

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

2676

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

2677

3253

if use_dbus:

2678

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

2679

"se.bsnet.fukt.Mandos"})

2680

class MandosDBusService(DBusObjectWithProperties):

3254

3255

@alternate_dbus_interfaces(

3256

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

3257

class MandosDBusService(DBusObjectWithObjectManager):

2681

3258

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

3259

2682

3260

def __init__(self):

2683

3261

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

3262

2684

3263

_interface = "se.recompile.Mandos"

2685

2686

@dbus_interface_annotations(_interface)

2687

def _foo(self):

2688

return { "org.freedesktop.DBus.Property"

2689

".EmitsChangedSignal":

2690

"false"}

2691

3264

2692

3265

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

2693

3266

def ClientAdded(self, objpath):

2694

3267

"D-Bus signal"

2695

3268

pass

2696

3269

2697

3270

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

2698

3271

def ClientNotFound(self, fingerprint, address):

2699

3272

"D-Bus signal"

2700

3273

pass

2701

3274

3275

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

3276

"true"})

2702

3277

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

2703

3278

def ClientRemoved(self, objpath, name):

2704

3279

"D-Bus signal"

2705

3280

pass

2706

3281

3282

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

3283

"true"})

2707

3284

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

2708

3285

def GetAllClients(self):

2709

3286

"D-Bus method"

2710

return dbus.Array(c.dbus_object_path

2711

for c in

2712

tcp_server.clients.itervalues())

2713

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

2714

3292

@dbus.service.method(_interface,

2715

3293

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

2716

3294

def GetAllClientsWithProperties(self):

2717

3295

"D-Bus method"

2718

3296

return dbus.Dictionary(

2719

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

2720

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

3297

{c.dbus_object_path: c.GetAll(

3298

"se.recompile.Mandos.Client")

3299

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

2721

3300

signature="oa{sv}")

2722

3301

2723

3302

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

2724

3303

def RemoveClient(self, object_path):

2725

3304

"D-Bus method"

2726

for c in tcp_server.clients.itervalues():

3305

for c in tcp_server.clients.values():

2727

3306

if c.dbus_object_path == object_path:

2728

3307

del tcp_server.clients[c.name]

2729

3308

c.remove_from_connection()

2730

# Don't signal anything except ClientRemoved

3309

# Don't signal the disabling

2731

3310

c.disable(quiet=True)

2732

# Emit D-Bus signal

2733

self.ClientRemoved(object_path, c.name)

3311

# Emit D-Bus signal for removal

3312

self.client_removed_signal(c)

2734

3313

return

2735

3314

raise KeyError(object_path)

2736

3315

2737

3316

del _interface

2738

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

2739

3354

mandos_dbus_service = MandosDBusService()

2740

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

2741

3361

def cleanup():

2742

3362

"Cleanup function; run on exit"

2743

service.cleanup()

2744

2745

multiprocessing.active_children()

2746

wnull.close()

3363

if zeroconf:

3364

service.cleanup()

3365

3366

mp.active_children()

3367

wn.close()

2747

3368

if not (tcp_server.clients or client_settings):

2748

3369

return

2749

3370

2750

3371

# Store client before exiting. Secrets are encrypted with key

2751

3372

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

2752

3373

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

2753

3374

clients = {}

2754

3375

with PGPEngine() as pgp:

2755

for client in tcp_server.clients.itervalues():

3376

for client in tcp_server.clients.values():

2756

3377

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

2757

3378

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

2758

3379

key)

2759

3380

client_dict = {}

2760

3381

2761

3382

# A list of attributes that can not be pickled

2762

3383

# + secret.

2763

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

2764

"checker", "server_settings"))

2765

for name, typ in (inspect.getmembers

2766

(dbus.service.Object)):

3384

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

3385

"checker", "server_settings"}

3386

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

3387

.Object):

2767

3388

exclude.add(name)

2768

3389

2769

3390

client_dict["encrypted_secret"] = (client

2770

3391

.encrypted_secret)

2771

3392

for attr in client.client_structure:

2772

3393

if attr not in exclude:

2773

3394

client_dict[attr] = getattr(client, attr)

2774

3395

2775

3396

clients[client.name] = client_dict

2776

3397

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

2777

3398

2778

3399

try:

2779

with (tempfile.NamedTemporaryFile

2780

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

2781

dir=os.path.dirname(stored_state_path),

2782

delete=False)) as stored_state:

2783

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

2784

tempname=stored_state.name

3400

with tempfile.NamedTemporaryFile(

3401

mode='wb',

3402

suffix=".pickle",

3403

prefix='clients-',

3404

dir=os.path.dirname(stored_state_path),

3405

delete=False) as stored_state:

3406

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

3407

protocol=2)

3408

tempname = stored_state.name

2785

3409

os.rename(tempname, stored_state_path)

2786

3410

except (IOError, OSError) as e:

2787

3411

if not debug:

2790

3414

except NameError:

2791

3415

pass

2792

3416

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

2793

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

3417

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

2794

3418

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

2795

3419

else:

2796

3420

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

2797

3421

exc_info=e)

2798

3422

raise

2799

3423

2800

3424

# Delete all clients, and settings from config

2801

3425

while tcp_server.clients:

2802

3426

name, client = tcp_server.clients.popitem()

2803

3427

if use_dbus:

2804

3428

client.remove_from_connection()

2805

# Don't signal anything except ClientRemoved

3429

# Don't signal the disabling

2806

3430

client.disable(quiet=True)

3431

# Emit D-Bus signal for removal

2807

3432

if use_dbus:

2808

# Emit D-Bus signal

2809

mandos_dbus_service.ClientRemoved(client

2810

.dbus_object_path,

2811

client.name)

3433

mandos_dbus_service.client_removed_signal(client)

2812

3434

client_settings.clear()

2813

3435

2814

3436

atexit.register(cleanup)

2815

2816

for client in tcp_server.clients.itervalues():

3437

3438

for client in tcp_server.clients.values():

2817

3439

if use_dbus:

2818

# Emit D-Bus signal

2819

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3440

# Emit D-Bus signal for adding

3441

mandos_dbus_service.client_added_signal(client)

2820

3442

# Need to initiate checking of clients

2821

3443

if client.enabled:

2822

3444

client.init_checker()

2823

3445

2824

3446

tcp_server.enable()

2825

3447

tcp_server.server_activate()

2826

3448

2827

3449

# Find out what port we got

2828

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

3450

if zeroconf:

3451

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

2829

3452

if use_ipv6:

2830

3453

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

2831

3454

" flowinfo %d, scope_id %d",

2833

3456

else: # IPv4

2834

3457

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

2835

3458

*tcp_server.socket.getsockname())

2836

2837

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

2838

3459

3460

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

3461

2839

3462

try:

2840

# From the Avahi example code

2841

try:

2842

service.activate()

2843

except dbus.exceptions.DBusException as error:

2844

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

2845

cleanup()

2846

sys.exit(1)

2847

# End of Avahi example code

2848

2849

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

2850

lambda *args, **kwargs:

2851

(tcp_server.handle_request

2852

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

2853

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

2854

3478

logger.debug("Starting main loop")

2855

3479

main_loop.run()

2856

3480

except AvahiError as error:

2865

3489

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

2866

3490

cleanup()

2867

3491

3492

2868

3493

if __name__ == '__main__':

2869

3494

main()