/mandos/release : revision 237.7.281

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

89

SO_BINDTODEVICE = None

115

90

116

91

if sys.version_info.major == 2:

117

92

str = unicode

118

93

119

if sys.version_info < (3, 2):

120

configparser.Configparser = configparser.SafeConfigParser

121

122

version = "1.8.5"

94

version = "1.6.8"

123

95

stored_state_file = "clients.pickle"

124

96

125

97

logger = logging.getLogger()

126

98

syslogger = None

127

99

128

100

try:

129

if_nametoindex = ctypes.cdll.LoadLibrary(

130

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

131

104

except (OSError, AttributeError):

132

133

105

def if_nametoindex(interface):

134

106

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

135

107

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

140

112

return interface_index

141

113

142

114

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

115

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

160

116

"""init logger and add loglevel"""

161

117

162

118

global syslogger

163

syslogger = (logging.handlers.SysLogHandler(

164

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

165

address="/dev/log"))

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

166

123

syslogger.setFormatter(logging.Formatter

167

124

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

168

125

' %(message)s'))

169

126

logger.addHandler(syslogger)

170

127

171

128

if debug:

172

129

console = logging.StreamHandler()

173

130

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

185

142

186

143

class PGPEngine(object):

187

144

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

188

189

145

def __init__(self):

190

146

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

147

self.gnupgargs = ['--batch',

203

'--homedir', self.tempdir,

148

'--home', self.tempdir,

204

149

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

150

'--quiet',

151

'--no-use-agent']

152

210

153

def __enter__(self):

211

154

return self

212

155

213

156

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

214

157

self._cleanup()

215

158

return False

216

159

217

160

def __del__(self):

218

161

self._cleanup()

219

162

220

163

def _cleanup(self):

221

164

if self.tempdir is not None:

222

165

# Delete contents of tempdir

223

166

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

224

topdown=False):

167

topdown = False):

225

168

for filename in files:

226

169

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

227

170

for dirname in dirs:

229

172

# Remove tempdir

230

173

os.rmdir(self.tempdir)

231

174

self.tempdir = None

232

175

233

176

def password_encode(self, password):

234

177

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

235

178

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

240

183

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

241

184

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

242

185

return encoded

243

186

244

187

def encrypt(self, data, password):

245

188

passphrase = self.password_encode(password)

246

with tempfile.NamedTemporaryFile(

247

dir=self.tempdir) as passfile:

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

248

191

passfile.write(passphrase)

249

192

passfile.flush()

250

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

193

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

251

194

'--passphrase-file',

252

195

passfile.name]

253

196

+ self.gnupgargs,

254

stdin=subprocess.PIPE,

255

stdout=subprocess.PIPE,

256

stderr=subprocess.PIPE)

257

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

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

258

201

if proc.returncode != 0:

259

202

raise PGPError(err)

260

203

return ciphertext

261

204

262

205

def decrypt(self, data, password):

263

206

passphrase = self.password_encode(password)

264

with tempfile.NamedTemporaryFile(

265

dir=self.tempdir) as passfile:

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

266

209

passfile.write(passphrase)

267

210

passfile.flush()

268

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

211

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

269

212

'--passphrase-file',

270

213

passfile.name]

271

214

+ self.gnupgargs,

272

stdin=subprocess.PIPE,

273

stdout=subprocess.PIPE,

274

stderr=subprocess.PIPE)

275

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

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

276

220

if proc.returncode != 0:

277

221

raise PGPError(err)

278

222

return decrypted_plaintext

279

223

280

224

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

225

class AvahiError(Exception):

308

226

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

309

227

self.value = value

310

228

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

311

229

**kwargs)

312

230

313

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 = str(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:

435

338

elif state == avahi.ENTRY_GROUP_FAILURE:

436

339

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

437

340

str(error))

438

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

439

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(str(getattr(self, attr)))

692

for attr in self.runtime_expansions }

1112

693

try:

1113

694

command = self.checker_command % escaped_attrs

1114

695

except TypeError as error:

1115

696

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

1116

self.checker_command,

697

self.checker_command, exc_info=error)

698

return True # Try again later

699

self.current_checker_command = command

700

try:

701

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

702

command, self.name)

703

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

704

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

705

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

706

# always replaced by /dev/null.)

707

# The exception is when not debugging but nevertheless

708

# running in the foreground; use the previously

709

# created wnull.

710

popen_args = {}

711

if (not self.server_settings["debug"]

712

and self.server_settings["foreground"]):

713

popen_args.update({"stdout": wnull,

714

"stderr": wnull })

715

self.checker = subprocess.Popen(command,

716

close_fds=True,

717

shell=True, cwd="/",

718

**popen_args)

719

except OSError as error:

720

logger.error("Failed to start subprocess",

1117

721

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

722

return True

723

self.checker_callback_tag = (gobject.child_watch_add

724

(self.checker.pid,

725

self.checker_callback,

726

data=command))

727

# The checker may have completed before the gobject

728

# watch was added. Check for this.

729

try:

730

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

731

except OSError as error:

732

if error.errno == errno.ECHILD:

733

# This should never happen

734

logger.error("Child process vanished",

735

exc_info=error)

736

return True

737

raise

738

if pid:

739

gobject.source_remove(self.checker_callback_tag)

740

self.checker_callback(pid, status, command)

741

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

1146

742

return True

1147

743

1148

744

def stop_checker(self):

1149

745

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

1150

746

if self.checker_callback_tag:

1151

GLib.source_remove(self.checker_callback_tag)

747

gobject.source_remove(self.checker_callback_tag)

1152

748

self.checker_callback_tag = None

1153

749

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

1154

750

return

1155

751

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

1156

self.checker.terminate()

752

try:

753

self.checker.terminate()

754

#time.sleep(0.5)

755

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

756

# self.checker.kill()

757

except OSError as error:

758

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

759

raise

1157

760

self.checker = None

1158

761

1159

762

1160

def dbus_service_property(dbus_interface,

1161

signature="v",

1162

access="readwrite",

1163

byte_arrays=False):

763

def dbus_service_property(dbus_interface, signature="v",

764

access="readwrite", byte_arrays=False):

1164

765

"""Decorators for marking methods of a DBusObjectWithProperties to

1165

766

become properties on the D-Bus.

1166

767

1167

768

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

1168

769

and with one argument by "Set".

1169

770

1170

771

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

1171

772

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

1172

773

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

1176

777

if byte_arrays and signature != "ay":

1177

778

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

1178

779

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

1179

1180

780

def decorator(func):

1181

781

func._dbus_is_property = True

1182

782

func._dbus_interface = dbus_interface

1185

785

func._dbus_name = func.__name__

1186

786

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

1187

787

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

1188

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

788

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1189

789

return func

1190

1191

790

return decorator

1192

791

1193

792

1194

793

def dbus_interface_annotations(dbus_interface):

1195

794

"""Decorator for marking functions returning interface annotations

1196

795

1197

796

Usage:

1198

797

1199

798

@dbus_interface_annotations("org.example.Interface")

1200

799

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

1201

800

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

1202

801

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

1203

802

"false"}

1204

803

"""

1205

1206

804

def decorator(func):

1207

805

func._dbus_is_interface = True

1208

806

func._dbus_interface = dbus_interface

1209

807

func._dbus_name = dbus_interface

1210

808

return func

1211

1212

809

return decorator

1213

810

1214

811

1215

812

def dbus_annotations(annotations):

1216

813

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

1217

814

Usage:

1218

815

1219

816

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

1220

817

"org.freedesktop.DBus.Property."

1221

818

"EmitsChangedSignal": "false"})

1223

820

access="r")

1224

821

def Property_dbus_property(self):

1225

822

return dbus.Boolean(False)

1226

1227

See also the DBusObjectWithAnnotations class.

1228

823

"""

1229

1230

824

def decorator(func):

1231

825

func._dbus_annotations = annotations

1232

826

return func

1233

1234

827

return decorator

1235

828

1236

829

1239

832

"""

1240

833

pass

1241

834

1242

1243

835

class DBusPropertyAccessException(DBusPropertyException):

1244

836

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

1245

837

"""

1252

844

pass

1253

845

1254

846

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.

847

class DBusObjectWithProperties(dbus.service.Object):

848

"""A D-Bus object with properties.

849

850

Classes inheriting from this can use the dbus_service_property

851

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

852

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

1260

853

"""

1261

854

1262

855

@staticmethod

1263

856

def _is_dbus_thing(thing):

1264

857

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

1265

858

1266

859

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

1267

860

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

1268

861

"""

1269

862

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

1270

863

False)

1271

864

1272

865

def _get_all_dbus_things(self, thing):

1273

866

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

1274

867

"""

1275

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

868

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

869

name),

1276

870

athing.__get__(self))

1277

871

for cls in self.__class__.__mro__

1278

872

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

873

inspect.getmembers(cls,

874

self._is_dbus_thing(thing)))

875

1352

876

def _get_dbus_property(self, interface_name, property_name):

1353

877

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

1354

878

property with the specified name and interface.

1355

879

"""

1356

for cls in self.__class__.__mro__:

1357

for name, value in inspect.getmembers(

1358

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

880

for cls in self.__class__.__mro__:

881

for name, value in (inspect.getmembers

882

(cls,

883

self._is_dbus_thing("property"))):

1359

884

if (value._dbus_name == property_name

1360

885

and value._dbus_interface == interface_name):

1361

886

return value.__get__(self)

1362

887

1363

888

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

889

raise DBusPropertyNotFound(self.dbus_object_path + ":"

890

+ interface_name + "."

891

+ property_name)

892

893

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

1378

894

out_signature="v")

1379

895

def Get(self, interface_name, property_name):

1380

896

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

1386

902

if not hasattr(value, "variant_level"):

1387

903

return value

1388

904

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

1389

905

1390

906

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

1391

907

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

1392

908

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

1404

920

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

1405

921

for byte in value))

1406

922

prop(value)

1407

1408

@dbus.service.method(dbus.PROPERTIES_IFACE,

1409

in_signature="s",

923

924

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

1410

925

out_signature="a{sv}")

1411

926

def GetAll(self, interface_name):

1412

927

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

1413

928

standard.

1414

929

1415

930

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

1416

931

"""

1417

932

properties = {}

1427

942

if not hasattr(value, "variant_level"):

1428

943

properties[name] = value

1429

944

continue

1430

properties[name] = type(value)(

1431

value, variant_level=value.variant_level + 1)

945

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

946

value.variant_level+1)

1432

947

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

1433

948

1434

949

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

1435

950

def PropertiesChanged(self, interface_name, changed_properties,

1436

951

invalidated_properties):

1438

953

standard.

1439

954

"""

1440

955

pass

1441

956

1442

957

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1443

958

out_signature="s",

1444

959

path_keyword='object_path',

1445

960

connection_keyword='connection')

1446

961

def Introspect(self, object_path, connection):

1447

962

"""Overloading of standard D-Bus method.

1448

963

1449

964

Inserts property tags and interface annotation tags.

1450

965

"""

1451

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1452

object_path,

1453

connection)

966

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

967

connection)

1454

968

try:

1455

969

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

1456

1457

970

def make_tag(document, name, prop):

1458

971

e = document.createElement("property")

1459

972

e.setAttribute("name", name)

1460

973

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

1461

974

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

1462

975

return e

1463

1464

976

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

1465

977

# Add property tags

1466

978

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

1469

981

if prop._dbus_interface

1470

982

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

1471

983

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)

984

# Add annotation tags

985

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

986

for tag in if_tag.getElementsByTagName(typ):

987

annots = dict()

988

for name, prop in (self.

989

_get_all_dbus_things(typ)):

990

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

991

and prop._dbus_interface

992

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

993

annots.update(getattr

994

(prop,

995

"_dbus_annotations",

996

{}))

997

for name, value in annots.items():

998

ann_tag = document.createElement(

999

"annotation")

1000

ann_tag.setAttribute("name", name)

1001

ann_tag.setAttribute("value", value)

1002

tag.appendChild(ann_tag)

1003

# Add interface annotation tags

1004

for annotation, value in dict(

1005

itertools.chain.from_iterable(

1006

annotations().items()

1007

for name, annotations in

1008

self._get_all_dbus_things("interface")

1009

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

1010

)).items():

1011

ann_tag = document.createElement("annotation")

1012

ann_tag.setAttribute("name", annotation)

1013

ann_tag.setAttribute("value", value)

1014

if_tag.appendChild(ann_tag)

1488

1015

# Add the names to the return values for the

1489

1016

# "org.freedesktop.DBus.Properties" methods

1490

1017

if (if_tag.getAttribute("name")

1509

1036

return xmlstring

1510

1037

1511

1038

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

1039

def datetime_to_dbus(dt, variant_level=0):

1584

1040

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

1585

1041

if dt is None:

1586

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

1587

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

1042

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

1043

return dbus.String(dt.isoformat(),

1044

variant_level=variant_level)

1588

1045

1589

1046

1590

1047

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1592

1049

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

1593

1050

interface names according to the "alt_interface_names" mapping.

1594

1051

Usage:

1595

1052

1596

1053

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

1597

1054

"net.example.AlternateInterface"})

1598

1055

class SampleDBusObject(dbus.service.Object):

1599

1056

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

1600

1057

def SampleDBusMethod():

1601

1058

pass

1602

1059

1603

1060

The above "SampleDBusMethod" on "SampleDBusObject" will be

1604

1061

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

1605

1062

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

1606

1063

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

1607

1064

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

1608

1065

1609

1066

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

1610

1067

(from DBusObjectWithProperties) and interfaces (from the

1611

1068

dbus_interface_annotations decorator).

1612

1069

"""

1613

1614

1070

def wrapper(cls):

1615

1071

for orig_interface_name, alt_interface_name in (

1616

alt_interface_names.items()):

1072

alt_interface_names.items()):

1617

1073

attr = {}

1618

1074

interface_names = set()

1619

1075

# Go though all attributes of the class

1621

1077

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

1622

1078

# with the wrong interface name

1623

1079

if (not hasattr(attribute, "_dbus_interface")

1624

or not attribute._dbus_interface.startswith(

1625

orig_interface_name)):

1080

or not attribute._dbus_interface

1081

.startswith(orig_interface_name)):

1626

1082

continue

1627

1083

# Create an alternate D-Bus interface name based on

1628

1084

# the current name

1629

alt_interface = attribute._dbus_interface.replace(

1630

orig_interface_name, alt_interface_name)

1085

alt_interface = (attribute._dbus_interface

1086

.replace(orig_interface_name,

1087

alt_interface_name))

1631

1088

interface_names.add(alt_interface)

1632

1089

# Is this a D-Bus signal?

1633

1090

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

1634

1091

# Extract the original non-method undecorated

1635

1092

# function by black magic

1636

if sys.version_info.major == 2:

1637

nonmethod_func = (dict(

1093

nonmethod_func = (dict(

1638

1094

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)

1095

attribute.__closure__))["func"]

1096

.cell_contents)

1646

1097

# Create a new, but exactly alike, function

1647

1098

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

1648

1099

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

1100

new_function = (dbus.service.signal

1101

(alt_interface,

1102

attribute._dbus_signature)

1103

(types.FunctionType(

1104

nonmethod_func.func_code,

1105

nonmethod_func.func_globals,

1106

nonmethod_func.func_name,

1107

nonmethod_func.func_defaults,

1108

nonmethod_func.func_closure)))

1653

1109

# Copy annotations, if any

1654

1110

try:

1655

new_function._dbus_annotations = dict(

1656

attribute._dbus_annotations)

1111

new_function._dbus_annotations = (

1112

dict(attribute._dbus_annotations))

1657

1113

except AttributeError:

1658

1114

pass

1659

1660

1115

# Define a creator of a function to call both the

1661

1116

# original and alternate functions, so both the

1662

1117

# original and alternate signals gets sent when

1665

1120

"""This function is a scope container to pass

1666

1121

func1 and func2 to the "call_both" function

1667

1122

outside of its arguments"""

1668

1669

@functools.wraps(func2)

1670

1123

def call_both(*args, **kwargs):

1671

1124

"""This function will emit two D-Bus

1672

1125

signals by calling func1 and func2"""

1673

1126

func1(*args, **kwargs)

1674

1127

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

1128

return call_both

1682

1129

# Create the "call_both" function and add it to

1683

1130

# the class

1688

1135

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

1689

1136

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

1690

1137

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

1138

attr[attrname] = (dbus.service.method

1139

(alt_interface,

1140

attribute._dbus_in_signature,

1141

attribute._dbus_out_signature)

1142

(types.FunctionType

1143

(attribute.func_code,

1144

attribute.func_globals,

1145

attribute.func_name,

1146

attribute.func_defaults,

1147

attribute.func_closure)))

1697

1148

# Copy annotations, if any

1698

1149

try:

1699

attr[attrname]._dbus_annotations = dict(

1700

attribute._dbus_annotations)

1150

attr[attrname]._dbus_annotations = (

1151

dict(attribute._dbus_annotations))

1701

1152

except AttributeError:

1702

1153

pass

1703

1154

# Is this a D-Bus property?

1706

1157

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

1707

1158

# property with the alternate D-Bus interface

1708

1159

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

1160

attr[attrname] = (dbus_service_property

1161

(alt_interface,

1162

attribute._dbus_signature,

1163

attribute._dbus_access,

1164

attribute

1165

._dbus_get_args_options

1166

["byte_arrays"])

1167

(types.FunctionType

1168

(attribute.func_code,

1169

attribute.func_globals,

1170

attribute.func_name,

1171

attribute.func_defaults,

1172

attribute.func_closure)))

1715

1173

# Copy annotations, if any

1716

1174

try:

1717

attr[attrname]._dbus_annotations = dict(

1718

attribute._dbus_annotations)

1175

attr[attrname]._dbus_annotations = (

1176

dict(attribute._dbus_annotations))

1719

1177

except AttributeError:

1720

1178

pass

1721

1179

# Is this a D-Bus interface?

1724

1182

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

1725

1183

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

1726

1184

# to the class.

1727

attr[attrname] = (

1728

dbus_interface_annotations(alt_interface)

1729

(copy_function(attribute)))

1185

attr[attrname] = (dbus_interface_annotations

1186

(alt_interface)

1187

(types.FunctionType

1188

(attribute.func_code,

1189

attribute.func_globals,

1190

attribute.func_name,

1191

attribute.func_defaults,

1192

attribute.func_closure)))

1730

1193

if deprecate:

1731

1194

# Deprecate all alternate interfaces

1732

iname = "_AlternateDBusNames_interface_annotation{}"

1195

iname="_AlternateDBusNames_interface_annotation{}"

1733

1196

for interface_name in interface_names:

1734

1735

1197

@dbus_interface_annotations(interface_name)

1736

1198

def func(self):

1737

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

1738

"true"}

1199

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

1200

"true" }

1739

1201

# Find an unused name

1740

1202

for aname in (iname.format(i)

1741

1203

for i in itertools.count()):

1745

1207

if interface_names:

1746

1208

# Replace the class with a new subclass of it with

1747

1209

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

1210

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

1211

(cls,), attr)

1754

1212

return cls

1755

1756

1213

return wrapper

1757

1214

1758

1215

1759

1216

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

1760

"se.bsnet.fukt.Mandos"})

1217

"se.bsnet.fukt.Mandos"})

1761

1218

class ClientDBus(Client, DBusObjectWithProperties):

1762

1219

"""A Client class using D-Bus

1763

1220

1764

1221

Attributes:

1765

1222

dbus_object_path: dbus.ObjectPath

1766

1223

bus: dbus.SystemBus()

1767

1224

"""

1768

1225

1769

1226

runtime_expansions = (Client.runtime_expansions

1770

+ ("dbus_object_path", ))

1771

1227

+ ("dbus_object_path",))

1228

1772

1229

_interface = "se.recompile.Mandos.Client"

1773

1230

1774

1231

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

1775

1776

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

1232

1233

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

1777

1234

self.bus = bus

1778

1235

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

1779

1236

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

1781

1238

client_object_name = str(self.name).translate(

1782

1239

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

1783

1240

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

1784

self.dbus_object_path = dbus.ObjectPath(

1785

"/clients/" + client_object_name)

1241

self.dbus_object_path = (dbus.ObjectPath

1242

("/clients/" + client_object_name))

1786

1243

DBusObjectWithProperties.__init__(self, self.bus,

1787

1244

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,

1245

1246

def notifychangeproperty(transform_func,

1247

dbus_name, type_func=lambda x: x,

1248

variant_level=1, invalidate_only=False,

1793

1249

_interface=_interface):

1794

1250

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

1795

1251

its changes to DBus.

1796

1252

1797

1253

transform_fun: Function that takes a value and a variant_level

1798

1254

and transforms it to a D-Bus type.

1799

1255

dbus_name: D-Bus name of the variable

1802

1258

variant_level: D-Bus variant level. Default: 1

1803

1259

"""

1804

1260

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

1805

1806

1261

def setter(self, value):

1807

1262

if hasattr(self, "dbus_object_path"):

1808

1263

if (not hasattr(self, attrname) or

1809

1264

type_func(getattr(self, attrname, None))

1810

1265

!= type_func(value)):

1811

1266

if invalidate_only:

1812

self.PropertiesChanged(

1813

_interface, dbus.Dictionary(),

1814

dbus.Array((dbus_name, )))

1267

self.PropertiesChanged(_interface,

1268

dbus.Dictionary(),

1269

dbus.Array

1270

((dbus_name,)))

1815

1271

else:

1816

dbus_value = transform_func(

1817

type_func(value),

1818

variant_level=variant_level)

1272

dbus_value = transform_func(type_func(value),

1273

variant_level

1274

=variant_level)

1819

1275

self.PropertyChanged(dbus.String(dbus_name),

1820

1276

dbus_value)

1821

self.PropertiesChanged(

1822

_interface,

1823

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

1824

dbus_value}),

1825

dbus.Array())

1277

self.PropertiesChanged(_interface,

1278

dbus.Dictionary({

1279

dbus.String(dbus_name):

1280

dbus_value }), dbus.Array())

1826

1281

setattr(self, attrname, value)

1827

1282

1828

1283

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

1829

1284

1830

1285

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1831

1286

approvals_pending = notifychangeproperty(dbus.Boolean,

1832

1287

"ApprovalPending",

1833

type_func=bool)

1288

type_func = bool)

1834

1289

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

1835

1290

last_enabled = notifychangeproperty(datetime_to_dbus,

1836

1291

"LastEnabled")

1837

checker = notifychangeproperty(

1838

dbus.Boolean, "CheckerRunning",

1839

type_func=lambda checker: checker is not None)

1292

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

1293

type_func = lambda checker:

1294

checker is not None)

1840

1295

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1841

1296

"LastCheckedOK")

1842

1297

last_checker_status = notifychangeproperty(dbus.Int16,

1845

1300

datetime_to_dbus, "LastApprovalRequest")

1846

1301

approved_by_default = notifychangeproperty(dbus.Boolean,

1847

1302

"ApprovedByDefault")

1848

approval_delay = notifychangeproperty(

1849

dbus.UInt64, "ApprovalDelay",

1850

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

1303

approval_delay = notifychangeproperty(dbus.UInt64,

1304

"ApprovalDelay",

1305

type_func =

1306

lambda td: td.total_seconds()

1307

* 1000)

1851

1308

approval_duration = notifychangeproperty(

1852

1309

dbus.UInt64, "ApprovalDuration",

1853

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

1310

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

1854

1311

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

1855

timeout = notifychangeproperty(

1856

dbus.UInt64, "Timeout",

1857

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

1312

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

1313

type_func = lambda td:

1314

td.total_seconds() * 1000)

1858

1315

extended_timeout = notifychangeproperty(

1859

1316

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)

1317

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

1318

interval = notifychangeproperty(dbus.UInt64,

1319

"Interval",

1320

type_func =

1321

lambda td: td.total_seconds()

1322

* 1000)

1864

1323

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

1865

1324

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

1866

1325

invalidate_only=True)

1867

1326

1868

1327

del notifychangeproperty

1869

1328

1870

1329

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

1871

1330

try:

1872

1331

self.remove_from_connection()

1875

1334

if hasattr(DBusObjectWithProperties, "__del__"):

1876

1335

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

1877

1336

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:

1337

1338

def checker_callback(self, pid, condition, command,

1339

*args, **kwargs):

1340

self.checker_callback_tag = None

1341

self.checker = None

1342

if os.WIFEXITED(condition):

1343

exitstatus = os.WEXITSTATUS(condition)

1886

1344

# Emit D-Bus signal

1887

1345

self.CheckerCompleted(dbus.Int16(exitstatus),

1888

# This is specific to GNU libC

1889

dbus.Int64(exitstatus << 8),

1346

dbus.Int64(condition),

1890

1347

dbus.String(command))

1891

1348

else:

1892

1349

# Emit D-Bus signal

1893

1350

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

1894

dbus.Int64(

1895

# This is specific to GNU libC

1896

(exitstatus << 8)

1897

| self.last_checker_signal),

1351

dbus.Int64(condition),

1898

1352

dbus.String(command))

1899

return ret

1900

1353

1354

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

1355

*args, **kwargs)

1356

1901

1357

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

1902

1358

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

1903

1359

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

1907

1363

# Emit D-Bus signal

1908

1364

self.CheckerStarted(self.current_checker_command)

1909

1365

return r

1910

1366

1911

1367

def _reset_approved(self):

1912

1368

self.approved = None

1913

1369

return False

1914

1370

1915

1371

def approve(self, value=True):

1916

1372

self.approved = value

1917

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

1918

* 1000), self._reset_approved)

1373

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

1374

* 1000), self._reset_approved)

1919

1375

self.send_changedstate()

1920

1921

# D-Bus methods, signals & properties

1922

1923

# Interfaces

1924

1925

# Signals

1926

1376

1377

## D-Bus methods, signals & properties

1378

1379

## Interfaces

1380

1381

## Signals

1382

1927

1383

# CheckerCompleted - signal

1928

1384

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

1929

1385

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

1930

1386

"D-Bus signal"

1931

1387

pass

1932

1388

1933

1389

# CheckerStarted - signal

1934

1390

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

1935

1391

def CheckerStarted(self, command):

1936

1392

"D-Bus signal"

1937

1393

pass

1938

1394

1939

1395

# PropertyChanged - signal

1940

1396

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

1941

1397

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

1942

1398

def PropertyChanged(self, property, value):

1943

1399

"D-Bus signal"

1944

1400

pass

1945

1401

1946

1402

# GotSecret - signal

1947

1403

@dbus.service.signal(_interface)

1948

1404

def GotSecret(self):

1951

1407

server to mandos-client

1952

1408

"""

1953

1409

pass

1954

1410

1955

1411

# Rejected - signal

1956

1412

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

1957

1413

def Rejected(self, reason):

1958

1414

"D-Bus signal"

1959

1415

pass

1960

1416

1961

1417

# NeedApproval - signal

1962

1418

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

1963

1419

def NeedApproval(self, timeout, default):

1964

1420

"D-Bus signal"

1965

1421

return self.need_approval()

1966

1967

# Methods

1968

1422

1423

## Methods

1424

1969

1425

# Approve - method

1970

1426

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

1971

1427

def Approve(self, value):

1972

1428

self.approve(value)

1973

1429

1974

1430

# CheckedOK - method

1975

1431

@dbus.service.method(_interface)

1976

1432

def CheckedOK(self):

1977

1433

self.checked_ok()

1978

1434

1979

1435

# Enable - method

1980

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

1981

1436

@dbus.service.method(_interface)

1982

1437

def Enable(self):

1983

1438

"D-Bus method"

1984

1439

self.enable()

1985

1440

1986

1441

# StartChecker - method

1987

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

1988

1442

@dbus.service.method(_interface)

1989

1443

def StartChecker(self):

1990

1444

"D-Bus method"

1991

1445

self.start_checker()

1992

1446

1993

1447

# Disable - method

1994

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

1995

1448

@dbus.service.method(_interface)

1996

1449

def Disable(self):

1997

1450

"D-Bus method"

1998

1451

self.disable()

1999

1452

2000

1453

# StopChecker - method

2001

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

2002

1454

@dbus.service.method(_interface)

2003

1455

def StopChecker(self):

2004

1456

self.stop_checker()

2005

2006

# Properties

2007

1457

1458

## Properties

1459

2008

1460

# ApprovalPending - property

2009

1461

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

2010

1462

def ApprovalPending_dbus_property(self):

2011

1463

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

2012

1464

2013

1465

# ApprovedByDefault - property

2014

@dbus_service_property(_interface,

2015

signature="b",

1466

@dbus_service_property(_interface, signature="b",

2016

1467

access="readwrite")

2017

1468

def ApprovedByDefault_dbus_property(self, value=None):

2018

1469

if value is None: # get

2019

1470

return dbus.Boolean(self.approved_by_default)

2020

1471

self.approved_by_default = bool(value)

2021

1472

2022

1473

# ApprovalDelay - property

2023

@dbus_service_property(_interface,

2024

signature="t",

1474

@dbus_service_property(_interface, signature="t",

2025

1475

access="readwrite")

2026

1476

def ApprovalDelay_dbus_property(self, value=None):

2027

1477

if value is None: # get

2028

1478

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

2029

1479

* 1000)

2030

1480

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

2031

1481

2032

1482

# ApprovalDuration - property

2033

@dbus_service_property(_interface,

2034

signature="t",

1483

@dbus_service_property(_interface, signature="t",

2035

1484

access="readwrite")

2036

1485

def ApprovalDuration_dbus_property(self, value=None):

2037

1486

if value is None: # get

2038

1487

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

2039

1488

* 1000)

2040

1489

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

2041

1490

2042

1491

# Name - property

2043

@dbus_annotations(

2044

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

2045

1492

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

2046

1493

def Name_dbus_property(self):

2047

1494

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

1495

2056

1496

# Fingerprint - property

2057

@dbus_annotations(

2058

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

2059

1497

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

2060

1498

def Fingerprint_dbus_property(self):

2061

1499

return dbus.String(self.fingerprint)

2062

1500

2063

1501

# Host - property

2064

@dbus_service_property(_interface,

2065

signature="s",

1502

@dbus_service_property(_interface, signature="s",

2066

1503

access="readwrite")

2067

1504

def Host_dbus_property(self, value=None):

2068

1505

if value is None: # get

2069

1506

return dbus.String(self.host)

2070

1507

self.host = str(value)

2071

1508

2072

1509

# Created - property

2073

@dbus_annotations(

2074

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

2075

1510

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

2076

1511

def Created_dbus_property(self):

2077

1512

return datetime_to_dbus(self.created)

2078

1513

2079

1514

# LastEnabled - property

2080

1515

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

2081

1516

def LastEnabled_dbus_property(self):

2082

1517

return datetime_to_dbus(self.last_enabled)

2083

1518

2084

1519

# Enabled - property

2085

@dbus_service_property(_interface,

2086

signature="b",

1520

@dbus_service_property(_interface, signature="b",

2087

1521

access="readwrite")

2088

1522

def Enabled_dbus_property(self, value=None):

2089

1523

if value is None: # get

2092

1526

self.enable()

2093

1527

else:

2094

1528

self.disable()

2095

1529

2096

1530

# LastCheckedOK - property

2097

@dbus_service_property(_interface,

2098

signature="s",

1531

@dbus_service_property(_interface, signature="s",

2099

1532

access="readwrite")

2100

1533

def LastCheckedOK_dbus_property(self, value=None):

2101

1534

if value is not None:

2102

1535

self.checked_ok()

2103

1536

return

2104

1537

return datetime_to_dbus(self.last_checked_ok)

2105

1538

2106

1539

# LastCheckerStatus - property

2107

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

1540

@dbus_service_property(_interface, signature="n",

1541

access="read")

2108

1542

def LastCheckerStatus_dbus_property(self):

2109

1543

return dbus.Int16(self.last_checker_status)

2110

1544

2111

1545

# Expires - property

2112

1546

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

2113

1547

def Expires_dbus_property(self):

2114

1548

return datetime_to_dbus(self.expires)

2115

1549

2116

1550

# LastApprovalRequest - property

2117

1551

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

2118

1552

def LastApprovalRequest_dbus_property(self):

2119

1553

return datetime_to_dbus(self.last_approval_request)

2120

1554

2121

1555

# Timeout - property

2122

@dbus_service_property(_interface,

2123

signature="t",

1556

@dbus_service_property(_interface, signature="t",

2124

1557

access="readwrite")

2125

1558

def Timeout_dbus_property(self, value=None):

2126

1559

if value is None: # get

2138

1571

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

2139

1572

is None):

2140

1573

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

1574

gobject.source_remove(self.disable_initiator_tag)

1575

self.disable_initiator_tag = (

1576

gobject.timeout_add(

1577

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

1578

* 1000), self.disable))

1579

2146

1580

# ExtendedTimeout - property

2147

@dbus_service_property(_interface,

2148

signature="t",

1581

@dbus_service_property(_interface, signature="t",

2149

1582

access="readwrite")

2150

1583

def ExtendedTimeout_dbus_property(self, value=None):

2151

1584

if value is None: # get

2152

1585

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

2153

1586

* 1000)

2154

1587

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

2155

1588

2156

1589

# Interval - property

2157

@dbus_service_property(_interface,

2158

signature="t",

1590

@dbus_service_property(_interface, signature="t",

2159

1591

access="readwrite")

2160

1592

def Interval_dbus_property(self, value=None):

2161

1593

if value is None: # get

2165

1597

return

2166

1598

if self.enabled:

2167

1599

# 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

1600

gobject.source_remove(self.checker_initiator_tag)

1601

self.checker_initiator_tag = (gobject.timeout_add

1602

(value, self.start_checker))

1603

self.start_checker() # Start one now, too

1604

2173

1605

# Checker - property

2174

@dbus_service_property(_interface,

2175

signature="s",

1606

@dbus_service_property(_interface, signature="s",

2176

1607

access="readwrite")

2177

1608

def Checker_dbus_property(self, value=None):

2178

1609

if value is None: # get

2179

1610

return dbus.String(self.checker_command)

2180

1611

self.checker_command = str(value)

2181

1612

2182

1613

# CheckerRunning - property

2183

@dbus_service_property(_interface,

2184

signature="b",

1614

@dbus_service_property(_interface, signature="b",

2185

1615

access="readwrite")

2186

1616

def CheckerRunning_dbus_property(self, value=None):

2187

1617

if value is None: # get

2190

1620

self.start_checker()

2191

1621

else:

2192

1622

self.stop_checker()

2193

1623

2194

1624

# ObjectPath - property

2195

@dbus_annotations(

2196

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

2197

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

2198

1625

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

2199

1626

def ObjectPath_dbus_property(self):

2200

return self.dbus_object_path # is already a dbus.ObjectPath

2201

1627

return self.dbus_object_path # is already a dbus.ObjectPath

1628

2202

1629

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

1630

@dbus_service_property(_interface, signature="ay",

1631

access="write", byte_arrays=True)

2210

1632

def Secret_dbus_property(self, value):

2211

1633

self.secret = bytes(value)

2212

1634

2213

1635

del _interface

2214

1636

2215

1637

2216

1638

class ProxyClient(object):

2217

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

1639

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

2218

1640

self._pipe = child_pipe

2219

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

1641

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

2220

1642

if not self._pipe.recv():

2221

raise KeyError(key_id or fpr)

2222

1643

raise KeyError()

1644

2223

1645

def __getattribute__(self, name):

2224

1646

if name == '_pipe':

2225

1647

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

2228

1650

if data[0] == 'data':

2229

1651

return data[1]

2230

1652

if data[0] == 'function':

2231

2232

1653

def func(*args, **kwargs):

2233

1654

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

2234

1655

return self._pipe.recv()[1]

2235

2236

1656

return func

2237

1657

2238

1658

def __setattr__(self, name, value):

2239

1659

if name == '_pipe':

2240

1660

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

2243

1663

2244

1664

class ClientHandler(socketserver.BaseRequestHandler, object):

2245

1665

"""A class to handle client connections.

2246

1666

2247

1667

Instantiated once for each connection to handle it.

2248

1668

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

2249

1669

2250

1670

def handle(self):

2251

1671

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

2252

1672

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

2253

1673

str(self.client_address))

2254

1674

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

2255

1675

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

1676

1677

session = (gnutls.connection

1678

.ClientSession(self.request,

1679

gnutls.connection

1680

.X509Credentials()))

1681

1682

# Note: gnutls.connection.X509Credentials is really a

1683

# generic GnuTLS certificate credentials object so long as

1684

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

1685

# here despite using OpenPGP certificates.

1686

1687

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

1688

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

1689

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

1690

# "+DHE-DSS"))

2263

1691

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

2264

1692

priority = self.server.gnutls_priority

2265

1693

if priority is None:

2266

1694

priority = "NORMAL"

2267

gnutls.priority_set_direct(session._c_object,

2268

priority.encode("utf-8"),

2269

None)

2270

1695

(gnutls.library.functions

1696

.gnutls_priority_set_direct(session._c_object,

1697

priority, None))

1698

2271

1699

# Start communication using the Mandos protocol

2272

1700

# Get protocol number

2273

1701

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

2278

1706

except (ValueError, IndexError, RuntimeError) as error:

2279

1707

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

2280

1708

return

2281

1709

2282

1710

# Start GnuTLS connection

2283

1711

try:

2284

1712

session.handshake()

2285

except gnutls.Error as error:

1713

except gnutls.errors.GNUTLSError as error:

2286

1714

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

2287

1715

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

2288

1716

# established. Just abandon the request.

2289

1717

return

2290

1718

logger.debug("Handshake succeeded")

2291

1719

2292

1720

approval_required = False

2293

1721

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,

1722

try:

1723

fpr = self.fingerprint(self.peer_certificate

1724

(session))

1725

except (TypeError,

1726

gnutls.errors.GNUTLSError) as error:

1727

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

1728

return

1729

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

1730

1731

try:

1732

client = ProxyClient(child_pipe, fpr,

2316

1733

self.client_address)

2317

1734

except KeyError:

2318

1735

return

2319

1736

2320

1737

if client.approval_delay:

2321

1738

delay = client.approval_delay

2322

1739

client.approvals_pending += 1

2323

1740

approval_required = True

2324

1741

2325

1742

while True:

2326

1743

if not client.enabled:

2327

1744

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

2328

client.name)

1745

client.name)

2329

1746

if self.server.use_dbus:

2330

1747

# Emit D-Bus signal

2331

1748

client.Rejected("Disabled")

2332

1749

return

2333

1750

2334

1751

if client.approved or not client.approval_delay:

2335

# We are approved or approval is disabled

1752

#We are approved or approval is disabled

2336

1753

break

2337

1754

elif client.approved is None:

2338

1755

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

2349

1766

# Emit D-Bus signal

2350

1767

client.Rejected("Denied")

2351

1768

return

2352

2353

# wait until timeout or approved

1769

1770

#wait until timeout or approved

2354

1771

time = datetime.datetime.now()

2355

1772

client.changedstate.acquire()

2356

1773

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

2369

1786

break

2370

1787

else:

2371

1788

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

1789

1790

sent_size = 0

1791

while sent_size < len(client.secret):

1792

try:

1793

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

1794

except gnutls.errors.GNUTLSError as error:

1795

logger.warning("gnutls send failed",

1796

exc_info=error)

1797

return

1798

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

1799

sent, len(client.secret)

1800

- (sent_size + sent))

1801

sent_size += sent

1802

2380

1803

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

2381

1804

# bump the timeout using extended_timeout

2382

1805

client.bump_timeout(client.extended_timeout)

2383

1806

if self.server.use_dbus:

2384

1807

# Emit D-Bus signal

2385

1808

client.GotSecret()

2386

1809

2387

1810

finally:

2388

1811

if approval_required:

2389

1812

client.approvals_pending -= 1

2390

1813

try:

2391

1814

session.bye()

2392

except gnutls.Error as error:

1815

except gnutls.errors.GNUTLSError as error:

2393

1816

logger.warning("GnuTLS bye failed",

2394

1817

exc_info=error)

2395

1818

2396

1819

@staticmethod

2397

1820

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

1821

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

1822

# If not an OpenPGP certificate...

1823

if (gnutls.library.functions

1824

.gnutls_certificate_type_get(session._c_object)

1825

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1826

# ...do the normal thing

1827

return session.peer_certificate

2414

1828

list_size = ctypes.c_uint(1)

2415

cert_list = (gnutls.certificate_get_peers

1829

cert_list = (gnutls.library.functions

1830

.gnutls_certificate_get_peers

2416

1831

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

2417

1832

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

2418

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

1833

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

1834

" certificate")

2419

1835

if list_size.value == 0:

2420

1836

return None

2421

1837

cert = cert_list[0]

2422

1838

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

1839

2458

1840

@staticmethod

2459

1841

def fingerprint(openpgp):

2460

1842

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2461

1843

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

1844

datum = (gnutls.library.types

1845

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

1846

ctypes.POINTER

1847

(ctypes.c_ubyte)),

1848

ctypes.c_uint(len(openpgp))))

2466

1849

# New empty GnuTLS certificate

2467

crt = gnutls.openpgp_crt_t()

2468

gnutls.openpgp_crt_init(ctypes.byref(crt))

1850

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1851

(gnutls.library.functions

1852

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2469

1853

# Import the OpenPGP public key into the certificate

2470

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

2471

gnutls.OPENPGP_FMT_RAW)

1854

(gnutls.library.functions

1855

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

1856

gnutls.library.constants

1857

.GNUTLS_OPENPGP_FMT_RAW))

2472

1858

# Verify the self signature in the key

2473

1859

crtverify = ctypes.c_uint()

2474

gnutls.openpgp_crt_verify_self(crt, 0,

2475

ctypes.byref(crtverify))

1860

(gnutls.library.functions

1861

.gnutls_openpgp_crt_verify_self(crt, 0,

1862

ctypes.byref(crtverify)))

2476

1863

if crtverify.value != 0:

2477

gnutls.openpgp_crt_deinit(crt)

2478

raise gnutls.CertificateSecurityError(code

2479

=crtverify.value)

1864

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1865

raise (gnutls.errors.CertificateSecurityError

1866

("Verify failed"))

2480

1867

# New buffer for the fingerprint

2481

1868

buf = ctypes.create_string_buffer(20)

2482

1869

buf_len = ctypes.c_size_t()

2483

1870

# Get the fingerprint from the certificate into the buffer

2484

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

2485

ctypes.byref(buf_len))

1871

(gnutls.library.functions

1872

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

1873

ctypes.byref(buf_len)))

2486

1874

# Deinit the certificate

2487

gnutls.openpgp_crt_deinit(crt)

1875

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2488

1876

# Convert the buffer to a Python bytestring

2489

1877

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

2490

1878

# Convert the bytestring to hexadecimal notation

2494

1882

2495

1883

class MultiprocessingMixIn(object):

2496

1884

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

2497

2498

1885

def sub_process_main(self, request, address):

2499

1886

try:

2500

1887

self.finish_request(request, address)

2501

1888

except Exception:

2502

1889

self.handle_error(request, address)

2503

1890

self.close_request(request)

2504

1891

2505

1892

def process_request(self, request, address):

2506

1893

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

2507

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

2508

args=(request, address))

1894

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

1895

args = (request, address))

2509

1896

proc.start()

2510

1897

return proc

2511

1898

2512

1899

2513

1900

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2514

1901

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

2515

2516

1902

def process_request(self, request, client_address):

2517

1903

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

2518

1904

2519

1905

This function creates a new pipe in self.pipe

2520

1906

"""

2521

1907

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2522

1908

2523

1909

proc = MultiprocessingMixIn.process_request(self, request,

2524

1910

client_address)

2525

1911

self.child_pipe.close()

2526

1912

self.add_pipe(parent_pipe, proc)

2527

1913

2528

1914

def add_pipe(self, parent_pipe, proc):

2529

1915

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

2530

1916

raise NotImplementedError()

2533

1919

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2534

1920

socketserver.TCPServer, object):

2535

1921

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

2536

1922

2537

1923

Attributes:

2538

1924

enabled: Boolean; whether this server is activated yet

2539

1925

interface: None or a network interface name (string)

2540

1926

use_ipv6: Boolean; to use IPv6 or not

2541

1927

"""

2542

2543

1928

def __init__(self, server_address, RequestHandlerClass,

2544

interface=None,

2545

use_ipv6=True,

2546

socketfd=None):

1929

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

2547

1930

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

2548

1931

creating a new one with socket.socket().

2549

1932

"""

2555

1938

self.socketfd = socketfd

2556

1939

# Save the original socket.socket() function

2557

1940

self.socket_socket = socket.socket

2558

2559

1941

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

2560

#

1942

#

2561

1943

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

2562

1944

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

2563

1945

# patching socket.socket.)

2564

#

1946

#

2565

1947

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

2566

1948

@functools.wraps(socket.socket)

2567

1949

def socket_wrapper(*args, **kwargs):

2579

1961

# socket_wrapper(), if socketfd was set.

2580

1962

socketserver.TCPServer.__init__(self, server_address,

2581

1963

RequestHandlerClass)

2582

1964

2583

1965

def server_bind(self):

2584

1966

"""This overrides the normal server_bind() function

2585

1967

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

2586

1968

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

2587

global SO_BINDTODEVICE

2588

1969

if self.interface is not None:

2589

1970

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

1971

logger.error("SO_BINDTODEVICE does not exist;"

1972

" cannot bind to interface %s",

1973

self.interface)

1974

else:

1975

try:

1976

self.socket.setsockopt(socket.SOL_SOCKET,

1977

SO_BINDTODEVICE,

1978

(self.interface + "\0")

1979

.encode("utf-8"))

1980

except socket.error as error:

1981

if error.errno == errno.EPERM:

1982

logger.error("No permission to bind to"

1983

" interface %s", self.interface)

1984

elif error.errno == errno.ENOPROTOOPT:

1985

logger.error("SO_BINDTODEVICE not available;"

1986

" cannot bind to interface %s",

1987

self.interface)

1988

elif error.errno == errno.ENODEV:

1989

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

1990

" cannot bind", self.interface)

1991

else:

1992

raise

2611

1993

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

2612

1994

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

2613

if self.server_address[1]:

2614

self.allow_reuse_address = True

2615

1995

if not self.server_address[0]:

2616

1996

if self.address_family == socket.AF_INET6:

2617

any_address = "::" # in6addr_any

1997

any_address = "::" # in6addr_any

2618

1998

else:

2619

any_address = "0.0.0.0" # INADDR_ANY

1999

any_address = "0.0.0.0" # INADDR_ANY

2620

2000

self.server_address = (any_address,

2621

2001

self.server_address[1])

2622

2002

elif not self.server_address[1]:

2623

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

2003

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

2004

0)

2624

2005

# if self.interface:

2625

2006

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

2626

2007

# 0, # port

2632

2013

2633

2014

class MandosServer(IPv6_TCPServer):

2634

2015

"""Mandos server.

2635

2016

2636

2017

Attributes:

2637

2018

clients: set of Client objects

2638

2019

gnutls_priority GnuTLS priority string

2639

2020

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

2640

2641

Assumes a GLib.MainLoop event loop.

2021

2022

Assumes a gobject.MainLoop event loop.

2642

2023

"""

2643

2644

2024

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

2025

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

2026

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

2651

2027

self.enabled = False

2652

2028

self.clients = clients

2653

2029

if self.clients is None:

2656

2032

self.gnutls_priority = gnutls_priority

2657

2033

IPv6_TCPServer.__init__(self, server_address,

2658

2034

RequestHandlerClass,

2659

interface=interface,

2660

use_ipv6=use_ipv6,

2661

socketfd=socketfd)

2662

2035

interface = interface,

2036

use_ipv6 = use_ipv6,

2037

socketfd = socketfd)

2663

2038

def server_activate(self):

2664

2039

if self.enabled:

2665

2040

return socketserver.TCPServer.server_activate(self)

2666

2041

2667

2042

def enable(self):

2668

2043

self.enabled = True

2669

2044

2670

2045

def add_pipe(self, parent_pipe, proc):

2671

2046

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

2047

gobject.io_add_watch(parent_pipe.fileno(),

2048

gobject.IO_IN | gobject.IO_HUP,

2049

functools.partial(self.handle_ipc,

2050

parent_pipe =

2051

parent_pipe,

2052

proc = proc))

2053

2054

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

2055

proc = None, client_object=None):

2683

2056

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

2684

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

2057

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

2685

2058

# Wait for other process to exit

2686

2059

proc.join()

2687

2060

return False

2688

2061

2689

2062

# Read a request from the child

2690

2063

request = parent_pipe.recv()

2691

2064

command = request[0]

2692

2065

2693

2066

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:

2067

fpr = request[1]

2068

address = request[2]

2069

2070

for c in self.clients.itervalues():

2071

if c.fingerprint == fpr:

2705

2072

client = c

2706

2073

break

2707

2074

else:

2708

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

2709

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

2075

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

2076

"dress: %s", fpr, address)

2710

2077

if self.use_dbus:

2711

2078

# Emit D-Bus signal

2712

mandos_dbus_service.ClientNotFound(key_id or fpr,

2079

mandos_dbus_service.ClientNotFound(fpr,

2713

2080

address[0])

2714

2081

parent_pipe.send(False)

2715

2082

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

2083

2084

gobject.io_add_watch(parent_pipe.fileno(),

2085

gobject.IO_IN | gobject.IO_HUP,

2086

functools.partial(self.handle_ipc,

2087

parent_pipe =

2088

parent_pipe,

2089

proc = proc,

2090

client_object =

2091

client))

2724

2092

parent_pipe.send(True)

2725

2093

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

2726

2094

# same fileno

2729

2097

funcname = request[1]

2730

2098

args = request[2]

2731

2099

kwargs = request[3]

2732

2100

2733

2101

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

2734

2102

funcname)(*args,

2735

**kwargs)))

2736

2103

**kwargs)))

2104

2737

2105

if command == 'getattr':

2738

2106

attrname = request[1]

2739

if isinstance(client_object.__getattribute__(attrname),

2740

collections.Callable):

2741

parent_pipe.send(('function', ))

2107

if callable(client_object.__getattribute__(attrname)):

2108

parent_pipe.send(('function',))

2742

2109

else:

2743

parent_pipe.send((

2744

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

2745

2110

parent_pipe.send(('data', client_object

2111

.__getattribute__(attrname)))

2112

2746

2113

if command == 'setattr':

2747

2114

attrname = request[1]

2748

2115

value = request[2]

2749

2116

setattr(client_object, attrname, value)

2750

2117

2751

2118

return True

2752

2119

2753

2120

2754

2121

def rfc3339_duration_to_delta(duration):

2755

2122

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

2756

2123

2757

2124

>>> rfc3339_duration_to_delta("P7D")

2758

2125

datetime.timedelta(7)

2759

2126

>>> rfc3339_duration_to_delta("PT60S")

2769

2136

>>> rfc3339_duration_to_delta("P1DT3M20S")

2770

2137

datetime.timedelta(1, 200)

2771

2138

"""

2772

2139

2773

2140

# Parsing an RFC 3339 duration with regular expressions is not

2774

2141

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

2775

2142

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

2776

2143

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

2777

2144

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

2778

2145

# avoid excessive use of external libraries.

2779

2146

2780

2147

# 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

2148

Token = collections.namedtuple("Token",

2149

("regexp", # To match token; if

2150

# "value" is not None,

2151

# must have a "group"

2152

# containing digits

2153

"value", # datetime.timedelta or

2154

# None

2155

"followers")) # Tokens valid after

2156

# this token

2786

2157

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

2787

2158

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

2788

2159

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

2789

2160

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

2790

2161

datetime.timedelta(seconds=1),

2791

frozenset((token_end, )))

2162

frozenset((token_end,)))

2792

2163

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

2793

2164

datetime.timedelta(minutes=1),

2794

2165

frozenset((token_second, token_end)))

2810

2181

frozenset((token_month, token_end)))

2811

2182

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

2812

2183

datetime.timedelta(weeks=1),

2813

frozenset((token_end, )))

2184

frozenset((token_end,)))

2814

2185

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

2815

2186

frozenset((token_year, token_month,

2816

2187

token_day, token_time,

2817

2188

token_week)))

2818

# Define starting values:

2819

# Value so far

2820

value = datetime.timedelta()

2189

# Define starting values

2190

value = datetime.timedelta() # Value so far

2821

2191

found_token = None

2822

# Following valid tokens

2823

followers = frozenset((token_duration, ))

2824

# String left to parse

2825

s = duration

2192

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

2193

s = duration # String left to parse

2826

2194

# Loop until end token is found

2827

2195

while found_token is not token_end:

2828

2196

# Search for any currently valid tokens

2844

2212

break

2845

2213

else:

2846

2214

# No currently valid tokens were found

2847

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

2848

.format(duration))

2215

raise ValueError("Invalid RFC 3339 duration")

2849

2216

# End token found

2850

2217

return value

2851

2218

2852

2219

2853

2220

def string_to_delta(interval):

2854

2221

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

2855

2222

2856

2223

>>> string_to_delta('7d')

2857

2224

datetime.timedelta(7)

2858

2225

>>> string_to_delta('60s')

2866

2233

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

2867

2234

datetime.timedelta(0, 330)

2868

2235

"""

2869

2236

2870

2237

try:

2871

2238

return rfc3339_duration_to_delta(interval)

2872

2239

except ValueError:

2873

2240

pass

2874

2241

2875

2242

timevalue = datetime.timedelta(0)

2876

2243

for s in interval.split():

2877

2244

try:

2888

2255

elif suffix == "w":

2889

2256

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

2890

2257

else:

2891

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

2258

raise ValueError("Unknown suffix {!r}"

2259

.format(suffix))

2892

2260

except IndexError as e:

2893

2261

raise ValueError(*(e.args))

2894

2262

timevalue += delta

2895

2263

return timevalue

2896

2264

2897

2265

2898

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

2266

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

2899

2267

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

2900

2268

2901

2269

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

2902

2270

if os.fork():

2903

2271

sys.exit()

2910

2278

# Close all standard open file descriptors

2911

2279

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

2912

2280

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

2913

raise OSError(errno.ENODEV,

2914

"{} not a character device"

2281

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

2915

2282

.format(os.devnull))

2916

2283

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

2917

2284

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

2921

2288

2922

2289

2923

2290

def main():

2924

2291

2925

2292

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

2926

2293

# Parsing of options, both command line and config file

2927

2294

2928

2295

parser = argparse.ArgumentParser()

2929

2296

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

2930

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

2297

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

2931

2298

help="show version number and exit")

2932

2299

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

2933

2300

help="Bind to interface IF")

2969

2336

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

2970

2337

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

2971

2338

default=None)

2972

2339

2973

2340

options = parser.parse_args()

2974

2341

2975

2342

if options.check:

2976

2343

import doctest

2977

2344

fail_count, test_count = doctest.testmod()

2978

2345

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

2979

2346

2980

2347

# 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

2348

server_defaults = { "interface": "",

2349

"address": "",

2350

"port": "",

2351

"debug": "False",

2352

"priority":

2353

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

2354

"servicename": "Mandos",

2355

"use_dbus": "True",

2356

"use_ipv6": "True",

2357

"debuglevel": "",

2358

"restore": "True",

2359

"socket": "",

2360

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

2361

"foreground": "False",

2362

"zeroconf": "True",

2363

}

2364

3004

2365

# Parse config file for server-global settings

3005

server_config = configparser.ConfigParser(server_defaults)

2366

server_config = configparser.SafeConfigParser(server_defaults)

3006

2367

del server_defaults

3007

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

3008

# Convert the ConfigParser object to a dict

2368

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

2369

"mandos.conf"))

2370

# Convert the SafeConfigParser object to a dict

3009

2371

server_settings = server_config.defaults()

3010

2372

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

3011

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

3012

"foreground", "zeroconf"):

2373

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

3013

2374

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

3014

2375

option)

3015

2376

if server_settings["port"]:

3025

2386

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

3026

2387

["socket"])

3027

2388

del server_config

3028

2389

3029

2390

# Override the settings from the config file with command line

3030

2391

# options, if set.

3031

2392

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

3032

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

3033

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

3034

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

2393

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

2394

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

2395

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

3035

2396

value = getattr(options, option)

3036

2397

if value is not None:

3037

2398

server_settings[option] = value

3049

2410

if server_settings["debug"]:

3050

2411

server_settings["foreground"] = True

3051

2412

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

3052

2413

3053

2414

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

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

2415

2416

if (not server_settings["zeroconf"] and

2417

not (server_settings["port"]

2418

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

2419

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

2420

" Zeroconf")

2421

3060

2422

# For convenience

3061

2423

debug = server_settings["debug"]

3062

2424

debuglevel = server_settings["debuglevel"]

3066

2428

stored_state_file)

3067

2429

foreground = server_settings["foreground"]

3068

2430

zeroconf = server_settings["zeroconf"]

3069

2431

3070

2432

if debug:

3071

2433

initlogger(debug, logging.DEBUG)

3072

2434

else:

3075

2437

else:

3076

2438

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

3077

2439

initlogger(debug, level)

3078

2440

3079

2441

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

2442

syslogger.setFormatter(logging.Formatter

2443

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

2444

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

2445

.format(server_settings

2446

["servicename"])))

2447

3085

2448

# Parse config file with clients

3086

client_config = configparser.ConfigParser(Client.client_defaults)

2449

client_config = configparser.SafeConfigParser(Client

2450

.client_defaults)

3087

2451

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

3088

2452

"clients.conf"))

3089

2453

3090

2454

global mandos_dbus_service

3091

2455

mandos_dbus_service = None

3092

2456

3093

2457

socketfd = None

3094

2458

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

3095

2459

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)

2460

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

2461

server_settings["port"]),

2462

ClientHandler,

2463

interface=(server_settings["interface"]

2464

or None),

2465

use_ipv6=use_ipv6,

2466

gnutls_priority=

2467

server_settings["priority"],

2468

use_dbus=use_dbus,

2469

socketfd=socketfd)

3104

2470

if not foreground:

3105

2471

pidfilename = "/run/mandos.pid"

3106

2472

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

3107

2473

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

3108

2474

pidfile = None

3109

2475

try:

3110

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

2476

pidfile = open(pidfilename, "w")

3111

2477

except IOError as e:

3112

2478

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

3113

2479

exc_info=e)

3114

3115

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

3116

("mandos", "mandos"),

3117

("nobody", "nogroup")):

2480

2481

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

3118

2482

try:

3119

2483

uid = pwd.getpwnam(name).pw_uid

3120

gid = pwd.getpwnam(group).pw_gid

2484

gid = pwd.getpwnam(name).pw_gid

3121

2485

break

3122

2486

except KeyError:

3123

2487

continue

3127

2491

try:

3128

2492

os.setgid(gid)

3129

2493

os.setuid(uid)

3130

if debug:

3131

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

3132

gid))

3133

2494

except OSError as error:

3134

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

3135

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

3136

2495

if error.errno != errno.EPERM:

3137

2496

raise

3138

2497

3139

2498

if debug:

3140

2499

# Enable all possible GnuTLS debugging

3141

2500

3142

2501

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

3143

2502

# - GnuTLS manual

3144

gnutls.global_set_log_level(11)

3145

3146

@gnutls.log_func

2503

gnutls.library.functions.gnutls_global_set_log_level(11)

2504

2505

@gnutls.library.types.gnutls_log_func

3147

2506

def debug_gnutls(level, string):

3148

2507

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

3149

3150

gnutls.global_set_log_function(debug_gnutls)

3151

2508

2509

(gnutls.library.functions

2510

.gnutls_global_set_log_function(debug_gnutls))

2511

3152

2512

# Redirect stdin so all checkers get /dev/null

3153

2513

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

3154

2514

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

3155

2515

if null > 2:

3156

2516

os.close(null)

3157

2517

3158

2518

# Need to fork before connecting to D-Bus

3159

2519

if not foreground:

3160

2520

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

3161

2521

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

2522

2523

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

2524

# need to inform gobject that threads will be used.

2525

gobject.threads_init()

2526

3168

2527

global main_loop

3169

2528

# From the Avahi example code

3170

2529

DBusGMainLoop(set_as_default=True)

3171

main_loop = GLib.MainLoop()

2530

main_loop = gobject.MainLoop()

3172

2531

bus = dbus.SystemBus()

3173

2532

# End of Avahi example code

3174

2533

if use_dbus:

3175

2534

try:

3176

2535

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:

2536

bus, do_not_queue=True)

2537

old_bus_name = (dbus.service.BusName

2538

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

2539

do_not_queue=True))

2540

except dbus.exceptions.NameExistsException as e:

3183

2541

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

3184

2542

use_dbus = False

3185

2543

server_settings["use_dbus"] = False

3186

2544

tcp_server.use_dbus = False

3187

2545

if zeroconf:

3188

2546

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)

2547

service = AvahiServiceToSyslog(name =

2548

server_settings["servicename"],

2549

servicetype = "_mandos._tcp",

2550

protocol = protocol, bus = bus)

3194

2551

if server_settings["interface"]:

3195

service.interface = if_nametoindex(

3196

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

3197

2552

service.interface = (if_nametoindex

2553

(server_settings["interface"]

2554

.encode("utf-8")))

2555

3198

2556

global multiprocessing_manager

3199

2557

multiprocessing_manager = multiprocessing.Manager()

3200

2558

3201

2559

client_class = Client

3202

2560

if use_dbus:

3203

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

3204

2561

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

2562

3205

2563

client_settings = Client.config_parser(client_config)

3206

2564

old_client_settings = {}

3207

2565

clients_data = {}

3208

2566

3209

2567

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

3210

2568

global wnull

3211

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

2569

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

3212

2570

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

3213

2571

# mode

3214

2572

if debug or not foreground:

3215

2573

wnull.close()

3216

2574

3217

2575

# Get client data and settings from last running state.

3218

2576

if server_settings["restore"]:

3219

2577

try:

3220

2578

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

2579

clients_data, old_client_settings = (pickle.load

2580

(stored_state))

3270

2581

os.remove(stored_state_path)

3271

2582

except IOError as e:

3272

2583

if e.errno == errno.ENOENT:

3273

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

3274

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

2584

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

2585

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

3275

2586

else:

3276

2587

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

3277

2588

exc_info=e)

3278

2589

raise

3279

2590

except EOFError as e:

3280

2591

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

3281

"EOFError:",

3282

exc_info=e)

3283

2592

"EOFError:", exc_info=e)

2593

3284

2594

with PGPEngine() as pgp:

3285

2595

for client_name, client in clients_data.items():

3286

2596

# Skip removed clients

3287

2597

if client_name not in client_settings:

3288

2598

continue

3289

2599

3290

2600

# Decide which value to use after restoring saved state.

3291

2601

# We have three different values: Old config file,

3292

2602

# new config file, and saved state.

3297

2607

# For each value in new config, check if it

3298

2608

# differs from the old config value (Except for

3299

2609

# the "secret" attribute)

3300

if (name != "secret"

3301

and (value !=

3302

old_client_settings[client_name][name])):

2610

if (name != "secret" and

2611

value != old_client_settings[client_name]

2612

[name]):

3303

2613

client[name] = value

3304

2614

except KeyError:

3305

2615

pass

3306

2616

3307

2617

# Clients who has passed its expire date can still be

3308

# enabled if its last checker was successful. A Client

2618

# enabled if its last checker was successful. Clients

3309

2619

# whose checker succeeded before we stored its state is

3310

2620

# assumed to have successfully run all checkers during

3311

2621

# downtime.

3314

2624

if not client["last_checked_ok"]:

3315

2625

logger.warning(

3316

2626

"disabling client {} - Client never "

3317

"performed a successful checker".format(

3318

client_name))

2627

"performed a successful checker"

2628

.format(client_name))

3319

2629

client["enabled"] = False

3320

2630

elif client["last_checker_status"] != 0:

3321

2631

logger.warning(

3322

2632

"disabling client {} - Client last"

3323

" checker failed with error code"

3324

" {}".format(

3325

client_name,

3326

client["last_checker_status"]))

2633

" checker failed with error code {}"

2634

.format(client_name,

2635

client["last_checker_status"]))

3327

2636

client["enabled"] = False

3328

2637

else:

3329

client["expires"] = (

3330

datetime.datetime.utcnow()

3331

+ client["timeout"])

2638

client["expires"] = (datetime.datetime

2639

.utcnow()

2640

+ client["timeout"])

3332

2641

logger.debug("Last checker succeeded,"

3333

" keeping {} enabled".format(

3334

client_name))

2642

" keeping {} enabled"

2643

.format(client_name))

3335

2644

try:

3336

client["secret"] = pgp.decrypt(

3337

client["encrypted_secret"],

3338

client_settings[client_name]["secret"])

2645

client["secret"] = (

2646

pgp.decrypt(client["encrypted_secret"],

2647

client_settings[client_name]

2648

["secret"]))

3339

2649

except PGPError:

3340

2650

# 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

2651

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

2652

.format(client_name))

2653

client["secret"] = (

2654

client_settings[client_name]["secret"])

2655

3346

2656

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

3347

2657

for client_name in (set(old_client_settings)

3348

2658

- set(client_settings)):

3350

2660

for client_name in (set(client_settings)

3351

2661

- set(old_client_settings)):

3352

2662

clients_data[client_name] = client_settings[client_name]

3353

2663

3354

2664

# Create all client objects

3355

2665

for client_name, client in clients_data.items():

3356

2666

tcp_server.clients[client_name] = client_class(

3357

name=client_name,

3358

settings=client,

3359

server_settings=server_settings)

3360

2667

name = client_name, settings = client,

2668

server_settings = server_settings)

2669

3361

2670

if not tcp_server.clients:

3362

2671

logger.warning("No clients defined")

3363

2672

3364

2673

if not foreground:

3365

2674

if pidfile is not None:

3366

pid = os.getpid()

3367

2675

try:

3368

2676

with pidfile:

3369

print(pid, file=pidfile)

2677

pid = os.getpid()

2678

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

3370

2679

except IOError:

3371

2680

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

3372

2681

pidfilename, pid)

3373

2682

del pidfile

3374

2683

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

2684

2685

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

2686

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

2687

3380

2688

if use_dbus:

3381

3382

@alternate_dbus_interfaces(

3383

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

3384

class MandosDBusService(DBusObjectWithObjectManager):

2689

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

2690

"se.bsnet.fukt.Mandos"})

2691

class MandosDBusService(DBusObjectWithProperties):

3385

2692

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

3386

3387

2693

def __init__(self):

3388

2694

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

3389

3390

2695

_interface = "se.recompile.Mandos"

3391

2696

2697

@dbus_interface_annotations(_interface)

2698

def _foo(self):

2699

return { "org.freedesktop.DBus.Property"

2700

".EmitsChangedSignal":

2701

"false"}

2702

3392

2703

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

3393

2704

def ClientAdded(self, objpath):

3394

2705

"D-Bus signal"

3395

2706

pass

3396

2707

3397

2708

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

3398

def ClientNotFound(self, key_id, address):

2709

def ClientNotFound(self, fingerprint, address):

3399

2710

"D-Bus signal"

3400

2711

pass

3401

3402

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

3403

"true"})

2712

3404

2713

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

3405

2714

def ClientRemoved(self, objpath, name):

3406

2715

"D-Bus signal"

3407

2716

pass

3408

3409

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

3410

"true"})

2717

3411

2718

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

3412

2719

def GetAllClients(self):

3413

2720

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

2721

return dbus.Array(c.dbus_object_path

2722

for c in

2723

tcp_server.clients.itervalues())

2724

3419

2725

@dbus.service.method(_interface,

3420

2726

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

3421

2727

def GetAllClientsWithProperties(self):

3422

2728

"D-Bus method"

3423

2729

return dbus.Dictionary(

3424

{c.dbus_object_path: c.GetAll(

3425

"se.recompile.Mandos.Client")

3426

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

2730

{ c.dbus_object_path: c.GetAll("")

2731

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

3427

2732

signature="oa{sv}")

3428

2733

3429

2734

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

3430

2735

def RemoveClient(self, object_path):

3431

2736

"D-Bus method"

3432

for c in tcp_server.clients.values():

2737

for c in tcp_server.clients.itervalues():

3433

2738

if c.dbus_object_path == object_path:

3434

2739

del tcp_server.clients[c.name]

3435

2740

c.remove_from_connection()

3436

# Don't signal the disabling

2741

# Don't signal anything except ClientRemoved

3437

2742

c.disable(quiet=True)

3438

# Emit D-Bus signal for removal

3439

self.client_removed_signal(c)

2743

# Emit D-Bus signal

2744

self.ClientRemoved(object_path, c.name)

3440

2745

return

3441

2746

raise KeyError(object_path)

3442

2747

3443

2748

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

2749

3481

2750

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

2751

3488

2752

def cleanup():

3489

2753

"Cleanup function; run on exit"

3490

2754

if zeroconf:

3491

2755

service.cleanup()

3492

3493

mp.active_children()

3494

wn.close()

2756

2757

multiprocessing.active_children()

2758

wnull.close()

3495

2759

if not (tcp_server.clients or client_settings):

3496

2760

return

3497

2761

3498

2762

# Store client before exiting. Secrets are encrypted with key

3499

2763

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

3500

2764

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

3501

2765

clients = {}

3502

2766

with PGPEngine() as pgp:

3503

for client in tcp_server.clients.values():

2767

for client in tcp_server.clients.itervalues():

3504

2768

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

3505

2769

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

3506

2770

key)

3507

2771

client_dict = {}

3508

2772

3509

2773

# A list of attributes that can not be pickled

3510

2774

# + secret.

3511

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

3512

"checker", "server_settings"}

3513

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

3514

.Object):

2775

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

2776

"checker", "server_settings" }

2777

for name, typ in (inspect.getmembers

2778

(dbus.service.Object)):

3515

2779

exclude.add(name)

3516

2780

3517

2781

client_dict["encrypted_secret"] = (client

3518

2782

.encrypted_secret)

3519

2783

for attr in client.client_structure:

3520

2784

if attr not in exclude:

3521

2785

client_dict[attr] = getattr(client, attr)

3522

2786

3523

2787

clients[client.name] = client_dict

3524

2788

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

3525

2789

3526

2790

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

2791

with (tempfile.NamedTemporaryFile

2792

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

2793

dir=os.path.dirname(stored_state_path),

2794

delete=False)) as stored_state:

2795

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

2796

tempname=stored_state.name

3536

2797

os.rename(tempname, stored_state_path)

3537

2798

except (IOError, OSError) as e:

3538

2799

if not debug:

3547

2808

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

3548

2809

exc_info=e)

3549

2810

raise

3550

2811

3551

2812

# Delete all clients, and settings from config

3552

2813

while tcp_server.clients:

3553

2814

name, client = tcp_server.clients.popitem()

3554

2815

if use_dbus:

3555

2816

client.remove_from_connection()

3556

# Don't signal the disabling

2817

# Don't signal anything except ClientRemoved

3557

2818

client.disable(quiet=True)

3558

# Emit D-Bus signal for removal

3559

2819

if use_dbus:

3560

mandos_dbus_service.client_removed_signal(client)

2820

# Emit D-Bus signal

2821

mandos_dbus_service.ClientRemoved(client

2822

.dbus_object_path,

2823

client.name)

3561

2824

client_settings.clear()

3562

2825

3563

2826

atexit.register(cleanup)

3564

3565

for client in tcp_server.clients.values():

2827

2828

for client in tcp_server.clients.itervalues():

3566

2829

if use_dbus:

3567

# Emit D-Bus signal for adding

3568

mandos_dbus_service.client_added_signal(client)

2830

# Emit D-Bus signal

2831

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3569

2832

# Need to initiate checking of clients

3570

2833

if client.enabled:

3571

2834

client.init_checker()

3572

2835

3573

2836

tcp_server.enable()

3574

2837

tcp_server.server_activate()

3575

2838

3576

2839

# Find out what port we got

3577

2840

if zeroconf:

3578

2841

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

3583

2846

else: # IPv4

3584

2847

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

3585

2848

*tcp_server.socket.getsockname())

3586

3587

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

3588

2849

2850

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

2851

3589

2852

try:

3590

2853

if zeroconf:

3591

2854

# From the Avahi example code

3596

2859

cleanup()

3597

2860

sys.exit(1)

3598

2861

# 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

2862

2863

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

2864

lambda *args, **kwargs:

2865

(tcp_server.handle_request

2866

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

2867

3605

2868

logger.debug("Starting main loop")

3606

2869

main_loop.run()

3607

2870

except AvahiError as error:

3616

2879

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

3617

2880

cleanup()

3618

2881

3619

3620

2882

if __name__ == '__main__':

3621

2883

main()