/mandos/release : revision 237.23.7

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

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

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

21

19

# the Free Software Foundation, either version 3 of the License, or

22

20

# (at your option) any later version.

23

21

#

24

# Mandos is distributed in the hope that it will be useful, but

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

# This program is distributed in the hope that it will be useful,

23

# but WITHOUT ANY WARRANTY; without even the implied warranty of

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

# You should have received a copy of the GNU General Public License

30

# along with Mandos. If not, see <http://www.gnu.org/licenses/>.

31

#

28

# along with this program. If not, see

29

# <http://www.gnu.org/licenses/>.

30

#

32

31

# Contact the authors at <mandos@recompile.se>.

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

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

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

72

81

73

import dbus

82

74

import dbus.service

83

import gi

84

from gi.repository import GLib

75

import gobject

76

import avahi

85

77

from dbus.mainloop.glib import DBusGMainLoop

86

78

import ctypes

87

79

import ctypes.util

88

80

import xml.dom.minidom

89

81

import inspect

90

82

91

# Try to find the value of SO_BINDTODEVICE:

92

83

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:

95

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

96

85

except AttributeError:

97

86

try:

98

# This is where SO_BINDTODEVICE was up to and including Python

99

# 2.6, and also 3.2:

100

87

from IN import SO_BINDTODEVICE

101

88

except ImportError:

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"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.7"

123

92

stored_state_file = "clients.pickle"

124

93

125

94

logger = logging.getLogger()

126

95

syslogger = None

127

96

128

97

try:

129

if_nametoindex = ctypes.cdll.LoadLibrary(

130

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

131

101

except (OSError, AttributeError):

132

133

102

def if_nametoindex(interface):

134

103

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

135

104

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

136

105

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

137

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

138

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

139

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

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

140

111

return interface_index

141

112

142

113

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

159

114

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

160

115

"""init logger and add loglevel"""

161

116

162

117

global syslogger

163

syslogger = (logging.handlers.SysLogHandler(

164

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

165

address="/dev/log"))

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

166

122

syslogger.setFormatter(logging.Formatter

167

123

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

168

124

' %(message)s'))

169

125

logger.addHandler(syslogger)

170

126

171

127

if debug:

172

128

console = logging.StreamHandler()

173

129

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

185

141

186

142

class PGPEngine(object):

187

143

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

188

189

144

def __init__(self):

190

145

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

202

146

self.gnupgargs = ['--batch',

203

'--homedir', self.tempdir,

147

'--home', self.tempdir,

204

148

'--force-mdc',

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

149

'--quiet',

150

'--no-use-agent']

151

210

152

def __enter__(self):

211

153

return self

212

154

213

155

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

214

156

self._cleanup()

215

157

return False

216

158

217

159

def __del__(self):

218

160

self._cleanup()

219

161

220

162

def _cleanup(self):

221

163

if self.tempdir is not None:

222

164

# Delete contents of tempdir

223

165

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

224

topdown=False):

166

topdown = False):

225

167

for filename in files:

226

168

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

227

169

for dirname in dirs:

229

171

# Remove tempdir

230

172

os.rmdir(self.tempdir)

231

173

self.tempdir = None

232

174

233

175

def password_encode(self, password):

234

176

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

235

177

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

240

182

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

241

183

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

242

184

return encoded

243

185

244

186

def encrypt(self, data, password):

245

187

passphrase = self.password_encode(password)

246

with tempfile.NamedTemporaryFile(

247

dir=self.tempdir) as passfile:

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

248

190

passfile.write(passphrase)

249

191

passfile.flush()

250

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

192

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

251

193

'--passphrase-file',

252

194

passfile.name]

253

195

+ self.gnupgargs,

254

stdin=subprocess.PIPE,

255

stdout=subprocess.PIPE,

256

stderr=subprocess.PIPE)

257

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

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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

258

200

if proc.returncode != 0:

259

201

raise PGPError(err)

260

202

return ciphertext

261

203

262

204

def decrypt(self, data, password):

263

205

passphrase = self.password_encode(password)

264

with tempfile.NamedTemporaryFile(

265

dir=self.tempdir) as passfile:

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

266

208

passfile.write(passphrase)

267

209

passfile.flush()

268

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

210

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

269

211

'--passphrase-file',

270

212

passfile.name]

271

213

+ self.gnupgargs,

272

stdin=subprocess.PIPE,

273

stdout=subprocess.PIPE,

274

stderr=subprocess.PIPE)

275

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

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

276

219

if proc.returncode != 0:

277

220

raise PGPError(err)

278

221

return decrypted_plaintext

279

222

280

223

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

307

224

class AvahiError(Exception):

308

225

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

309

226

self.value = value

310

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

311

**kwargs)

312

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

313

230

314

231

class AvahiServiceError(AvahiError):

315

232

pass

316

233

317

318

234

class AvahiGroupError(AvahiError):

319

235

pass

320

236

321

237

322

238

class AvahiService(object):

323

239

"""An Avahi (Zeroconf) service.

324

240

325

241

Attributes:

326

242

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

327

243

Used to optionally bind to the specified interface.

339

255

server: D-Bus Server

340

256

bus: dbus.SystemBus()

341

257

"""

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

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

354

263

self.interface = interface

355

264

self.name = name

356

265

self.type = servicetype

365

274

self.server = None

366

275

self.bus = bus

367

276

self.entry_group_state_changed_match = None

368

369

def rename(self, remove=True):

277

278

def rename(self):

370

279

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

371

280

if self.rename_count >= self.max_renames:

372

281

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

373

282

" after %i retries, exiting.",

374

283

self.rename_count)

375

284

raise AvahiServiceError("Too many renames")

376

self.name = str(

377

self.server.GetAlternativeServiceName(self.name))

378

self.rename_count += 1

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

379

287

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

380

288

self.name)

381

if remove:

382

self.remove()

289

self.remove()

383

290

try:

384

291

self.add()

385

292

except dbus.exceptions.DBusException as error:

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

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

395

298

def remove(self):

396

299

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

397

300

if self.entry_group_state_changed_match is not None:

399

302

self.entry_group_state_changed_match = None

400

303

if self.group is not None:

401

304

self.group.Reset()

402

305

403

306

def add(self):

404

307

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

405

308

self.remove()

422

325

dbus.UInt16(self.port),

423

326

avahi.string_array_to_txt_array(self.TXT))

424

327

self.group.Commit()

425

328

426

329

def entry_group_state_changed(self, state, error):

427

330

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

428

331

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

429

332

430

333

if state == avahi.ENTRY_GROUP_ESTABLISHED:

431

334

logger.debug("Zeroconf service established.")

432

335

elif state == avahi.ENTRY_GROUP_COLLISION:

434

337

self.rename()

435

338

elif state == avahi.ENTRY_GROUP_FAILURE:

436

339

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

437

str(error))

438

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

439

340

unicode(error))

341

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

342

.format(error))

343

440

344

def cleanup(self):

441

345

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

442

346

if self.group is not None:

447

351

pass

448

352

self.group = None

449

353

self.remove()

450

354

451

355

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

452

356

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

453

357

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

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

}

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

460

365

if state in bad_states:

461

366

if bad_states[state] is not None:

462

367

if error is None:

465

370

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

466

371

self.cleanup()

467

372

elif state == avahi.SERVER_RUNNING:

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)

373

self.add()

480

374

else:

481

375

if error is None:

482

376

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

483

377

else:

484

378

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

485

379

486

380

def activate(self):

487

381

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

488

382

if self.server is None:

492

386

follow_name_owner_changes=True),

493

387

avahi.DBUS_INTERFACE_SERVER)

494

388

self.server.connect_to_signal("StateChanged",

495

self.server_state_changed)

389

self.server_state_changed)

496

390

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

497

391

498

392

499

393

class AvahiServiceToSyslog(AvahiService):

500

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

394

def rename(self):

501

395

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

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

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

.format(self.name)))

506

401

return ret

507

402

508

403

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

821

404

class Client(object):

822

405

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

823

406

824

407

Attributes:

825

408

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

826

409

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

827

410

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

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

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

832

415

checker_command: string; External command which is run to check

833

416

if client lives. %() expansions are done at

834

417

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

835

418

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

836

checker_initiator_tag: a GLib event source tag, or None

419

checker_initiator_tag: a gobject event source tag, or None

837

420

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

838

421

client_structure: Object describing what attributes a client has

839

422

and is used for storing the client at exit

840

423

current_checker_command: string; current running checker_command

841

disable_initiator_tag: a GLib event source tag, or None

424

disable_initiator_tag: a gobject event source tag, or None

842

425

enabled: bool()

843

426

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

844

uniquely identify an OpenPGP client

845

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

846

a client using raw public keys

427

uniquely identify the client

847

428

host: string; available for use by the checker command

848

429

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

849

430

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

851

432

last_checker_status: integer between 0 and 255 reflecting exit

852

433

status of last checker. -1 reflects crashed

853

434

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

856

435

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

857

436

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

858

437

D-Bus identifiers

865

444

disabled, or None

866

445

server_settings: The server_settings dict from main()

867

446

"""

868

447

869

448

runtime_expansions = ("approval_delay", "approval_duration",

870

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

449

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

871

450

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

872

451

"last_approval_request", "last_checked_ok",

873

452

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

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

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

886

464

@staticmethod

887

465

def config_parser(config):

888

466

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

895

473

for client_name in config.sections():

896

474

section = dict(config.items(client_name))

897

475

client = settings[client_name] = {}

898

476

899

477

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

900

478

# Reformat values from string types to Python types

901

479

client["approved_by_default"] = config.getboolean(

902

480

client_name, "approved_by_default")

903

481

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

904

482

"enabled")

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

483

911

484

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

912

485

.replace(" ", ""))

913

486

if "secret" in section:

914

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

915

.encode("utf-8"),

916

"base64")

487

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

917

488

elif "secfile" in section:

918

489

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

919

490

(section["secfile"])),

934

505

client["last_approval_request"] = None

935

506

client["last_checked_ok"] = None

936

507

client["last_checker_status"] = -2

937

508

938

509

return settings

939

940

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

510

511

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

941

512

self.name = name

942

513

if server_settings is None:

943

514

server_settings = {}

945

516

# adding all client settings

946

517

for setting, value in settings.items():

947

518

setattr(self, setting, value)

948

519

949

520

if self.enabled:

950

521

if not hasattr(self, "last_enabled"):

951

522

self.last_enabled = datetime.datetime.utcnow()

955

526

else:

956

527

self.last_enabled = None

957

528

self.expires = None

958

529

959

530

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

960

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

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the fingerprint()

533

# function

961

534

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

962

535

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

963

536

datetime.datetime.utcnow())

964

537

965

538

# attributes specific for this server instance

966

539

self.checker = None

967

540

self.checker_initiator_tag = None

970

543

self.current_checker_command = None

971

544

self.approved = None

972

545

self.approvals_pending = 0

973

self.changedstate = multiprocessing_manager.Condition(

974

multiprocessing_manager.Lock())

975

self.client_structure = [attr

976

for attr in self.__dict__.keys()

546

self.changedstate = (multiprocessing_manager

547

.Condition(multiprocessing_manager

548

.Lock()))

549

self.client_structure = [attr for attr in

550

self.__dict__.iterkeys()

977

551

if not attr.startswith("_")]

978

552

self.client_structure.append("client_structure")

979

980

for name, t in inspect.getmembers(

981

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

553

554

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

555

lambda obj:

556

isinstance(obj,

557

property)):

982

558

if not name.startswith("_"):

983

559

self.client_structure.append(name)

984

560

985

561

# Send notice to process children that client state has changed

986

562

def send_changedstate(self):

987

563

with self.changedstate:

988

564

self.changedstate.notify_all()

989

565

990

566

def enable(self):

991

567

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

992

568

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

997

573

self.last_enabled = datetime.datetime.utcnow()

998

574

self.init_checker()

999

575

self.send_changedstate()

1000

576

1001

577

def disable(self, quiet=True):

1002

578

"""Disable this client."""

1003

579

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

1005

581

if not quiet:

1006

582

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

1007

583

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

1008

GLib.source_remove(self.disable_initiator_tag)

584

gobject.source_remove(self.disable_initiator_tag)

1009

585

self.disable_initiator_tag = None

1010

586

self.expires = None

1011

587

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

1012

GLib.source_remove(self.checker_initiator_tag)

588

gobject.source_remove(self.checker_initiator_tag)

1013

589

self.checker_initiator_tag = None

1014

590

self.stop_checker()

1015

591

self.enabled = False

1016

592

if not quiet:

1017

593

self.send_changedstate()

1018

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

594

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

1019

595

return False

1020

596

1021

597

def __del__(self):

1022

598

self.disable()

1023

599

1024

600

def init_checker(self):

1025

601

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

1026

602

# and every interval from then on.

1027

603

if self.checker_initiator_tag is not None:

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)

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

1032

609

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

1033

610

if self.disable_initiator_tag is not None:

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)

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

1037

616

# Also start a new checker *right now*.

1038

617

self.start_checker()

1039

1040

def checker_callback(self, source, condition, connection,

1041

command):

618

619

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

1042

620

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

1047

621

self.checker_callback_tag = None

1048

622

self.checker = None

1049

1050

if returncode >= 0:

1051

self.last_checker_status = returncode

1052

self.last_checker_signal = None

623

if os.WIFEXITED(condition):

624

self.last_checker_status = os.WEXITSTATUS(condition)

1053

625

if self.last_checker_status == 0:

1054

626

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

1055

627

vars(self))

1056

628

self.checked_ok()

1057

629

else:

1058

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

630

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

631

vars(self))

1059

632

else:

1060

633

self.last_checker_status = -1

1061

self.last_checker_signal = -returncode

1062

634

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

1063

635

vars(self))

1064

return False

1065

636

1066

637

def checked_ok(self):

1067

638

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

1068

639

self.last_checked_ok = datetime.datetime.utcnow()

1069

640

self.last_checker_status = 0

1070

self.last_checker_signal = None

1071

641

self.bump_timeout()

1072

642

1073

643

def bump_timeout(self, timeout=None):

1074

644

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

1075

645

if timeout is None:

1076

646

timeout = self.timeout

1077

647

if self.disable_initiator_tag is not None:

1078

GLib.source_remove(self.disable_initiator_tag)

648

gobject.source_remove(self.disable_initiator_tag)

1079

649

self.disable_initiator_tag = None

1080

650

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

1081

self.disable_initiator_tag = GLib.timeout_add(

1082

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

651

self.disable_initiator_tag = (gobject.timeout_add

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

1083

654

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

1084

655

1085

656

def need_approval(self):

1086

657

self.last_approval_request = datetime.datetime.utcnow()

1087

658

1088

659

def start_checker(self):

1089

660

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

1090

661

1091

662

If a checker already exists, leave it running and do

1092

663

nothing."""

1093

664

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

1098

669

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

1099

670

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

1100

671

# should be.

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

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)

1106

687

# Start a new checker if needed

1107

688

if self.checker is None:

1108

689

# Escape attributes for the shell

1109

escaped_attrs = {

1110

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

1111

for attr in self.runtime_expansions}

690

escaped_attrs = { attr:

691

re.escape(unicode(getattr(self,

692

attr)))

693

for attr in self.runtime_expansions }

1112

694

try:

1113

695

command = self.checker_command % escaped_attrs

1114

696

except TypeError as error:

1115

697

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

1116

self.checker_command,

698

self.checker_command, exc_info=error)

699

return True # Try again later

700

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

1117

722

exc_info=error)

1118

return True # Try again later

1119

self.current_checker_command = command

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

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

1146

743

return True

1147

744

1148

745

def stop_checker(self):

1149

746

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

1150

747

if self.checker_callback_tag:

1151

GLib.source_remove(self.checker_callback_tag)

748

gobject.source_remove(self.checker_callback_tag)

1152

749

self.checker_callback_tag = None

1153

750

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

1154

751

return

1155

752

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

1156

self.checker.terminate()

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

1157

761

self.checker = None

1158

762

1159

763

1160

def dbus_service_property(dbus_interface,

1161

signature="v",

1162

access="readwrite",

1163

byte_arrays=False):

764

def dbus_service_property(dbus_interface, signature="v",

765

access="readwrite", byte_arrays=False):

1164

766

"""Decorators for marking methods of a DBusObjectWithProperties to

1165

767

become properties on the D-Bus.

1166

768

1167

769

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

1168

770

and with one argument by "Set".

1169

771

1170

772

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

1171

773

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

1172

774

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

1176

778

if byte_arrays and signature != "ay":

1177

779

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

1178

780

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

1179

1180

781

def decorator(func):

1181

782

func._dbus_is_property = True

1182

783

func._dbus_interface = dbus_interface

1185

786

func._dbus_name = func.__name__

1186

787

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

1187

788

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

1188

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

789

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1189

790

return func

1190

1191

791

return decorator

1192

792

1193

793

1194

794

def dbus_interface_annotations(dbus_interface):

1195

795

"""Decorator for marking functions returning interface annotations

1196

796

1197

797

Usage:

1198

798

1199

799

@dbus_interface_annotations("org.example.Interface")

1200

800

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

1201

801

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

1202

802

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

1203

803

"false"}

1204

804

"""

1205

1206

805

def decorator(func):

1207

806

func._dbus_is_interface = True

1208

807

func._dbus_interface = dbus_interface

1209

808

func._dbus_name = dbus_interface

1210

809

return func

1211

1212

810

return decorator

1213

811

1214

812

1215

813

def dbus_annotations(annotations):

1216

814

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

1217

815

Usage:

1218

1219

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

1220

"org.freedesktop.DBus.Property."

1221

"EmitsChangedSignal": "false"})

816

1222

817

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

1223

818

access="r")

819

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

820

"org.freedesktop.DBus.Property."

821

"EmitsChangedSignal": "false"})

1224

822

def Property_dbus_property(self):

1225

823

return dbus.Boolean(False)

1226

1227

See also the DBusObjectWithAnnotations class.

1228

824

"""

1229

1230

825

def decorator(func):

1231

826

func._dbus_annotations = annotations

1232

827

return func

1233

1234

828

return decorator

1235

829

1236

830

1237

831

class DBusPropertyException(dbus.exceptions.DBusException):

1238

832

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

1239

833

"""

1240

pass

834

def __unicode__(self):

835

return unicode(str(self))

1241

836

1242

837

1243

838

class DBusPropertyAccessException(DBusPropertyException):

1252

847

pass

1253

848

1254

849

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.

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.

1260

856

"""

1261

857

1262

858

@staticmethod

1263

859

def _is_dbus_thing(thing):

1264

860

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

1265

861

1266

862

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

1267

863

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

1268

864

"""

1269

865

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

1270

866

False)

1271

867

1272

868

def _get_all_dbus_things(self, thing):

1273

869

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

1274

870

"""

1275

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

871

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

872

name),

1276

873

athing.__get__(self))

1277

874

for cls in self.__class__.__mro__

1278

875

for name, athing in

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

876

inspect.getmembers(cls,

877

self._is_dbus_thing(thing)))

878

1352

879

def _get_dbus_property(self, interface_name, property_name):

1353

880

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

1354

881

property with the specified name and interface.

1355

882

"""

1356

for cls in self.__class__.__mro__:

1357

for name, value in inspect.getmembers(

1358

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

883

for cls in self.__class__.__mro__:

884

for name, value in (inspect.getmembers

885

(cls,

886

self._is_dbus_thing("property"))):

1359

887

if (value._dbus_name == property_name

1360

888

and value._dbus_interface == interface_name):

1361

889

return value.__get__(self)

1362

890

1363

891

# No such property

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

892

raise DBusPropertyNotFound(self.dbus_object_path + ":"

893

+ interface_name + "."

894

+ property_name)

895

896

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

1378

897

out_signature="v")

1379

898

def Get(self, interface_name, property_name):

1380

899

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

1386

905

if not hasattr(value, "variant_level"):

1387

906

return value

1388

907

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

1389

908

1390

909

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

1391

910

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

1392

911

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

1404

923

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

1405

924

for byte in value))

1406

925

prop(value)

1407

1408

@dbus.service.method(dbus.PROPERTIES_IFACE,

1409

in_signature="s",

926

927

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

1410

928

out_signature="a{sv}")

1411

929

def GetAll(self, interface_name):

1412

930

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

1413

931

standard.

1414

932

1415

933

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

1416

934

"""

1417

935

properties = {}

1427

945

if not hasattr(value, "variant_level"):

1428

946

properties[name] = value

1429

947

continue

1430

properties[name] = type(value)(

1431

value, variant_level=value.variant_level + 1)

948

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

949

value.variant_level+1)

1432

950

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

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

951

1442

952

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1443

953

out_signature="s",

1444

954

path_keyword='object_path',

1445

955

connection_keyword='connection')

1446

956

def Introspect(self, object_path, connection):

1447

957

"""Overloading of standard D-Bus method.

1448

958

1449

959

Inserts property tags and interface annotation tags.

1450

960

"""

1451

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1452

object_path,

1453

connection)

961

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

962

connection)

1454

963

try:

1455

964

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

1456

1457

965

def make_tag(document, name, prop):

1458

966

e = document.createElement("property")

1459

967

e.setAttribute("name", name)

1460

968

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

1461

969

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

1462

970

return e

1463

1464

971

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

1465

972

# Add property tags

1466

973

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

1469

976

if prop._dbus_interface

1470

977

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

1471

978

if_tag.appendChild(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)

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)

1488

1010

# Add the names to the return values for the

1489

1011

# "org.freedesktop.DBus.Properties" methods

1490

1012

if (if_tag.getAttribute("name")

1509

1031

return xmlstring

1510

1032

1511

1033

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

1583

1034

def datetime_to_dbus(dt, variant_level=0):

1584

1035

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

1585

1036

if dt is None:

1586

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

1587

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

1037

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

1038

return dbus.String(dt.isoformat(),

1039

variant_level=variant_level)

1588

1040

1589

1041

1590

1042

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1592

1044

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

1593

1045

interface names according to the "alt_interface_names" mapping.

1594

1046

Usage:

1595

1047

1596

1048

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

1597

1049

"net.example.AlternateInterface"})

1598

1050

class SampleDBusObject(dbus.service.Object):

1599

1051

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

1600

1052

def SampleDBusMethod():

1601

1053

pass

1602

1054

1603

1055

The above "SampleDBusMethod" on "SampleDBusObject" will be

1604

1056

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

1605

1057

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

1606

1058

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

1607

1059

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

1608

1060

1609

1061

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

1610

1062

(from DBusObjectWithProperties) and interfaces (from the

1611

1063

dbus_interface_annotations decorator).

1612

1064

"""

1613

1614

1065

def wrapper(cls):

1615

1066

for orig_interface_name, alt_interface_name in (

1616

alt_interface_names.items()):

1067

alt_interface_names.items()):

1617

1068

attr = {}

1618

1069

interface_names = set()

1619

1070

# Go though all attributes of the class

1621

1072

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

1622

1073

# with the wrong interface name

1623

1074

if (not hasattr(attribute, "_dbus_interface")

1624

or not attribute._dbus_interface.startswith(

1625

orig_interface_name)):

1075

or not attribute._dbus_interface

1076

.startswith(orig_interface_name)):

1626

1077

continue

1627

1078

# Create an alternate D-Bus interface name based on

1628

1079

# the current name

1629

alt_interface = attribute._dbus_interface.replace(

1630

orig_interface_name, alt_interface_name)

1080

alt_interface = (attribute._dbus_interface

1081

.replace(orig_interface_name,

1082

alt_interface_name))

1631

1083

interface_names.add(alt_interface)

1632

1084

# Is this a D-Bus signal?

1633

1085

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

1634

1086

# Extract the original non-method undecorated

1635

1087

# function by black magic

1636

if sys.version_info.major == 2:

1637

nonmethod_func = (dict(

1088

nonmethod_func = (dict(

1638

1089

zip(attribute.func_code.co_freevars,

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)

1090

attribute.__closure__))["func"]

1091

.cell_contents)

1646

1092

# Create a new, but exactly alike, function

1647

1093

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

1648

1094

# with the alternate D-Bus interface name

1649

new_function = copy_function(nonmethod_func)

1650

new_function = (dbus.service.signal(

1651

alt_interface,

1652

attribute._dbus_signature)(new_function))

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

1653

1104

# Copy annotations, if any

1654

1105

try:

1655

new_function._dbus_annotations = dict(

1656

attribute._dbus_annotations)

1106

new_function._dbus_annotations = (

1107

dict(attribute._dbus_annotations))

1657

1108

except AttributeError:

1658

1109

pass

1659

1660

1110

# Define a creator of a function to call both the

1661

1111

# original and alternate functions, so both the

1662

1112

# original and alternate signals gets sent when

1665

1115

"""This function is a scope container to pass

1666

1116

func1 and func2 to the "call_both" function

1667

1117

outside of its arguments"""

1668

1669

@functools.wraps(func2)

1670

1118

def call_both(*args, **kwargs):

1671

1119

"""This function will emit two D-Bus

1672

1120

signals by calling func1 and func2"""

1673

1121

func1(*args, **kwargs)

1674

1122

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

1681

1123

return call_both

1682

1124

# Create the "call_both" function and add it to

1683

1125

# the class

1688

1130

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

1689

1131

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

1690

1132

# to the class.

1691

attr[attrname] = (

1692

dbus.service.method(

1693

alt_interface,

1694

attribute._dbus_in_signature,

1695

attribute._dbus_out_signature)

1696

(copy_function(attribute)))

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

1697

1143

# Copy annotations, if any

1698

1144

try:

1699

attr[attrname]._dbus_annotations = dict(

1700

attribute._dbus_annotations)

1145

attr[attrname]._dbus_annotations = (

1146

dict(attribute._dbus_annotations))

1701

1147

except AttributeError:

1702

1148

pass

1703

1149

# Is this a D-Bus property?

1706

1152

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

1707

1153

# property with the alternate D-Bus interface

1708

1154

# name. Add it to the class.

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

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

1715

1168

# Copy annotations, if any

1716

1169

try:

1717

attr[attrname]._dbus_annotations = dict(

1718

attribute._dbus_annotations)

1170

attr[attrname]._dbus_annotations = (

1171

dict(attribute._dbus_annotations))

1719

1172

except AttributeError:

1720

1173

pass

1721

1174

# Is this a D-Bus interface?

1724

1177

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

1725

1178

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

1726

1179

# to the class.

1727

attr[attrname] = (

1728

dbus_interface_annotations(alt_interface)

1729

(copy_function(attribute)))

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

1730

1188

if deprecate:

1731

1189

# Deprecate all alternate interfaces

1732

iname = "_AlternateDBusNames_interface_annotation{}"

1190

iname="_AlternateDBusNames_interface_annotation{}"

1733

1191

for interface_name in interface_names:

1734

1735

1192

@dbus_interface_annotations(interface_name)

1736

1193

def func(self):

1737

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

1738

"true"}

1194

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

1195

"true" }

1739

1196

# Find an unused name

1740

1197

for aname in (iname.format(i)

1741

1198

for i in itertools.count()):

1745

1202

if interface_names:

1746

1203

# Replace the class with a new subclass of it with

1747

1204

# methods, signals, etc. as created above.

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)

1205

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

1206

(cls,), attr)

1754

1207

return cls

1755

1756

1208

return wrapper

1757

1209

1758

1210

1759

1211

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

1760

"se.bsnet.fukt.Mandos"})

1212

"se.bsnet.fukt.Mandos"})

1761

1213

class ClientDBus(Client, DBusObjectWithProperties):

1762

1214

"""A Client class using D-Bus

1763

1215

1764

1216

Attributes:

1765

1217

dbus_object_path: dbus.ObjectPath

1766

1218

bus: dbus.SystemBus()

1767

1219

"""

1768

1220

1769

1221

runtime_expansions = (Client.runtime_expansions

1770

+ ("dbus_object_path", ))

1771

1772

_interface = "se.recompile.Mandos.Client"

1773

1222

+ ("dbus_object_path",))

1223

1774

1224

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

1775

1776

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

1225

1226

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

1777

1227

self.bus = bus

1778

1228

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

1779

1229

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

1780

1230

# the D-Bus

1781

client_object_name = str(self.name).translate(

1231

client_object_name = unicode(self.name).translate(

1782

1232

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

1783

1233

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

1784

self.dbus_object_path = dbus.ObjectPath(

1785

"/clients/" + client_object_name)

1234

self.dbus_object_path = (dbus.ObjectPath

1235

("/clients/" + client_object_name))

1786

1236

DBusObjectWithProperties.__init__(self, self.bus,

1787

1237

self.dbus_object_path)

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

1238

1239

def notifychangeproperty(transform_func,

1240

dbus_name, type_func=lambda x: x,

1241

variant_level=1):

1794

1242

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

1795

1243

its changes to DBus.

1796

1244

1797

1245

transform_fun: Function that takes a value and a variant_level

1798

1246

and transforms it to a D-Bus type.

1799

1247

dbus_name: D-Bus name of the variable

1802

1250

variant_level: D-Bus variant level. Default: 1

1803

1251

"""

1804

1252

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

1805

1806

1253

def setter(self, value):

1807

1254

if hasattr(self, "dbus_object_path"):

1808

1255

if (not hasattr(self, attrname) or

1809

1256

type_func(getattr(self, attrname, None))

1810

1257

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

1258

dbus_value = transform_func(type_func(value),

1259

variant_level

1260

=variant_level)

1261

self.PropertyChanged(dbus.String(dbus_name),

1262

dbus_value)

1826

1263

setattr(self, attrname, value)

1827

1264

1828

1265

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

1829

1266

1830

1267

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1831

1268

approvals_pending = notifychangeproperty(dbus.Boolean,

1832

1269

"ApprovalPending",

1833

type_func=bool)

1270

type_func = bool)

1834

1271

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

1835

1272

last_enabled = notifychangeproperty(datetime_to_dbus,

1836

1273

"LastEnabled")

1837

checker = notifychangeproperty(

1838

dbus.Boolean, "CheckerRunning",

1839

type_func=lambda checker: checker is not None)

1274

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

1275

type_func = lambda checker:

1276

checker is not None)

1840

1277

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1841

1278

"LastCheckedOK")

1842

1279

last_checker_status = notifychangeproperty(dbus.Int16,

1845

1282

datetime_to_dbus, "LastApprovalRequest")

1846

1283

approved_by_default = notifychangeproperty(dbus.Boolean,

1847

1284

"ApprovedByDefault")

1848

approval_delay = notifychangeproperty(

1849

dbus.UInt64, "ApprovalDelay",

1850

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

1285

approval_delay = notifychangeproperty(dbus.UInt64,

1286

"ApprovalDelay",

1287

type_func =

1288

lambda td: td.total_seconds()

1289

* 1000)

1851

1290

approval_duration = notifychangeproperty(

1852

1291

dbus.UInt64, "ApprovalDuration",

1853

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

1292

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

1854

1293

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

1855

timeout = notifychangeproperty(

1856

dbus.UInt64, "Timeout",

1857

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

1294

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

1295

type_func = lambda td:

1296

td.total_seconds() * 1000)

1858

1297

extended_timeout = notifychangeproperty(

1859

1298

dbus.UInt64, "ExtendedTimeout",

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)

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)

1864

1305

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

1865

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

1866

invalidate_only=True)

1867

1306

1868

1307

del notifychangeproperty

1869

1308

1870

1309

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

1871

1310

try:

1872

1311

self.remove_from_connection()

1875

1314

if hasattr(DBusObjectWithProperties, "__del__"):

1876

1315

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

1877

1316

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

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:

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)

1886

1324

# Emit D-Bus signal

1887

1325

self.CheckerCompleted(dbus.Int16(exitstatus),

1888

# This is specific to GNU libC

1889

dbus.Int64(exitstatus << 8),

1326

dbus.Int64(condition),

1890

1327

dbus.String(command))

1891

1328

else:

1892

1329

# Emit D-Bus signal

1893

1330

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

1894

dbus.Int64(

1895

# This is specific to GNU libC

1896

(exitstatus << 8)

1897

| self.last_checker_signal),

1331

dbus.Int64(condition),

1898

1332

dbus.String(command))

1899

return ret

1900

1333

1334

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

1335

*args, **kwargs)

1336

1901

1337

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

1902

1338

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

1903

1339

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

1907

1343

# Emit D-Bus signal

1908

1344

self.CheckerStarted(self.current_checker_command)

1909

1345

return r

1910

1346

1911

1347

def _reset_approved(self):

1912

1348

self.approved = None

1913

1349

return False

1914

1350

1915

1351

def approve(self, value=True):

1916

1352

self.approved = value

1917

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

1918

* 1000), self._reset_approved)

1353

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

1354

* 1000), self._reset_approved)

1919

1355

self.send_changedstate()

1920

1921

# D-Bus methods, signals & properties

1922

1923

# Interfaces

1924

1925

# Signals

1926

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

1927

1369

# CheckerCompleted - signal

1928

1370

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

1929

1371

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

1930

1372

"D-Bus signal"

1931

1373

pass

1932

1374

1933

1375

# CheckerStarted - signal

1934

1376

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

1935

1377

def CheckerStarted(self, command):

1936

1378

"D-Bus signal"

1937

1379

pass

1938

1380

1939

1381

# PropertyChanged - signal

1940

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

1941

1382

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

1942

1383

def PropertyChanged(self, property, value):

1943

1384

"D-Bus signal"

1944

1385

pass

1945

1386

1946

1387

# GotSecret - signal

1947

1388

@dbus.service.signal(_interface)

1948

1389

def GotSecret(self):

1951

1392

server to mandos-client

1952

1393

"""

1953

1394

pass

1954

1395

1955

1396

# Rejected - signal

1956

1397

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

1957

1398

def Rejected(self, reason):

1958

1399

"D-Bus signal"

1959

1400

pass

1960

1401

1961

1402

# NeedApproval - signal

1962

1403

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

1963

1404

def NeedApproval(self, timeout, default):

1964

1405

"D-Bus signal"

1965

1406

return self.need_approval()

1966

1967

# Methods

1968

1407

1408

## Methods

1409

1969

1410

# Approve - method

1970

1411

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

1971

1412

def Approve(self, value):

1972

1413

self.approve(value)

1973

1414

1974

1415

# CheckedOK - method

1975

1416

@dbus.service.method(_interface)

1976

1417

def CheckedOK(self):

1977

1418

self.checked_ok()

1978

1419

1979

1420

# Enable - method

1980

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

1981

1421

@dbus.service.method(_interface)

1982

1422

def Enable(self):

1983

1423

"D-Bus method"

1984

1424

self.enable()

1985

1425

1986

1426

# StartChecker - method

1987

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

1988

1427

@dbus.service.method(_interface)

1989

1428

def StartChecker(self):

1990

1429

"D-Bus method"

1991

1430

self.start_checker()

1992

1431

1993

1432

# Disable - method

1994

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

1995

1433

@dbus.service.method(_interface)

1996

1434

def Disable(self):

1997

1435

"D-Bus method"

1998

1436

self.disable()

1999

1437

2000

1438

# StopChecker - method

2001

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

2002

1439

@dbus.service.method(_interface)

2003

1440

def StopChecker(self):

2004

1441

self.stop_checker()

2005

2006

# Properties

2007

1442

1443

## Properties

1444

2008

1445

# ApprovalPending - property

2009

1446

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

2010

1447

def ApprovalPending_dbus_property(self):

2011

1448

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

2012

1449

2013

1450

# ApprovedByDefault - property

2014

@dbus_service_property(_interface,

2015

signature="b",

1451

@dbus_service_property(_interface, signature="b",

2016

1452

access="readwrite")

2017

1453

def ApprovedByDefault_dbus_property(self, value=None):

2018

1454

if value is None: # get

2019

1455

return dbus.Boolean(self.approved_by_default)

2020

1456

self.approved_by_default = bool(value)

2021

1457

2022

1458

# ApprovalDelay - property

2023

@dbus_service_property(_interface,

2024

signature="t",

1459

@dbus_service_property(_interface, signature="t",

2025

1460

access="readwrite")

2026

1461

def ApprovalDelay_dbus_property(self, value=None):

2027

1462

if value is None: # get

2028

1463

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

2029

1464

* 1000)

2030

1465

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

2031

1466

2032

1467

# ApprovalDuration - property

2033

@dbus_service_property(_interface,

2034

signature="t",

1468

@dbus_service_property(_interface, signature="t",

2035

1469

access="readwrite")

2036

1470

def ApprovalDuration_dbus_property(self, value=None):

2037

1471

if value is None: # get

2038

1472

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

2039

1473

* 1000)

2040

1474

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

2041

1475

2042

1476

# Name - property

2043

@dbus_annotations(

2044

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

2045

1477

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

2046

1478

def Name_dbus_property(self):

2047

1479

return dbus.String(self.name)

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

1480

2056

1481

# Fingerprint - property

2057

@dbus_annotations(

2058

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

2059

1482

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

2060

1483

def Fingerprint_dbus_property(self):

2061

1484

return dbus.String(self.fingerprint)

2062

1485

2063

1486

# Host - property

2064

@dbus_service_property(_interface,

2065

signature="s",

1487

@dbus_service_property(_interface, signature="s",

2066

1488

access="readwrite")

2067

1489

def Host_dbus_property(self, value=None):

2068

1490

if value is None: # get

2069

1491

return dbus.String(self.host)

2070

self.host = str(value)

2071

1492

self.host = unicode(value)

1493

2072

1494

# Created - property

2073

@dbus_annotations(

2074

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

2075

1495

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

2076

1496

def Created_dbus_property(self):

2077

1497

return datetime_to_dbus(self.created)

2078

1498

2079

1499

# LastEnabled - property

2080

1500

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

2081

1501

def LastEnabled_dbus_property(self):

2082

1502

return datetime_to_dbus(self.last_enabled)

2083

1503

2084

1504

# Enabled - property

2085

@dbus_service_property(_interface,

2086

signature="b",

1505

@dbus_service_property(_interface, signature="b",

2087

1506

access="readwrite")

2088

1507

def Enabled_dbus_property(self, value=None):

2089

1508

if value is None: # get

2092

1511

self.enable()

2093

1512

else:

2094

1513

self.disable()

2095

1514

2096

1515

# LastCheckedOK - property

2097

@dbus_service_property(_interface,

2098

signature="s",

1516

@dbus_service_property(_interface, signature="s",

2099

1517

access="readwrite")

2100

1518

def LastCheckedOK_dbus_property(self, value=None):

2101

1519

if value is not None:

2102

1520

self.checked_ok()

2103

1521

return

2104

1522

return datetime_to_dbus(self.last_checked_ok)

2105

1523

2106

1524

# LastCheckerStatus - property

2107

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

1525

@dbus_service_property(_interface, signature="n",

1526

access="read")

2108

1527

def LastCheckerStatus_dbus_property(self):

2109

1528

return dbus.Int16(self.last_checker_status)

2110

1529

2111

1530

# Expires - property

2112

1531

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

2113

1532

def Expires_dbus_property(self):

2114

1533

return datetime_to_dbus(self.expires)

2115

1534

2116

1535

# LastApprovalRequest - property

2117

1536

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

2118

1537

def LastApprovalRequest_dbus_property(self):

2119

1538

return datetime_to_dbus(self.last_approval_request)

2120

1539

2121

1540

# Timeout - property

2122

@dbus_service_property(_interface,

2123

signature="t",

1541

@dbus_service_property(_interface, signature="t",

2124

1542

access="readwrite")

2125

1543

def Timeout_dbus_property(self, value=None):

2126

1544

if value is None: # get

2138

1556

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

2139

1557

is None):

2140

1558

return

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

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

2146

1565

# ExtendedTimeout - property

2147

@dbus_service_property(_interface,

2148

signature="t",

1566

@dbus_service_property(_interface, signature="t",

2149

1567

access="readwrite")

2150

1568

def ExtendedTimeout_dbus_property(self, value=None):

2151

1569

if value is None: # get

2152

1570

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

2153

1571

* 1000)

2154

1572

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

2155

1573

2156

1574

# Interval - property

2157

@dbus_service_property(_interface,

2158

signature="t",

1575

@dbus_service_property(_interface, signature="t",

2159

1576

access="readwrite")

2160

1577

def Interval_dbus_property(self, value=None):

2161

1578

if value is None: # get

2165

1582

return

2166

1583

if self.enabled:

2167

1584

# Reschedule checker run

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

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

2173

1590

# Checker - property

2174

@dbus_service_property(_interface,

2175

signature="s",

1591

@dbus_service_property(_interface, signature="s",

2176

1592

access="readwrite")

2177

1593

def Checker_dbus_property(self, value=None):

2178

1594

if value is None: # get

2179

1595

return dbus.String(self.checker_command)

2180

self.checker_command = str(value)

2181

1596

self.checker_command = unicode(value)

1597

2182

1598

# CheckerRunning - property

2183

@dbus_service_property(_interface,

2184

signature="b",

1599

@dbus_service_property(_interface, signature="b",

2185

1600

access="readwrite")

2186

1601

def CheckerRunning_dbus_property(self, value=None):

2187

1602

if value is None: # get

2190

1605

self.start_checker()

2191

1606

else:

2192

1607

self.stop_checker()

2193

1608

2194

1609

# ObjectPath - property

2195

@dbus_annotations(

2196

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

2197

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

2198

1610

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

2199

1611

def ObjectPath_dbus_property(self):

2200

return self.dbus_object_path # is already a dbus.ObjectPath

2201

1612

return self.dbus_object_path # is already a dbus.ObjectPath

1613

2202

1614

# Secret = property

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)

1615

@dbus_service_property(_interface, signature="ay",

1616

access="write", byte_arrays=True)

2210

1617

def Secret_dbus_property(self, value):

2211

self.secret = bytes(value)

2212

1618

self.secret = str(value)

1619

2213

1620

del _interface

2214

1621

2215

1622

2216

1623

class ProxyClient(object):

2217

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

1624

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

2218

1625

self._pipe = child_pipe

2219

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

1626

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

2220

1627

if not self._pipe.recv():

2221

raise KeyError(key_id or fpr)

2222

1628

raise KeyError()

1629

2223

1630

def __getattribute__(self, name):

2224

1631

if name == '_pipe':

2225

1632

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

2228

1635

if data[0] == 'data':

2229

1636

return data[1]

2230

1637

if data[0] == 'function':

2231

2232

1638

def func(*args, **kwargs):

2233

1639

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

2234

1640

return self._pipe.recv()[1]

2235

2236

1641

return func

2237

1642

2238

1643

def __setattr__(self, name, value):

2239

1644

if name == '_pipe':

2240

1645

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

2243

1648

2244

1649

class ClientHandler(socketserver.BaseRequestHandler, object):

2245

1650

"""A class to handle client connections.

2246

1651

2247

1652

Instantiated once for each connection to handle it.

2248

1653

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

2249

1654

2250

1655

def handle(self):

2251

1656

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

2252

1657

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

2253

str(self.client_address))

1658

unicode(self.client_address))

2254

1659

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

2255

1660

self.server.child_pipe.fileno())

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

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

2263

1676

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

2264

1677

priority = self.server.gnutls_priority

2265

1678

if priority is None:

2266

1679

priority = "NORMAL"

2267

gnutls.priority_set_direct(session._c_object,

2268

priority.encode("utf-8"),

2269

None)

2270

1680

(gnutls.library.functions

1681

.gnutls_priority_set_direct(session._c_object,

1682

priority, None))

1683

2271

1684

# Start communication using the Mandos protocol

2272

1685

# Get protocol number

2273

1686

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

2278

1691

except (ValueError, IndexError, RuntimeError) as error:

2279

1692

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

2280

1693

return

2281

1694

2282

1695

# Start GnuTLS connection

2283

1696

try:

2284

1697

session.handshake()

2285

except gnutls.Error as error:

1698

except gnutls.errors.GNUTLSError as error:

2286

1699

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

2287

1700

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

2288

1701

# established. Just abandon the request.

2289

1702

return

2290

1703

logger.debug("Handshake succeeded")

2291

1704

2292

1705

approval_required = False

2293

1706

try:

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,

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,

2316

1718

self.client_address)

2317

1719

except KeyError:

2318

1720

return

2319

1721

2320

1722

if client.approval_delay:

2321

1723

delay = client.approval_delay

2322

1724

client.approvals_pending += 1

2323

1725

approval_required = True

2324

1726

2325

1727

while True:

2326

1728

if not client.enabled:

2327

1729

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

2328

client.name)

1730

client.name)

2329

1731

if self.server.use_dbus:

2330

1732

# Emit D-Bus signal

2331

1733

client.Rejected("Disabled")

2332

1734

return

2333

1735

2334

1736

if client.approved or not client.approval_delay:

2335

# We are approved or approval is disabled

1737

#We are approved or approval is disabled

2336

1738

break

2337

1739

elif client.approved is None:

2338

1740

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

2349

1751

# Emit D-Bus signal

2350

1752

client.Rejected("Denied")

2351

1753

return

2352

2353

# wait until timeout or approved

1754

1755

#wait until timeout or approved

2354

1756

time = datetime.datetime.now()

2355

1757

client.changedstate.acquire()

2356

1758

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

2369

1771

break

2370

1772

else:

2371

1773

delay -= time2 - time

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

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

2380

1788

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

2381

1789

# bump the timeout using extended_timeout

2382

1790

client.bump_timeout(client.extended_timeout)

2383

1791

if self.server.use_dbus:

2384

1792

# Emit D-Bus signal

2385

1793

client.GotSecret()

2386

1794

2387

1795

finally:

2388

1796

if approval_required:

2389

1797

client.approvals_pending -= 1

2390

1798

try:

2391

1799

session.bye()

2392

except gnutls.Error as error:

1800

except gnutls.errors.GNUTLSError as error:

2393

1801

logger.warning("GnuTLS bye failed",

2394

1802

exc_info=error)

2395

1803

2396

1804

@staticmethod

2397

1805

def peer_certificate(session):

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

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

2414

1813

list_size = ctypes.c_uint(1)

2415

cert_list = (gnutls.certificate_get_peers

1814

cert_list = (gnutls.library.functions

1815

.gnutls_certificate_get_peers

2416

1816

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

2417

1817

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

2418

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

1818

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

1819

" certificate")

2419

1820

if list_size.value == 0:

2420

1821

return None

2421

1822

cert = cert_list[0]

2422

1823

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

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

1824

2458

1825

@staticmethod

2459

1826

def fingerprint(openpgp):

2460

1827

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2461

1828

# New GnuTLS "datum" with the OpenPGP public key

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

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

2466

1834

# New empty GnuTLS certificate

2467

crt = gnutls.openpgp_crt_t()

2468

gnutls.openpgp_crt_init(ctypes.byref(crt))

1835

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1836

(gnutls.library.functions

1837

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2469

1838

# Import the OpenPGP public key into the certificate

2470

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

2471

gnutls.OPENPGP_FMT_RAW)

1839

(gnutls.library.functions

1840

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

1841

gnutls.library.constants

1842

.GNUTLS_OPENPGP_FMT_RAW))

2472

1843

# Verify the self signature in the key

2473

1844

crtverify = ctypes.c_uint()

2474

gnutls.openpgp_crt_verify_self(crt, 0,

2475

ctypes.byref(crtverify))

1845

(gnutls.library.functions

1846

.gnutls_openpgp_crt_verify_self(crt, 0,

1847

ctypes.byref(crtverify)))

2476

1848

if crtverify.value != 0:

2477

gnutls.openpgp_crt_deinit(crt)

2478

raise gnutls.CertificateSecurityError(code

2479

=crtverify.value)

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1850

raise (gnutls.errors.CertificateSecurityError

1851

("Verify failed"))

2480

1852

# New buffer for the fingerprint

2481

1853

buf = ctypes.create_string_buffer(20)

2482

1854

buf_len = ctypes.c_size_t()

2483

1855

# Get the fingerprint from the certificate into the buffer

2484

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

2485

ctypes.byref(buf_len))

1856

(gnutls.library.functions

1857

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

1858

ctypes.byref(buf_len)))

2486

1859

# Deinit the certificate

2487

gnutls.openpgp_crt_deinit(crt)

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2488

1861

# Convert the buffer to a Python bytestring

2489

1862

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

2490

1863

# Convert the bytestring to hexadecimal notation

2494

1867

2495

1868

class MultiprocessingMixIn(object):

2496

1869

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

2497

2498

1870

def sub_process_main(self, request, address):

2499

1871

try:

2500

1872

self.finish_request(request, address)

2501

1873

except Exception:

2502

1874

self.handle_error(request, address)

2503

1875

self.close_request(request)

2504

1876

2505

1877

def process_request(self, request, address):

2506

1878

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

2507

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

2508

args=(request, address))

1879

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

1880

args = (request, address))

2509

1881

proc.start()

2510

1882

return proc

2511

1883

2512

1884

2513

1885

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2514

1886

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

2515

2516

1887

def process_request(self, request, client_address):

2517

1888

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

2518

1889

2519

1890

This function creates a new pipe in self.pipe

2520

1891

"""

2521

1892

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2522

1893

2523

1894

proc = MultiprocessingMixIn.process_request(self, request,

2524

1895

client_address)

2525

1896

self.child_pipe.close()

2526

1897

self.add_pipe(parent_pipe, proc)

2527

1898

2528

1899

def add_pipe(self, parent_pipe, proc):

2529

1900

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

2530

1901

raise NotImplementedError()

2533

1904

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2534

1905

socketserver.TCPServer, object):

2535

1906

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

2536

1907

2537

1908

Attributes:

2538

1909

enabled: Boolean; whether this server is activated yet

2539

1910

interface: None or a network interface name (string)

2540

1911

use_ipv6: Boolean; to use IPv6 or not

2541

1912

"""

2542

2543

1913

def __init__(self, server_address, RequestHandlerClass,

2544

interface=None,

2545

use_ipv6=True,

2546

socketfd=None):

1914

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

2547

1915

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

2548

1916

creating a new one with socket.socket().

2549

1917

"""

2555

1923

self.socketfd = socketfd

2556

1924

# Save the original socket.socket() function

2557

1925

self.socket_socket = socket.socket

2558

2559

1926

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

2560

#

1927

#

2561

1928

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

2562

1929

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

2563

1930

# patching socket.socket.)

2564

#

1931

#

2565

1932

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

2566

1933

@functools.wraps(socket.socket)

2567

1934

def socket_wrapper(*args, **kwargs):

2579

1946

# socket_wrapper(), if socketfd was set.

2580

1947

socketserver.TCPServer.__init__(self, server_address,

2581

1948

RequestHandlerClass)

2582

1949

2583

1950

def server_bind(self):

2584

1951

"""This overrides the normal server_bind() function

2585

1952

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

2586

1953

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

2587

global SO_BINDTODEVICE

2588

1954

if self.interface is not None:

2589

1955

if SO_BINDTODEVICE is None:

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

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

2611

1977

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

2612

1978

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

2613

if self.server_address[1]:

2614

self.allow_reuse_address = True

2615

1979

if not self.server_address[0]:

2616

1980

if self.address_family == socket.AF_INET6:

2617

any_address = "::" # in6addr_any

1981

any_address = "::" # in6addr_any

2618

1982

else:

2619

any_address = "0.0.0.0" # INADDR_ANY

1983

any_address = "0.0.0.0" # INADDR_ANY

2620

1984

self.server_address = (any_address,

2621

1985

self.server_address[1])

2622

1986

elif not self.server_address[1]:

2623

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

1987

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

1988

0)

2624

1989

# if self.interface:

2625

1990

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

2626

1991

# 0, # port

2632

1997

2633

1998

class MandosServer(IPv6_TCPServer):

2634

1999

"""Mandos server.

2635

2000

2636

2001

Attributes:

2637

2002

clients: set of Client objects

2638

2003

gnutls_priority GnuTLS priority string

2639

2004

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

2640

2641

Assumes a GLib.MainLoop event loop.

2005

2006

Assumes a gobject.MainLoop event loop.

2642

2007

"""

2643

2644

2008

def __init__(self, server_address, RequestHandlerClass,

2645

interface=None,

2646

use_ipv6=True,

2647

clients=None,

2648

gnutls_priority=None,

2649

use_dbus=True,

2650

socketfd=None):

2009

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

2010

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

2651

2011

self.enabled = False

2652

2012

self.clients = clients

2653

2013

if self.clients is None:

2656

2016

self.gnutls_priority = gnutls_priority

2657

2017

IPv6_TCPServer.__init__(self, server_address,

2658

2018

RequestHandlerClass,

2659

interface=interface,

2660

use_ipv6=use_ipv6,

2661

socketfd=socketfd)

2662

2019

interface = interface,

2020

use_ipv6 = use_ipv6,

2021

socketfd = socketfd)

2663

2022

def server_activate(self):

2664

2023

if self.enabled:

2665

2024

return socketserver.TCPServer.server_activate(self)

2666

2025

2667

2026

def enable(self):

2668

2027

self.enabled = True

2669

2028

2670

2029

def add_pipe(self, parent_pipe, proc):

2671

2030

# Call "handle_ipc" for both data and EOF events

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

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

2683

2040

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

2684

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

2041

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

2685

2042

# Wait for other process to exit

2686

2043

proc.join()

2687

2044

return False

2688

2045

2689

2046

# Read a request from the child

2690

2047

request = parent_pipe.recv()

2691

2048

command = request[0]

2692

2049

2693

2050

if command == 'init':

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:

2051

fpr = request[1]

2052

address = request[2]

2053

2054

for c in self.clients.itervalues():

2055

if c.fingerprint == fpr:

2705

2056

client = c

2706

2057

break

2707

2058

else:

2708

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

2709

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

2059

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

2060

"dress: %s", fpr, address)

2710

2061

if self.use_dbus:

2711

2062

# Emit D-Bus signal

2712

mandos_dbus_service.ClientNotFound(key_id or fpr,

2063

mandos_dbus_service.ClientNotFound(fpr,

2713

2064

address[0])

2714

2065

parent_pipe.send(False)

2715

2066

return False

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

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

2724

2076

parent_pipe.send(True)

2725

2077

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

2726

2078

# same fileno

2729

2081

funcname = request[1]

2730

2082

args = request[2]

2731

2083

kwargs = request[3]

2732

2084

2733

2085

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

2734

2086

funcname)(*args,

2735

**kwargs)))

2736

2087

**kwargs)))

2088

2737

2089

if command == 'getattr':

2738

2090

attrname = request[1]

2739

if isinstance(client_object.__getattribute__(attrname),

2740

collections.Callable):

2741

parent_pipe.send(('function', ))

2091

if callable(client_object.__getattribute__(attrname)):

2092

parent_pipe.send(('function',))

2742

2093

else:

2743

parent_pipe.send((

2744

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

2745

2094

parent_pipe.send(('data', client_object

2095

.__getattribute__(attrname)))

2096

2746

2097

if command == 'setattr':

2747

2098

attrname = request[1]

2748

2099

value = request[2]

2749

2100

setattr(client_object, attrname, value)

2750

2101

2751

2102

return True

2752

2103

2753

2104

2754

2105

def rfc3339_duration_to_delta(duration):

2755

2106

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

2756

2107

2757

2108

>>> rfc3339_duration_to_delta("P7D")

2758

2109

datetime.timedelta(7)

2759

2110

>>> rfc3339_duration_to_delta("PT60S")

2769

2120

>>> rfc3339_duration_to_delta("P1DT3M20S")

2770

2121

datetime.timedelta(1, 200)

2771

2122

"""

2772

2123

2773

2124

# Parsing an RFC 3339 duration with regular expressions is not

2774

2125

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

2775

2126

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

2776

2127

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

2777

2128

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

2778

2129

# avoid excessive use of external libraries.

2779

2130

2780

2131

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

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

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

2786

2141

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

2787

2142

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

2788

2143

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

2789

2144

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

2790

2145

datetime.timedelta(seconds=1),

2791

frozenset((token_end, )))

2146

frozenset((token_end,)))

2792

2147

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

2793

2148

datetime.timedelta(minutes=1),

2794

2149

frozenset((token_second, token_end)))

2810

2165

frozenset((token_month, token_end)))

2811

2166

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

2812

2167

datetime.timedelta(weeks=1),

2813

frozenset((token_end, )))

2168

frozenset((token_end,)))

2814

2169

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

2815

2170

frozenset((token_year, token_month,

2816

2171

token_day, token_time,

2817

2172

token_week)))

2818

# Define starting values:

2819

# Value so far

2820

value = datetime.timedelta()

2173

# Define starting values

2174

value = datetime.timedelta() # Value so far

2821

2175

found_token = None

2822

# Following valid tokens

2823

followers = frozenset((token_duration, ))

2824

# String left to parse

2825

s = duration

2176

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

2177

s = duration # String left to parse

2826

2178

# Loop until end token is found

2827

2179

while found_token is not token_end:

2828

2180

# Search for any currently valid tokens

2844

2196

break

2845

2197

else:

2846

2198

# No currently valid tokens were found

2847

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

2848

.format(duration))

2199

raise ValueError("Invalid RFC 3339 duration")

2849

2200

# End token found

2850

2201

return value

2851

2202

2852

2203

2853

2204

def string_to_delta(interval):

2854

2205

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

2855

2206

2856

2207

>>> string_to_delta('7d')

2857

2208

datetime.timedelta(7)

2858

2209

>>> string_to_delta('60s')

2866

2217

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

2867

2218

datetime.timedelta(0, 330)

2868

2219

"""

2869

2220

2870

2221

try:

2871

2222

return rfc3339_duration_to_delta(interval)

2872

2223

except ValueError:

2873

2224

pass

2874

2225

2875

2226

timevalue = datetime.timedelta(0)

2876

2227

for s in interval.split():

2877

2228

try:

2878

suffix = s[-1]

2229

suffix = unicode(s[-1])

2879

2230

value = int(s[:-1])

2880

2231

if suffix == "d":

2881

2232

delta = datetime.timedelta(value)

2888

2239

elif suffix == "w":

2889

2240

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

2890

2241

else:

2891

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

2242

raise ValueError("Unknown suffix {!r}"

2243

.format(suffix))

2892

2244

except IndexError as e:

2893

2245

raise ValueError(*(e.args))

2894

2246

timevalue += delta

2895

2247

return timevalue

2896

2248

2897

2249

2898

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

2250

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

2899

2251

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

2900

2252

2901

2253

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

2902

2254

if os.fork():

2903

2255

sys.exit()

2910

2262

# Close all standard open file descriptors

2911

2263

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

2912

2264

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

2913

raise OSError(errno.ENODEV,

2914

"{} not a character device"

2265

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

2915

2266

.format(os.devnull))

2916

2267

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

2917

2268

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

2921

2272

2922

2273

2923

2274

def main():

2924

2275

2925

2276

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

2926

2277

# Parsing of options, both command line and config file

2927

2278

2928

2279

parser = argparse.ArgumentParser()

2929

2280

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

2930

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

2281

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

2931

2282

help="show version number and exit")

2932

2283

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

2933

2284

help="Bind to interface IF")

2969

2320

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

2970

2321

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

2971

2322

default=None)

2972

2323

2973

2324

options = parser.parse_args()

2974

2325

2975

2326

if options.check:

2976

2327

import doctest

2977

2328

fail_count, test_count = doctest.testmod()

2978

2329

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

2979

2330

2980

2331

# Default values for config file for server-global settings

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

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

3004

2349

# Parse config file for server-global settings

3005

server_config = configparser.ConfigParser(server_defaults)

2350

server_config = configparser.SafeConfigParser(server_defaults)

3006

2351

del server_defaults

3007

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

3008

# Convert the ConfigParser object to a dict

2352

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

2353

"mandos.conf"))

2354

# Convert the SafeConfigParser object to a dict

3009

2355

server_settings = server_config.defaults()

3010

2356

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

3011

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

3012

"foreground", "zeroconf"):

2357

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

3013

2358

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

3014

2359

option)

3015

2360

if server_settings["port"]:

3025

2370

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

3026

2371

["socket"])

3027

2372

del server_config

3028

2373

3029

2374

# Override the settings from the config file with command line

3030

2375

# options, if set.

3031

2376

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

3032

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

3033

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

3034

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

2377

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

2378

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

2379

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

3035

2380

value = getattr(options, option)

3036

2381

if value is not None:

3037

2382

server_settings[option] = value

3038

2383

del options

3039

2384

# Force all strings to be unicode

3040

2385

for option in server_settings.keys():

3041

if isinstance(server_settings[option], bytes):

3042

server_settings[option] = (server_settings[option]

3043

.decode("utf-8"))

2386

if type(server_settings[option]) is str:

2387

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

3044

2388

# Force all boolean options to be boolean

3045

2389

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

3046

2390

"foreground", "zeroconf"):

3049

2393

if server_settings["debug"]:

3050

2394

server_settings["foreground"] = True

3051

2395

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

3052

2396

3053

2397

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

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

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

3060

2405

# For convenience

3061

2406

debug = server_settings["debug"]

3062

2407

debuglevel = server_settings["debuglevel"]

3066

2411

stored_state_file)

3067

2412

foreground = server_settings["foreground"]

3068

2413

zeroconf = server_settings["zeroconf"]

3069

2414

3070

2415

if debug:

3071

2416

initlogger(debug, logging.DEBUG)

3072

2417

else:

3075

2420

else:

3076

2421

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

3077

2422

initlogger(debug, level)

3078

2423

3079

2424

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

3080

syslogger.setFormatter(

3081

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

3082

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

3083

server_settings["servicename"])))

3084

2425

syslogger.setFormatter(logging.Formatter

2426

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

2427

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

2428

.format(server_settings

2429

["servicename"])))

2430

3085

2431

# Parse config file with clients

3086

client_config = configparser.ConfigParser(Client.client_defaults)

2432

client_config = configparser.SafeConfigParser(Client

2433

.client_defaults)

3087

2434

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

3088

2435

"clients.conf"))

3089

2436

3090

2437

global mandos_dbus_service

3091

2438

mandos_dbus_service = None

3092

2439

3093

2440

socketfd = None

3094

2441

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

3095

2442

socketfd = server_settings["socket"]

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)

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)

3104

2453

if not foreground:

3105

2454

pidfilename = "/run/mandos.pid"

3106

2455

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

3107

2456

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

3108

2457

pidfile = None

3109

2458

try:

3110

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

2459

pidfile = open(pidfilename, "w")

3111

2460

except IOError as e:

3112

2461

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

3113

2462

exc_info=e)

3114

3115

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

3116

("mandos", "mandos"),

3117

("nobody", "nogroup")):

2463

2464

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

3118

2465

try:

3119

2466

uid = pwd.getpwnam(name).pw_uid

3120

gid = pwd.getpwnam(group).pw_gid

2467

gid = pwd.getpwnam(name).pw_gid

3121

2468

break

3122

2469

except KeyError:

3123

2470

continue

3127

2474

try:

3128

2475

os.setgid(gid)

3129

2476

os.setuid(uid)

3130

if debug:

3131

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

3132

gid))

3133

2477

except OSError as error:

3134

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

3135

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

3136

2478

if error.errno != errno.EPERM:

3137

2479

raise

3138

2480

3139

2481

if debug:

3140

2482

# Enable all possible GnuTLS debugging

3141

2483

3142

2484

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

3143

2485

# - GnuTLS manual

3144

gnutls.global_set_log_level(11)

3145

3146

@gnutls.log_func

2486

gnutls.library.functions.gnutls_global_set_log_level(11)

2487

2488

@gnutls.library.types.gnutls_log_func

3147

2489

def debug_gnutls(level, string):

3148

2490

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

3149

3150

gnutls.global_set_log_function(debug_gnutls)

3151

2491

2492

(gnutls.library.functions

2493

.gnutls_global_set_log_function(debug_gnutls))

2494

3152

2495

# Redirect stdin so all checkers get /dev/null

3153

2496

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

3154

2497

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

3155

2498

if null > 2:

3156

2499

os.close(null)

3157

2500

3158

2501

# Need to fork before connecting to D-Bus

3159

2502

if not foreground:

3160

2503

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

3161

2504

daemon()

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

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

3168

2510

global main_loop

3169

2511

# From the Avahi example code

3170

2512

DBusGMainLoop(set_as_default=True)

3171

main_loop = GLib.MainLoop()

2513

main_loop = gobject.MainLoop()

3172

2514

bus = dbus.SystemBus()

3173

2515

# End of Avahi example code

3174

2516

if use_dbus:

3175

2517

try:

3176

2518

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

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:

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:

3183

2524

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

3184

2525

use_dbus = False

3185

2526

server_settings["use_dbus"] = False

3186

2527

tcp_server.use_dbus = False

3187

2528

if zeroconf:

3188

2529

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3189

service = AvahiServiceToSyslog(

3190

name=server_settings["servicename"],

3191

servicetype="_mandos._tcp",

3192

protocol=protocol,

3193

bus=bus)

2530

service = AvahiServiceToSyslog(name =

2531

server_settings["servicename"],

2532

servicetype = "_mandos._tcp",

2533

protocol = protocol, bus = bus)

3194

2534

if server_settings["interface"]:

3195

service.interface = if_nametoindex(

3196

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

3197

2535

service.interface = (if_nametoindex

2536

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

2537

3198

2538

global multiprocessing_manager

3199

2539

multiprocessing_manager = multiprocessing.Manager()

3200

2540

3201

2541

client_class = Client

3202

2542

if use_dbus:

3203

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

3204

2543

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

2544

3205

2545

client_settings = Client.config_parser(client_config)

3206

2546

old_client_settings = {}

3207

2547

clients_data = {}

3208

2548

3209

2549

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

3210

2550

global wnull

3211

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

2551

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

3212

2552

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

3213

2553

# mode

3214

2554

if debug or not foreground:

3215

2555

wnull.close()

3216

2556

3217

2557

# Get client data and settings from last running state.

3218

2558

if server_settings["restore"]:

3219

2559

try:

3220

2560

with open(stored_state_path, "rb") as 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"))

2561

clients_data, old_client_settings = (pickle.load

2562

(stored_state))

3270

2563

os.remove(stored_state_path)

3271

2564

except IOError as e:

3272

2565

if e.errno == errno.ENOENT:

3273

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

3274

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

2566

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

2567

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

3275

2568

else:

3276

2569

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

3277

2570

exc_info=e)

3278

2571

raise

3279

2572

except EOFError as e:

3280

2573

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

3281

"EOFError:",

3282

exc_info=e)

3283

2574

"EOFError:", exc_info=e)

2575

3284

2576

with PGPEngine() as pgp:

3285

2577

for client_name, client in clients_data.items():

3286

2578

# Skip removed clients

3287

2579

if client_name not in client_settings:

3288

2580

continue

3289

2581

3290

2582

# Decide which value to use after restoring saved state.

3291

2583

# We have three different values: Old config file,

3292

2584

# new config file, and saved state.

3297

2589

# For each value in new config, check if it

3298

2590

# differs from the old config value (Except for

3299

2591

# the "secret" attribute)

3300

if (name != "secret"

3301

and (value !=

3302

old_client_settings[client_name][name])):

2592

if (name != "secret" and

2593

value != old_client_settings[client_name]

2594

[name]):

3303

2595

client[name] = value

3304

2596

except KeyError:

3305

2597

pass

3306

2598

3307

2599

# Clients who has passed its expire date can still be

3308

# enabled if its last checker was successful. A Client

2600

# enabled if its last checker was successful. Clients

3309

2601

# whose checker succeeded before we stored its state is

3310

2602

# assumed to have successfully run all checkers during

3311

2603

# downtime.

3314

2606

if not client["last_checked_ok"]:

3315

2607

logger.warning(

3316

2608

"disabling client {} - Client never "

3317

"performed a successful checker".format(

3318

client_name))

2609

"performed a successful checker"

2610

.format(client_name))

3319

2611

client["enabled"] = False

3320

2612

elif client["last_checker_status"] != 0:

3321

2613

logger.warning(

3322

2614

"disabling client {} - Client last"

3323

" checker failed with error code"

3324

" {}".format(

3325

client_name,

3326

client["last_checker_status"]))

2615

" checker failed with error code {}"

2616

.format(client_name,

2617

client["last_checker_status"]))

3327

2618

client["enabled"] = False

3328

2619

else:

3329

client["expires"] = (

3330

datetime.datetime.utcnow()

3331

+ client["timeout"])

2620

client["expires"] = (datetime.datetime

2621

.utcnow()

2622

+ client["timeout"])

3332

2623

logger.debug("Last checker succeeded,"

3333

" keeping {} enabled".format(

3334

client_name))

2624

" keeping {} enabled"

2625

.format(client_name))

3335

2626

try:

3336

client["secret"] = pgp.decrypt(

3337

client["encrypted_secret"],

3338

client_settings[client_name]["secret"])

2627

client["secret"] = (

2628

pgp.decrypt(client["encrypted_secret"],

2629

client_settings[client_name]

2630

["secret"]))

3339

2631

except PGPError:

3340

2632

# If decryption fails, we use secret from new settings

3341

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

3342

client_name))

3343

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

3344

["secret"])

3345

2633

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

2634

.format(client_name))

2635

client["secret"] = (

2636

client_settings[client_name]["secret"])

2637

3346

2638

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

3347

2639

for client_name in (set(old_client_settings)

3348

2640

- set(client_settings)):

3350

2642

for client_name in (set(client_settings)

3351

2643

- set(old_client_settings)):

3352

2644

clients_data[client_name] = client_settings[client_name]

3353

2645

3354

2646

# Create all client objects

3355

2647

for client_name, client in clients_data.items():

3356

2648

tcp_server.clients[client_name] = client_class(

3357

name=client_name,

3358

settings=client,

3359

server_settings=server_settings)

3360

2649

name = client_name, settings = client,

2650

server_settings = server_settings)

2651

3361

2652

if not tcp_server.clients:

3362

2653

logger.warning("No clients defined")

3363

2654

3364

2655

if not foreground:

3365

2656

if pidfile is not None:

3366

pid = os.getpid()

3367

2657

try:

3368

2658

with pidfile:

3369

print(pid, file=pidfile)

2659

pid = os.getpid()

2660

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

3370

2661

except IOError:

3371

2662

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

3372

2663

pidfilename, pid)

3373

2664

del pidfile

3374

2665

del pidfilename

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

2666

2667

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

2668

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

2669

3380

2670

if use_dbus:

3381

3382

@alternate_dbus_interfaces(

3383

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

3384

class MandosDBusService(DBusObjectWithObjectManager):

2671

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

2672

"se.bsnet.fukt.Mandos"})

2673

class MandosDBusService(DBusObjectWithProperties):

3385

2674

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

3386

3387

2675

def __init__(self):

3388

2676

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

3389

3390

2677

_interface = "se.recompile.Mandos"

3391

2678

2679

@dbus_interface_annotations(_interface)

2680

def _foo(self):

2681

return { "org.freedesktop.DBus.Property"

2682

".EmitsChangedSignal":

2683

"false"}

2684

3392

2685

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

3393

2686

def ClientAdded(self, objpath):

3394

2687

"D-Bus signal"

3395

2688

pass

3396

2689

3397

2690

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

3398

def ClientNotFound(self, key_id, address):

2691

def ClientNotFound(self, fingerprint, address):

3399

2692

"D-Bus signal"

3400

2693

pass

3401

3402

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

3403

"true"})

2694

3404

2695

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

3405

2696

def ClientRemoved(self, objpath, name):

3406

2697

"D-Bus signal"

3407

2698

pass

3408

3409

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

3410

"true"})

2699

3411

2700

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

3412

2701

def GetAllClients(self):

3413

2702

"D-Bus method"

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

2703

return dbus.Array(c.dbus_object_path

2704

for c in

2705

tcp_server.clients.itervalues())

2706

3419

2707

@dbus.service.method(_interface,

3420

2708

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

3421

2709

def GetAllClientsWithProperties(self):

3422

2710

"D-Bus method"

3423

2711

return dbus.Dictionary(

3424

{c.dbus_object_path: c.GetAll(

3425

"se.recompile.Mandos.Client")

3426

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

2712

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

2713

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

3427

2714

signature="oa{sv}")

3428

2715

3429

2716

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

3430

2717

def RemoveClient(self, object_path):

3431

2718

"D-Bus method"

3432

for c in tcp_server.clients.values():

2719

for c in tcp_server.clients.itervalues():

3433

2720

if c.dbus_object_path == object_path:

3434

2721

del tcp_server.clients[c.name]

3435

2722

c.remove_from_connection()

3436

# Don't signal the disabling

2723

# Don't signal anything except ClientRemoved

3437

2724

c.disable(quiet=True)

3438

# Emit D-Bus signal for removal

3439

self.client_removed_signal(c)

2725

# Emit D-Bus signal

2726

self.ClientRemoved(object_path, c.name)

3440

2727

return

3441

2728

raise KeyError(object_path)

3442

2729

3443

2730

del _interface

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

2731

3481

2732

mandos_dbus_service = MandosDBusService()

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

2733

3488

2734

def cleanup():

3489

2735

"Cleanup function; run on exit"

3490

2736

if zeroconf:

3491

2737

service.cleanup()

3492

3493

mp.active_children()

3494

wn.close()

2738

2739

multiprocessing.active_children()

2740

wnull.close()

3495

2741

if not (tcp_server.clients or client_settings):

3496

2742

return

3497

2743

3498

2744

# Store client before exiting. Secrets are encrypted with key

3499

2745

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

3500

2746

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

3501

2747

clients = {}

3502

2748

with PGPEngine() as pgp:

3503

for client in tcp_server.clients.values():

2749

for client in tcp_server.clients.itervalues():

3504

2750

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

3505

2751

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

3506

2752

key)

3507

2753

client_dict = {}

3508

2754

3509

2755

# A list of attributes that can not be pickled

3510

2756

# + secret.

3511

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

3512

"checker", "server_settings"}

3513

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

3514

.Object):

2757

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

2758

"checker", "server_settings" }

2759

for name, typ in (inspect.getmembers

2760

(dbus.service.Object)):

3515

2761

exclude.add(name)

3516

2762

3517

2763

client_dict["encrypted_secret"] = (client

3518

2764

.encrypted_secret)

3519

2765

for attr in client.client_structure:

3520

2766

if attr not in exclude:

3521

2767

client_dict[attr] = getattr(client, attr)

3522

2768

3523

2769

clients[client.name] = client_dict

3524

2770

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

3525

2771

3526

2772

try:

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

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

3536

2779

os.rename(tempname, stored_state_path)

3537

2780

except (IOError, OSError) as e:

3538

2781

if not debug:

3547

2790

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

3548

2791

exc_info=e)

3549

2792

raise

3550

2793

3551

2794

# Delete all clients, and settings from config

3552

2795

while tcp_server.clients:

3553

2796

name, client = tcp_server.clients.popitem()

3554

2797

if use_dbus:

3555

2798

client.remove_from_connection()

3556

# Don't signal the disabling

2799

# Don't signal anything except ClientRemoved

3557

2800

client.disable(quiet=True)

3558

# Emit D-Bus signal for removal

3559

2801

if use_dbus:

3560

mandos_dbus_service.client_removed_signal(client)

2802

# Emit D-Bus signal

2803

mandos_dbus_service.ClientRemoved(client

2804

.dbus_object_path,

2805

client.name)

3561

2806

client_settings.clear()

3562

2807

3563

2808

atexit.register(cleanup)

3564

3565

for client in tcp_server.clients.values():

2809

2810

for client in tcp_server.clients.itervalues():

3566

2811

if use_dbus:

3567

# Emit D-Bus signal for adding

3568

mandos_dbus_service.client_added_signal(client)

2812

# Emit D-Bus signal

2813

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3569

2814

# Need to initiate checking of clients

3570

2815

if client.enabled:

3571

2816

client.init_checker()

3572

2817

3573

2818

tcp_server.enable()

3574

2819

tcp_server.server_activate()

3575

2820

3576

2821

# Find out what port we got

3577

2822

if zeroconf:

3578

2823

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

3583

2828

else: # IPv4

3584

2829

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

3585

2830

*tcp_server.socket.getsockname())

3586

3587

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

3588

2831

2832

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

2833

3589

2834

try:

3590

2835

if zeroconf:

3591

2836

# From the Avahi example code

3596

2841

cleanup()

3597

2842

sys.exit(1)

3598

2843

# End of Avahi example code

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

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

3605

2850

logger.debug("Starting main loop")

3606

2851

main_loop.run()

3607

2852

except AvahiError as error:

3616

2861

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

3617

2862

cleanup()

3618

2863

3619

3620

2864

if __name__ == '__main__':

3621

2865

main()