/mandos/release : revision 237.7.699

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

import gi

84

from gi.repository import GLib

77

85

from dbus.mainloop.glib import DBusGMainLoop

78

86

import ctypes

79

87

import ctypes.util

80

88

import xml.dom.minidom

81

89

import inspect

82

90

91

# Try to find the value of SO_BINDTODEVICE:

83

92

try:

93

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

94

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

84

95

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

96

except AttributeError:

86

97

try:

98

# This is where SO_BINDTODEVICE was up to and including Python

99

# 2.6, and also 3.2:

87

100

from IN import SO_BINDTODEVICE

88

101

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.7"

102

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

103

# Try running the C preprocessor:

104

try:

105

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

106

"/dev/stdin"],

107

stdin=subprocess.PIPE,

108

stdout=subprocess.PIPE)

109

stdout = cc.communicate(

110

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

111

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

112

except (OSError, ValueError, IndexError):

113

# No value found

114

SO_BINDTODEVICE = None

115

116

if sys.version_info.major == 2:

117

str = unicode

118

119

if sys.version_info < (3, 2):

120

configparser.Configparser = configparser.SafeConfigParser

121

122

version = "1.8.6"

92

123

stored_state_file = "clients.pickle"

93

124

94

125

logger = logging.getLogger()

95

126

syslogger = None

96

127

97

128

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

129

if_nametoindex = ctypes.cdll.LoadLibrary(

130

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

101

131

except (OSError, AttributeError):

132

102

133

def if_nametoindex(interface):

103

134

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

104

135

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

105

136

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

106

137

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

138

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

139

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

111

140

return interface_index

112

141

113

142

143

def copy_function(func):

144

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

145

if sys.version_info.major == 2:

146

return types.FunctionType(func.func_code,

147

func.func_globals,

148

func.func_name,

149

func.func_defaults,

150

func.func_closure)

151

else:

152

return types.FunctionType(func.__code__,

153

func.__globals__,

154

func.__name__,

155

func.__defaults__,

156

func.__closure__)

157

158

114

159

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

115

160

"""init logger and add loglevel"""

116

161

117

162

global syslogger

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

163

syslogger = (logging.handlers.SysLogHandler(

164

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

165

address="/dev/log"))

122

166

syslogger.setFormatter(logging.Formatter

123

167

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

124

168

' %(message)s'))

125

169

logger.addHandler(syslogger)

126

170

127

171

if debug:

128

172

console = logging.StreamHandler()

129

173

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

141

185

142

186

class PGPEngine(object):

143

187

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

188

144

189

def __init__(self):

145

190

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

191

self.gpg = "gpg"

192

try:

193

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

194

for line in output.splitlines():

195

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

196

if name == "gpg":

197

self.gpg = path

198

break

199

except OSError as e:

200

if e.errno != errno.ENOENT:

201

raise

146

202

self.gnupgargs = ['--batch',

147

'--home', self.tempdir,

203

'--homedir', self.tempdir,

148

204

'--force-mdc',

149

'--quiet',

150

'--no-use-agent']

151

205

'--quiet']

206

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

207

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

208

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

209

152

210

def __enter__(self):

153

211

return self

154

212

155

213

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

156

214

self._cleanup()

157

215

return False

158

216

159

217

def __del__(self):

160

218

self._cleanup()

161

219

162

220

def _cleanup(self):

163

221

if self.tempdir is not None:

164

222

# Delete contents of tempdir

165

223

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

166

topdown = False):

224

topdown=False):

167

225

for filename in files:

168

226

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

169

227

for dirname in dirs:

171

229

# Remove tempdir

172

230

os.rmdir(self.tempdir)

173

231

self.tempdir = None

174

232

175

233

def password_encode(self, password):

176

234

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

177

235

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

182

240

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

183

241

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

184

242

return encoded

185

243

186

244

def encrypt(self, data, password):

187

245

passphrase = self.password_encode(password)

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

246

with tempfile.NamedTemporaryFile(

247

dir=self.tempdir) as passfile:

190

248

passfile.write(passphrase)

191

249

passfile.flush()

192

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

250

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

193

251

'--passphrase-file',

194

252

passfile.name]

195

253

+ self.gnupgargs,

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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

254

stdin=subprocess.PIPE,

255

stdout=subprocess.PIPE,

256

stderr=subprocess.PIPE)

257

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

200

258

if proc.returncode != 0:

201

259

raise PGPError(err)

202

260

return ciphertext

203

261

204

262

def decrypt(self, data, password):

205

263

passphrase = self.password_encode(password)

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

264

with tempfile.NamedTemporaryFile(

265

dir=self.tempdir) as passfile:

208

266

passfile.write(passphrase)

209

267

passfile.flush()

210

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

268

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

211

269

'--passphrase-file',

212

270

passfile.name]

213

271

+ self.gnupgargs,

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

272

stdin=subprocess.PIPE,

273

stdout=subprocess.PIPE,

274

stderr=subprocess.PIPE)

275

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

219

276

if proc.returncode != 0:

220

277

raise PGPError(err)

221

278

return decrypted_plaintext

222

279

223

280

281

# Pretend that we have an Avahi module

282

class avahi(object):

283

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

284

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

285

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

286

PROTO_INET = 0 # avahi-common/address.h

287

PROTO_INET6 = 1 # avahi-common/address.h

288

DBUS_NAME = "org.freedesktop.Avahi"

289

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

290

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

291

DBUS_PATH_SERVER = "/"

292

293

@staticmethod

294

def string_array_to_txt_array(t):

295

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

296

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

297

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

298

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

299

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

300

SERVER_INVALID = 0 # avahi-common/defs.h

301

SERVER_REGISTERING = 1 # avahi-common/defs.h

302

SERVER_RUNNING = 2 # avahi-common/defs.h

303

SERVER_COLLISION = 3 # avahi-common/defs.h

304

SERVER_FAILURE = 4 # avahi-common/defs.h

305

306

224

307

class AvahiError(Exception):

225

308

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

226

309

self.value = value

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

310

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

311

**kwargs)

312

230

313

231

314

class AvahiServiceError(AvahiError):

232

315

pass

233

316

317

234

318

class AvahiGroupError(AvahiError):

235

319

pass

236

320

237

321

238

322

class AvahiService(object):

239

323

"""An Avahi (Zeroconf) service.

240

324

241

325

Attributes:

242

326

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

243

327

Used to optionally bind to the specified interface.

255

339

server: D-Bus Server

256

340

bus: dbus.SystemBus()

257

341

"""

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

342

343

def __init__(self,

344

interface=avahi.IF_UNSPEC,

345

name=None,

346

servicetype=None,

347

port=None,

348

TXT=None,

349

domain="",

350

host="",

351

max_renames=32768,

352

protocol=avahi.PROTO_UNSPEC,

353

bus=None):

263

354

self.interface = interface

264

355

self.name = name

265

356

self.type = servicetype

274

365

self.server = None

275

366

self.bus = bus

276

367

self.entry_group_state_changed_match = None

277

278

def rename(self):

368

369

def rename(self, remove=True):

279

370

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

280

371

if self.rename_count >= self.max_renames:

281

372

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

282

373

" after %i retries, exiting.",

283

374

self.rename_count)

284

375

raise AvahiServiceError("Too many renames")

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

376

self.name = str(

377

self.server.GetAlternativeServiceName(self.name))

378

self.rename_count += 1

287

379

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

288

380

self.name)

289

self.remove()

381

if remove:

382

self.remove()

290

383

try:

291

384

self.add()

292

385

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

386

if (error.get_dbus_name()

387

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

388

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

389

return self.rename(remove=False)

390

else:

391

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

392

self.cleanup()

393

os._exit(1)

394

298

395

def remove(self):

299

396

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

300

397

if self.entry_group_state_changed_match is not None:

302

399

self.entry_group_state_changed_match = None

303

400

if self.group is not None:

304

401

self.group.Reset()

305

402

306

403

def add(self):

307

404

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

308

405

self.remove()

325

422

dbus.UInt16(self.port),

326

423

avahi.string_array_to_txt_array(self.TXT))

327

424

self.group.Commit()

328

425

329

426

def entry_group_state_changed(self, state, error):

330

427

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

331

428

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

332

429

333

430

if state == avahi.ENTRY_GROUP_ESTABLISHED:

334

431

logger.debug("Zeroconf service established.")

335

432

elif state == avahi.ENTRY_GROUP_COLLISION:

337

434

self.rename()

338

435

elif state == avahi.ENTRY_GROUP_FAILURE:

339

436

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

340

unicode(error))

341

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

342

.format(error))

343

437

str(error))

438

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

439

344

440

def cleanup(self):

345

441

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

346

442

if self.group is not None:

351

447

pass

352

448

self.group = None

353

449

self.remove()

354

450

355

451

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

356

452

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

357

453

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

454

bad_states = {

455

avahi.SERVER_INVALID: "Zeroconf server invalid",

456

avahi.SERVER_REGISTERING: None,

457

avahi.SERVER_COLLISION: "Zeroconf server name collision",

458

avahi.SERVER_FAILURE: "Zeroconf server failure",

459

}

365

460

if state in bad_states:

366

461

if bad_states[state] is not None:

367

462

if error is None:

370

465

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

371

466

self.cleanup()

372

467

elif state == avahi.SERVER_RUNNING:

373

self.add()

468

try:

469

self.add()

470

except dbus.exceptions.DBusException as error:

471

if (error.get_dbus_name()

472

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

473

logger.info("Local Zeroconf service name"

474

" collision.")

475

return self.rename(remove=False)

476

else:

477

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

478

self.cleanup()

479

os._exit(1)

374

480

else:

375

481

if error is None:

376

482

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

377

483

else:

378

484

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

379

485

380

486

def activate(self):

381

487

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

382

488

if self.server is None:

386

492

follow_name_owner_changes=True),

387

493

avahi.DBUS_INTERFACE_SERVER)

388

494

self.server.connect_to_signal("StateChanged",

389

self.server_state_changed)

495

self.server_state_changed)

390

496

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

391

497

392

498

393

499

class AvahiServiceToSyslog(AvahiService):

394

def rename(self):

500

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

395

501

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

502

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

503

syslogger.setFormatter(logging.Formatter(

504

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

505

.format(self.name)))

401

506

return ret

402

507

403

508

509

# Pretend that we have a GnuTLS module

510

class gnutls(object):

511

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

512

513

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

514

if library is None:

515

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

516

_library = ctypes.cdll.LoadLibrary(library)

517

del library

518

519

# Unless otherwise indicated, the constants and types below are

520

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

521

522

# Constants

523

E_SUCCESS = 0

524

E_INTERRUPTED = -52

525

E_AGAIN = -28

526

CRT_OPENPGP = 2

527

CRT_RAWPK = 3

528

CLIENT = 2

529

SHUT_RDWR = 0

530

CRD_CERTIFICATE = 1

531

E_NO_CERTIFICATE_FOUND = -49

532

X509_FMT_DER = 0

533

NO_TICKETS = 1<<10

534

ENABLE_RAWPK = 1<<18

535

CTYPE_PEERS = 3

536

KEYID_USE_SHA256 = 1 # gnutls/x509.h

537

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

538

539

# Types

540

class session_int(ctypes.Structure):

541

_fields_ = []

542

session_t = ctypes.POINTER(session_int)

543

544

class certificate_credentials_st(ctypes.Structure):

545

_fields_ = []

546

certificate_credentials_t = ctypes.POINTER(

547

certificate_credentials_st)

548

certificate_type_t = ctypes.c_int

549

550

class datum_t(ctypes.Structure):

551

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

552

('size', ctypes.c_uint)]

553

554

class openpgp_crt_int(ctypes.Structure):

555

_fields_ = []

556

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

557

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

558

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

559

credentials_type_t = ctypes.c_int

560

transport_ptr_t = ctypes.c_void_p

561

close_request_t = ctypes.c_int

562

563

# Exceptions

564

class Error(Exception):

565

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

566

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

567

# code is passed, convert it to a string with

568

# gnutls.strerror()

569

self.code = code

570

if message is None and code is not None:

571

message = gnutls.strerror(code)

572

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

573

message, *args)

574

575

class CertificateSecurityError(Error):

576

pass

577

578

# Classes

579

class Credentials(object):

580

def __init__(self):

581

self._c_object = gnutls.certificate_credentials_t()

582

gnutls.certificate_allocate_credentials(

583

ctypes.byref(self._c_object))

584

self.type = gnutls.CRD_CERTIFICATE

585

586

def __del__(self):

587

gnutls.certificate_free_credentials(self._c_object)

588

589

class ClientSession(object):

590

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

591

self._c_object = gnutls.session_t()

592

gnutls_flags = gnutls.CLIENT

593

if gnutls.check_version(b"3.5.6"):

594

gnutls_flags |= gnutls.NO_TICKETS

595

if gnutls.has_rawpk:

596

gnutls_flags |= gnutls.ENABLE_RAWPK

597

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

598

del gnutls_flags

599

gnutls.set_default_priority(self._c_object)

600

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

601

gnutls.handshake_set_private_extensions(self._c_object,

602

True)

603

self.socket = socket

604

if credentials is None:

605

credentials = gnutls.Credentials()

606

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

607

ctypes.cast(credentials._c_object,

608

ctypes.c_void_p))

609

self.credentials = credentials

610

611

def __del__(self):

612

gnutls.deinit(self._c_object)

613

614

def handshake(self):

615

return gnutls.handshake(self._c_object)

616

617

def send(self, data):

618

data = bytes(data)

619

data_len = len(data)

620

while data_len > 0:

621

data_len -= gnutls.record_send(self._c_object,

622

data[-data_len:],

623

data_len)

624

625

def bye(self):

626

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

627

628

# Error handling functions

629

def _error_code(result):

630

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

631

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

632

if result >= 0:

633

return result

634

if result == gnutls.E_NO_CERTIFICATE_FOUND:

635

raise gnutls.CertificateSecurityError(code=result)

636

raise gnutls.Error(code=result)

637

638

def _retry_on_error(result, func, arguments):

639

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

640

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

641

while result < 0:

642

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

643

return _error_code(result)

644

result = func(*arguments)

645

return result

646

647

# Unless otherwise indicated, the function declarations below are

648

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

649

650

# Functions

651

priority_set_direct = _library.gnutls_priority_set_direct

652

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

653

ctypes.POINTER(ctypes.c_char_p)]

654

priority_set_direct.restype = _error_code

655

656

init = _library.gnutls_init

657

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

658

init.restype = _error_code

659

660

set_default_priority = _library.gnutls_set_default_priority

661

set_default_priority.argtypes = [session_t]

662

set_default_priority.restype = _error_code

663

664

record_send = _library.gnutls_record_send

665

record_send.argtypes = [session_t, ctypes.c_void_p,

666

ctypes.c_size_t]

667

record_send.restype = ctypes.c_ssize_t

668

record_send.errcheck = _retry_on_error

669

670

certificate_allocate_credentials = (

671

_library.gnutls_certificate_allocate_credentials)

672

certificate_allocate_credentials.argtypes = [

673

ctypes.POINTER(certificate_credentials_t)]

674

certificate_allocate_credentials.restype = _error_code

675

676

certificate_free_credentials = (

677

_library.gnutls_certificate_free_credentials)

678

certificate_free_credentials.argtypes = [

679

certificate_credentials_t]

680

certificate_free_credentials.restype = None

681

682

handshake_set_private_extensions = (

683

_library.gnutls_handshake_set_private_extensions)

684

handshake_set_private_extensions.argtypes = [session_t,

685

ctypes.c_int]

686

handshake_set_private_extensions.restype = None

687

688

credentials_set = _library.gnutls_credentials_set

689

credentials_set.argtypes = [session_t, credentials_type_t,

690

ctypes.c_void_p]

691

credentials_set.restype = _error_code

692

693

strerror = _library.gnutls_strerror

694

strerror.argtypes = [ctypes.c_int]

695

strerror.restype = ctypes.c_char_p

696

697

certificate_type_get = _library.gnutls_certificate_type_get

698

certificate_type_get.argtypes = [session_t]

699

certificate_type_get.restype = _error_code

700

701

certificate_get_peers = _library.gnutls_certificate_get_peers

702

certificate_get_peers.argtypes = [session_t,

703

ctypes.POINTER(ctypes.c_uint)]

704

certificate_get_peers.restype = ctypes.POINTER(datum_t)

705

706

global_set_log_level = _library.gnutls_global_set_log_level

707

global_set_log_level.argtypes = [ctypes.c_int]

708

global_set_log_level.restype = None

709

710

global_set_log_function = _library.gnutls_global_set_log_function

711

global_set_log_function.argtypes = [log_func]

712

global_set_log_function.restype = None

713

714

deinit = _library.gnutls_deinit

715

deinit.argtypes = [session_t]

716

deinit.restype = None

717

718

handshake = _library.gnutls_handshake

719

handshake.argtypes = [session_t]

720

handshake.restype = _error_code

721

handshake.errcheck = _retry_on_error

722

723

transport_set_ptr = _library.gnutls_transport_set_ptr

724

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

725

transport_set_ptr.restype = None

726

727

bye = _library.gnutls_bye

728

bye.argtypes = [session_t, close_request_t]

729

bye.restype = _error_code

730

bye.errcheck = _retry_on_error

731

732

check_version = _library.gnutls_check_version

733

check_version.argtypes = [ctypes.c_char_p]

734

check_version.restype = ctypes.c_char_p

735

736

_need_version = b"3.3.0"

737

if check_version(_need_version) is None:

738

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

739

.format(_need_version))

740

741

_tls_rawpk_version = b"3.6.6"

742

has_rawpk = bool(check_version(_tls_rawpk_version))

743

744

if has_rawpk:

745

# Types

746

class pubkey_st(ctypes.Structure):

747

_fields = []

748

pubkey_t = ctypes.POINTER(pubkey_st)

749

750

x509_crt_fmt_t = ctypes.c_int

751

752

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

753

pubkey_init = _library.gnutls_pubkey_init

754

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

755

pubkey_init.restype = _error_code

756

757

pubkey_import = _library.gnutls_pubkey_import

758

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

759

x509_crt_fmt_t]

760

pubkey_import.restype = _error_code

761

762

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

763

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

764

ctypes.POINTER(ctypes.c_ubyte),

765

ctypes.POINTER(ctypes.c_size_t)]

766

pubkey_get_key_id.restype = _error_code

767

768

pubkey_deinit = _library.gnutls_pubkey_deinit

769

pubkey_deinit.argtypes = [pubkey_t]

770

pubkey_deinit.restype = None

771

else:

772

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

773

774

openpgp_crt_init = _library.gnutls_openpgp_crt_init

775

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

776

openpgp_crt_init.restype = _error_code

777

778

openpgp_crt_import = _library.gnutls_openpgp_crt_import

779

openpgp_crt_import.argtypes = [openpgp_crt_t,

780

ctypes.POINTER(datum_t),

781

openpgp_crt_fmt_t]

782

openpgp_crt_import.restype = _error_code

783

784

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

785

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

786

ctypes.POINTER(ctypes.c_uint)]

787

openpgp_crt_verify_self.restype = _error_code

788

789

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

790

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

791

openpgp_crt_deinit.restype = None

792

793

openpgp_crt_get_fingerprint = (

794

_library.gnutls_openpgp_crt_get_fingerprint)

795

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

796

ctypes.c_void_p,

797

ctypes.POINTER(

798

ctypes.c_size_t)]

799

openpgp_crt_get_fingerprint.restype = _error_code

800

801

if check_version(b"3.6.4"):

802

certificate_type_get2 = _library.gnutls_certificate_type_get2

803

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

804

certificate_type_get2.restype = _error_code

805

806

# Remove non-public functions

807

del _error_code, _retry_on_error

808

809

810

def call_pipe(connection, # : multiprocessing.Connection

811

func, *args, **kwargs):

812

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

813

814

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

815

return value on the provided multiprocessing.Connection.

816

"""

817

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

818

connection.close()

819

820

404

821

class Client(object):

405

822

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

406

823

407

824

Attributes:

408

825

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

409

826

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

410

827

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

411

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

412

to see if the client lives.

413

'None' if no process is running.

414

checker_callback_tag: a gobject event source tag, or None

828

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

829

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

830

running.

831

checker_callback_tag: a GLib event source tag, or None

415

832

checker_command: string; External command which is run to check

416

833

if client lives. %() expansions are done at

417

834

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

418

835

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

419

checker_initiator_tag: a gobject event source tag, or None

836

checker_initiator_tag: a GLib event source tag, or None

420

837

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

421

838

client_structure: Object describing what attributes a client has

422

839

and is used for storing the client at exit

423

840

current_checker_command: string; current running checker_command

424

disable_initiator_tag: a gobject event source tag, or None

841

disable_initiator_tag: a GLib event source tag, or None

425

842

enabled: bool()

426

843

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

427

uniquely identify the client

844

uniquely identify an OpenPGP client

845

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

846

a client using raw public keys

428

847

host: string; available for use by the checker command

429

848

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

430

849

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

432

851

last_checker_status: integer between 0 and 255 reflecting exit

433

852

status of last checker. -1 reflects crashed

434

853

checker, -2 means no checker completed yet.

854

last_checker_signal: The signal which killed the last checker, if

855

last_checker_status is -1

435

856

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

436

857

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

437

858

D-Bus identifiers

444

865

disabled, or None

445

866

server_settings: The server_settings dict from main()

446

867

"""

447

868

448

869

runtime_expansions = ("approval_delay", "approval_duration",

449

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

870

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

450

871

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

451

872

"last_approval_request", "last_checked_ok",

452

873

"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

874

client_defaults = {

875

"timeout": "PT5M",

876

"extended_timeout": "PT15M",

877

"interval": "PT2M",

878

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

879

"host": "",

880

"approval_delay": "PT0S",

881

"approval_duration": "PT1S",

882

"approved_by_default": "True",

883

"enabled": "True",

884

}

885

464

886

@staticmethod

465

887

def config_parser(config):

466

888

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

473

895

for client_name in config.sections():

474

896

section = dict(config.items(client_name))

475

897

client = settings[client_name] = {}

476

898

477

899

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

478

900

# Reformat values from string types to Python types

479

901

client["approved_by_default"] = config.getboolean(

480

902

client_name, "approved_by_default")

481

903

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

482

904

"enabled")

483

905

906

# Uppercase and remove spaces from key_id and fingerprint

907

# for later comparison purposes with return value from the

908

# key_id() and fingerprint() functions

909

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

910

.replace(" ", ""))

484

911

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

485

912

.replace(" ", ""))

486

913

if "secret" in section:

487

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

914

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

915

.encode("utf-8"),

916

"base64")

488

917

elif "secfile" in section:

489

918

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

490

919

(section["secfile"])),

505

934

client["last_approval_request"] = None

506

935

client["last_checked_ok"] = None

507

936

client["last_checker_status"] = -2

508

937

509

938

return settings

510

511

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

939

940

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

512

941

self.name = name

513

942

if server_settings is None:

514

943

server_settings = {}

516

945

# adding all client settings

517

946

for setting, value in settings.items():

518

947

setattr(self, setting, value)

519

948

520

949

if self.enabled:

521

950

if not hasattr(self, "last_enabled"):

522

951

self.last_enabled = datetime.datetime.utcnow()

526

955

else:

527

956

self.last_enabled = None

528

957

self.expires = None

529

958

530

959

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

960

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

534

961

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

535

962

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

536

963

datetime.datetime.utcnow())

537

964

538

965

# attributes specific for this server instance

539

966

self.checker = None

540

967

self.checker_initiator_tag = None

543

970

self.current_checker_command = None

544

971

self.approved = None

545

972

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

973

self.changedstate = multiprocessing_manager.Condition(

974

multiprocessing_manager.Lock())

975

self.client_structure = [attr

976

for attr in self.__dict__.keys()

551

977

if not attr.startswith("_")]

552

978

self.client_structure.append("client_structure")

553

554

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

555

lambda obj:

556

isinstance(obj,

557

property)):

979

980

for name, t in inspect.getmembers(

981

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

558

982

if not name.startswith("_"):

559

983

self.client_structure.append(name)

560

984

561

985

# Send notice to process children that client state has changed

562

986

def send_changedstate(self):

563

987

with self.changedstate:

564

988

self.changedstate.notify_all()

565

989

566

990

def enable(self):

567

991

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

568

992

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

573

997

self.last_enabled = datetime.datetime.utcnow()

574

998

self.init_checker()

575

999

self.send_changedstate()

576

1000

577

1001

def disable(self, quiet=True):

578

1002

"""Disable this client."""

579

1003

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

581

1005

if not quiet:

582

1006

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

583

1007

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

584

gobject.source_remove(self.disable_initiator_tag)

1008

GLib.source_remove(self.disable_initiator_tag)

585

1009

self.disable_initiator_tag = None

586

1010

self.expires = None

587

1011

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

588

gobject.source_remove(self.checker_initiator_tag)

1012

GLib.source_remove(self.checker_initiator_tag)

589

1013

self.checker_initiator_tag = None

590

1014

self.stop_checker()

591

1015

self.enabled = False

592

1016

if not quiet:

593

1017

self.send_changedstate()

594

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

1018

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

595

1019

return False

596

1020

597

1021

def __del__(self):

598

1022

self.disable()

599

1023

600

1024

def init_checker(self):

601

1025

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

602

1026

# and every interval from then on.

603

1027

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

1028

GLib.source_remove(self.checker_initiator_tag)

1029

self.checker_initiator_tag = GLib.timeout_add(

1030

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

1031

self.start_checker)

609

1032

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

610

1033

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

1034

GLib.source_remove(self.disable_initiator_tag)

1035

self.disable_initiator_tag = GLib.timeout_add(

1036

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

616

1037

# Also start a new checker *right now*.

617

1038

self.start_checker()

618

619

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

1039

1040

def checker_callback(self, source, condition, connection,

1041

command):

620

1042

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

1043

# Read return code from connection (see call_pipe)

1044

returncode = connection.recv()

1045

connection.close()

1046

self.checker.join()

621

1047

self.checker_callback_tag = None

622

1048

self.checker = None

623

if os.WIFEXITED(condition):

624

self.last_checker_status = os.WEXITSTATUS(condition)

1049

1050

if returncode >= 0:

1051

self.last_checker_status = returncode

1052

self.last_checker_signal = None

625

1053

if self.last_checker_status == 0:

626

1054

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

627

1055

vars(self))

628

1056

self.checked_ok()

629

1057

else:

630

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

631

vars(self))

1058

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

632

1059

else:

633

1060

self.last_checker_status = -1

1061

self.last_checker_signal = -returncode

634

1062

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

635

1063

vars(self))

636

1064

return False

1065

637

1066

def checked_ok(self):

638

1067

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

639

1068

self.last_checked_ok = datetime.datetime.utcnow()

640

1069

self.last_checker_status = 0

1070

self.last_checker_signal = None

641

1071

self.bump_timeout()

642

1072

643

1073

def bump_timeout(self, timeout=None):

644

1074

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

645

1075

if timeout is None:

646

1076

timeout = self.timeout

647

1077

if self.disable_initiator_tag is not None:

648

gobject.source_remove(self.disable_initiator_tag)

1078

GLib.source_remove(self.disable_initiator_tag)

649

1079

self.disable_initiator_tag = None

650

1080

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

651

self.disable_initiator_tag = (gobject.timeout_add

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

1081

self.disable_initiator_tag = GLib.timeout_add(

1082

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

654

1083

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

655

1084

656

1085

def need_approval(self):

657

1086

self.last_approval_request = datetime.datetime.utcnow()

658

1087

659

1088

def start_checker(self):

660

1089

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

661

1090

662

1091

If a checker already exists, leave it running and do

663

1092

nothing."""

664

1093

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

669

1098

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

670

1099

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

671

1100

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

1101

1102

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

1103

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

1104

self.checker.join()

1105

self.checker = None

687

1106

# Start a new checker if needed

688

1107

if self.checker is None:

689

1108

# Escape attributes for the shell

690

escaped_attrs = { attr:

691

re.escape(unicode(getattr(self,

692

attr)))

693

for attr in self.runtime_expansions }

1109

escaped_attrs = {

1110

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

1111

for attr in self.runtime_expansions}

694

1112

try:

695

1113

command = self.checker_command % escaped_attrs

696

1114

except TypeError as error:

697

1115

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

698

self.checker_command, exc_info=error)

699

return True # Try again later

1116

self.checker_command,

1117

exc_info=error)

1118

return True # Try again later

700

1119

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

1120

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

1121

self.name)

1122

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

1123

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

1124

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

1125

# always replaced by /dev/null.)

1126

# The exception is when not debugging but nevertheless

1127

# running in the foreground; use the previously

1128

# created wnull.

1129

popen_args = {"close_fds": True,

1130

"shell": True,

1131

"cwd": "/"}

1132

if (not self.server_settings["debug"]

1133

and self.server_settings["foreground"]):

1134

popen_args.update({"stdout": wnull,

1135

"stderr": wnull})

1136

pipe = multiprocessing.Pipe(duplex=False)

1137

self.checker = multiprocessing.Process(

1138

target=call_pipe,

1139

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

1140

kwargs=popen_args)

1141

self.checker.start()

1142

self.checker_callback_tag = GLib.io_add_watch(

1143

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

1144

self.checker_callback, pipe[0], command)

1145

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

743

1146

return True

744

1147

745

1148

def stop_checker(self):

746

1149

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

747

1150

if self.checker_callback_tag:

748

gobject.source_remove(self.checker_callback_tag)

1151

GLib.source_remove(self.checker_callback_tag)

749

1152

self.checker_callback_tag = None

750

1153

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

751

1154

return

752

1155

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

1156

self.checker.terminate()

761

1157

self.checker = None

762

1158

763

1159

764

def dbus_service_property(dbus_interface, signature="v",

765

access="readwrite", byte_arrays=False):

1160

def dbus_service_property(dbus_interface,

1161

signature="v",

1162

access="readwrite",

1163

byte_arrays=False):

766

1164

"""Decorators for marking methods of a DBusObjectWithProperties to

767

1165

become properties on the D-Bus.

768

1166

769

1167

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

770

1168

and with one argument by "Set".

771

1169

772

1170

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

773

1171

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

774

1172

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

778

1176

if byte_arrays and signature != "ay":

779

1177

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

780

1178

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

1179

781

1180

def decorator(func):

782

1181

func._dbus_is_property = True

783

1182

func._dbus_interface = dbus_interface

786

1185

func._dbus_name = func.__name__

787

1186

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

788

1187

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

789

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1188

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

790

1189

return func

1190

791

1191

return decorator

792

1192

793

1193

794

1194

def dbus_interface_annotations(dbus_interface):

795

1195

"""Decorator for marking functions returning interface annotations

796

1196

797

1197

Usage:

798

1198

799

1199

@dbus_interface_annotations("org.example.Interface")

800

1200

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

801

1201

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

802

1202

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

803

1203

"false"}

804

1204

"""

1205

805

1206

def decorator(func):

806

1207

func._dbus_is_interface = True

807

1208

func._dbus_interface = dbus_interface

808

1209

func._dbus_name = dbus_interface

809

1210

return func

1211

810

1212

return decorator

811

1213

812

1214

813

1215

def dbus_annotations(annotations):

814

1216

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

815

1217

Usage:

816

1218

1219

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

1220

"org.freedesktop.DBus.Property."

1221

"EmitsChangedSignal": "false"})

817

1222

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

818

1223

access="r")

819

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

820

"org.freedesktop.DBus.Property."

821

"EmitsChangedSignal": "false"})

822

1224

def Property_dbus_property(self):

823

1225

return dbus.Boolean(False)

1226

1227

See also the DBusObjectWithAnnotations class.

824

1228

"""

1229

825

1230

def decorator(func):

826

1231

func._dbus_annotations = annotations

827

1232

return func

1233

828

1234

return decorator

829

1235

830

1236

831

1237

class DBusPropertyException(dbus.exceptions.DBusException):

832

1238

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

833

1239

"""

834

def __unicode__(self):

835

return unicode(str(self))

1240

pass

836

1241

837

1242

838

1243

class DBusPropertyAccessException(DBusPropertyException):

847

1252

pass

848

1253

849

1254

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.

1255

class DBusObjectWithAnnotations(dbus.service.Object):

1256

"""A D-Bus object with annotations.

1257

1258

Classes inheriting from this can use the dbus_annotations

1259

decorator to add annotations to methods or signals.

856

1260

"""

857

1261

858

1262

@staticmethod

859

1263

def _is_dbus_thing(thing):

860

1264

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

861

1265

862

1266

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

863

1267

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

864

1268

"""

865

1269

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

866

1270

False)

867

1271

868

1272

def _get_all_dbus_things(self, thing):

869

1273

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

870

1274

"""

871

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

872

name),

1275

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

873

1276

athing.__get__(self))

874

1277

for cls in self.__class__.__mro__

875

1278

for name, athing in

876

inspect.getmembers(cls,

877

self._is_dbus_thing(thing)))

878

1279

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

1280

1281

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1282

out_signature="s",

1283

path_keyword='object_path',

1284

connection_keyword='connection')

1285

def Introspect(self, object_path, connection):

1286

"""Overloading of standard D-Bus method.

1287

1288

Inserts annotation tags on methods and signals.

1289

"""

1290

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

1291

connection)

1292

try:

1293

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

1294

1295

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

1296

# Add annotation tags

1297

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

1298

for tag in if_tag.getElementsByTagName(typ):

1299

annots = dict()

1300

for name, prop in (self.

1301

_get_all_dbus_things(typ)):

1302

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

1303

and prop._dbus_interface

1304

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

1305

annots.update(getattr(

1306

prop, "_dbus_annotations", {}))

1307

for name, value in annots.items():

1308

ann_tag = document.createElement(

1309

"annotation")

1310

ann_tag.setAttribute("name", name)

1311

ann_tag.setAttribute("value", value)

1312

tag.appendChild(ann_tag)

1313

# Add interface annotation tags

1314

for annotation, value in dict(

1315

itertools.chain.from_iterable(

1316

annotations().items()

1317

for name, annotations

1318

in self._get_all_dbus_things("interface")

1319

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

1320

)).items():

1321

ann_tag = document.createElement("annotation")

1322

ann_tag.setAttribute("name", annotation)

1323

ann_tag.setAttribute("value", value)

1324

if_tag.appendChild(ann_tag)

1325

# Fix argument name for the Introspect method itself

1326

if (if_tag.getAttribute("name")

1327

== dbus.INTROSPECTABLE_IFACE):

1328

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

1329

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

1330

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

1331

if (arg.getAttribute("direction")

1332

== "out"):

1333

arg.setAttribute("name",

1334

"xml_data")

1335

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

1336

document.unlink()

1337

except (AttributeError, xml.dom.DOMException,

1338

xml.parsers.expat.ExpatError) as error:

1339

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

1340

exc_info=error)

1341

return xmlstring

1342

1343

1344

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1345

"""A D-Bus object with properties.

1346

1347

Classes inheriting from this can use the dbus_service_property

1348

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

1349

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

1350

"""

1351

879

1352

def _get_dbus_property(self, interface_name, property_name):

880

1353

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

881

1354

property with the specified name and interface.

882

1355

"""

883

for cls in self.__class__.__mro__:

884

for name, value in (inspect.getmembers

885

(cls,

886

self._is_dbus_thing("property"))):

1356

for cls in self.__class__.__mro__:

1357

for name, value in inspect.getmembers(

1358

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

887

1359

if (value._dbus_name == property_name

888

1360

and value._dbus_interface == interface_name):

889

1361

return value.__get__(self)

890

1362

891

1363

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

1364

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

1365

self.dbus_object_path, interface_name, property_name))

1366

1367

@classmethod

1368

def _get_all_interface_names(cls):

1369

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

1370

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

1371

"_dbus_interface", None)

1372

for x in (inspect.getmro(cls))

1373

for attr in dir(x))

1374

if name is not None)

1375

1376

@dbus.service.method(dbus.PROPERTIES_IFACE,

1377

in_signature="ss",

897

1378

out_signature="v")

898

1379

def Get(self, interface_name, property_name):

899

1380

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

905

1386

if not hasattr(value, "variant_level"):

906

1387

return value

907

1388

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

908

1389

909

1390

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

910

1391

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

911

1392

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

923

1404

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

924

1405

for byte in value))

925

1406

prop(value)

926

927

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

1407

1408

@dbus.service.method(dbus.PROPERTIES_IFACE,

1409

in_signature="s",

928

1410

out_signature="a{sv}")

929

1411

def GetAll(self, interface_name):

930

1412

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

931

1413

standard.

932

1414

933

1415

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

934

1416

"""

935

1417

properties = {}

945

1427

if not hasattr(value, "variant_level"):

946

1428

properties[name] = value

947

1429

continue

948

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

949

value.variant_level+1)

1430

properties[name] = type(value)(

1431

value, variant_level=value.variant_level + 1)

950

1432

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

951

1433

1434

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

1435

def PropertiesChanged(self, interface_name, changed_properties,

1436

invalidated_properties):

1437

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

1438

standard.

1439

"""

1440

pass

1441

952

1442

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

953

1443

out_signature="s",

954

1444

path_keyword='object_path',

955

1445

connection_keyword='connection')

956

1446

def Introspect(self, object_path, connection):

957

1447

"""Overloading of standard D-Bus method.

958

1448

959

1449

Inserts property tags and interface annotation tags.

960

1450

"""

961

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

962

connection)

1451

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1452

object_path,

1453

connection)

963

1454

try:

964

1455

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

1456

965

1457

def make_tag(document, name, prop):

966

1458

e = document.createElement("property")

967

1459

e.setAttribute("name", name)

968

1460

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

969

1461

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

970

1462

return e

1463

971

1464

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

972

1465

# Add property tags

973

1466

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

976

1469

if prop._dbus_interface

977

1470

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

978

1471

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)

1472

# Add annotation tags for properties

1473

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

1474

annots = dict()

1475

for name, prop in self._get_all_dbus_things(

1476

"property"):

1477

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

1478

and prop._dbus_interface

1479

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

1480

annots.update(getattr(

1481

prop, "_dbus_annotations", {}))

1482

for name, value in annots.items():

1483

ann_tag = document.createElement(

1484

"annotation")

1485

ann_tag.setAttribute("name", name)

1486

ann_tag.setAttribute("value", value)

1487

tag.appendChild(ann_tag)

1010

1488

# Add the names to the return values for the

1011

1489

# "org.freedesktop.DBus.Properties" methods

1012

1490

if (if_tag.getAttribute("name")

1031

1509

return xmlstring

1032

1510

1033

1511

1512

try:

1513

dbus.OBJECT_MANAGER_IFACE

1514

except AttributeError:

1515

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

1516

1517

1518

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1519

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

1520

1521

Classes inheriting from this exposes the standard

1522

GetManagedObjects call and the InterfacesAdded and

1523

InterfacesRemoved signals on the standard

1524

"org.freedesktop.DBus.ObjectManager" interface.

1525

1526

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

1527

manually.

1528

"""

1529

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1530

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

1531

def GetManagedObjects(self):

1532

"""This function must be overridden"""

1533

raise NotImplementedError()

1534

1535

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1536

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

1537

def InterfacesAdded(self, object_path, interfaces_and_properties):

1538

pass

1539

1540

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

1541

def InterfacesRemoved(self, object_path, interfaces):

1542

pass

1543

1544

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1545

out_signature="s",

1546

path_keyword='object_path',

1547

connection_keyword='connection')

1548

def Introspect(self, object_path, connection):

1549

"""Overloading of standard D-Bus method.

1550

1551

Override return argument name of GetManagedObjects to be

1552

"objpath_interfaces_and_properties"

1553

"""

1554

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1555

object_path,

1556

connection)

1557

try:

1558

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

1559

1560

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

1561

# Fix argument name for the GetManagedObjects method

1562

if (if_tag.getAttribute("name")

1563

== dbus.OBJECT_MANAGER_IFACE):

1564

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

1565

if (cn.getAttribute("name")

1566

== "GetManagedObjects"):

1567

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

1568

if (arg.getAttribute("direction")

1569

== "out"):

1570

arg.setAttribute(

1571

"name",

1572

"objpath_interfaces"

1573

"_and_properties")

1574

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

1575

document.unlink()

1576

except (AttributeError, xml.dom.DOMException,

1577

xml.parsers.expat.ExpatError) as error:

1578

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

1579

exc_info=error)

1580

return xmlstring

1581

1582

1034

1583

def datetime_to_dbus(dt, variant_level=0):

1035

1584

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

1036

1585

if dt is None:

1037

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

1038

return dbus.String(dt.isoformat(),

1039

variant_level=variant_level)

1586

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

1587

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

1040

1588

1041

1589

1042

1590

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1044

1592

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

1045

1593

interface names according to the "alt_interface_names" mapping.

1046

1594

Usage:

1047

1595

1048

1596

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

1049

1597

"net.example.AlternateInterface"})

1050

1598

class SampleDBusObject(dbus.service.Object):

1051

1599

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

1052

1600

def SampleDBusMethod():

1053

1601

pass

1054

1602

1055

1603

The above "SampleDBusMethod" on "SampleDBusObject" will be

1056

1604

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

1057

1605

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

1058

1606

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

1059

1607

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

1060

1608

1061

1609

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

1062

1610

(from DBusObjectWithProperties) and interfaces (from the

1063

1611

dbus_interface_annotations decorator).

1064

1612

"""

1613

1065

1614

def wrapper(cls):

1066

1615

for orig_interface_name, alt_interface_name in (

1067

alt_interface_names.items()):

1616

alt_interface_names.items()):

1068

1617

attr = {}

1069

1618

interface_names = set()

1070

1619

# Go though all attributes of the class

1072

1621

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

1073

1622

# with the wrong interface name

1074

1623

if (not hasattr(attribute, "_dbus_interface")

1075

or not attribute._dbus_interface

1076

.startswith(orig_interface_name)):

1624

or not attribute._dbus_interface.startswith(

1625

orig_interface_name)):

1077

1626

continue

1078

1627

# Create an alternate D-Bus interface name based on

1079

1628

# the current name

1080

alt_interface = (attribute._dbus_interface

1081

.replace(orig_interface_name,

1082

alt_interface_name))

1629

alt_interface = attribute._dbus_interface.replace(

1630

orig_interface_name, alt_interface_name)

1083

1631

interface_names.add(alt_interface)

1084

1632

# Is this a D-Bus signal?

1085

1633

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

1086

1634

# Extract the original non-method undecorated

1087

1635

# function by black magic

1088

nonmethod_func = (dict(

1636

if sys.version_info.major == 2:

1637

nonmethod_func = (dict(

1089

1638

zip(attribute.func_code.co_freevars,

1090

attribute.__closure__))["func"]

1091

.cell_contents)

1639

attribute.__closure__))

1640

["func"].cell_contents)

1641

else:

1642

nonmethod_func = (dict(

1643

zip(attribute.__code__.co_freevars,

1644

attribute.__closure__))

1645

["func"].cell_contents)

1092

1646

# Create a new, but exactly alike, function

1093

1647

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

1094

1648

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

1649

new_function = copy_function(nonmethod_func)

1650

new_function = (dbus.service.signal(

1651

alt_interface,

1652

attribute._dbus_signature)(new_function))

1104

1653

# Copy annotations, if any

1105

1654

try:

1106

new_function._dbus_annotations = (

1107

dict(attribute._dbus_annotations))

1655

new_function._dbus_annotations = dict(

1656

attribute._dbus_annotations)

1108

1657

except AttributeError:

1109

1658

pass

1659

1110

1660

# Define a creator of a function to call both the

1111

1661

# original and alternate functions, so both the

1112

1662

# original and alternate signals gets sent when

1115

1665

"""This function is a scope container to pass

1116

1666

func1 and func2 to the "call_both" function

1117

1667

outside of its arguments"""

1668

1669

@functools.wraps(func2)

1118

1670

def call_both(*args, **kwargs):

1119

1671

"""This function will emit two D-Bus

1120

1672

signals by calling func1 and func2"""

1121

1673

func1(*args, **kwargs)

1122

1674

func2(*args, **kwargs)

1675

# Make wrapper function look like a D-Bus

1676

# signal

1677

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

1678

if name.startswith("_dbus_"):

1679

setattr(call_both, name, attr)

1680

1123

1681

return call_both

1124

1682

# Create the "call_both" function and add it to

1125

1683

# the class

1130

1688

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

1131

1689

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

1132

1690

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

1691

attr[attrname] = (

1692

dbus.service.method(

1693

alt_interface,

1694

attribute._dbus_in_signature,

1695

attribute._dbus_out_signature)

1696

(copy_function(attribute)))

1143

1697

# Copy annotations, if any

1144

1698

try:

1145

attr[attrname]._dbus_annotations = (

1146

dict(attribute._dbus_annotations))

1699

attr[attrname]._dbus_annotations = dict(

1700

attribute._dbus_annotations)

1147

1701

except AttributeError:

1148

1702

pass

1149

1703

# Is this a D-Bus property?

1152

1706

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

1153

1707

# property with the alternate D-Bus interface

1154

1708

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

1709

attr[attrname] = (dbus_service_property(

1710

alt_interface, attribute._dbus_signature,

1711

attribute._dbus_access,

1712

attribute._dbus_get_args_options

1713

["byte_arrays"])

1714

(copy_function(attribute)))

1168

1715

# Copy annotations, if any

1169

1716

try:

1170

attr[attrname]._dbus_annotations = (

1171

dict(attribute._dbus_annotations))

1717

attr[attrname]._dbus_annotations = dict(

1718

attribute._dbus_annotations)

1172

1719

except AttributeError:

1173

1720

pass

1174

1721

# Is this a D-Bus interface?

1177

1724

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

1178

1725

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

1179

1726

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

1727

attr[attrname] = (

1728

dbus_interface_annotations(alt_interface)

1729

(copy_function(attribute)))

1188

1730

if deprecate:

1189

1731

# Deprecate all alternate interfaces

1190

iname="_AlternateDBusNames_interface_annotation{}"

1732

iname = "_AlternateDBusNames_interface_annotation{}"

1191

1733

for interface_name in interface_names:

1734

1192

1735

@dbus_interface_annotations(interface_name)

1193

1736

def func(self):

1194

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

1195

"true" }

1737

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

1738

"true"}

1196

1739

# Find an unused name

1197

1740

for aname in (iname.format(i)

1198

1741

for i in itertools.count()):

1202

1745

if interface_names:

1203

1746

# Replace the class with a new subclass of it with

1204

1747

# methods, signals, etc. as created above.

1205

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

1206

(cls,), attr)

1748

if sys.version_info.major == 2:

1749

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

1750

(cls, ), attr)

1751

else:

1752

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

1753

(cls, ), attr)

1207

1754

return cls

1755

1208

1756

return wrapper

1209

1757

1210

1758

1211

1759

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

1212

"se.bsnet.fukt.Mandos"})

1760

"se.bsnet.fukt.Mandos"})

1213

1761

class ClientDBus(Client, DBusObjectWithProperties):

1214

1762

"""A Client class using D-Bus

1215

1763

1216

1764

Attributes:

1217

1765

dbus_object_path: dbus.ObjectPath

1218

1766

bus: dbus.SystemBus()

1219

1767

"""

1220

1768

1221

1769

runtime_expansions = (Client.runtime_expansions

1222

+ ("dbus_object_path",))

1223

1770

+ ("dbus_object_path", ))

1771

1772

_interface = "se.recompile.Mandos.Client"

1773

1224

1774

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

1225

1226

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

1775

1776

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

1227

1777

self.bus = bus

1228

1778

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

1229

1779

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

1230

1780

# the D-Bus

1231

client_object_name = unicode(self.name).translate(

1781

client_object_name = str(self.name).translate(

1232

1782

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

1233

1783

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

1234

self.dbus_object_path = (dbus.ObjectPath

1235

("/clients/" + client_object_name))

1784

self.dbus_object_path = dbus.ObjectPath(

1785

"/clients/" + client_object_name)

1236

1786

DBusObjectWithProperties.__init__(self, self.bus,

1237

1787

self.dbus_object_path)

1238

1239

def notifychangeproperty(transform_func,

1240

dbus_name, type_func=lambda x: x,

1241

variant_level=1):

1788

1789

def notifychangeproperty(transform_func, dbus_name,

1790

type_func=lambda x: x,

1791

variant_level=1,

1792

invalidate_only=False,

1793

_interface=_interface):

1242

1794

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

1243

1795

its changes to DBus.

1244

1796

1245

1797

transform_fun: Function that takes a value and a variant_level

1246

1798

and transforms it to a D-Bus type.

1247

1799

dbus_name: D-Bus name of the variable

1250

1802

variant_level: D-Bus variant level. Default: 1

1251

1803

"""

1252

1804

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

1805

1253

1806

def setter(self, value):

1254

1807

if hasattr(self, "dbus_object_path"):

1255

1808

if (not hasattr(self, attrname) or

1256

1809

type_func(getattr(self, attrname, None))

1257

1810

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

1811

if invalidate_only:

1812

self.PropertiesChanged(

1813

_interface, dbus.Dictionary(),

1814

dbus.Array((dbus_name, )))

1815

else:

1816

dbus_value = transform_func(

1817

type_func(value),

1818

variant_level=variant_level)

1819

self.PropertyChanged(dbus.String(dbus_name),

1820

dbus_value)

1821

self.PropertiesChanged(

1822

_interface,

1823

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

1824

dbus_value}),

1825

dbus.Array())

1263

1826

setattr(self, attrname, value)

1264

1827

1265

1828

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

1266

1829

1267

1830

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1268

1831

approvals_pending = notifychangeproperty(dbus.Boolean,

1269

1832

"ApprovalPending",

1270

type_func = bool)

1833

type_func=bool)

1271

1834

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

1272

1835

last_enabled = notifychangeproperty(datetime_to_dbus,

1273

1836

"LastEnabled")

1274

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

1275

type_func = lambda checker:

1276

checker is not None)

1837

checker = notifychangeproperty(

1838

dbus.Boolean, "CheckerRunning",

1839

type_func=lambda checker: checker is not None)

1277

1840

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1278

1841

"LastCheckedOK")

1279

1842

last_checker_status = notifychangeproperty(dbus.Int16,

1282

1845

datetime_to_dbus, "LastApprovalRequest")

1283

1846

approved_by_default = notifychangeproperty(dbus.Boolean,

1284

1847

"ApprovedByDefault")

1285

approval_delay = notifychangeproperty(dbus.UInt64,

1286

"ApprovalDelay",

1287

type_func =

1288

lambda td: td.total_seconds()

1289

* 1000)

1848

approval_delay = notifychangeproperty(

1849

dbus.UInt64, "ApprovalDelay",

1850

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

1290

1851

approval_duration = notifychangeproperty(

1291

1852

dbus.UInt64, "ApprovalDuration",

1292

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

1853

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

1293

1854

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

1294

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

1295

type_func = lambda td:

1296

td.total_seconds() * 1000)

1855

timeout = notifychangeproperty(

1856

dbus.UInt64, "Timeout",

1857

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

1297

1858

extended_timeout = notifychangeproperty(

1298

1859

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)

1860

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

1861

interval = notifychangeproperty(

1862

dbus.UInt64, "Interval",

1863

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

1305

1864

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

1306

1865

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

1866

invalidate_only=True)

1867

1307

1868

del notifychangeproperty

1308

1869

1309

1870

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

1310

1871

try:

1311

1872

self.remove_from_connection()

1314

1875

if hasattr(DBusObjectWithProperties, "__del__"):

1315

1876

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

1316

1877

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)

1878

1879

def checker_callback(self, source, condition,

1880

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

1881

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

1882

connection, command, *args,

1883

**kwargs)

1884

exitstatus = self.last_checker_status

1885

if exitstatus >= 0:

1324

1886

# Emit D-Bus signal

1325

1887

self.CheckerCompleted(dbus.Int16(exitstatus),

1326

dbus.Int64(condition),

1888

# This is specific to GNU libC

1889

dbus.Int64(exitstatus << 8),

1327

1890

dbus.String(command))

1328

1891

else:

1329

1892

# Emit D-Bus signal

1330

1893

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

1331

dbus.Int64(condition),

1894

dbus.Int64(

1895

# This is specific to GNU libC

1896

(exitstatus << 8)

1897

| self.last_checker_signal),

1332

1898

dbus.String(command))

1333

1334

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

1335

*args, **kwargs)

1336

1899

return ret

1900

1337

1901

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

1338

1902

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

1339

1903

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

1343

1907

# Emit D-Bus signal

1344

1908

self.CheckerStarted(self.current_checker_command)

1345

1909

return r

1346

1910

1347

1911

def _reset_approved(self):

1348

1912

self.approved = None

1349

1913

return False

1350

1914

1351

1915

def approve(self, value=True):

1352

1916

self.approved = value

1353

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

1354

* 1000), self._reset_approved)

1917

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

1918

* 1000), self._reset_approved)

1355

1919

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

1920

1921

# D-Bus methods, signals & properties

1922

1923

# Interfaces

1924

1925

# Signals

1926

1369

1927

# CheckerCompleted - signal

1370

1928

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

1371

1929

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

1372

1930

"D-Bus signal"

1373

1931

pass

1374

1932

1375

1933

# CheckerStarted - signal

1376

1934

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

1377

1935

def CheckerStarted(self, command):

1378

1936

"D-Bus signal"

1379

1937

pass

1380

1938

1381

1939

# PropertyChanged - signal

1940

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

1382

1941

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

1383

1942

def PropertyChanged(self, property, value):

1384

1943

"D-Bus signal"

1385

1944

pass

1386

1945

1387

1946

# GotSecret - signal

1388

1947

@dbus.service.signal(_interface)

1389

1948

def GotSecret(self):

1392

1951

server to mandos-client

1393

1952

"""

1394

1953

pass

1395

1954

1396

1955

# Rejected - signal

1397

1956

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

1398

1957

def Rejected(self, reason):

1399

1958

"D-Bus signal"

1400

1959

pass

1401

1960

1402

1961

# NeedApproval - signal

1403

1962

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

1404

1963

def NeedApproval(self, timeout, default):

1405

1964

"D-Bus signal"

1406

1965

return self.need_approval()

1407

1408

## Methods

1409

1966

1967

# Methods

1968

1410

1969

# Approve - method

1411

1970

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

1412

1971

def Approve(self, value):

1413

1972

self.approve(value)

1414

1973

1415

1974

# CheckedOK - method

1416

1975

@dbus.service.method(_interface)

1417

1976

def CheckedOK(self):

1418

1977

self.checked_ok()

1419

1978

1420

1979

# Enable - method

1980

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

1421

1981

@dbus.service.method(_interface)

1422

1982

def Enable(self):

1423

1983

"D-Bus method"

1424

1984

self.enable()

1425

1985

1426

1986

# StartChecker - method

1987

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

1427

1988

@dbus.service.method(_interface)

1428

1989

def StartChecker(self):

1429

1990

"D-Bus method"

1430

1991

self.start_checker()

1431

1992

1432

1993

# Disable - method

1994

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

1433

1995

@dbus.service.method(_interface)

1434

1996

def Disable(self):

1435

1997

"D-Bus method"

1436

1998

self.disable()

1437

1999

1438

2000

# StopChecker - method

2001

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

1439

2002

@dbus.service.method(_interface)

1440

2003

def StopChecker(self):

1441

2004

self.stop_checker()

1442

1443

## Properties

1444

2005

2006

# Properties

2007

1445

2008

# ApprovalPending - property

1446

2009

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

1447

2010

def ApprovalPending_dbus_property(self):

1448

2011

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

1449

2012

1450

2013

# ApprovedByDefault - property

1451

@dbus_service_property(_interface, signature="b",

2014

@dbus_service_property(_interface,

2015

signature="b",

1452

2016

access="readwrite")

1453

2017

def ApprovedByDefault_dbus_property(self, value=None):

1454

2018

if value is None: # get

1455

2019

return dbus.Boolean(self.approved_by_default)

1456

2020

self.approved_by_default = bool(value)

1457

2021

1458

2022

# ApprovalDelay - property

1459

@dbus_service_property(_interface, signature="t",

2023

@dbus_service_property(_interface,

2024

signature="t",

1460

2025

access="readwrite")

1461

2026

def ApprovalDelay_dbus_property(self, value=None):

1462

2027

if value is None: # get

1463

2028

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

1464

2029

* 1000)

1465

2030

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

1466

2031

1467

2032

# ApprovalDuration - property

1468

@dbus_service_property(_interface, signature="t",

2033

@dbus_service_property(_interface,

2034

signature="t",

1469

2035

access="readwrite")

1470

2036

def ApprovalDuration_dbus_property(self, value=None):

1471

2037

if value is None: # get

1472

2038

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

1473

2039

* 1000)

1474

2040

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

1475

2041

1476

2042

# Name - property

2043

@dbus_annotations(

2044

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

1477

2045

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

1478

2046

def Name_dbus_property(self):

1479

2047

return dbus.String(self.name)

1480

2048

2049

# KeyID - property

2050

@dbus_annotations(

2051

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

2052

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

2053

def KeyID_dbus_property(self):

2054

return dbus.String(self.key_id)

2055

1481

2056

# Fingerprint - property

2057

@dbus_annotations(

2058

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

1482

2059

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

1483

2060

def Fingerprint_dbus_property(self):

1484

2061

return dbus.String(self.fingerprint)

1485

2062

1486

2063

# Host - property

1487

@dbus_service_property(_interface, signature="s",

2064

@dbus_service_property(_interface,

2065

signature="s",

1488

2066

access="readwrite")

1489

2067

def Host_dbus_property(self, value=None):

1490

2068

if value is None: # get

1491

2069

return dbus.String(self.host)

1492

self.host = unicode(value)

1493

2070

self.host = str(value)

2071

1494

2072

# Created - property

2073

@dbus_annotations(

2074

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

1495

2075

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

1496

2076

def Created_dbus_property(self):

1497

2077

return datetime_to_dbus(self.created)

1498

2078

1499

2079

# LastEnabled - property

1500

2080

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

1501

2081

def LastEnabled_dbus_property(self):

1502

2082

return datetime_to_dbus(self.last_enabled)

1503

2083

1504

2084

# Enabled - property

1505

@dbus_service_property(_interface, signature="b",

2085

@dbus_service_property(_interface,

2086

signature="b",

1506

2087

access="readwrite")

1507

2088

def Enabled_dbus_property(self, value=None):

1508

2089

if value is None: # get

1511

2092

self.enable()

1512

2093

else:

1513

2094

self.disable()

1514

2095

1515

2096

# LastCheckedOK - property

1516

@dbus_service_property(_interface, signature="s",

2097

@dbus_service_property(_interface,

2098

signature="s",

1517

2099

access="readwrite")

1518

2100

def LastCheckedOK_dbus_property(self, value=None):

1519

2101

if value is not None:

1520

2102

self.checked_ok()

1521

2103

return

1522

2104

return datetime_to_dbus(self.last_checked_ok)

1523

2105

1524

2106

# LastCheckerStatus - property

1525

@dbus_service_property(_interface, signature="n",

1526

access="read")

2107

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

1527

2108

def LastCheckerStatus_dbus_property(self):

1528

2109

return dbus.Int16(self.last_checker_status)

1529

2110

1530

2111

# Expires - property

1531

2112

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

1532

2113

def Expires_dbus_property(self):

1533

2114

return datetime_to_dbus(self.expires)

1534

2115

1535

2116

# LastApprovalRequest - property

1536

2117

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

1537

2118

def LastApprovalRequest_dbus_property(self):

1538

2119

return datetime_to_dbus(self.last_approval_request)

1539

2120

1540

2121

# Timeout - property

1541

@dbus_service_property(_interface, signature="t",

2122

@dbus_service_property(_interface,

2123

signature="t",

1542

2124

access="readwrite")

1543

2125

def Timeout_dbus_property(self, value=None):

1544

2126

if value is None: # get

1556

2138

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

1557

2139

is None):

1558

2140

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

2141

GLib.source_remove(self.disable_initiator_tag)

2142

self.disable_initiator_tag = GLib.timeout_add(

2143

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

2144

self.disable)

2145

1565

2146

# ExtendedTimeout - property

1566

@dbus_service_property(_interface, signature="t",

2147

@dbus_service_property(_interface,

2148

signature="t",

1567

2149

access="readwrite")

1568

2150

def ExtendedTimeout_dbus_property(self, value=None):

1569

2151

if value is None: # get

1570

2152

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

1571

2153

* 1000)

1572

2154

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

1573

2155

1574

2156

# Interval - property

1575

@dbus_service_property(_interface, signature="t",

2157

@dbus_service_property(_interface,

2158

signature="t",

1576

2159

access="readwrite")

1577

2160

def Interval_dbus_property(self, value=None):

1578

2161

if value is None: # get

1582

2165

return

1583

2166

if self.enabled:

1584

2167

# 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

2168

GLib.source_remove(self.checker_initiator_tag)

2169

self.checker_initiator_tag = GLib.timeout_add(

2170

value, self.start_checker)

2171

self.start_checker() # Start one now, too

2172

1590

2173

# Checker - property

1591

@dbus_service_property(_interface, signature="s",

2174

@dbus_service_property(_interface,

2175

signature="s",

1592

2176

access="readwrite")

1593

2177

def Checker_dbus_property(self, value=None):

1594

2178

if value is None: # get

1595

2179

return dbus.String(self.checker_command)

1596

self.checker_command = unicode(value)

1597

2180

self.checker_command = str(value)

2181

1598

2182

# CheckerRunning - property

1599

@dbus_service_property(_interface, signature="b",

2183

@dbus_service_property(_interface,

2184

signature="b",

1600

2185

access="readwrite")

1601

2186

def CheckerRunning_dbus_property(self, value=None):

1602

2187

if value is None: # get

1605

2190

self.start_checker()

1606

2191

else:

1607

2192

self.stop_checker()

1608

2193

1609

2194

# ObjectPath - property

2195

@dbus_annotations(

2196

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

2197

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

1610

2198

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

1611

2199

def ObjectPath_dbus_property(self):

1612

return self.dbus_object_path # is already a dbus.ObjectPath

1613

2200

return self.dbus_object_path # is already a dbus.ObjectPath

2201

1614

2202

# Secret = property

1615

@dbus_service_property(_interface, signature="ay",

1616

access="write", byte_arrays=True)

2203

@dbus_annotations(

2204

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

2205

"invalidates"})

2206

@dbus_service_property(_interface,

2207

signature="ay",

2208

access="write",

2209

byte_arrays=True)

1617

2210

def Secret_dbus_property(self, value):

1618

self.secret = str(value)

1619

2211

self.secret = bytes(value)

2212

1620

2213

del _interface

1621

2214

1622

2215

1623

2216

class ProxyClient(object):

1624

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

2217

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

1625

2218

self._pipe = child_pipe

1626

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

2219

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

1627

2220

if not self._pipe.recv():

1628

raise KeyError()

1629

2221

raise KeyError(key_id or fpr)

2222

1630

2223

def __getattribute__(self, name):

1631

2224

if name == '_pipe':

1632

2225

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

1635

2228

if data[0] == 'data':

1636

2229

return data[1]

1637

2230

if data[0] == 'function':

2231

1638

2232

def func(*args, **kwargs):

1639

2233

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

1640

2234

return self._pipe.recv()[1]

2235

1641

2236

return func

1642

2237

1643

2238

def __setattr__(self, name, value):

1644

2239

if name == '_pipe':

1645

2240

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

1648

2243

1649

2244

class ClientHandler(socketserver.BaseRequestHandler, object):

1650

2245

"""A class to handle client connections.

1651

2246

1652

2247

Instantiated once for each connection to handle it.

1653

2248

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

1654

2249

1655

2250

def handle(self):

1656

2251

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

1657

2252

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

1658

unicode(self.client_address))

2253

str(self.client_address))

1659

2254

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

1660

2255

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

2256

2257

session = gnutls.ClientSession(self.request)

2258

2259

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

2260

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

2261

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

2262

# "+DHE-DSS"))

1676

2263

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

1677

2264

priority = self.server.gnutls_priority

1678

2265

if priority is None:

1679

2266

priority = "NORMAL"

1680

(gnutls.library.functions

1681

.gnutls_priority_set_direct(session._c_object,

1682

priority, None))

1683

2267

gnutls.priority_set_direct(session._c_object,

2268

priority.encode("utf-8"),

2269

None)

2270

1684

2271

# Start communication using the Mandos protocol

1685

2272

# Get protocol number

1686

2273

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

1691

2278

except (ValueError, IndexError, RuntimeError) as error:

1692

2279

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

1693

2280

return

1694

2281

1695

2282

# Start GnuTLS connection

1696

2283

try:

1697

2284

session.handshake()

1698

except gnutls.errors.GNUTLSError as error:

2285

except gnutls.Error as error:

1699

2286

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

1700

2287

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

1701

2288

# established. Just abandon the request.

1702

2289

return

1703

2290

logger.debug("Handshake succeeded")

1704

2291

1705

2292

approval_required = False

1706

2293

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,

2294

if gnutls.has_rawpk:

2295

fpr = b""

2296

try:

2297

key_id = self.key_id(

2298

self.peer_certificate(session))

2299

except (TypeError, gnutls.Error) as error:

2300

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

2301

return

2302

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

2303

2304

else:

2305

key_id = b""

2306

try:

2307

fpr = self.fingerprint(

2308

self.peer_certificate(session))

2309

except (TypeError, gnutls.Error) as error:

2310

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

2311

return

2312

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

2313

2314

try:

2315

client = ProxyClient(child_pipe, key_id, fpr,

1718

2316

self.client_address)

1719

2317

except KeyError:

1720

2318

return

1721

2319

1722

2320

if client.approval_delay:

1723

2321

delay = client.approval_delay

1724

2322

client.approvals_pending += 1

1725

2323

approval_required = True

1726

2324

1727

2325

while True:

1728

2326

if not client.enabled:

1729

2327

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

1730

client.name)

2328

client.name)

1731

2329

if self.server.use_dbus:

1732

2330

# Emit D-Bus signal

1733

2331

client.Rejected("Disabled")

1734

2332

return

1735

2333

1736

2334

if client.approved or not client.approval_delay:

1737

#We are approved or approval is disabled

2335

# We are approved or approval is disabled

1738

2336

break

1739

2337

elif client.approved is None:

1740

2338

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

1751

2349

# Emit D-Bus signal

1752

2350

client.Rejected("Denied")

1753

2351

return

1754

1755

#wait until timeout or approved

2352

2353

# wait until timeout or approved

1756

2354

time = datetime.datetime.now()

1757

2355

client.changedstate.acquire()

1758

2356

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

1771

2369

break

1772

2370

else:

1773

2371

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

2372

2373

try:

2374

session.send(client.secret)

2375

except gnutls.Error as error:

2376

logger.warning("gnutls send failed",

2377

exc_info=error)

2378

return

2379

1788

2380

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

1789

2381

# bump the timeout using extended_timeout

1790

2382

client.bump_timeout(client.extended_timeout)

1791

2383

if self.server.use_dbus:

1792

2384

# Emit D-Bus signal

1793

2385

client.GotSecret()

1794

2386

1795

2387

finally:

1796

2388

if approval_required:

1797

2389

client.approvals_pending -= 1

1798

2390

try:

1799

2391

session.bye()

1800

except gnutls.errors.GNUTLSError as error:

2392

except gnutls.Error as error:

1801

2393

logger.warning("GnuTLS bye failed",

1802

2394

exc_info=error)

1803

2395

1804

2396

@staticmethod

1805

2397

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

2398

"Return the peer's certificate as a bytestring"

2399

try:

2400

cert_type = gnutls.certificate_type_get2(session._c_object,

2401

gnutls.CTYPE_PEERS)

2402

except AttributeError:

2403

cert_type = gnutls.certificate_type_get(session._c_object)

2404

if gnutls.has_rawpk:

2405

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2406

else:

2407

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2408

# If not a valid certificate type...

2409

if cert_type not in valid_cert_types:

2410

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

2411

valid_cert_types)

2412

# ...return invalid data

2413

return b""

1813

2414

list_size = ctypes.c_uint(1)

1814

cert_list = (gnutls.library.functions

1815

.gnutls_certificate_get_peers

2415

cert_list = (gnutls.certificate_get_peers

1816

2416

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

1817

2417

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

1818

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

1819

" certificate")

2418

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

1820

2419

if list_size.value == 0:

1821

2420

return None

1822

2421

cert = cert_list[0]

1823

2422

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

1824

2423

2424

@staticmethod

2425

def key_id(certificate):

2426

"Convert a certificate bytestring to a hexdigit key ID"

2427

# New GnuTLS "datum" with the public key

2428

datum = gnutls.datum_t(

2429

ctypes.cast(ctypes.c_char_p(certificate),

2430

ctypes.POINTER(ctypes.c_ubyte)),

2431

ctypes.c_uint(len(certificate)))

2432

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

2433

# New empty GnuTLS certificate

2434

pubkey = gnutls.pubkey_t()

2435

gnutls.pubkey_init(ctypes.byref(pubkey))

2436

# Import the raw public key into the certificate

2437

gnutls.pubkey_import(pubkey,

2438

ctypes.byref(datum),

2439

gnutls.X509_FMT_DER)

2440

# New buffer for the key ID

2441

buf = ctypes.create_string_buffer(32)

2442

buf_len = ctypes.c_size_t(len(buf))

2443

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

2444

gnutls.pubkey_get_key_id(pubkey,

2445

gnutls.KEYID_USE_SHA256,

2446

ctypes.cast(ctypes.byref(buf),

2447

ctypes.POINTER(ctypes.c_ubyte)),

2448

ctypes.byref(buf_len))

2449

# Deinit the certificate

2450

gnutls.pubkey_deinit(pubkey)

2451

2452

# Convert the buffer to a Python bytestring

2453

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

2454

# Convert the bytestring to hexadecimal notation

2455

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

2456

return hex_key_id

2457

1825

2458

@staticmethod

1826

2459

def fingerprint(openpgp):

1827

2460

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1828

2461

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

2462

datum = gnutls.datum_t(

2463

ctypes.cast(ctypes.c_char_p(openpgp),

2464

ctypes.POINTER(ctypes.c_ubyte)),

2465

ctypes.c_uint(len(openpgp)))

1834

2466

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

2467

crt = gnutls.openpgp_crt_t()

2468

gnutls.openpgp_crt_init(ctypes.byref(crt))

1838

2469

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

2470

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

2471

gnutls.OPENPGP_FMT_RAW)

1843

2472

# Verify the self signature in the key

1844

2473

crtverify = ctypes.c_uint()

1845

(gnutls.library.functions

1846

.gnutls_openpgp_crt_verify_self(crt, 0,

1847

ctypes.byref(crtverify)))

2474

gnutls.openpgp_crt_verify_self(crt, 0,

2475

ctypes.byref(crtverify))

1848

2476

if crtverify.value != 0:

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1850

raise (gnutls.errors.CertificateSecurityError

1851

("Verify failed"))

2477

gnutls.openpgp_crt_deinit(crt)

2478

raise gnutls.CertificateSecurityError(code

2479

=crtverify.value)

1852

2480

# New buffer for the fingerprint

1853

2481

buf = ctypes.create_string_buffer(20)

1854

2482

buf_len = ctypes.c_size_t()

1855

2483

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

2484

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

2485

ctypes.byref(buf_len))

1859

2486

# Deinit the certificate

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2487

gnutls.openpgp_crt_deinit(crt)

1861

2488

# Convert the buffer to a Python bytestring

1862

2489

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

1863

2490

# Convert the bytestring to hexadecimal notation

1867

2494

1868

2495

class MultiprocessingMixIn(object):

1869

2496

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

2497

1870

2498

def sub_process_main(self, request, address):

1871

2499

try:

1872

2500

self.finish_request(request, address)

1873

2501

except Exception:

1874

2502

self.handle_error(request, address)

1875

2503

self.close_request(request)

1876

2504

1877

2505

def process_request(self, request, address):

1878

2506

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

1879

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

1880

args = (request, address))

2507

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

2508

args=(request, address))

1881

2509

proc.start()

1882

2510

return proc

1883

2511

1884

2512

1885

2513

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1886

2514

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

2515

1887

2516

def process_request(self, request, client_address):

1888

2517

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

1889

2518

1890

2519

This function creates a new pipe in self.pipe

1891

2520

"""

1892

2521

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1893

2522

1894

2523

proc = MultiprocessingMixIn.process_request(self, request,

1895

2524

client_address)

1896

2525

self.child_pipe.close()

1897

2526

self.add_pipe(parent_pipe, proc)

1898

2527

1899

2528

def add_pipe(self, parent_pipe, proc):

1900

2529

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

1901

2530

raise NotImplementedError()

1904

2533

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1905

2534

socketserver.TCPServer, object):

1906

2535

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

1907

2536

1908

2537

Attributes:

1909

2538

enabled: Boolean; whether this server is activated yet

1910

2539

interface: None or a network interface name (string)

1911

2540

use_ipv6: Boolean; to use IPv6 or not

1912

2541

"""

2542

1913

2543

def __init__(self, server_address, RequestHandlerClass,

1914

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

2544

interface=None,

2545

use_ipv6=True,

2546

socketfd=None):

1915

2547

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

1916

2548

creating a new one with socket.socket().

1917

2549

"""

1923

2555

self.socketfd = socketfd

1924

2556

# Save the original socket.socket() function

1925

2557

self.socket_socket = socket.socket

2558

1926

2559

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

1927

#

2560

#

1928

2561

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

1929

2562

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

1930

2563

# patching socket.socket.)

1931

#

2564

#

1932

2565

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

1933

2566

@functools.wraps(socket.socket)

1934

2567

def socket_wrapper(*args, **kwargs):

1946

2579

# socket_wrapper(), if socketfd was set.

1947

2580

socketserver.TCPServer.__init__(self, server_address,

1948

2581

RequestHandlerClass)

1949

2582

1950

2583

def server_bind(self):

1951

2584

"""This overrides the normal server_bind() function

1952

2585

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

1953

2586

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

2587

global SO_BINDTODEVICE

1954

2588

if self.interface is not None:

1955

2589

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

2590

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

2591

# common enough.

2592

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

2593

SO_BINDTODEVICE = 25

2594

try:

2595

self.socket.setsockopt(

2596

socket.SOL_SOCKET, SO_BINDTODEVICE,

2597

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

2598

except socket.error as error:

2599

if error.errno == errno.EPERM:

2600

logger.error("No permission to bind to"

2601

" interface %s", self.interface)

2602

elif error.errno == errno.ENOPROTOOPT:

2603

logger.error("SO_BINDTODEVICE not available;"

2604

" cannot bind to interface %s",

2605

self.interface)

2606

elif error.errno == errno.ENODEV:

2607

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

2608

" cannot bind", self.interface)

2609

else:

2610

raise

1977

2611

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

1978

2612

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

2613

if self.server_address[1]:

2614

self.allow_reuse_address = True

1979

2615

if not self.server_address[0]:

1980

2616

if self.address_family == socket.AF_INET6:

1981

any_address = "::" # in6addr_any

2617

any_address = "::" # in6addr_any

1982

2618

else:

1983

any_address = "0.0.0.0" # INADDR_ANY

2619

any_address = "0.0.0.0" # INADDR_ANY

1984

2620

self.server_address = (any_address,

1985

2621

self.server_address[1])

1986

2622

elif not self.server_address[1]:

1987

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

1988

0)

2623

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

1989

2624

# if self.interface:

1990

2625

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

1991

2626

# 0, # port

1997

2632

1998

2633

class MandosServer(IPv6_TCPServer):

1999

2634

"""Mandos server.

2000

2635

2001

2636

Attributes:

2002

2637

clients: set of Client objects

2003

2638

gnutls_priority GnuTLS priority string

2004

2639

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

2005

2006

Assumes a gobject.MainLoop event loop.

2640

2641

Assumes a GLib.MainLoop event loop.

2007

2642

"""

2643

2008

2644

def __init__(self, server_address, RequestHandlerClass,

2009

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

2010

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

2645

interface=None,

2646

use_ipv6=True,

2647

clients=None,

2648

gnutls_priority=None,

2649

use_dbus=True,

2650

socketfd=None):

2011

2651

self.enabled = False

2012

2652

self.clients = clients

2013

2653

if self.clients is None:

2016

2656

self.gnutls_priority = gnutls_priority

2017

2657

IPv6_TCPServer.__init__(self, server_address,

2018

2658

RequestHandlerClass,

2019

interface = interface,

2020

use_ipv6 = use_ipv6,

2021

socketfd = socketfd)

2659

interface=interface,

2660

use_ipv6=use_ipv6,

2661

socketfd=socketfd)

2662

2022

2663

def server_activate(self):

2023

2664

if self.enabled:

2024

2665

return socketserver.TCPServer.server_activate(self)

2025

2666

2026

2667

def enable(self):

2027

2668

self.enabled = True

2028

2669

2029

2670

def add_pipe(self, parent_pipe, proc):

2030

2671

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

2672

GLib.io_add_watch(

2673

parent_pipe.fileno(),

2674

GLib.IO_IN | GLib.IO_HUP,

2675

functools.partial(self.handle_ipc,

2676

parent_pipe=parent_pipe,

2677

proc=proc))

2678

2679

def handle_ipc(self, source, condition,

2680

parent_pipe=None,

2681

proc=None,

2682

client_object=None):

2040

2683

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

2041

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

2684

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

2042

2685

# Wait for other process to exit

2043

2686

proc.join()

2044

2687

return False

2045

2688

2046

2689

# Read a request from the child

2047

2690

request = parent_pipe.recv()

2048

2691

command = request[0]

2049

2692

2050

2693

if command == 'init':

2051

fpr = request[1]

2052

address = request[2]

2053

2054

for c in self.clients.itervalues():

2055

if c.fingerprint == fpr:

2694

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

2695

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

2696

address = request[3]

2697

2698

for c in self.clients.values():

2699

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2700

continue

2701

if key_id and c.key_id == key_id:

2702

client = c

2703

break

2704

if fpr and c.fingerprint == fpr:

2056

2705

client = c

2057

2706

break

2058

2707

else:

2059

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

2060

"dress: %s", fpr, address)

2708

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

2709

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

2061

2710

if self.use_dbus:

2062

2711

# Emit D-Bus signal

2063

mandos_dbus_service.ClientNotFound(fpr,

2712

mandos_dbus_service.ClientNotFound(key_id or fpr,

2064

2713

address[0])

2065

2714

parent_pipe.send(False)

2066

2715

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

2716

2717

GLib.io_add_watch(

2718

parent_pipe.fileno(),

2719

GLib.IO_IN | GLib.IO_HUP,

2720

functools.partial(self.handle_ipc,

2721

parent_pipe=parent_pipe,

2722

proc=proc,

2723

client_object=client))

2076

2724

parent_pipe.send(True)

2077

2725

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

2078

2726

# same fileno

2081

2729

funcname = request[1]

2082

2730

args = request[2]

2083

2731

kwargs = request[3]

2084

2732

2085

2733

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

2086

2734

funcname)(*args,

2087

**kwargs)))

2088

2735

**kwargs)))

2736

2089

2737

if command == 'getattr':

2090

2738

attrname = request[1]

2091

if callable(client_object.__getattribute__(attrname)):

2092

parent_pipe.send(('function',))

2739

if isinstance(client_object.__getattribute__(attrname),

2740

collections.Callable):

2741

parent_pipe.send(('function', ))

2093

2742

else:

2094

parent_pipe.send(('data', client_object

2095

.__getattribute__(attrname)))

2096

2743

parent_pipe.send((

2744

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

2745

2097

2746

if command == 'setattr':

2098

2747

attrname = request[1]

2099

2748

value = request[2]

2100

2749

setattr(client_object, attrname, value)

2101

2750

2102

2751

return True

2103

2752

2104

2753

2105

2754

def rfc3339_duration_to_delta(duration):

2106

2755

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

2107

2756

2108

2757

>>> rfc3339_duration_to_delta("P7D")

2109

2758

datetime.timedelta(7)

2110

2759

>>> rfc3339_duration_to_delta("PT60S")

2120

2769

>>> rfc3339_duration_to_delta("P1DT3M20S")

2121

2770

datetime.timedelta(1, 200)

2122

2771

"""

2123

2772

2124

2773

# Parsing an RFC 3339 duration with regular expressions is not

2125

2774

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

2126

2775

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

2127

2776

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

2128

2777

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

2129

2778

# avoid excessive use of external libraries.

2130

2779

2131

2780

# 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

2781

Token = collections.namedtuple("Token", (

2782

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

2783

# a "group" containing digits

2784

"value", # datetime.timedelta or None

2785

"followers")) # Tokens valid after this token

2141

2786

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

2142

2787

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

2143

2788

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

2144

2789

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

2145

2790

datetime.timedelta(seconds=1),

2146

frozenset((token_end,)))

2791

frozenset((token_end, )))

2147

2792

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

2148

2793

datetime.timedelta(minutes=1),

2149

2794

frozenset((token_second, token_end)))

2165

2810

frozenset((token_month, token_end)))

2166

2811

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

2167

2812

datetime.timedelta(weeks=1),

2168

frozenset((token_end,)))

2813

frozenset((token_end, )))

2169

2814

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

2170

2815

frozenset((token_year, token_month,

2171

2816

token_day, token_time,

2172

2817

token_week)))

2173

# Define starting values

2174

value = datetime.timedelta() # Value so far

2818

# Define starting values:

2819

# Value so far

2820

value = datetime.timedelta()

2175

2821

found_token = None

2176

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

2177

s = duration # String left to parse

2822

# Following valid tokens

2823

followers = frozenset((token_duration, ))

2824

# String left to parse

2825

s = duration

2178

2826

# Loop until end token is found

2179

2827

while found_token is not token_end:

2180

2828

# Search for any currently valid tokens

2196

2844

break

2197

2845

else:

2198

2846

# No currently valid tokens were found

2199

raise ValueError("Invalid RFC 3339 duration")

2847

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

2848

.format(duration))

2200

2849

# End token found

2201

2850

return value

2202

2851

2203

2852

2204

2853

def string_to_delta(interval):

2205

2854

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

2206

2855

2207

2856

>>> string_to_delta('7d')

2208

2857

datetime.timedelta(7)

2209

2858

>>> string_to_delta('60s')

2217

2866

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

2218

2867

datetime.timedelta(0, 330)

2219

2868

"""

2220

2869

2221

2870

try:

2222

2871

return rfc3339_duration_to_delta(interval)

2223

2872

except ValueError:

2224

2873

pass

2225

2874

2226

2875

timevalue = datetime.timedelta(0)

2227

2876

for s in interval.split():

2228

2877

try:

2229

suffix = unicode(s[-1])

2878

suffix = s[-1]

2230

2879

value = int(s[:-1])

2231

2880

if suffix == "d":

2232

2881

delta = datetime.timedelta(value)

2239

2888

elif suffix == "w":

2240

2889

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

2241

2890

else:

2242

raise ValueError("Unknown suffix {!r}"

2243

.format(suffix))

2891

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

2244

2892

except IndexError as e:

2245

2893

raise ValueError(*(e.args))

2246

2894

timevalue += delta

2247

2895

return timevalue

2248

2896

2249

2897

2250

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

2898

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

2251

2899

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

2252

2900

2253

2901

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

2254

2902

if os.fork():

2255

2903

sys.exit()

2262

2910

# Close all standard open file descriptors

2263

2911

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

2264

2912

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

2265

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

2913

raise OSError(errno.ENODEV,

2914

"{} not a character device"

2266

2915

.format(os.devnull))

2267

2916

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

2268

2917

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

2272

2921

2273

2922

2274

2923

def main():

2275

2924

2276

2925

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

2277

2926

# Parsing of options, both command line and config file

2278

2927

2279

2928

parser = argparse.ArgumentParser()

2280

2929

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

2281

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

2930

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

2282

2931

help="show version number and exit")

2283

2932

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

2284

2933

help="Bind to interface IF")

2320

2969

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

2321

2970

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

2322

2971

default=None)

2323

2972

2324

2973

options = parser.parse_args()

2325

2974

2326

2975

if options.check:

2327

2976

import doctest

2328

2977

fail_count, test_count = doctest.testmod()

2329

2978

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

2330

2979

2331

2980

# 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

2981

if gnutls.has_rawpk:

2982

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

2983

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

2984

else:

2985

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

2986

":+SIGN-DSA-SHA256")

2987

server_defaults = {"interface": "",

2988

"address": "",

2989

"port": "",

2990

"debug": "False",

2991

"priority": priority,

2992

"servicename": "Mandos",

2993

"use_dbus": "True",

2994

"use_ipv6": "True",

2995

"debuglevel": "",

2996

"restore": "True",

2997

"socket": "",

2998

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

2999

"foreground": "False",

3000

"zeroconf": "True",

3001

}

3002

del priority

3003

2349

3004

# Parse config file for server-global settings

2350

server_config = configparser.SafeConfigParser(server_defaults)

3005

server_config = configparser.ConfigParser(server_defaults)

2351

3006

del server_defaults

2352

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

2353

"mandos.conf"))

2354

# Convert the SafeConfigParser object to a dict

3007

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

3008

# Convert the ConfigParser object to a dict

2355

3009

server_settings = server_config.defaults()

2356

3010

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

2357

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

3011

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

3012

"foreground", "zeroconf"):

2358

3013

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

2359

3014

option)

2360

3015

if server_settings["port"]:

2370

3025

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

2371

3026

["socket"])

2372

3027

del server_config

2373

3028

2374

3029

# Override the settings from the config file with command line

2375

3030

# options, if set.

2376

3031

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

2377

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

2378

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

2379

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

3032

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

3033

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

3034

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

2380

3035

value = getattr(options, option)

2381

3036

if value is not None:

2382

3037

server_settings[option] = value

2383

3038

del options

2384

3039

# Force all strings to be unicode

2385

3040

for option in server_settings.keys():

2386

if type(server_settings[option]) is str:

2387

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

3041

if isinstance(server_settings[option], bytes):

3042

server_settings[option] = (server_settings[option]

3043

.decode("utf-8"))

2388

3044

# Force all boolean options to be boolean

2389

3045

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

2390

3046

"foreground", "zeroconf"):

2393

3049

if server_settings["debug"]:

2394

3050

server_settings["foreground"] = True

2395

3051

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

2396

3052

2397

3053

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

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

3054

3055

if (not server_settings["zeroconf"]

3056

and not (server_settings["port"]

3057

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

3058

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

3059

2405

3060

# For convenience

2406

3061

debug = server_settings["debug"]

2407

3062

debuglevel = server_settings["debuglevel"]

2411

3066

stored_state_file)

2412

3067

foreground = server_settings["foreground"]

2413

3068

zeroconf = server_settings["zeroconf"]

2414

3069

2415

3070

if debug:

2416

3071

initlogger(debug, logging.DEBUG)

2417

3072

else:

2420

3075

else:

2421

3076

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

2422

3077

initlogger(debug, level)

2423

3078

2424

3079

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

3080

syslogger.setFormatter(

3081

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

3082

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

3083

server_settings["servicename"])))

3084

2431

3085

# Parse config file with clients

2432

client_config = configparser.SafeConfigParser(Client

2433

.client_defaults)

3086

client_config = configparser.ConfigParser(Client.client_defaults)

2434

3087

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

2435

3088

"clients.conf"))

2436

3089

2437

3090

global mandos_dbus_service

2438

3091

mandos_dbus_service = None

2439

3092

2440

3093

socketfd = None

2441

3094

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

2442

3095

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)

3096

tcp_server = MandosServer(

3097

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

3098

ClientHandler,

3099

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

3100

use_ipv6=use_ipv6,

3101

gnutls_priority=server_settings["priority"],

3102

use_dbus=use_dbus,

3103

socketfd=socketfd)

2453

3104

if not foreground:

2454

3105

pidfilename = "/run/mandos.pid"

2455

3106

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

2456

3107

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

2457

3108

pidfile = None

2458

3109

try:

2459

pidfile = open(pidfilename, "w")

3110

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

2460

3111

except IOError as e:

2461

3112

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

2462

3113

exc_info=e)

2463

2464

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

3114

3115

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

3116

("mandos", "mandos"),

3117

("nobody", "nogroup")):

2465

3118

try:

2466

3119

uid = pwd.getpwnam(name).pw_uid

2467

gid = pwd.getpwnam(name).pw_gid

3120

gid = pwd.getpwnam(group).pw_gid

2468

3121

break

2469

3122

except KeyError:

2470

3123

continue

2474

3127

try:

2475

3128

os.setgid(gid)

2476

3129

os.setuid(uid)

3130

if debug:

3131

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

3132

gid))

2477

3133

except OSError as error:

3134

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

3135

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

2478

3136

if error.errno != errno.EPERM:

2479

3137

raise

2480

3138

2481

3139

if debug:

2482

3140

# Enable all possible GnuTLS debugging

2483

3141

2484

3142

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

2485

3143

# - GnuTLS manual

2486

gnutls.library.functions.gnutls_global_set_log_level(11)

2487

2488

@gnutls.library.types.gnutls_log_func

3144

gnutls.global_set_log_level(11)

3145

3146

@gnutls.log_func

2489

3147

def debug_gnutls(level, string):

2490

3148

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

2491

2492

(gnutls.library.functions

2493

.gnutls_global_set_log_function(debug_gnutls))

2494

3149

3150

gnutls.global_set_log_function(debug_gnutls)

3151

2495

3152

# Redirect stdin so all checkers get /dev/null

2496

3153

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

2497

3154

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

2498

3155

if null > 2:

2499

3156

os.close(null)

2500

3157

2501

3158

# Need to fork before connecting to D-Bus

2502

3159

if not foreground:

2503

3160

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

2504

3161

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

3162

3163

if gi.version_info < (3, 10, 2):

3164

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

3165

# need to inform GLib that threads will be used.

3166

GLib.threads_init()

3167

2510

3168

global main_loop

2511

3169

# From the Avahi example code

2512

3170

DBusGMainLoop(set_as_default=True)

2513

main_loop = gobject.MainLoop()

3171

main_loop = GLib.MainLoop()

2514

3172

bus = dbus.SystemBus()

2515

3173

# End of Avahi example code

2516

3174

if use_dbus:

2517

3175

try:

2518

3176

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:

3177

bus,

3178

do_not_queue=True)

3179

old_bus_name = dbus.service.BusName(

3180

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

3181

do_not_queue=True)

3182

except dbus.exceptions.DBusException as e:

2524

3183

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

2525

3184

use_dbus = False

2526

3185

server_settings["use_dbus"] = False

2527

3186

tcp_server.use_dbus = False

2528

3187

if zeroconf:

2529

3188

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)

3189

service = AvahiServiceToSyslog(

3190

name=server_settings["servicename"],

3191

servicetype="_mandos._tcp",

3192

protocol=protocol,

3193

bus=bus)

2534

3194

if server_settings["interface"]:

2535

service.interface = (if_nametoindex

2536

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

2537

3195

service.interface = if_nametoindex(

3196

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

3197

2538

3198

global multiprocessing_manager

2539

3199

multiprocessing_manager = multiprocessing.Manager()

2540

3200

2541

3201

client_class = Client

2542

3202

if use_dbus:

2543

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

2544

3203

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

3204

2545

3205

client_settings = Client.config_parser(client_config)

2546

3206

old_client_settings = {}

2547

3207

clients_data = {}

2548

3208

2549

3209

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

2550

3210

global wnull

2551

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

3211

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

2552

3212

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

2553

3213

# mode

2554

3214

if debug or not foreground:

2555

3215

wnull.close()

2556

3216

2557

3217

# Get client data and settings from last running state.

2558

3218

if server_settings["restore"]:

2559

3219

try:

2560

3220

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

2561

clients_data, old_client_settings = (pickle.load

2562

(stored_state))

3221

if sys.version_info.major == 2:

3222

clients_data, old_client_settings = pickle.load(

3223

stored_state)

3224

else:

3225

bytes_clients_data, bytes_old_client_settings = (

3226

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

3227

# Fix bytes to strings

3228

# clients_data

3229

# .keys()

3230

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

3231

if isinstance(key, bytes)

3232

else key): value

3233

for key, value in

3234

bytes_clients_data.items()}

3235

del bytes_clients_data

3236

for key in clients_data:

3237

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

3238

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

3239

for k, v in

3240

clients_data[key].items()}

3241

clients_data[key] = value

3242

# .client_structure

3243

value["client_structure"] = [

3244

(s.decode("utf-8")

3245

if isinstance(s, bytes)

3246

else s) for s in

3247

value["client_structure"]]

3248

# .name & .host

3249

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

3250

if isinstance(value[k], bytes):

3251

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

3252

if "key_id" not in value:

3253

value["key_id"] = ""

3254

elif "fingerprint" not in value:

3255

value["fingerprint"] = ""

3256

# old_client_settings

3257

# .keys()

3258

old_client_settings = {

3259

(key.decode("utf-8")

3260

if isinstance(key, bytes)

3261

else key): value

3262

for key, value in

3263

bytes_old_client_settings.items()}

3264

del bytes_old_client_settings

3265

# .host

3266

for value in old_client_settings.values():

3267

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

3268

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

3269

.decode("utf-8"))

2563

3270

os.remove(stored_state_path)

2564

3271

except IOError as e:

2565

3272

if e.errno == errno.ENOENT:

2566

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

2567

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

3273

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

3274

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

2568

3275

else:

2569

3276

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

2570

3277

exc_info=e)

2571

3278

raise

2572

3279

except EOFError as e:

2573

3280

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

2574

"EOFError:", exc_info=e)

2575

3281

"EOFError:",

3282

exc_info=e)

3283

2576

3284

with PGPEngine() as pgp:

2577

3285

for client_name, client in clients_data.items():

2578

3286

# Skip removed clients

2579

3287

if client_name not in client_settings:

2580

3288

continue

2581

3289

2582

3290

# Decide which value to use after restoring saved state.

2583

3291

# We have three different values: Old config file,

2584

3292

# new config file, and saved state.

2589

3297

# For each value in new config, check if it

2590

3298

# differs from the old config value (Except for

2591

3299

# the "secret" attribute)

2592

if (name != "secret" and

2593

value != old_client_settings[client_name]

2594

[name]):

3300

if (name != "secret"

3301

and (value !=

3302

old_client_settings[client_name][name])):

2595

3303

client[name] = value

2596

3304

except KeyError:

2597

3305

pass

2598

3306

2599

3307

# Clients who has passed its expire date can still be

2600

# enabled if its last checker was successful. Clients

3308

# enabled if its last checker was successful. A Client

2601

3309

# whose checker succeeded before we stored its state is

2602

3310

# assumed to have successfully run all checkers during

2603

3311

# downtime.

2606

3314

if not client["last_checked_ok"]:

2607

3315

logger.warning(

2608

3316

"disabling client {} - Client never "

2609

"performed a successful checker"

2610

.format(client_name))

3317

"performed a successful checker".format(

3318

client_name))

2611

3319

client["enabled"] = False

2612

3320

elif client["last_checker_status"] != 0:

2613

3321

logger.warning(

2614

3322

"disabling client {} - Client last"

2615

" checker failed with error code {}"

2616

.format(client_name,

2617

client["last_checker_status"]))

3323

" checker failed with error code"

3324

" {}".format(

3325

client_name,

3326

client["last_checker_status"]))

2618

3327

client["enabled"] = False

2619

3328

else:

2620

client["expires"] = (datetime.datetime

2621

.utcnow()

2622

+ client["timeout"])

3329

client["expires"] = (

3330

datetime.datetime.utcnow()

3331

+ client["timeout"])

2623

3332

logger.debug("Last checker succeeded,"

2624

" keeping {} enabled"

2625

.format(client_name))

3333

" keeping {} enabled".format(

3334

client_name))

2626

3335

try:

2627

client["secret"] = (

2628

pgp.decrypt(client["encrypted_secret"],

2629

client_settings[client_name]

2630

["secret"]))

3336

client["secret"] = pgp.decrypt(

3337

client["encrypted_secret"],

3338

client_settings[client_name]["secret"])

2631

3339

except PGPError:

2632

3340

# 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

3341

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

3342

client_name))

3343

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

3344

["secret"])

3345

2638

3346

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

2639

3347

for client_name in (set(old_client_settings)

2640

3348

- set(client_settings)):

2642

3350

for client_name in (set(client_settings)

2643

3351

- set(old_client_settings)):

2644

3352

clients_data[client_name] = client_settings[client_name]

2645

3353

2646

3354

# Create all client objects

2647

3355

for client_name, client in clients_data.items():

2648

3356

tcp_server.clients[client_name] = client_class(

2649

name = client_name, settings = client,

2650

server_settings = server_settings)

2651

3357

name=client_name,

3358

settings=client,

3359

server_settings=server_settings)

3360

2652

3361

if not tcp_server.clients:

2653

3362

logger.warning("No clients defined")

2654

3363

2655

3364

if not foreground:

2656

3365

if pidfile is not None:

3366

pid = os.getpid()

2657

3367

try:

2658

3368

with pidfile:

2659

pid = os.getpid()

2660

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

3369

print(pid, file=pidfile)

2661

3370

except IOError:

2662

3371

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

2663

3372

pidfilename, pid)

2664

3373

del pidfile

2665

3374

del pidfilename

2666

2667

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

2668

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

2669

3375

3376

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

3377

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3378

lambda: main_loop.quit() and False)

3379

2670

3380

if use_dbus:

2671

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

2672

"se.bsnet.fukt.Mandos"})

2673

class MandosDBusService(DBusObjectWithProperties):

3381

3382

@alternate_dbus_interfaces(

3383

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

3384

class MandosDBusService(DBusObjectWithObjectManager):

2674

3385

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

3386

2675

3387

def __init__(self):

2676

3388

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

3389

2677

3390

_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

3391

2685

3392

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

2686

3393

def ClientAdded(self, objpath):

2687

3394

"D-Bus signal"

2688

3395

pass

2689

3396

2690

3397

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

2691

def ClientNotFound(self, fingerprint, address):

3398

def ClientNotFound(self, key_id, address):

2692

3399

"D-Bus signal"

2693

3400

pass

2694

3401

3402

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

3403

"true"})

2695

3404

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

2696

3405

def ClientRemoved(self, objpath, name):

2697

3406

"D-Bus signal"

2698

3407

pass

2699

3408

3409

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

3410

"true"})

2700

3411

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

2701

3412

def GetAllClients(self):

2702

3413

"D-Bus method"

2703

return dbus.Array(c.dbus_object_path

2704

for c in

2705

tcp_server.clients.itervalues())

2706

3414

return dbus.Array(c.dbus_object_path for c in

3415

tcp_server.clients.values())

3416

3417

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

3418

"true"})

2707

3419

@dbus.service.method(_interface,

2708

3420

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

2709

3421

def GetAllClientsWithProperties(self):

2710

3422

"D-Bus method"

2711

3423

return dbus.Dictionary(

2712

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

2713

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

3424

{c.dbus_object_path: c.GetAll(

3425

"se.recompile.Mandos.Client")

3426

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

2714

3427

signature="oa{sv}")

2715

3428

2716

3429

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

2717

3430

def RemoveClient(self, object_path):

2718

3431

"D-Bus method"

2719

for c in tcp_server.clients.itervalues():

3432

for c in tcp_server.clients.values():

2720

3433

if c.dbus_object_path == object_path:

2721

3434

del tcp_server.clients[c.name]

2722

3435

c.remove_from_connection()

2723

# Don't signal anything except ClientRemoved

3436

# Don't signal the disabling

2724

3437

c.disable(quiet=True)

2725

# Emit D-Bus signal

2726

self.ClientRemoved(object_path, c.name)

3438

# Emit D-Bus signal for removal

3439

self.client_removed_signal(c)

2727

3440

return

2728

3441

raise KeyError(object_path)

2729

3442

2730

3443

del _interface

2731

3444

3445

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3446

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

3447

def GetManagedObjects(self):

3448

"""D-Bus method"""

3449

return dbus.Dictionary(

3450

{client.dbus_object_path:

3451

dbus.Dictionary(

3452

{interface: client.GetAll(interface)

3453

for interface in

3454

client._get_all_interface_names()})

3455

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

3456

3457

def client_added_signal(self, client):

3458

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

3459

if use_dbus:

3460

# New standard signal

3461

self.InterfacesAdded(

3462

client.dbus_object_path,

3463

dbus.Dictionary(

3464

{interface: client.GetAll(interface)

3465

for interface in

3466

client._get_all_interface_names()}))

3467

# Old signal

3468

self.ClientAdded(client.dbus_object_path)

3469

3470

def client_removed_signal(self, client):

3471

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

3472

if use_dbus:

3473

# New standard signal

3474

self.InterfacesRemoved(

3475

client.dbus_object_path,

3476

client._get_all_interface_names())

3477

# Old signal

3478

self.ClientRemoved(client.dbus_object_path,

3479

client.name)

3480

2732

3481

mandos_dbus_service = MandosDBusService()

2733

3482

3483

# Save modules to variables to exempt the modules from being

3484

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

3485

mp = multiprocessing

3486

wn = wnull

3487

2734

3488

def cleanup():

2735

3489

"Cleanup function; run on exit"

2736

3490

if zeroconf:

2737

3491

service.cleanup()

2738

2739

multiprocessing.active_children()

2740

wnull.close()

3492

3493

mp.active_children()

3494

wn.close()

2741

3495

if not (tcp_server.clients or client_settings):

2742

3496

return

2743

3497

2744

3498

# Store client before exiting. Secrets are encrypted with key

2745

3499

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

2746

3500

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

2747

3501

clients = {}

2748

3502

with PGPEngine() as pgp:

2749

for client in tcp_server.clients.itervalues():

3503

for client in tcp_server.clients.values():

2750

3504

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

2751

3505

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

2752

3506

key)

2753

3507

client_dict = {}

2754

3508

2755

3509

# A list of attributes that can not be pickled

2756

3510

# + secret.

2757

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

2758

"checker", "server_settings" }

2759

for name, typ in (inspect.getmembers

2760

(dbus.service.Object)):

3511

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

3512

"checker", "server_settings"}

3513

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

3514

.Object):

2761

3515

exclude.add(name)

2762

3516

2763

3517

client_dict["encrypted_secret"] = (client

2764

3518

.encrypted_secret)

2765

3519

for attr in client.client_structure:

2766

3520

if attr not in exclude:

2767

3521

client_dict[attr] = getattr(client, attr)

2768

3522

2769

3523

clients[client.name] = client_dict

2770

3524

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

2771

3525

2772

3526

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

3527

with tempfile.NamedTemporaryFile(

3528

mode='wb',

3529

suffix=".pickle",

3530

prefix='clients-',

3531

dir=os.path.dirname(stored_state_path),

3532

delete=False) as stored_state:

3533

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

3534

protocol=2)

3535

tempname = stored_state.name

2779

3536

os.rename(tempname, stored_state_path)

2780

3537

except (IOError, OSError) as e:

2781

3538

if not debug:

2790

3547

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

2791

3548

exc_info=e)

2792

3549

raise

2793

3550

2794

3551

# Delete all clients, and settings from config

2795

3552

while tcp_server.clients:

2796

3553

name, client = tcp_server.clients.popitem()

2797

3554

if use_dbus:

2798

3555

client.remove_from_connection()

2799

# Don't signal anything except ClientRemoved

3556

# Don't signal the disabling

2800

3557

client.disable(quiet=True)

3558

# Emit D-Bus signal for removal

2801

3559

if use_dbus:

2802

# Emit D-Bus signal

2803

mandos_dbus_service.ClientRemoved(client

2804

.dbus_object_path,

2805

client.name)

3560

mandos_dbus_service.client_removed_signal(client)

2806

3561

client_settings.clear()

2807

3562

2808

3563

atexit.register(cleanup)

2809

2810

for client in tcp_server.clients.itervalues():

3564

3565

for client in tcp_server.clients.values():

2811

3566

if use_dbus:

2812

# Emit D-Bus signal

2813

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3567

# Emit D-Bus signal for adding

3568

mandos_dbus_service.client_added_signal(client)

2814

3569

# Need to initiate checking of clients

2815

3570

if client.enabled:

2816

3571

client.init_checker()

2817

3572

2818

3573

tcp_server.enable()

2819

3574

tcp_server.server_activate()

2820

3575

2821

3576

# Find out what port we got

2822

3577

if zeroconf:

2823

3578

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

2828

3583

else: # IPv4

2829

3584

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

2830

3585

*tcp_server.socket.getsockname())

2831

2832

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

2833

3586

3587

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

3588

2834

3589

try:

2835

3590

if zeroconf:

2836

3591

# From the Avahi example code

2841

3596

cleanup()

2842

3597

sys.exit(1)

2843

3598

# 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

3599

3600

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

3601

lambda *args, **kwargs:

3602

(tcp_server.handle_request

3603

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

3604

2850

3605

logger.debug("Starting main loop")

2851

3606

main_loop.run()

2852

3607

except AvahiError as error:

2861

3616

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

2862

3617

cleanup()

2863

3618

3619

2864

3620

if __name__ == '__main__':

2865

3621

main()