/mandos/release : revision 237.7.637

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

92

119

stored_state_file = "clients.pickle"

93

120

94

121

logger = logging.getLogger()

95

122

syslogger = None

96

123

97

124

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

101

127

except (OSError, AttributeError):

128

102

129

def if_nametoindex(interface):

103

130

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

104

131

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

105

132

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

106

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

134

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

135

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

111

136

return interface_index

112

137

113

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

114

155

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

115

156

"""init logger and add loglevel"""

116

157

117

158

global syslogger

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

122

162

syslogger.setFormatter(logging.Formatter

123

163

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

124

164

' %(message)s'))

125

165

logger.addHandler(syslogger)

126

166

127

167

if debug:

128

168

console = logging.StreamHandler()

129

169

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

141

181

142

182

class PGPEngine(object):

143

183

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

184

144

185

def __init__(self):

145

186

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

146

198

self.gnupgargs = ['--batch',

147

'--home', self.tempdir,

199

'--homedir', self.tempdir,

148

200

'--force-mdc',

149

'--quiet',

150

'--no-use-agent']

151

201

'--quiet']

202

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

203

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

204

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

205

152

206

def __enter__(self):

153

207

return self

154

208

155

209

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

156

210

self._cleanup()

157

211

return False

158

212

159

213

def __del__(self):

160

214

self._cleanup()

161

215

162

216

def _cleanup(self):

163

217

if self.tempdir is not None:

164

218

# Delete contents of tempdir

165

219

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

166

topdown = False):

220

topdown=False):

167

221

for filename in files:

168

222

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

169

223

for dirname in dirs:

171

225

# Remove tempdir

172

226

os.rmdir(self.tempdir)

173

227

self.tempdir = None

174

228

175

229

def password_encode(self, password):

176

230

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

177

231

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

182

236

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

183

237

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

184

238

return encoded

185

239

186

240

def encrypt(self, data, password):

187

241

passphrase = self.password_encode(password)

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

190

244

passfile.write(passphrase)

191

245

passfile.flush()

192

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

246

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

193

247

'--passphrase-file',

194

248

passfile.name]

195

249

+ self.gnupgargs,

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

200

254

if proc.returncode != 0:

201

255

raise PGPError(err)

202

256

return ciphertext

203

257

204

258

def decrypt(self, data, password):

205

259

passphrase = self.password_encode(password)

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

208

262

passfile.write(passphrase)

209

263

passfile.flush()

210

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

264

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

211

265

'--passphrase-file',

212

266

passfile.name]

213

267

+ self.gnupgargs,

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

219

272

if proc.returncode != 0:

220

273

raise PGPError(err)

221

274

return decrypted_plaintext

222

275

223

276

277

# Pretend that we have an Avahi module

278

class avahi(object):

279

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

280

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

224

303

class AvahiError(Exception):

225

304

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

226

305

self.value = value

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

306

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

307

**kwargs)

308

230

309

231

310

class AvahiServiceError(AvahiError):

232

311

pass

233

312

313

234

314

class AvahiGroupError(AvahiError):

235

315

pass

236

316

237

317

238

318

class AvahiService(object):

239

319

"""An Avahi (Zeroconf) service.

240

320

241

321

Attributes:

242

322

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

243

323

Used to optionally bind to the specified interface.

255

335

server: D-Bus Server

256

336

bus: dbus.SystemBus()

257

337

"""

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

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

263

350

self.interface = interface

264

351

self.name = name

265

352

self.type = servicetype

274

361

self.server = None

275

362

self.bus = bus

276

363

self.entry_group_state_changed_match = None

277

278

def rename(self):

364

365

def rename(self, remove=True):

279

366

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

280

367

if self.rename_count >= self.max_renames:

281

368

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

282

369

" after %i retries, exiting.",

283

370

self.rename_count)

284

371

raise AvahiServiceError("Too many renames")

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

287

375

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

288

376

self.name)

289

self.remove()

377

if remove:

378

self.remove()

290

379

try:

291

380

self.add()

292

381

except dbus.exceptions.DBusException as error:

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

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

298

391

def remove(self):

299

392

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

300

393

if self.entry_group_state_changed_match is not None:

302

395

self.entry_group_state_changed_match = None

303

396

if self.group is not None:

304

397

self.group.Reset()

305

398

306

399

def add(self):

307

400

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

308

401

self.remove()

325

418

dbus.UInt16(self.port),

326

419

avahi.string_array_to_txt_array(self.TXT))

327

420

self.group.Commit()

328

421

329

422

def entry_group_state_changed(self, state, error):

330

423

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

331

424

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

332

425

333

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

334

427

logger.debug("Zeroconf service established.")

335

428

elif state == avahi.ENTRY_GROUP_COLLISION:

337

430

self.rename()

338

431

elif state == avahi.ENTRY_GROUP_FAILURE:

339

432

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

340

unicode(error))

341

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

342

.format(error))

343

433

str(error))

434

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

435

344

436

def cleanup(self):

345

437

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

346

438

if self.group is not None:

351

443

pass

352

444

self.group = None

353

445

self.remove()

354

446

355

447

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

356

448

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

357

449

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

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"Zeroconf server failure" }

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

}

365

456

if state in bad_states:

366

457

if bad_states[state] is not None:

367

458

if error is None:

370

461

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

371

462

self.cleanup()

372

463

elif state == avahi.SERVER_RUNNING:

373

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)

374

476

else:

375

477

if error is None:

376

478

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

377

479

else:

378

480

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

379

481

380

482

def activate(self):

381

483

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

382

484

if self.server is None:

386

488

follow_name_owner_changes=True),

387

489

avahi.DBUS_INTERFACE_SERVER)

388

490

self.server.connect_to_signal("StateChanged",

389

self.server_state_changed)

491

self.server_state_changed)

390

492

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

391

493

392

494

393

495

class AvahiServiceToSyslog(AvahiService):

394

def rename(self):

496

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

395

497

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

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

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

401

502

return ret

402

503

403

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

404

817

class Client(object):

405

818

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

406

819

407

820

Attributes:

408

821

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

409

822

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

411

824

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

412

825

to see if the client lives.

413

826

'None' if no process is running.

414

checker_callback_tag: a gobject event source tag, or None

827

checker_callback_tag: a GLib event source tag, or None

415

828

checker_command: string; External command which is run to check

416

829

if client lives. %() expansions are done at

417

830

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

418

831

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

419

checker_initiator_tag: a gobject event source tag, or None

832

checker_initiator_tag: a GLib event source tag, or None

420

833

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

421

834

client_structure: Object describing what attributes a client has

422

835

and is used for storing the client at exit

423

836

current_checker_command: string; current running checker_command

424

disable_initiator_tag: a gobject event source tag, or None

837

disable_initiator_tag: a GLib event source tag, or None

425

838

enabled: bool()

426

839

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

427

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

428

843

host: string; available for use by the checker command

429

844

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

430

845

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

432

847

last_checker_status: integer between 0 and 255 reflecting exit

433

848

status of last checker. -1 reflects crashed

434

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

435

852

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

436

853

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

437

854

D-Bus identifiers

444

861

disabled, or None

445

862

server_settings: The server_settings dict from main()

446

863

"""

447

864

448

865

runtime_expansions = ("approval_delay", "approval_duration",

449

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

866

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

450

867

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

451

868

"last_approval_request", "last_checked_ok",

452

869

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

453

client_defaults = { "timeout": "PT5M",

454

"extended_timeout": "PT15M",

455

"interval": "PT2M",

456

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

457

"host": "",

458

"approval_delay": "PT0S",

459

"approval_duration": "PT1S",

460

"approved_by_default": "True",

461

"enabled": "True",

462

}

463

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

464

882

@staticmethod

465

883

def config_parser(config):

466

884

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

473

891

for client_name in config.sections():

474

892

section = dict(config.items(client_name))

475

893

client = settings[client_name] = {}

476

894

477

895

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

478

896

# Reformat values from string types to Python types

479

897

client["approved_by_default"] = config.getboolean(

480

898

client_name, "approved_by_default")

481

899

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

482

900

"enabled")

483

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

484

907

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

485

908

.replace(" ", ""))

486

909

if "secret" in section:

487

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

910

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

911

.encode("utf-8"),

912

"base64")

488

913

elif "secfile" in section:

489

914

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

490

915

(section["secfile"])),

505

930

client["last_approval_request"] = None

506

931

client["last_checked_ok"] = None

507

932

client["last_checker_status"] = -2

508

933

509

934

return settings

510

511

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

935

936

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

512

937

self.name = name

513

938

if server_settings is None:

514

939

server_settings = {}

516

941

# adding all client settings

517

942

for setting, value in settings.items():

518

943

setattr(self, setting, value)

519

944

520

945

if self.enabled:

521

946

if not hasattr(self, "last_enabled"):

522

947

self.last_enabled = datetime.datetime.utcnow()

526

951

else:

527

952

self.last_enabled = None

528

953

self.expires = None

529

954

530

955

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

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the fingerprint()

533

# function

956

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

534

957

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

535

958

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

536

959

datetime.datetime.utcnow())

537

960

538

961

# attributes specific for this server instance

539

962

self.checker = None

540

963

self.checker_initiator_tag = None

543

966

self.current_checker_command = None

544

967

self.approved = None

545

968

self.approvals_pending = 0

546

self.changedstate = (multiprocessing_manager

547

.Condition(multiprocessing_manager

548

.Lock()))

549

self.client_structure = [attr for attr in

550

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

551

973

if not attr.startswith("_")]

552

974

self.client_structure.append("client_structure")

553

554

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

555

lambda obj:

556

isinstance(obj,

557

property)):

975

976

for name, t in inspect.getmembers(

977

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

558

978

if not name.startswith("_"):

559

979

self.client_structure.append(name)

560

980

561

981

# Send notice to process children that client state has changed

562

982

def send_changedstate(self):

563

983

with self.changedstate:

564

984

self.changedstate.notify_all()

565

985

566

986

def enable(self):

567

987

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

568

988

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

573

993

self.last_enabled = datetime.datetime.utcnow()

574

994

self.init_checker()

575

995

self.send_changedstate()

576

996

577

997

def disable(self, quiet=True):

578

998

"""Disable this client."""

579

999

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

581

1001

if not quiet:

582

1002

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

583

1003

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

584

gobject.source_remove(self.disable_initiator_tag)

1004

GLib.source_remove(self.disable_initiator_tag)

585

1005

self.disable_initiator_tag = None

586

1006

self.expires = None

587

1007

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

588

gobject.source_remove(self.checker_initiator_tag)

1008

GLib.source_remove(self.checker_initiator_tag)

589

1009

self.checker_initiator_tag = None

590

1010

self.stop_checker()

591

1011

self.enabled = False

592

1012

if not quiet:

593

1013

self.send_changedstate()

594

# 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

595

1015

return False

596

1016

597

1017

def __del__(self):

598

1018

self.disable()

599

1019

600

1020

def init_checker(self):

601

1021

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

602

1022

# and every interval from then on.

603

1023

if self.checker_initiator_tag is not None:

604

gobject.source_remove(self.checker_initiator_tag)

605

self.checker_initiator_tag = (gobject.timeout_add

606

(int(self.interval

607

.total_seconds() * 1000),

608

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)

609

1028

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

610

1029

if self.disable_initiator_tag is not None:

611

gobject.source_remove(self.disable_initiator_tag)

612

self.disable_initiator_tag = (gobject.timeout_add

613

(int(self.timeout

614

.total_seconds() * 1000),

615

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)

616

1033

# Also start a new checker *right now*.

617

1034

self.start_checker()

618

619

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

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

620

1038

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

621

1039

self.checker_callback_tag = None

622

1040

self.checker = None

623

if os.WIFEXITED(condition):

624

self.last_checker_status = os.WEXITSTATUS(condition)

1041

# Read return code from connection (see call_pipe)

1042

returncode = connection.recv()

1043

connection.close()

1044

1045

if returncode >= 0:

1046

self.last_checker_status = returncode

1047

self.last_checker_signal = None

625

1048

if self.last_checker_status == 0:

626

1049

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

627

1050

vars(self))

628

1051

self.checked_ok()

629

1052

else:

630

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

631

vars(self))

1053

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

632

1054

else:

633

1055

self.last_checker_status = -1

1056

self.last_checker_signal = -returncode

634

1057

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

635

1058

vars(self))

636

1059

return False

1060

637

1061

def checked_ok(self):

638

1062

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

639

1063

self.last_checked_ok = datetime.datetime.utcnow()

640

1064

self.last_checker_status = 0

1065

self.last_checker_signal = None

641

1066

self.bump_timeout()

642

1067

643

1068

def bump_timeout(self, timeout=None):

644

1069

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

645

1070

if timeout is None:

646

1071

timeout = self.timeout

647

1072

if self.disable_initiator_tag is not None:

648

gobject.source_remove(self.disable_initiator_tag)

1073

GLib.source_remove(self.disable_initiator_tag)

649

1074

self.disable_initiator_tag = None

650

1075

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

651

self.disable_initiator_tag = (gobject.timeout_add

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

1076

self.disable_initiator_tag = GLib.timeout_add(

1077

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

654

1078

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

655

1079

656

1080

def need_approval(self):

657

1081

self.last_approval_request = datetime.datetime.utcnow()

658

1082

659

1083

def start_checker(self):

660

1084

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

661

1085

662

1086

If a checker already exists, leave it running and do

663

1087

nothing."""

664

1088

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

669

1093

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

670

1094

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

671

1095

# should be.

672

673

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

674

try:

675

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

676

except AttributeError:

677

pass

678

except OSError as error:

679

if error.errno != errno.ECHILD:

680

raise

681

else:

682

if pid:

683

logger.warning("Checker was a zombie")

684

gobject.source_remove(self.checker_callback_tag)

685

self.checker_callback(pid, status,

686

self.current_checker_command)

1096

1097

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

1098

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

1099

self.checker.join()

1100

self.checker = None

687

1101

# Start a new checker if needed

688

1102

if self.checker is None:

689

1103

# Escape attributes for the shell

690

escaped_attrs = { attr:

691

re.escape(unicode(getattr(self,

692

attr)))

693

for attr in self.runtime_expansions }

1104

escaped_attrs = {

1105

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

1106

for attr in self.runtime_expansions}

694

1107

try:

695

1108

command = self.checker_command % escaped_attrs

696

1109

except TypeError as error:

697

1110

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

698

self.checker_command, exc_info=error)

699

return True # Try again later

1111

self.checker_command,

1112

exc_info=error)

1113

return True # Try again later

700

1114

self.current_checker_command = command

701

try:

702

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

703

command, self.name)

704

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

705

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

706

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

707

# always replaced by /dev/null.)

708

# The exception is when not debugging but nevertheless

709

# running in the foreground; use the previously

710

# created wnull.

711

popen_args = {}

712

if (not self.server_settings["debug"]

713

and self.server_settings["foreground"]):

714

popen_args.update({"stdout": wnull,

715

"stderr": wnull })

716

self.checker = subprocess.Popen(command,

717

close_fds=True,

718

shell=True, cwd="/",

719

**popen_args)

720

except OSError as error:

721

logger.error("Failed to start subprocess",

722

exc_info=error)

723

return True

724

self.checker_callback_tag = (gobject.child_watch_add

725

(self.checker.pid,

726

self.checker_callback,

727

data=command))

728

# The checker may have completed before the gobject

729

# watch was added. Check for this.

730

try:

731

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

732

except OSError as error:

733

if error.errno == errno.ECHILD:

734

# This should never happen

735

logger.error("Child process vanished",

736

exc_info=error)

737

return True

738

raise

739

if pid:

740

gobject.source_remove(self.checker_callback_tag)

741

self.checker_callback(pid, status, command)

742

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

1115

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

1116

self.name)

1117

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

1118

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

1119

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

1120

# always replaced by /dev/null.)

1121

# The exception is when not debugging but nevertheless

1122

# running in the foreground; use the previously

1123

# created wnull.

1124

popen_args = {"close_fds": True,

1125

"shell": True,

1126

"cwd": "/"}

1127

if (not self.server_settings["debug"]

1128

and self.server_settings["foreground"]):

1129

popen_args.update({"stdout": wnull,

1130

"stderr": wnull})

1131

pipe = multiprocessing.Pipe(duplex=False)

1132

self.checker = multiprocessing.Process(

1133

target=call_pipe,

1134

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

1135

kwargs=popen_args)

1136

self.checker.start()

1137

self.checker_callback_tag = GLib.io_add_watch(

1138

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

1139

self.checker_callback, pipe[0], command)

1140

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

743

1141

return True

744

1142

745

1143

def stop_checker(self):

746

1144

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

747

1145

if self.checker_callback_tag:

748

gobject.source_remove(self.checker_callback_tag)

1146

GLib.source_remove(self.checker_callback_tag)

749

1147

self.checker_callback_tag = None

750

1148

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

751

1149

return

752

1150

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

753

try:

754

self.checker.terminate()

755

#time.sleep(0.5)

756

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

757

# self.checker.kill()

758

except OSError as error:

759

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

760

raise

1151

self.checker.terminate()

761

1152

self.checker = None

762

1153

763

1154

764

def dbus_service_property(dbus_interface, signature="v",

765

access="readwrite", byte_arrays=False):

1155

def dbus_service_property(dbus_interface,

1156

signature="v",

1157

access="readwrite",

1158

byte_arrays=False):

766

1159

"""Decorators for marking methods of a DBusObjectWithProperties to

767

1160

become properties on the D-Bus.

768

1161

769

1162

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

770

1163

and with one argument by "Set".

771

1164

772

1165

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

773

1166

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

774

1167

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

778

1171

if byte_arrays and signature != "ay":

779

1172

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

780

1173

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

1174

781

1175

def decorator(func):

782

1176

func._dbus_is_property = True

783

1177

func._dbus_interface = dbus_interface

786

1180

func._dbus_name = func.__name__

787

1181

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

788

1182

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

789

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1183

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

790

1184

return func

1185

791

1186

return decorator

792

1187

793

1188

794

1189

def dbus_interface_annotations(dbus_interface):

795

1190

"""Decorator for marking functions returning interface annotations

796

1191

797

1192

Usage:

798

1193

799

1194

@dbus_interface_annotations("org.example.Interface")

800

1195

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

801

1196

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

802

1197

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

803

1198

"false"}

804

1199

"""

1200

805

1201

def decorator(func):

806

1202

func._dbus_is_interface = True

807

1203

func._dbus_interface = dbus_interface

808

1204

func._dbus_name = dbus_interface

809

1205

return func

1206

810

1207

return decorator

811

1208

812

1209

813

1210

def dbus_annotations(annotations):

814

1211

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

815

1212

Usage:

816

1213

1214

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

1215

"org.freedesktop.DBus.Property."

1216

"EmitsChangedSignal": "false"})

817

1217

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

818

1218

access="r")

819

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

820

"org.freedesktop.DBus.Property."

821

"EmitsChangedSignal": "false"})

822

1219

def Property_dbus_property(self):

823

1220

return dbus.Boolean(False)

1221

1222

See also the DBusObjectWithAnnotations class.

824

1223

"""

1224

825

1225

def decorator(func):

826

1226

func._dbus_annotations = annotations

827

1227

return func

1228

828

1229

return decorator

829

1230

830

1231

831

1232

class DBusPropertyException(dbus.exceptions.DBusException):

832

1233

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

833

1234

"""

834

def __unicode__(self):

835

return unicode(str(self))

1235

pass

836

1236

837

1237

838

1238

class DBusPropertyAccessException(DBusPropertyException):

847

1247

pass

848

1248

849

1249

850

class DBusObjectWithProperties(dbus.service.Object):

851

"""A D-Bus object with properties.

852

853

Classes inheriting from this can use the dbus_service_property

854

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

855

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

1250

class DBusObjectWithAnnotations(dbus.service.Object):

1251

"""A D-Bus object with annotations.

1252

1253

Classes inheriting from this can use the dbus_annotations

1254

decorator to add annotations to methods or signals.

856

1255

"""

857

1256

858

1257

@staticmethod

859

1258

def _is_dbus_thing(thing):

860

1259

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

861

1260

862

1261

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

863

1262

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

864

1263

"""

865

1264

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

866

1265

False)

867

1266

868

1267

def _get_all_dbus_things(self, thing):

869

1268

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

870

1269

"""

871

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

872

name),

1270

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

873

1271

athing.__get__(self))

874

1272

for cls in self.__class__.__mro__

875

1273

for name, athing in

876

inspect.getmembers(cls,

877

self._is_dbus_thing(thing)))

878

1274

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

1275

1276

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1277

out_signature="s",

1278

path_keyword='object_path',

1279

connection_keyword='connection')

1280

def Introspect(self, object_path, connection):

1281

"""Overloading of standard D-Bus method.

1282

1283

Inserts annotation tags on methods and signals.

1284

"""

1285

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

1286

connection)

1287

try:

1288

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

1289

1290

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

1291

# Add annotation tags

1292

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

1293

for tag in if_tag.getElementsByTagName(typ):

1294

annots = dict()

1295

for name, prop in (self.

1296

_get_all_dbus_things(typ)):

1297

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

1298

and prop._dbus_interface

1299

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

1300

annots.update(getattr(

1301

prop, "_dbus_annotations", {}))

1302

for name, value in annots.items():

1303

ann_tag = document.createElement(

1304

"annotation")

1305

ann_tag.setAttribute("name", name)

1306

ann_tag.setAttribute("value", value)

1307

tag.appendChild(ann_tag)

1308

# Add interface annotation tags

1309

for annotation, value in dict(

1310

itertools.chain.from_iterable(

1311

annotations().items()

1312

for name, annotations

1313

in self._get_all_dbus_things("interface")

1314

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

1315

)).items():

1316

ann_tag = document.createElement("annotation")

1317

ann_tag.setAttribute("name", annotation)

1318

ann_tag.setAttribute("value", value)

1319

if_tag.appendChild(ann_tag)

1320

# Fix argument name for the Introspect method itself

1321

if (if_tag.getAttribute("name")

1322

== dbus.INTROSPECTABLE_IFACE):

1323

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

1324

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

1325

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

1326

if (arg.getAttribute("direction")

1327

== "out"):

1328

arg.setAttribute("name",

1329

"xml_data")

1330

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

1331

document.unlink()

1332

except (AttributeError, xml.dom.DOMException,

1333

xml.parsers.expat.ExpatError) as error:

1334

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

1335

exc_info=error)

1336

return xmlstring

1337

1338

1339

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1340

"""A D-Bus object with properties.

1341

1342

Classes inheriting from this can use the dbus_service_property

1343

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

1344

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

1345

"""

1346

879

1347

def _get_dbus_property(self, interface_name, property_name):

880

1348

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

881

1349

property with the specified name and interface.

882

1350

"""

883

for cls in self.__class__.__mro__:

884

for name, value in (inspect.getmembers

885

(cls,

886

self._is_dbus_thing("property"))):

1351

for cls in self.__class__.__mro__:

1352

for name, value in inspect.getmembers(

1353

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

887

1354

if (value._dbus_name == property_name

888

1355

and value._dbus_interface == interface_name):

889

1356

return value.__get__(self)

890

1357

891

1358

# No such property

892

raise DBusPropertyNotFound(self.dbus_object_path + ":"

893

+ interface_name + "."

894

+ property_name)

895

896

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

1359

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

1360

self.dbus_object_path, interface_name, property_name))

1361

1362

@classmethod

1363

def _get_all_interface_names(cls):

1364

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

1365

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

1366

"_dbus_interface", None)

1367

for x in (inspect.getmro(cls))

1368

for attr in dir(x))

1369

if name is not None)

1370

1371

@dbus.service.method(dbus.PROPERTIES_IFACE,

1372

in_signature="ss",

897

1373

out_signature="v")

898

1374

def Get(self, interface_name, property_name):

899

1375

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

905

1381

if not hasattr(value, "variant_level"):

906

1382

return value

907

1383

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

908

1384

909

1385

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

910

1386

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

911

1387

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

923

1399

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

924

1400

for byte in value))

925

1401

prop(value)

926

927

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

1402

1403

@dbus.service.method(dbus.PROPERTIES_IFACE,

1404

in_signature="s",

928

1405

out_signature="a{sv}")

929

1406

def GetAll(self, interface_name):

930

1407

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

931

1408

standard.

932

1409

933

1410

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

934

1411

"""

935

1412

properties = {}

945

1422

if not hasattr(value, "variant_level"):

946

1423

properties[name] = value

947

1424

continue

948

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

949

value.variant_level+1)

1425

properties[name] = type(value)(

1426

value, variant_level=value.variant_level + 1)

950

1427

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

951

1428

1429

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

1430

def PropertiesChanged(self, interface_name, changed_properties,

1431

invalidated_properties):

1432

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

1433

standard.

1434

"""

1435

pass

1436

952

1437

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

953

1438

out_signature="s",

954

1439

path_keyword='object_path',

955

1440

connection_keyword='connection')

956

1441

def Introspect(self, object_path, connection):

957

1442

"""Overloading of standard D-Bus method.

958

1443

959

1444

Inserts property tags and interface annotation tags.

960

1445

"""

961

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

962

connection)

1446

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1447

object_path,

1448

connection)

963

1449

try:

964

1450

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

1451

965

1452

def make_tag(document, name, prop):

966

1453

e = document.createElement("property")

967

1454

e.setAttribute("name", name)

968

1455

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

969

1456

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

970

1457

return e

1458

971

1459

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

972

1460

# Add property tags

973

1461

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

976

1464

if prop._dbus_interface

977

1465

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

978

1466

if_tag.appendChild(tag)

979

# Add annotation tags

980

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

981

for tag in if_tag.getElementsByTagName(typ):

982

annots = dict()

983

for name, prop in (self.

984

_get_all_dbus_things(typ)):

985

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

986

and prop._dbus_interface

987

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

988

annots.update(getattr

989

(prop,

990

"_dbus_annotations",

991

{}))

992

for name, value in annots.items():

993

ann_tag = document.createElement(

994

"annotation")

995

ann_tag.setAttribute("name", name)

996

ann_tag.setAttribute("value", value)

997

tag.appendChild(ann_tag)

998

# Add interface annotation tags

999

for annotation, value in dict(

1000

itertools.chain.from_iterable(

1001

annotations().items()

1002

for name, annotations in

1003

self._get_all_dbus_things("interface")

1004

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

1005

)).items():

1006

ann_tag = document.createElement("annotation")

1007

ann_tag.setAttribute("name", annotation)

1008

ann_tag.setAttribute("value", value)

1009

if_tag.appendChild(ann_tag)

1467

# Add annotation tags for properties

1468

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

1469

annots = dict()

1470

for name, prop in self._get_all_dbus_things(

1471

"property"):

1472

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

1473

and prop._dbus_interface

1474

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

1475

annots.update(getattr(

1476

prop, "_dbus_annotations", {}))

1477

for name, value in annots.items():

1478

ann_tag = document.createElement(

1479

"annotation")

1480

ann_tag.setAttribute("name", name)

1481

ann_tag.setAttribute("value", value)

1482

tag.appendChild(ann_tag)

1010

1483

# Add the names to the return values for the

1011

1484

# "org.freedesktop.DBus.Properties" methods

1012

1485

if (if_tag.getAttribute("name")

1031

1504

return xmlstring

1032

1505

1033

1506

1507

try:

1508

dbus.OBJECT_MANAGER_IFACE

1509

except AttributeError:

1510

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

1511

1512

1513

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1514

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

1515

1516

Classes inheriting from this exposes the standard

1517

GetManagedObjects call and the InterfacesAdded and

1518

InterfacesRemoved signals on the standard

1519

"org.freedesktop.DBus.ObjectManager" interface.

1520

1521

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

1522

manually.

1523

"""

1524

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1525

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

1526

def GetManagedObjects(self):

1527

"""This function must be overridden"""

1528

raise NotImplementedError()

1529

1530

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1531

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

1532

def InterfacesAdded(self, object_path, interfaces_and_properties):

1533

pass

1534

1535

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

1536

def InterfacesRemoved(self, object_path, interfaces):

1537

pass

1538

1539

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1540

out_signature="s",

1541

path_keyword='object_path',

1542

connection_keyword='connection')

1543

def Introspect(self, object_path, connection):

1544

"""Overloading of standard D-Bus method.

1545

1546

Override return argument name of GetManagedObjects to be

1547

"objpath_interfaces_and_properties"

1548

"""

1549

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1550

object_path,

1551

connection)

1552

try:

1553

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

1554

1555

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

1556

# Fix argument name for the GetManagedObjects method

1557

if (if_tag.getAttribute("name")

1558

== dbus.OBJECT_MANAGER_IFACE):

1559

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

1560

if (cn.getAttribute("name")

1561

== "GetManagedObjects"):

1562

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

1563

if (arg.getAttribute("direction")

1564

== "out"):

1565

arg.setAttribute(

1566

"name",

1567

"objpath_interfaces"

1568

"_and_properties")

1569

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

1570

document.unlink()

1571

except (AttributeError, xml.dom.DOMException,

1572

xml.parsers.expat.ExpatError) as error:

1573

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

1574

exc_info=error)

1575

return xmlstring

1576

1577

1034

1578

def datetime_to_dbus(dt, variant_level=0):

1035

1579

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

1036

1580

if dt is None:

1037

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

1038

return dbus.String(dt.isoformat(),

1039

variant_level=variant_level)

1581

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

1582

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

1040

1583

1041

1584

1042

1585

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1044

1587

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

1045

1588

interface names according to the "alt_interface_names" mapping.

1046

1589

Usage:

1047

1590

1048

1591

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

1049

1592

"net.example.AlternateInterface"})

1050

1593

class SampleDBusObject(dbus.service.Object):

1051

1594

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

1052

1595

def SampleDBusMethod():

1053

1596

pass

1054

1597

1055

1598

The above "SampleDBusMethod" on "SampleDBusObject" will be

1056

1599

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

1057

1600

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

1058

1601

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

1059

1602

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

1060

1603

1061

1604

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

1062

1605

(from DBusObjectWithProperties) and interfaces (from the

1063

1606

dbus_interface_annotations decorator).

1064

1607

"""

1608

1065

1609

def wrapper(cls):

1066

1610

for orig_interface_name, alt_interface_name in (

1067

alt_interface_names.items()):

1611

alt_interface_names.items()):

1068

1612

attr = {}

1069

1613

interface_names = set()

1070

1614

# Go though all attributes of the class

1072

1616

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

1073

1617

# with the wrong interface name

1074

1618

if (not hasattr(attribute, "_dbus_interface")

1075

or not attribute._dbus_interface

1076

.startswith(orig_interface_name)):

1619

or not attribute._dbus_interface.startswith(

1620

orig_interface_name)):

1077

1621

continue

1078

1622

# Create an alternate D-Bus interface name based on

1079

1623

# the current name

1080

alt_interface = (attribute._dbus_interface

1081

.replace(orig_interface_name,

1082

alt_interface_name))

1624

alt_interface = attribute._dbus_interface.replace(

1625

orig_interface_name, alt_interface_name)

1083

1626

interface_names.add(alt_interface)

1084

1627

# Is this a D-Bus signal?

1085

1628

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

1086

1629

# Extract the original non-method undecorated

1087

1630

# function by black magic

1088

nonmethod_func = (dict(

1631

if sys.version_info.major == 2:

1632

nonmethod_func = (dict(

1089

1633

zip(attribute.func_code.co_freevars,

1090

attribute.__closure__))["func"]

1091

.cell_contents)

1634

attribute.__closure__))

1635

["func"].cell_contents)

1636

else:

1637

nonmethod_func = (dict(

1638

zip(attribute.__code__.co_freevars,

1639

attribute.__closure__))

1640

["func"].cell_contents)

1092

1641

# Create a new, but exactly alike, function

1093

1642

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

1094

1643

# with the alternate D-Bus interface name

1095

new_function = (dbus.service.signal

1096

(alt_interface,

1097

attribute._dbus_signature)

1098

(types.FunctionType(

1099

nonmethod_func.func_code,

1100

nonmethod_func.func_globals,

1101

nonmethod_func.func_name,

1102

nonmethod_func.func_defaults,

1103

nonmethod_func.func_closure)))

1644

new_function = copy_function(nonmethod_func)

1645

new_function = (dbus.service.signal(

1646

alt_interface,

1647

attribute._dbus_signature)(new_function))

1104

1648

# Copy annotations, if any

1105

1649

try:

1106

new_function._dbus_annotations = (

1107

dict(attribute._dbus_annotations))

1650

new_function._dbus_annotations = dict(

1651

attribute._dbus_annotations)

1108

1652

except AttributeError:

1109

1653

pass

1654

1110

1655

# Define a creator of a function to call both the

1111

1656

# original and alternate functions, so both the

1112

1657

# original and alternate signals gets sent when

1115

1660

"""This function is a scope container to pass

1116

1661

func1 and func2 to the "call_both" function

1117

1662

outside of its arguments"""

1663

1664

@functools.wraps(func2)

1118

1665

def call_both(*args, **kwargs):

1119

1666

"""This function will emit two D-Bus

1120

1667

signals by calling func1 and func2"""

1121

1668

func1(*args, **kwargs)

1122

1669

func2(*args, **kwargs)

1670

# Make wrapper function look like a D-Bus

1671

# signal

1672

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

1673

if name.startswith("_dbus_"):

1674

setattr(call_both, name, attr)

1675

1123

1676

return call_both

1124

1677

# Create the "call_both" function and add it to

1125

1678

# the class

1130

1683

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

1131

1684

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

1132

1685

# to the class.

1133

attr[attrname] = (dbus.service.method

1134

(alt_interface,

1135

attribute._dbus_in_signature,

1136

attribute._dbus_out_signature)

1137

(types.FunctionType

1138

(attribute.func_code,

1139

attribute.func_globals,

1140

attribute.func_name,

1141

attribute.func_defaults,

1142

attribute.func_closure)))

1686

attr[attrname] = (

1687

dbus.service.method(

1688

alt_interface,

1689

attribute._dbus_in_signature,

1690

attribute._dbus_out_signature)

1691

(copy_function(attribute)))

1143

1692

# Copy annotations, if any

1144

1693

try:

1145

attr[attrname]._dbus_annotations = (

1146

dict(attribute._dbus_annotations))

1694

attr[attrname]._dbus_annotations = dict(

1695

attribute._dbus_annotations)

1147

1696

except AttributeError:

1148

1697

pass

1149

1698

# Is this a D-Bus property?

1152

1701

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

1153

1702

# property with the alternate D-Bus interface

1154

1703

# name. Add it to the class.

1155

attr[attrname] = (dbus_service_property

1156

(alt_interface,

1157

attribute._dbus_signature,

1158

attribute._dbus_access,

1159

attribute

1160

._dbus_get_args_options

1161

["byte_arrays"])

1162

(types.FunctionType

1163

(attribute.func_code,

1164

attribute.func_globals,

1165

attribute.func_name,

1166

attribute.func_defaults,

1167

attribute.func_closure)))

1704

attr[attrname] = (dbus_service_property(

1705

alt_interface, attribute._dbus_signature,

1706

attribute._dbus_access,

1707

attribute._dbus_get_args_options

1708

["byte_arrays"])

1709

(copy_function(attribute)))

1168

1710

# Copy annotations, if any

1169

1711

try:

1170

attr[attrname]._dbus_annotations = (

1171

dict(attribute._dbus_annotations))

1712

attr[attrname]._dbus_annotations = dict(

1713

attribute._dbus_annotations)

1172

1714

except AttributeError:

1173

1715

pass

1174

1716

# Is this a D-Bus interface?

1177

1719

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

1178

1720

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

1179

1721

# to the class.

1180

attr[attrname] = (dbus_interface_annotations

1181

(alt_interface)

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

attribute.func_closure)))

1722

attr[attrname] = (

1723

dbus_interface_annotations(alt_interface)

1724

(copy_function(attribute)))

1188

1725

if deprecate:

1189

1726

# Deprecate all alternate interfaces

1190

iname="_AlternateDBusNames_interface_annotation{}"

1727

iname = "_AlternateDBusNames_interface_annotation{}"

1191

1728

for interface_name in interface_names:

1729

1192

1730

@dbus_interface_annotations(interface_name)

1193

1731

def func(self):

1194

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

1195

"true" }

1732

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

1733

"true"}

1196

1734

# Find an unused name

1197

1735

for aname in (iname.format(i)

1198

1736

for i in itertools.count()):

1202

1740

if interface_names:

1203

1741

# Replace the class with a new subclass of it with

1204

1742

# methods, signals, etc. as created above.

1205

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

1206

(cls,), attr)

1743

if sys.version_info.major == 2:

1744

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

1745

(cls, ), attr)

1746

else:

1747

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

1748

(cls, ), attr)

1207

1749

return cls

1750

1208

1751

return wrapper

1209

1752

1210

1753

1211

1754

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

1212

"se.bsnet.fukt.Mandos"})

1755

"se.bsnet.fukt.Mandos"})

1213

1756

class ClientDBus(Client, DBusObjectWithProperties):

1214

1757

"""A Client class using D-Bus

1215

1758

1216

1759

Attributes:

1217

1760

dbus_object_path: dbus.ObjectPath

1218

1761

bus: dbus.SystemBus()

1219

1762

"""

1220

1763

1221

1764

runtime_expansions = (Client.runtime_expansions

1222

+ ("dbus_object_path",))

1223

1765

+ ("dbus_object_path", ))

1766

1767

_interface = "se.recompile.Mandos.Client"

1768

1224

1769

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

1225

1226

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

1770

1771

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

1227

1772

self.bus = bus

1228

1773

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

1229

1774

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

1230

1775

# the D-Bus

1231

client_object_name = unicode(self.name).translate(

1776

client_object_name = str(self.name).translate(

1232

1777

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

1233

1778

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

1234

self.dbus_object_path = (dbus.ObjectPath

1235

("/clients/" + client_object_name))

1779

self.dbus_object_path = dbus.ObjectPath(

1780

"/clients/" + client_object_name)

1236

1781

DBusObjectWithProperties.__init__(self, self.bus,

1237

1782

self.dbus_object_path)

1238

1239

def notifychangeproperty(transform_func,

1240

dbus_name, type_func=lambda x: x,

1241

variant_level=1):

1783

1784

def notifychangeproperty(transform_func, dbus_name,

1785

type_func=lambda x: x,

1786

variant_level=1,

1787

invalidate_only=False,

1788

_interface=_interface):

1242

1789

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

1243

1790

its changes to DBus.

1244

1791

1245

1792

transform_fun: Function that takes a value and a variant_level

1246

1793

and transforms it to a D-Bus type.

1247

1794

dbus_name: D-Bus name of the variable

1250

1797

variant_level: D-Bus variant level. Default: 1

1251

1798

"""

1252

1799

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

1800

1253

1801

def setter(self, value):

1254

1802

if hasattr(self, "dbus_object_path"):

1255

1803

if (not hasattr(self, attrname) or

1256

1804

type_func(getattr(self, attrname, None))

1257

1805

!= type_func(value)):

1258

dbus_value = transform_func(type_func(value),

1259

variant_level

1260

=variant_level)

1261

self.PropertyChanged(dbus.String(dbus_name),

1262

dbus_value)

1806

if invalidate_only:

1807

self.PropertiesChanged(

1808

_interface, dbus.Dictionary(),

1809

dbus.Array((dbus_name, )))

1810

else:

1811

dbus_value = transform_func(

1812

type_func(value),

1813

variant_level=variant_level)

1814

self.PropertyChanged(dbus.String(dbus_name),

1815

dbus_value)

1816

self.PropertiesChanged(

1817

_interface,

1818

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

1819

dbus_value}),

1820

dbus.Array())

1263

1821

setattr(self, attrname, value)

1264

1822

1265

1823

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

1266

1824

1267

1825

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1268

1826

approvals_pending = notifychangeproperty(dbus.Boolean,

1269

1827

"ApprovalPending",

1270

type_func = bool)

1828

type_func=bool)

1271

1829

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

1272

1830

last_enabled = notifychangeproperty(datetime_to_dbus,

1273

1831

"LastEnabled")

1274

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

1275

type_func = lambda checker:

1276

checker is not None)

1832

checker = notifychangeproperty(

1833

dbus.Boolean, "CheckerRunning",

1834

type_func=lambda checker: checker is not None)

1277

1835

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1278

1836

"LastCheckedOK")

1279

1837

last_checker_status = notifychangeproperty(dbus.Int16,

1282

1840

datetime_to_dbus, "LastApprovalRequest")

1283

1841

approved_by_default = notifychangeproperty(dbus.Boolean,

1284

1842

"ApprovedByDefault")

1285

approval_delay = notifychangeproperty(dbus.UInt64,

1286

"ApprovalDelay",

1287

type_func =

1288

lambda td: td.total_seconds()

1289

* 1000)

1843

approval_delay = notifychangeproperty(

1844

dbus.UInt64, "ApprovalDelay",

1845

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

1290

1846

approval_duration = notifychangeproperty(

1291

1847

dbus.UInt64, "ApprovalDuration",

1292

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

1848

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

1293

1849

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

1294

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

1295

type_func = lambda td:

1296

td.total_seconds() * 1000)

1850

timeout = notifychangeproperty(

1851

dbus.UInt64, "Timeout",

1852

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

1297

1853

extended_timeout = notifychangeproperty(

1298

1854

dbus.UInt64, "ExtendedTimeout",

1299

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

1300

interval = notifychangeproperty(dbus.UInt64,

1301

"Interval",

1302

type_func =

1303

lambda td: td.total_seconds()

1304

* 1000)

1855

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

1856

interval = notifychangeproperty(

1857

dbus.UInt64, "Interval",

1858

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

1305

1859

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

1306

1860

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

1861

invalidate_only=True)

1862

1307

1863

del notifychangeproperty

1308

1864

1309

1865

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

1310

1866

try:

1311

1867

self.remove_from_connection()

1314

1870

if hasattr(DBusObjectWithProperties, "__del__"):

1315

1871

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

1316

1872

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

1317

1318

def checker_callback(self, pid, condition, command,

1319

*args, **kwargs):

1320

self.checker_callback_tag = None

1321

self.checker = None

1322

if os.WIFEXITED(condition):

1323

exitstatus = os.WEXITSTATUS(condition)

1873

1874

def checker_callback(self, source, condition,

1875

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

1876

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

1877

connection, command, *args,

1878

**kwargs)

1879

exitstatus = self.last_checker_status

1880

if exitstatus >= 0:

1324

1881

# Emit D-Bus signal

1325

1882

self.CheckerCompleted(dbus.Int16(exitstatus),

1326

dbus.Int64(condition),

1883

# This is specific to GNU libC

1884

dbus.Int64(exitstatus << 8),

1327

1885

dbus.String(command))

1328

1886

else:

1329

1887

# Emit D-Bus signal

1330

1888

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

1331

dbus.Int64(condition),

1889

dbus.Int64(

1890

# This is specific to GNU libC

1891

(exitstatus << 8)

1892

| self.last_checker_signal),

1332

1893

dbus.String(command))

1333

1334

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

1335

*args, **kwargs)

1336

1894

return ret

1895

1337

1896

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

1338

1897

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

1339

1898

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

1343

1902

# Emit D-Bus signal

1344

1903

self.CheckerStarted(self.current_checker_command)

1345

1904

return r

1346

1905

1347

1906

def _reset_approved(self):

1348

1907

self.approved = None

1349

1908

return False

1350

1909

1351

1910

def approve(self, value=True):

1352

1911

self.approved = value

1353

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

1354

* 1000), self._reset_approved)

1912

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

1913

* 1000), self._reset_approved)

1355

1914

self.send_changedstate()

1356

1357

## D-Bus methods, signals & properties

1358

_interface = "se.recompile.Mandos.Client"

1359

1360

## Interfaces

1361

1362

@dbus_interface_annotations(_interface)

1363

def _foo(self):

1364

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

1365

"false"}

1366

1367

## Signals

1368

1915

1916

# D-Bus methods, signals & properties

1917

1918

# Interfaces

1919

1920

# Signals

1921

1369

1922

# CheckerCompleted - signal

1370

1923

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

1371

1924

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

1372

1925

"D-Bus signal"

1373

1926

pass

1374

1927

1375

1928

# CheckerStarted - signal

1376

1929

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

1377

1930

def CheckerStarted(self, command):

1378

1931

"D-Bus signal"

1379

1932

pass

1380

1933

1381

1934

# PropertyChanged - signal

1935

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

1382

1936

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

1383

1937

def PropertyChanged(self, property, value):

1384

1938

"D-Bus signal"

1385

1939

pass

1386

1940

1387

1941

# GotSecret - signal

1388

1942

@dbus.service.signal(_interface)

1389

1943

def GotSecret(self):

1392

1946

server to mandos-client

1393

1947

"""

1394

1948

pass

1395

1949

1396

1950

# Rejected - signal

1397

1951

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

1398

1952

def Rejected(self, reason):

1399

1953

"D-Bus signal"

1400

1954

pass

1401

1955

1402

1956

# NeedApproval - signal

1403

1957

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

1404

1958

def NeedApproval(self, timeout, default):

1405

1959

"D-Bus signal"

1406

1960

return self.need_approval()

1407

1408

## Methods

1409

1961

1962

# Methods

1963

1410

1964

# Approve - method

1411

1965

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

1412

1966

def Approve(self, value):

1413

1967

self.approve(value)

1414

1968

1415

1969

# CheckedOK - method

1416

1970

@dbus.service.method(_interface)

1417

1971

def CheckedOK(self):

1418

1972

self.checked_ok()

1419

1973

1420

1974

# Enable - method

1975

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

1421

1976

@dbus.service.method(_interface)

1422

1977

def Enable(self):

1423

1978

"D-Bus method"

1424

1979

self.enable()

1425

1980

1426

1981

# StartChecker - method

1982

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

1427

1983

@dbus.service.method(_interface)

1428

1984

def StartChecker(self):

1429

1985

"D-Bus method"

1430

1986

self.start_checker()

1431

1987

1432

1988

# Disable - method

1989

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

1433

1990

@dbus.service.method(_interface)

1434

1991

def Disable(self):

1435

1992

"D-Bus method"

1436

1993

self.disable()

1437

1994

1438

1995

# StopChecker - method

1996

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

1439

1997

@dbus.service.method(_interface)

1440

1998

def StopChecker(self):

1441

1999

self.stop_checker()

1442

1443

## Properties

1444

2000

2001

# Properties

2002

1445

2003

# ApprovalPending - property

1446

2004

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

1447

2005

def ApprovalPending_dbus_property(self):

1448

2006

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

1449

2007

1450

2008

# ApprovedByDefault - property

1451

@dbus_service_property(_interface, signature="b",

2009

@dbus_service_property(_interface,

2010

signature="b",

1452

2011

access="readwrite")

1453

2012

def ApprovedByDefault_dbus_property(self, value=None):

1454

2013

if value is None: # get

1455

2014

return dbus.Boolean(self.approved_by_default)

1456

2015

self.approved_by_default = bool(value)

1457

2016

1458

2017

# ApprovalDelay - property

1459

@dbus_service_property(_interface, signature="t",

2018

@dbus_service_property(_interface,

2019

signature="t",

1460

2020

access="readwrite")

1461

2021

def ApprovalDelay_dbus_property(self, value=None):

1462

2022

if value is None: # get

1463

2023

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

1464

2024

* 1000)

1465

2025

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

1466

2026

1467

2027

# ApprovalDuration - property

1468

@dbus_service_property(_interface, signature="t",

2028

@dbus_service_property(_interface,

2029

signature="t",

1469

2030

access="readwrite")

1470

2031

def ApprovalDuration_dbus_property(self, value=None):

1471

2032

if value is None: # get

1472

2033

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

1473

2034

* 1000)

1474

2035

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

1475

2036

1476

2037

# Name - property

2038

@dbus_annotations(

2039

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

1477

2040

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

1478

2041

def Name_dbus_property(self):

1479

2042

return dbus.String(self.name)

1480

2043

2044

# KeyID - property

2045

@dbus_annotations(

2046

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

2047

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

2048

def KeyID_dbus_property(self):

2049

return dbus.String(self.key_id)

2050

1481

2051

# Fingerprint - property

2052

@dbus_annotations(

2053

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

1482

2054

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

1483

2055

def Fingerprint_dbus_property(self):

1484

2056

return dbus.String(self.fingerprint)

1485

2057

1486

2058

# Host - property

1487

@dbus_service_property(_interface, signature="s",

2059

@dbus_service_property(_interface,

2060

signature="s",

1488

2061

access="readwrite")

1489

2062

def Host_dbus_property(self, value=None):

1490

2063

if value is None: # get

1491

2064

return dbus.String(self.host)

1492

self.host = unicode(value)

1493

2065

self.host = str(value)

2066

1494

2067

# Created - property

2068

@dbus_annotations(

2069

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

1495

2070

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

1496

2071

def Created_dbus_property(self):

1497

2072

return datetime_to_dbus(self.created)

1498

2073

1499

2074

# LastEnabled - property

1500

2075

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

1501

2076

def LastEnabled_dbus_property(self):

1502

2077

return datetime_to_dbus(self.last_enabled)

1503

2078

1504

2079

# Enabled - property

1505

@dbus_service_property(_interface, signature="b",

2080

@dbus_service_property(_interface,

2081

signature="b",

1506

2082

access="readwrite")

1507

2083

def Enabled_dbus_property(self, value=None):

1508

2084

if value is None: # get

1511

2087

self.enable()

1512

2088

else:

1513

2089

self.disable()

1514

2090

1515

2091

# LastCheckedOK - property

1516

@dbus_service_property(_interface, signature="s",

2092

@dbus_service_property(_interface,

2093

signature="s",

1517

2094

access="readwrite")

1518

2095

def LastCheckedOK_dbus_property(self, value=None):

1519

2096

if value is not None:

1520

2097

self.checked_ok()

1521

2098

return

1522

2099

return datetime_to_dbus(self.last_checked_ok)

1523

2100

1524

2101

# LastCheckerStatus - property

1525

@dbus_service_property(_interface, signature="n",

1526

access="read")

2102

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

1527

2103

def LastCheckerStatus_dbus_property(self):

1528

2104

return dbus.Int16(self.last_checker_status)

1529

2105

1530

2106

# Expires - property

1531

2107

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

1532

2108

def Expires_dbus_property(self):

1533

2109

return datetime_to_dbus(self.expires)

1534

2110

1535

2111

# LastApprovalRequest - property

1536

2112

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

1537

2113

def LastApprovalRequest_dbus_property(self):

1538

2114

return datetime_to_dbus(self.last_approval_request)

1539

2115

1540

2116

# Timeout - property

1541

@dbus_service_property(_interface, signature="t",

2117

@dbus_service_property(_interface,

2118

signature="t",

1542

2119

access="readwrite")

1543

2120

def Timeout_dbus_property(self, value=None):

1544

2121

if value is None: # get

1556

2133

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

1557

2134

is None):

1558

2135

return

1559

gobject.source_remove(self.disable_initiator_tag)

1560

self.disable_initiator_tag = (

1561

gobject.timeout_add(

1562

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

1563

* 1000), self.disable))

1564

2136

GLib.source_remove(self.disable_initiator_tag)

2137

self.disable_initiator_tag = GLib.timeout_add(

2138

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

2139

self.disable)

2140

1565

2141

# ExtendedTimeout - property

1566

@dbus_service_property(_interface, signature="t",

2142

@dbus_service_property(_interface,

2143

signature="t",

1567

2144

access="readwrite")

1568

2145

def ExtendedTimeout_dbus_property(self, value=None):

1569

2146

if value is None: # get

1570

2147

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

1571

2148

* 1000)

1572

2149

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

1573

2150

1574

2151

# Interval - property

1575

@dbus_service_property(_interface, signature="t",

2152

@dbus_service_property(_interface,

2153

signature="t",

1576

2154

access="readwrite")

1577

2155

def Interval_dbus_property(self, value=None):

1578

2156

if value is None: # get

1582

2160

return

1583

2161

if self.enabled:

1584

2162

# Reschedule checker run

1585

gobject.source_remove(self.checker_initiator_tag)

1586

self.checker_initiator_tag = (gobject.timeout_add

1587

(value, self.start_checker))

1588

self.start_checker() # Start one now, too

1589

2163

GLib.source_remove(self.checker_initiator_tag)

2164

self.checker_initiator_tag = GLib.timeout_add(

2165

value, self.start_checker)

2166

self.start_checker() # Start one now, too

2167

1590

2168

# Checker - property

1591

@dbus_service_property(_interface, signature="s",

2169

@dbus_service_property(_interface,

2170

signature="s",

1592

2171

access="readwrite")

1593

2172

def Checker_dbus_property(self, value=None):

1594

2173

if value is None: # get

1595

2174

return dbus.String(self.checker_command)

1596

self.checker_command = unicode(value)

1597

2175

self.checker_command = str(value)

2176

1598

2177

# CheckerRunning - property

1599

@dbus_service_property(_interface, signature="b",

2178

@dbus_service_property(_interface,

2179

signature="b",

1600

2180

access="readwrite")

1601

2181

def CheckerRunning_dbus_property(self, value=None):

1602

2182

if value is None: # get

1605

2185

self.start_checker()

1606

2186

else:

1607

2187

self.stop_checker()

1608

2188

1609

2189

# ObjectPath - property

2190

@dbus_annotations(

2191

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

2192

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

1610

2193

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

1611

2194

def ObjectPath_dbus_property(self):

1612

return self.dbus_object_path # is already a dbus.ObjectPath

1613

2195

return self.dbus_object_path # is already a dbus.ObjectPath

2196

1614

2197

# Secret = property

1615

@dbus_service_property(_interface, signature="ay",

1616

access="write", byte_arrays=True)

2198

@dbus_annotations(

2199

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

2200

"invalidates"})

2201

@dbus_service_property(_interface,

2202

signature="ay",

2203

access="write",

2204

byte_arrays=True)

1617

2205

def Secret_dbus_property(self, value):

1618

self.secret = str(value)

1619

2206

self.secret = bytes(value)

2207

1620

2208

del _interface

1621

2209

1622

2210

1623

2211

class ProxyClient(object):

1624

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

2212

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

1625

2213

self._pipe = child_pipe

1626

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

2214

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

1627

2215

if not self._pipe.recv():

1628

raise KeyError()

1629

2216

raise KeyError(key_id or fpr)

2217

1630

2218

def __getattribute__(self, name):

1631

2219

if name == '_pipe':

1632

2220

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

1635

2223

if data[0] == 'data':

1636

2224

return data[1]

1637

2225

if data[0] == 'function':

2226

1638

2227

def func(*args, **kwargs):

1639

2228

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

1640

2229

return self._pipe.recv()[1]

2230

1641

2231

return func

1642

2232

1643

2233

def __setattr__(self, name, value):

1644

2234

if name == '_pipe':

1645

2235

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

1648

2238

1649

2239

class ClientHandler(socketserver.BaseRequestHandler, object):

1650

2240

"""A class to handle client connections.

1651

2241

1652

2242

Instantiated once for each connection to handle it.

1653

2243

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

1654

2244

1655

2245

def handle(self):

1656

2246

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

1657

2247

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

1658

unicode(self.client_address))

2248

str(self.client_address))

1659

2249

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

1660

2250

self.server.child_pipe.fileno())

1661

1662

session = (gnutls.connection

1663

.ClientSession(self.request,

1664

gnutls.connection

1665

.X509Credentials()))

1666

1667

# Note: gnutls.connection.X509Credentials is really a

1668

# generic GnuTLS certificate credentials object so long as

1669

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

1670

# here despite using OpenPGP certificates.

1671

1672

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

1673

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

1674

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

1675

# "+DHE-DSS"))

2251

2252

session = gnutls.ClientSession(self.request)

2253

2254

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

2255

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

2256

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

2257

# "+DHE-DSS"))

1676

2258

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

1677

2259

priority = self.server.gnutls_priority

1678

2260

if priority is None:

1679

2261

priority = "NORMAL"

1680

(gnutls.library.functions

1681

.gnutls_priority_set_direct(session._c_object,

1682

priority, None))

1683

2262

gnutls.priority_set_direct(session._c_object,

2263

priority.encode("utf-8"),

2264

None)

2265

1684

2266

# Start communication using the Mandos protocol

1685

2267

# Get protocol number

1686

2268

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

1691

2273

except (ValueError, IndexError, RuntimeError) as error:

1692

2274

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

1693

2275

return

1694

2276

1695

2277

# Start GnuTLS connection

1696

2278

try:

1697

2279

session.handshake()

1698

except gnutls.errors.GNUTLSError as error:

2280

except gnutls.Error as error:

1699

2281

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

1700

2282

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

1701

2283

# established. Just abandon the request.

1702

2284

return

1703

2285

logger.debug("Handshake succeeded")

1704

2286

1705

2287

approval_required = False

1706

2288

try:

1707

try:

1708

fpr = self.fingerprint(self.peer_certificate

1709

(session))

1710

except (TypeError,

1711

gnutls.errors.GNUTLSError) as error:

1712

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

1713

return

1714

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

1715

1716

try:

1717

client = ProxyClient(child_pipe, fpr,

2289

if gnutls.has_rawpk:

2290

fpr = ""

2291

try:

2292

key_id = self.key_id(

2293

self.peer_certificate(session))

2294

except (TypeError, gnutls.Error) as error:

2295

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

2296

return

2297

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

2298

2299

else:

2300

key_id = ""

2301

try:

2302

fpr = self.fingerprint(

2303

self.peer_certificate(session))

2304

except (TypeError, gnutls.Error) as error:

2305

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

2306

return

2307

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

2308

2309

try:

2310

client = ProxyClient(child_pipe, key_id, fpr,

1718

2311

self.client_address)

1719

2312

except KeyError:

1720

2313

return

1721

2314

1722

2315

if client.approval_delay:

1723

2316

delay = client.approval_delay

1724

2317

client.approvals_pending += 1

1725

2318

approval_required = True

1726

2319

1727

2320

while True:

1728

2321

if not client.enabled:

1729

2322

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

1730

client.name)

2323

client.name)

1731

2324

if self.server.use_dbus:

1732

2325

# Emit D-Bus signal

1733

2326

client.Rejected("Disabled")

1734

2327

return

1735

2328

1736

2329

if client.approved or not client.approval_delay:

1737

#We are approved or approval is disabled

2330

# We are approved or approval is disabled

1738

2331

break

1739

2332

elif client.approved is None:

1740

2333

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

1751

2344

# Emit D-Bus signal

1752

2345

client.Rejected("Denied")

1753

2346

return

1754

1755

#wait until timeout or approved

2347

2348

# wait until timeout or approved

1756

2349

time = datetime.datetime.now()

1757

2350

client.changedstate.acquire()

1758

2351

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

1771

2364

break

1772

2365

else:

1773

2366

delay -= time2 - time

1774

1775

sent_size = 0

1776

while sent_size < len(client.secret):

1777

try:

1778

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

1779

except gnutls.errors.GNUTLSError as error:

1780

logger.warning("gnutls send failed",

1781

exc_info=error)

1782

return

1783

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

1784

sent, len(client.secret)

1785

- (sent_size + sent))

1786

sent_size += sent

1787

2367

2368

try:

2369

session.send(client.secret)

2370

except gnutls.Error as error:

2371

logger.warning("gnutls send failed",

2372

exc_info=error)

2373

return

2374

1788

2375

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

1789

2376

# bump the timeout using extended_timeout

1790

2377

client.bump_timeout(client.extended_timeout)

1791

2378

if self.server.use_dbus:

1792

2379

# Emit D-Bus signal

1793

2380

client.GotSecret()

1794

2381

1795

2382

finally:

1796

2383

if approval_required:

1797

2384

client.approvals_pending -= 1

1798

2385

try:

1799

2386

session.bye()

1800

except gnutls.errors.GNUTLSError as error:

2387

except gnutls.Error as error:

1801

2388

logger.warning("GnuTLS bye failed",

1802

2389

exc_info=error)

1803

2390

1804

2391

@staticmethod

1805

2392

def peer_certificate(session):

1806

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

1807

# If not an OpenPGP certificate...

1808

if (gnutls.library.functions

1809

.gnutls_certificate_type_get(session._c_object)

1810

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1811

# ...do the normal thing

1812

return session.peer_certificate

2393

"Return the peer's certificate as a bytestring"

2394

try:

2395

cert_type = gnutls.certificate_type_get2(session._c_object,

2396

gnutls.CTYPE_PEERS)

2397

except AttributeError:

2398

cert_type = gnutls.certificate_type_get(session._c_object)

2399

if gnutls.has_rawpk:

2400

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2401

else:

2402

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2403

# If not a valid certificate type...

2404

if cert_type not in valid_cert_types:

2405

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

2406

valid_cert_types)

2407

# ...return invalid data

2408

return b""

1813

2409

list_size = ctypes.c_uint(1)

1814

cert_list = (gnutls.library.functions

1815

.gnutls_certificate_get_peers

2410

cert_list = (gnutls.certificate_get_peers

1816

2411

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

1817

2412

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

1818

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

1819

" certificate")

2413

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

1820

2414

if list_size.value == 0:

1821

2415

return None

1822

2416

cert = cert_list[0]

1823

2417

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

1824

2418

2419

@staticmethod

2420

def key_id(certificate):

2421

"Convert a certificate bytestring to a hexdigit key ID"

2422

# New GnuTLS "datum" with the public key

2423

datum = gnutls.datum_t(

2424

ctypes.cast(ctypes.c_char_p(certificate),

2425

ctypes.POINTER(ctypes.c_ubyte)),

2426

ctypes.c_uint(len(certificate)))

2427

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

2428

# New empty GnuTLS certificate

2429

pubkey = gnutls.pubkey_t()

2430

gnutls.pubkey_init(ctypes.byref(pubkey))

2431

# Import the raw public key into the certificate

2432

gnutls.pubkey_import(pubkey,

2433

ctypes.byref(datum),

2434

gnutls.X509_FMT_DER)

2435

# New buffer for the key ID

2436

buf = ctypes.create_string_buffer(32)

2437

buf_len = ctypes.c_size_t(len(buf))

2438

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

2439

gnutls.pubkey_get_key_id(pubkey,

2440

gnutls.KEYID_USE_SHA256,

2441

ctypes.cast(ctypes.byref(buf),

2442

ctypes.POINTER(ctypes.c_ubyte)),

2443

ctypes.byref(buf_len))

2444

# Deinit the certificate

2445

gnutls.pubkey_deinit(pubkey)

2446

2447

# Convert the buffer to a Python bytestring

2448

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

2449

# Convert the bytestring to hexadecimal notation

2450

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

2451

return hex_key_id

2452

1825

2453

@staticmethod

1826

2454

def fingerprint(openpgp):

1827

2455

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1828

2456

# New GnuTLS "datum" with the OpenPGP public key

1829

datum = (gnutls.library.types

1830

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

1831

ctypes.POINTER

1832

(ctypes.c_ubyte)),

1833

ctypes.c_uint(len(openpgp))))

2457

datum = gnutls.datum_t(

2458

ctypes.cast(ctypes.c_char_p(openpgp),

2459

ctypes.POINTER(ctypes.c_ubyte)),

2460

ctypes.c_uint(len(openpgp)))

1834

2461

# New empty GnuTLS certificate

1835

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1836

(gnutls.library.functions

1837

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2462

crt = gnutls.openpgp_crt_t()

2463

gnutls.openpgp_crt_init(ctypes.byref(crt))

1838

2464

# Import the OpenPGP public key into the certificate

1839

(gnutls.library.functions

1840

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

1841

gnutls.library.constants

1842

.GNUTLS_OPENPGP_FMT_RAW))

2465

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

2466

gnutls.OPENPGP_FMT_RAW)

1843

2467

# Verify the self signature in the key

1844

2468

crtverify = ctypes.c_uint()

1845

(gnutls.library.functions

1846

.gnutls_openpgp_crt_verify_self(crt, 0,

1847

ctypes.byref(crtverify)))

2469

gnutls.openpgp_crt_verify_self(crt, 0,

2470

ctypes.byref(crtverify))

1848

2471

if crtverify.value != 0:

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1850

raise (gnutls.errors.CertificateSecurityError

1851

("Verify failed"))

2472

gnutls.openpgp_crt_deinit(crt)

2473

raise gnutls.CertificateSecurityError(code

2474

=crtverify.value)

1852

2475

# New buffer for the fingerprint

1853

2476

buf = ctypes.create_string_buffer(20)

1854

2477

buf_len = ctypes.c_size_t()

1855

2478

# Get the fingerprint from the certificate into the buffer

1856

(gnutls.library.functions

1857

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

1858

ctypes.byref(buf_len)))

2479

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

2480

ctypes.byref(buf_len))

1859

2481

# Deinit the certificate

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2482

gnutls.openpgp_crt_deinit(crt)

1861

2483

# Convert the buffer to a Python bytestring

1862

2484

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

1863

2485

# Convert the bytestring to hexadecimal notation

1867

2489

1868

2490

class MultiprocessingMixIn(object):

1869

2491

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

2492

1870

2493

def sub_process_main(self, request, address):

1871

2494

try:

1872

2495

self.finish_request(request, address)

1873

2496

except Exception:

1874

2497

self.handle_error(request, address)

1875

2498

self.close_request(request)

1876

2499

1877

2500

def process_request(self, request, address):

1878

2501

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

1879

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

1880

args = (request, address))

2502

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

2503

args=(request, address))

1881

2504

proc.start()

1882

2505

return proc

1883

2506

1884

2507

1885

2508

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1886

2509

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

2510

1887

2511

def process_request(self, request, client_address):

1888

2512

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

1889

2513

1890

2514

This function creates a new pipe in self.pipe

1891

2515

"""

1892

2516

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1893

2517

1894

2518

proc = MultiprocessingMixIn.process_request(self, request,

1895

2519

client_address)

1896

2520

self.child_pipe.close()

1897

2521

self.add_pipe(parent_pipe, proc)

1898

2522

1899

2523

def add_pipe(self, parent_pipe, proc):

1900

2524

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

1901

2525

raise NotImplementedError()

1904

2528

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1905

2529

socketserver.TCPServer, object):

1906

2530

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

1907

2531

1908

2532

Attributes:

1909

2533

enabled: Boolean; whether this server is activated yet

1910

2534

interface: None or a network interface name (string)

1911

2535

use_ipv6: Boolean; to use IPv6 or not

1912

2536

"""

2537

1913

2538

def __init__(self, server_address, RequestHandlerClass,

1914

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

2539

interface=None,

2540

use_ipv6=True,

2541

socketfd=None):

1915

2542

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

1916

2543

creating a new one with socket.socket().

1917

2544

"""

1923

2550

self.socketfd = socketfd

1924

2551

# Save the original socket.socket() function

1925

2552

self.socket_socket = socket.socket

2553

1926

2554

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

1927

#

2555

#

1928

2556

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

1929

2557

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

1930

2558

# patching socket.socket.)

1931

#

2559

#

1932

2560

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

1933

2561

@functools.wraps(socket.socket)

1934

2562

def socket_wrapper(*args, **kwargs):

1946

2574

# socket_wrapper(), if socketfd was set.

1947

2575

socketserver.TCPServer.__init__(self, server_address,

1948

2576

RequestHandlerClass)

1949

2577

1950

2578

def server_bind(self):

1951

2579

"""This overrides the normal server_bind() function

1952

2580

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

1953

2581

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

2582

global SO_BINDTODEVICE

1954

2583

if self.interface is not None:

1955

2584

if SO_BINDTODEVICE is None:

1956

logger.error("SO_BINDTODEVICE does not exist;"

1957

" cannot bind to interface %s",

1958

self.interface)

1959

else:

1960

try:

1961

self.socket.setsockopt(socket.SOL_SOCKET,

1962

SO_BINDTODEVICE,

1963

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

1964

except socket.error as error:

1965

if error.errno == errno.EPERM:

1966

logger.error("No permission to bind to"

1967

" interface %s", self.interface)

1968

elif error.errno == errno.ENOPROTOOPT:

1969

logger.error("SO_BINDTODEVICE not available;"

1970

" cannot bind to interface %s",

1971

self.interface)

1972

elif error.errno == errno.ENODEV:

1973

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

1974

" cannot bind", self.interface)

1975

else:

1976

raise

2585

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

2586

# common enough.

2587

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

2588

SO_BINDTODEVICE = 25

2589

try:

2590

self.socket.setsockopt(

2591

socket.SOL_SOCKET, SO_BINDTODEVICE,

2592

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

2593

except socket.error as error:

2594

if error.errno == errno.EPERM:

2595

logger.error("No permission to bind to"

2596

" interface %s", self.interface)

2597

elif error.errno == errno.ENOPROTOOPT:

2598

logger.error("SO_BINDTODEVICE not available;"

2599

" cannot bind to interface %s",

2600

self.interface)

2601

elif error.errno == errno.ENODEV:

2602

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

2603

" cannot bind", self.interface)

2604

else:

2605

raise

1977

2606

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

1978

2607

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

1979

2608

if not self.server_address[0]:

1980

2609

if self.address_family == socket.AF_INET6:

1981

any_address = "::" # in6addr_any

2610

any_address = "::" # in6addr_any

1982

2611

else:

1983

any_address = "0.0.0.0" # INADDR_ANY

2612

any_address = "0.0.0.0" # INADDR_ANY

1984

2613

self.server_address = (any_address,

1985

2614

self.server_address[1])

1986

2615

elif not self.server_address[1]:

1987

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

1988

0)

2616

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

1989

2617

# if self.interface:

1990

2618

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

1991

2619

# 0, # port

1997

2625

1998

2626

class MandosServer(IPv6_TCPServer):

1999

2627

"""Mandos server.

2000

2628

2001

2629

Attributes:

2002

2630

clients: set of Client objects

2003

2631

gnutls_priority GnuTLS priority string

2004

2632

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

2005

2006

Assumes a gobject.MainLoop event loop.

2633

2634

Assumes a GLib.MainLoop event loop.

2007

2635

"""

2636

2008

2637

def __init__(self, server_address, RequestHandlerClass,

2009

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

2010

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

2638

interface=None,

2639

use_ipv6=True,

2640

clients=None,

2641

gnutls_priority=None,

2642

use_dbus=True,

2643

socketfd=None):

2011

2644

self.enabled = False

2012

2645

self.clients = clients

2013

2646

if self.clients is None:

2016

2649

self.gnutls_priority = gnutls_priority

2017

2650

IPv6_TCPServer.__init__(self, server_address,

2018

2651

RequestHandlerClass,

2019

interface = interface,

2020

use_ipv6 = use_ipv6,

2021

socketfd = socketfd)

2652

interface=interface,

2653

use_ipv6=use_ipv6,

2654

socketfd=socketfd)

2655

2022

2656

def server_activate(self):

2023

2657

if self.enabled:

2024

2658

return socketserver.TCPServer.server_activate(self)

2025

2659

2026

2660

def enable(self):

2027

2661

self.enabled = True

2028

2662

2029

2663

def add_pipe(self, parent_pipe, proc):

2030

2664

# Call "handle_ipc" for both data and EOF events

2031

gobject.io_add_watch(parent_pipe.fileno(),

2032

gobject.IO_IN | gobject.IO_HUP,

2033

functools.partial(self.handle_ipc,

2034

parent_pipe =

2035

parent_pipe,

2036

proc = proc))

2037

2038

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

2039

proc = None, client_object=None):

2665

GLib.io_add_watch(

2666

parent_pipe.fileno(),

2667

GLib.IO_IN | GLib.IO_HUP,

2668

functools.partial(self.handle_ipc,

2669

parent_pipe=parent_pipe,

2670

proc=proc))

2671

2672

def handle_ipc(self, source, condition,

2673

parent_pipe=None,

2674

proc=None,

2675

client_object=None):

2040

2676

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

2041

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

2677

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

2042

2678

# Wait for other process to exit

2043

2679

proc.join()

2044

2680

return False

2045

2681

2046

2682

# Read a request from the child

2047

2683

request = parent_pipe.recv()

2048

2684

command = request[0]

2049

2685

2050

2686

if command == 'init':

2051

fpr = request[1]

2052

address = request[2]

2053

2054

for c in self.clients.itervalues():

2055

if c.fingerprint == fpr:

2687

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

2688

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

2689

address = request[3]

2690

2691

for c in self.clients.values():

2692

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2693

continue

2694

if key_id and c.key_id == key_id:

2695

client = c

2696

break

2697

if fpr and c.fingerprint == fpr:

2056

2698

client = c

2057

2699

break

2058

2700

else:

2059

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

2060

"dress: %s", fpr, address)

2701

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

2702

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

2061

2703

if self.use_dbus:

2062

2704

# Emit D-Bus signal

2063

mandos_dbus_service.ClientNotFound(fpr,

2705

mandos_dbus_service.ClientNotFound(key_id or fpr,

2064

2706

address[0])

2065

2707

parent_pipe.send(False)

2066

2708

return False

2067

2068

gobject.io_add_watch(parent_pipe.fileno(),

2069

gobject.IO_IN | gobject.IO_HUP,

2070

functools.partial(self.handle_ipc,

2071

parent_pipe =

2072

parent_pipe,

2073

proc = proc,

2074

client_object =

2075

client))

2709

2710

GLib.io_add_watch(

2711

parent_pipe.fileno(),

2712

GLib.IO_IN | GLib.IO_HUP,

2713

functools.partial(self.handle_ipc,

2714

parent_pipe=parent_pipe,

2715

proc=proc,

2716

client_object=client))

2076

2717

parent_pipe.send(True)

2077

2718

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

2078

2719

# same fileno

2081

2722

funcname = request[1]

2082

2723

args = request[2]

2083

2724

kwargs = request[3]

2084

2725

2085

2726

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

2086

2727

funcname)(*args,

2087

**kwargs)))

2088

2728

**kwargs)))

2729

2089

2730

if command == 'getattr':

2090

2731

attrname = request[1]

2091

if callable(client_object.__getattribute__(attrname)):

2092

parent_pipe.send(('function',))

2732

if isinstance(client_object.__getattribute__(attrname),

2733

collections.Callable):

2734

parent_pipe.send(('function', ))

2093

2735

else:

2094

parent_pipe.send(('data', client_object

2095

.__getattribute__(attrname)))

2096

2736

parent_pipe.send((

2737

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

2738

2097

2739

if command == 'setattr':

2098

2740

attrname = request[1]

2099

2741

value = request[2]

2100

2742

setattr(client_object, attrname, value)

2101

2743

2102

2744

return True

2103

2745

2104

2746

2105

2747

def rfc3339_duration_to_delta(duration):

2106

2748

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

2107

2749

2108

2750

>>> rfc3339_duration_to_delta("P7D")

2109

2751

datetime.timedelta(7)

2110

2752

>>> rfc3339_duration_to_delta("PT60S")

2120

2762

>>> rfc3339_duration_to_delta("P1DT3M20S")

2121

2763

datetime.timedelta(1, 200)

2122

2764

"""

2123

2765

2124

2766

# Parsing an RFC 3339 duration with regular expressions is not

2125

2767

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

2126

2768

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

2127

2769

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

2128

2770

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

2129

2771

# avoid excessive use of external libraries.

2130

2772

2131

2773

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

2132

Token = collections.namedtuple("Token",

2133

("regexp", # To match token; if

2134

# "value" is not None,

2135

# must have a "group"

2136

# containing digits

2137

"value", # datetime.timedelta or

2138

# None

2139

"followers")) # Tokens valid after

2140

# this token

2774

Token = collections.namedtuple("Token", (

2775

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

2776

# a "group" containing digits

2777

"value", # datetime.timedelta or None

2778

"followers")) # Tokens valid after this token

2141

2779

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

2142

2780

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

2143

2781

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

2144

2782

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

2145

2783

datetime.timedelta(seconds=1),

2146

frozenset((token_end,)))

2784

frozenset((token_end, )))

2147

2785

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

2148

2786

datetime.timedelta(minutes=1),

2149

2787

frozenset((token_second, token_end)))

2165

2803

frozenset((token_month, token_end)))

2166

2804

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

2167

2805

datetime.timedelta(weeks=1),

2168

frozenset((token_end,)))

2806

frozenset((token_end, )))

2169

2807

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

2170

2808

frozenset((token_year, token_month,

2171

2809

token_day, token_time,

2172

2810

token_week)))

2173

# Define starting values

2174

value = datetime.timedelta() # Value so far

2811

# Define starting values:

2812

# Value so far

2813

value = datetime.timedelta()

2175

2814

found_token = None

2176

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

2177

s = duration # String left to parse

2815

# Following valid tokens

2816

followers = frozenset((token_duration, ))

2817

# String left to parse

2818

s = duration

2178

2819

# Loop until end token is found

2179

2820

while found_token is not token_end:

2180

2821

# Search for any currently valid tokens

2196

2837

break

2197

2838

else:

2198

2839

# No currently valid tokens were found

2199

raise ValueError("Invalid RFC 3339 duration")

2840

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

2841

.format(duration))

2200

2842

# End token found

2201

2843

return value

2202

2844

2203

2845

2204

2846

def string_to_delta(interval):

2205

2847

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

2206

2848

2207

2849

>>> string_to_delta('7d')

2208

2850

datetime.timedelta(7)

2209

2851

>>> string_to_delta('60s')

2217

2859

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

2218

2860

datetime.timedelta(0, 330)

2219

2861

"""

2220

2862

2221

2863

try:

2222

2864

return rfc3339_duration_to_delta(interval)

2223

2865

except ValueError:

2224

2866

pass

2225

2867

2226

2868

timevalue = datetime.timedelta(0)

2227

2869

for s in interval.split():

2228

2870

try:

2229

suffix = unicode(s[-1])

2871

suffix = s[-1]

2230

2872

value = int(s[:-1])

2231

2873

if suffix == "d":

2232

2874

delta = datetime.timedelta(value)

2239

2881

elif suffix == "w":

2240

2882

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

2241

2883

else:

2242

raise ValueError("Unknown suffix {!r}"

2243

.format(suffix))

2884

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

2244

2885

except IndexError as e:

2245

2886

raise ValueError(*(e.args))

2246

2887

timevalue += delta

2247

2888

return timevalue

2248

2889

2249

2890

2250

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

2891

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

2251

2892

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

2252

2893

2253

2894

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

2254

2895

if os.fork():

2255

2896

sys.exit()

2262

2903

# Close all standard open file descriptors

2263

2904

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

2264

2905

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

2265

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

2906

raise OSError(errno.ENODEV,

2907

"{} not a character device"

2266

2908

.format(os.devnull))

2267

2909

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

2268

2910

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

2272

2914

2273

2915

2274

2916

def main():

2275

2917

2276

2918

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

2277

2919

# Parsing of options, both command line and config file

2278

2920

2279

2921

parser = argparse.ArgumentParser()

2280

2922

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

2281

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

2923

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

2282

2924

help="show version number and exit")

2283

2925

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

2284

2926

help="Bind to interface IF")

2320

2962

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

2321

2963

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

2322

2964

default=None)

2323

2965

2324

2966

options = parser.parse_args()

2325

2967

2326

2968

if options.check:

2327

2969

import doctest

2328

2970

fail_count, test_count = doctest.testmod()

2329

2971

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

2330

2972

2331

2973

# Default values for config file for server-global settings

2332

server_defaults = { "interface": "",

2333

"address": "",

2334

"port": "",

2335

"debug": "False",

2336

"priority":

2337

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

2338

"servicename": "Mandos",

2339

"use_dbus": "True",

2340

"use_ipv6": "True",

2341

"debuglevel": "",

2342

"restore": "True",

2343

"socket": "",

2344

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

2345

"foreground": "False",

2346

"zeroconf": "True",

2347

}

2348

2974

if gnutls.has_rawpk:

2975

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

2976

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

2977

else:

2978

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

2979

":+SIGN-DSA-SHA256")

2980

server_defaults = {"interface": "",

2981

"address": "",

2982

"port": "",

2983

"debug": "False",

2984

"priority": priority,

2985

"servicename": "Mandos",

2986

"use_dbus": "True",

2987

"use_ipv6": "True",

2988

"debuglevel": "",

2989

"restore": "True",

2990

"socket": "",

2991

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

2992

"foreground": "False",

2993

"zeroconf": "True",

2994

}

2995

del priority

2996

2349

2997

# Parse config file for server-global settings

2350

2998

server_config = configparser.SafeConfigParser(server_defaults)

2351

2999

del server_defaults

2352

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

2353

"mandos.conf"))

3000

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

2354

3001

# Convert the SafeConfigParser object to a dict

2355

3002

server_settings = server_config.defaults()

2356

3003

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

2357

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

3004

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

3005

"foreground", "zeroconf"):

2358

3006

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

2359

3007

option)

2360

3008

if server_settings["port"]:

2370

3018

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

2371

3019

["socket"])

2372

3020

del server_config

2373

3021

2374

3022

# Override the settings from the config file with command line

2375

3023

# options, if set.

2376

3024

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

2377

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

2378

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

2379

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

3025

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

3026

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

3027

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

2380

3028

value = getattr(options, option)

2381

3029

if value is not None:

2382

3030

server_settings[option] = value

2383

3031

del options

2384

3032

# Force all strings to be unicode

2385

3033

for option in server_settings.keys():

2386

if type(server_settings[option]) is str:

2387

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

3034

if isinstance(server_settings[option], bytes):

3035

server_settings[option] = (server_settings[option]

3036

.decode("utf-8"))

2388

3037

# Force all boolean options to be boolean

2389

3038

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

2390

3039

"foreground", "zeroconf"):

2393

3042

if server_settings["debug"]:

2394

3043

server_settings["foreground"] = True

2395

3044

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

2396

3045

2397

3046

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

2398

2399

if (not server_settings["zeroconf"] and

2400

not (server_settings["port"]

2401

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

2402

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

2403

" Zeroconf")

2404

3047

3048

if (not server_settings["zeroconf"]

3049

and not (server_settings["port"]

3050

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

3051

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

3052

2405

3053

# For convenience

2406

3054

debug = server_settings["debug"]

2407

3055

debuglevel = server_settings["debuglevel"]

2411

3059

stored_state_file)

2412

3060

foreground = server_settings["foreground"]

2413

3061

zeroconf = server_settings["zeroconf"]

2414

3062

2415

3063

if debug:

2416

3064

initlogger(debug, logging.DEBUG)

2417

3065

else:

2420

3068

else:

2421

3069

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

2422

3070

initlogger(debug, level)

2423

3071

2424

3072

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

2425

syslogger.setFormatter(logging.Formatter

2426

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

2427

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

2428

.format(server_settings

2429

["servicename"])))

2430

3073

syslogger.setFormatter(

3074

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

3075

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

3076

server_settings["servicename"])))

3077

2431

3078

# Parse config file with clients

2432

3079

client_config = configparser.SafeConfigParser(Client

2433

3080

.client_defaults)

2434

3081

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

2435

3082

"clients.conf"))

2436

3083

2437

3084

global mandos_dbus_service

2438

3085

mandos_dbus_service = None

2439

3086

2440

3087

socketfd = None

2441

3088

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

2442

3089

socketfd = server_settings["socket"]

2443

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

2444

server_settings["port"]),

2445

ClientHandler,

2446

interface=(server_settings["interface"]

2447

or None),

2448

use_ipv6=use_ipv6,

2449

gnutls_priority=

2450

server_settings["priority"],

2451

use_dbus=use_dbus,

2452

socketfd=socketfd)

3090

tcp_server = MandosServer(

3091

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

3092

ClientHandler,

3093

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

3094

use_ipv6=use_ipv6,

3095

gnutls_priority=server_settings["priority"],

3096

use_dbus=use_dbus,

3097

socketfd=socketfd)

2453

3098

if not foreground:

2454

3099

pidfilename = "/run/mandos.pid"

2455

3100

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

2456

3101

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

2457

3102

pidfile = None

2458

3103

try:

2459

pidfile = open(pidfilename, "w")

3104

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

2460

3105

except IOError as e:

2461

3106

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

2462

3107

exc_info=e)

2463

2464

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

3108

3109

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

3110

("mandos", "mandos"),

3111

("nobody", "nogroup")):

2465

3112

try:

2466

3113

uid = pwd.getpwnam(name).pw_uid

2467

gid = pwd.getpwnam(name).pw_gid

3114

gid = pwd.getpwnam(group).pw_gid

2468

3115

break

2469

3116

except KeyError:

2470

3117

continue

2474

3121

try:

2475

3122

os.setgid(gid)

2476

3123

os.setuid(uid)

3124

if debug:

3125

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

3126

gid))

2477

3127

except OSError as error:

3128

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

3129

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

2478

3130

if error.errno != errno.EPERM:

2479

3131

raise

2480

3132

2481

3133

if debug:

2482

3134

# Enable all possible GnuTLS debugging

2483

3135

2484

3136

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

2485

3137

# - GnuTLS manual

2486

gnutls.library.functions.gnutls_global_set_log_level(11)

2487

2488

@gnutls.library.types.gnutls_log_func

3138

gnutls.global_set_log_level(11)

3139

3140

@gnutls.log_func

2489

3141

def debug_gnutls(level, string):

2490

3142

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

2491

2492

(gnutls.library.functions

2493

.gnutls_global_set_log_function(debug_gnutls))

2494

3143

3144

gnutls.global_set_log_function(debug_gnutls)

3145

2495

3146

# Redirect stdin so all checkers get /dev/null

2496

3147

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

2497

3148

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

2498

3149

if null > 2:

2499

3150

os.close(null)

2500

3151

2501

3152

# Need to fork before connecting to D-Bus

2502

3153

if not foreground:

2503

3154

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

2504

3155

daemon()

2505

2506

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

2507

# need to inform gobject that threads will be used.

2508

gobject.threads_init()

2509

3156

3157

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

3158

# to inform GLib that threads will be used.

3159

GLib.threads_init()

3160

2510

3161

global main_loop

2511

3162

# From the Avahi example code

2512

3163

DBusGMainLoop(set_as_default=True)

2513

main_loop = gobject.MainLoop()

3164

main_loop = GLib.MainLoop()

2514

3165

bus = dbus.SystemBus()

2515

3166

# End of Avahi example code

2516

3167

if use_dbus:

2517

3168

try:

2518

3169

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

2519

bus, do_not_queue=True)

2520

old_bus_name = (dbus.service.BusName

2521

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

2522

do_not_queue=True))

2523

except dbus.exceptions.NameExistsException as e:

3170

bus,

3171

do_not_queue=True)

3172

old_bus_name = dbus.service.BusName(

3173

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

3174

do_not_queue=True)

3175

except dbus.exceptions.DBusException as e:

2524

3176

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

2525

3177

use_dbus = False

2526

3178

server_settings["use_dbus"] = False

2527

3179

tcp_server.use_dbus = False

2528

3180

if zeroconf:

2529

3181

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2530

service = AvahiServiceToSyslog(name =

2531

server_settings["servicename"],

2532

servicetype = "_mandos._tcp",

2533

protocol = protocol, bus = bus)

3182

service = AvahiServiceToSyslog(

3183

name=server_settings["servicename"],

3184

servicetype="_mandos._tcp",

3185

protocol=protocol,

3186

bus=bus)

2534

3187

if server_settings["interface"]:

2535

service.interface = (if_nametoindex

2536

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

2537

3188

service.interface = if_nametoindex(

3189

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

3190

2538

3191

global multiprocessing_manager

2539

3192

multiprocessing_manager = multiprocessing.Manager()

2540

3193

2541

3194

client_class = Client

2542

3195

if use_dbus:

2543

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

2544

3196

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

3197

2545

3198

client_settings = Client.config_parser(client_config)

2546

3199

old_client_settings = {}

2547

3200

clients_data = {}

2548

3201

2549

3202

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

2550

3203

global wnull

2551

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

3204

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

2552

3205

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

2553

3206

# mode

2554

3207

if debug or not foreground:

2555

3208

wnull.close()

2556

3209

2557

3210

# Get client data and settings from last running state.

2558

3211

if server_settings["restore"]:

2559

3212

try:

2560

3213

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

2561

clients_data, old_client_settings = (pickle.load

2562

(stored_state))

3214

if sys.version_info.major == 2:

3215

clients_data, old_client_settings = pickle.load(

3216

stored_state)

3217

else:

3218

bytes_clients_data, bytes_old_client_settings = (

3219

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

3220

# Fix bytes to strings

3221

# clients_data

3222

# .keys()

3223

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

3224

if isinstance(key, bytes)

3225

else key): value

3226

for key, value in

3227

bytes_clients_data.items()}

3228

del bytes_clients_data

3229

for key in clients_data:

3230

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

3231

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

3232

for k, v in

3233

clients_data[key].items()}

3234

clients_data[key] = value

3235

# .client_structure

3236

value["client_structure"] = [

3237

(s.decode("utf-8")

3238

if isinstance(s, bytes)

3239

else s) for s in

3240

value["client_structure"]]

3241

# .name & .host

3242

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

3243

if isinstance(value[k], bytes):

3244

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

3245

if not value.has_key("key_id"):

3246

value["key_id"] = ""

3247

elif not value.has_key("fingerprint"):

3248

value["fingerprint"] = ""

3249

# old_client_settings

3250

# .keys()

3251

old_client_settings = {

3252

(key.decode("utf-8")

3253

if isinstance(key, bytes)

3254

else key): value

3255

for key, value in

3256

bytes_old_client_settings.items()}

3257

del bytes_old_client_settings

3258

# .host

3259

for value in old_client_settings.values():

3260

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

3261

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

3262

.decode("utf-8"))

2563

3263

os.remove(stored_state_path)

2564

3264

except IOError as e:

2565

3265

if e.errno == errno.ENOENT:

2566

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

2567

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

3266

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

3267

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

2568

3268

else:

2569

3269

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

2570

3270

exc_info=e)

2571

3271

raise

2572

3272

except EOFError as e:

2573

3273

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

2574

"EOFError:", exc_info=e)

2575

3274

"EOFError:",

3275

exc_info=e)

3276

2576

3277

with PGPEngine() as pgp:

2577

3278

for client_name, client in clients_data.items():

2578

3279

# Skip removed clients

2579

3280

if client_name not in client_settings:

2580

3281

continue

2581

3282

2582

3283

# Decide which value to use after restoring saved state.

2583

3284

# We have three different values: Old config file,

2584

3285

# new config file, and saved state.

2589

3290

# For each value in new config, check if it

2590

3291

# differs from the old config value (Except for

2591

3292

# the "secret" attribute)

2592

if (name != "secret" and

2593

value != old_client_settings[client_name]

2594

[name]):

3293

if (name != "secret"

3294

and (value !=

3295

old_client_settings[client_name][name])):

2595

3296

client[name] = value

2596

3297

except KeyError:

2597

3298

pass

2598

3299

2599

3300

# Clients who has passed its expire date can still be

2600

# enabled if its last checker was successful. Clients

3301

# enabled if its last checker was successful. A Client

2601

3302

# whose checker succeeded before we stored its state is

2602

3303

# assumed to have successfully run all checkers during

2603

3304

# downtime.

2606

3307

if not client["last_checked_ok"]:

2607

3308

logger.warning(

2608

3309

"disabling client {} - Client never "

2609

"performed a successful checker"

2610

.format(client_name))

3310

"performed a successful checker".format(

3311

client_name))

2611

3312

client["enabled"] = False

2612

3313

elif client["last_checker_status"] != 0:

2613

3314

logger.warning(

2614

3315

"disabling client {} - Client last"

2615

" checker failed with error code {}"

2616

.format(client_name,

2617

client["last_checker_status"]))

3316

" checker failed with error code"

3317

" {}".format(

3318

client_name,

3319

client["last_checker_status"]))

2618

3320

client["enabled"] = False

2619

3321

else:

2620

client["expires"] = (datetime.datetime

2621

.utcnow()

2622

+ client["timeout"])

3322

client["expires"] = (

3323

datetime.datetime.utcnow()

3324

+ client["timeout"])

2623

3325

logger.debug("Last checker succeeded,"

2624

" keeping {} enabled"

2625

.format(client_name))

3326

" keeping {} enabled".format(

3327

client_name))

2626

3328

try:

2627

client["secret"] = (

2628

pgp.decrypt(client["encrypted_secret"],

2629

client_settings[client_name]

2630

["secret"]))

3329

client["secret"] = pgp.decrypt(

3330

client["encrypted_secret"],

3331

client_settings[client_name]["secret"])

2631

3332

except PGPError:

2632

3333

# If decryption fails, we use secret from new settings

2633

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

2634

.format(client_name))

2635

client["secret"] = (

2636

client_settings[client_name]["secret"])

2637

3334

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

3335

client_name))

3336

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

3337

["secret"])

3338

2638

3339

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

2639

3340

for client_name in (set(old_client_settings)

2640

3341

- set(client_settings)):

2642

3343

for client_name in (set(client_settings)

2643

3344

- set(old_client_settings)):

2644

3345

clients_data[client_name] = client_settings[client_name]

2645

3346

2646

3347

# Create all client objects

2647

3348

for client_name, client in clients_data.items():

2648

3349

tcp_server.clients[client_name] = client_class(

2649

name = client_name, settings = client,

2650

server_settings = server_settings)

2651

3350

name=client_name,

3351

settings=client,

3352

server_settings=server_settings)

3353

2652

3354

if not tcp_server.clients:

2653

3355

logger.warning("No clients defined")

2654

3356

2655

3357

if not foreground:

2656

3358

if pidfile is not None:

3359

pid = os.getpid()

2657

3360

try:

2658

3361

with pidfile:

2659

pid = os.getpid()

2660

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

3362

print(pid, file=pidfile)

2661

3363

except IOError:

2662

3364

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

2663

3365

pidfilename, pid)

2664

3366

del pidfile

2665

3367

del pidfilename

2666

2667

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

2668

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

2669

3368

3369

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

3370

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3371

lambda: main_loop.quit() and False)

3372

2670

3373

if use_dbus:

2671

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

2672

"se.bsnet.fukt.Mandos"})

2673

class MandosDBusService(DBusObjectWithProperties):

3374

3375

@alternate_dbus_interfaces(

3376

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

3377

class MandosDBusService(DBusObjectWithObjectManager):

2674

3378

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

3379

2675

3380

def __init__(self):

2676

3381

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

3382

2677

3383

_interface = "se.recompile.Mandos"

2678

2679

@dbus_interface_annotations(_interface)

2680

def _foo(self):

2681

return { "org.freedesktop.DBus.Property"

2682

".EmitsChangedSignal":

2683

"false"}

2684

3384

2685

3385

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

2686

3386

def ClientAdded(self, objpath):

2687

3387

"D-Bus signal"

2688

3388

pass

2689

3389

2690

3390

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

2691

def ClientNotFound(self, fingerprint, address):

3391

def ClientNotFound(self, key_id, address):

2692

3392

"D-Bus signal"

2693

3393

pass

2694

3394

3395

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

3396

"true"})

2695

3397

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

2696

3398

def ClientRemoved(self, objpath, name):

2697

3399

"D-Bus signal"

2698

3400

pass

2699

3401

3402

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

3403

"true"})

2700

3404

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

2701

3405

def GetAllClients(self):

2702

3406

"D-Bus method"

2703

return dbus.Array(c.dbus_object_path

2704

for c in

2705

tcp_server.clients.itervalues())

2706

3407

return dbus.Array(c.dbus_object_path for c in

3408

tcp_server.clients.values())

3409

3410

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

3411

"true"})

2707

3412

@dbus.service.method(_interface,

2708

3413

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

2709

3414

def GetAllClientsWithProperties(self):

2710

3415

"D-Bus method"

2711

3416

return dbus.Dictionary(

2712

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

2713

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

3417

{c.dbus_object_path: c.GetAll(

3418

"se.recompile.Mandos.Client")

3419

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

2714

3420

signature="oa{sv}")

2715

3421

2716

3422

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

2717

3423

def RemoveClient(self, object_path):

2718

3424

"D-Bus method"

2719

for c in tcp_server.clients.itervalues():

3425

for c in tcp_server.clients.values():

2720

3426

if c.dbus_object_path == object_path:

2721

3427

del tcp_server.clients[c.name]

2722

3428

c.remove_from_connection()

2723

# Don't signal anything except ClientRemoved

3429

# Don't signal the disabling

2724

3430

c.disable(quiet=True)

2725

# Emit D-Bus signal

2726

self.ClientRemoved(object_path, c.name)

3431

# Emit D-Bus signal for removal

3432

self.client_removed_signal(c)

2727

3433

return

2728

3434

raise KeyError(object_path)

2729

3435

2730

3436

del _interface

2731

3437

3438

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3439

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

3440

def GetManagedObjects(self):

3441

"""D-Bus method"""

3442

return dbus.Dictionary(

3443

{client.dbus_object_path:

3444

dbus.Dictionary(

3445

{interface: client.GetAll(interface)

3446

for interface in

3447

client._get_all_interface_names()})

3448

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

3449

3450

def client_added_signal(self, client):

3451

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

3452

if use_dbus:

3453

# New standard signal

3454

self.InterfacesAdded(

3455

client.dbus_object_path,

3456

dbus.Dictionary(

3457

{interface: client.GetAll(interface)

3458

for interface in

3459

client._get_all_interface_names()}))

3460

# Old signal

3461

self.ClientAdded(client.dbus_object_path)

3462

3463

def client_removed_signal(self, client):

3464

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

3465

if use_dbus:

3466

# New standard signal

3467

self.InterfacesRemoved(

3468

client.dbus_object_path,

3469

client._get_all_interface_names())

3470

# Old signal

3471

self.ClientRemoved(client.dbus_object_path,

3472

client.name)

3473

2732

3474

mandos_dbus_service = MandosDBusService()

2733

3475

3476

# Save modules to variables to exempt the modules from being

3477

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

3478

mp = multiprocessing

3479

wn = wnull

3480

2734

3481

def cleanup():

2735

3482

"Cleanup function; run on exit"

2736

3483

if zeroconf:

2737

3484

service.cleanup()

2738

2739

multiprocessing.active_children()

2740

wnull.close()

3485

3486

mp.active_children()

3487

wn.close()

2741

3488

if not (tcp_server.clients or client_settings):

2742

3489

return

2743

3490

2744

3491

# Store client before exiting. Secrets are encrypted with key

2745

3492

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

2746

3493

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

2747

3494

clients = {}

2748

3495

with PGPEngine() as pgp:

2749

for client in tcp_server.clients.itervalues():

3496

for client in tcp_server.clients.values():

2750

3497

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

2751

3498

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

2752

3499

key)

2753

3500

client_dict = {}

2754

3501

2755

3502

# A list of attributes that can not be pickled

2756

3503

# + secret.

2757

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

2758

"checker", "server_settings" }

2759

for name, typ in (inspect.getmembers

2760

(dbus.service.Object)):

3504

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

3505

"checker", "server_settings"}

3506

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

3507

.Object):

2761

3508

exclude.add(name)

2762

3509

2763

3510

client_dict["encrypted_secret"] = (client

2764

3511

.encrypted_secret)

2765

3512

for attr in client.client_structure:

2766

3513

if attr not in exclude:

2767

3514

client_dict[attr] = getattr(client, attr)

2768

3515

2769

3516

clients[client.name] = client_dict

2770

3517

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

2771

3518

2772

3519

try:

2773

with (tempfile.NamedTemporaryFile

2774

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

2775

dir=os.path.dirname(stored_state_path),

2776

delete=False)) as stored_state:

2777

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

2778

tempname=stored_state.name

3520

with tempfile.NamedTemporaryFile(

3521

mode='wb',

3522

suffix=".pickle",

3523

prefix='clients-',

3524

dir=os.path.dirname(stored_state_path),

3525

delete=False) as stored_state:

3526

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

3527

protocol=2)

3528

tempname = stored_state.name

2779

3529

os.rename(tempname, stored_state_path)

2780

3530

except (IOError, OSError) as e:

2781

3531

if not debug:

2790

3540

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

2791

3541

exc_info=e)

2792

3542

raise

2793

3543

2794

3544

# Delete all clients, and settings from config

2795

3545

while tcp_server.clients:

2796

3546

name, client = tcp_server.clients.popitem()

2797

3547

if use_dbus:

2798

3548

client.remove_from_connection()

2799

# Don't signal anything except ClientRemoved

3549

# Don't signal the disabling

2800

3550

client.disable(quiet=True)

3551

# Emit D-Bus signal for removal

2801

3552

if use_dbus:

2802

# Emit D-Bus signal

2803

mandos_dbus_service.ClientRemoved(client

2804

.dbus_object_path,

2805

client.name)

3553

mandos_dbus_service.client_removed_signal(client)

2806

3554

client_settings.clear()

2807

3555

2808

3556

atexit.register(cleanup)

2809

2810

for client in tcp_server.clients.itervalues():

3557

3558

for client in tcp_server.clients.values():

2811

3559

if use_dbus:

2812

# Emit D-Bus signal

2813

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3560

# Emit D-Bus signal for adding

3561

mandos_dbus_service.client_added_signal(client)

2814

3562

# Need to initiate checking of clients

2815

3563

if client.enabled:

2816

3564

client.init_checker()

2817

3565

2818

3566

tcp_server.enable()

2819

3567

tcp_server.server_activate()

2820

3568

2821

3569

# Find out what port we got

2822

3570

if zeroconf:

2823

3571

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

2828

3576

else: # IPv4

2829

3577

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

2830

3578

*tcp_server.socket.getsockname())

2831

2832

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

2833

3579

3580

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

3581

2834

3582

try:

2835

3583

if zeroconf:

2836

3584

# From the Avahi example code

2841

3589

cleanup()

2842

3590

sys.exit(1)

2843

3591

# End of Avahi example code

2844

2845

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

2846

lambda *args, **kwargs:

2847

(tcp_server.handle_request

2848

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

2849

3592

3593

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

3594

lambda *args, **kwargs:

3595

(tcp_server.handle_request

3596

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

3597

2850

3598

logger.debug("Starting main loop")

2851

3599

main_loop.run()

2852

3600

except AvahiError as error:

2861

3609

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

2862

3610

cleanup()

2863

3611

3612

2864

3613

if __name__ == '__main__':

2865

3614

main()