/mandos/release : revision 237.7.475

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

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.7.16"

92

119

stored_state_file = "clients.pickle"

93

120

94

121

logger = logging.getLogger()

95

122

syslogger = None

96

123

97

124

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

101

127

except (OSError, AttributeError):

128

102

129

def if_nametoindex(interface):

103

130

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

104

131

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

105

132

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

106

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

134

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

135

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

111

136

return interface_index

112

137

113

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

114

155

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

115

156

"""init logger and add loglevel"""

116

157

117

158

global syslogger

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

122

162

syslogger.setFormatter(logging.Formatter

123

163

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

124

164

' %(message)s'))

125

165

logger.addHandler(syslogger)

126

166

127

167

if debug:

128

168

console = logging.StreamHandler()

129

169

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

141

181

142

182

class PGPEngine(object):

143

183

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

184

144

185

def __init__(self):

145

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

146

198

self.gnupgargs = ['--batch',

147

'--home', self.tempdir,

199

'--homedir', self.tempdir,

148

200

'--force-mdc',

149

'--quiet',

150

'--no-use-agent']

151

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

152

206

def __enter__(self):

153

207

return self

154

208

155

209

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

156

210

self._cleanup()

157

211

return False

158

212

159

213

def __del__(self):

160

214

self._cleanup()

161

215

162

216

def _cleanup(self):

163

217

if self.tempdir is not None:

164

218

# Delete contents of tempdir

165

219

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

166

topdown = False):

220

topdown=False):

167

221

for filename in files:

168

222

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

169

223

for dirname in dirs:

171

225

# Remove tempdir

172

226

os.rmdir(self.tempdir)

173

227

self.tempdir = None

174

228

175

229

def password_encode(self, password):

176

230

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

177

231

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

182

236

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

183

237

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

184

238

return encoded

185

239

186

240

def encrypt(self, data, password):

187

241

passphrase = self.password_encode(password)

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

190

244

passfile.write(passphrase)

191

245

passfile.flush()

192

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

246

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

193

247

'--passphrase-file',

194

248

passfile.name]

195

249

+ self.gnupgargs,

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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)

200

254

if proc.returncode != 0:

201

255

raise PGPError(err)

202

256

return ciphertext

203

257

204

258

def decrypt(self, data, password):

205

259

passphrase = self.password_encode(password)

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

208

262

passfile.write(passphrase)

209

263

passfile.flush()

210

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

264

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

211

265

'--passphrase-file',

212

266

passfile.name]

213

267

+ self.gnupgargs,

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

219

272

if proc.returncode != 0:

220

273

raise PGPError(err)

221

274

return decrypted_plaintext

222

275

223

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

224

304

class AvahiError(Exception):

225

305

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

226

306

self.value = value

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

307

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

308

**kwargs)

309

230

310

231

311

class AvahiServiceError(AvahiError):

232

312

pass

233

313

314

234

315

class AvahiGroupError(AvahiError):

235

316

pass

236

317

237

318

238

319

class AvahiService(object):

239

320

"""An Avahi (Zeroconf) service.

240

321

241

322

Attributes:

242

323

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

243

324

Used to optionally bind to the specified interface.

255

336

server: D-Bus Server

256

337

bus: dbus.SystemBus()

257

338

"""

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

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

263

351

self.interface = interface

264

352

self.name = name

265

353

self.type = servicetype

274

362

self.server = None

275

363

self.bus = bus

276

364

self.entry_group_state_changed_match = None

277

278

def rename(self):

365

366

def rename(self, remove=True):

279

367

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

280

368

if self.rename_count >= self.max_renames:

281

369

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

282

370

" after %i retries, exiting.",

283

371

self.rename_count)

284

372

raise AvahiServiceError("Too many renames")

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

287

376

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

288

377

self.name)

289

self.remove()

378

if remove:

379

self.remove()

290

380

try:

291

381

self.add()

292

382

except dbus.exceptions.DBusException as error:

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

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

298

392

def remove(self):

299

393

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

300

394

if self.entry_group_state_changed_match is not None:

302

396

self.entry_group_state_changed_match = None

303

397

if self.group is not None:

304

398

self.group.Reset()

305

399

306

400

def add(self):

307

401

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

308

402

self.remove()

325

419

dbus.UInt16(self.port),

326

420

avahi.string_array_to_txt_array(self.TXT))

327

421

self.group.Commit()

328

422

329

423

def entry_group_state_changed(self, state, error):

330

424

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

331

425

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

332

426

333

427

if state == avahi.ENTRY_GROUP_ESTABLISHED:

334

428

logger.debug("Zeroconf service established.")

335

429

elif state == avahi.ENTRY_GROUP_COLLISION:

337

431

self.rename()

338

432

elif state == avahi.ENTRY_GROUP_FAILURE:

339

433

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

340

unicode(error))

341

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

342

.format(error))

343

434

str(error))

435

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

436

344

437

def cleanup(self):

345

438

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

346

439

if self.group is not None:

351

444

pass

352

445

self.group = None

353

446

self.remove()

354

447

355

448

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

356

449

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

357

450

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

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"Zeroconf server failure" }

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

}

365

457

if state in bad_states:

366

458

if bad_states[state] is not None:

367

459

if error is None:

370

462

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

371

463

self.cleanup()

372

464

elif state == avahi.SERVER_RUNNING:

373

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)

374

477

else:

375

478

if error is None:

376

479

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

377

480

else:

378

481

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

379

482

380

483

def activate(self):

381

484

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

382

485

if self.server is None:

386

489

follow_name_owner_changes=True),

387

490

avahi.DBUS_INTERFACE_SERVER)

388

491

self.server.connect_to_signal("StateChanged",

389

self.server_state_changed)

492

self.server_state_changed)

390

493

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

391

494

392

495

393

496

class AvahiServiceToSyslog(AvahiService):

394

def rename(self):

497

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

395

498

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

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

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

401

503

return ret

402

504

403

505

404

def timedelta_to_milliseconds(td):

405

"Convert a datetime.timedelta() to milliseconds"

406

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

407

+ (td.seconds * 1000)

408

+ (td.microseconds // 1000))

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

409

778

410

779

411

780

class Client(object):

412

781

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

413

782

414

783

Attributes:

415

784

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

416

785

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

418

787

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

419

788

to see if the client lives.

420

789

'None' if no process is running.

421

checker_callback_tag: a gobject event source tag, or None

790

checker_callback_tag: a GLib event source tag, or None

422

791

checker_command: string; External command which is run to check

423

792

if client lives. %() expansions are done at

424

793

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

425

794

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

426

checker_initiator_tag: a gobject event source tag, or None

795

checker_initiator_tag: a GLib event source tag, or None

427

796

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

428

797

client_structure: Object describing what attributes a client has

429

798

and is used for storing the client at exit

430

799

current_checker_command: string; current running checker_command

431

disable_initiator_tag: a gobject event source tag, or None

800

disable_initiator_tag: a GLib event source tag, or None

432

801

enabled: bool()

433

802

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

434

803

uniquely identify the client

439

808

last_checker_status: integer between 0 and 255 reflecting exit

440

809

status of last checker. -1 reflects crashed

441

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

442

813

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

443

814

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

444

815

D-Bus identifiers

451

822

disabled, or None

452

823

server_settings: The server_settings dict from main()

453

824

"""

454

825

455

826

runtime_expansions = ("approval_delay", "approval_duration",

456

827

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

457

828

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

458

829

"last_approval_request", "last_checked_ok",

459

830

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

460

client_defaults = { "timeout": "PT5M",

461

"extended_timeout": "PT15M",

462

"interval": "PT2M",

463

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

464

"host": "",

465

"approval_delay": "PT0S",

466

"approval_duration": "PT1S",

467

"approved_by_default": "True",

468

"enabled": "True",

469

}

470

471

def timeout_milliseconds(self):

472

"Return the 'timeout' attribute in milliseconds"

473

return timedelta_to_milliseconds(self.timeout)

474

475

def extended_timeout_milliseconds(self):

476

"Return the 'extended_timeout' attribute in milliseconds"

477

return timedelta_to_milliseconds(self.extended_timeout)

478

479

def interval_milliseconds(self):

480

"Return the 'interval' attribute in milliseconds"

481

return timedelta_to_milliseconds(self.interval)

482

483

def approval_delay_milliseconds(self):

484

return timedelta_to_milliseconds(self.approval_delay)

485

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

486

843

@staticmethod

487

844

def config_parser(config):

488

845

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

495

852

for client_name in config.sections():

496

853

section = dict(config.items(client_name))

497

854

client = settings[client_name] = {}

498

855

499

856

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

500

857

# Reformat values from string types to Python types

501

858

client["approved_by_default"] = config.getboolean(

502

859

client_name, "approved_by_default")

503

860

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

504

861

"enabled")

505

862

863

# Uppercase and remove spaces from fingerprint for later

864

# comparison purposes with return value from the

865

# fingerprint() function

506

866

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

507

867

.replace(" ", ""))

508

868

if "secret" in section:

509

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

869

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

870

.encode("utf-8"),

871

"base64")

510

872

elif "secfile" in section:

511

873

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

512

874

(section["secfile"])),

513

875

"rb") as secfile:

514

876

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

515

877

else:

516

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

878

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

517

879

.format(section))

518

880

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

519

881

client["extended_timeout"] = string_to_delta(

527

889

client["last_approval_request"] = None

528

890

client["last_checked_ok"] = None

529

891

client["last_checker_status"] = -2

530

892

531

893

return settings

532

533

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

894

895

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

534

896

self.name = name

535

897

if server_settings is None:

536

898

server_settings = {}

537

899

self.server_settings = server_settings

538

900

# adding all client settings

539

for setting, value in settings.iteritems():

901

for setting, value in settings.items():

540

902

setattr(self, setting, value)

541

903

542

904

if self.enabled:

543

905

if not hasattr(self, "last_enabled"):

544

906

self.last_enabled = datetime.datetime.utcnow()

548

910

else:

549

911

self.last_enabled = None

550

912

self.expires = None

551

913

552

914

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

553

# Uppercase and remove spaces from fingerprint for later

554

# comparison purposes with return value from the fingerprint()

555

# function

556

915

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

557

916

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

558

917

datetime.datetime.utcnow())

559

918

560

919

# attributes specific for this server instance

561

920

self.checker = None

562

921

self.checker_initiator_tag = None

565

924

self.current_checker_command = None

566

925

self.approved = None

567

926

self.approvals_pending = 0

568

self.changedstate = (multiprocessing_manager

569

.Condition(multiprocessing_manager

570

.Lock()))

571

self.client_structure = [attr for attr in

572

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

573

931

if not attr.startswith("_")]

574

932

self.client_structure.append("client_structure")

575

576

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

577

lambda obj:

578

isinstance(obj,

579

property)):

933

934

for name, t in inspect.getmembers(

935

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

580

936

if not name.startswith("_"):

581

937

self.client_structure.append(name)

582

938

583

939

# Send notice to process children that client state has changed

584

940

def send_changedstate(self):

585

941

with self.changedstate:

586

942

self.changedstate.notify_all()

587

943

588

944

def enable(self):

589

945

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

590

946

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

595

951

self.last_enabled = datetime.datetime.utcnow()

596

952

self.init_checker()

597

953

self.send_changedstate()

598

954

599

955

def disable(self, quiet=True):

600

956

"""Disable this client."""

601

957

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

603

959

if not quiet:

604

960

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

605

961

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

606

gobject.source_remove(self.disable_initiator_tag)

962

GLib.source_remove(self.disable_initiator_tag)

607

963

self.disable_initiator_tag = None

608

964

self.expires = None

609

965

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

610

gobject.source_remove(self.checker_initiator_tag)

966

GLib.source_remove(self.checker_initiator_tag)

611

967

self.checker_initiator_tag = None

612

968

self.stop_checker()

613

969

self.enabled = False

614

970

if not quiet:

615

971

self.send_changedstate()

616

# 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

617

973

return False

618

974

619

975

def __del__(self):

620

976

self.disable()

621

977

622

978

def init_checker(self):

623

979

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

624

980

# and every interval from then on.

625

981

if self.checker_initiator_tag is not None:

626

gobject.source_remove(self.checker_initiator_tag)

627

self.checker_initiator_tag = (gobject.timeout_add

628

(self.interval_milliseconds(),

629

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)

630

986

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

631

987

if self.disable_initiator_tag is not None:

632

gobject.source_remove(self.disable_initiator_tag)

633

self.disable_initiator_tag = (gobject.timeout_add

634

(self.timeout_milliseconds(),

635

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)

636

991

# Also start a new checker *right now*.

637

992

self.start_checker()

638

639

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

993

994

def checker_callback(self, source, condition, connection,

995

command):

640

996

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

641

997

self.checker_callback_tag = None

642

998

self.checker = None

643

if os.WIFEXITED(condition):

644

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

645

1006

if self.last_checker_status == 0:

646

1007

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

647

1008

vars(self))

648

1009

self.checked_ok()

649

1010

else:

650

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

651

vars(self))

1011

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

652

1012

else:

653

1013

self.last_checker_status = -1

1014

self.last_checker_signal = -returncode

654

1015

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

655

1016

vars(self))

656

1017

return False

1018

657

1019

def checked_ok(self):

658

1020

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

659

1021

self.last_checked_ok = datetime.datetime.utcnow()

660

1022

self.last_checker_status = 0

1023

self.last_checker_signal = None

661

1024

self.bump_timeout()

662

1025

663

1026

def bump_timeout(self, timeout=None):

664

1027

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

665

1028

if timeout is None:

666

1029

timeout = self.timeout

667

1030

if self.disable_initiator_tag is not None:

668

gobject.source_remove(self.disable_initiator_tag)

1031

GLib.source_remove(self.disable_initiator_tag)

669

1032

self.disable_initiator_tag = None

670

1033

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

671

self.disable_initiator_tag = (gobject.timeout_add

672

(timedelta_to_milliseconds

673

(timeout), self.disable))

1034

self.disable_initiator_tag = GLib.timeout_add(

1035

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

674

1036

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

675

1037

676

1038

def need_approval(self):

677

1039

self.last_approval_request = datetime.datetime.utcnow()

678

1040

679

1041

def start_checker(self):

680

1042

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

681

1043

682

1044

If a checker already exists, leave it running and do

683

1045

nothing."""

684

1046

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

689

1051

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

690

1052

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

691

1053

# should be.

692

693

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

694

try:

695

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

696

except AttributeError:

697

pass

698

except OSError as error:

699

if error.errno != errno.ECHILD:

700

raise

701

else:

702

if pid:

703

logger.warning("Checker was a zombie")

704

gobject.source_remove(self.checker_callback_tag)

705

self.checker_callback(pid, status,

706

self.current_checker_command)

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

707

1059

# Start a new checker if needed

708

1060

if self.checker is None:

709

1061

# Escape attributes for the shell

710

escaped_attrs = dict(

711

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

712

for attr in

713

self.runtime_expansions)

1062

escaped_attrs = {

1063

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

1064

for attr in self.runtime_expansions}

714

1065

try:

715

1066

command = self.checker_command % escaped_attrs

716

1067

except TypeError as error:

717

1068

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

718

self.checker_command, exc_info=error)

719

return True # Try again later

1069

self.checker_command,

1070

exc_info=error)

1071

return True # Try again later

720

1072

self.current_checker_command = command

721

try:

722

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

723

command, self.name)

724

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

725

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

726

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

727

# always replaced by /dev/null.)

728

# The exception is when not debugging but nevertheless

729

# running in the foreground; use the previously

730

# created wnull.

731

popen_args = {}

732

if (not self.server_settings["debug"]

733

and self.server_settings["foreground"]):

734

popen_args.update({"stdout": wnull,

735

"stderr": wnull })

736

self.checker = subprocess.Popen(command,

737

close_fds=True,

738

shell=True, cwd="/",

739

**popen_args)

740

except OSError as error:

741

logger.error("Failed to start subprocess",

742

exc_info=error)

743

return True

744

self.checker_callback_tag = (gobject.child_watch_add

745

(self.checker.pid,

746

self.checker_callback,

747

data=command))

748

# The checker may have completed before the gobject

749

# watch was added. Check for this.

750

try:

751

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

752

except OSError as error:

753

if error.errno == errno.ECHILD:

754

# This should never happen

755

logger.error("Child process vanished",

756

exc_info=error)

757

return True

758

raise

759

if pid:

760

gobject.source_remove(self.checker_callback_tag)

761

self.checker_callback(pid, status, command)

762

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

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

763

1099

return True

764

1100

765

1101

def stop_checker(self):

766

1102

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

767

1103

if self.checker_callback_tag:

768

gobject.source_remove(self.checker_callback_tag)

1104

GLib.source_remove(self.checker_callback_tag)

769

1105

self.checker_callback_tag = None

770

1106

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

771

1107

return

772

1108

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

773

try:

774

self.checker.terminate()

775

#time.sleep(0.5)

776

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

777

# self.checker.kill()

778

except OSError as error:

779

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

780

raise

1109

self.checker.terminate()

781

1110

self.checker = None

782

1111

783

1112

784

def dbus_service_property(dbus_interface, signature="v",

785

access="readwrite", byte_arrays=False):

1113

def dbus_service_property(dbus_interface,

1114

signature="v",

1115

access="readwrite",

1116

byte_arrays=False):

786

1117

"""Decorators for marking methods of a DBusObjectWithProperties to

787

1118

become properties on the D-Bus.

788

1119

789

1120

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

790

1121

and with one argument by "Set".

791

1122

792

1123

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

793

1124

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

794

1125

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

797

1128

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

798

1129

if byte_arrays and signature != "ay":

799

1130

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

800

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

1131

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

1132

801

1133

def decorator(func):

802

1134

func._dbus_is_property = True

803

1135

func._dbus_interface = dbus_interface

806

1138

func._dbus_name = func.__name__

807

1139

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

808

1140

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

809

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1141

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

810

1142

return func

1143

811

1144

return decorator

812

1145

813

1146

814

1147

def dbus_interface_annotations(dbus_interface):

815

1148

"""Decorator for marking functions returning interface annotations

816

1149

817

1150

Usage:

818

1151

819

1152

@dbus_interface_annotations("org.example.Interface")

820

1153

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

821

1154

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

822

1155

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

823

1156

"false"}

824

1157

"""

1158

825

1159

def decorator(func):

826

1160

func._dbus_is_interface = True

827

1161

func._dbus_interface = dbus_interface

828

1162

func._dbus_name = dbus_interface

829

1163

return func

1164

830

1165

return decorator

831

1166

832

1167

833

1168

def dbus_annotations(annotations):

834

1169

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

835

1170

Usage:

836

1171

1172

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

1173

"org.freedesktop.DBus.Property."

1174

"EmitsChangedSignal": "false"})

837

1175

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

838

1176

access="r")

839

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

840

"org.freedesktop.DBus.Property."

841

"EmitsChangedSignal": "false"})

842

1177

def Property_dbus_property(self):

843

1178

return dbus.Boolean(False)

1179

1180

See also the DBusObjectWithAnnotations class.

844

1181

"""

1182

845

1183

def decorator(func):

846

1184

func._dbus_annotations = annotations

847

1185

return func

1186

848

1187

return decorator

849

1188

850

1189

851

1190

class DBusPropertyException(dbus.exceptions.DBusException):

852

1191

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

853

1192

"""

854

def __unicode__(self):

855

return unicode(str(self))

1193

pass

856

1194

857

1195

858

1196

class DBusPropertyAccessException(DBusPropertyException):

867

1205

pass

868

1206

869

1207

870

class DBusObjectWithProperties(dbus.service.Object):

871

"""A D-Bus object with properties.

872

873

Classes inheriting from this can use the dbus_service_property

874

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

875

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

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.

876

1213

"""

877

1214

878

1215

@staticmethod

879

1216

def _is_dbus_thing(thing):

880

1217

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

881

1218

882

1219

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

883

1220

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

884

1221

"""

885

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

1222

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

886

1223

False)

887

1224

888

1225

def _get_all_dbus_things(self, thing):

889

1226

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

890

1227

"""

891

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

892

name),

1228

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

893

1229

athing.__get__(self))

894

1230

for cls in self.__class__.__mro__

895

1231

for name, athing in

896

inspect.getmembers(cls,

897

self._is_dbus_thing(thing)))

898

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

899

1305

def _get_dbus_property(self, interface_name, property_name):

900

1306

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

901

1307

property with the specified name and interface.

902

1308

"""

903

for cls in self.__class__.__mro__:

904

for name, value in (inspect.getmembers

905

(cls,

906

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

907

1312

if (value._dbus_name == property_name

908

1313

and value._dbus_interface == interface_name):

909

1314

return value.__get__(self)

910

1315

911

1316

# No such property

912

raise DBusPropertyNotFound(self.dbus_object_path + ":"

913

+ interface_name + "."

914

+ property_name)

915

916

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

917

1331

out_signature="v")

918

1332

def Get(self, interface_name, property_name):

919

1333

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

925

1339

if not hasattr(value, "variant_level"):

926

1340

return value

927

1341

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

928

1342

929

1343

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

930

1344

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

931

1345

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

938

1352

# signatures other than "ay".

939

1353

if prop._dbus_signature != "ay":

940

1354

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

941

"'ay' signature {0!r}"

1355

"'ay' signature {!r}"

942

1356

.format(prop._dbus_signature))

943

1357

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

944

1358

for byte in value))

945

1359

prop(value)

946

947

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

1360

1361

@dbus.service.method(dbus.PROPERTIES_IFACE,

1362

in_signature="s",

948

1363

out_signature="a{sv}")

949

1364

def GetAll(self, interface_name):

950

1365

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

951

1366

standard.

952

1367

953

1368

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

954

1369

"""

955

1370

properties = {}

965

1380

if not hasattr(value, "variant_level"):

966

1381

properties[name] = value

967

1382

continue

968

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

969

value.variant_level+1)

1383

properties[name] = type(value)(

1384

value, variant_level=value.variant_level + 1)

970

1385

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

971

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

972

1395

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

973

1396

out_signature="s",

974

1397

path_keyword='object_path',

975

1398

connection_keyword='connection')

976

1399

def Introspect(self, object_path, connection):

977

1400

"""Overloading of standard D-Bus method.

978

1401

979

1402

Inserts property tags and interface annotation tags.

980

1403

"""

981

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

982

connection)

1404

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1405

object_path,

1406

connection)

983

1407

try:

984

1408

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

1409

985

1410

def make_tag(document, name, prop):

986

1411

e = document.createElement("property")

987

1412

e.setAttribute("name", name)

988

1413

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

989

1414

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

990

1415

return e

1416

991

1417

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

992

1418

# Add property tags

993

1419

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

996

1422

if prop._dbus_interface

997

1423

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

998

1424

if_tag.appendChild(tag)

999

# Add annotation tags

1000

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

1001

for tag in if_tag.getElementsByTagName(typ):

1002

annots = dict()

1003

for name, prop in (self.

1004

_get_all_dbus_things(typ)):

1005

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

1006

and prop._dbus_interface

1007

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

1008

annots.update(getattr

1009

(prop,

1010

"_dbus_annotations",

1011

{}))

1012

for name, value in annots.iteritems():

1013

ann_tag = document.createElement(

1014

"annotation")

1015

ann_tag.setAttribute("name", name)

1016

ann_tag.setAttribute("value", value)

1017

tag.appendChild(ann_tag)

1018

# Add interface annotation tags

1019

for annotation, value in dict(

1020

itertools.chain.from_iterable(

1021

annotations().iteritems()

1022

for name, annotations in

1023

self._get_all_dbus_things("interface")

1024

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

1025

)).iteritems():

1026

ann_tag = document.createElement("annotation")

1027

ann_tag.setAttribute("name", annotation)

1028

ann_tag.setAttribute("value", value)

1029

if_tag.appendChild(ann_tag)

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)

1030

1441

# Add the names to the return values for the

1031

1442

# "org.freedesktop.DBus.Properties" methods

1032

1443

if (if_tag.getAttribute("name")

1051

1462

return xmlstring

1052

1463

1053

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

1054

1536

def datetime_to_dbus(dt, variant_level=0):

1055

1537

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

1056

1538

if dt is None:

1057

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

1058

return dbus.String(dt.isoformat(),

1059

variant_level=variant_level)

1539

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

1540

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

1060

1541

1061

1542

1062

1543

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1064

1545

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

1065

1546

interface names according to the "alt_interface_names" mapping.

1066

1547

Usage:

1067

1548

1068

1549

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

1069

1550

"net.example.AlternateInterface"})

1070

1551

class SampleDBusObject(dbus.service.Object):

1071

1552

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

1072

1553

def SampleDBusMethod():

1073

1554

pass

1074

1555

1075

1556

The above "SampleDBusMethod" on "SampleDBusObject" will be

1076

1557

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

1077

1558

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

1078

1559

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

1079

1560

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

1080

1561

1081

1562

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

1082

1563

(from DBusObjectWithProperties) and interfaces (from the

1083

1564

dbus_interface_annotations decorator).

1084

1565

"""

1566

1085

1567

def wrapper(cls):

1086

1568

for orig_interface_name, alt_interface_name in (

1087

alt_interface_names.iteritems()):

1569

alt_interface_names.items()):

1088

1570

attr = {}

1089

1571

interface_names = set()

1090

1572

# Go though all attributes of the class

1092

1574

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

1093

1575

# with the wrong interface name

1094

1576

if (not hasattr(attribute, "_dbus_interface")

1095

or not attribute._dbus_interface

1096

.startswith(orig_interface_name)):

1577

or not attribute._dbus_interface.startswith(

1578

orig_interface_name)):

1097

1579

continue

1098

1580

# Create an alternate D-Bus interface name based on

1099

1581

# the current name

1100

alt_interface = (attribute._dbus_interface

1101

.replace(orig_interface_name,

1102

alt_interface_name))

1582

alt_interface = attribute._dbus_interface.replace(

1583

orig_interface_name, alt_interface_name)

1103

1584

interface_names.add(alt_interface)

1104

1585

# Is this a D-Bus signal?

1105

1586

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

1106

1587

# Extract the original non-method undecorated

1107

1588

# function by black magic

1108

nonmethod_func = (dict(

1589

if sys.version_info.major == 2:

1590

nonmethod_func = (dict(

1109

1591

zip(attribute.func_code.co_freevars,

1110

attribute.__closure__))["func"]

1111

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

1112

1599

# Create a new, but exactly alike, function

1113

1600

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

1114

1601

# with the alternate D-Bus interface name

1115

new_function = (dbus.service.signal

1116

(alt_interface,

1117

attribute._dbus_signature)

1118

(types.FunctionType(

1119

nonmethod_func.func_code,

1120

nonmethod_func.func_globals,

1121

nonmethod_func.func_name,

1122

nonmethod_func.func_defaults,

1123

nonmethod_func.func_closure)))

1602

new_function = copy_function(nonmethod_func)

1603

new_function = (dbus.service.signal(

1604

alt_interface,

1605

attribute._dbus_signature)(new_function))

1124

1606

# Copy annotations, if any

1125

1607

try:

1126

new_function._dbus_annotations = (

1127

dict(attribute._dbus_annotations))

1608

new_function._dbus_annotations = dict(

1609

attribute._dbus_annotations)

1128

1610

except AttributeError:

1129

1611

pass

1612

1130

1613

# Define a creator of a function to call both the

1131

1614

# original and alternate functions, so both the

1132

1615

# original and alternate signals gets sent when

1135

1618

"""This function is a scope container to pass

1136

1619

func1 and func2 to the "call_both" function

1137

1620

outside of its arguments"""

1621

1622

@functools.wraps(func2)

1138

1623

def call_both(*args, **kwargs):

1139

1624

"""This function will emit two D-Bus

1140

1625

signals by calling func1 and func2"""

1141

1626

func1(*args, **kwargs)

1142

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

1143

1634

return call_both

1144

1635

# Create the "call_both" function and add it to

1145

1636

# the class

1150

1641

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

1151

1642

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

1152

1643

# to the class.

1153

attr[attrname] = (dbus.service.method

1154

(alt_interface,

1155

attribute._dbus_in_signature,

1156

attribute._dbus_out_signature)

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1644

attr[attrname] = (

1645

dbus.service.method(

1646

alt_interface,

1647

attribute._dbus_in_signature,

1648

attribute._dbus_out_signature)

1649

(copy_function(attribute)))

1163

1650

# Copy annotations, if any

1164

1651

try:

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1652

attr[attrname]._dbus_annotations = dict(

1653

attribute._dbus_annotations)

1167

1654

except AttributeError:

1168

1655

pass

1169

1656

# Is this a D-Bus property?

1172

1659

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

1173

1660

# property with the alternate D-Bus interface

1174

1661

# name. Add it to the class.

1175

attr[attrname] = (dbus_service_property

1176

(alt_interface,

1177

attribute._dbus_signature,

1178

attribute._dbus_access,

1179

attribute

1180

._dbus_get_args_options

1181

["byte_arrays"])

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

attribute.func_closure)))

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

1188

1668

# Copy annotations, if any

1189

1669

try:

1190

attr[attrname]._dbus_annotations = (

1191

dict(attribute._dbus_annotations))

1670

attr[attrname]._dbus_annotations = dict(

1671

attribute._dbus_annotations)

1192

1672

except AttributeError:

1193

1673

pass

1194

1674

# Is this a D-Bus interface?

1197

1677

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

1198

1678

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

1199

1679

# to the class.

1200

attr[attrname] = (dbus_interface_annotations

1201

(alt_interface)

1202

(types.FunctionType

1203

(attribute.func_code,

1204

attribute.func_globals,

1205

attribute.func_name,

1206

attribute.func_defaults,

1207

attribute.func_closure)))

1680

attr[attrname] = (

1681

dbus_interface_annotations(alt_interface)

1682

(copy_function(attribute)))

1208

1683

if deprecate:

1209

1684

# Deprecate all alternate interfaces

1210

iname="_AlternateDBusNames_interface_annotation{0}"

1685

iname = "_AlternateDBusNames_interface_annotation{}"

1211

1686

for interface_name in interface_names:

1687

1212

1688

@dbus_interface_annotations(interface_name)

1213

1689

def func(self):

1214

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

1215

"true" }

1690

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

1691

"true"}

1216

1692

# Find an unused name

1217

1693

for aname in (iname.format(i)

1218

1694

for i in itertools.count()):

1222

1698

if interface_names:

1223

1699

# Replace the class with a new subclass of it with

1224

1700

# methods, signals, etc. as created above.

1225

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

1226

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

1227

1707

return cls

1708

1228

1709

return wrapper

1229

1710

1230

1711

1231

1712

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

1232

"se.bsnet.fukt.Mandos"})

1713

"se.bsnet.fukt.Mandos"})

1233

1714

class ClientDBus(Client, DBusObjectWithProperties):

1234

1715

"""A Client class using D-Bus

1235

1716

1236

1717

Attributes:

1237

1718

dbus_object_path: dbus.ObjectPath

1238

1719

bus: dbus.SystemBus()

1239

1720

"""

1240

1721

1241

1722

runtime_expansions = (Client.runtime_expansions

1242

+ ("dbus_object_path",))

1243

1723

+ ("dbus_object_path", ))

1724

1725

_interface = "se.recompile.Mandos.Client"

1726

1244

1727

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

1245

1246

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

1728

1729

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

1247

1730

self.bus = bus

1248

1731

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

1249

1732

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

1250

1733

# the D-Bus

1251

client_object_name = unicode(self.name).translate(

1734

client_object_name = str(self.name).translate(

1252

1735

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

1253

1736

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

1254

self.dbus_object_path = (dbus.ObjectPath

1255

("/clients/" + client_object_name))

1737

self.dbus_object_path = dbus.ObjectPath(

1738

"/clients/" + client_object_name)

1256

1739

DBusObjectWithProperties.__init__(self, self.bus,

1257

1740

self.dbus_object_path)

1258

1259

def notifychangeproperty(transform_func,

1260

dbus_name, type_func=lambda x: x,

1261

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

1262

1747

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

1263

1748

its changes to DBus.

1264

1749

1265

1750

transform_fun: Function that takes a value and a variant_level

1266

1751

and transforms it to a D-Bus type.

1267

1752

dbus_name: D-Bus name of the variable

1269

1754

to the D-Bus. Default: no transform

1270

1755

variant_level: D-Bus variant level. Default: 1

1271

1756

"""

1272

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

1757

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

1758

1273

1759

def setter(self, value):

1274

1760

if hasattr(self, "dbus_object_path"):

1275

1761

if (not hasattr(self, attrname) or

1276

1762

type_func(getattr(self, attrname, None))

1277

1763

!= type_func(value)):

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1281

self.PropertyChanged(dbus.String(dbus_name),

1282

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

1283

1779

setattr(self, attrname, value)

1284

1780

1285

1781

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

1286

1782

1287

1783

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1288

1784

approvals_pending = notifychangeproperty(dbus.Boolean,

1289

1785

"ApprovalPending",

1290

type_func = bool)

1786

type_func=bool)

1291

1787

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

1292

1788

last_enabled = notifychangeproperty(datetime_to_dbus,

1293

1789

"LastEnabled")

1294

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

1295

type_func = lambda checker:

1296

checker is not None)

1790

checker = notifychangeproperty(

1791

dbus.Boolean, "CheckerRunning",

1792

type_func=lambda checker: checker is not None)

1297

1793

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1298

1794

"LastCheckedOK")

1299

1795

last_checker_status = notifychangeproperty(dbus.Int16,

1302

1798

datetime_to_dbus, "LastApprovalRequest")

1303

1799

approved_by_default = notifychangeproperty(dbus.Boolean,

1304

1800

"ApprovedByDefault")

1305

approval_delay = notifychangeproperty(dbus.UInt64,

1306

"ApprovalDelay",

1307

type_func =

1308

timedelta_to_milliseconds)

1801

approval_delay = notifychangeproperty(

1802

dbus.UInt64, "ApprovalDelay",

1803

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

1309

1804

approval_duration = notifychangeproperty(

1310

1805

dbus.UInt64, "ApprovalDuration",

1311

type_func = timedelta_to_milliseconds)

1806

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

1312

1807

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

1313

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

1314

type_func =

1315

timedelta_to_milliseconds)

1808

timeout = notifychangeproperty(

1809

dbus.UInt64, "Timeout",

1810

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

1316

1811

extended_timeout = notifychangeproperty(

1317

1812

dbus.UInt64, "ExtendedTimeout",

1318

type_func = timedelta_to_milliseconds)

1319

interval = notifychangeproperty(dbus.UInt64,

1320

"Interval",

1321

type_func =

1322

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)

1323

1817

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

1324

1818

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

1819

invalidate_only=True)

1820

1325

1821

del notifychangeproperty

1326

1822

1327

1823

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

1328

1824

try:

1329

1825

self.remove_from_connection()

1332

1828

if hasattr(DBusObjectWithProperties, "__del__"):

1333

1829

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

1334

1830

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

1335

1336

def checker_callback(self, pid, condition, command,

1337

*args, **kwargs):

1338

self.checker_callback_tag = None

1339

self.checker = None

1340

if os.WIFEXITED(condition):

1341

exitstatus = os.WEXITSTATUS(condition)

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:

1342

1839

# Emit D-Bus signal

1343

1840

self.CheckerCompleted(dbus.Int16(exitstatus),

1344

dbus.Int64(condition),

1841

# This is specific to GNU libC

1842

dbus.Int64(exitstatus << 8),

1345

1843

dbus.String(command))

1346

1844

else:

1347

1845

# Emit D-Bus signal

1348

1846

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

1349

dbus.Int64(condition),

1847

dbus.Int64(

1848

# This is specific to GNU libC

1849

(exitstatus << 8)

1850

| self.last_checker_signal),

1350

1851

dbus.String(command))

1351

1352

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

1353

*args, **kwargs)

1354

1852

return ret

1853

1355

1854

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

1356

1855

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

1357

1856

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

1361

1860

# Emit D-Bus signal

1362

1861

self.CheckerStarted(self.current_checker_command)

1363

1862

return r

1364

1863

1365

1864

def _reset_approved(self):

1366

1865

self.approved = None

1367

1866

return False

1368

1867

1369

1868

def approve(self, value=True):

1370

1869

self.approved = value

1371

gobject.timeout_add(timedelta_to_milliseconds

1372

(self.approval_duration),

1373

self._reset_approved)

1870

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

1871

* 1000), self._reset_approved)

1374

1872

self.send_changedstate()

1375

1376

## D-Bus methods, signals & properties

1377

_interface = "se.recompile.Mandos.Client"

1378

1379

## Interfaces

1380

1381

@dbus_interface_annotations(_interface)

1382

def _foo(self):

1383

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

1384

"false"}

1385

1386

## Signals

1387

1873

1874

# D-Bus methods, signals & properties

1875

1876

# Interfaces

1877

1878

# Signals

1879

1388

1880

# CheckerCompleted - signal

1389

1881

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

1390

1882

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

1391

1883

"D-Bus signal"

1392

1884

pass

1393

1885

1394

1886

# CheckerStarted - signal

1395

1887

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

1396

1888

def CheckerStarted(self, command):

1397

1889

"D-Bus signal"

1398

1890

pass

1399

1891

1400

1892

# PropertyChanged - signal

1893

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

1401

1894

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

1402

1895

def PropertyChanged(self, property, value):

1403

1896

"D-Bus signal"

1404

1897

pass

1405

1898

1406

1899

# GotSecret - signal

1407

1900

@dbus.service.signal(_interface)

1408

1901

def GotSecret(self):

1411

1904

server to mandos-client

1412

1905

"""

1413

1906

pass

1414

1907

1415

1908

# Rejected - signal

1416

1909

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

1417

1910

def Rejected(self, reason):

1418

1911

"D-Bus signal"

1419

1912

pass

1420

1913

1421

1914

# NeedApproval - signal

1422

1915

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

1423

1916

def NeedApproval(self, timeout, default):

1424

1917

"D-Bus signal"

1425

1918

return self.need_approval()

1426

1427

## Methods

1428

1919

1920

# Methods

1921

1429

1922

# Approve - method

1430

1923

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

1431

1924

def Approve(self, value):

1432

1925

self.approve(value)

1433

1926

1434

1927

# CheckedOK - method

1435

1928

@dbus.service.method(_interface)

1436

1929

def CheckedOK(self):

1437

1930

self.checked_ok()

1438

1931

1439

1932

# Enable - method

1933

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

1440

1934

@dbus.service.method(_interface)

1441

1935

def Enable(self):

1442

1936

"D-Bus method"

1443

1937

self.enable()

1444

1938

1445

1939

# StartChecker - method

1940

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

1446

1941

@dbus.service.method(_interface)

1447

1942

def StartChecker(self):

1448

1943

"D-Bus method"

1449

1944

self.start_checker()

1450

1945

1451

1946

# Disable - method

1947

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

1452

1948

@dbus.service.method(_interface)

1453

1949

def Disable(self):

1454

1950

"D-Bus method"

1455

1951

self.disable()

1456

1952

1457

1953

# StopChecker - method

1954

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

1458

1955

@dbus.service.method(_interface)

1459

1956

def StopChecker(self):

1460

1957

self.stop_checker()

1461

1462

## Properties

1463

1958

1959

# Properties

1960

1464

1961

# ApprovalPending - property

1465

1962

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

1466

1963

def ApprovalPending_dbus_property(self):

1467

1964

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

1468

1965

1469

1966

# ApprovedByDefault - property

1470

@dbus_service_property(_interface, signature="b",

1967

@dbus_service_property(_interface,

1968

signature="b",

1471

1969

access="readwrite")

1472

1970

def ApprovedByDefault_dbus_property(self, value=None):

1473

1971

if value is None: # get

1474

1972

return dbus.Boolean(self.approved_by_default)

1475

1973

self.approved_by_default = bool(value)

1476

1974

1477

1975

# ApprovalDelay - property

1478

@dbus_service_property(_interface, signature="t",

1976

@dbus_service_property(_interface,

1977

signature="t",

1479

1978

access="readwrite")

1480

1979

def ApprovalDelay_dbus_property(self, value=None):

1481

1980

if value is None: # get

1482

return dbus.UInt64(self.approval_delay_milliseconds())

1981

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

1982

* 1000)

1483

1983

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

1484

1984

1485

1985

# ApprovalDuration - property

1486

@dbus_service_property(_interface, signature="t",

1986

@dbus_service_property(_interface,

1987

signature="t",

1487

1988

access="readwrite")

1488

1989

def ApprovalDuration_dbus_property(self, value=None):

1489

1990

if value is None: # get

1490

return dbus.UInt64(timedelta_to_milliseconds(

1491

self.approval_duration))

1991

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

1992

* 1000)

1492

1993

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

1493

1994

1494

1995

# Name - property

1996

@dbus_annotations(

1997

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

1495

1998

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

1496

1999

def Name_dbus_property(self):

1497

2000

return dbus.String(self.name)

1498

2001

1499

2002

# Fingerprint - property

2003

@dbus_annotations(

2004

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

1500

2005

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

1501

2006

def Fingerprint_dbus_property(self):

1502

2007

return dbus.String(self.fingerprint)

1503

2008

1504

2009

# Host - property

1505

@dbus_service_property(_interface, signature="s",

2010

@dbus_service_property(_interface,

2011

signature="s",

1506

2012

access="readwrite")

1507

2013

def Host_dbus_property(self, value=None):

1508

2014

if value is None: # get

1509

2015

return dbus.String(self.host)

1510

self.host = unicode(value)

1511

2016

self.host = str(value)

2017

1512

2018

# Created - property

2019

@dbus_annotations(

2020

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

1513

2021

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

1514

2022

def Created_dbus_property(self):

1515

2023

return datetime_to_dbus(self.created)

1516

2024

1517

2025

# LastEnabled - property

1518

2026

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

1519

2027

def LastEnabled_dbus_property(self):

1520

2028

return datetime_to_dbus(self.last_enabled)

1521

2029

1522

2030

# Enabled - property

1523

@dbus_service_property(_interface, signature="b",

2031

@dbus_service_property(_interface,

2032

signature="b",

1524

2033

access="readwrite")

1525

2034

def Enabled_dbus_property(self, value=None):

1526

2035

if value is None: # get

1529

2038

self.enable()

1530

2039

else:

1531

2040

self.disable()

1532

2041

1533

2042

# LastCheckedOK - property

1534

@dbus_service_property(_interface, signature="s",

2043

@dbus_service_property(_interface,

2044

signature="s",

1535

2045

access="readwrite")

1536

2046

def LastCheckedOK_dbus_property(self, value=None):

1537

2047

if value is not None:

1538

2048

self.checked_ok()

1539

2049

return

1540

2050

return datetime_to_dbus(self.last_checked_ok)

1541

2051

1542

2052

# LastCheckerStatus - property

1543

@dbus_service_property(_interface, signature="n",

1544

access="read")

2053

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

1545

2054

def LastCheckerStatus_dbus_property(self):

1546

2055

return dbus.Int16(self.last_checker_status)

1547

2056

1548

2057

# Expires - property

1549

2058

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

1550

2059

def Expires_dbus_property(self):

1551

2060

return datetime_to_dbus(self.expires)

1552

2061

1553

2062

# LastApprovalRequest - property

1554

2063

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

1555

2064

def LastApprovalRequest_dbus_property(self):

1556

2065

return datetime_to_dbus(self.last_approval_request)

1557

2066

1558

2067

# Timeout - property

1559

@dbus_service_property(_interface, signature="t",

2068

@dbus_service_property(_interface,

2069

signature="t",

1560

2070

access="readwrite")

1561

2071

def Timeout_dbus_property(self, value=None):

1562

2072

if value is None: # get

1563

return dbus.UInt64(self.timeout_milliseconds())

2073

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

1564

2074

old_timeout = self.timeout

1565

2075

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

1566

2076

# Reschedule disabling

1574

2084

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

1575

2085

is None):

1576

2086

return

1577

gobject.source_remove(self.disable_initiator_tag)

1578

self.disable_initiator_tag = (

1579

gobject.timeout_add(

1580

timedelta_to_milliseconds(self.expires - now),

1581

self.disable))

1582

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

1583

2092

# ExtendedTimeout - property

1584

@dbus_service_property(_interface, signature="t",

2093

@dbus_service_property(_interface,

2094

signature="t",

1585

2095

access="readwrite")

1586

2096

def ExtendedTimeout_dbus_property(self, value=None):

1587

2097

if value is None: # get

1588

return dbus.UInt64(self.extended_timeout_milliseconds())

2098

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

2099

* 1000)

1589

2100

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

1590

2101

1591

2102

# Interval - property

1592

@dbus_service_property(_interface, signature="t",

2103

@dbus_service_property(_interface,

2104

signature="t",

1593

2105

access="readwrite")

1594

2106

def Interval_dbus_property(self, value=None):

1595

2107

if value is None: # get

1596

return dbus.UInt64(self.interval_milliseconds())

2108

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

1597

2109

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

1598

2110

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

1599

2111

return

1600

2112

if self.enabled:

1601

2113

# Reschedule checker run

1602

gobject.source_remove(self.checker_initiator_tag)

1603

self.checker_initiator_tag = (gobject.timeout_add

1604

(value, self.start_checker))

1605

self.start_checker() # Start one now, too

1606

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

1607

2119

# Checker - property

1608

@dbus_service_property(_interface, signature="s",

2120

@dbus_service_property(_interface,

2121

signature="s",

1609

2122

access="readwrite")

1610

2123

def Checker_dbus_property(self, value=None):

1611

2124

if value is None: # get

1612

2125

return dbus.String(self.checker_command)

1613

self.checker_command = unicode(value)

1614

2126

self.checker_command = str(value)

2127

1615

2128

# CheckerRunning - property

1616

@dbus_service_property(_interface, signature="b",

2129

@dbus_service_property(_interface,

2130

signature="b",

1617

2131

access="readwrite")

1618

2132

def CheckerRunning_dbus_property(self, value=None):

1619

2133

if value is None: # get

1622

2136

self.start_checker()

1623

2137

else:

1624

2138

self.stop_checker()

1625

2139

1626

2140

# ObjectPath - property

2141

@dbus_annotations(

2142

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

2143

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

1627

2144

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

1628

2145

def ObjectPath_dbus_property(self):

1629

return self.dbus_object_path # is already a dbus.ObjectPath

1630

2146

return self.dbus_object_path # is already a dbus.ObjectPath

2147

1631

2148

# Secret = property

1632

@dbus_service_property(_interface, signature="ay",

1633

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)

1634

2156

def Secret_dbus_property(self, value):

1635

self.secret = str(value)

1636

2157

self.secret = bytes(value)

2158

1637

2159

del _interface

1638

2160

1639

2161

1642

2164

self._pipe = child_pipe

1643

2165

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

1644

2166

if not self._pipe.recv():

1645

raise KeyError()

1646

2167

raise KeyError(fpr)

2168

1647

2169

def __getattribute__(self, name):

1648

2170

if name == '_pipe':

1649

2171

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

1652

2174

if data[0] == 'data':

1653

2175

return data[1]

1654

2176

if data[0] == 'function':

2177

1655

2178

def func(*args, **kwargs):

1656

2179

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

1657

2180

return self._pipe.recv()[1]

2181

1658

2182

return func

1659

2183

1660

2184

def __setattr__(self, name, value):

1661

2185

if name == '_pipe':

1662

2186

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

1665

2189

1666

2190

class ClientHandler(socketserver.BaseRequestHandler, object):

1667

2191

"""A class to handle client connections.

1668

2192

1669

2193

Instantiated once for each connection to handle it.

1670

2194

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

1671

2195

1672

2196

def handle(self):

1673

2197

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

1674

2198

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

1675

unicode(self.client_address))

2199

str(self.client_address))

1676

2200

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

1677

2201

self.server.child_pipe.fileno())

1678

1679

session = (gnutls.connection

1680

.ClientSession(self.request,

1681

gnutls.connection

1682

.X509Credentials()))

1683

1684

# Note: gnutls.connection.X509Credentials is really a

1685

# generic GnuTLS certificate credentials object so long as

1686

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

1687

# here despite using OpenPGP certificates.

1688

1689

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

1690

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

1691

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

1692

# "+DHE-DSS"))

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

1693

2209

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

1694

2210

priority = self.server.gnutls_priority

1695

2211

if priority is None:

1696

2212

priority = "NORMAL"

1697

(gnutls.library.functions

1698

.gnutls_priority_set_direct(session._c_object,

1699

priority, None))

1700

2213

gnutls.priority_set_direct(session._c_object,

2214

priority.encode("utf-8"),

2215

None)

2216

1701

2217

# Start communication using the Mandos protocol

1702

2218

# Get protocol number

1703

2219

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

1708

2224

except (ValueError, IndexError, RuntimeError) as error:

1709

2225

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

1710

2226

return

1711

2227

1712

2228

# Start GnuTLS connection

1713

2229

try:

1714

2230

session.handshake()

1715

except gnutls.errors.GNUTLSError as error:

2231

except gnutls.Error as error:

1716

2232

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

1717

2233

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

1718

2234

# established. Just abandon the request.

1719

2235

return

1720

2236

logger.debug("Handshake succeeded")

1721

2237

1722

2238

approval_required = False

1723

2239

try:

1724

2240

try:

1725

fpr = self.fingerprint(self.peer_certificate

1726

(session))

1727

except (TypeError,

1728

gnutls.errors.GNUTLSError) as error:

2241

fpr = self.fingerprint(

2242

self.peer_certificate(session))

2243

except (TypeError, gnutls.Error) as error:

1729

2244

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

1730

2245

return

1731

2246

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

1732

2247

1733

2248

try:

1734

2249

client = ProxyClient(child_pipe, fpr,

1735

2250

self.client_address)

1736

2251

except KeyError:

1737

2252

return

1738

2253

1739

2254

if client.approval_delay:

1740

2255

delay = client.approval_delay

1741

2256

client.approvals_pending += 1

1742

2257

approval_required = True

1743

2258

1744

2259

while True:

1745

2260

if not client.enabled:

1746

2261

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

1747

client.name)

2262

client.name)

1748

2263

if self.server.use_dbus:

1749

2264

# Emit D-Bus signal

1750

2265

client.Rejected("Disabled")

1751

2266

return

1752

2267

1753

2268

if client.approved or not client.approval_delay:

1754

#We are approved or approval is disabled

2269

# We are approved or approval is disabled

1755

2270

break

1756

2271

elif client.approved is None:

1757

2272

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

1759

2274

if self.server.use_dbus:

1760

2275

# Emit D-Bus signal

1761

2276

client.NeedApproval(

1762

client.approval_delay_milliseconds(),

1763

client.approved_by_default)

2277

client.approval_delay.total_seconds()

2278

* 1000, client.approved_by_default)

1764

2279

else:

1765

2280

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

1766

2281

client.name)

1768

2283

# Emit D-Bus signal

1769

2284

client.Rejected("Denied")

1770

2285

return

1771

1772

#wait until timeout or approved

2286

2287

# wait until timeout or approved

1773

2288

time = datetime.datetime.now()

1774

2289

client.changedstate.acquire()

1775

client.changedstate.wait(

1776

float(timedelta_to_milliseconds(delay)

1777

/ 1000))

2290

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

1778

2291

client.changedstate.release()

1779

2292

time2 = datetime.datetime.now()

1780

2293

if (time2 - time) >= delay:

1790

2303

break

1791

2304

else:

1792

2305

delay -= time2 - time

1793

1794

sent_size = 0

1795

while sent_size < len(client.secret):

1796

try:

1797

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

1798

except gnutls.errors.GNUTLSError as error:

1799

logger.warning("gnutls send failed",

1800

exc_info=error)

1801

return

1802

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

1803

sent, len(client.secret)

1804

- (sent_size + sent))

1805

sent_size += sent

1806

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

1807

2314

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

1808

2315

# bump the timeout using extended_timeout

1809

2316

client.bump_timeout(client.extended_timeout)

1810

2317

if self.server.use_dbus:

1811

2318

# Emit D-Bus signal

1812

2319

client.GotSecret()

1813

2320

1814

2321

finally:

1815

2322

if approval_required:

1816

2323

client.approvals_pending -= 1

1817

2324

try:

1818

2325

session.bye()

1819

except gnutls.errors.GNUTLSError as error:

2326

except gnutls.Error as error:

1820

2327

logger.warning("GnuTLS bye failed",

1821

2328

exc_info=error)

1822

2329

1823

2330

@staticmethod

1824

2331

def peer_certificate(session):

1825

2332

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

1826

2333

# If not an OpenPGP certificate...

1827

if (gnutls.library.functions

1828

.gnutls_certificate_type_get(session._c_object)

1829

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1830

# ...do the normal thing

1831

return session.peer_certificate

2334

if (gnutls.certificate_type_get(session._c_object)

2335

!= gnutls.CRT_OPENPGP):

2336

# ...return invalid data

2337

return b""

1832

2338

list_size = ctypes.c_uint(1)

1833

cert_list = (gnutls.library.functions

1834

.gnutls_certificate_get_peers

2339

cert_list = (gnutls.certificate_get_peers

1835

2340

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

1836

2341

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

1837

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

1838

" certificate")

2342

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

1839

2343

if list_size.value == 0:

1840

2344

return None

1841

2345

cert = cert_list[0]

1842

2346

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

1843

2347

1844

2348

@staticmethod

1845

2349

def fingerprint(openpgp):

1846

2350

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1847

2351

# New GnuTLS "datum" with the OpenPGP public key

1848

datum = (gnutls.library.types

1849

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

1850

ctypes.POINTER

1851

(ctypes.c_ubyte)),

1852

ctypes.c_uint(len(openpgp))))

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

1853

2356

# New empty GnuTLS certificate

1854

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1855

(gnutls.library.functions

1856

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2357

crt = gnutls.openpgp_crt_t()

2358

gnutls.openpgp_crt_init(ctypes.byref(crt))

1857

2359

# Import the OpenPGP public key into the certificate

1858

(gnutls.library.functions

1859

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

1860

gnutls.library.constants

1861

.GNUTLS_OPENPGP_FMT_RAW))

2360

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

2361

gnutls.OPENPGP_FMT_RAW)

1862

2362

# Verify the self signature in the key

1863

2363

crtverify = ctypes.c_uint()

1864

(gnutls.library.functions

1865

.gnutls_openpgp_crt_verify_self(crt, 0,

1866

ctypes.byref(crtverify)))

2364

gnutls.openpgp_crt_verify_self(crt, 0,

2365

ctypes.byref(crtverify))

1867

2366

if crtverify.value != 0:

1868

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1869

raise (gnutls.errors.CertificateSecurityError

1870

("Verify failed"))

2367

gnutls.openpgp_crt_deinit(crt)

2368

raise gnutls.CertificateSecurityError("Verify failed")

1871

2369

# New buffer for the fingerprint

1872

2370

buf = ctypes.create_string_buffer(20)

1873

2371

buf_len = ctypes.c_size_t()

1874

2372

# Get the fingerprint from the certificate into the buffer

1875

(gnutls.library.functions

1876

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

1877

ctypes.byref(buf_len)))

2373

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

2374

ctypes.byref(buf_len))

1878

2375

# Deinit the certificate

1879

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2376

gnutls.openpgp_crt_deinit(crt)

1880

2377

# Convert the buffer to a Python bytestring

1881

2378

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

1882

2379

# Convert the bytestring to hexadecimal notation

1886

2383

1887

2384

class MultiprocessingMixIn(object):

1888

2385

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

2386

1889

2387

def sub_process_main(self, request, address):

1890

2388

try:

1891

2389

self.finish_request(request, address)

1892

2390

except Exception:

1893

2391

self.handle_error(request, address)

1894

2392

self.close_request(request)

1895

2393

1896

2394

def process_request(self, request, address):

1897

2395

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

1898

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

1899

args = (request, address))

2396

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

2397

args=(request, address))

1900

2398

proc.start()

1901

2399

return proc

1902

2400

1903

2401

1904

2402

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1905

2403

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

2404

1906

2405

def process_request(self, request, client_address):

1907

2406

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

1908

2407

1909

2408

This function creates a new pipe in self.pipe

1910

2409

"""

1911

2410

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1912

2411

1913

2412

proc = MultiprocessingMixIn.process_request(self, request,

1914

2413

client_address)

1915

2414

self.child_pipe.close()

1916

2415

self.add_pipe(parent_pipe, proc)

1917

2416

1918

2417

def add_pipe(self, parent_pipe, proc):

1919

2418

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

1920

2419

raise NotImplementedError()

1923

2422

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1924

2423

socketserver.TCPServer, object):

1925

2424

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

1926

2425

1927

2426

Attributes:

1928

2427

enabled: Boolean; whether this server is activated yet

1929

2428

interface: None or a network interface name (string)

1930

2429

use_ipv6: Boolean; to use IPv6 or not

1931

2430

"""

2431

1932

2432

def __init__(self, server_address, RequestHandlerClass,

1933

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

2433

interface=None,

2434

use_ipv6=True,

2435

socketfd=None):

1934

2436

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

1935

2437

creating a new one with socket.socket().

1936

2438

"""

1942

2444

self.socketfd = socketfd

1943

2445

# Save the original socket.socket() function

1944

2446

self.socket_socket = socket.socket

2447

1945

2448

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

1946

#

2449

#

1947

2450

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

1948

2451

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

1949

2452

# patching socket.socket.)

1950

#

2453

#

1951

2454

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

1952

2455

@functools.wraps(socket.socket)

1953

2456

def socket_wrapper(*args, **kwargs):

1965

2468

# socket_wrapper(), if socketfd was set.

1966

2469

socketserver.TCPServer.__init__(self, server_address,

1967

2470

RequestHandlerClass)

1968

2471

1969

2472

def server_bind(self):

1970

2473

"""This overrides the normal server_bind() function

1971

2474

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

1972

2475

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

2476

global SO_BINDTODEVICE

1973

2477

if self.interface is not None:

1974

2478

if SO_BINDTODEVICE is None:

1975

logger.error("SO_BINDTODEVICE does not exist;"

1976

" cannot bind to interface %s",

1977

self.interface)

1978

else:

1979

try:

1980

self.socket.setsockopt(socket.SOL_SOCKET,

1981

SO_BINDTODEVICE,

1982

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

1983

except socket.error as error:

1984

if error.errno == errno.EPERM:

1985

logger.error("No permission to bind to"

1986

" interface %s", self.interface)

1987

elif error.errno == errno.ENOPROTOOPT:

1988

logger.error("SO_BINDTODEVICE not available;"

1989

" cannot bind to interface %s",

1990

self.interface)

1991

elif error.errno == errno.ENODEV:

1992

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

1993

" cannot bind", self.interface)

1994

else:

1995

raise

2479

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

2480

# common enough.

2481

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

2482

SO_BINDTODEVICE = 25

2483

try:

2484

self.socket.setsockopt(

2485

socket.SOL_SOCKET, SO_BINDTODEVICE,

2486

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

2487

except socket.error as error:

2488

if error.errno == errno.EPERM:

2489

logger.error("No permission to bind to"

2490

" interface %s", self.interface)

2491

elif error.errno == errno.ENOPROTOOPT:

2492

logger.error("SO_BINDTODEVICE not available;"

2493

" cannot bind to interface %s",

2494

self.interface)

2495

elif error.errno == errno.ENODEV:

2496

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

2497

" cannot bind", self.interface)

2498

else:

2499

raise

1996

2500

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

1997

2501

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

1998

2502

if not self.server_address[0]:

1999

2503

if self.address_family == socket.AF_INET6:

2000

any_address = "::" # in6addr_any

2504

any_address = "::" # in6addr_any

2001

2505

else:

2002

any_address = "0.0.0.0" # INADDR_ANY

2506

any_address = "0.0.0.0" # INADDR_ANY

2003

2507

self.server_address = (any_address,

2004

2508

self.server_address[1])

2005

2509

elif not self.server_address[1]:

2006

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

2007

0)

2510

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

2008

2511

# if self.interface:

2009

2512

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

2010

2513

# 0, # port

2016

2519

2017

2520

class MandosServer(IPv6_TCPServer):

2018

2521

"""Mandos server.

2019

2522

2020

2523

Attributes:

2021

2524

clients: set of Client objects

2022

2525

gnutls_priority GnuTLS priority string

2023

2526

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

2024

2025

Assumes a gobject.MainLoop event loop.

2527

2528

Assumes a GLib.MainLoop event loop.

2026

2529

"""

2530

2027

2531

def __init__(self, server_address, RequestHandlerClass,

2028

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

2029

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

2532

interface=None,

2533

use_ipv6=True,

2534

clients=None,

2535

gnutls_priority=None,

2536

use_dbus=True,

2537

socketfd=None):

2030

2538

self.enabled = False

2031

2539

self.clients = clients

2032

2540

if self.clients is None:

2035

2543

self.gnutls_priority = gnutls_priority

2036

2544

IPv6_TCPServer.__init__(self, server_address,

2037

2545

RequestHandlerClass,

2038

interface = interface,

2039

use_ipv6 = use_ipv6,

2040

socketfd = socketfd)

2546

interface=interface,

2547

use_ipv6=use_ipv6,

2548

socketfd=socketfd)

2549

2041

2550

def server_activate(self):

2042

2551

if self.enabled:

2043

2552

return socketserver.TCPServer.server_activate(self)

2044

2553

2045

2554

def enable(self):

2046

2555

self.enabled = True

2047

2556

2048

2557

def add_pipe(self, parent_pipe, proc):

2049

2558

# Call "handle_ipc" for both data and EOF events

2050

gobject.io_add_watch(parent_pipe.fileno(),

2051

gobject.IO_IN | gobject.IO_HUP,

2052

functools.partial(self.handle_ipc,

2053

parent_pipe =

2054

parent_pipe,

2055

proc = proc))

2056

2057

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

2058

proc = None, client_object=None):

2559

GLib.io_add_watch(

2560

parent_pipe.fileno(),

2561

GLib.IO_IN | GLib.IO_HUP,

2562

functools.partial(self.handle_ipc,

2563

parent_pipe=parent_pipe,

2564

proc=proc))

2565

2566

def handle_ipc(self, source, condition,

2567

parent_pipe=None,

2568

proc=None,

2569

client_object=None):

2059

2570

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

2060

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

2571

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

2061

2572

# Wait for other process to exit

2062

2573

proc.join()

2063

2574

return False

2064

2575

2065

2576

# Read a request from the child

2066

2577

request = parent_pipe.recv()

2067

2578

command = request[0]

2068

2579

2069

2580

if command == 'init':

2070

fpr = request[1]

2581

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

2071

2582

address = request[2]

2072

2073

for c in self.clients.itervalues():

2583

2584

for c in self.clients.values():

2074

2585

if c.fingerprint == fpr:

2075

2586

client = c

2076

2587

break

2083

2594

address[0])

2084

2595

parent_pipe.send(False)

2085

2596

return False

2086

2087

gobject.io_add_watch(parent_pipe.fileno(),

2088

gobject.IO_IN | gobject.IO_HUP,

2089

functools.partial(self.handle_ipc,

2090

parent_pipe =

2091

parent_pipe,

2092

proc = proc,

2093

client_object =

2094

client))

2597

2598

GLib.io_add_watch(

2599

parent_pipe.fileno(),

2600

GLib.IO_IN | GLib.IO_HUP,

2601

functools.partial(self.handle_ipc,

2602

parent_pipe=parent_pipe,

2603

proc=proc,

2604

client_object=client))

2095

2605

parent_pipe.send(True)

2096

2606

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

2097

2607

# same fileno

2100

2610

funcname = request[1]

2101

2611

args = request[2]

2102

2612

kwargs = request[3]

2103

2613

2104

2614

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

2105

2615

funcname)(*args,

2106

**kwargs)))

2107

2616

**kwargs)))

2617

2108

2618

if command == 'getattr':

2109

2619

attrname = request[1]

2110

if callable(client_object.__getattribute__(attrname)):

2111

parent_pipe.send(('function',))

2620

if isinstance(client_object.__getattribute__(attrname),

2621

collections.Callable):

2622

parent_pipe.send(('function', ))

2112

2623

else:

2113

parent_pipe.send(('data', client_object

2114

.__getattribute__(attrname)))

2115

2624

parent_pipe.send((

2625

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

2626

2116

2627

if command == 'setattr':

2117

2628

attrname = request[1]

2118

2629

value = request[2]

2119

2630

setattr(client_object, attrname, value)

2120

2631

2121

2632

return True

2122

2633

2123

2634

2124

2635

def rfc3339_duration_to_delta(duration):

2125

2636

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

2126

2637

2127

2638

>>> rfc3339_duration_to_delta("P7D")

2128

2639

datetime.timedelta(7)

2129

2640

>>> rfc3339_duration_to_delta("PT60S")

2139

2650

>>> rfc3339_duration_to_delta("P1DT3M20S")

2140

2651

datetime.timedelta(1, 200)

2141

2652

"""

2142

2653

2143

2654

# Parsing an RFC 3339 duration with regular expressions is not

2144

2655

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

2145

2656

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

2146

2657

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

2147

2658

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

2148

2659

# avoid excessive use of external libraries.

2149

2660

2150

2661

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

2151

Token = collections.namedtuple("Token",

2152

("regexp", # To match token; if

2153

# "value" is not None,

2154

# must have a "group"

2155

# containing digits

2156

"value", # datetime.timedelta or

2157

# None

2158

"followers")) # Tokens valid after

2159

# this token

2662

Token = collections.namedtuple("Token", (

2663

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

2664

# a "group" containing digits

2665

"value", # datetime.timedelta or None

2666

"followers")) # Tokens valid after this token

2160

2667

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

2161

2668

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

2162

2669

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

2163

2670

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

2164

2671

datetime.timedelta(seconds=1),

2165

frozenset((token_end,)))

2672

frozenset((token_end, )))

2166

2673

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

2167

2674

datetime.timedelta(minutes=1),

2168

2675

frozenset((token_second, token_end)))

2184

2691

frozenset((token_month, token_end)))

2185

2692

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

2186

2693

datetime.timedelta(weeks=1),

2187

frozenset((token_end,)))

2694

frozenset((token_end, )))

2188

2695

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

2189

2696

frozenset((token_year, token_month,

2190

2697

token_day, token_time,

2191

token_week))),

2192

# Define starting values

2193

value = datetime.timedelta() # Value so far

2698

token_week)))

2699

# Define starting values:

2700

# Value so far

2701

value = datetime.timedelta()

2194

2702

found_token = None

2195

followers = frozenset(token_duration,) # Following valid tokens

2196

s = duration # String left to parse

2703

# Following valid tokens

2704

followers = frozenset((token_duration, ))

2705

# String left to parse

2706

s = duration

2197

2707

# Loop until end token is found

2198

2708

while found_token is not token_end:

2199

2709

# Search for any currently valid tokens

2215

2725

break

2216

2726

else:

2217

2727

# No currently valid tokens were found

2218

raise ValueError("Invalid RFC 3339 duration")

2728

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

2729

.format(duration))

2219

2730

# End token found

2220

2731

return value

2221

2732

2222

2733

2223

2734

def string_to_delta(interval):

2224

2735

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

2225

2736

2226

2737

>>> string_to_delta('7d')

2227

2738

datetime.timedelta(7)

2228

2739

>>> string_to_delta('60s')

2236

2747

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

2237

2748

datetime.timedelta(0, 330)

2238

2749

"""

2239

2750

2240

2751

try:

2241

2752

return rfc3339_duration_to_delta(interval)

2242

2753

except ValueError:

2243

2754

pass

2244

2755

2245

2756

timevalue = datetime.timedelta(0)

2246

2757

for s in interval.split():

2247

2758

try:

2248

suffix = unicode(s[-1])

2759

suffix = s[-1]

2249

2760

value = int(s[:-1])

2250

2761

if suffix == "d":

2251

2762

delta = datetime.timedelta(value)

2258

2769

elif suffix == "w":

2259

2770

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

2260

2771

else:

2261

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

2262

.format(suffix))

2772

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

2263

2773

except IndexError as e:

2264

2774

raise ValueError(*(e.args))

2265

2775

timevalue += delta

2266

2776

return timevalue

2267

2777

2268

2778

2269

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

2779

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

2270

2780

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

2271

2781

2272

2782

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

2273

2783

if os.fork():

2274

2784

sys.exit()

2282

2792

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

2283

2793

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

2284

2794

raise OSError(errno.ENODEV,

2285

"{0} not a character device"

2795

"{} not a character device"

2286

2796

.format(os.devnull))

2287

2797

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

2288

2798

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

2292

2802

2293

2803

2294

2804

def main():

2295

2805

2296

2806

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

2297

2807

# Parsing of options, both command line and config file

2298

2808

2299

2809

parser = argparse.ArgumentParser()

2300

2810

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

2301

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

2811

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

2302

2812

help="show version number and exit")

2303

2813

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

2304

2814

help="Bind to interface IF")

2340

2850

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

2341

2851

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

2342

2852

default=None)

2343

2853

2344

2854

options = parser.parse_args()

2345

2855

2346

2856

if options.check:

2347

2857

import doctest

2348

2858

fail_count, test_count = doctest.testmod()

2349

2859

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

2350

2860

2351

2861

# Default values for config file for server-global settings

2352

server_defaults = { "interface": "",

2353

"address": "",

2354

"port": "",

2355

"debug": "False",

2356

"priority":

2357

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

2358

"servicename": "Mandos",

2359

"use_dbus": "True",

2360

"use_ipv6": "True",

2361

"debuglevel": "",

2362

"restore": "True",

2363

"socket": "",

2364

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

2365

"foreground": "False",

2366

"zeroconf": "True",

2367

}

2368

2862

server_defaults = {"interface": "",

2863

"address": "",

2864

"port": "",

2865

"debug": "False",

2866

"priority":

2867

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

2868

":+SIGN-DSA-SHA256",

2869

"servicename": "Mandos",

2870

"use_dbus": "True",

2871

"use_ipv6": "True",

2872

"debuglevel": "",

2873

"restore": "True",

2874

"socket": "",

2875

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

2876

"foreground": "False",

2877

"zeroconf": "True",

2878

}

2879

2369

2880

# Parse config file for server-global settings

2370

2881

server_config = configparser.SafeConfigParser(server_defaults)

2371

2882

del server_defaults

2372

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

2373

"mandos.conf"))

2883

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

2374

2884

# Convert the SafeConfigParser object to a dict

2375

2885

server_settings = server_config.defaults()

2376

2886

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

2377

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

2887

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

2888

"foreground", "zeroconf"):

2378

2889

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

2379

2890

option)

2380

2891

if server_settings["port"]:

2390

2901

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

2391

2902

["socket"])

2392

2903

del server_config

2393

2904

2394

2905

# Override the settings from the config file with command line

2395

2906

# options, if set.

2396

2907

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

2397

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

2398

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

2399

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

2908

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

2909

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

2910

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

2400

2911

value = getattr(options, option)

2401

2912

if value is not None:

2402

2913

server_settings[option] = value

2403

2914

del options

2404

2915

# Force all strings to be unicode

2405

2916

for option in server_settings.keys():

2406

if type(server_settings[option]) is str:

2407

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

2917

if isinstance(server_settings[option], bytes):

2918

server_settings[option] = (server_settings[option]

2919

.decode("utf-8"))

2408

2920

# Force all boolean options to be boolean

2409

2921

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

2410

2922

"foreground", "zeroconf"):

2413

2925

if server_settings["debug"]:

2414

2926

server_settings["foreground"] = True

2415

2927

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

2416

2928

2417

2929

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

2418

2419

if (not server_settings["zeroconf"] and

2420

not (server_settings["port"]

2421

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

2422

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

2423

" Zeroconf")

2424

2930

2931

if (not server_settings["zeroconf"]

2932

and not (server_settings["port"]

2933

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

2934

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

2935

2425

2936

# For convenience

2426

2937

debug = server_settings["debug"]

2427

2938

debuglevel = server_settings["debuglevel"]

2431

2942

stored_state_file)

2432

2943

foreground = server_settings["foreground"]

2433

2944

zeroconf = server_settings["zeroconf"]

2434

2945

2435

2946

if debug:

2436

2947

initlogger(debug, logging.DEBUG)

2437

2948

else:

2440

2951

else:

2441

2952

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

2442

2953

initlogger(debug, level)

2443

2954

2444

2955

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

2445

syslogger.setFormatter(logging.Formatter

2446

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

2447

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

2448

.format(server_settings

2449

["servicename"])))

2450

2956

syslogger.setFormatter(

2957

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

2958

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

2959

server_settings["servicename"])))

2960

2451

2961

# Parse config file with clients

2452

2962

client_config = configparser.SafeConfigParser(Client

2453

2963

.client_defaults)

2454

2964

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

2455

2965

"clients.conf"))

2456

2966

2457

2967

global mandos_dbus_service

2458

2968

mandos_dbus_service = None

2459

2969

2460

2970

socketfd = None

2461

2971

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

2462

2972

socketfd = server_settings["socket"]

2463

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

2464

server_settings["port"]),

2465

ClientHandler,

2466

interface=(server_settings["interface"]

2467

or None),

2468

use_ipv6=use_ipv6,

2469

gnutls_priority=

2470

server_settings["priority"],

2471

use_dbus=use_dbus,

2472

socketfd=socketfd)

2973

tcp_server = MandosServer(

2974

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

2975

ClientHandler,

2976

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

2977

use_ipv6=use_ipv6,

2978

gnutls_priority=server_settings["priority"],

2979

use_dbus=use_dbus,

2980

socketfd=socketfd)

2473

2981

if not foreground:

2474

2982

pidfilename = "/run/mandos.pid"

2475

2983

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

2476

2984

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

2477

2985

pidfile = None

2478

2986

try:

2479

pidfile = open(pidfilename, "w")

2987

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

2480

2988

except IOError as e:

2481

2989

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

2482

2990

exc_info=e)

2483

2484

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

2991

2992

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

2993

("mandos", "mandos"),

2994

("nobody", "nogroup")):

2485

2995

try:

2486

2996

uid = pwd.getpwnam(name).pw_uid

2487

gid = pwd.getpwnam(name).pw_gid

2997

gid = pwd.getpwnam(group).pw_gid

2488

2998

break

2489

2999

except KeyError:

2490

3000

continue

2494

3004

try:

2495

3005

os.setgid(gid)

2496

3006

os.setuid(uid)

3007

if debug:

3008

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

3009

gid))

2497

3010

except OSError as error:

3011

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

3012

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

2498

3013

if error.errno != errno.EPERM:

2499

3014

raise

2500

3015

2501

3016

if debug:

2502

3017

# Enable all possible GnuTLS debugging

2503

3018

2504

3019

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

2505

3020

# - GnuTLS manual

2506

gnutls.library.functions.gnutls_global_set_log_level(11)

2507

2508

@gnutls.library.types.gnutls_log_func

3021

gnutls.global_set_log_level(11)

3022

3023

@gnutls.log_func

2509

3024

def debug_gnutls(level, string):

2510

3025

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

2511

2512

(gnutls.library.functions

2513

.gnutls_global_set_log_function(debug_gnutls))

2514

3026

3027

gnutls.global_set_log_function(debug_gnutls)

3028

2515

3029

# Redirect stdin so all checkers get /dev/null

2516

3030

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

2517

3031

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

2518

3032

if null > 2:

2519

3033

os.close(null)

2520

3034

2521

3035

# Need to fork before connecting to D-Bus

2522

3036

if not foreground:

2523

3037

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

2524

3038

daemon()

2525

2526

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

2527

# need to inform gobject that threads will be used.

2528

gobject.threads_init()

2529

3039

3040

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

3041

# to inform GLib that threads will be used.

3042

GLib.threads_init()

3043

2530

3044

global main_loop

2531

3045

# From the Avahi example code

2532

3046

DBusGMainLoop(set_as_default=True)

2533

main_loop = gobject.MainLoop()

3047

main_loop = GLib.MainLoop()

2534

3048

bus = dbus.SystemBus()

2535

3049

# End of Avahi example code

2536

3050

if use_dbus:

2537

3051

try:

2538

3052

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

2539

bus, do_not_queue=True)

2540

old_bus_name = (dbus.service.BusName

2541

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

2542

do_not_queue=True))

2543

except dbus.exceptions.NameExistsException as e:

3053

bus,

3054

do_not_queue=True)

3055

old_bus_name = dbus.service.BusName(

3056

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

3057

do_not_queue=True)

3058

except dbus.exceptions.DBusException as e:

2544

3059

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

2545

3060

use_dbus = False

2546

3061

server_settings["use_dbus"] = False

2547

3062

tcp_server.use_dbus = False

2548

3063

if zeroconf:

2549

3064

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2550

service = AvahiServiceToSyslog(name =

2551

server_settings["servicename"],

2552

servicetype = "_mandos._tcp",

2553

protocol = protocol, bus = bus)

3065

service = AvahiServiceToSyslog(

3066

name=server_settings["servicename"],

3067

servicetype="_mandos._tcp",

3068

protocol=protocol,

3069

bus=bus)

2554

3070

if server_settings["interface"]:

2555

service.interface = (if_nametoindex

2556

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

2557

3071

service.interface = if_nametoindex(

3072

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

3073

2558

3074

global multiprocessing_manager

2559

3075

multiprocessing_manager = multiprocessing.Manager()

2560

3076

2561

3077

client_class = Client

2562

3078

if use_dbus:

2563

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

2564

3079

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

3080

2565

3081

client_settings = Client.config_parser(client_config)

2566

3082

old_client_settings = {}

2567

3083

clients_data = {}

2568

3084

2569

3085

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

2570

3086

global wnull

2571

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

3087

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

2572

3088

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

2573

3089

# mode

2574

3090

if debug or not foreground:

2575

3091

wnull.close()

2576

3092

2577

3093

# Get client data and settings from last running state.

2578

3094

if server_settings["restore"]:

2579

3095

try:

2580

3096

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

2581

clients_data, old_client_settings = (pickle.load

2582

(stored_state))

3097

if sys.version_info.major == 2:

3098

clients_data, old_client_settings = pickle.load(

3099

stored_state)

3100

else:

3101

bytes_clients_data, bytes_old_client_settings = (

3102

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

3103

# Fix bytes to strings

3104

# clients_data

3105

# .keys()

3106

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

3107

if isinstance(key, bytes)

3108

else key): value

3109

for key, value in

3110

bytes_clients_data.items()}

3111

del bytes_clients_data

3112

for key in clients_data:

3113

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

3114

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

3115

for k, v in

3116

clients_data[key].items()}

3117

clients_data[key] = value

3118

# .client_structure

3119

value["client_structure"] = [

3120

(s.decode("utf-8")

3121

if isinstance(s, bytes)

3122

else s) for s in

3123

value["client_structure"]]

3124

# .name & .host

3125

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

3126

if isinstance(value[k], bytes):

3127

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

3128

# old_client_settings

3129

# .keys()

3130

old_client_settings = {

3131

(key.decode("utf-8")

3132

if isinstance(key, bytes)

3133

else key): value

3134

for key, value in

3135

bytes_old_client_settings.items()}

3136

del bytes_old_client_settings

3137

# .host

3138

for value in old_client_settings.values():

3139

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

3140

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

3141

.decode("utf-8"))

2583

3142

os.remove(stored_state_path)

2584

3143

except IOError as e:

2585

3144

if e.errno == errno.ENOENT:

2586

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

2587

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

3145

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

3146

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

2588

3147

else:

2589

3148

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

2590

3149

exc_info=e)

2591

3150

raise

2592

3151

except EOFError as e:

2593

3152

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

2594

"EOFError:", exc_info=e)

2595

3153

"EOFError:",

3154

exc_info=e)

3155

2596

3156

with PGPEngine() as pgp:

2597

for client_name, client in clients_data.iteritems():

3157

for client_name, client in clients_data.items():

2598

3158

# Skip removed clients

2599

3159

if client_name not in client_settings:

2600

3160

continue

2601

3161

2602

3162

# Decide which value to use after restoring saved state.

2603

3163

# We have three different values: Old config file,

2604

3164

# new config file, and saved state.

2609

3169

# For each value in new config, check if it

2610

3170

# differs from the old config value (Except for

2611

3171

# the "secret" attribute)

2612

if (name != "secret" and

2613

value != old_client_settings[client_name]

2614

[name]):

3172

if (name != "secret"

3173

and (value !=

3174

old_client_settings[client_name][name])):

2615

3175

client[name] = value

2616

3176

except KeyError:

2617

3177

pass

2618

3178

2619

3179

# Clients who has passed its expire date can still be

2620

# enabled if its last checker was successful. Clients

3180

# enabled if its last checker was successful. A Client

2621

3181

# whose checker succeeded before we stored its state is

2622

3182

# assumed to have successfully run all checkers during

2623

3183

# downtime.

2625

3185

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

2626

3186

if not client["last_checked_ok"]:

2627

3187

logger.warning(

2628

"disabling client {0} - Client never "

2629

"performed a successful checker"

2630

.format(client_name))

3188

"disabling client {} - Client never "

3189

"performed a successful checker".format(

3190

client_name))

2631

3191

client["enabled"] = False

2632

3192

elif client["last_checker_status"] != 0:

2633

3193

logger.warning(

2634

"disabling client {0} - Client "

2635

"last checker failed with error code {1}"

2636

.format(client_name,

2637

client["last_checker_status"]))

3194

"disabling client {} - Client last"

3195

" checker failed with error code"

3196

" {}".format(

3197

client_name,

3198

client["last_checker_status"]))

2638

3199

client["enabled"] = False

2639

3200

else:

2640

client["expires"] = (datetime.datetime

2641

.utcnow()

2642

+ client["timeout"])

3201

client["expires"] = (

3202

datetime.datetime.utcnow()

3203

+ client["timeout"])

2643

3204

logger.debug("Last checker succeeded,"

2644

" keeping {0} enabled"

2645

.format(client_name))

3205

" keeping {} enabled".format(

3206

client_name))

2646

3207

try:

2647

client["secret"] = (

2648

pgp.decrypt(client["encrypted_secret"],

2649

client_settings[client_name]

2650

["secret"]))

3208

client["secret"] = pgp.decrypt(

3209

client["encrypted_secret"],

3210

client_settings[client_name]["secret"])

2651

3211

except PGPError:

2652

3212

# If decryption fails, we use secret from new settings

2653

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

2654

.format(client_name))

2655

client["secret"] = (

2656

client_settings[client_name]["secret"])

2657

3213

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

3214

client_name))

3215

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

3216

["secret"])

3217

2658

3218

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

2659

3219

for client_name in (set(old_client_settings)

2660

3220

- set(client_settings)):

2662

3222

for client_name in (set(client_settings)

2663

3223

- set(old_client_settings)):

2664

3224

clients_data[client_name] = client_settings[client_name]

2665

3225

2666

3226

# Create all client objects

2667

for client_name, client in clients_data.iteritems():

3227

for client_name, client in clients_data.items():

2668

3228

tcp_server.clients[client_name] = client_class(

2669

name = client_name, settings = client,

2670

server_settings = server_settings)

2671

3229

name=client_name,

3230

settings=client,

3231

server_settings=server_settings)

3232

2672

3233

if not tcp_server.clients:

2673

3234

logger.warning("No clients defined")

2674

3235

2675

3236

if not foreground:

2676

3237

if pidfile is not None:

3238

pid = os.getpid()

2677

3239

try:

2678

3240

with pidfile:

2679

pid = os.getpid()

2680

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

3241

print(pid, file=pidfile)

2681

3242

except IOError:

2682

3243

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

2683

3244

pidfilename, pid)

2684

3245

del pidfile

2685

3246

del pidfilename

2686

2687

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

2688

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

2689

3247

3248

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

3249

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3250

lambda: main_loop.quit() and False)

3251

2690

3252

if use_dbus:

2691

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

2692

"se.bsnet.fukt.Mandos"})

2693

class MandosDBusService(DBusObjectWithProperties):

3253

3254

@alternate_dbus_interfaces(

3255

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

3256

class MandosDBusService(DBusObjectWithObjectManager):

2694

3257

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

3258

2695

3259

def __init__(self):

2696

3260

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

3261

2697

3262

_interface = "se.recompile.Mandos"

2698

2699

@dbus_interface_annotations(_interface)

2700

def _foo(self):

2701

return { "org.freedesktop.DBus.Property"

2702

".EmitsChangedSignal":

2703

"false"}

2704

3263

2705

3264

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

2706

3265

def ClientAdded(self, objpath):

2707

3266

"D-Bus signal"

2708

3267

pass

2709

3268

2710

3269

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

2711

3270

def ClientNotFound(self, fingerprint, address):

2712

3271

"D-Bus signal"

2713

3272

pass

2714

3273

3274

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

3275

"true"})

2715

3276

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

2716

3277

def ClientRemoved(self, objpath, name):

2717

3278

"D-Bus signal"

2718

3279

pass

2719

3280

3281

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

3282

"true"})

2720

3283

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

2721

3284

def GetAllClients(self):

2722

3285

"D-Bus method"

2723

return dbus.Array(c.dbus_object_path

2724

for c in

2725

tcp_server.clients.itervalues())

2726

3286

return dbus.Array(c.dbus_object_path for c in

3287

tcp_server.clients.values())

3288

3289

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

3290

"true"})

2727

3291

@dbus.service.method(_interface,

2728

3292

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

2729

3293

def GetAllClientsWithProperties(self):

2730

3294

"D-Bus method"

2731

3295

return dbus.Dictionary(

2732

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

2733

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

3296

{c.dbus_object_path: c.GetAll(

3297

"se.recompile.Mandos.Client")

3298

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

2734

3299

signature="oa{sv}")

2735

3300

2736

3301

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

2737

3302

def RemoveClient(self, object_path):

2738

3303

"D-Bus method"

2739

for c in tcp_server.clients.itervalues():

3304

for c in tcp_server.clients.values():

2740

3305

if c.dbus_object_path == object_path:

2741

3306

del tcp_server.clients[c.name]

2742

3307

c.remove_from_connection()

2743

# Don't signal anything except ClientRemoved

3308

# Don't signal the disabling

2744

3309

c.disable(quiet=True)

2745

# Emit D-Bus signal

2746

self.ClientRemoved(object_path, c.name)

3310

# Emit D-Bus signal for removal

3311

self.client_removed_signal(c)

2747

3312

return

2748

3313

raise KeyError(object_path)

2749

3314

2750

3315

del _interface

2751

3316

3317

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3318

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

3319

def GetManagedObjects(self):

3320

"""D-Bus method"""

3321

return dbus.Dictionary(

3322

{client.dbus_object_path:

3323

dbus.Dictionary(

3324

{interface: client.GetAll(interface)

3325

for interface in

3326

client._get_all_interface_names()})

3327

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

3328

3329

def client_added_signal(self, client):

3330

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

3331

if use_dbus:

3332

# New standard signal

3333

self.InterfacesAdded(

3334

client.dbus_object_path,

3335

dbus.Dictionary(

3336

{interface: client.GetAll(interface)

3337

for interface in

3338

client._get_all_interface_names()}))

3339

# Old signal

3340

self.ClientAdded(client.dbus_object_path)

3341

3342

def client_removed_signal(self, client):

3343

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

3344

if use_dbus:

3345

# New standard signal

3346

self.InterfacesRemoved(

3347

client.dbus_object_path,

3348

client._get_all_interface_names())

3349

# Old signal

3350

self.ClientRemoved(client.dbus_object_path,

3351

client.name)

3352

2752

3353

mandos_dbus_service = MandosDBusService()

2753

3354

3355

# Save modules to variables to exempt the modules from being

3356

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

3357

mp = multiprocessing

3358

wn = wnull

3359

2754

3360

def cleanup():

2755

3361

"Cleanup function; run on exit"

2756

3362

if zeroconf:

2757

3363

service.cleanup()

2758

2759

multiprocessing.active_children()

2760

wnull.close()

3364

3365

mp.active_children()

3366

wn.close()

2761

3367

if not (tcp_server.clients or client_settings):

2762

3368

return

2763

3369

2764

3370

# Store client before exiting. Secrets are encrypted with key

2765

3371

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

2766

3372

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

2767

3373

clients = {}

2768

3374

with PGPEngine() as pgp:

2769

for client in tcp_server.clients.itervalues():

3375

for client in tcp_server.clients.values():

2770

3376

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

2771

3377

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

2772

3378

key)

2773

3379

client_dict = {}

2774

3380

2775

3381

# A list of attributes that can not be pickled

2776

3382

# + secret.

2777

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

2778

"checker", "server_settings"))

2779

for name, typ in (inspect.getmembers

2780

(dbus.service.Object)):

3383

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

3384

"checker", "server_settings"}

3385

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

3386

.Object):

2781

3387

exclude.add(name)

2782

3388

2783

3389

client_dict["encrypted_secret"] = (client

2784

3390

.encrypted_secret)

2785

3391

for attr in client.client_structure:

2786

3392

if attr not in exclude:

2787

3393

client_dict[attr] = getattr(client, attr)

2788

3394

2789

3395

clients[client.name] = client_dict

2790

3396

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

2791

3397

2792

3398

try:

2793

with (tempfile.NamedTemporaryFile

2794

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

2795

dir=os.path.dirname(stored_state_path),

2796

delete=False)) as stored_state:

2797

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

2798

tempname=stored_state.name

3399

with tempfile.NamedTemporaryFile(

3400

mode='wb',

3401

suffix=".pickle",

3402

prefix='clients-',

3403

dir=os.path.dirname(stored_state_path),

3404

delete=False) as stored_state:

3405

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

3406

protocol=2)

3407

tempname = stored_state.name

2799

3408

os.rename(tempname, stored_state_path)

2800

3409

except (IOError, OSError) as e:

2801

3410

if not debug:

2804

3413

except NameError:

2805

3414

pass

2806

3415

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

2807

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

3416

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

2808

3417

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

2809

3418

else:

2810

3419

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

2811

3420

exc_info=e)

2812

3421

raise

2813

3422

2814

3423

# Delete all clients, and settings from config

2815

3424

while tcp_server.clients:

2816

3425

name, client = tcp_server.clients.popitem()

2817

3426

if use_dbus:

2818

3427

client.remove_from_connection()

2819

# Don't signal anything except ClientRemoved

3428

# Don't signal the disabling

2820

3429

client.disable(quiet=True)

3430

# Emit D-Bus signal for removal

2821

3431

if use_dbus:

2822

# Emit D-Bus signal

2823

mandos_dbus_service.ClientRemoved(client

2824

.dbus_object_path,

2825

client.name)

3432

mandos_dbus_service.client_removed_signal(client)

2826

3433

client_settings.clear()

2827

3434

2828

3435

atexit.register(cleanup)

2829

2830

for client in tcp_server.clients.itervalues():

3436

3437

for client in tcp_server.clients.values():

2831

3438

if use_dbus:

2832

# Emit D-Bus signal

2833

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3439

# Emit D-Bus signal for adding

3440

mandos_dbus_service.client_added_signal(client)

2834

3441

# Need to initiate checking of clients

2835

3442

if client.enabled:

2836

3443

client.init_checker()

2837

3444

2838

3445

tcp_server.enable()

2839

3446

tcp_server.server_activate()

2840

3447

2841

3448

# Find out what port we got

2842

3449

if zeroconf:

2843

3450

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

2848

3455

else: # IPv4

2849

3456

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

2850

3457

*tcp_server.socket.getsockname())

2851

2852

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

2853

3458

3459

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

3460

2854

3461

try:

2855

3462

if zeroconf:

2856

3463

# From the Avahi example code

2861

3468

cleanup()

2862

3469

sys.exit(1)

2863

3470

# End of Avahi example code

2864

2865

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

2866

lambda *args, **kwargs:

2867

(tcp_server.handle_request

2868

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

2869

3471

3472

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

3473

lambda *args, **kwargs:

3474

(tcp_server.handle_request

3475

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

3476

2870

3477

logger.debug("Starting main loop")

2871

3478

main_loop.run()

2872

3479

except AvahiError as error:

2881

3488

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

2882

3489

cleanup()

2883

3490

3491

2884

3492

if __name__ == '__main__':

2885

3493

main()