/mandos/trunk : revision 237.4.116

1

#!/usr/bin/python2.7

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

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

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

109

136

return interface_index

110

137

111

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

112

155

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

113

156

"""init logger and add loglevel"""

114

157

115

158

global syslogger

116

syslogger = (logging.handlers.SysLogHandler

117

(facility =

118

logging.handlers.SysLogHandler.LOG_DAEMON,

119

address = "/dev/log"))

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

120

162

syslogger.setFormatter(logging.Formatter

121

163

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

122

164

' %(message)s'))

123

165

logger.addHandler(syslogger)

124

166

125

167

if debug:

126

168

console = logging.StreamHandler()

127

169

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

139

181

140

182

class PGPEngine(object):

141

183

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

184

142

185

def __init__(self):

143

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

144

198

self.gnupgargs = ['--batch',

145

'--home', self.tempdir,

199

'--homedir', self.tempdir,

146

200

'--force-mdc',

147

'--quiet',

148

'--no-use-agent']

149

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

150

206

def __enter__(self):

151

207

return self

152

208

153

209

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

154

210

self._cleanup()

155

211

return False

156

212

157

213

def __del__(self):

158

214

self._cleanup()

159

215

160

216

def _cleanup(self):

161

217

if self.tempdir is not None:

162

218

# Delete contents of tempdir

163

219

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

164

topdown = False):

220

topdown=False):

165

221

for filename in files:

166

222

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

167

223

for dirname in dirs:

169

225

# Remove tempdir

170

226

os.rmdir(self.tempdir)

171

227

self.tempdir = None

172

228

173

229

def password_encode(self, password):

174

230

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

175

231

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

180

236

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

181

237

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

182

238

return encoded

183

239

184

240

def encrypt(self, data, password):

185

241

passphrase = self.password_encode(password)

186

with tempfile.NamedTemporaryFile(dir=self.tempdir

187

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

188

244

passfile.write(passphrase)

189

245

passfile.flush()

190

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

246

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

191

247

'--passphrase-file',

192

248

passfile.name]

193

249

+ self.gnupgargs,

194

stdin = subprocess.PIPE,

195

stdout = subprocess.PIPE,

196

stderr = subprocess.PIPE)

197

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)

198

254

if proc.returncode != 0:

199

255

raise PGPError(err)

200

256

return ciphertext

201

257

202

258

def decrypt(self, data, password):

203

259

passphrase = self.password_encode(password)

204

with tempfile.NamedTemporaryFile(dir = self.tempdir

205

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

206

262

passfile.write(passphrase)

207

263

passfile.flush()

208

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

264

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

209

265

'--passphrase-file',

210

266

passfile.name]

211

267

+ self.gnupgargs,

212

stdin = subprocess.PIPE,

213

stdout = subprocess.PIPE,

214

stderr = subprocess.PIPE)

215

decrypted_plaintext, err = proc.communicate(input

216

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

217

272

if proc.returncode != 0:

218

273

raise PGPError(err)

219

274

return decrypted_plaintext

220

275

221

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

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

281

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

282

PROTO_INET = 0 # avahi-common/address.h

283

PROTO_INET6 = 1 # avahi-common/address.h

284

DBUS_NAME = "org.freedesktop.Avahi"

285

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

286

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

287

DBUS_PATH_SERVER = "/"

288

289

@staticmethod

290

def string_array_to_txt_array(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

302

222

303

class AvahiError(Exception):

223

304

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

224

305

self.value = value

225

306

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

226

307

**kwargs)

227

308

309

228

310

class AvahiServiceError(AvahiError):

229

311

pass

230

312

313

231

314

class AvahiGroupError(AvahiError):

232

315

pass

233

316

234

317

235

318

class AvahiService(object):

236

319

"""An Avahi (Zeroconf) service.

237

320

238

321

Attributes:

239

322

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

240

323

Used to optionally bind to the specified interface.

252

335

server: D-Bus Server

253

336

bus: dbus.SystemBus()

254

337

"""

255

256

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

257

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

258

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

259

protocol = avahi.PROTO_UNSPEC, bus = None):

338

339

def __init__(self,

340

interface=avahi.IF_UNSPEC,

341

name=None,

342

servicetype=None,

343

port=None,

344

TXT=None,

345

domain="",

346

host="",

347

max_renames=32768,

348

protocol=avahi.PROTO_UNSPEC,

349

bus=None):

260

350

self.interface = interface

261

351

self.name = name

262

352

self.type = servicetype

271

361

self.server = None

272

362

self.bus = bus

273

363

self.entry_group_state_changed_match = None

274

275

def rename(self):

364

365

def rename(self, remove=True):

276

366

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

277

367

if self.rename_count >= self.max_renames:

278

368

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

279

369

" after %i retries, exiting.",

280

370

self.rename_count)

281

371

raise AvahiServiceError("Too many renames")

282

self.name = unicode(self.server

283

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

284

375

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

285

376

self.name)

286

self.remove()

377

if remove:

378

self.remove()

287

379

try:

288

380

self.add()

289

381

except dbus.exceptions.DBusException as error:

290

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

291

self.cleanup()

292

os._exit(1)

293

self.rename_count += 1

294

382

if (error.get_dbus_name()

383

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

384

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

385

return self.rename(remove=False)

386

else:

387

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

388

self.cleanup()

389

os._exit(1)

390

295

391

def remove(self):

296

392

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

297

393

if self.entry_group_state_changed_match is not None:

299

395

self.entry_group_state_changed_match = None

300

396

if self.group is not None:

301

397

self.group.Reset()

302

398

303

399

def add(self):

304

400

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

305

401

self.remove()

322

418

dbus.UInt16(self.port),

323

419

avahi.string_array_to_txt_array(self.TXT))

324

420

self.group.Commit()

325

421

326

422

def entry_group_state_changed(self, state, error):

327

423

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

328

424

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

329

425

330

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

331

427

logger.debug("Zeroconf service established.")

332

428

elif state == avahi.ENTRY_GROUP_COLLISION:

334

430

self.rename()

335

431

elif state == avahi.ENTRY_GROUP_FAILURE:

336

432

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

337

unicode(error))

338

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

339

.format(error))

340

433

str(error))

434

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

435

341

436

def cleanup(self):

342

437

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

343

438

if self.group is not None:

348

443

pass

349

444

self.group = None

350

445

self.remove()

351

446

352

447

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

353

448

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

354

449

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

355

bad_states = { avahi.SERVER_INVALID:

356

"Zeroconf server invalid",

357

avahi.SERVER_REGISTERING: None,

358

avahi.SERVER_COLLISION:

359

"Zeroconf server name collision",

360

avahi.SERVER_FAILURE:

361

"Zeroconf server failure" }

450

bad_states = {

451

avahi.SERVER_INVALID: "Zeroconf server invalid",

452

avahi.SERVER_REGISTERING: None,

453

avahi.SERVER_COLLISION: "Zeroconf server name collision",

454

avahi.SERVER_FAILURE: "Zeroconf server failure",

455

}

362

456

if state in bad_states:

363

457

if bad_states[state] is not None:

364

458

if error is None:

367

461

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

368

462

self.cleanup()

369

463

elif state == avahi.SERVER_RUNNING:

370

self.add()

464

try:

465

self.add()

466

except dbus.exceptions.DBusException as error:

467

if (error.get_dbus_name()

468

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

469

logger.info("Local Zeroconf service name"

470

" collision.")

471

return self.rename(remove=False)

472

else:

473

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

474

self.cleanup()

475

os._exit(1)

371

476

else:

372

477

if error is None:

373

478

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

374

479

else:

375

480

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

376

481

377

482

def activate(self):

378

483

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

379

484

if self.server is None:

383

488

follow_name_owner_changes=True),

384

489

avahi.DBUS_INTERFACE_SERVER)

385

490

self.server.connect_to_signal("StateChanged",

386

self.server_state_changed)

491

self.server_state_changed)

387

492

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

388

493

389

494

390

495

class AvahiServiceToSyslog(AvahiService):

391

def rename(self):

496

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

392

497

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

393

ret = AvahiService.rename(self)

394

syslogger.setFormatter(logging.Formatter

395

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

396

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

397

.format(self.name)))

498

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

499

syslogger.setFormatter(logging.Formatter(

500

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

501

.format(self.name)))

398

502

return ret

399

503

400

504

505

# Pretend that we have a GnuTLS module

506

class gnutls(object):

507

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

508

509

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

510

if library is None:

511

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

512

_library = ctypes.cdll.LoadLibrary(library)

513

del library

514

515

# Unless otherwise indicated, the constants and types below are

516

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

517

518

# Constants

519

E_SUCCESS = 0

520

E_INTERRUPTED = -52

521

E_AGAIN = -28

522

CRT_OPENPGP = 2

523

CRT_RAWPK = 3

524

CLIENT = 2

525

SHUT_RDWR = 0

526

CRD_CERTIFICATE = 1

527

E_NO_CERTIFICATE_FOUND = -49

528

X509_FMT_DER = 0

529

NO_TICKETS = 1<<10

530

ENABLE_RAWPK = 1<<18

531

CTYPE_PEERS = 3

532

KEYID_USE_SHA256 = 1 # gnutls/x509.h

533

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

534

535

# Types

536

class session_int(ctypes.Structure):

537

_fields_ = []

538

session_t = ctypes.POINTER(session_int)

539

540

class certificate_credentials_st(ctypes.Structure):

541

_fields_ = []

542

certificate_credentials_t = ctypes.POINTER(

543

certificate_credentials_st)

544

certificate_type_t = ctypes.c_int

545

546

class datum_t(ctypes.Structure):

547

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

548

('size', ctypes.c_uint)]

549

550

class openpgp_crt_int(ctypes.Structure):

551

_fields_ = []

552

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

553

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

554

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

555

credentials_type_t = ctypes.c_int

556

transport_ptr_t = ctypes.c_void_p

557

close_request_t = ctypes.c_int

558

559

# Exceptions

560

class Error(Exception):

561

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

562

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

563

# code is passed, convert it to a string with

564

# gnutls.strerror()

565

self.code = code

566

if message is None and code is not None:

567

message = gnutls.strerror(code)

568

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

569

message, *args)

570

571

class CertificateSecurityError(Error):

572

pass

573

574

# Classes

575

class Credentials(object):

576

def __init__(self):

577

self._c_object = gnutls.certificate_credentials_t()

578

gnutls.certificate_allocate_credentials(

579

ctypes.byref(self._c_object))

580

self.type = gnutls.CRD_CERTIFICATE

581

582

def __del__(self):

583

gnutls.certificate_free_credentials(self._c_object)

584

585

class ClientSession(object):

586

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

587

self._c_object = gnutls.session_t()

588

gnutls_flags = gnutls.CLIENT

589

if gnutls.check_version(b"3.5.6"):

590

gnutls_flags |= gnutls.NO_TICKETS

591

if gnutls.has_rawpk:

592

gnutls_flags |= gnutls.ENABLE_RAWPK

593

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

594

del gnutls_flags

595

gnutls.set_default_priority(self._c_object)

596

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

597

gnutls.handshake_set_private_extensions(self._c_object,

598

True)

599

self.socket = socket

600

if credentials is None:

601

credentials = gnutls.Credentials()

602

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

603

ctypes.cast(credentials._c_object,

604

ctypes.c_void_p))

605

self.credentials = credentials

606

607

def __del__(self):

608

gnutls.deinit(self._c_object)

609

610

def handshake(self):

611

return gnutls.handshake(self._c_object)

612

613

def send(self, data):

614

data = bytes(data)

615

data_len = len(data)

616

while data_len > 0:

617

data_len -= gnutls.record_send(self._c_object,

618

data[-data_len:],

619

data_len)

620

621

def bye(self):

622

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

623

624

# Error handling functions

625

def _error_code(result):

626

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

627

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

628

if result >= 0:

629

return result

630

if result == gnutls.E_NO_CERTIFICATE_FOUND:

631

raise gnutls.CertificateSecurityError(code=result)

632

raise gnutls.Error(code=result)

633

634

def _retry_on_error(result, func, arguments):

635

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

636

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

637

while result < 0:

638

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

639

return _error_code(result)

640

result = func(*arguments)

641

return result

642

643

# Unless otherwise indicated, the function declarations below are

644

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

645

646

# Functions

647

priority_set_direct = _library.gnutls_priority_set_direct

648

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

649

ctypes.POINTER(ctypes.c_char_p)]

650

priority_set_direct.restype = _error_code

651

652

init = _library.gnutls_init

653

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

654

init.restype = _error_code

655

656

set_default_priority = _library.gnutls_set_default_priority

657

set_default_priority.argtypes = [session_t]

658

set_default_priority.restype = _error_code

659

660

record_send = _library.gnutls_record_send

661

record_send.argtypes = [session_t, ctypes.c_void_p,

662

ctypes.c_size_t]

663

record_send.restype = ctypes.c_ssize_t

664

record_send.errcheck = _retry_on_error

665

666

certificate_allocate_credentials = (

667

_library.gnutls_certificate_allocate_credentials)

668

certificate_allocate_credentials.argtypes = [

669

ctypes.POINTER(certificate_credentials_t)]

670

certificate_allocate_credentials.restype = _error_code

671

672

certificate_free_credentials = (

673

_library.gnutls_certificate_free_credentials)

674

certificate_free_credentials.argtypes = [

675

certificate_credentials_t]

676

certificate_free_credentials.restype = None

677

678

handshake_set_private_extensions = (

679

_library.gnutls_handshake_set_private_extensions)

680

handshake_set_private_extensions.argtypes = [session_t,

681

ctypes.c_int]

682

handshake_set_private_extensions.restype = None

683

684

credentials_set = _library.gnutls_credentials_set

685

credentials_set.argtypes = [session_t, credentials_type_t,

686

ctypes.c_void_p]

687

credentials_set.restype = _error_code

688

689

strerror = _library.gnutls_strerror

690

strerror.argtypes = [ctypes.c_int]

691

strerror.restype = ctypes.c_char_p

692

693

certificate_type_get = _library.gnutls_certificate_type_get

694

certificate_type_get.argtypes = [session_t]

695

certificate_type_get.restype = _error_code

696

697

certificate_get_peers = _library.gnutls_certificate_get_peers

698

certificate_get_peers.argtypes = [session_t,

699

ctypes.POINTER(ctypes.c_uint)]

700

certificate_get_peers.restype = ctypes.POINTER(datum_t)

701

702

global_set_log_level = _library.gnutls_global_set_log_level

703

global_set_log_level.argtypes = [ctypes.c_int]

704

global_set_log_level.restype = None

705

706

global_set_log_function = _library.gnutls_global_set_log_function

707

global_set_log_function.argtypes = [log_func]

708

global_set_log_function.restype = None

709

710

deinit = _library.gnutls_deinit

711

deinit.argtypes = [session_t]

712

deinit.restype = None

713

714

handshake = _library.gnutls_handshake

715

handshake.argtypes = [session_t]

716

handshake.restype = _error_code

717

handshake.errcheck = _retry_on_error

718

719

transport_set_ptr = _library.gnutls_transport_set_ptr

720

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

721

transport_set_ptr.restype = None

722

723

bye = _library.gnutls_bye

724

bye.argtypes = [session_t, close_request_t]

725

bye.restype = _error_code

726

bye.errcheck = _retry_on_error

727

728

check_version = _library.gnutls_check_version

729

check_version.argtypes = [ctypes.c_char_p]

730

check_version.restype = ctypes.c_char_p

731

732

_need_version = b"3.3.0"

733

if check_version(_need_version) is None:

734

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

735

.format(_need_version))

736

737

_tls_rawpk_version = b"3.6.6"

738

has_rawpk = bool(check_version(_tls_rawpk_version))

739

740

if has_rawpk:

741

# Types

742

class pubkey_st(ctypes.Structure):

743

_fields = []

744

pubkey_t = ctypes.POINTER(pubkey_st)

745

746

x509_crt_fmt_t = ctypes.c_int

747

748

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

749

pubkey_init = _library.gnutls_pubkey_init

750

pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]

751

pubkey_init.restype = _error_code

752

753

pubkey_import = _library.gnutls_pubkey_import

754

pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),

755

x509_crt_fmt_t]

756

pubkey_import.restype = _error_code

757

758

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

759

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

760

ctypes.POINTER(ctypes.c_ubyte),

761

ctypes.POINTER(ctypes.c_size_t)]

762

pubkey_get_key_id.restype = _error_code

763

764

pubkey_deinit = _library.gnutls_pubkey_deinit

765

pubkey_deinit.argtypes = [pubkey_t]

766

pubkey_deinit.restype = None

767

else:

768

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

769

770

openpgp_crt_init = _library.gnutls_openpgp_crt_init

771

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

772

openpgp_crt_init.restype = _error_code

773

774

openpgp_crt_import = _library.gnutls_openpgp_crt_import

775

openpgp_crt_import.argtypes = [openpgp_crt_t,

776

ctypes.POINTER(datum_t),

777

openpgp_crt_fmt_t]

778

openpgp_crt_import.restype = _error_code

779

780

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

781

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

782

ctypes.POINTER(ctypes.c_uint)]

783

openpgp_crt_verify_self.restype = _error_code

784

785

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

786

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

787

openpgp_crt_deinit.restype = None

788

789

openpgp_crt_get_fingerprint = (

790

_library.gnutls_openpgp_crt_get_fingerprint)

791

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

792

ctypes.c_void_p,

793

ctypes.POINTER(

794

ctypes.c_size_t)]

795

openpgp_crt_get_fingerprint.restype = _error_code

796

797

if check_version(b"3.6.4"):

798

certificate_type_get2 = _library.gnutls_certificate_type_get2

799

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

800

certificate_type_get2.restype = _error_code

801

802

# Remove non-public functions

803

del _error_code, _retry_on_error

804

805

806

def call_pipe(connection, # : multiprocessing.Connection

807

func, *args, **kwargs):

808

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

809

810

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

811

return value on the provided multiprocessing.Connection.

812

"""

813

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

814

connection.close()

815

816

401

817

class Client(object):

402

818

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

403

819

404

820

Attributes:

405

821

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

406

822

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

407

823

approval_duration: datetime.timedelta(); Duration of one approval

408

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

409

to see if the client lives.

410

'None' if no process is running.

411

checker_callback_tag: a gobject event source tag, or None

824

checker: multiprocessing.Process(); a running checker process used

825

to see if the client lives. 'None' if no process is

826

running.

827

checker_callback_tag: a GLib event source tag, or None

412

828

checker_command: string; External command which is run to check

413

829

if client lives. %() expansions are done at

414

830

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

415

831

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

416

checker_initiator_tag: a gobject event source tag, or None

832

checker_initiator_tag: a GLib event source tag, or None

417

833

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

418

834

client_structure: Object describing what attributes a client has

419

835

and is used for storing the client at exit

420

836

current_checker_command: string; current running checker_command

421

disable_initiator_tag: a gobject event source tag, or None

837

disable_initiator_tag: a GLib event source tag, or None

422

838

enabled: bool()

423

839

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

424

uniquely identify the client

840

uniquely identify an OpenPGP client

841

key_id: string (64 hexadecimal digits); used to uniquely identify

842

a client using raw public keys

425

843

host: string; available for use by the checker command

426

844

interval: datetime.timedelta(); How often to start a new checker

427

845

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

429

847

last_checker_status: integer between 0 and 255 reflecting exit

430

848

status of last checker. -1 reflects crashed

431

849

checker, -2 means no checker completed yet.

850

last_checker_signal: The signal which killed the last checker, if

851

last_checker_status is -1

432

852

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

433

853

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

434

854

D-Bus identifiers

441

861

disabled, or None

442

862

server_settings: The server_settings dict from main()

443

863

"""

444

864

445

865

runtime_expansions = ("approval_delay", "approval_duration",

446

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

866

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

447

867

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

448

868

"last_approval_request", "last_checked_ok",

449

869

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

450

client_defaults = { "timeout": "PT5M",

451

"extended_timeout": "PT15M",

452

"interval": "PT2M",

453

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

454

"host": "",

455

"approval_delay": "PT0S",

456

"approval_duration": "PT1S",

457

"approved_by_default": "True",

458

"enabled": "True",

459

}

460

870

client_defaults = {

871

"timeout": "PT5M",

872

"extended_timeout": "PT15M",

873

"interval": "PT2M",

874

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

875

"host": "",

876

"approval_delay": "PT0S",

877

"approval_duration": "PT1S",

878

"approved_by_default": "True",

879

"enabled": "True",

880

}

881

461

882

@staticmethod

462

883

def config_parser(config):

463

884

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

470

891

for client_name in config.sections():

471

892

section = dict(config.items(client_name))

472

893

client = settings[client_name] = {}

473

894

474

895

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

475

896

# Reformat values from string types to Python types

476

897

client["approved_by_default"] = config.getboolean(

477

898

client_name, "approved_by_default")

478

899

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

479

900

"enabled")

480

901

902

# Uppercase and remove spaces from key_id and fingerprint

903

# for later comparison purposes with return value from the

904

# key_id() and fingerprint() functions

905

client["key_id"] = (section.get("key_id", "").upper()

906

.replace(" ", ""))

481

907

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

482

908

.replace(" ", ""))

483

909

if "secret" in section:

484

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

910

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

911

.encode("utf-8"),

912

"base64")

485

913

elif "secfile" in section:

486

914

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

487

915

(section["secfile"])),

502

930

client["last_approval_request"] = None

503

931

client["last_checked_ok"] = None

504

932

client["last_checker_status"] = -2

505

933

506

934

return settings

507

508

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

935

936

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

509

937

self.name = name

510

938

if server_settings is None:

511

939

server_settings = {}

513

941

# adding all client settings

514

942

for setting, value in settings.items():

515

943

setattr(self, setting, value)

516

944

517

945

if self.enabled:

518

946

if not hasattr(self, "last_enabled"):

519

947

self.last_enabled = datetime.datetime.utcnow()

523

951

else:

524

952

self.last_enabled = None

525

953

self.expires = None

526

954

527

955

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

528

# Uppercase and remove spaces from fingerprint for later

529

# comparison purposes with return value from the fingerprint()

530

# function

956

logger.debug(" Key ID: %s", self.key_id)

531

957

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

532

958

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

533

959

datetime.datetime.utcnow())

534

960

535

961

# attributes specific for this server instance

536

962

self.checker = None

537

963

self.checker_initiator_tag = None

540

966

self.current_checker_command = None

541

967

self.approved = None

542

968

self.approvals_pending = 0

543

self.changedstate = (multiprocessing_manager

544

.Condition(multiprocessing_manager

545

.Lock()))

546

self.client_structure = [attr for attr in

547

self.__dict__.iterkeys()

969

self.changedstate = multiprocessing_manager.Condition(

970

multiprocessing_manager.Lock())

971

self.client_structure = [attr

972

for attr in self.__dict__.keys()

548

973

if not attr.startswith("_")]

549

974

self.client_structure.append("client_structure")

550

551

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

552

lambda obj:

553

isinstance(obj,

554

property)):

975

976

for name, t in inspect.getmembers(

977

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

555

978

if not name.startswith("_"):

556

979

self.client_structure.append(name)

557

980

558

981

# Send notice to process children that client state has changed

559

982

def send_changedstate(self):

560

983

with self.changedstate:

561

984

self.changedstate.notify_all()

562

985

563

986

def enable(self):

564

987

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

565

988

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

570

993

self.last_enabled = datetime.datetime.utcnow()

571

994

self.init_checker()

572

995

self.send_changedstate()

573

996

574

997

def disable(self, quiet=True):

575

998

"""Disable this client."""

576

999

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

578

1001

if not quiet:

579

1002

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

580

1003

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

581

gobject.source_remove(self.disable_initiator_tag)

1004

GLib.source_remove(self.disable_initiator_tag)

582

1005

self.disable_initiator_tag = None

583

1006

self.expires = None

584

1007

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

585

gobject.source_remove(self.checker_initiator_tag)

1008

GLib.source_remove(self.checker_initiator_tag)

586

1009

self.checker_initiator_tag = None

587

1010

self.stop_checker()

588

1011

self.enabled = False

589

1012

if not quiet:

590

1013

self.send_changedstate()

591

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

1014

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

592

1015

return False

593

1016

594

1017

def __del__(self):

595

1018

self.disable()

596

1019

597

1020

def init_checker(self):

598

1021

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

599

1022

# and every interval from then on.

600

1023

if self.checker_initiator_tag is not None:

601

gobject.source_remove(self.checker_initiator_tag)

602

self.checker_initiator_tag = (gobject.timeout_add

603

(int(self.interval

604

.total_seconds() * 1000),

605

self.start_checker))

1024

GLib.source_remove(self.checker_initiator_tag)

1025

self.checker_initiator_tag = GLib.timeout_add(

1026

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

1027

self.start_checker)

606

1028

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

607

1029

if self.disable_initiator_tag is not None:

608

gobject.source_remove(self.disable_initiator_tag)

609

self.disable_initiator_tag = (gobject.timeout_add

610

(int(self.timeout

611

.total_seconds() * 1000),

612

self.disable))

1030

GLib.source_remove(self.disable_initiator_tag)

1031

self.disable_initiator_tag = GLib.timeout_add(

1032

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

613

1033

# Also start a new checker *right now*.

614

1034

self.start_checker()

615

616

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

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

617

1038

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

1039

# Read return code from connection (see call_pipe)

1040

returncode = connection.recv()

1041

connection.close()

1042

self.checker.join()

618

1043

self.checker_callback_tag = None

619

1044

self.checker = None

620

if os.WIFEXITED(condition):

621

self.last_checker_status = os.WEXITSTATUS(condition)

1045

1046

if returncode >= 0:

1047

self.last_checker_status = returncode

1048

self.last_checker_signal = None

622

1049

if self.last_checker_status == 0:

623

1050

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

624

1051

vars(self))

625

1052

self.checked_ok()

626

1053

else:

627

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

628

vars(self))

1054

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

629

1055

else:

630

1056

self.last_checker_status = -1

1057

self.last_checker_signal = -returncode

631

1058

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

632

1059

vars(self))

633

1060

return False

1061

634

1062

def checked_ok(self):

635

1063

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

636

1064

self.last_checked_ok = datetime.datetime.utcnow()

637

1065

self.last_checker_status = 0

1066

self.last_checker_signal = None

638

1067

self.bump_timeout()

639

1068

640

1069

def bump_timeout(self, timeout=None):

641

1070

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

642

1071

if timeout is None:

643

1072

timeout = self.timeout

644

1073

if self.disable_initiator_tag is not None:

645

gobject.source_remove(self.disable_initiator_tag)

1074

GLib.source_remove(self.disable_initiator_tag)

646

1075

self.disable_initiator_tag = None

647

1076

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

648

self.disable_initiator_tag = (gobject.timeout_add

649

(int(timeout.total_seconds()

650

* 1000), self.disable))

1077

self.disable_initiator_tag = GLib.timeout_add(

1078

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

651

1079

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

652

1080

653

1081

def need_approval(self):

654

1082

self.last_approval_request = datetime.datetime.utcnow()

655

1083

656

1084

def start_checker(self):

657

1085

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

658

1086

659

1087

If a checker already exists, leave it running and do

660

1088

nothing."""

661

1089

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

666

1094

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

667

1095

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

668

1096

# should be.

669

670

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

671

try:

672

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

673

except AttributeError:

674

pass

675

except OSError as error:

676

if error.errno != errno.ECHILD:

677

raise

678

else:

679

if pid:

680

logger.warning("Checker was a zombie")

681

gobject.source_remove(self.checker_callback_tag)

682

self.checker_callback(pid, status,

683

self.current_checker_command)

1097

1098

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

1099

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

1100

self.checker.join()

1101

self.checker = None

684

1102

# Start a new checker if needed

685

1103

if self.checker is None:

686

1104

# Escape attributes for the shell

687

escaped_attrs = { attr:

688

re.escape(unicode(getattr(self,

689

attr)))

690

for attr in self.runtime_expansions }

1105

escaped_attrs = {

1106

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

1107

for attr in self.runtime_expansions}

691

1108

try:

692

1109

command = self.checker_command % escaped_attrs

693

1110

except TypeError as error:

694

1111

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

695

self.checker_command, exc_info=error)

696

return True # Try again later

1112

self.checker_command,

1113

exc_info=error)

1114

return True # Try again later

697

1115

self.current_checker_command = command

698

try:

699

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

700

command, self.name)

701

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

702

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

703

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

704

# always replaced by /dev/null.)

705

# The exception is when not debugging but nevertheless

706

# running in the foreground; use the previously

707

# created wnull.

708

popen_args = {}

709

if (not self.server_settings["debug"]

710

and self.server_settings["foreground"]):

711

popen_args.update({"stdout": wnull,

712

"stderr": wnull })

713

self.checker = subprocess.Popen(command,

714

close_fds=True,

715

shell=True, cwd="/",

716

**popen_args)

717

except OSError as error:

718

logger.error("Failed to start subprocess",

719

exc_info=error)

720

return True

721

self.checker_callback_tag = (gobject.child_watch_add

722

(self.checker.pid,

723

self.checker_callback,

724

data=command))

725

# The checker may have completed before the gobject

726

# watch was added. Check for this.

727

try:

728

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

729

except OSError as error:

730

if error.errno == errno.ECHILD:

731

# This should never happen

732

logger.error("Child process vanished",

733

exc_info=error)

734

return True

735

raise

736

if pid:

737

gobject.source_remove(self.checker_callback_tag)

738

self.checker_callback(pid, status, command)

739

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

1116

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

1117

self.name)

1118

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

1119

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

1120

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

1121

# always replaced by /dev/null.)

1122

# The exception is when not debugging but nevertheless

1123

# running in the foreground; use the previously

1124

# created wnull.

1125

popen_args = {"close_fds": True,

1126

"shell": True,

1127

"cwd": "/"}

1128

if (not self.server_settings["debug"]

1129

and self.server_settings["foreground"]):

1130

popen_args.update({"stdout": wnull,

1131

"stderr": wnull})

1132

pipe = multiprocessing.Pipe(duplex=False)

1133

self.checker = multiprocessing.Process(

1134

target=call_pipe,

1135

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

1136

kwargs=popen_args)

1137

self.checker.start()

1138

self.checker_callback_tag = GLib.io_add_watch(

1139

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

1140

self.checker_callback, pipe[0], command)

1141

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

740

1142

return True

741

1143

742

1144

def stop_checker(self):

743

1145

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

744

1146

if self.checker_callback_tag:

745

gobject.source_remove(self.checker_callback_tag)

1147

GLib.source_remove(self.checker_callback_tag)

746

1148

self.checker_callback_tag = None

747

1149

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

748

1150

return

749

1151

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

750

try:

751

self.checker.terminate()

752

#time.sleep(0.5)

753

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

754

# self.checker.kill()

755

except OSError as error:

756

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

757

raise

1152

self.checker.terminate()

758

1153

self.checker = None

759

1154

760

1155

761

def dbus_service_property(dbus_interface, signature="v",

762

access="readwrite", byte_arrays=False):

1156

def dbus_service_property(dbus_interface,

1157

signature="v",

1158

access="readwrite",

1159

byte_arrays=False):

763

1160

"""Decorators for marking methods of a DBusObjectWithProperties to

764

1161

become properties on the D-Bus.

765

1162

766

1163

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

767

1164

and with one argument by "Set".

768

1165

769

1166

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

770

1167

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

771

1168

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

775

1172

if byte_arrays and signature != "ay":

776

1173

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

777

1174

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

1175

778

1176

def decorator(func):

779

1177

func._dbus_is_property = True

780

1178

func._dbus_interface = dbus_interface

783

1181

func._dbus_name = func.__name__

784

1182

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

785

1183

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

786

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1184

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

787

1185

return func

1186

788

1187

return decorator

789

1188

790

1189

791

1190

def dbus_interface_annotations(dbus_interface):

792

1191

"""Decorator for marking functions returning interface annotations

793

1192

794

1193

Usage:

795

1194

796

1195

@dbus_interface_annotations("org.example.Interface")

797

1196

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

798

1197

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

799

1198

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

800

1199

"false"}

801

1200

"""

1201

802

1202

def decorator(func):

803

1203

func._dbus_is_interface = True

804

1204

func._dbus_interface = dbus_interface

805

1205

func._dbus_name = dbus_interface

806

1206

return func

1207

807

1208

return decorator

808

1209

809

1210

810

1211

def dbus_annotations(annotations):

811

1212

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

812

1213

Usage:

813

1214

1215

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

1216

"org.freedesktop.DBus.Property."

1217

"EmitsChangedSignal": "false"})

814

1218

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

815

1219

access="r")

816

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

817

"org.freedesktop.DBus.Property."

818

"EmitsChangedSignal": "false"})

819

1220

def Property_dbus_property(self):

820

1221

return dbus.Boolean(False)

1222

1223

See also the DBusObjectWithAnnotations class.

821

1224

"""

1225

822

1226

def decorator(func):

823

1227

func._dbus_annotations = annotations

824

1228

return func

1229

825

1230

return decorator

826

1231

827

1232

830

1235

"""

831

1236

pass

832

1237

1238

833

1239

class DBusPropertyAccessException(DBusPropertyException):

834

1240

"""A property's access permissions disallows an operation.

835

1241

"""

842

1248

pass

843

1249

844

1250

845

class DBusObjectWithProperties(dbus.service.Object):

846

"""A D-Bus object with properties.

847

848

Classes inheriting from this can use the dbus_service_property

849

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

850

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

1251

class DBusObjectWithAnnotations(dbus.service.Object):

1252

"""A D-Bus object with annotations.

1253

1254

Classes inheriting from this can use the dbus_annotations

1255

decorator to add annotations to methods or signals.

851

1256

"""

852

1257

853

1258

@staticmethod

854

1259

def _is_dbus_thing(thing):

855

1260

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

856

1261

857

1262

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

858

1263

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

859

1264

"""

860

1265

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

861

1266

False)

862

1267

863

1268

def _get_all_dbus_things(self, thing):

864

1269

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

865

1270

"""

866

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

867

name),

1271

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

868

1272

athing.__get__(self))

869

1273

for cls in self.__class__.__mro__

870

1274

for name, athing in

871

inspect.getmembers(cls,

872

self._is_dbus_thing(thing)))

873

1275

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

1276

1277

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1278

out_signature="s",

1279

path_keyword='object_path',

1280

connection_keyword='connection')

1281

def Introspect(self, object_path, connection):

1282

"""Overloading of standard D-Bus method.

1283

1284

Inserts annotation tags on methods and signals.

1285

"""

1286

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

1287

connection)

1288

try:

1289

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

1290

1291

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

1292

# Add annotation tags

1293

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

1294

for tag in if_tag.getElementsByTagName(typ):

1295

annots = dict()

1296

for name, prop in (self.

1297

_get_all_dbus_things(typ)):

1298

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

1299

and prop._dbus_interface

1300

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

1301

annots.update(getattr(

1302

prop, "_dbus_annotations", {}))

1303

for name, value in annots.items():

1304

ann_tag = document.createElement(

1305

"annotation")

1306

ann_tag.setAttribute("name", name)

1307

ann_tag.setAttribute("value", value)

1308

tag.appendChild(ann_tag)

1309

# Add interface annotation tags

1310

for annotation, value in dict(

1311

itertools.chain.from_iterable(

1312

annotations().items()

1313

for name, annotations

1314

in self._get_all_dbus_things("interface")

1315

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

1316

)).items():

1317

ann_tag = document.createElement("annotation")

1318

ann_tag.setAttribute("name", annotation)

1319

ann_tag.setAttribute("value", value)

1320

if_tag.appendChild(ann_tag)

1321

# Fix argument name for the Introspect method itself

1322

if (if_tag.getAttribute("name")

1323

== dbus.INTROSPECTABLE_IFACE):

1324

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

1325

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

1326

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

1327

if (arg.getAttribute("direction")

1328

== "out"):

1329

arg.setAttribute("name",

1330

"xml_data")

1331

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

1332

document.unlink()

1333

except (AttributeError, xml.dom.DOMException,

1334

xml.parsers.expat.ExpatError) as error:

1335

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

1336

exc_info=error)

1337

return xmlstring

1338

1339

1340

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1341

"""A D-Bus object with properties.

1342

1343

Classes inheriting from this can use the dbus_service_property

1344

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

1345

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

1346

"""

1347

874

1348

def _get_dbus_property(self, interface_name, property_name):

875

1349

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

876

1350

property with the specified name and interface.

877

1351

"""

878

for cls in self.__class__.__mro__:

879

for name, value in (inspect.getmembers

880

(cls,

881

self._is_dbus_thing("property"))):

1352

for cls in self.__class__.__mro__:

1353

for name, value in inspect.getmembers(

1354

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

882

1355

if (value._dbus_name == property_name

883

1356

and value._dbus_interface == interface_name):

884

1357

return value.__get__(self)

885

1358

886

1359

# No such property

887

raise DBusPropertyNotFound(self.dbus_object_path + ":"

888

+ interface_name + "."

889

+ property_name)

890

891

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

1360

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

1361

self.dbus_object_path, interface_name, property_name))

1362

1363

@classmethod

1364

def _get_all_interface_names(cls):

1365

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

1366

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

1367

"_dbus_interface", None)

1368

for x in (inspect.getmro(cls))

1369

for attr in dir(x))

1370

if name is not None)

1371

1372

@dbus.service.method(dbus.PROPERTIES_IFACE,

1373

in_signature="ss",

892

1374

out_signature="v")

893

1375

def Get(self, interface_name, property_name):

894

1376

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

900

1382

if not hasattr(value, "variant_level"):

901

1383

return value

902

1384

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

903

1385

904

1386

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

905

1387

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

906

1388

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

918

1400

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

919

1401

for byte in value))

920

1402

prop(value)

921

922

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

1403

1404

@dbus.service.method(dbus.PROPERTIES_IFACE,

1405

in_signature="s",

923

1406

out_signature="a{sv}")

924

1407

def GetAll(self, interface_name):

925

1408

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

926

1409

standard.

927

1410

928

1411

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

929

1412

"""

930

1413

properties = {}

940

1423

if not hasattr(value, "variant_level"):

941

1424

properties[name] = value

942

1425

continue

943

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

944

value.variant_level+1)

1426

properties[name] = type(value)(

1427

value, variant_level=value.variant_level + 1)

945

1428

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

946

1429

1430

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

1431

def PropertiesChanged(self, interface_name, changed_properties,

1432

invalidated_properties):

1433

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

1434

standard.

1435

"""

1436

pass

1437

947

1438

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

948

1439

out_signature="s",

949

1440

path_keyword='object_path',

950

1441

connection_keyword='connection')

951

1442

def Introspect(self, object_path, connection):

952

1443

"""Overloading of standard D-Bus method.

953

1444

954

1445

Inserts property tags and interface annotation tags.

955

1446

"""

956

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

957

connection)

1447

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1448

object_path,

1449

connection)

958

1450

try:

959

1451

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

1452

960

1453

def make_tag(document, name, prop):

961

1454

e = document.createElement("property")

962

1455

e.setAttribute("name", name)

963

1456

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

964

1457

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

965

1458

return e

1459

966

1460

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

967

1461

# Add property tags

968

1462

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

971

1465

if prop._dbus_interface

972

1466

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

973

1467

if_tag.appendChild(tag)

974

# Add annotation tags

975

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

976

for tag in if_tag.getElementsByTagName(typ):

977

annots = dict()

978

for name, prop in (self.

979

_get_all_dbus_things(typ)):

980

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

981

and prop._dbus_interface

982

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

983

annots.update(getattr

984

(prop,

985

"_dbus_annotations",

986

{}))

987

for name, value in annots.items():

988

ann_tag = document.createElement(

989

"annotation")

990

ann_tag.setAttribute("name", name)

991

ann_tag.setAttribute("value", value)

992

tag.appendChild(ann_tag)

993

# Add interface annotation tags

994

for annotation, value in dict(

995

itertools.chain.from_iterable(

996

annotations().items()

997

for name, annotations in

998

self._get_all_dbus_things("interface")

999

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

1000

)).items():

1001

ann_tag = document.createElement("annotation")

1002

ann_tag.setAttribute("name", annotation)

1003

ann_tag.setAttribute("value", value)

1004

if_tag.appendChild(ann_tag)

1468

# Add annotation tags for properties

1469

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

1470

annots = dict()

1471

for name, prop in self._get_all_dbus_things(

1472

"property"):

1473

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

1474

and prop._dbus_interface

1475

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

1476

annots.update(getattr(

1477

prop, "_dbus_annotations", {}))

1478

for name, value in annots.items():

1479

ann_tag = document.createElement(

1480

"annotation")

1481

ann_tag.setAttribute("name", name)

1482

ann_tag.setAttribute("value", value)

1483

tag.appendChild(ann_tag)

1005

1484

# Add the names to the return values for the

1006

1485

# "org.freedesktop.DBus.Properties" methods

1007

1486

if (if_tag.getAttribute("name")

1026

1505

return xmlstring

1027

1506

1028

1507

1508

try:

1509

dbus.OBJECT_MANAGER_IFACE

1510

except AttributeError:

1511

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

1512

1513

1514

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1515

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

1516

1517

Classes inheriting from this exposes the standard

1518

GetManagedObjects call and the InterfacesAdded and

1519

InterfacesRemoved signals on the standard

1520

"org.freedesktop.DBus.ObjectManager" interface.

1521

1522

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

1523

manually.

1524

"""

1525

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1526

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

1527

def GetManagedObjects(self):

1528

"""This function must be overridden"""

1529

raise NotImplementedError()

1530

1531

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1532

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

1533

def InterfacesAdded(self, object_path, interfaces_and_properties):

1534

pass

1535

1536

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

1537

def InterfacesRemoved(self, object_path, interfaces):

1538

pass

1539

1540

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1541

out_signature="s",

1542

path_keyword='object_path',

1543

connection_keyword='connection')

1544

def Introspect(self, object_path, connection):

1545

"""Overloading of standard D-Bus method.

1546

1547

Override return argument name of GetManagedObjects to be

1548

"objpath_interfaces_and_properties"

1549

"""

1550

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1551

object_path,

1552

connection)

1553

try:

1554

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

1555

1556

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

1557

# Fix argument name for the GetManagedObjects method

1558

if (if_tag.getAttribute("name")

1559

== dbus.OBJECT_MANAGER_IFACE):

1560

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

1561

if (cn.getAttribute("name")

1562

== "GetManagedObjects"):

1563

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

1564

if (arg.getAttribute("direction")

1565

== "out"):

1566

arg.setAttribute(

1567

"name",

1568

"objpath_interfaces"

1569

"_and_properties")

1570

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

1571

document.unlink()

1572

except (AttributeError, xml.dom.DOMException,

1573

xml.parsers.expat.ExpatError) as error:

1574

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

1575

exc_info=error)

1576

return xmlstring

1577

1578

1029

1579

def datetime_to_dbus(dt, variant_level=0):

1030

1580

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

1031

1581

if dt is None:

1032

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

1033

return dbus.String(dt.isoformat(),

1034

variant_level=variant_level)

1582

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

1583

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

1035

1584

1036

1585

1037

1586

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1039

1588

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

1040

1589

interface names according to the "alt_interface_names" mapping.

1041

1590

Usage:

1042

1591

1043

1592

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

1044

1593

"net.example.AlternateInterface"})

1045

1594

class SampleDBusObject(dbus.service.Object):

1046

1595

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

1047

1596

def SampleDBusMethod():

1048

1597

pass

1049

1598

1050

1599

The above "SampleDBusMethod" on "SampleDBusObject" will be

1051

1600

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

1052

1601

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

1053

1602

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

1054

1603

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

1055

1604

1056

1605

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

1057

1606

(from DBusObjectWithProperties) and interfaces (from the

1058

1607

dbus_interface_annotations decorator).

1059

1608

"""

1609

1060

1610

def wrapper(cls):

1061

1611

for orig_interface_name, alt_interface_name in (

1062

alt_interface_names.items()):

1612

alt_interface_names.items()):

1063

1613

attr = {}

1064

1614

interface_names = set()

1065

1615

# Go though all attributes of the class

1067

1617

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

1068

1618

# with the wrong interface name

1069

1619

if (not hasattr(attribute, "_dbus_interface")

1070

or not attribute._dbus_interface

1071

.startswith(orig_interface_name)):

1620

or not attribute._dbus_interface.startswith(

1621

orig_interface_name)):

1072

1622

continue

1073

1623

# Create an alternate D-Bus interface name based on

1074

1624

# the current name

1075

alt_interface = (attribute._dbus_interface

1076

.replace(orig_interface_name,

1077

alt_interface_name))

1625

alt_interface = attribute._dbus_interface.replace(

1626

orig_interface_name, alt_interface_name)

1078

1627

interface_names.add(alt_interface)

1079

1628

# Is this a D-Bus signal?

1080

1629

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

1081

1630

# Extract the original non-method undecorated

1082

1631

# function by black magic

1083

nonmethod_func = (dict(

1632

if sys.version_info.major == 2:

1633

nonmethod_func = (dict(

1084

1634

zip(attribute.func_code.co_freevars,

1085

attribute.__closure__))["func"]

1086

.cell_contents)

1635

attribute.__closure__))

1636

["func"].cell_contents)

1637

else:

1638

nonmethod_func = (dict(

1639

zip(attribute.__code__.co_freevars,

1640

attribute.__closure__))

1641

["func"].cell_contents)

1087

1642

# Create a new, but exactly alike, function

1088

1643

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

1089

1644

# with the alternate D-Bus interface name

1090

new_function = (dbus.service.signal

1091

(alt_interface,

1092

attribute._dbus_signature)

1093

(types.FunctionType(

1094

nonmethod_func.func_code,

1095

nonmethod_func.func_globals,

1096

nonmethod_func.func_name,

1097

nonmethod_func.func_defaults,

1098

nonmethod_func.func_closure)))

1645

new_function = copy_function(nonmethod_func)

1646

new_function = (dbus.service.signal(

1647

alt_interface,

1648

attribute._dbus_signature)(new_function))

1099

1649

# Copy annotations, if any

1100

1650

try:

1101

new_function._dbus_annotations = (

1102

dict(attribute._dbus_annotations))

1651

new_function._dbus_annotations = dict(

1652

attribute._dbus_annotations)

1103

1653

except AttributeError:

1104

1654

pass

1655

1105

1656

# Define a creator of a function to call both the

1106

1657

# original and alternate functions, so both the

1107

1658

# original and alternate signals gets sent when

1110

1661

"""This function is a scope container to pass

1111

1662

func1 and func2 to the "call_both" function

1112

1663

outside of its arguments"""

1664

1665

@functools.wraps(func2)

1113

1666

def call_both(*args, **kwargs):

1114

1667

"""This function will emit two D-Bus

1115

1668

signals by calling func1 and func2"""

1116

1669

func1(*args, **kwargs)

1117

1670

func2(*args, **kwargs)

1671

# Make wrapper function look like a D-Bus

1672

# signal

1673

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

1674

if name.startswith("_dbus_"):

1675

setattr(call_both, name, attr)

1676

1118

1677

return call_both

1119

1678

# Create the "call_both" function and add it to

1120

1679

# the class

1125

1684

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

1126

1685

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

1127

1686

# to the class.

1128

attr[attrname] = (dbus.service.method

1129

(alt_interface,

1130

attribute._dbus_in_signature,

1131

attribute._dbus_out_signature)

1132

(types.FunctionType

1133

(attribute.func_code,

1134

attribute.func_globals,

1135

attribute.func_name,

1136

attribute.func_defaults,

1137

attribute.func_closure)))

1687

attr[attrname] = (

1688

dbus.service.method(

1689

alt_interface,

1690

attribute._dbus_in_signature,

1691

attribute._dbus_out_signature)

1692

(copy_function(attribute)))

1138

1693

# Copy annotations, if any

1139

1694

try:

1140

attr[attrname]._dbus_annotations = (

1141

dict(attribute._dbus_annotations))

1695

attr[attrname]._dbus_annotations = dict(

1696

attribute._dbus_annotations)

1142

1697

except AttributeError:

1143

1698

pass

1144

1699

# Is this a D-Bus property?

1147

1702

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

1148

1703

# property with the alternate D-Bus interface

1149

1704

# name. Add it to the class.

1150

attr[attrname] = (dbus_service_property

1151

(alt_interface,

1152

attribute._dbus_signature,

1153

attribute._dbus_access,

1154

attribute

1155

._dbus_get_args_options

1156

["byte_arrays"])

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1705

attr[attrname] = (dbus_service_property(

1706

alt_interface, attribute._dbus_signature,

1707

attribute._dbus_access,

1708

attribute._dbus_get_args_options

1709

["byte_arrays"])

1710

(copy_function(attribute)))

1163

1711

# Copy annotations, if any

1164

1712

try:

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1713

attr[attrname]._dbus_annotations = dict(

1714

attribute._dbus_annotations)

1167

1715

except AttributeError:

1168

1716

pass

1169

1717

# Is this a D-Bus interface?

1172

1720

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

1173

1721

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

1174

1722

# to the class.

1175

attr[attrname] = (dbus_interface_annotations

1176

(alt_interface)

1177

(types.FunctionType

1178

(attribute.func_code,

1179

attribute.func_globals,

1180

attribute.func_name,

1181

attribute.func_defaults,

1182

attribute.func_closure)))

1723

attr[attrname] = (

1724

dbus_interface_annotations(alt_interface)

1725

(copy_function(attribute)))

1183

1726

if deprecate:

1184

1727

# Deprecate all alternate interfaces

1185

iname="_AlternateDBusNames_interface_annotation{}"

1728

iname = "_AlternateDBusNames_interface_annotation{}"

1186

1729

for interface_name in interface_names:

1730

1187

1731

@dbus_interface_annotations(interface_name)

1188

1732

def func(self):

1189

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

1190

"true" }

1733

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

1734

"true"}

1191

1735

# Find an unused name

1192

1736

for aname in (iname.format(i)

1193

1737

for i in itertools.count()):

1197

1741

if interface_names:

1198

1742

# Replace the class with a new subclass of it with

1199

1743

# methods, signals, etc. as created above.

1200

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

1201

(cls,), attr)

1744

if sys.version_info.major == 2:

1745

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

1746

(cls, ), attr)

1747

else:

1748

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

1749

(cls, ), attr)

1202

1750

return cls

1751

1203

1752

return wrapper

1204

1753

1205

1754

1206

1755

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

1207

"se.bsnet.fukt.Mandos"})

1756

"se.bsnet.fukt.Mandos"})

1208

1757

class ClientDBus(Client, DBusObjectWithProperties):

1209

1758

"""A Client class using D-Bus

1210

1759

1211

1760

Attributes:

1212

1761

dbus_object_path: dbus.ObjectPath

1213

1762

bus: dbus.SystemBus()

1214

1763

"""

1215

1764

1216

1765

runtime_expansions = (Client.runtime_expansions

1217

+ ("dbus_object_path",))

1218

1766

+ ("dbus_object_path", ))

1767

1768

_interface = "se.recompile.Mandos.Client"

1769

1219

1770

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

1220

1221

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

1771

1772

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

1222

1773

self.bus = bus

1223

1774

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

1224

1775

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

1225

1776

# the D-Bus

1226

client_object_name = unicode(self.name).translate(

1777

client_object_name = str(self.name).translate(

1227

1778

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

1228

1779

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

1229

self.dbus_object_path = (dbus.ObjectPath

1230

("/clients/" + client_object_name))

1780

self.dbus_object_path = dbus.ObjectPath(

1781

"/clients/" + client_object_name)

1231

1782

DBusObjectWithProperties.__init__(self, self.bus,

1232

1783

self.dbus_object_path)

1233

1234

def notifychangeproperty(transform_func,

1235

dbus_name, type_func=lambda x: x,

1236

variant_level=1):

1784

1785

def notifychangeproperty(transform_func, dbus_name,

1786

type_func=lambda x: x,

1787

variant_level=1,

1788

invalidate_only=False,

1789

_interface=_interface):

1237

1790

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

1238

1791

its changes to DBus.

1239

1792

1240

1793

transform_fun: Function that takes a value and a variant_level

1241

1794

and transforms it to a D-Bus type.

1242

1795

dbus_name: D-Bus name of the variable

1245

1798

variant_level: D-Bus variant level. Default: 1

1246

1799

"""

1247

1800

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

1801

1248

1802

def setter(self, value):

1249

1803

if hasattr(self, "dbus_object_path"):

1250

1804

if (not hasattr(self, attrname) or

1251

1805

type_func(getattr(self, attrname, None))

1252

1806

!= type_func(value)):

1253

dbus_value = transform_func(type_func(value),

1254

variant_level

1255

=variant_level)

1256

self.PropertyChanged(dbus.String(dbus_name),

1257

dbus_value)

1807

if invalidate_only:

1808

self.PropertiesChanged(

1809

_interface, dbus.Dictionary(),

1810

dbus.Array((dbus_name, )))

1811

else:

1812

dbus_value = transform_func(

1813

type_func(value),

1814

variant_level=variant_level)

1815

self.PropertyChanged(dbus.String(dbus_name),

1816

dbus_value)

1817

self.PropertiesChanged(

1818

_interface,

1819

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

1820

dbus_value}),

1821

dbus.Array())

1258

1822

setattr(self, attrname, value)

1259

1823

1260

1824

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

1261

1825

1262

1826

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1263

1827

approvals_pending = notifychangeproperty(dbus.Boolean,

1264

1828

"ApprovalPending",

1265

type_func = bool)

1829

type_func=bool)

1266

1830

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

1267

1831

last_enabled = notifychangeproperty(datetime_to_dbus,

1268

1832

"LastEnabled")

1269

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

1270

type_func = lambda checker:

1271

checker is not None)

1833

checker = notifychangeproperty(

1834

dbus.Boolean, "CheckerRunning",

1835

type_func=lambda checker: checker is not None)

1272

1836

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1273

1837

"LastCheckedOK")

1274

1838

last_checker_status = notifychangeproperty(dbus.Int16,

1277

1841

datetime_to_dbus, "LastApprovalRequest")

1278

1842

approved_by_default = notifychangeproperty(dbus.Boolean,

1279

1843

"ApprovedByDefault")

1280

approval_delay = notifychangeproperty(dbus.UInt64,

1281

"ApprovalDelay",

1282

type_func =

1283

lambda td: td.total_seconds()

1284

* 1000)

1844

approval_delay = notifychangeproperty(

1845

dbus.UInt64, "ApprovalDelay",

1846

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

1285

1847

approval_duration = notifychangeproperty(

1286

1848

dbus.UInt64, "ApprovalDuration",

1287

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

1849

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

1288

1850

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

1289

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

1290

type_func = lambda td:

1291

td.total_seconds() * 1000)

1851

timeout = notifychangeproperty(

1852

dbus.UInt64, "Timeout",

1853

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

1292

1854

extended_timeout = notifychangeproperty(

1293

1855

dbus.UInt64, "ExtendedTimeout",

1294

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

1295

interval = notifychangeproperty(dbus.UInt64,

1296

"Interval",

1297

type_func =

1298

lambda td: td.total_seconds()

1299

* 1000)

1856

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

1857

interval = notifychangeproperty(

1858

dbus.UInt64, "Interval",

1859

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

1300

1860

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

1301

1861

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

1862

invalidate_only=True)

1863

1302

1864

del notifychangeproperty

1303

1865

1304

1866

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

1305

1867

try:

1306

1868

self.remove_from_connection()

1309

1871

if hasattr(DBusObjectWithProperties, "__del__"):

1310

1872

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

1311

1873

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

1312

1313

def checker_callback(self, pid, condition, command,

1314

*args, **kwargs):

1315

self.checker_callback_tag = None

1316

self.checker = None

1317

if os.WIFEXITED(condition):

1318

exitstatus = os.WEXITSTATUS(condition)

1874

1875

def checker_callback(self, source, condition,

1876

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

1877

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

1878

connection, command, *args,

1879

**kwargs)

1880

exitstatus = self.last_checker_status

1881

if exitstatus >= 0:

1319

1882

# Emit D-Bus signal

1320

1883

self.CheckerCompleted(dbus.Int16(exitstatus),

1321

dbus.Int64(condition),

1884

# This is specific to GNU libC

1885

dbus.Int64(exitstatus << 8),

1322

1886

dbus.String(command))

1323

1887

else:

1324

1888

# Emit D-Bus signal

1325

1889

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

1326

dbus.Int64(condition),

1890

dbus.Int64(

1891

# This is specific to GNU libC

1892

(exitstatus << 8)

1893

| self.last_checker_signal),

1327

1894

dbus.String(command))

1328

1329

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

1330

*args, **kwargs)

1331

1895

return ret

1896

1332

1897

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

1333

1898

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

1334

1899

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

1338

1903

# Emit D-Bus signal

1339

1904

self.CheckerStarted(self.current_checker_command)

1340

1905

return r

1341

1906

1342

1907

def _reset_approved(self):

1343

1908

self.approved = None

1344

1909

return False

1345

1910

1346

1911

def approve(self, value=True):

1347

1912

self.approved = value

1348

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

1349

* 1000), self._reset_approved)

1913

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

1914

* 1000), self._reset_approved)

1350

1915

self.send_changedstate()

1351

1352

## D-Bus methods, signals & properties

1353

_interface = "se.recompile.Mandos.Client"

1354

1355

## Interfaces

1356

1357

@dbus_interface_annotations(_interface)

1358

def _foo(self):

1359

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

1360

"false"}

1361

1362

## Signals

1363

1916

1917

# D-Bus methods, signals & properties

1918

1919

# Interfaces

1920

1921

# Signals

1922

1364

1923

# CheckerCompleted - signal

1365

1924

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

1366

1925

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

1367

1926

"D-Bus signal"

1368

1927

pass

1369

1928

1370

1929

# CheckerStarted - signal

1371

1930

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

1372

1931

def CheckerStarted(self, command):

1373

1932

"D-Bus signal"

1374

1933

pass

1375

1934

1376

1935

# PropertyChanged - signal

1936

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

1377

1937

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

1378

1938

def PropertyChanged(self, property, value):

1379

1939

"D-Bus signal"

1380

1940

pass

1381

1941

1382

1942

# GotSecret - signal

1383

1943

@dbus.service.signal(_interface)

1384

1944

def GotSecret(self):

1387

1947

server to mandos-client

1388

1948

"""

1389

1949

pass

1390

1950

1391

1951

# Rejected - signal

1392

1952

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

1393

1953

def Rejected(self, reason):

1394

1954

"D-Bus signal"

1395

1955

pass

1396

1956

1397

1957

# NeedApproval - signal

1398

1958

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

1399

1959

def NeedApproval(self, timeout, default):

1400

1960

"D-Bus signal"

1401

1961

return self.need_approval()

1402

1403

## Methods

1404

1962

1963

# Methods

1964

1405

1965

# Approve - method

1406

1966

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

1407

1967

def Approve(self, value):

1408

1968

self.approve(value)

1409

1969

1410

1970

# CheckedOK - method

1411

1971

@dbus.service.method(_interface)

1412

1972

def CheckedOK(self):

1413

1973

self.checked_ok()

1414

1974

1415

1975

# Enable - method

1976

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

1416

1977

@dbus.service.method(_interface)

1417

1978

def Enable(self):

1418

1979

"D-Bus method"

1419

1980

self.enable()

1420

1981

1421

1982

# StartChecker - method

1983

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

1422

1984

@dbus.service.method(_interface)

1423

1985

def StartChecker(self):

1424

1986

"D-Bus method"

1425

1987

self.start_checker()

1426

1988

1427

1989

# Disable - method

1990

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

1428

1991

@dbus.service.method(_interface)

1429

1992

def Disable(self):

1430

1993

"D-Bus method"

1431

1994

self.disable()

1432

1995

1433

1996

# StopChecker - method

1997

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

1434

1998

@dbus.service.method(_interface)

1435

1999

def StopChecker(self):

1436

2000

self.stop_checker()

1437

1438

## Properties

1439

2001

2002

# Properties

2003

1440

2004

# ApprovalPending - property

1441

2005

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

1442

2006

def ApprovalPending_dbus_property(self):

1443

2007

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

1444

2008

1445

2009

# ApprovedByDefault - property

1446

@dbus_service_property(_interface, signature="b",

2010

@dbus_service_property(_interface,

2011

signature="b",

1447

2012

access="readwrite")

1448

2013

def ApprovedByDefault_dbus_property(self, value=None):

1449

2014

if value is None: # get

1450

2015

return dbus.Boolean(self.approved_by_default)

1451

2016

self.approved_by_default = bool(value)

1452

2017

1453

2018

# ApprovalDelay - property

1454

@dbus_service_property(_interface, signature="t",

2019

@dbus_service_property(_interface,

2020

signature="t",

1455

2021

access="readwrite")

1456

2022

def ApprovalDelay_dbus_property(self, value=None):

1457

2023

if value is None: # get

1458

2024

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

1459

2025

* 1000)

1460

2026

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

1461

2027

1462

2028

# ApprovalDuration - property

1463

@dbus_service_property(_interface, signature="t",

2029

@dbus_service_property(_interface,

2030

signature="t",

1464

2031

access="readwrite")

1465

2032

def ApprovalDuration_dbus_property(self, value=None):

1466

2033

if value is None: # get

1467

2034

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

1468

2035

* 1000)

1469

2036

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

1470

2037

1471

2038

# Name - property

2039

@dbus_annotations(

2040

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

1472

2041

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

1473

2042

def Name_dbus_property(self):

1474

2043

return dbus.String(self.name)

1475

2044

2045

# KeyID - property

2046

@dbus_annotations(

2047

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

2048

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

2049

def KeyID_dbus_property(self):

2050

return dbus.String(self.key_id)

2051

1476

2052

# Fingerprint - property

2053

@dbus_annotations(

2054

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

1477

2055

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

1478

2056

def Fingerprint_dbus_property(self):

1479

2057

return dbus.String(self.fingerprint)

1480

2058

1481

2059

# Host - property

1482

@dbus_service_property(_interface, signature="s",

2060

@dbus_service_property(_interface,

2061

signature="s",

1483

2062

access="readwrite")

1484

2063

def Host_dbus_property(self, value=None):

1485

2064

if value is None: # get

1486

2065

return dbus.String(self.host)

1487

self.host = unicode(value)

1488

2066

self.host = str(value)

2067

1489

2068

# Created - property

2069

@dbus_annotations(

2070

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

1490

2071

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

1491

2072

def Created_dbus_property(self):

1492

2073

return datetime_to_dbus(self.created)

1493

2074

1494

2075

# LastEnabled - property

1495

2076

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

1496

2077

def LastEnabled_dbus_property(self):

1497

2078

return datetime_to_dbus(self.last_enabled)

1498

2079

1499

2080

# Enabled - property

1500

@dbus_service_property(_interface, signature="b",

2081

@dbus_service_property(_interface,

2082

signature="b",

1501

2083

access="readwrite")

1502

2084

def Enabled_dbus_property(self, value=None):

1503

2085

if value is None: # get

1506

2088

self.enable()

1507

2089

else:

1508

2090

self.disable()

1509

2091

1510

2092

# LastCheckedOK - property

1511

@dbus_service_property(_interface, signature="s",

2093

@dbus_service_property(_interface,

2094

signature="s",

1512

2095

access="readwrite")

1513

2096

def LastCheckedOK_dbus_property(self, value=None):

1514

2097

if value is not None:

1515

2098

self.checked_ok()

1516

2099

return

1517

2100

return datetime_to_dbus(self.last_checked_ok)

1518

2101

1519

2102

# LastCheckerStatus - property

1520

@dbus_service_property(_interface, signature="n",

1521

access="read")

2103

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

1522

2104

def LastCheckerStatus_dbus_property(self):

1523

2105

return dbus.Int16(self.last_checker_status)

1524

2106

1525

2107

# Expires - property

1526

2108

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

1527

2109

def Expires_dbus_property(self):

1528

2110

return datetime_to_dbus(self.expires)

1529

2111

1530

2112

# LastApprovalRequest - property

1531

2113

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

1532

2114

def LastApprovalRequest_dbus_property(self):

1533

2115

return datetime_to_dbus(self.last_approval_request)

1534

2116

1535

2117

# Timeout - property

1536

@dbus_service_property(_interface, signature="t",

2118

@dbus_service_property(_interface,

2119

signature="t",

1537

2120

access="readwrite")

1538

2121

def Timeout_dbus_property(self, value=None):

1539

2122

if value is None: # get

1551

2134

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

1552

2135

is None):

1553

2136

return

1554

gobject.source_remove(self.disable_initiator_tag)

1555

self.disable_initiator_tag = (

1556

gobject.timeout_add(

1557

int((self.expires - now).total_seconds()

1558

* 1000), self.disable))

1559

2137

GLib.source_remove(self.disable_initiator_tag)

2138

self.disable_initiator_tag = GLib.timeout_add(

2139

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

2140

self.disable)

2141

1560

2142

# ExtendedTimeout - property

1561

@dbus_service_property(_interface, signature="t",

2143

@dbus_service_property(_interface,

2144

signature="t",

1562

2145

access="readwrite")

1563

2146

def ExtendedTimeout_dbus_property(self, value=None):

1564

2147

if value is None: # get

1565

2148

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

1566

2149

* 1000)

1567

2150

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

1568

2151

1569

2152

# Interval - property

1570

@dbus_service_property(_interface, signature="t",

2153

@dbus_service_property(_interface,

2154

signature="t",

1571

2155

access="readwrite")

1572

2156

def Interval_dbus_property(self, value=None):

1573

2157

if value is None: # get

1577

2161

return

1578

2162

if self.enabled:

1579

2163

# Reschedule checker run

1580

gobject.source_remove(self.checker_initiator_tag)

1581

self.checker_initiator_tag = (gobject.timeout_add

1582

(value, self.start_checker))

1583

self.start_checker() # Start one now, too

1584

2164

GLib.source_remove(self.checker_initiator_tag)

2165

self.checker_initiator_tag = GLib.timeout_add(

2166

value, self.start_checker)

2167

self.start_checker() # Start one now, too

2168

1585

2169

# Checker - property

1586

@dbus_service_property(_interface, signature="s",

2170

@dbus_service_property(_interface,

2171

signature="s",

1587

2172

access="readwrite")

1588

2173

def Checker_dbus_property(self, value=None):

1589

2174

if value is None: # get

1590

2175

return dbus.String(self.checker_command)

1591

self.checker_command = unicode(value)

1592

2176

self.checker_command = str(value)

2177

1593

2178

# CheckerRunning - property

1594

@dbus_service_property(_interface, signature="b",

2179

@dbus_service_property(_interface,

2180

signature="b",

1595

2181

access="readwrite")

1596

2182

def CheckerRunning_dbus_property(self, value=None):

1597

2183

if value is None: # get

1600

2186

self.start_checker()

1601

2187

else:

1602

2188

self.stop_checker()

1603

2189

1604

2190

# ObjectPath - property

2191

@dbus_annotations(

2192

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

2193

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

1605

2194

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

1606

2195

def ObjectPath_dbus_property(self):

1607

return self.dbus_object_path # is already a dbus.ObjectPath

1608

2196

return self.dbus_object_path # is already a dbus.ObjectPath

2197

1609

2198

# Secret = property

1610

@dbus_service_property(_interface, signature="ay",

1611

access="write", byte_arrays=True)

2199

@dbus_annotations(

2200

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

2201

"invalidates"})

2202

@dbus_service_property(_interface,

2203

signature="ay",

2204

access="write",

2205

byte_arrays=True)

1612

2206

def Secret_dbus_property(self, value):

1613

2207

self.secret = bytes(value)

1614

2208

1615

2209

del _interface

1616

2210

1617

2211

1618

2212

class ProxyClient(object):

1619

def __init__(self, child_pipe, fpr, address):

2213

def __init__(self, child_pipe, key_id, fpr, address):

1620

2214

self._pipe = child_pipe

1621

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

2215

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

1622

2216

if not self._pipe.recv():

1623

raise KeyError()

1624

2217

raise KeyError(key_id or fpr)

2218

1625

2219

def __getattribute__(self, name):

1626

2220

if name == '_pipe':

1627

2221

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

1630

2224

if data[0] == 'data':

1631

2225

return data[1]

1632

2226

if data[0] == 'function':

2227

1633

2228

def func(*args, **kwargs):

1634

2229

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

1635

2230

return self._pipe.recv()[1]

2231

1636

2232

return func

1637

2233

1638

2234

def __setattr__(self, name, value):

1639

2235

if name == '_pipe':

1640

2236

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

1643

2239

1644

2240

class ClientHandler(socketserver.BaseRequestHandler, object):

1645

2241

"""A class to handle client connections.

1646

2242

1647

2243

Instantiated once for each connection to handle it.

1648

2244

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

1649

2245

1650

2246

def handle(self):

1651

2247

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

1652

2248

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

1653

unicode(self.client_address))

2249

str(self.client_address))

1654

2250

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

1655

2251

self.server.child_pipe.fileno())

1656

1657

session = (gnutls.connection

1658

.ClientSession(self.request,

1659

gnutls.connection

1660

.X509Credentials()))

1661

1662

# Note: gnutls.connection.X509Credentials is really a

1663

# generic GnuTLS certificate credentials object so long as

1664

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

1665

# here despite using OpenPGP certificates.

1666

1667

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

1668

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

1669

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

1670

# "+DHE-DSS"))

2252

2253

session = gnutls.ClientSession(self.request)

2254

2255

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

2256

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

2257

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

2258

# "+DHE-DSS"))

1671

2259

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

1672

2260

priority = self.server.gnutls_priority

1673

2261

if priority is None:

1674

2262

priority = "NORMAL"

1675

(gnutls.library.functions

1676

.gnutls_priority_set_direct(session._c_object,

1677

priority, None))

1678

2263

gnutls.priority_set_direct(session._c_object,

2264

priority.encode("utf-8"),

2265

None)

2266

1679

2267

# Start communication using the Mandos protocol

1680

2268

# Get protocol number

1681

2269

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

1686

2274

except (ValueError, IndexError, RuntimeError) as error:

1687

2275

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

1688

2276

return

1689

2277

1690

2278

# Start GnuTLS connection

1691

2279

try:

1692

2280

session.handshake()

1693

except gnutls.errors.GNUTLSError as error:

2281

except gnutls.Error as error:

1694

2282

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

1695

2283

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

1696

2284

# established. Just abandon the request.

1697

2285

return

1698

2286

logger.debug("Handshake succeeded")

1699

2287

1700

2288

approval_required = False

1701

2289

try:

1702

try:

1703

fpr = self.fingerprint(self.peer_certificate

1704

(session))

1705

except (TypeError,

1706

gnutls.errors.GNUTLSError) as error:

1707

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

1708

return

1709

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

1710

1711

try:

1712

client = ProxyClient(child_pipe, fpr,

2290

if gnutls.has_rawpk:

2291

fpr = b""

2292

try:

2293

key_id = self.key_id(

2294

self.peer_certificate(session))

2295

except (TypeError, gnutls.Error) as error:

2296

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

2297

return

2298

logger.debug("Key ID: %s", key_id)

2299

2300

else:

2301

key_id = b""

2302

try:

2303

fpr = self.fingerprint(

2304

self.peer_certificate(session))

2305

except (TypeError, gnutls.Error) as error:

2306

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

2307

return

2308

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

2309

2310

try:

2311

client = ProxyClient(child_pipe, key_id, fpr,

1713

2312

self.client_address)

1714

2313

except KeyError:

1715

2314

return

1716

2315

1717

2316

if client.approval_delay:

1718

2317

delay = client.approval_delay

1719

2318

client.approvals_pending += 1

1720

2319

approval_required = True

1721

2320

1722

2321

while True:

1723

2322

if not client.enabled:

1724

2323

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

1725

client.name)

2324

client.name)

1726

2325

if self.server.use_dbus:

1727

2326

# Emit D-Bus signal

1728

2327

client.Rejected("Disabled")

1729

2328

return

1730

2329

1731

2330

if client.approved or not client.approval_delay:

1732

#We are approved or approval is disabled

2331

# We are approved or approval is disabled

1733

2332

break

1734

2333

elif client.approved is None:

1735

2334

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

1746

2345

# Emit D-Bus signal

1747

2346

client.Rejected("Denied")

1748

2347

return

1749

1750

#wait until timeout or approved

2348

2349

# wait until timeout or approved

1751

2350

time = datetime.datetime.now()

1752

2351

client.changedstate.acquire()

1753

2352

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

1766

2365

break

1767

2366

else:

1768

2367

delay -= time2 - time

1769

1770

sent_size = 0

1771

while sent_size < len(client.secret):

1772

try:

1773

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

1774

except gnutls.errors.GNUTLSError as error:

1775

logger.warning("gnutls send failed",

1776

exc_info=error)

1777

return

1778

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

1779

sent, len(client.secret)

1780

- (sent_size + sent))

1781

sent_size += sent

1782

2368

2369

try:

2370

session.send(client.secret)

2371

except gnutls.Error as error:

2372

logger.warning("gnutls send failed",

2373

exc_info=error)

2374

return

2375

1783

2376

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

1784

2377

# bump the timeout using extended_timeout

1785

2378

client.bump_timeout(client.extended_timeout)

1786

2379

if self.server.use_dbus:

1787

2380

# Emit D-Bus signal

1788

2381

client.GotSecret()

1789

2382

1790

2383

finally:

1791

2384

if approval_required:

1792

2385

client.approvals_pending -= 1

1793

2386

try:

1794

2387

session.bye()

1795

except gnutls.errors.GNUTLSError as error:

2388

except gnutls.Error as error:

1796

2389

logger.warning("GnuTLS bye failed",

1797

2390

exc_info=error)

1798

2391

1799

2392

@staticmethod

1800

2393

def peer_certificate(session):

1801

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

1802

# If not an OpenPGP certificate...

1803

if (gnutls.library.functions

1804

.gnutls_certificate_type_get(session._c_object)

1805

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1806

# ...do the normal thing

1807

return session.peer_certificate

2394

"Return the peer's certificate as a bytestring"

2395

try:

2396

cert_type = gnutls.certificate_type_get2(session._c_object,

2397

gnutls.CTYPE_PEERS)

2398

except AttributeError:

2399

cert_type = gnutls.certificate_type_get(session._c_object)

2400

if gnutls.has_rawpk:

2401

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2402

else:

2403

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2404

# If not a valid certificate type...

2405

if cert_type not in valid_cert_types:

2406

logger.info("Cert type %r not in %r", cert_type,

2407

valid_cert_types)

2408

# ...return invalid data

2409

return b""

1808

2410

list_size = ctypes.c_uint(1)

1809

cert_list = (gnutls.library.functions

1810

.gnutls_certificate_get_peers

2411

cert_list = (gnutls.certificate_get_peers

1811

2412

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

1812

2413

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

1813

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

1814

" certificate")

2414

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

1815

2415

if list_size.value == 0:

1816

2416

return None

1817

2417

cert = cert_list[0]

1818

2418

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

1819

2419

2420

@staticmethod

2421

def key_id(certificate):

2422

"Convert a certificate bytestring to a hexdigit key ID"

2423

# New GnuTLS "datum" with the public key

2424

datum = gnutls.datum_t(

2425

ctypes.cast(ctypes.c_char_p(certificate),

2426

ctypes.POINTER(ctypes.c_ubyte)),

2427

ctypes.c_uint(len(certificate)))

2428

# XXX all these need to be created in the gnutls "module"

2429

# New empty GnuTLS certificate

2430

pubkey = gnutls.pubkey_t()

2431

gnutls.pubkey_init(ctypes.byref(pubkey))

2432

# Import the raw public key into the certificate

2433

gnutls.pubkey_import(pubkey,

2434

ctypes.byref(datum),

2435

gnutls.X509_FMT_DER)

2436

# New buffer for the key ID

2437

buf = ctypes.create_string_buffer(32)

2438

buf_len = ctypes.c_size_t(len(buf))

2439

# Get the key ID from the raw public key into the buffer

2440

gnutls.pubkey_get_key_id(pubkey,

2441

gnutls.KEYID_USE_SHA256,

2442

ctypes.cast(ctypes.byref(buf),

2443

ctypes.POINTER(ctypes.c_ubyte)),

2444

ctypes.byref(buf_len))

2445

# Deinit the certificate

2446

gnutls.pubkey_deinit(pubkey)

2447

2448

# Convert the buffer to a Python bytestring

2449

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

2450

# Convert the bytestring to hexadecimal notation

2451

hex_key_id = binascii.hexlify(key_id).upper()

2452

return hex_key_id

2453

1820

2454

@staticmethod

1821

2455

def fingerprint(openpgp):

1822

2456

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1823

2457

# New GnuTLS "datum" with the OpenPGP public key

1824

datum = (gnutls.library.types

1825

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

1826

ctypes.POINTER

1827

(ctypes.c_ubyte)),

1828

ctypes.c_uint(len(openpgp))))

2458

datum = gnutls.datum_t(

2459

ctypes.cast(ctypes.c_char_p(openpgp),

2460

ctypes.POINTER(ctypes.c_ubyte)),

2461

ctypes.c_uint(len(openpgp)))

1829

2462

# New empty GnuTLS certificate

1830

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1831

(gnutls.library.functions

1832

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2463

crt = gnutls.openpgp_crt_t()

2464

gnutls.openpgp_crt_init(ctypes.byref(crt))

1833

2465

# Import the OpenPGP public key into the certificate

1834

(gnutls.library.functions

1835

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

1836

gnutls.library.constants

1837

.GNUTLS_OPENPGP_FMT_RAW))

2466

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

2467

gnutls.OPENPGP_FMT_RAW)

1838

2468

# Verify the self signature in the key

1839

2469

crtverify = ctypes.c_uint()

1840

(gnutls.library.functions

1841

.gnutls_openpgp_crt_verify_self(crt, 0,

1842

ctypes.byref(crtverify)))

2470

gnutls.openpgp_crt_verify_self(crt, 0,

2471

ctypes.byref(crtverify))

1843

2472

if crtverify.value != 0:

1844

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1845

raise (gnutls.errors.CertificateSecurityError

1846

("Verify failed"))

2473

gnutls.openpgp_crt_deinit(crt)

2474

raise gnutls.CertificateSecurityError(code

2475

=crtverify.value)

1847

2476

# New buffer for the fingerprint

1848

2477

buf = ctypes.create_string_buffer(20)

1849

2478

buf_len = ctypes.c_size_t()

1850

2479

# Get the fingerprint from the certificate into the buffer

1851

(gnutls.library.functions

1852

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

1853

ctypes.byref(buf_len)))

2480

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

2481

ctypes.byref(buf_len))

1854

2482

# Deinit the certificate

1855

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2483

gnutls.openpgp_crt_deinit(crt)

1856

2484

# Convert the buffer to a Python bytestring

1857

2485

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

1858

2486

# Convert the bytestring to hexadecimal notation

1862

2490

1863

2491

class MultiprocessingMixIn(object):

1864

2492

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

2493

1865

2494

def sub_process_main(self, request, address):

1866

2495

try:

1867

2496

self.finish_request(request, address)

1868

2497

except Exception:

1869

2498

self.handle_error(request, address)

1870

2499

self.close_request(request)

1871

2500

1872

2501

def process_request(self, request, address):

1873

2502

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

1874

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

1875

args = (request, address))

2503

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

2504

args=(request, address))

1876

2505

proc.start()

1877

2506

return proc

1878

2507

1879

2508

1880

2509

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1881

2510

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

2511

1882

2512

def process_request(self, request, client_address):

1883

2513

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

1884

2514

1885

2515

This function creates a new pipe in self.pipe

1886

2516

"""

1887

2517

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1888

2518

1889

2519

proc = MultiprocessingMixIn.process_request(self, request,

1890

2520

client_address)

1891

2521

self.child_pipe.close()

1892

2522

self.add_pipe(parent_pipe, proc)

1893

2523

1894

2524

def add_pipe(self, parent_pipe, proc):

1895

2525

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

1896

2526

raise NotImplementedError()

1899

2529

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1900

2530

socketserver.TCPServer, object):

1901

2531

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

1902

2532

1903

2533

Attributes:

1904

2534

enabled: Boolean; whether this server is activated yet

1905

2535

interface: None or a network interface name (string)

1906

2536

use_ipv6: Boolean; to use IPv6 or not

1907

2537

"""

2538

1908

2539

def __init__(self, server_address, RequestHandlerClass,

1909

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

2540

interface=None,

2541

use_ipv6=True,

2542

socketfd=None):

1910

2543

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

1911

2544

creating a new one with socket.socket().

1912

2545

"""

1918

2551

self.socketfd = socketfd

1919

2552

# Save the original socket.socket() function

1920

2553

self.socket_socket = socket.socket

2554

1921

2555

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

1922

#

2556

#

1923

2557

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

1924

2558

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

1925

2559

# patching socket.socket.)

1926

#

2560

#

1927

2561

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

1928

2562

@functools.wraps(socket.socket)

1929

2563

def socket_wrapper(*args, **kwargs):

1941

2575

# socket_wrapper(), if socketfd was set.

1942

2576

socketserver.TCPServer.__init__(self, server_address,

1943

2577

RequestHandlerClass)

1944

2578

1945

2579

def server_bind(self):

1946

2580

"""This overrides the normal server_bind() function

1947

2581

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

1948

2582

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

2583

global SO_BINDTODEVICE

1949

2584

if self.interface is not None:

1950

2585

if SO_BINDTODEVICE is None:

1951

logger.error("SO_BINDTODEVICE does not exist;"

1952

" cannot bind to interface %s",

1953

self.interface)

1954

else:

1955

try:

1956

self.socket.setsockopt(socket.SOL_SOCKET,

1957

SO_BINDTODEVICE,

1958

(self.interface + "\0")

1959

.encode("utf-8"))

1960

except socket.error as error:

1961

if error.errno == errno.EPERM:

1962

logger.error("No permission to bind to"

1963

" interface %s", self.interface)

1964

elif error.errno == errno.ENOPROTOOPT:

1965

logger.error("SO_BINDTODEVICE not available;"

1966

" cannot bind to interface %s",

1967

self.interface)

1968

elif error.errno == errno.ENODEV:

1969

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

1970

" cannot bind", self.interface)

1971

else:

1972

raise

2586

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

2587

# common enough.

2588

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

2589

SO_BINDTODEVICE = 25

2590

try:

2591

self.socket.setsockopt(

2592

socket.SOL_SOCKET, SO_BINDTODEVICE,

2593

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

2594

except socket.error as error:

2595

if error.errno == errno.EPERM:

2596

logger.error("No permission to bind to"

2597

" interface %s", self.interface)

2598

elif error.errno == errno.ENOPROTOOPT:

2599

logger.error("SO_BINDTODEVICE not available;"

2600

" cannot bind to interface %s",

2601

self.interface)

2602

elif error.errno == errno.ENODEV:

2603

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

2604

" cannot bind", self.interface)

2605

else:

2606

raise

1973

2607

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

1974

2608

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

2609

if self.server_address[1]:

2610

self.allow_reuse_address = True

1975

2611

if not self.server_address[0]:

1976

2612

if self.address_family == socket.AF_INET6:

1977

any_address = "::" # in6addr_any

2613

any_address = "::" # in6addr_any

1978

2614

else:

1979

any_address = "0.0.0.0" # INADDR_ANY

2615

any_address = "0.0.0.0" # INADDR_ANY

1980

2616

self.server_address = (any_address,

1981

2617

self.server_address[1])

1982

2618

elif not self.server_address[1]:

1983

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

1984

0)

2619

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

1985

2620

# if self.interface:

1986

2621

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

1987

2622

# 0, # port

1993

2628

1994

2629

class MandosServer(IPv6_TCPServer):

1995

2630

"""Mandos server.

1996

2631

1997

2632

Attributes:

1998

2633

clients: set of Client objects

1999

2634

gnutls_priority GnuTLS priority string

2000

2635

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

2001

2002

Assumes a gobject.MainLoop event loop.

2636

2637

Assumes a GLib.MainLoop event loop.

2003

2638

"""

2639

2004

2640

def __init__(self, server_address, RequestHandlerClass,

2005

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

2006

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

2641

interface=None,

2642

use_ipv6=True,

2643

clients=None,

2644

gnutls_priority=None,

2645

use_dbus=True,

2646

socketfd=None):

2007

2647

self.enabled = False

2008

2648

self.clients = clients

2009

2649

if self.clients is None:

2012

2652

self.gnutls_priority = gnutls_priority

2013

2653

IPv6_TCPServer.__init__(self, server_address,

2014

2654

RequestHandlerClass,

2015

interface = interface,

2016

use_ipv6 = use_ipv6,

2017

socketfd = socketfd)

2655

interface=interface,

2656

use_ipv6=use_ipv6,

2657

socketfd=socketfd)

2658

2018

2659

def server_activate(self):

2019

2660

if self.enabled:

2020

2661

return socketserver.TCPServer.server_activate(self)

2021

2662

2022

2663

def enable(self):

2023

2664

self.enabled = True

2024

2665

2025

2666

def add_pipe(self, parent_pipe, proc):

2026

2667

# Call "handle_ipc" for both data and EOF events

2027

gobject.io_add_watch(parent_pipe.fileno(),

2028

gobject.IO_IN | gobject.IO_HUP,

2029

functools.partial(self.handle_ipc,

2030

parent_pipe =

2031

parent_pipe,

2032

proc = proc))

2033

2034

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

2035

proc = None, client_object=None):

2668

GLib.io_add_watch(

2669

parent_pipe.fileno(),

2670

GLib.IO_IN | GLib.IO_HUP,

2671

functools.partial(self.handle_ipc,

2672

parent_pipe=parent_pipe,

2673

proc=proc))

2674

2675

def handle_ipc(self, source, condition,

2676

parent_pipe=None,

2677

proc=None,

2678

client_object=None):

2036

2679

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

2037

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

2680

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

2038

2681

# Wait for other process to exit

2039

2682

proc.join()

2040

2683

return False

2041

2684

2042

2685

# Read a request from the child

2043

2686

request = parent_pipe.recv()

2044

2687

command = request[0]

2045

2688

2046

2689

if command == 'init':

2047

fpr = request[1]

2048

address = request[2]

2049

2050

for c in self.clients.itervalues():

2051

if c.fingerprint == fpr:

2690

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

2691

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

2692

address = request[3]

2693

2694

for c in self.clients.values():

2695

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2696

continue

2697

if key_id and c.key_id == key_id:

2698

client = c

2699

break

2700

if fpr and c.fingerprint == fpr:

2052

2701

client = c

2053

2702

break

2054

2703

else:

2055

logger.info("Client not found for fingerprint: %s, ad"

2056

"dress: %s", fpr, address)

2704

logger.info("Client not found for key ID: %s, address"

2705

": %s", key_id or fpr, address)

2057

2706

if self.use_dbus:

2058

2707

# Emit D-Bus signal

2059

mandos_dbus_service.ClientNotFound(fpr,

2708

mandos_dbus_service.ClientNotFound(key_id or fpr,

2060

2709

address[0])

2061

2710

parent_pipe.send(False)

2062

2711

return False

2063

2064

gobject.io_add_watch(parent_pipe.fileno(),

2065

gobject.IO_IN | gobject.IO_HUP,

2066

functools.partial(self.handle_ipc,

2067

parent_pipe =

2068

parent_pipe,

2069

proc = proc,

2070

client_object =

2071

client))

2712

2713

GLib.io_add_watch(

2714

parent_pipe.fileno(),

2715

GLib.IO_IN | GLib.IO_HUP,

2716

functools.partial(self.handle_ipc,

2717

parent_pipe=parent_pipe,

2718

proc=proc,

2719

client_object=client))

2072

2720

parent_pipe.send(True)

2073

2721

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

2074

2722

# same fileno

2077

2725

funcname = request[1]

2078

2726

args = request[2]

2079

2727

kwargs = request[3]

2080

2728

2081

2729

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

2082

2730

funcname)(*args,

2083

**kwargs)))

2084

2731

**kwargs)))

2732

2085

2733

if command == 'getattr':

2086

2734

attrname = request[1]

2087

if callable(client_object.__getattribute__(attrname)):

2088

parent_pipe.send(('function',))

2735

if isinstance(client_object.__getattribute__(attrname),

2736

collections.Callable):

2737

parent_pipe.send(('function', ))

2089

2738

else:

2090

parent_pipe.send(('data', client_object

2091

.__getattribute__(attrname)))

2092

2739

parent_pipe.send((

2740

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

2741

2093

2742

if command == 'setattr':

2094

2743

attrname = request[1]

2095

2744

value = request[2]

2096

2745

setattr(client_object, attrname, value)

2097

2746

2098

2747

return True

2099

2748

2100

2749

2101

2750

def rfc3339_duration_to_delta(duration):

2102

2751

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

2103

2752

2104

2753

>>> rfc3339_duration_to_delta("P7D")

2105

2754

datetime.timedelta(7)

2106

2755

>>> rfc3339_duration_to_delta("PT60S")

2116

2765

>>> rfc3339_duration_to_delta("P1DT3M20S")

2117

2766

datetime.timedelta(1, 200)

2118

2767

"""

2119

2768

2120

2769

# Parsing an RFC 3339 duration with regular expressions is not

2121

2770

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

2122

2771

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

2123

2772

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

2124

2773

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

2125

2774

# avoid excessive use of external libraries.

2126

2775

2127

2776

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

2128

Token = collections.namedtuple("Token",

2129

("regexp", # To match token; if

2130

# "value" is not None,

2131

# must have a "group"

2132

# containing digits

2133

"value", # datetime.timedelta or

2134

# None

2135

"followers")) # Tokens valid after

2136

# this token

2777

Token = collections.namedtuple("Token", (

2778

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

2779

# a "group" containing digits

2780

"value", # datetime.timedelta or None

2781

"followers")) # Tokens valid after this token

2137

2782

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

2138

2783

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

2139

2784

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

2140

2785

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

2141

2786

datetime.timedelta(seconds=1),

2142

frozenset((token_end,)))

2787

frozenset((token_end, )))

2143

2788

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

2144

2789

datetime.timedelta(minutes=1),

2145

2790

frozenset((token_second, token_end)))

2161

2806

frozenset((token_month, token_end)))

2162

2807

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

2163

2808

datetime.timedelta(weeks=1),

2164

frozenset((token_end,)))

2809

frozenset((token_end, )))

2165

2810

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

2166

2811

frozenset((token_year, token_month,

2167

2812

token_day, token_time,

2168

2813

token_week)))

2169

# Define starting values

2170

value = datetime.timedelta() # Value so far

2814

# Define starting values:

2815

# Value so far

2816

value = datetime.timedelta()

2171

2817

found_token = None

2172

followers = frozenset((token_duration,)) # Following valid tokens

2173

s = duration # String left to parse

2818

# Following valid tokens

2819

followers = frozenset((token_duration, ))

2820

# String left to parse

2821

s = duration

2174

2822

# Loop until end token is found

2175

2823

while found_token is not token_end:

2176

2824

# Search for any currently valid tokens

2192

2840

break

2193

2841

else:

2194

2842

# No currently valid tokens were found

2195

raise ValueError("Invalid RFC 3339 duration")

2843

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

2844

.format(duration))

2196

2845

# End token found

2197

2846

return value

2198

2847

2199

2848

2200

2849

def string_to_delta(interval):

2201

2850

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

2202

2851

2203

2852

>>> string_to_delta('7d')

2204

2853

datetime.timedelta(7)

2205

2854

>>> string_to_delta('60s')

2213

2862

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

2214

2863

datetime.timedelta(0, 330)

2215

2864

"""

2216

2865

2217

2866

try:

2218

2867

return rfc3339_duration_to_delta(interval)

2219

2868

except ValueError:

2220

2869

pass

2221

2870

2222

2871

timevalue = datetime.timedelta(0)

2223

2872

for s in interval.split():

2224

2873

try:

2235

2884

elif suffix == "w":

2236

2885

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

2237

2886

else:

2238

raise ValueError("Unknown suffix {!r}"

2239

.format(suffix))

2887

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

2240

2888

except IndexError as e:

2241

2889

raise ValueError(*(e.args))

2242

2890

timevalue += delta

2243

2891

return timevalue

2244

2892

2245

2893

2246

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

2894

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

2247

2895

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

2248

2896

2249

2897

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

2250

2898

if os.fork():

2251

2899

sys.exit()

2258

2906

# Close all standard open file descriptors

2259

2907

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

2260

2908

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

2261

raise OSError(errno.ENODEV, "{} not a character device"

2909

raise OSError(errno.ENODEV,

2910

"{} not a character device"

2262

2911

.format(os.devnull))

2263

2912

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

2264

2913

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

2268

2917

2269

2918

2270

2919

def main():

2271

2920

2272

2921

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

2273

2922

# Parsing of options, both command line and config file

2274

2923

2275

2924

parser = argparse.ArgumentParser()

2276

2925

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

2277

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

2926

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

2278

2927

help="show version number and exit")

2279

2928

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

2280

2929

help="Bind to interface IF")

2316

2965

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

2317

2966

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

2318

2967

default=None)

2319

2968

2320

2969

options = parser.parse_args()

2321

2970

2322

2971

if options.check:

2323

2972

import doctest

2324

2973

fail_count, test_count = doctest.testmod()

2325

2974

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

2326

2975

2327

2976

# Default values for config file for server-global settings

2328

server_defaults = { "interface": "",

2329

"address": "",

2330

"port": "",

2331

"debug": "False",

2332

"priority":

2333

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

2334

"servicename": "Mandos",

2335

"use_dbus": "True",

2336

"use_ipv6": "True",

2337

"debuglevel": "",

2338

"restore": "True",

2339

"socket": "",

2340

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

2341

"foreground": "False",

2342

"zeroconf": "True",

2343

}

2344

2977

if gnutls.has_rawpk:

2978

priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"

2979

":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")

2980

else:

2981

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

2982

":+SIGN-DSA-SHA256")

2983

server_defaults = {"interface": "",

2984

"address": "",

2985

"port": "",

2986

"debug": "False",

2987

"priority": priority,

2988

"servicename": "Mandos",

2989

"use_dbus": "True",

2990

"use_ipv6": "True",

2991

"debuglevel": "",

2992

"restore": "True",

2993

"socket": "",

2994

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

2995

"foreground": "False",

2996

"zeroconf": "True",

2997

}

2998

del priority

2999

2345

3000

# Parse config file for server-global settings

2346

3001

server_config = configparser.SafeConfigParser(server_defaults)

2347

3002

del server_defaults

2348

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

2349

"mandos.conf"))

3003

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

2350

3004

# Convert the SafeConfigParser object to a dict

2351

3005

server_settings = server_config.defaults()

2352

3006

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

2353

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

3007

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

3008

"foreground", "zeroconf"):

2354

3009

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

2355

3010

option)

2356

3011

if server_settings["port"]:

2366

3021

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

2367

3022

["socket"])

2368

3023

del server_config

2369

3024

2370

3025

# Override the settings from the config file with command line

2371

3026

# options, if set.

2372

3027

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

2373

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

2374

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

2375

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

3028

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

3029

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

3030

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

2376

3031

value = getattr(options, option)

2377

3032

if value is not None:

2378

3033

server_settings[option] = value

2390

3045

if server_settings["debug"]:

2391

3046

server_settings["foreground"] = True

2392

3047

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

2393

3048

2394

3049

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

2395

2396

if (not server_settings["zeroconf"] and

2397

not (server_settings["port"]

2398

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

2399

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

2400

" Zeroconf")

2401

3050

3051

if (not server_settings["zeroconf"]

3052

and not (server_settings["port"]

3053

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

3054

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

3055

2402

3056

# For convenience

2403

3057

debug = server_settings["debug"]

2404

3058

debuglevel = server_settings["debuglevel"]

2408

3062

stored_state_file)

2409

3063

foreground = server_settings["foreground"]

2410

3064

zeroconf = server_settings["zeroconf"]

2411

3065

2412

3066

if debug:

2413

3067

initlogger(debug, logging.DEBUG)

2414

3068

else:

2417

3071

else:

2418

3072

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

2419

3073

initlogger(debug, level)

2420

3074

2421

3075

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

2422

syslogger.setFormatter(logging.Formatter

2423

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

2424

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

2425

.format(server_settings

2426

["servicename"])))

2427

3076

syslogger.setFormatter(

3077

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

3078

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

3079

server_settings["servicename"])))

3080

2428

3081

# Parse config file with clients

2429

3082

client_config = configparser.SafeConfigParser(Client

2430

3083

.client_defaults)

2431

3084

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

2432

3085

"clients.conf"))

2433

3086

2434

3087

global mandos_dbus_service

2435

3088

mandos_dbus_service = None

2436

3089

2437

3090

socketfd = None

2438

3091

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

2439

3092

socketfd = server_settings["socket"]

2440

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

2441

server_settings["port"]),

2442

ClientHandler,

2443

interface=(server_settings["interface"]

2444

or None),

2445

use_ipv6=use_ipv6,

2446

gnutls_priority=

2447

server_settings["priority"],

2448

use_dbus=use_dbus,

2449

socketfd=socketfd)

3093

tcp_server = MandosServer(

3094

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

3095

ClientHandler,

3096

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

3097

use_ipv6=use_ipv6,

3098

gnutls_priority=server_settings["priority"],

3099

use_dbus=use_dbus,

3100

socketfd=socketfd)

2450

3101

if not foreground:

2451

3102

pidfilename = "/run/mandos.pid"

2452

3103

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

2453

3104

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

2454

3105

pidfile = None

2455

3106

try:

2456

pidfile = open(pidfilename, "w")

3107

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

2457

3108

except IOError as e:

2458

3109

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

2459

3110

exc_info=e)

2460

2461

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

3111

3112

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

3113

("mandos", "mandos"),

3114

("nobody", "nogroup")):

2462

3115

try:

2463

3116

uid = pwd.getpwnam(name).pw_uid

2464

gid = pwd.getpwnam(name).pw_gid

3117

gid = pwd.getpwnam(group).pw_gid

2465

3118

break

2466

3119

except KeyError:

2467

3120

continue

2471

3124

try:

2472

3125

os.setgid(gid)

2473

3126

os.setuid(uid)

3127

if debug:

3128

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

3129

gid))

2474

3130

except OSError as error:

3131

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

3132

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

2475

3133

if error.errno != errno.EPERM:

2476

3134

raise

2477

3135

2478

3136

if debug:

2479

3137

# Enable all possible GnuTLS debugging

2480

3138

2481

3139

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

2482

3140

# - GnuTLS manual

2483

gnutls.library.functions.gnutls_global_set_log_level(11)

2484

2485

@gnutls.library.types.gnutls_log_func

3141

gnutls.global_set_log_level(11)

3142

3143

@gnutls.log_func

2486

3144

def debug_gnutls(level, string):

2487

3145

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

2488

2489

(gnutls.library.functions

2490

.gnutls_global_set_log_function(debug_gnutls))

2491

3146

3147

gnutls.global_set_log_function(debug_gnutls)

3148

2492

3149

# Redirect stdin so all checkers get /dev/null

2493

3150

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

2494

3151

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

2495

3152

if null > 2:

2496

3153

os.close(null)

2497

3154

2498

3155

# Need to fork before connecting to D-Bus

2499

3156

if not foreground:

2500

3157

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

2501

3158

daemon()

2502

2503

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

2504

# need to inform gobject that threads will be used.

2505

gobject.threads_init()

2506

3159

3160

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

3161

# to inform GLib that threads will be used.

3162

GLib.threads_init()

3163

2507

3164

global main_loop

2508

3165

# From the Avahi example code

2509

3166

DBusGMainLoop(set_as_default=True)

2510

main_loop = gobject.MainLoop()

3167

main_loop = GLib.MainLoop()

2511

3168

bus = dbus.SystemBus()

2512

3169

# End of Avahi example code

2513

3170

if use_dbus:

2514

3171

try:

2515

3172

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

2516

bus, do_not_queue=True)

2517

old_bus_name = (dbus.service.BusName

2518

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

2519

do_not_queue=True))

2520

except dbus.exceptions.NameExistsException as e:

3173

bus,

3174

do_not_queue=True)

3175

old_bus_name = dbus.service.BusName(

3176

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

3177

do_not_queue=True)

3178

except dbus.exceptions.DBusException as e:

2521

3179

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

2522

3180

use_dbus = False

2523

3181

server_settings["use_dbus"] = False

2524

3182

tcp_server.use_dbus = False

2525

3183

if zeroconf:

2526

3184

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2527

service = AvahiServiceToSyslog(name =

2528

server_settings["servicename"],

2529

servicetype = "_mandos._tcp",

2530

protocol = protocol, bus = bus)

3185

service = AvahiServiceToSyslog(

3186

name=server_settings["servicename"],

3187

servicetype="_mandos._tcp",

3188

protocol=protocol,

3189

bus=bus)

2531

3190

if server_settings["interface"]:

2532

service.interface = (if_nametoindex

2533

(server_settings["interface"]

2534

.encode("utf-8")))

2535

3191

service.interface = if_nametoindex(

3192

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

3193

2536

3194

global multiprocessing_manager

2537

3195

multiprocessing_manager = multiprocessing.Manager()

2538

3196

2539

3197

client_class = Client

2540

3198

if use_dbus:

2541

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

2542

3199

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

3200

2543

3201

client_settings = Client.config_parser(client_config)

2544

3202

old_client_settings = {}

2545

3203

clients_data = {}

2546

3204

2547

3205

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

2548

3206

global wnull

2549

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

3207

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

2550

3208

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

2551

3209

# mode

2552

3210

if debug or not foreground:

2553

3211

wnull.close()

2554

3212

2555

3213

# Get client data and settings from last running state.

2556

3214

if server_settings["restore"]:

2557

3215

try:

2558

3216

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

2559

clients_data, old_client_settings = (pickle.load

2560

(stored_state))

3217

if sys.version_info.major == 2:

3218

clients_data, old_client_settings = pickle.load(

3219

stored_state)

3220

else:

3221

bytes_clients_data, bytes_old_client_settings = (

3222

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

3223

# Fix bytes to strings

3224

# clients_data

3225

# .keys()

3226

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

3227

if isinstance(key, bytes)

3228

else key): value

3229

for key, value in

3230

bytes_clients_data.items()}

3231

del bytes_clients_data

3232

for key in clients_data:

3233

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

3234

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

3235

for k, v in

3236

clients_data[key].items()}

3237

clients_data[key] = value

3238

# .client_structure

3239

value["client_structure"] = [

3240

(s.decode("utf-8")

3241

if isinstance(s, bytes)

3242

else s) for s in

3243

value["client_structure"]]

3244

# .name & .host

3245

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

3246

if isinstance(value[k], bytes):

3247

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

3248

if "key_id" not in value:

3249

value["key_id"] = ""

3250

elif "fingerprint" not in value:

3251

value["fingerprint"] = ""

3252

# old_client_settings

3253

# .keys()

3254

old_client_settings = {

3255

(key.decode("utf-8")

3256

if isinstance(key, bytes)

3257

else key): value

3258

for key, value in

3259

bytes_old_client_settings.items()}

3260

del bytes_old_client_settings

3261

# .host

3262

for value in old_client_settings.values():

3263

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

3264

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

3265

.decode("utf-8"))

2561

3266

os.remove(stored_state_path)

2562

3267

except IOError as e:

2563

3268

if e.errno == errno.ENOENT:

2564

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

2565

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

3269

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

3270

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

2566

3271

else:

2567

3272

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

2568

3273

exc_info=e)

2569

3274

raise

2570

3275

except EOFError as e:

2571

3276

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

2572

"EOFError:", exc_info=e)

2573

3277

"EOFError:",

3278

exc_info=e)

3279

2574

3280

with PGPEngine() as pgp:

2575

3281

for client_name, client in clients_data.items():

2576

3282

# Skip removed clients

2577

3283

if client_name not in client_settings:

2578

3284

continue

2579

3285

2580

3286

# Decide which value to use after restoring saved state.

2581

3287

# We have three different values: Old config file,

2582

3288

# new config file, and saved state.

2587

3293

# For each value in new config, check if it

2588

3294

# differs from the old config value (Except for

2589

3295

# the "secret" attribute)

2590

if (name != "secret" and

2591

value != old_client_settings[client_name]

2592

[name]):

3296

if (name != "secret"

3297

and (value !=

3298

old_client_settings[client_name][name])):

2593

3299

client[name] = value

2594

3300

except KeyError:

2595

3301

pass

2596

3302

2597

3303

# Clients who has passed its expire date can still be

2598

# enabled if its last checker was successful. Clients

3304

# enabled if its last checker was successful. A Client

2599

3305

# whose checker succeeded before we stored its state is

2600

3306

# assumed to have successfully run all checkers during

2601

3307

# downtime.

2604

3310

if not client["last_checked_ok"]:

2605

3311

logger.warning(

2606

3312

"disabling client {} - Client never "

2607

"performed a successful checker"

2608

.format(client_name))

3313

"performed a successful checker".format(

3314

client_name))

2609

3315

client["enabled"] = False

2610

3316

elif client["last_checker_status"] != 0:

2611

3317

logger.warning(

2612

3318

"disabling client {} - Client last"

2613

" checker failed with error code {}"

2614

.format(client_name,

2615

client["last_checker_status"]))

3319

" checker failed with error code"

3320

" {}".format(

3321

client_name,

3322

client["last_checker_status"]))

2616

3323

client["enabled"] = False

2617

3324

else:

2618

client["expires"] = (datetime.datetime

2619

.utcnow()

2620

+ client["timeout"])

3325

client["expires"] = (

3326

datetime.datetime.utcnow()

3327

+ client["timeout"])

2621

3328

logger.debug("Last checker succeeded,"

2622

" keeping {} enabled"

2623

.format(client_name))

3329

" keeping {} enabled".format(

3330

client_name))

2624

3331

try:

2625

client["secret"] = (

2626

pgp.decrypt(client["encrypted_secret"],

2627

client_settings[client_name]

2628

["secret"]))

3332

client["secret"] = pgp.decrypt(

3333

client["encrypted_secret"],

3334

client_settings[client_name]["secret"])

2629

3335

except PGPError:

2630

3336

# If decryption fails, we use secret from new settings

2631

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

2632

.format(client_name))

2633

client["secret"] = (

2634

client_settings[client_name]["secret"])

2635

3337

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

3338

client_name))

3339

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

3340

["secret"])

3341

2636

3342

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

2637

3343

for client_name in (set(old_client_settings)

2638

3344

- set(client_settings)):

2640

3346

for client_name in (set(client_settings)

2641

3347

- set(old_client_settings)):

2642

3348

clients_data[client_name] = client_settings[client_name]

2643

3349

2644

3350

# Create all client objects

2645

3351

for client_name, client in clients_data.items():

2646

3352

tcp_server.clients[client_name] = client_class(

2647

name = client_name, settings = client,

2648

server_settings = server_settings)

2649

3353

name=client_name,

3354

settings=client,

3355

server_settings=server_settings)

3356

2650

3357

if not tcp_server.clients:

2651

3358

logger.warning("No clients defined")

2652

3359

2653

3360

if not foreground:

2654

3361

if pidfile is not None:

3362

pid = os.getpid()

2655

3363

try:

2656

3364

with pidfile:

2657

pid = os.getpid()

2658

pidfile.write("{}\n".format(pid).encode("utf-8"))

3365

print(pid, file=pidfile)

2659

3366

except IOError:

2660

3367

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

2661

3368

pidfilename, pid)

2662

3369

del pidfile

2663

3370

del pidfilename

2664

2665

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

2666

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

2667

3371

3372

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

3373

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3374

lambda: main_loop.quit() and False)

3375

2668

3376

if use_dbus:

2669

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

2670

"se.bsnet.fukt.Mandos"})

2671

class MandosDBusService(DBusObjectWithProperties):

3377

3378

@alternate_dbus_interfaces(

3379

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

3380

class MandosDBusService(DBusObjectWithObjectManager):

2672

3381

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

3382

2673

3383

def __init__(self):

2674

3384

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

3385

2675

3386

_interface = "se.recompile.Mandos"

2676

2677

@dbus_interface_annotations(_interface)

2678

def _foo(self):

2679

return { "org.freedesktop.DBus.Property"

2680

".EmitsChangedSignal":

2681

"false"}

2682

3387

2683

3388

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

2684

3389

def ClientAdded(self, objpath):

2685

3390

"D-Bus signal"

2686

3391

pass

2687

3392

2688

3393

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

2689

def ClientNotFound(self, fingerprint, address):

3394

def ClientNotFound(self, key_id, address):

2690

3395

"D-Bus signal"

2691

3396

pass

2692

3397

3398

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

3399

"true"})

2693

3400

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

2694

3401

def ClientRemoved(self, objpath, name):

2695

3402

"D-Bus signal"

2696

3403

pass

2697

3404

3405

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

3406

"true"})

2698

3407

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

2699

3408

def GetAllClients(self):

2700

3409

"D-Bus method"

2701

return dbus.Array(c.dbus_object_path

2702

for c in

2703

tcp_server.clients.itervalues())

2704

3410

return dbus.Array(c.dbus_object_path for c in

3411

tcp_server.clients.values())

3412

3413

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

3414

"true"})

2705

3415

@dbus.service.method(_interface,

2706

3416

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

2707

3417

def GetAllClientsWithProperties(self):

2708

3418

"D-Bus method"

2709

3419

return dbus.Dictionary(

2710

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

2711

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

3420

{c.dbus_object_path: c.GetAll(

3421

"se.recompile.Mandos.Client")

3422

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

2712

3423

signature="oa{sv}")

2713

3424

2714

3425

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

2715

3426

def RemoveClient(self, object_path):

2716

3427

"D-Bus method"

2717

for c in tcp_server.clients.itervalues():

3428

for c in tcp_server.clients.values():

2718

3429

if c.dbus_object_path == object_path:

2719

3430

del tcp_server.clients[c.name]

2720

3431

c.remove_from_connection()

2721

# Don't signal anything except ClientRemoved

3432

# Don't signal the disabling

2722

3433

c.disable(quiet=True)

2723

# Emit D-Bus signal

2724

self.ClientRemoved(object_path, c.name)

3434

# Emit D-Bus signal for removal

3435

self.client_removed_signal(c)

2725

3436

return

2726

3437

raise KeyError(object_path)

2727

3438

2728

3439

del _interface

2729

3440

3441

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3442

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

3443

def GetManagedObjects(self):

3444

"""D-Bus method"""

3445

return dbus.Dictionary(

3446

{client.dbus_object_path:

3447

dbus.Dictionary(

3448

{interface: client.GetAll(interface)

3449

for interface in

3450

client._get_all_interface_names()})

3451

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

3452

3453

def client_added_signal(self, client):

3454

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

3455

if use_dbus:

3456

# New standard signal

3457

self.InterfacesAdded(

3458

client.dbus_object_path,

3459

dbus.Dictionary(

3460

{interface: client.GetAll(interface)

3461

for interface in

3462

client._get_all_interface_names()}))

3463

# Old signal

3464

self.ClientAdded(client.dbus_object_path)

3465

3466

def client_removed_signal(self, client):

3467

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

3468

if use_dbus:

3469

# New standard signal

3470

self.InterfacesRemoved(

3471

client.dbus_object_path,

3472

client._get_all_interface_names())

3473

# Old signal

3474

self.ClientRemoved(client.dbus_object_path,

3475

client.name)

3476

2730

3477

mandos_dbus_service = MandosDBusService()

2731

3478

3479

# Save modules to variables to exempt the modules from being

3480

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

3481

mp = multiprocessing

3482

wn = wnull

3483

2732

3484

def cleanup():

2733

3485

"Cleanup function; run on exit"

2734

3486

if zeroconf:

2735

3487

service.cleanup()

2736

2737

multiprocessing.active_children()

2738

wnull.close()

3488

3489

mp.active_children()

3490

wn.close()

2739

3491

if not (tcp_server.clients or client_settings):

2740

3492

return

2741

3493

2742

3494

# Store client before exiting. Secrets are encrypted with key

2743

3495

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

2744

3496

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

2745

3497

clients = {}

2746

3498

with PGPEngine() as pgp:

2747

for client in tcp_server.clients.itervalues():

3499

for client in tcp_server.clients.values():

2748

3500

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

2749

3501

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

2750

3502

key)

2751

3503

client_dict = {}

2752

3504

2753

3505

# A list of attributes that can not be pickled

2754

3506

# + secret.

2755

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

2756

"checker", "server_settings" }

2757

for name, typ in (inspect.getmembers

2758

(dbus.service.Object)):

3507

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

3508

"checker", "server_settings"}

3509

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

3510

.Object):

2759

3511

exclude.add(name)

2760

3512

2761

3513

client_dict["encrypted_secret"] = (client

2762

3514

.encrypted_secret)

2763

3515

for attr in client.client_structure:

2764

3516

if attr not in exclude:

2765

3517

client_dict[attr] = getattr(client, attr)

2766

3518

2767

3519

clients[client.name] = client_dict

2768

3520

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

2769

3521

2770

3522

try:

2771

with (tempfile.NamedTemporaryFile

2772

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

2773

dir=os.path.dirname(stored_state_path),

2774

delete=False)) as stored_state:

2775

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

2776

tempname=stored_state.name

3523

with tempfile.NamedTemporaryFile(

3524

mode='wb',

3525

suffix=".pickle",

3526

prefix='clients-',

3527

dir=os.path.dirname(stored_state_path),

3528

delete=False) as stored_state:

3529

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

3530

protocol=2)

3531

tempname = stored_state.name

2777

3532

os.rename(tempname, stored_state_path)

2778

3533

except (IOError, OSError) as e:

2779

3534

if not debug:

2788

3543

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

2789

3544

exc_info=e)

2790

3545

raise

2791

3546

2792

3547

# Delete all clients, and settings from config

2793

3548

while tcp_server.clients:

2794

3549

name, client = tcp_server.clients.popitem()

2795

3550

if use_dbus:

2796

3551

client.remove_from_connection()

2797

# Don't signal anything except ClientRemoved

3552

# Don't signal the disabling

2798

3553

client.disable(quiet=True)

3554

# Emit D-Bus signal for removal

2799

3555

if use_dbus:

2800

# Emit D-Bus signal

2801

mandos_dbus_service.ClientRemoved(client

2802

.dbus_object_path,

2803

client.name)

3556

mandos_dbus_service.client_removed_signal(client)

2804

3557

client_settings.clear()

2805

3558

2806

3559

atexit.register(cleanup)

2807

2808

for client in tcp_server.clients.itervalues():

3560

3561

for client in tcp_server.clients.values():

2809

3562

if use_dbus:

2810

# Emit D-Bus signal

2811

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3563

# Emit D-Bus signal for adding

3564

mandos_dbus_service.client_added_signal(client)

2812

3565

# Need to initiate checking of clients

2813

3566

if client.enabled:

2814

3567

client.init_checker()

2815

3568

2816

3569

tcp_server.enable()

2817

3570

tcp_server.server_activate()

2818

3571

2819

3572

# Find out what port we got

2820

3573

if zeroconf:

2821

3574

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

2826

3579

else: # IPv4

2827

3580

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

2828

3581

*tcp_server.socket.getsockname())

2829

2830

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

2831

3582

3583

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

3584

2832

3585

try:

2833

3586

if zeroconf:

2834

3587

# From the Avahi example code

2839

3592

cleanup()

2840

3593

sys.exit(1)

2841

3594

# End of Avahi example code

2842

2843

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

2844

lambda *args, **kwargs:

2845

(tcp_server.handle_request

2846

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

2847

3595

3596

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

3597

lambda *args, **kwargs:

3598

(tcp_server.handle_request

3599

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

3600

2848

3601

logger.debug("Starting main loop")

2849

3602

main_loop.run()

2850

3603

except AvahiError as error:

2859

3612

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

2860

3613

cleanup()

2861

3614

3615

2862

3616

if __name__ == '__main__':

2863

3617

main()