/mandos/release : revision 237.7.502

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

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(*args, **kwargs)

500

syslogger.setFormatter(logging.Formatter(

501

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

502

.format(self.name)))

398

503

return ret

399

504

400

505

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

506

# Pretend that we have a GnuTLS module

507

class GnuTLS(object):

508

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

509

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

510

511

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

512

if library is None:

513

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

514

_library = ctypes.cdll.LoadLibrary(library)

515

del library

516

_need_version = b"3.3.0"

517

518

def __init__(self):

519

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

520

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

521

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

522

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

523

.format(self._need_version))

524

525

# Unless otherwise indicated, the constants and types below are

526

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

527

528

# Constants

529

E_SUCCESS = 0

530

E_INTERRUPTED = -52

531

E_AGAIN = -28

532

CRT_OPENPGP = 2

533

CLIENT = 2

534

SHUT_RDWR = 0

535

CRD_CERTIFICATE = 1

536

E_NO_CERTIFICATE_FOUND = -49

537

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

538

539

# Types

540

class session_int(ctypes.Structure):

541

_fields_ = []

542

session_t = ctypes.POINTER(session_int)

543

544

class certificate_credentials_st(ctypes.Structure):

545

_fields_ = []

546

certificate_credentials_t = ctypes.POINTER(

547

certificate_credentials_st)

548

certificate_type_t = ctypes.c_int

549

550

class datum_t(ctypes.Structure):

551

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

552

('size', ctypes.c_uint)]

553

554

class openpgp_crt_int(ctypes.Structure):

555

_fields_ = []

556

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

557

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

558

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

559

credentials_type_t = ctypes.c_int

560

transport_ptr_t = ctypes.c_void_p

561

close_request_t = ctypes.c_int

562

563

# Exceptions

564

class Error(Exception):

565

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

566

# exception might be raised from within GnuTLS.__init__,

567

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

568

# global variable has happened.

569

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

570

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

571

# code is passed, convert it to a string with

572

# gnutls.strerror()

573

self.code = code

574

if message is None and code is not None:

575

message = GnuTLS.strerror(code)

576

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

577

message, *args)

578

579

class CertificateSecurityError(Error):

580

pass

581

582

# Classes

583

class Credentials(object):

584

def __init__(self):

585

self._c_object = gnutls.certificate_credentials_t()

586

gnutls.certificate_allocate_credentials(

587

ctypes.byref(self._c_object))

588

self.type = gnutls.CRD_CERTIFICATE

589

590

def __del__(self):

591

gnutls.certificate_free_credentials(self._c_object)

592

593

class ClientSession(object):

594

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

595

self._c_object = gnutls.session_t()

596

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

597

gnutls.set_default_priority(self._c_object)

598

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

599

gnutls.handshake_set_private_extensions(self._c_object,

600

True)

601

self.socket = socket

602

if credentials is None:

603

credentials = gnutls.Credentials()

604

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

605

ctypes.cast(credentials._c_object,

606

ctypes.c_void_p))

607

self.credentials = credentials

608

609

def __del__(self):

610

gnutls.deinit(self._c_object)

611

612

def handshake(self):

613

return gnutls.handshake(self._c_object)

614

615

def send(self, data):

616

data = bytes(data)

617

data_len = len(data)

618

while data_len > 0:

619

data_len -= gnutls.record_send(self._c_object,

620

data[-data_len:],

621

data_len)

622

623

def bye(self):

624

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

625

626

# Error handling functions

627

def _error_code(result):

628

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

629

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

630

if result >= 0:

631

return result

632

if result == gnutls.E_NO_CERTIFICATE_FOUND:

633

raise gnutls.CertificateSecurityError(code=result)

634

raise gnutls.Error(code=result)

635

636

def _retry_on_error(result, func, arguments):

637

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

638

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

639

while result < 0:

640

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

641

return _error_code(result)

642

result = func(*arguments)

643

return result

644

645

# Unless otherwise indicated, the function declarations below are

646

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

647

648

# Functions

649

priority_set_direct = _library.gnutls_priority_set_direct

650

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

651

ctypes.POINTER(ctypes.c_char_p)]

652

priority_set_direct.restype = _error_code

653

654

init = _library.gnutls_init

655

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

656

init.restype = _error_code

657

658

set_default_priority = _library.gnutls_set_default_priority

659

set_default_priority.argtypes = [session_t]

660

set_default_priority.restype = _error_code

661

662

record_send = _library.gnutls_record_send

663

record_send.argtypes = [session_t, ctypes.c_void_p,

664

ctypes.c_size_t]

665

record_send.restype = ctypes.c_ssize_t

666

record_send.errcheck = _retry_on_error

667

668

certificate_allocate_credentials = (

669

_library.gnutls_certificate_allocate_credentials)

670

certificate_allocate_credentials.argtypes = [

671

ctypes.POINTER(certificate_credentials_t)]

672

certificate_allocate_credentials.restype = _error_code

673

674

certificate_free_credentials = (

675

_library.gnutls_certificate_free_credentials)

676

certificate_free_credentials.argtypes = [

677

certificate_credentials_t]

678

certificate_free_credentials.restype = None

679

680

handshake_set_private_extensions = (

681

_library.gnutls_handshake_set_private_extensions)

682

handshake_set_private_extensions.argtypes = [session_t,

683

ctypes.c_int]

684

handshake_set_private_extensions.restype = None

685

686

credentials_set = _library.gnutls_credentials_set

687

credentials_set.argtypes = [session_t, credentials_type_t,

688

ctypes.c_void_p]

689

credentials_set.restype = _error_code

690

691

strerror = _library.gnutls_strerror

692

strerror.argtypes = [ctypes.c_int]

693

strerror.restype = ctypes.c_char_p

694

695

certificate_type_get = _library.gnutls_certificate_type_get

696

certificate_type_get.argtypes = [session_t]

697

certificate_type_get.restype = _error_code

698

699

certificate_get_peers = _library.gnutls_certificate_get_peers

700

certificate_get_peers.argtypes = [session_t,

701

ctypes.POINTER(ctypes.c_uint)]

702

certificate_get_peers.restype = ctypes.POINTER(datum_t)

703

704

global_set_log_level = _library.gnutls_global_set_log_level

705

global_set_log_level.argtypes = [ctypes.c_int]

706

global_set_log_level.restype = None

707

708

global_set_log_function = _library.gnutls_global_set_log_function

709

global_set_log_function.argtypes = [log_func]

710

global_set_log_function.restype = None

711

712

deinit = _library.gnutls_deinit

713

deinit.argtypes = [session_t]

714

deinit.restype = None

715

716

handshake = _library.gnutls_handshake

717

handshake.argtypes = [session_t]

718

handshake.restype = _error_code

719

handshake.errcheck = _retry_on_error

720

721

transport_set_ptr = _library.gnutls_transport_set_ptr

722

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

723

transport_set_ptr.restype = None

724

725

bye = _library.gnutls_bye

726

bye.argtypes = [session_t, close_request_t]

727

bye.restype = _error_code

728

bye.errcheck = _retry_on_error

729

730

check_version = _library.gnutls_check_version

731

check_version.argtypes = [ctypes.c_char_p]

732

check_version.restype = ctypes.c_char_p

733

734

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

735

736

openpgp_crt_init = _library.gnutls_openpgp_crt_init

737

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

738

openpgp_crt_init.restype = _error_code

739

740

openpgp_crt_import = _library.gnutls_openpgp_crt_import

741

openpgp_crt_import.argtypes = [openpgp_crt_t,

742

ctypes.POINTER(datum_t),

743

openpgp_crt_fmt_t]

744

openpgp_crt_import.restype = _error_code

745

746

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

747

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

748

ctypes.POINTER(ctypes.c_uint)]

749

openpgp_crt_verify_self.restype = _error_code

750

751

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

752

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

753

openpgp_crt_deinit.restype = None

754

755

openpgp_crt_get_fingerprint = (

756

_library.gnutls_openpgp_crt_get_fingerprint)

757

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

758

ctypes.c_void_p,

759

ctypes.POINTER(

760

ctypes.c_size_t)]

761

openpgp_crt_get_fingerprint.restype = _error_code

762

763

# Remove non-public functions

764

del _error_code, _retry_on_error

765

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

766

gnutls = GnuTLS()

767

768

769

def call_pipe(connection, # : multiprocessing.Connection

770

func, *args, **kwargs):

771

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

772

773

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

774

return value on the provided multiprocessing.Connection.

775

"""

776

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

777

connection.close()

406

778

407

779

408

780

class Client(object):

409

781

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

410

782

411

783

Attributes:

412

784

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

413

785

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

415

787

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

416

788

to see if the client lives.

417

789

'None' if no process is running.

418

checker_callback_tag: a gobject event source tag, or None

790

checker_callback_tag: a GLib event source tag, or None

419

791

checker_command: string; External command which is run to check

420

792

if client lives. %() expansions are done at

421

793

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

422

794

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

423

checker_initiator_tag: a gobject event source tag, or None

795

checker_initiator_tag: a GLib event source tag, or None

424

796

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

425

797

client_structure: Object describing what attributes a client has

426

798

and is used for storing the client at exit

427

799

current_checker_command: string; current running checker_command

428

disable_initiator_tag: a gobject event source tag, or None

800

disable_initiator_tag: a GLib event source tag, or None

429

801

enabled: bool()

430

802

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

431

803

uniquely identify the client

436

808

last_checker_status: integer between 0 and 255 reflecting exit

437

809

status of last checker. -1 reflects crashed

438

810

checker, -2 means no checker completed yet.

811

last_checker_signal: The signal which killed the last checker, if

812

last_checker_status is -1

439

813

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

440

814

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

441

815

D-Bus identifiers

448

822

disabled, or None

449

823

server_settings: The server_settings dict from main()

450

824

"""

451

825

452

826

runtime_expansions = ("approval_delay", "approval_duration",

453

827

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

454

828

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

455

829

"last_approval_request", "last_checked_ok",

456

830

"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

831

client_defaults = {

832

"timeout": "PT5M",

833

"extended_timeout": "PT15M",

834

"interval": "PT2M",

835

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

836

"host": "",

837

"approval_delay": "PT0S",

838

"approval_duration": "PT1S",

839

"approved_by_default": "True",

840

"enabled": "True",

841

}

842

483

843

@staticmethod

484

844

def config_parser(config):

485

845

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

492

852

for client_name in config.sections():

493

853

section = dict(config.items(client_name))

494

854

client = settings[client_name] = {}

495

855

496

856

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

497

857

# Reformat values from string types to Python types

498

858

client["approved_by_default"] = config.getboolean(

499

859

client_name, "approved_by_default")

500

860

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

501

861

"enabled")

502

862

863

# Uppercase and remove spaces from fingerprint for later

864

# comparison purposes with return value from the

865

# fingerprint() function

503

866

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

504

867

.replace(" ", ""))

505

868

if "secret" in section:

506

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

869

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

870

.encode("utf-8"),

871

"base64")

507

872

elif "secfile" in section:

508

873

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

509

874

(section["secfile"])),

510

875

"rb") as secfile:

511

876

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

512

877

else:

513

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

878

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

514

879

.format(section))

515

880

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

516

881

client["extended_timeout"] = string_to_delta(

524

889

client["last_approval_request"] = None

525

890

client["last_checked_ok"] = None

526

891

client["last_checker_status"] = -2

527

892

528

893

return settings

529

530

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

894

895

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

531

896

self.name = name

532

897

if server_settings is None:

533

898

server_settings = {}

534

899

self.server_settings = server_settings

535

900

# adding all client settings

536

for setting, value in settings.iteritems():

901

for setting, value in settings.items():

537

902

setattr(self, setting, value)

538

903

539

904

if self.enabled:

540

905

if not hasattr(self, "last_enabled"):

541

906

self.last_enabled = datetime.datetime.utcnow()

545

910

else:

546

911

self.last_enabled = None

547

912

self.expires = None

548

913

549

914

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

915

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

554

916

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

555

917

datetime.datetime.utcnow())

556

918

557

919

# attributes specific for this server instance

558

920

self.checker = None

559

921

self.checker_initiator_tag = None

562

924

self.current_checker_command = None

563

925

self.approved = None

564

926

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

927

self.changedstate = multiprocessing_manager.Condition(

928

multiprocessing_manager.Lock())

929

self.client_structure = [attr

930

for attr in self.__dict__.keys()

570

931

if not attr.startswith("_")]

571

932

self.client_structure.append("client_structure")

572

573

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

574

lambda obj:

575

isinstance(obj,

576

property)):

933

934

for name, t in inspect.getmembers(

935

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

577

936

if not name.startswith("_"):

578

937

self.client_structure.append(name)

579

938

580

939

# Send notice to process children that client state has changed

581

940

def send_changedstate(self):

582

941

with self.changedstate:

583

942

self.changedstate.notify_all()

584

943

585

944

def enable(self):

586

945

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

587

946

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

592

951

self.last_enabled = datetime.datetime.utcnow()

593

952

self.init_checker()

594

953

self.send_changedstate()

595

954

596

955

def disable(self, quiet=True):

597

956

"""Disable this client."""

598

957

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

600

959

if not quiet:

601

960

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

602

961

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

603

gobject.source_remove(self.disable_initiator_tag)

962

GLib.source_remove(self.disable_initiator_tag)

604

963

self.disable_initiator_tag = None

605

964

self.expires = None

606

965

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

607

gobject.source_remove(self.checker_initiator_tag)

966

GLib.source_remove(self.checker_initiator_tag)

608

967

self.checker_initiator_tag = None

609

968

self.stop_checker()

610

969

self.enabled = False

611

970

if not quiet:

612

971

self.send_changedstate()

613

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

972

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

614

973

return False

615

974

616

975

def __del__(self):

617

976

self.disable()

618

977

619

978

def init_checker(self):

620

979

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

621

980

# and every interval from then on.

622

981

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

982

GLib.source_remove(self.checker_initiator_tag)

983

self.checker_initiator_tag = GLib.timeout_add(

984

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

985

self.start_checker)

627

986

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

628

987

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

988

GLib.source_remove(self.disable_initiator_tag)

989

self.disable_initiator_tag = GLib.timeout_add(

990

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

633

991

# Also start a new checker *right now*.

634

992

self.start_checker()

635

636

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

993

994

def checker_callback(self, source, condition, connection,

995

command):

637

996

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

638

997

self.checker_callback_tag = None

639

998

self.checker = None

640

if os.WIFEXITED(condition):

641

self.last_checker_status = os.WEXITSTATUS(condition)

999

# Read return code from connection (see call_pipe)

1000

returncode = connection.recv()

1001

connection.close()

1002

1003

if returncode >= 0:

1004

self.last_checker_status = returncode

1005

self.last_checker_signal = None

642

1006

if self.last_checker_status == 0:

643

1007

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

644

1008

vars(self))

645

1009

self.checked_ok()

646

1010

else:

647

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

648

vars(self))

1011

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

649

1012

else:

650

1013

self.last_checker_status = -1

1014

self.last_checker_signal = -returncode

651

1015

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

652

1016

vars(self))

653

1017

return False

1018

654

1019

def checked_ok(self):

655

1020

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

656

1021

self.last_checked_ok = datetime.datetime.utcnow()

657

1022

self.last_checker_status = 0

1023

self.last_checker_signal = None

658

1024

self.bump_timeout()

659

1025

660

1026

def bump_timeout(self, timeout=None):

661

1027

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

662

1028

if timeout is None:

663

1029

timeout = self.timeout

664

1030

if self.disable_initiator_tag is not None:

665

gobject.source_remove(self.disable_initiator_tag)

1031

GLib.source_remove(self.disable_initiator_tag)

666

1032

self.disable_initiator_tag = None

667

1033

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

668

self.disable_initiator_tag = (gobject.timeout_add

669

(timedelta_to_milliseconds

670

(timeout), self.disable))

1034

self.disable_initiator_tag = GLib.timeout_add(

1035

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

671

1036

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

672

1037

673

1038

def need_approval(self):

674

1039

self.last_approval_request = datetime.datetime.utcnow()

675

1040

676

1041

def start_checker(self):

677

1042

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

678

1043

679

1044

If a checker already exists, leave it running and do

680

1045

nothing."""

681

1046

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

686

1051

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

687

1052

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

688

1053

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

1054

1055

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

1056

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

1057

self.checker.join()

1058

self.checker = None

704

1059

# Start a new checker if needed

705

1060

if self.checker is None:

706

1061

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

1062

escaped_attrs = {

1063

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

1064

for attr in self.runtime_expansions}

711

1065

try:

712

1066

command = self.checker_command % escaped_attrs

713

1067

except TypeError as error:

714

1068

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

715

self.checker_command, exc_info=error)

716

return True # Try again later

1069

self.checker_command,

1070

exc_info=error)

1071

return True # Try again later

717

1072

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

1073

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

1074

self.name)

1075

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

1076

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

1077

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

1078

# always replaced by /dev/null.)

1079

# The exception is when not debugging but nevertheless

1080

# running in the foreground; use the previously

1081

# created wnull.

1082

popen_args = {"close_fds": True,

1083

"shell": True,

1084

"cwd": "/"}

1085

if (not self.server_settings["debug"]

1086

and self.server_settings["foreground"]):

1087

popen_args.update({"stdout": wnull,

1088

"stderr": wnull})

1089

pipe = multiprocessing.Pipe(duplex=False)

1090

self.checker = multiprocessing.Process(

1091

target=call_pipe,

1092

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

1093

kwargs=popen_args)

1094

self.checker.start()

1095

self.checker_callback_tag = GLib.io_add_watch(

1096

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

1097

self.checker_callback, pipe[0], command)

1098

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

760

1099

return True

761

1100

762

1101

def stop_checker(self):

763

1102

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

764

1103

if self.checker_callback_tag:

765

gobject.source_remove(self.checker_callback_tag)

1104

GLib.source_remove(self.checker_callback_tag)

766

1105

self.checker_callback_tag = None

767

1106

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

768

1107

return

769

1108

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

1109

self.checker.terminate()

778

1110

self.checker = None

779

1111

780

1112

781

def dbus_service_property(dbus_interface, signature="v",

782

access="readwrite", byte_arrays=False):

1113

def dbus_service_property(dbus_interface,

1114

signature="v",

1115

access="readwrite",

1116

byte_arrays=False):

783

1117

"""Decorators for marking methods of a DBusObjectWithProperties to

784

1118

become properties on the D-Bus.

785

1119

786

1120

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

787

1121

and with one argument by "Set".

788

1122

789

1123

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

790

1124

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

791

1125

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

794

1128

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

795

1129

if byte_arrays and signature != "ay":

796

1130

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

797

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

1131

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

1132

798

1133

def decorator(func):

799

1134

func._dbus_is_property = True

800

1135

func._dbus_interface = dbus_interface

803

1138

func._dbus_name = func.__name__

804

1139

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

805

1140

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

806

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1141

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

807

1142

return func

1143

808

1144

return decorator

809

1145

810

1146

811

1147

def dbus_interface_annotations(dbus_interface):

812

1148

"""Decorator for marking functions returning interface annotations

813

1149

814

1150

Usage:

815

1151

816

1152

@dbus_interface_annotations("org.example.Interface")

817

1153

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

818

1154

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

819

1155

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

820

1156

"false"}

821

1157

"""

1158

822

1159

def decorator(func):

823

1160

func._dbus_is_interface = True

824

1161

func._dbus_interface = dbus_interface

825

1162

func._dbus_name = dbus_interface

826

1163

return func

1164

827

1165

return decorator

828

1166

829

1167

830

1168

def dbus_annotations(annotations):

831

1169

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

832

1170

Usage:

833

1171

1172

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

1173

"org.freedesktop.DBus.Property."

1174

"EmitsChangedSignal": "false"})

834

1175

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

835

1176

access="r")

836

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

837

"org.freedesktop.DBus.Property."

838

"EmitsChangedSignal": "false"})

839

1177

def Property_dbus_property(self):

840

1178

return dbus.Boolean(False)

1179

1180

See also the DBusObjectWithAnnotations class.

841

1181

"""

1182

842

1183

def decorator(func):

843

1184

func._dbus_annotations = annotations

844

1185

return func

1186

845

1187

return decorator

846

1188

847

1189

848

1190

class DBusPropertyException(dbus.exceptions.DBusException):

849

1191

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

850

1192

"""

851

def __unicode__(self):

852

return unicode(str(self))

1193

pass

853

1194

854

1195

855

1196

class DBusPropertyAccessException(DBusPropertyException):

864

1205

pass

865

1206

866

1207

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.

1208

class DBusObjectWithAnnotations(dbus.service.Object):

1209

"""A D-Bus object with annotations.

1210

1211

Classes inheriting from this can use the dbus_annotations

1212

decorator to add annotations to methods or signals.

873

1213

"""

874

1214

875

1215

@staticmethod

876

1216

def _is_dbus_thing(thing):

877

1217

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

878

1218

879

1219

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

880

1220

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

881

1221

"""

882

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

1222

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

883

1223

False)

884

1224

885

1225

def _get_all_dbus_things(self, thing):

886

1226

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

887

1227

"""

888

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

889

name),

1228

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

890

1229

athing.__get__(self))

891

1230

for cls in self.__class__.__mro__

892

1231

for name, athing in

893

inspect.getmembers(cls,

894

self._is_dbus_thing(thing)))

895

1232

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

1233

1234

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1235

out_signature="s",

1236

path_keyword='object_path',

1237

connection_keyword='connection')

1238

def Introspect(self, object_path, connection):

1239

"""Overloading of standard D-Bus method.

1240

1241

Inserts annotation tags on methods and signals.

1242

"""

1243

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

1244

connection)

1245

try:

1246

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

1247

1248

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

1249

# Add annotation tags

1250

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

1251

for tag in if_tag.getElementsByTagName(typ):

1252

annots = dict()

1253

for name, prop in (self.

1254

_get_all_dbus_things(typ)):

1255

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

1256

and prop._dbus_interface

1257

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

1258

annots.update(getattr(

1259

prop, "_dbus_annotations", {}))

1260

for name, value in annots.items():

1261

ann_tag = document.createElement(

1262

"annotation")

1263

ann_tag.setAttribute("name", name)

1264

ann_tag.setAttribute("value", value)

1265

tag.appendChild(ann_tag)

1266

# Add interface annotation tags

1267

for annotation, value in dict(

1268

itertools.chain.from_iterable(

1269

annotations().items()

1270

for name, annotations

1271

in self._get_all_dbus_things("interface")

1272

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

1273

)).items():

1274

ann_tag = document.createElement("annotation")

1275

ann_tag.setAttribute("name", annotation)

1276

ann_tag.setAttribute("value", value)

1277

if_tag.appendChild(ann_tag)

1278

# Fix argument name for the Introspect method itself

1279

if (if_tag.getAttribute("name")

1280

== dbus.INTROSPECTABLE_IFACE):

1281

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

1282

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

1283

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

1284

if (arg.getAttribute("direction")

1285

== "out"):

1286

arg.setAttribute("name",

1287

"xml_data")

1288

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

1289

document.unlink()

1290

except (AttributeError, xml.dom.DOMException,

1291

xml.parsers.expat.ExpatError) as error:

1292

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

1293

exc_info=error)

1294

return xmlstring

1295

1296

1297

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1298

"""A D-Bus object with properties.

1299

1300

Classes inheriting from this can use the dbus_service_property

1301

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

1302

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

1303

"""

1304

896

1305

def _get_dbus_property(self, interface_name, property_name):

897

1306

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

898

1307

property with the specified name and interface.

899

1308

"""

900

for cls in self.__class__.__mro__:

901

for name, value in (inspect.getmembers

902

(cls,

903

self._is_dbus_thing("property"))):

1309

for cls in self.__class__.__mro__:

1310

for name, value in inspect.getmembers(

1311

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

904

1312

if (value._dbus_name == property_name

905

1313

and value._dbus_interface == interface_name):

906

1314

return value.__get__(self)

907

1315

908

1316

# 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",

1317

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

1318

self.dbus_object_path, interface_name, property_name))

1319

1320

@classmethod

1321

def _get_all_interface_names(cls):

1322

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

1323

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

1324

"_dbus_interface", None)

1325

for x in (inspect.getmro(cls))

1326

for attr in dir(x))

1327

if name is not None)

1328

1329

@dbus.service.method(dbus.PROPERTIES_IFACE,

1330

in_signature="ss",

914

1331

out_signature="v")

915

1332

def Get(self, interface_name, property_name):

916

1333

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

922

1339

if not hasattr(value, "variant_level"):

923

1340

return value

924

1341

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

925

1342

926

1343

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

927

1344

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

928

1345

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

935

1352

# signatures other than "ay".

936

1353

if prop._dbus_signature != "ay":

937

1354

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

938

"'ay' signature {0!r}"

1355

"'ay' signature {!r}"

939

1356

.format(prop._dbus_signature))

940

1357

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

941

1358

for byte in value))

942

1359

prop(value)

943

944

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

1360

1361

@dbus.service.method(dbus.PROPERTIES_IFACE,

1362

in_signature="s",

945

1363

out_signature="a{sv}")

946

1364

def GetAll(self, interface_name):

947

1365

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

948

1366

standard.

949

1367

950

1368

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

951

1369

"""

952

1370

properties = {}

962

1380

if not hasattr(value, "variant_level"):

963

1381

properties[name] = value

964

1382

continue

965

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

966

value.variant_level+1)

1383

properties[name] = type(value)(

1384

value, variant_level=value.variant_level + 1)

967

1385

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

968

1386

1387

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

1388

def PropertiesChanged(self, interface_name, changed_properties,

1389

invalidated_properties):

1390

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

1391

standard.

1392

"""

1393

pass

1394

969

1395

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

970

1396

out_signature="s",

971

1397

path_keyword='object_path',

972

1398

connection_keyword='connection')

973

1399

def Introspect(self, object_path, connection):

974

1400

"""Overloading of standard D-Bus method.

975

1401

976

1402

Inserts property tags and interface annotation tags.

977

1403

"""

978

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

979

connection)

1404

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1405

object_path,

1406

connection)

980

1407

try:

981

1408

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

1409

982

1410

def make_tag(document, name, prop):

983

1411

e = document.createElement("property")

984

1412

e.setAttribute("name", name)

985

1413

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

986

1414

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

987

1415

return e

1416

988

1417

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

989

1418

# Add property tags

990

1419

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

993

1422

if prop._dbus_interface

994

1423

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

995

1424

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)

1425

# Add annotation tags for properties

1426

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

1427

annots = dict()

1428

for name, prop in self._get_all_dbus_things(

1429

"property"):

1430

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

1431

and prop._dbus_interface

1432

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

1433

annots.update(getattr(

1434

prop, "_dbus_annotations", {}))

1435

for name, value in annots.items():

1436

ann_tag = document.createElement(

1437

"annotation")

1438

ann_tag.setAttribute("name", name)

1439

ann_tag.setAttribute("value", value)

1440

tag.appendChild(ann_tag)

1027

1441

# Add the names to the return values for the

1028

1442

# "org.freedesktop.DBus.Properties" methods

1029

1443

if (if_tag.getAttribute("name")

1048

1462

return xmlstring

1049

1463

1050

1464

1465

try:

1466

dbus.OBJECT_MANAGER_IFACE

1467

except AttributeError:

1468

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

1469

1470

1471

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1472

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

1473

1474

Classes inheriting from this exposes the standard

1475

GetManagedObjects call and the InterfacesAdded and

1476

InterfacesRemoved signals on the standard

1477

"org.freedesktop.DBus.ObjectManager" interface.

1478

1479

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

1480

manually.

1481

"""

1482

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1483

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

1484

def GetManagedObjects(self):

1485

"""This function must be overridden"""

1486

raise NotImplementedError()

1487

1488

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1489

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

1490

def InterfacesAdded(self, object_path, interfaces_and_properties):

1491

pass

1492

1493

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

1494

def InterfacesRemoved(self, object_path, interfaces):

1495

pass

1496

1497

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1498

out_signature="s",

1499

path_keyword='object_path',

1500

connection_keyword='connection')

1501

def Introspect(self, object_path, connection):

1502

"""Overloading of standard D-Bus method.

1503

1504

Override return argument name of GetManagedObjects to be

1505

"objpath_interfaces_and_properties"

1506

"""

1507

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1508

object_path,

1509

connection)

1510

try:

1511

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

1512

1513

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

1514

# Fix argument name for the GetManagedObjects method

1515

if (if_tag.getAttribute("name")

1516

== dbus.OBJECT_MANAGER_IFACE):

1517

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

1518

if (cn.getAttribute("name")

1519

== "GetManagedObjects"):

1520

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

1521

if (arg.getAttribute("direction")

1522

== "out"):

1523

arg.setAttribute(

1524

"name",

1525

"objpath_interfaces"

1526

"_and_properties")

1527

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

1528

document.unlink()

1529

except (AttributeError, xml.dom.DOMException,

1530

xml.parsers.expat.ExpatError) as error:

1531

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

1532

exc_info=error)

1533

return xmlstring

1534

1535

1051

1536

def datetime_to_dbus(dt, variant_level=0):

1052

1537

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

1053

1538

if dt is None:

1054

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

1055

return dbus.String(dt.isoformat(),

1056

variant_level=variant_level)

1539

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

1540

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

1057

1541

1058

1542

1059

1543

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1061

1545

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

1062

1546

interface names according to the "alt_interface_names" mapping.

1063

1547

Usage:

1064

1548

1065

1549

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

1066

1550

"net.example.AlternateInterface"})

1067

1551

class SampleDBusObject(dbus.service.Object):

1068

1552

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

1069

1553

def SampleDBusMethod():

1070

1554

pass

1071

1555

1072

1556

The above "SampleDBusMethod" on "SampleDBusObject" will be

1073

1557

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

1074

1558

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

1075

1559

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

1076

1560

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

1077

1561

1078

1562

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

1079

1563

(from DBusObjectWithProperties) and interfaces (from the

1080

1564

dbus_interface_annotations decorator).

1081

1565

"""

1566

1082

1567

def wrapper(cls):

1083

1568

for orig_interface_name, alt_interface_name in (

1084

alt_interface_names.iteritems()):

1569

alt_interface_names.items()):

1085

1570

attr = {}

1086

1571

interface_names = set()

1087

1572

# Go though all attributes of the class

1089

1574

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

1090

1575

# with the wrong interface name

1091

1576

if (not hasattr(attribute, "_dbus_interface")

1092

or not attribute._dbus_interface

1093

.startswith(orig_interface_name)):

1577

or not attribute._dbus_interface.startswith(

1578

orig_interface_name)):

1094

1579

continue

1095

1580

# Create an alternate D-Bus interface name based on

1096

1581

# the current name

1097

alt_interface = (attribute._dbus_interface

1098

.replace(orig_interface_name,

1099

alt_interface_name))

1582

alt_interface = attribute._dbus_interface.replace(

1583

orig_interface_name, alt_interface_name)

1100

1584

interface_names.add(alt_interface)

1101

1585

# Is this a D-Bus signal?

1102

1586

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

1103

1587

# Extract the original non-method undecorated

1104

1588

# function by black magic

1105

nonmethod_func = (dict(

1589

if sys.version_info.major == 2:

1590

nonmethod_func = (dict(

1106

1591

zip(attribute.func_code.co_freevars,

1107

attribute.__closure__))["func"]

1108

.cell_contents)

1592

attribute.__closure__))

1593

["func"].cell_contents)

1594

else:

1595

nonmethod_func = (dict(

1596

zip(attribute.__code__.co_freevars,

1597

attribute.__closure__))

1598

["func"].cell_contents)

1109

1599

# Create a new, but exactly alike, function

1110

1600

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

1111

1601

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

1602

new_function = copy_function(nonmethod_func)

1603

new_function = (dbus.service.signal(

1604

alt_interface,

1605

attribute._dbus_signature)(new_function))

1121

1606

# Copy annotations, if any

1122

1607

try:

1123

new_function._dbus_annotations = (

1124

dict(attribute._dbus_annotations))

1608

new_function._dbus_annotations = dict(

1609

attribute._dbus_annotations)

1125

1610

except AttributeError:

1126

1611

pass

1612

1127

1613

# Define a creator of a function to call both the

1128

1614

# original and alternate functions, so both the

1129

1615

# original and alternate signals gets sent when

1132

1618

"""This function is a scope container to pass

1133

1619

func1 and func2 to the "call_both" function

1134

1620

outside of its arguments"""

1621

1622

@functools.wraps(func2)

1135

1623

def call_both(*args, **kwargs):

1136

1624

"""This function will emit two D-Bus

1137

1625

signals by calling func1 and func2"""

1138

1626

func1(*args, **kwargs)

1139

1627

func2(*args, **kwargs)

1628

# Make wrapper function look like a D-Bus

1629

# signal

1630

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

1631

if name.startswith("_dbus_"):

1632

setattr(call_both, name, attr)

1633

1140

1634

return call_both

1141

1635

# Create the "call_both" function and add it to

1142

1636

# the class

1147

1641

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

1148

1642

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

1149

1643

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

1644

attr[attrname] = (

1645

dbus.service.method(

1646

alt_interface,

1647

attribute._dbus_in_signature,

1648

attribute._dbus_out_signature)

1649

(copy_function(attribute)))

1160

1650

# Copy annotations, if any

1161

1651

try:

1162

attr[attrname]._dbus_annotations = (

1163

dict(attribute._dbus_annotations))

1652

attr[attrname]._dbus_annotations = dict(

1653

attribute._dbus_annotations)

1164

1654

except AttributeError:

1165

1655

pass

1166

1656

# Is this a D-Bus property?

1169

1659

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

1170

1660

# property with the alternate D-Bus interface

1171

1661

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

1662

attr[attrname] = (dbus_service_property(

1663

alt_interface, attribute._dbus_signature,

1664

attribute._dbus_access,

1665

attribute._dbus_get_args_options

1666

["byte_arrays"])

1667

(copy_function(attribute)))

1185

1668

# Copy annotations, if any

1186

1669

try:

1187

attr[attrname]._dbus_annotations = (

1188

dict(attribute._dbus_annotations))

1670

attr[attrname]._dbus_annotations = dict(

1671

attribute._dbus_annotations)

1189

1672

except AttributeError:

1190

1673

pass

1191

1674

# Is this a D-Bus interface?

1194

1677

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

1195

1678

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

1196

1679

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

1680

attr[attrname] = (

1681

dbus_interface_annotations(alt_interface)

1682

(copy_function(attribute)))

1205

1683

if deprecate:

1206

1684

# Deprecate all alternate interfaces

1207

iname="_AlternateDBusNames_interface_annotation{0}"

1685

iname = "_AlternateDBusNames_interface_annotation{}"

1208

1686

for interface_name in interface_names:

1687

1209

1688

@dbus_interface_annotations(interface_name)

1210

1689

def func(self):

1211

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

1212

"true" }

1690

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

1691

"true"}

1213

1692

# Find an unused name

1214

1693

for aname in (iname.format(i)

1215

1694

for i in itertools.count()):

1219

1698

if interface_names:

1220

1699

# Replace the class with a new subclass of it with

1221

1700

# methods, signals, etc. as created above.

1222

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

1223

(cls,), attr)

1701

if sys.version_info.major == 2:

1702

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

1703

(cls, ), attr)

1704

else:

1705

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

1706

(cls, ), attr)

1224

1707

return cls

1708

1225

1709

return wrapper

1226

1710

1227

1711

1228

1712

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

1229

"se.bsnet.fukt.Mandos"})

1713

"se.bsnet.fukt.Mandos"})

1230

1714

class ClientDBus(Client, DBusObjectWithProperties):

1231

1715

"""A Client class using D-Bus

1232

1716

1233

1717

Attributes:

1234

1718

dbus_object_path: dbus.ObjectPath

1235

1719

bus: dbus.SystemBus()

1236

1720

"""

1237

1721

1238

1722

runtime_expansions = (Client.runtime_expansions

1239

+ ("dbus_object_path",))

1240

1723

+ ("dbus_object_path", ))

1724

1725

_interface = "se.recompile.Mandos.Client"

1726

1241

1727

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

1242

1243

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

1728

1729

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

1244

1730

self.bus = bus

1245

1731

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

1246

1732

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

1247

1733

# the D-Bus

1248

client_object_name = unicode(self.name).translate(

1734

client_object_name = str(self.name).translate(

1249

1735

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

1250

1736

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

1251

self.dbus_object_path = (dbus.ObjectPath

1252

("/clients/" + client_object_name))

1737

self.dbus_object_path = dbus.ObjectPath(

1738

"/clients/" + client_object_name)

1253

1739

DBusObjectWithProperties.__init__(self, self.bus,

1254

1740

self.dbus_object_path)

1255

1256

def notifychangeproperty(transform_func,

1257

dbus_name, type_func=lambda x: x,

1258

variant_level=1):

1741

1742

def notifychangeproperty(transform_func, dbus_name,

1743

type_func=lambda x: x,

1744

variant_level=1,

1745

invalidate_only=False,

1746

_interface=_interface):

1259

1747

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

1260

1748

its changes to DBus.

1261

1749

1262

1750

transform_fun: Function that takes a value and a variant_level

1263

1751

and transforms it to a D-Bus type.

1264

1752

dbus_name: D-Bus name of the variable

1266

1754

to the D-Bus. Default: no transform

1267

1755

variant_level: D-Bus variant level. Default: 1

1268

1756

"""

1269

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

1757

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

1758

1270

1759

def setter(self, value):

1271

1760

if hasattr(self, "dbus_object_path"):

1272

1761

if (not hasattr(self, attrname) or

1273

1762

type_func(getattr(self, attrname, None))

1274

1763

!= 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)

1764

if invalidate_only:

1765

self.PropertiesChanged(

1766

_interface, dbus.Dictionary(),

1767

dbus.Array((dbus_name, )))

1768

else:

1769

dbus_value = transform_func(

1770

type_func(value),

1771

variant_level=variant_level)

1772

self.PropertyChanged(dbus.String(dbus_name),

1773

dbus_value)

1774

self.PropertiesChanged(

1775

_interface,

1776

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

1777

dbus_value}),

1778

dbus.Array())

1280

1779

setattr(self, attrname, value)

1281

1780

1282

1781

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

1283

1782

1284

1783

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1285

1784

approvals_pending = notifychangeproperty(dbus.Boolean,

1286

1785

"ApprovalPending",

1287

type_func = bool)

1786

type_func=bool)

1288

1787

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

1289

1788

last_enabled = notifychangeproperty(datetime_to_dbus,

1290

1789

"LastEnabled")

1291

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

1292

type_func = lambda checker:

1293

checker is not None)

1790

checker = notifychangeproperty(

1791

dbus.Boolean, "CheckerRunning",

1792

type_func=lambda checker: checker is not None)

1294

1793

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1295

1794

"LastCheckedOK")

1296

1795

last_checker_status = notifychangeproperty(dbus.Int16,

1299

1798

datetime_to_dbus, "LastApprovalRequest")

1300

1799

approved_by_default = notifychangeproperty(dbus.Boolean,

1301

1800

"ApprovedByDefault")

1302

approval_delay = notifychangeproperty(dbus.UInt64,

1303

"ApprovalDelay",

1304

type_func =

1305

timedelta_to_milliseconds)

1801

approval_delay = notifychangeproperty(

1802

dbus.UInt64, "ApprovalDelay",

1803

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

1306

1804

approval_duration = notifychangeproperty(

1307

1805

dbus.UInt64, "ApprovalDuration",

1308

type_func = timedelta_to_milliseconds)

1806

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

1309

1807

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

1310

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

1311

type_func =

1312

timedelta_to_milliseconds)

1808

timeout = notifychangeproperty(

1809

dbus.UInt64, "Timeout",

1810

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

1313

1811

extended_timeout = notifychangeproperty(

1314

1812

dbus.UInt64, "ExtendedTimeout",

1315

type_func = timedelta_to_milliseconds)

1316

interval = notifychangeproperty(dbus.UInt64,

1317

"Interval",

1318

type_func =

1319

timedelta_to_milliseconds)

1813

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

1814

interval = notifychangeproperty(

1815

dbus.UInt64, "Interval",

1816

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

1320

1817

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

1321

1818

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

1819

invalidate_only=True)

1820

1322

1821

del notifychangeproperty

1323

1822

1324

1823

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

1325

1824

try:

1326

1825

self.remove_from_connection()

1329

1828

if hasattr(DBusObjectWithProperties, "__del__"):

1330

1829

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

1331

1830

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)

1831

1832

def checker_callback(self, source, condition,

1833

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

1834

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

1835

connection, command, *args,

1836

**kwargs)

1837

exitstatus = self.last_checker_status

1838

if exitstatus >= 0:

1339

1839

# Emit D-Bus signal

1340

1840

self.CheckerCompleted(dbus.Int16(exitstatus),

1341

dbus.Int64(condition),

1841

# This is specific to GNU libC

1842

dbus.Int64(exitstatus << 8),

1342

1843

dbus.String(command))

1343

1844

else:

1344

1845

# Emit D-Bus signal

1345

1846

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

1346

dbus.Int64(condition),

1847

dbus.Int64(

1848

# This is specific to GNU libC

1849

(exitstatus << 8)

1850

| self.last_checker_signal),

1347

1851

dbus.String(command))

1348

1349

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

1350

*args, **kwargs)

1351

1852

return ret

1853

1352

1854

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

1855

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

1358

1856

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

1359

1857

# Only if new checker process was started

1360

1858

if (self.checker is not None

1362

1860

# Emit D-Bus signal

1363

1861

self.CheckerStarted(self.current_checker_command)

1364

1862

return r

1365

1863

1366

1864

def _reset_approved(self):

1367

1865

self.approved = None

1368

1866

return False

1369

1867

1370

1868

def approve(self, value=True):

1371

1869

self.approved = value

1372

gobject.timeout_add(timedelta_to_milliseconds

1373

(self.approval_duration),

1374

self._reset_approved)

1870

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

1871

* 1000), self._reset_approved)

1375

1872

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

1873

1874

# D-Bus methods, signals & properties

1875

1876

# Interfaces

1877

1878

# Signals

1879

1389

1880

# CheckerCompleted - signal

1390

1881

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

1391

1882

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

1392

1883

"D-Bus signal"

1393

1884

pass

1394

1885

1395

1886

# CheckerStarted - signal

1396

1887

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

1397

1888

def CheckerStarted(self, command):

1398

1889

"D-Bus signal"

1399

1890

pass

1400

1891

1401

1892

# PropertyChanged - signal

1893

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

1402

1894

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

1403

1895

def PropertyChanged(self, property, value):

1404

1896

"D-Bus signal"

1405

1897

pass

1406

1898

1407

1899

# GotSecret - signal

1408

1900

@dbus.service.signal(_interface)

1409

1901

def GotSecret(self):

1412

1904

server to mandos-client

1413

1905

"""

1414

1906

pass

1415

1907

1416

1908

# Rejected - signal

1417

1909

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

1418

1910

def Rejected(self, reason):

1419

1911

"D-Bus signal"

1420

1912

pass

1421

1913

1422

1914

# NeedApproval - signal

1423

1915

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

1424

1916

def NeedApproval(self, timeout, default):

1425

1917

"D-Bus signal"

1426

1918

return self.need_approval()

1427

1428

## Methods

1429

1919

1920

# Methods

1921

1430

1922

# Approve - method

1431

1923

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

1432

1924

def Approve(self, value):

1433

1925

self.approve(value)

1434

1926

1435

1927

# CheckedOK - method

1436

1928

@dbus.service.method(_interface)

1437

1929

def CheckedOK(self):

1438

1930

self.checked_ok()

1439

1931

1440

1932

# Enable - method

1933

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

1441

1934

@dbus.service.method(_interface)

1442

1935

def Enable(self):

1443

1936

"D-Bus method"

1444

1937

self.enable()

1445

1938

1446

1939

# StartChecker - method

1940

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

1447

1941

@dbus.service.method(_interface)

1448

1942

def StartChecker(self):

1449

1943

"D-Bus method"

1450

1944

self.start_checker()

1451

1945

1452

1946

# Disable - method

1947

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

1453

1948

@dbus.service.method(_interface)

1454

1949

def Disable(self):

1455

1950

"D-Bus method"

1456

1951

self.disable()

1457

1952

1458

1953

# StopChecker - method

1954

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

1459

1955

@dbus.service.method(_interface)

1460

1956

def StopChecker(self):

1461

1957

self.stop_checker()

1462

1463

## Properties

1464

1958

1959

# Properties

1960

1465

1961

# ApprovalPending - property

1466

1962

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

1467

1963

def ApprovalPending_dbus_property(self):

1468

1964

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

1469

1965

1470

1966

# ApprovedByDefault - property

1471

@dbus_service_property(_interface, signature="b",

1967

@dbus_service_property(_interface,

1968

signature="b",

1472

1969

access="readwrite")

1473

1970

def ApprovedByDefault_dbus_property(self, value=None):

1474

1971

if value is None: # get

1475

1972

return dbus.Boolean(self.approved_by_default)

1476

1973

self.approved_by_default = bool(value)

1477

1974

1478

1975

# ApprovalDelay - property

1479

@dbus_service_property(_interface, signature="t",

1976

@dbus_service_property(_interface,

1977

signature="t",

1480

1978

access="readwrite")

1481

1979

def ApprovalDelay_dbus_property(self, value=None):

1482

1980

if value is None: # get

1483

return dbus.UInt64(self.approval_delay_milliseconds())

1981

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

1982

* 1000)

1484

1983

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

1485

1984

1486

1985

# ApprovalDuration - property

1487

@dbus_service_property(_interface, signature="t",

1986

@dbus_service_property(_interface,

1987

signature="t",

1488

1988

access="readwrite")

1489

1989

def ApprovalDuration_dbus_property(self, value=None):

1490

1990

if value is None: # get

1491

return dbus.UInt64(timedelta_to_milliseconds(

1492

self.approval_duration))

1991

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

1992

* 1000)

1493

1993

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

1494

1994

1495

1995

# Name - property

1996

@dbus_annotations(

1997

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

1496

1998

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

1497

1999

def Name_dbus_property(self):

1498

2000

return dbus.String(self.name)

1499

2001

1500

2002

# Fingerprint - property

2003

@dbus_annotations(

2004

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

1501

2005

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

1502

2006

def Fingerprint_dbus_property(self):

1503

2007

return dbus.String(self.fingerprint)

1504

2008

1505

2009

# Host - property

1506

@dbus_service_property(_interface, signature="s",

2010

@dbus_service_property(_interface,

2011

signature="s",

1507

2012

access="readwrite")

1508

2013

def Host_dbus_property(self, value=None):

1509

2014

if value is None: # get

1510

2015

return dbus.String(self.host)

1511

self.host = unicode(value)

1512

2016

self.host = str(value)

2017

1513

2018

# Created - property

2019

@dbus_annotations(

2020

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

1514

2021

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

1515

2022

def Created_dbus_property(self):

1516

2023

return datetime_to_dbus(self.created)

1517

2024

1518

2025

# LastEnabled - property

1519

2026

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

1520

2027

def LastEnabled_dbus_property(self):

1521

2028

return datetime_to_dbus(self.last_enabled)

1522

2029

1523

2030

# Enabled - property

1524

@dbus_service_property(_interface, signature="b",

2031

@dbus_service_property(_interface,

2032

signature="b",

1525

2033

access="readwrite")

1526

2034

def Enabled_dbus_property(self, value=None):

1527

2035

if value is None: # get

1530

2038

self.enable()

1531

2039

else:

1532

2040

self.disable()

1533

2041

1534

2042

# LastCheckedOK - property

1535

@dbus_service_property(_interface, signature="s",

2043

@dbus_service_property(_interface,

2044

signature="s",

1536

2045

access="readwrite")

1537

2046

def LastCheckedOK_dbus_property(self, value=None):

1538

2047

if value is not None:

1539

2048

self.checked_ok()

1540

2049

return

1541

2050

return datetime_to_dbus(self.last_checked_ok)

1542

2051

1543

2052

# LastCheckerStatus - property

1544

@dbus_service_property(_interface, signature="n",

1545

access="read")

2053

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

1546

2054

def LastCheckerStatus_dbus_property(self):

1547

2055

return dbus.Int16(self.last_checker_status)

1548

2056

1549

2057

# Expires - property

1550

2058

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

1551

2059

def Expires_dbus_property(self):

1552

2060

return datetime_to_dbus(self.expires)

1553

2061

1554

2062

# LastApprovalRequest - property

1555

2063

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

1556

2064

def LastApprovalRequest_dbus_property(self):

1557

2065

return datetime_to_dbus(self.last_approval_request)

1558

2066

1559

2067

# Timeout - property

1560

@dbus_service_property(_interface, signature="t",

2068

@dbus_service_property(_interface,

2069

signature="t",

1561

2070

access="readwrite")

1562

2071

def Timeout_dbus_property(self, value=None):

1563

2072

if value is None: # get

1564

return dbus.UInt64(self.timeout_milliseconds())

2073

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

1565

2074

old_timeout = self.timeout

1566

2075

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

1567

2076

# Reschedule disabling

1575

2084

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

1576

2085

is None):

1577

2086

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

2087

GLib.source_remove(self.disable_initiator_tag)

2088

self.disable_initiator_tag = GLib.timeout_add(

2089

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

2090

self.disable)

2091

1584

2092

# ExtendedTimeout - property

1585

@dbus_service_property(_interface, signature="t",

2093

@dbus_service_property(_interface,

2094

signature="t",

1586

2095

access="readwrite")

1587

2096

def ExtendedTimeout_dbus_property(self, value=None):

1588

2097

if value is None: # get

1589

return dbus.UInt64(self.extended_timeout_milliseconds())

2098

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

2099

* 1000)

1590

2100

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

1591

2101

1592

2102

# Interval - property

1593

@dbus_service_property(_interface, signature="t",

2103

@dbus_service_property(_interface,

2104

signature="t",

1594

2105

access="readwrite")

1595

2106

def Interval_dbus_property(self, value=None):

1596

2107

if value is None: # get

1597

return dbus.UInt64(self.interval_milliseconds())

2108

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

1598

2109

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

1599

2110

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

1600

2111

return

1601

2112

if self.enabled:

1602

2113

# 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

2114

GLib.source_remove(self.checker_initiator_tag)

2115

self.checker_initiator_tag = GLib.timeout_add(

2116

value, self.start_checker)

2117

self.start_checker() # Start one now, too

2118

1608

2119

# Checker - property

1609

@dbus_service_property(_interface, signature="s",

2120

@dbus_service_property(_interface,

2121

signature="s",

1610

2122

access="readwrite")

1611

2123

def Checker_dbus_property(self, value=None):

1612

2124

if value is None: # get

1613

2125

return dbus.String(self.checker_command)

1614

self.checker_command = unicode(value)

1615

2126

self.checker_command = str(value)

2127

1616

2128

# CheckerRunning - property

1617

@dbus_service_property(_interface, signature="b",

2129

@dbus_service_property(_interface,

2130

signature="b",

1618

2131

access="readwrite")

1619

2132

def CheckerRunning_dbus_property(self, value=None):

1620

2133

if value is None: # get

1623

2136

self.start_checker()

1624

2137

else:

1625

2138

self.stop_checker()

1626

2139

1627

2140

# ObjectPath - property

2141

@dbus_annotations(

2142

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

2143

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

1628

2144

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

1629

2145

def ObjectPath_dbus_property(self):

1630

return self.dbus_object_path # is already a dbus.ObjectPath

1631

2146

return self.dbus_object_path # is already a dbus.ObjectPath

2147

1632

2148

# Secret = property

1633

@dbus_service_property(_interface, signature="ay",

1634

access="write", byte_arrays=True)

2149

@dbus_annotations(

2150

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

2151

"invalidates"})

2152

@dbus_service_property(_interface,

2153

signature="ay",

2154

access="write",

2155

byte_arrays=True)

1635

2156

def Secret_dbus_property(self, value):

1636

self.secret = str(value)

1637

2157

self.secret = bytes(value)

2158

1638

2159

del _interface

1639

2160

1640

2161

1643

2164

self._pipe = child_pipe

1644

2165

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

1645

2166

if not self._pipe.recv():

1646

raise KeyError()

1647

2167

raise KeyError(fpr)

2168

1648

2169

def __getattribute__(self, name):

1649

2170

if name == '_pipe':

1650

2171

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

1653

2174

if data[0] == 'data':

1654

2175

return data[1]

1655

2176

if data[0] == 'function':

2177

1656

2178

def func(*args, **kwargs):

1657

2179

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

1658

2180

return self._pipe.recv()[1]

2181

1659

2182

return func

1660

2183

1661

2184

def __setattr__(self, name, value):

1662

2185

if name == '_pipe':

1663

2186

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

1666

2189

1667

2190

class ClientHandler(socketserver.BaseRequestHandler, object):

1668

2191

"""A class to handle client connections.

1669

2192

1670

2193

Instantiated once for each connection to handle it.

1671

2194

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

1672

2195

1673

2196

def handle(self):

1674

2197

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

1675

2198

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

1676

unicode(self.client_address))

2199

str(self.client_address))

1677

2200

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

1678

2201

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

2202

2203

session = gnutls.ClientSession(self.request)

2204

2205

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

2206

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

2207

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

2208

# "+DHE-DSS"))

1694

2209

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

1695

2210

priority = self.server.gnutls_priority

1696

2211

if priority is None:

1697

2212

priority = "NORMAL"

1698

(gnutls.library.functions

1699

.gnutls_priority_set_direct(session._c_object,

1700

priority, None))

1701

2213

gnutls.priority_set_direct(session._c_object,

2214

priority.encode("utf-8"),

2215

None)

2216

1702

2217

# Start communication using the Mandos protocol

1703

2218

# Get protocol number

1704

2219

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

1709

2224

except (ValueError, IndexError, RuntimeError) as error:

1710

2225

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

1711

2226

return

1712

2227

1713

2228

# Start GnuTLS connection

1714

2229

try:

1715

2230

session.handshake()

1716

except gnutls.errors.GNUTLSError as error:

2231

except gnutls.Error as error:

1717

2232

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

1718

2233

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

1719

2234

# established. Just abandon the request.

1720

2235

return

1721

2236

logger.debug("Handshake succeeded")

1722

2237

1723

2238

approval_required = False

1724

2239

try:

1725

2240

try:

1726

fpr = self.fingerprint(self.peer_certificate

1727

(session))

1728

except (TypeError,

1729

gnutls.errors.GNUTLSError) as error:

2241

fpr = self.fingerprint(

2242

self.peer_certificate(session))

2243

except (TypeError, gnutls.Error) as error:

1730

2244

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

1731

2245

return

1732

2246

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

1733

2247

1734

2248

try:

1735

2249

client = ProxyClient(child_pipe, fpr,

1736

2250

self.client_address)

1737

2251

except KeyError:

1738

2252

return

1739

2253

1740

2254

if client.approval_delay:

1741

2255

delay = client.approval_delay

1742

2256

client.approvals_pending += 1

1743

2257

approval_required = True

1744

2258

1745

2259

while True:

1746

2260

if not client.enabled:

1747

2261

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

1748

client.name)

2262

client.name)

1749

2263

if self.server.use_dbus:

1750

2264

# Emit D-Bus signal

1751

2265

client.Rejected("Disabled")

1752

2266

return

1753

2267

1754

2268

if client.approved or not client.approval_delay:

1755

#We are approved or approval is disabled

2269

# We are approved or approval is disabled

1756

2270

break

1757

2271

elif client.approved is None:

1758

2272

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

1760

2274

if self.server.use_dbus:

1761

2275

# Emit D-Bus signal

1762

2276

client.NeedApproval(

1763

client.approval_delay_milliseconds(),

1764

client.approved_by_default)

2277

client.approval_delay.total_seconds()

2278

* 1000, client.approved_by_default)

1765

2279

else:

1766

2280

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

1767

2281

client.name)

1769

2283

# Emit D-Bus signal

1770

2284

client.Rejected("Denied")

1771

2285

return

1772

1773

#wait until timeout or approved

2286

2287

# wait until timeout or approved

1774

2288

time = datetime.datetime.now()

1775

2289

client.changedstate.acquire()

1776

client.changedstate.wait(

1777

float(timedelta_to_milliseconds(delay)

1778

/ 1000))

2290

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

1779

2291

client.changedstate.release()

1780

2292

time2 = datetime.datetime.now()

1781

2293

if (time2 - time) >= delay:

1791

2303

break

1792

2304

else:

1793

2305

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

2306

2307

try:

2308

session.send(client.secret)

2309

except gnutls.Error as error:

2310

logger.warning("gnutls send failed",

2311

exc_info=error)

2312

return

2313

1808

2314

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

1809

2315

# bump the timeout using extended_timeout

1810

2316

client.bump_timeout(client.extended_timeout)

1811

2317

if self.server.use_dbus:

1812

2318

# Emit D-Bus signal

1813

2319

client.GotSecret()

1814

2320

1815

2321

finally:

1816

2322

if approval_required:

1817

2323

client.approvals_pending -= 1

1818

2324

try:

1819

2325

session.bye()

1820

except gnutls.errors.GNUTLSError as error:

2326

except gnutls.Error as error:

1821

2327

logger.warning("GnuTLS bye failed",

1822

2328

exc_info=error)

1823

2329

1824

2330

@staticmethod

1825

2331

def peer_certificate(session):

1826

2332

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

1827

2333

# 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

2334

if (gnutls.certificate_type_get(session._c_object)

2335

!= gnutls.CRT_OPENPGP):

2336

# ...return invalid data

2337

return b""

1833

2338

list_size = ctypes.c_uint(1)

1834

cert_list = (gnutls.library.functions

1835

.gnutls_certificate_get_peers

2339

cert_list = (gnutls.certificate_get_peers

1836

2340

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

1837

2341

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

1838

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

1839

" certificate")

2342

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

1840

2343

if list_size.value == 0:

1841

2344

return None

1842

2345

cert = cert_list[0]

1843

2346

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

1844

2347

1845

2348

@staticmethod

1846

2349

def fingerprint(openpgp):

1847

2350

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1848

2351

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

2352

datum = gnutls.datum_t(

2353

ctypes.cast(ctypes.c_char_p(openpgp),

2354

ctypes.POINTER(ctypes.c_ubyte)),

2355

ctypes.c_uint(len(openpgp)))

1854

2356

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

2357

crt = gnutls.openpgp_crt_t()

2358

gnutls.openpgp_crt_init(ctypes.byref(crt))

1858

2359

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

2360

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

2361

gnutls.OPENPGP_FMT_RAW)

1863

2362

# Verify the self signature in the key

1864

2363

crtverify = ctypes.c_uint()

1865

(gnutls.library.functions

1866

.gnutls_openpgp_crt_verify_self(crt, 0,

1867

ctypes.byref(crtverify)))

2364

gnutls.openpgp_crt_verify_self(crt, 0,

2365

ctypes.byref(crtverify))

1868

2366

if crtverify.value != 0:

1869

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1870

raise (gnutls.errors.CertificateSecurityError

1871

("Verify failed"))

2367

gnutls.openpgp_crt_deinit(crt)

2368

raise gnutls.CertificateSecurityError(code

2369

=crtverify.value)

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