/mandos/trunk : revision 237.4.55

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

if sys.version_info.major == 2:

92

__metaclass__ = type

93

94

# Try to find the value of SO_BINDTODEVICE:

95

83

try:

96

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

97

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

98

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

99

85

except AttributeError:

100

86

try:

101

# This is where SO_BINDTODEVICE was up to and including Python

102

# 2.6, and also 3.2:

103

87

from IN import SO_BINDTODEVICE

104

88

except ImportError:

105

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

106

# Try running the C preprocessor:

107

try:

108

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

109

"/dev/stdin"],

110

stdin=subprocess.PIPE,

111

stdout=subprocess.PIPE)

112

stdout = cc.communicate(

113

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

114

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

115

except (OSError, ValueError, IndexError):

116

# No value found

117

SO_BINDTODEVICE = None

89

SO_BINDTODEVICE = None

118

90

119

91

if sys.version_info.major == 2:

120

92

str = unicode

121

93

122

if sys.version_info < (3, 2):

123

configparser.Configparser = configparser.SafeConfigParser

124

125

version = "1.8.7"

94

version = "1.6.9"

126

95

stored_state_file = "clients.pickle"

127

96

128

97

logger = logging.getLogger()

129

98

syslogger = None

130

99

131

100

try:

132

if_nametoindex = ctypes.cdll.LoadLibrary(

133

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

134

104

except (OSError, AttributeError):

135

136

105

def if_nametoindex(interface):

137

106

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

138

107

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

143

112

return interface_index

144

113

145

114

146

def copy_function(func):

147

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

148

if sys.version_info.major == 2:

149

return types.FunctionType(func.func_code,

150

func.func_globals,

151

func.func_name,

152

func.func_defaults,

153

func.func_closure)

154

else:

155

return types.FunctionType(func.__code__,

156

func.__globals__,

157

func.__name__,

158

func.__defaults__,

159

func.__closure__)

160

161

162

115

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

163

116

"""init logger and add loglevel"""

164

117

165

118

global syslogger

166

syslogger = (logging.handlers.SysLogHandler(

167

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

168

address="/dev/log"))

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

169

123

syslogger.setFormatter(logging.Formatter

170

124

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

171

125

' %(message)s'))

172

126

logger.addHandler(syslogger)

173

127

174

128

if debug:

175

129

console = logging.StreamHandler()

176

130

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

186

140

pass

187

141

188

142

189

class PGPEngine:

143

class PGPEngine(object):

190

144

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

191

192

145

def __init__(self):

193

146

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

194

self.gpg = "gpg"

195

try:

196

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

197

for line in output.splitlines():

198

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

199

if name == "gpg":

200

self.gpg = path

201

break

202

except OSError as e:

203

if e.errno != errno.ENOENT:

204

raise

205

147

self.gnupgargs = ['--batch',

206

'--homedir', self.tempdir,

148

'--home', self.tempdir,

207

149

'--force-mdc',

208

'--quiet']

209

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

210

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

211

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

212

150

'--quiet',

151

'--no-use-agent']

152

213

153

def __enter__(self):

214

154

return self

215

155

216

156

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

217

157

self._cleanup()

218

158

return False

219

159

220

160

def __del__(self):

221

161

self._cleanup()

222

162

223

163

def _cleanup(self):

224

164

if self.tempdir is not None:

225

165

# Delete contents of tempdir

226

166

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

227

topdown=False):

167

topdown = False):

228

168

for filename in files:

229

169

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

230

170

for dirname in dirs:

232

172

# Remove tempdir

233

173

os.rmdir(self.tempdir)

234

174

self.tempdir = None

235

175

236

176

def password_encode(self, password):

237

177

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

238

178

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

243

183

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

244

184

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

245

185

return encoded

246

186

247

187

def encrypt(self, data, password):

248

188

passphrase = self.password_encode(password)

249

with tempfile.NamedTemporaryFile(

250

dir=self.tempdir) as passfile:

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

251

191

passfile.write(passphrase)

252

192

passfile.flush()

253

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

193

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

254

194

'--passphrase-file',

255

195

passfile.name]

256

196

+ self.gnupgargs,

257

stdin=subprocess.PIPE,

258

stdout=subprocess.PIPE,

259

stderr=subprocess.PIPE)

260

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)

261

201

if proc.returncode != 0:

262

202

raise PGPError(err)

263

203

return ciphertext

264

204

265

205

def decrypt(self, data, password):

266

206

passphrase = self.password_encode(password)

267

with tempfile.NamedTemporaryFile(

268

dir=self.tempdir) as passfile:

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

269

209

passfile.write(passphrase)

270

210

passfile.flush()

271

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

211

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

272

212

'--passphrase-file',

273

213

passfile.name]

274

214

+ self.gnupgargs,

275

stdin=subprocess.PIPE,

276

stdout=subprocess.PIPE,

277

stderr=subprocess.PIPE)

278

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)

279

220

if proc.returncode != 0:

280

221

raise PGPError(err)

281

222

return decrypted_plaintext

282

223

283

224

284

# Pretend that we have an Avahi module

285

class avahi:

286

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

287

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

288

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

289

PROTO_INET = 0 # avahi-common/address.h

290

PROTO_INET6 = 1 # avahi-common/address.h

291

DBUS_NAME = "org.freedesktop.Avahi"

292

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

293

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

294

DBUS_PATH_SERVER = "/"

295

296

@staticmethod

297

def string_array_to_txt_array(t):

298

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

299

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

300

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

301

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

302

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

303

SERVER_INVALID = 0 # avahi-common/defs.h

304

SERVER_REGISTERING = 1 # avahi-common/defs.h

305

SERVER_RUNNING = 2 # avahi-common/defs.h

306

SERVER_COLLISION = 3 # avahi-common/defs.h

307

SERVER_FAILURE = 4 # avahi-common/defs.h

308

309

310

225

class AvahiError(Exception):

311

226

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

312

227

self.value = value

313

228

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

314

229

**kwargs)

315

230

316

317

231

class AvahiServiceError(AvahiError):

318

232

pass

319

233

320

321

234

class AvahiGroupError(AvahiError):

322

235

pass

323

236

324

237

325

class AvahiService:

238

class AvahiService(object):

326

239

"""An Avahi (Zeroconf) service.

327

240

328

241

Attributes:

329

242

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

330

243

Used to optionally bind to the specified interface.

342

255

server: D-Bus Server

343

256

bus: dbus.SystemBus()

344

257

"""

345

346

def __init__(self,

347

interface=avahi.IF_UNSPEC,

348

name=None,

349

servicetype=None,

350

port=None,

351

TXT=None,

352

domain="",

353

host="",

354

max_renames=32768,

355

protocol=avahi.PROTO_UNSPEC,

356

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

357

263

self.interface = interface

358

264

self.name = name

359

265

self.type = servicetype

368

274

self.server = None

369

275

self.bus = bus

370

276

self.entry_group_state_changed_match = None

371

372

def rename(self, remove=True):

277

278

def rename(self):

373

279

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

374

280

if self.rename_count >= self.max_renames:

375

281

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

376

282

" after %i retries, exiting.",

377

283

self.rename_count)

378

284

raise AvahiServiceError("Too many renames")

379

self.name = str(

380

self.server.GetAlternativeServiceName(self.name))

381

self.rename_count += 1

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

382

287

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

383

288

self.name)

384

if remove:

385

self.remove()

289

self.remove()

386

290

try:

387

291

self.add()

388

292

except dbus.exceptions.DBusException as error:

389

if (error.get_dbus_name()

390

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

391

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

392

return self.rename(remove=False)

393

else:

394

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

395

self.cleanup()

396

os._exit(1)

397

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

398

298

def remove(self):

399

299

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

400

300

if self.entry_group_state_changed_match is not None:

402

302

self.entry_group_state_changed_match = None

403

303

if self.group is not None:

404

304

self.group.Reset()

405

305

406

306

def add(self):

407

307

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

408

308

self.remove()

425

325

dbus.UInt16(self.port),

426

326

avahi.string_array_to_txt_array(self.TXT))

427

327

self.group.Commit()

428

328

429

329

def entry_group_state_changed(self, state, error):

430

330

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

431

331

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

432

332

433

333

if state == avahi.ENTRY_GROUP_ESTABLISHED:

434

334

logger.debug("Zeroconf service established.")

435

335

elif state == avahi.ENTRY_GROUP_COLLISION:

438

338

elif state == avahi.ENTRY_GROUP_FAILURE:

439

339

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

440

340

str(error))

441

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

442

341

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

342

.format(error))

343

443

344

def cleanup(self):

444

345

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

445

346

if self.group is not None:

450

351

pass

451

352

self.group = None

452

353

self.remove()

453

354

454

355

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

455

356

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

456

357

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

457

bad_states = {

458

avahi.SERVER_INVALID: "Zeroconf server invalid",

459

avahi.SERVER_REGISTERING: None,

460

avahi.SERVER_COLLISION: "Zeroconf server name collision",

461

avahi.SERVER_FAILURE: "Zeroconf server failure",

462

}

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

463

365

if state in bad_states:

464

366

if bad_states[state] is not None:

465

367

if error is None:

468

370

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

469

371

self.cleanup()

470

372

elif state == avahi.SERVER_RUNNING:

471

try:

472

self.add()

473

except dbus.exceptions.DBusException as error:

474

if (error.get_dbus_name()

475

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

476

logger.info("Local Zeroconf service name"

477

" collision.")

478

return self.rename(remove=False)

479

else:

480

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

481

self.cleanup()

482

os._exit(1)

373

self.add()

483

374

else:

484

375

if error is None:

485

376

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

486

377

else:

487

378

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

488

379

489

380

def activate(self):

490

381

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

491

382

if self.server is None:

495

386

follow_name_owner_changes=True),

496

387

avahi.DBUS_INTERFACE_SERVER)

497

388

self.server.connect_to_signal("StateChanged",

498

self.server_state_changed)

389

self.server_state_changed)

499

390

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

500

391

501

392

502

393

class AvahiServiceToSyslog(AvahiService):

503

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

394

def rename(self):

504

395

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

505

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

506

syslogger.setFormatter(logging.Formatter(

507

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

508

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

509

401

return ret

510

402

511

403

512

# Pretend that we have a GnuTLS module

513

class gnutls:

514

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

515

516

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

517

if library is None:

518

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

519

_library = ctypes.cdll.LoadLibrary(library)

520

del library

521

522

# Unless otherwise indicated, the constants and types below are

523

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

524

525

# Constants

526

E_SUCCESS = 0

527

E_INTERRUPTED = -52

528

E_AGAIN = -28

529

CRT_OPENPGP = 2

530

CRT_RAWPK = 3

531

CLIENT = 2

532

SHUT_RDWR = 0

533

CRD_CERTIFICATE = 1

534

E_NO_CERTIFICATE_FOUND = -49

535

X509_FMT_DER = 0

536

NO_TICKETS = 1<<10

537

ENABLE_RAWPK = 1<<18

538

CTYPE_PEERS = 3

539

KEYID_USE_SHA256 = 1 # gnutls/x509.h

540

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

541

542

# Types

543

class session_int(ctypes.Structure):

544

_fields_ = []

545

session_t = ctypes.POINTER(session_int)

546

547

class certificate_credentials_st(ctypes.Structure):

548

_fields_ = []

549

certificate_credentials_t = ctypes.POINTER(

550

certificate_credentials_st)

551

certificate_type_t = ctypes.c_int

552

553

class datum_t(ctypes.Structure):

554

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

555

('size', ctypes.c_uint)]

556

557

class openpgp_crt_int(ctypes.Structure):

558

_fields_ = []

559

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

560

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

561

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

562

credentials_type_t = ctypes.c_int

563

transport_ptr_t = ctypes.c_void_p

564

close_request_t = ctypes.c_int

565

566

# Exceptions

567

class Error(Exception):

568

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

569

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

570

# code is passed, convert it to a string with

571

# gnutls.strerror()

572

self.code = code

573

if message is None and code is not None:

574

message = gnutls.strerror(code)

575

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

576

message, *args)

577

578

class CertificateSecurityError(Error):

579

pass

580

581

# Classes

582

class Credentials:

583

def __init__(self):

584

self._c_object = gnutls.certificate_credentials_t()

585

gnutls.certificate_allocate_credentials(

586

ctypes.byref(self._c_object))

587

self.type = gnutls.CRD_CERTIFICATE

588

589

def __del__(self):

590

gnutls.certificate_free_credentials(self._c_object)

591

592

class ClientSession:

593

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

594

self._c_object = gnutls.session_t()

595

gnutls_flags = gnutls.CLIENT

596

if gnutls.check_version(b"3.5.6"):

597

gnutls_flags |= gnutls.NO_TICKETS

598

if gnutls.has_rawpk:

599

gnutls_flags |= gnutls.ENABLE_RAWPK

600

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

601

del gnutls_flags

602

gnutls.set_default_priority(self._c_object)

603

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

604

gnutls.handshake_set_private_extensions(self._c_object,

605

True)

606

self.socket = socket

607

if credentials is None:

608

credentials = gnutls.Credentials()

609

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

610

ctypes.cast(credentials._c_object,

611

ctypes.c_void_p))

612

self.credentials = credentials

613

614

def __del__(self):

615

gnutls.deinit(self._c_object)

616

617

def handshake(self):

618

return gnutls.handshake(self._c_object)

619

620

def send(self, data):

621

data = bytes(data)

622

data_len = len(data)

623

while data_len > 0:

624

data_len -= gnutls.record_send(self._c_object,

625

data[-data_len:],

626

data_len)

627

628

def bye(self):

629

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

630

631

# Error handling functions

632

def _error_code(result):

633

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

634

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

635

if result >= 0:

636

return result

637

if result == gnutls.E_NO_CERTIFICATE_FOUND:

638

raise gnutls.CertificateSecurityError(code=result)

639

raise gnutls.Error(code=result)

640

641

def _retry_on_error(result, func, arguments):

642

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

643

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

644

while result < 0:

645

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

646

return _error_code(result)

647

result = func(*arguments)

648

return result

649

650

# Unless otherwise indicated, the function declarations below are

651

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

652

653

# Functions

654

priority_set_direct = _library.gnutls_priority_set_direct

655

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

656

ctypes.POINTER(ctypes.c_char_p)]

657

priority_set_direct.restype = _error_code

658

659

init = _library.gnutls_init

660

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

661

init.restype = _error_code

662

663

set_default_priority = _library.gnutls_set_default_priority

664

set_default_priority.argtypes = [session_t]

665

set_default_priority.restype = _error_code

666

667

record_send = _library.gnutls_record_send

668

record_send.argtypes = [session_t, ctypes.c_void_p,

669

ctypes.c_size_t]

670

record_send.restype = ctypes.c_ssize_t

671

record_send.errcheck = _retry_on_error

672

673

certificate_allocate_credentials = (

674

_library.gnutls_certificate_allocate_credentials)

675

certificate_allocate_credentials.argtypes = [

676

ctypes.POINTER(certificate_credentials_t)]

677

certificate_allocate_credentials.restype = _error_code

678

679

certificate_free_credentials = (

680

_library.gnutls_certificate_free_credentials)

681

certificate_free_credentials.argtypes = [

682

certificate_credentials_t]

683

certificate_free_credentials.restype = None

684

685

handshake_set_private_extensions = (

686

_library.gnutls_handshake_set_private_extensions)

687

handshake_set_private_extensions.argtypes = [session_t,

688

ctypes.c_int]

689

handshake_set_private_extensions.restype = None

690

691

credentials_set = _library.gnutls_credentials_set

692

credentials_set.argtypes = [session_t, credentials_type_t,

693

ctypes.c_void_p]

694

credentials_set.restype = _error_code

695

696

strerror = _library.gnutls_strerror

697

strerror.argtypes = [ctypes.c_int]

698

strerror.restype = ctypes.c_char_p

699

700

certificate_type_get = _library.gnutls_certificate_type_get

701

certificate_type_get.argtypes = [session_t]

702

certificate_type_get.restype = _error_code

703

704

certificate_get_peers = _library.gnutls_certificate_get_peers

705

certificate_get_peers.argtypes = [session_t,

706

ctypes.POINTER(ctypes.c_uint)]

707

certificate_get_peers.restype = ctypes.POINTER(datum_t)

708

709

global_set_log_level = _library.gnutls_global_set_log_level

710

global_set_log_level.argtypes = [ctypes.c_int]

711

global_set_log_level.restype = None

712

713

global_set_log_function = _library.gnutls_global_set_log_function

714

global_set_log_function.argtypes = [log_func]

715

global_set_log_function.restype = None

716

717

deinit = _library.gnutls_deinit

718

deinit.argtypes = [session_t]

719

deinit.restype = None

720

721

handshake = _library.gnutls_handshake

722

handshake.argtypes = [session_t]

723

handshake.restype = _error_code

724

handshake.errcheck = _retry_on_error

725

726

transport_set_ptr = _library.gnutls_transport_set_ptr

727

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

728

transport_set_ptr.restype = None

729

730

bye = _library.gnutls_bye

731

bye.argtypes = [session_t, close_request_t]

732

bye.restype = _error_code

733

bye.errcheck = _retry_on_error

734

735

check_version = _library.gnutls_check_version

736

check_version.argtypes = [ctypes.c_char_p]

737

check_version.restype = ctypes.c_char_p

738

739

_need_version = b"3.3.0"

740

if check_version(_need_version) is None:

741

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

742

.format(_need_version))

743

744

_tls_rawpk_version = b"3.6.6"

745

has_rawpk = bool(check_version(_tls_rawpk_version))

746

747

if has_rawpk:

748

# Types

749

class pubkey_st(ctypes.Structure):

750

_fields = []

751

pubkey_t = ctypes.POINTER(pubkey_st)

752

753

x509_crt_fmt_t = ctypes.c_int

754

755

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

756

pubkey_init = _library.gnutls_pubkey_init

757

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

758

pubkey_init.restype = _error_code

759

760

pubkey_import = _library.gnutls_pubkey_import

761

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

762

x509_crt_fmt_t]

763

pubkey_import.restype = _error_code

764

765

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

766

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

767

ctypes.POINTER(ctypes.c_ubyte),

768

ctypes.POINTER(ctypes.c_size_t)]

769

pubkey_get_key_id.restype = _error_code

770

771

pubkey_deinit = _library.gnutls_pubkey_deinit

772

pubkey_deinit.argtypes = [pubkey_t]

773

pubkey_deinit.restype = None

774

else:

775

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

776

777

openpgp_crt_init = _library.gnutls_openpgp_crt_init

778

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

779

openpgp_crt_init.restype = _error_code

780

781

openpgp_crt_import = _library.gnutls_openpgp_crt_import

782

openpgp_crt_import.argtypes = [openpgp_crt_t,

783

ctypes.POINTER(datum_t),

784

openpgp_crt_fmt_t]

785

openpgp_crt_import.restype = _error_code

786

787

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

788

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

789

ctypes.POINTER(ctypes.c_uint)]

790

openpgp_crt_verify_self.restype = _error_code

791

792

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

793

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

794

openpgp_crt_deinit.restype = None

795

796

openpgp_crt_get_fingerprint = (

797

_library.gnutls_openpgp_crt_get_fingerprint)

798

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

799

ctypes.c_void_p,

800

ctypes.POINTER(

801

ctypes.c_size_t)]

802

openpgp_crt_get_fingerprint.restype = _error_code

803

804

if check_version(b"3.6.4"):

805

certificate_type_get2 = _library.gnutls_certificate_type_get2

806

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

807

certificate_type_get2.restype = _error_code

808

809

# Remove non-public functions

810

del _error_code, _retry_on_error

811

812

813

def call_pipe(connection, # : multiprocessing.Connection

814

func, *args, **kwargs):

815

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

816

817

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

818

return value on the provided multiprocessing.Connection.

819

"""

820

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

821

connection.close()

822

823

824

class Client:

404

class Client(object):

825

405

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

826

406

827

407

Attributes:

828

408

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

829

409

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

830

410

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

831

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

832

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

833

running.

834

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

835

415

checker_command: string; External command which is run to check

836

416

if client lives. %() expansions are done at

837

417

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

838

418

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

839

checker_initiator_tag: a GLib event source tag, or None

419

checker_initiator_tag: a gobject event source tag, or None

840

420

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

841

421

client_structure: Object describing what attributes a client has

842

422

and is used for storing the client at exit

843

423

current_checker_command: string; current running checker_command

844

disable_initiator_tag: a GLib event source tag, or None

424

disable_initiator_tag: a gobject event source tag, or None

845

425

enabled: bool()

846

426

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

847

uniquely identify an OpenPGP client

848

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

849

a client using raw public keys

427

uniquely identify the client

850

428

host: string; available for use by the checker command

851

429

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

852

430

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

854

432

last_checker_status: integer between 0 and 255 reflecting exit

855

433

status of last checker. -1 reflects crashed

856

434

checker, -2 means no checker completed yet.

857

last_checker_signal: The signal which killed the last checker, if

858

last_checker_status is -1

859

435

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

860

436

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

861

437

D-Bus identifiers

868

444

disabled, or None

869

445

server_settings: The server_settings dict from main()

870

446

"""

871

447

872

448

runtime_expansions = ("approval_delay", "approval_duration",

873

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

449

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

874

450

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

875

451

"last_approval_request", "last_checked_ok",

876

452

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

877

client_defaults = {

878

"timeout": "PT5M",

879

"extended_timeout": "PT15M",

880

"interval": "PT2M",

881

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

882

"host": "",

883

"approval_delay": "PT0S",

884

"approval_duration": "PT1S",

885

"approved_by_default": "True",

886

"enabled": "True",

887

}

888

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

889

464

@staticmethod

890

465

def config_parser(config):

891

466

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

898

473

for client_name in config.sections():

899

474

section = dict(config.items(client_name))

900

475

client = settings[client_name] = {}

901

476

902

477

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

903

478

# Reformat values from string types to Python types

904

479

client["approved_by_default"] = config.getboolean(

905

480

client_name, "approved_by_default")

906

481

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

907

482

"enabled")

908

909

# Uppercase and remove spaces from key_id and fingerprint

910

# for later comparison purposes with return value from the

911

# key_id() and fingerprint() functions

912

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

913

.replace(" ", ""))

483

914

484

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

915

485

.replace(" ", ""))

916

486

if "secret" in section:

917

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

918

.encode("utf-8"),

919

"base64")

487

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

920

488

elif "secfile" in section:

921

489

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

922

490

(section["secfile"])),

937

505

client["last_approval_request"] = None

938

506

client["last_checked_ok"] = None

939

507

client["last_checker_status"] = -2

940

508

941

509

return settings

942

943

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

510

511

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

944

512

self.name = name

945

513

if server_settings is None:

946

514

server_settings = {}

948

516

# adding all client settings

949

517

for setting, value in settings.items():

950

518

setattr(self, setting, value)

951

519

952

520

if self.enabled:

953

521

if not hasattr(self, "last_enabled"):

954

522

self.last_enabled = datetime.datetime.utcnow()

958

526

else:

959

527

self.last_enabled = None

960

528

self.expires = None

961

529

962

530

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

963

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

964

534

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

965

535

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

966

536

datetime.datetime.utcnow())

967

537

968

538

# attributes specific for this server instance

969

539

self.checker = None

970

540

self.checker_initiator_tag = None

973

543

self.current_checker_command = None

974

544

self.approved = None

975

545

self.approvals_pending = 0

976

self.changedstate = multiprocessing_manager.Condition(

977

multiprocessing_manager.Lock())

978

self.client_structure = [attr

979

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

980

551

if not attr.startswith("_")]

981

552

self.client_structure.append("client_structure")

982

983

for name, t in inspect.getmembers(

984

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

985

558

if not name.startswith("_"):

986

559

self.client_structure.append(name)

987

560

988

561

# Send notice to process children that client state has changed

989

562

def send_changedstate(self):

990

563

with self.changedstate:

991

564

self.changedstate.notify_all()

992

565

993

566

def enable(self):

994

567

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

995

568

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

1000

573

self.last_enabled = datetime.datetime.utcnow()

1001

574

self.init_checker()

1002

575

self.send_changedstate()

1003

576

1004

577

def disable(self, quiet=True):

1005

578

"""Disable this client."""

1006

579

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

1008

581

if not quiet:

1009

582

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

1010

583

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

1011

GLib.source_remove(self.disable_initiator_tag)

584

gobject.source_remove(self.disable_initiator_tag)

1012

585

self.disable_initiator_tag = None

1013

586

self.expires = None

1014

587

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

1015

GLib.source_remove(self.checker_initiator_tag)

588

gobject.source_remove(self.checker_initiator_tag)

1016

589

self.checker_initiator_tag = None

1017

590

self.stop_checker()

1018

591

self.enabled = False

1019

592

if not quiet:

1020

593

self.send_changedstate()

1021

# 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

1022

595

return False

1023

596

1024

597

def __del__(self):

1025

598

self.disable()

1026

599

1027

600

def init_checker(self):

1028

601

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

1029

602

# and every interval from then on.

1030

603

if self.checker_initiator_tag is not None:

1031

GLib.source_remove(self.checker_initiator_tag)

1032

self.checker_initiator_tag = GLib.timeout_add(

1033

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

1034

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

1035

609

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

1036

610

if self.disable_initiator_tag is not None:

1037

GLib.source_remove(self.disable_initiator_tag)

1038

self.disable_initiator_tag = GLib.timeout_add(

1039

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

1040

616

# Also start a new checker *right now*.

1041

617

self.start_checker()

1042

1043

def checker_callback(self, source, condition, connection,

1044

command):

618

619

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

1045

620

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

1046

# Read return code from connection (see call_pipe)

1047

returncode = connection.recv()

1048

connection.close()

1049

self.checker.join()

1050

621

self.checker_callback_tag = None

1051

622

self.checker = None

1052

1053

if returncode >= 0:

1054

self.last_checker_status = returncode

1055

self.last_checker_signal = None

623

if os.WIFEXITED(condition):

624

self.last_checker_status = os.WEXITSTATUS(condition)

1056

625

if self.last_checker_status == 0:

1057

626

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

1058

627

vars(self))

1059

628

self.checked_ok()

1060

629

else:

1061

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

630

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

631

vars(self))

1062

632

else:

1063

633

self.last_checker_status = -1

1064

self.last_checker_signal = -returncode

1065

634

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

1066

635

vars(self))

1067

return False

1068

636

1069

637

def checked_ok(self):

1070

638

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

1071

639

self.last_checked_ok = datetime.datetime.utcnow()

1072

640

self.last_checker_status = 0

1073

self.last_checker_signal = None

1074

641

self.bump_timeout()

1075

642

1076

643

def bump_timeout(self, timeout=None):

1077

644

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

1078

645

if timeout is None:

1079

646

timeout = self.timeout

1080

647

if self.disable_initiator_tag is not None:

1081

GLib.source_remove(self.disable_initiator_tag)

648

gobject.source_remove(self.disable_initiator_tag)

1082

649

self.disable_initiator_tag = None

1083

650

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

1084

self.disable_initiator_tag = GLib.timeout_add(

1085

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

651

self.disable_initiator_tag = (gobject.timeout_add

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

1086

654

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

1087

655

1088

656

def need_approval(self):

1089

657

self.last_approval_request = datetime.datetime.utcnow()

1090

658

1091

659

def start_checker(self):

1092

660

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

1093

661

1094

662

If a checker already exists, leave it running and do

1095

663

nothing."""

1096

664

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

1101

669

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

1102

670

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

1103

671

# should be.

1104

1105

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

1106

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

1107

self.checker.join()

1108

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)

1109

687

# Start a new checker if needed

1110

688

if self.checker is None:

1111

689

# Escape attributes for the shell

1112

escaped_attrs = {

1113

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

1114

for attr in self.runtime_expansions}

690

escaped_attrs = { attr:

691

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

692

for attr in self.runtime_expansions }

1115

693

try:

1116

694

command = self.checker_command % escaped_attrs

1117

695

except TypeError as error:

1118

696

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

1119

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

1120

721

exc_info=error)

1121

return True # Try again later

1122

self.current_checker_command = command

1123

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

1124

self.name)

1125

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

1126

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

1127

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

1128

# always replaced by /dev/null.)

1129

# The exception is when not debugging but nevertheless

1130

# running in the foreground; use the previously

1131

# created wnull.

1132

popen_args = {"close_fds": True,

1133

"shell": True,

1134

"cwd": "/"}

1135

if (not self.server_settings["debug"]

1136

and self.server_settings["foreground"]):

1137

popen_args.update({"stdout": wnull,

1138

"stderr": wnull})

1139

pipe = multiprocessing.Pipe(duplex=False)

1140

self.checker = multiprocessing.Process(

1141

target=call_pipe,

1142

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

1143

kwargs=popen_args)

1144

self.checker.start()

1145

self.checker_callback_tag = GLib.io_add_watch(

1146

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

1147

self.checker_callback, pipe[0], command)

1148

# 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

1149

742

return True

1150

743

1151

744

def stop_checker(self):

1152

745

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

1153

746

if self.checker_callback_tag:

1154

GLib.source_remove(self.checker_callback_tag)

747

gobject.source_remove(self.checker_callback_tag)

1155

748

self.checker_callback_tag = None

1156

749

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

1157

750

return

1158

751

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

1159

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

1160

760

self.checker = None

1161

761

1162

762

1163

def dbus_service_property(dbus_interface,

1164

signature="v",

1165

access="readwrite",

1166

byte_arrays=False):

763

def dbus_service_property(dbus_interface, signature="v",

764

access="readwrite", byte_arrays=False):

1167

765

"""Decorators for marking methods of a DBusObjectWithProperties to

1168

766

become properties on the D-Bus.

1169

767

1170

768

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

1171

769

and with one argument by "Set".

1172

770

1173

771

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

1174

772

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

1175

773

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

1179

777

if byte_arrays and signature != "ay":

1180

778

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

1181

779

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

1182

1183

780

def decorator(func):

1184

781

func._dbus_is_property = True

1185

782

func._dbus_interface = dbus_interface

1188

785

func._dbus_name = func.__name__

1189

786

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

1190

787

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

1191

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

788

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1192

789

return func

1193

1194

790

return decorator

1195

791

1196

792

1197

793

def dbus_interface_annotations(dbus_interface):

1198

794

"""Decorator for marking functions returning interface annotations

1199

795

1200

796

Usage:

1201

797

1202

798

@dbus_interface_annotations("org.example.Interface")

1203

799

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

1204

800

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

1205

801

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

1206

802

"false"}

1207

803

"""

1208

1209

804

def decorator(func):

1210

805

func._dbus_is_interface = True

1211

806

func._dbus_interface = dbus_interface

1212

807

func._dbus_name = dbus_interface

1213

808

return func

1214

1215

809

return decorator

1216

810

1217

811

1218

812

def dbus_annotations(annotations):

1219

813

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

1220

814

Usage:

1221

815

1222

816

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

1223

817

"org.freedesktop.DBus.Property."

1224

818

"EmitsChangedSignal": "false"})

1226

820

access="r")

1227

821

def Property_dbus_property(self):

1228

822

return dbus.Boolean(False)

1229

1230

See also the DBusObjectWithAnnotations class.

1231

823

"""

1232

1233

824

def decorator(func):

1234

825

func._dbus_annotations = annotations

1235

826

return func

1236

1237

827

return decorator

1238

828

1239

829

1242

832

"""

1243

833

pass

1244

834

1245

1246

835

class DBusPropertyAccessException(DBusPropertyException):

1247

836

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

1248

837

"""

1255

844

pass

1256

845

1257

846

1258

class DBusObjectWithAnnotations(dbus.service.Object):

1259

"""A D-Bus object with annotations.

1260

1261

Classes inheriting from this can use the dbus_annotations

1262

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.

1263

853

"""

1264

854

1265

855

@staticmethod

1266

856

def _is_dbus_thing(thing):

1267

857

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

1268

858

1269

859

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

1270

860

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

1271

861

"""

1272

862

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

1273

863

False)

1274

864

1275

865

def _get_all_dbus_things(self, thing):

1276

866

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

1277

867

"""

1278

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

868

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

869

name),

1279

870

athing.__get__(self))

1280

871

for cls in self.__class__.__mro__

1281

872

for name, athing in

1282

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

1283

1284

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1285

out_signature="s",

1286

path_keyword='object_path',

1287

connection_keyword='connection')

1288

def Introspect(self, object_path, connection):

1289

"""Overloading of standard D-Bus method.

1290

1291

Inserts annotation tags on methods and signals.

1292

"""

1293

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

1294

connection)

1295

try:

1296

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

1297

1298

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

1299

# Add annotation tags

1300

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

1301

for tag in if_tag.getElementsByTagName(typ):

1302

annots = dict()

1303

for name, prop in (self.

1304

_get_all_dbus_things(typ)):

1305

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

1306

and prop._dbus_interface

1307

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

1308

annots.update(getattr(

1309

prop, "_dbus_annotations", {}))

1310

for name, value in annots.items():

1311

ann_tag = document.createElement(

1312

"annotation")

1313

ann_tag.setAttribute("name", name)

1314

ann_tag.setAttribute("value", value)

1315

tag.appendChild(ann_tag)

1316

# Add interface annotation tags

1317

for annotation, value in dict(

1318

itertools.chain.from_iterable(

1319

annotations().items()

1320

for name, annotations

1321

in self._get_all_dbus_things("interface")

1322

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

1323

)).items():

1324

ann_tag = document.createElement("annotation")

1325

ann_tag.setAttribute("name", annotation)

1326

ann_tag.setAttribute("value", value)

1327

if_tag.appendChild(ann_tag)

1328

# Fix argument name for the Introspect method itself

1329

if (if_tag.getAttribute("name")

1330

== dbus.INTROSPECTABLE_IFACE):

1331

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

1332

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

1333

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

1334

if (arg.getAttribute("direction")

1335

== "out"):

1336

arg.setAttribute("name",

1337

"xml_data")

1338

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

1339

document.unlink()

1340

except (AttributeError, xml.dom.DOMException,

1341

xml.parsers.expat.ExpatError) as error:

1342

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

1343

exc_info=error)

1344

return xmlstring

1345

1346

1347

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1348

"""A D-Bus object with properties.

1349

1350

Classes inheriting from this can use the dbus_service_property

1351

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

1352

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

1353

"""

1354

873

inspect.getmembers(cls,

874

self._is_dbus_thing(thing)))

875

1355

876

def _get_dbus_property(self, interface_name, property_name):

1356

877

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

1357

878

property with the specified name and interface.

1358

879

"""

1359

for cls in self.__class__.__mro__:

1360

for name, value in inspect.getmembers(

1361

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

1362

884

if (value._dbus_name == property_name

1363

885

and value._dbus_interface == interface_name):

1364

886

return value.__get__(self)

1365

887

1366

888

# No such property

1367

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

1368

self.dbus_object_path, interface_name, property_name))

1369

1370

@classmethod

1371

def _get_all_interface_names(cls):

1372

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

1373

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

1374

"_dbus_interface", None)

1375

for x in (inspect.getmro(cls))

1376

for attr in dir(x))

1377

if name is not None)

1378

1379

@dbus.service.method(dbus.PROPERTIES_IFACE,

1380

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

1381

894

out_signature="v")

1382

895

def Get(self, interface_name, property_name):

1383

896

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

1389

902

if not hasattr(value, "variant_level"):

1390

903

return value

1391

904

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

1392

905

1393

906

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

1394

907

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

1395

908

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

1407

920

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

1408

921

for byte in value))

1409

922

prop(value)

1410

1411

@dbus.service.method(dbus.PROPERTIES_IFACE,

1412

in_signature="s",

923

924

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

1413

925

out_signature="a{sv}")

1414

926

def GetAll(self, interface_name):

1415

927

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

1416

928

standard.

1417

929

1418

930

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

1419

931

"""

1420

932

properties = {}

1430

942

if not hasattr(value, "variant_level"):

1431

943

properties[name] = value

1432

944

continue

1433

properties[name] = type(value)(

1434

value, variant_level=value.variant_level + 1)

945

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

946

value.variant_level+1)

1435

947

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

1436

948

1437

949

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

1438

950

def PropertiesChanged(self, interface_name, changed_properties,

1439

951

invalidated_properties):

1441

953

standard.

1442

954

"""

1443

955

pass

1444

956

1445

957

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1446

958

out_signature="s",

1447

959

path_keyword='object_path',

1448

960

connection_keyword='connection')

1449

961

def Introspect(self, object_path, connection):

1450

962

"""Overloading of standard D-Bus method.

1451

963

1452

964

Inserts property tags and interface annotation tags.

1453

965

"""

1454

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1455

object_path,

1456

connection)

966

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

967

connection)

1457

968

try:

1458

969

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

1459

1460

970

def make_tag(document, name, prop):

1461

971

e = document.createElement("property")

1462

972

e.setAttribute("name", name)

1463

973

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

1464

974

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

1465

975

return e

1466

1467

976

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

1468

977

# Add property tags

1469

978

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

1472

981

if prop._dbus_interface

1473

982

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

1474

983

if_tag.appendChild(tag)

1475

# Add annotation tags for properties

1476

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

1477

annots = dict()

1478

for name, prop in self._get_all_dbus_things(

1479

"property"):

1480

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

1481

and prop._dbus_interface

1482

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

1483

annots.update(getattr(

1484

prop, "_dbus_annotations", {}))

1485

for name, value in annots.items():

1486

ann_tag = document.createElement(

1487

"annotation")

1488

ann_tag.setAttribute("name", name)

1489

ann_tag.setAttribute("value", value)

1490

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)

1491

1015

# Add the names to the return values for the

1492

1016

# "org.freedesktop.DBus.Properties" methods

1493

1017

if (if_tag.getAttribute("name")

1512

1036

return xmlstring

1513

1037

1514

1038

1515

try:

1516

dbus.OBJECT_MANAGER_IFACE

1517

except AttributeError:

1518

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

1519

1520

1521

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1522

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

1523

1524

Classes inheriting from this exposes the standard

1525

GetManagedObjects call and the InterfacesAdded and

1526

InterfacesRemoved signals on the standard

1527

"org.freedesktop.DBus.ObjectManager" interface.

1528

1529

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

1530

manually.

1531

"""

1532

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1533

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

1534

def GetManagedObjects(self):

1535

"""This function must be overridden"""

1536

raise NotImplementedError()

1537

1538

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1539

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

1540

def InterfacesAdded(self, object_path, interfaces_and_properties):

1541

pass

1542

1543

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

1544

def InterfacesRemoved(self, object_path, interfaces):

1545

pass

1546

1547

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1548

out_signature="s",

1549

path_keyword='object_path',

1550

connection_keyword='connection')

1551

def Introspect(self, object_path, connection):

1552

"""Overloading of standard D-Bus method.

1553

1554

Override return argument name of GetManagedObjects to be

1555

"objpath_interfaces_and_properties"

1556

"""

1557

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1558

object_path,

1559

connection)

1560

try:

1561

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

1562

1563

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

1564

# Fix argument name for the GetManagedObjects method

1565

if (if_tag.getAttribute("name")

1566

== dbus.OBJECT_MANAGER_IFACE):

1567

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

1568

if (cn.getAttribute("name")

1569

== "GetManagedObjects"):

1570

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

1571

if (arg.getAttribute("direction")

1572

== "out"):

1573

arg.setAttribute(

1574

"name",

1575

"objpath_interfaces"

1576

"_and_properties")

1577

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

1578

document.unlink()

1579

except (AttributeError, xml.dom.DOMException,

1580

xml.parsers.expat.ExpatError) as error:

1581

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

1582

exc_info=error)

1583

return xmlstring

1584

1585

1586

1039

def datetime_to_dbus(dt, variant_level=0):

1587

1040

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

1588

1041

if dt is None:

1589

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

1590

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)

1591

1045

1592

1046

1593

1047

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1595

1049

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

1596

1050

interface names according to the "alt_interface_names" mapping.

1597

1051

Usage:

1598

1052

1599

1053

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

1600

1054

"net.example.AlternateInterface"})

1601

1055

class SampleDBusObject(dbus.service.Object):

1602

1056

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

1603

1057

def SampleDBusMethod():

1604

1058

pass

1605

1059

1606

1060

The above "SampleDBusMethod" on "SampleDBusObject" will be

1607

1061

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

1608

1062

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

1609

1063

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

1610

1064

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

1611

1065

1612

1066

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

1613

1067

(from DBusObjectWithProperties) and interfaces (from the

1614

1068

dbus_interface_annotations decorator).

1615

1069

"""

1616

1617

1070

def wrapper(cls):

1618

1071

for orig_interface_name, alt_interface_name in (

1619

alt_interface_names.items()):

1072

alt_interface_names.items()):

1620

1073

attr = {}

1621

1074

interface_names = set()

1622

1075

# Go though all attributes of the class

1624

1077

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

1625

1078

# with the wrong interface name

1626

1079

if (not hasattr(attribute, "_dbus_interface")

1627

or not attribute._dbus_interface.startswith(

1628

orig_interface_name)):

1080

or not attribute._dbus_interface

1081

.startswith(orig_interface_name)):

1629

1082

continue

1630

1083

# Create an alternate D-Bus interface name based on

1631

1084

# the current name

1632

alt_interface = attribute._dbus_interface.replace(

1633

orig_interface_name, alt_interface_name)

1085

alt_interface = (attribute._dbus_interface

1086

.replace(orig_interface_name,

1087

alt_interface_name))

1634

1088

interface_names.add(alt_interface)

1635

1089

# Is this a D-Bus signal?

1636

1090

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

1637

1091

# Extract the original non-method undecorated

1638

1092

# function by black magic

1639

if sys.version_info.major == 2:

1640

nonmethod_func = (dict(

1093

nonmethod_func = (dict(

1641

1094

zip(attribute.func_code.co_freevars,

1642

attribute.__closure__))

1643

["func"].cell_contents)

1644

else:

1645

nonmethod_func = (dict(

1646

zip(attribute.__code__.co_freevars,

1647

attribute.__closure__))

1648

["func"].cell_contents)

1095

attribute.__closure__))["func"]

1096

.cell_contents)

1649

1097

# Create a new, but exactly alike, function

1650

1098

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

1651

1099

# with the alternate D-Bus interface name

1652

new_function = copy_function(nonmethod_func)

1653

new_function = (dbus.service.signal(

1654

alt_interface,

1655

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

1656

1109

# Copy annotations, if any

1657

1110

try:

1658

new_function._dbus_annotations = dict(

1659

attribute._dbus_annotations)

1111

new_function._dbus_annotations = (

1112

dict(attribute._dbus_annotations))

1660

1113

except AttributeError:

1661

1114

pass

1662

1663

1115

# Define a creator of a function to call both the

1664

1116

# original and alternate functions, so both the

1665

1117

# original and alternate signals gets sent when

1668

1120

"""This function is a scope container to pass

1669

1121

func1 and func2 to the "call_both" function

1670

1122

outside of its arguments"""

1671

1672

@functools.wraps(func2)

1673

1123

def call_both(*args, **kwargs):

1674

1124

"""This function will emit two D-Bus

1675

1125

signals by calling func1 and func2"""

1676

1126

func1(*args, **kwargs)

1677

1127

func2(*args, **kwargs)

1678

# Make wrapper function look like a D-Bus

1679

# signal

1680

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

1681

if name.startswith("_dbus_"):

1682

setattr(call_both, name, attr)

1683

1684

1128

return call_both

1685

1129

# Create the "call_both" function and add it to

1686

1130

# the class

1691

1135

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

1692

1136

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

1693

1137

# to the class.

1694

attr[attrname] = (

1695

dbus.service.method(

1696

alt_interface,

1697

attribute._dbus_in_signature,

1698

attribute._dbus_out_signature)

1699

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

1700

1148

# Copy annotations, if any

1701

1149

try:

1702

attr[attrname]._dbus_annotations = dict(

1703

attribute._dbus_annotations)

1150

attr[attrname]._dbus_annotations = (

1151

dict(attribute._dbus_annotations))

1704

1152

except AttributeError:

1705

1153

pass

1706

1154

# Is this a D-Bus property?

1709

1157

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

1710

1158

# property with the alternate D-Bus interface

1711

1159

# name. Add it to the class.

1712

attr[attrname] = (dbus_service_property(

1713

alt_interface, attribute._dbus_signature,

1714

attribute._dbus_access,

1715

attribute._dbus_get_args_options

1716

["byte_arrays"])

1717

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

1718

1173

# Copy annotations, if any

1719

1174

try:

1720

attr[attrname]._dbus_annotations = dict(

1721

attribute._dbus_annotations)

1175

attr[attrname]._dbus_annotations = (

1176

dict(attribute._dbus_annotations))

1722

1177

except AttributeError:

1723

1178

pass

1724

1179

# Is this a D-Bus interface?

1727

1182

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

1728

1183

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

1729

1184

# to the class.

1730

attr[attrname] = (

1731

dbus_interface_annotations(alt_interface)

1732

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

1733

1193

if deprecate:

1734

1194

# Deprecate all alternate interfaces

1735

iname = "_AlternateDBusNames_interface_annotation{}"

1195

iname="_AlternateDBusNames_interface_annotation{}"

1736

1196

for interface_name in interface_names:

1737

1738

1197

@dbus_interface_annotations(interface_name)

1739

1198

def func(self):

1740

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

1741

"true"}

1199

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

1200

"true" }

1742

1201

# Find an unused name

1743

1202

for aname in (iname.format(i)

1744

1203

for i in itertools.count()):

1748

1207

if interface_names:

1749

1208

# Replace the class with a new subclass of it with

1750

1209

# methods, signals, etc. as created above.

1751

if sys.version_info.major == 2:

1752

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

1753

(cls, ), attr)

1754

else:

1755

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

1756

(cls, ), attr)

1210

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

1211

(cls,), attr)

1757

1212

return cls

1758

1759

1213

return wrapper

1760

1214

1761

1215

1762

1216

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

1763

"se.bsnet.fukt.Mandos"})

1217

"se.bsnet.fukt.Mandos"})

1764

1218

class ClientDBus(Client, DBusObjectWithProperties):

1765

1219

"""A Client class using D-Bus

1766

1220

1767

1221

Attributes:

1768

1222

dbus_object_path: dbus.ObjectPath

1769

1223

bus: dbus.SystemBus()

1770

1224

"""

1771

1225

1772

1226

runtime_expansions = (Client.runtime_expansions

1773

+ ("dbus_object_path", ))

1774

1227

+ ("dbus_object_path",))

1228

1775

1229

_interface = "se.recompile.Mandos.Client"

1776

1230

1777

1231

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

1778

1779

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

1232

1233

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

1780

1234

self.bus = bus

1781

1235

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

1782

1236

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

1784

1238

client_object_name = str(self.name).translate(

1785

1239

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

1786

1240

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

1787

self.dbus_object_path = dbus.ObjectPath(

1788

"/clients/" + client_object_name)

1241

self.dbus_object_path = (dbus.ObjectPath

1242

("/clients/" + client_object_name))

1789

1243

DBusObjectWithProperties.__init__(self, self.bus,

1790

1244

self.dbus_object_path)

1791

1792

def notifychangeproperty(transform_func, dbus_name,

1793

type_func=lambda x: x,

1794

variant_level=1,

1795

invalidate_only=False,

1245

1246

def notifychangeproperty(transform_func,

1247

dbus_name, type_func=lambda x: x,

1248

variant_level=1, invalidate_only=False,

1796

1249

_interface=_interface):

1797

1250

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

1798

1251

its changes to DBus.

1799

1252

1800

1253

transform_fun: Function that takes a value and a variant_level

1801

1254

and transforms it to a D-Bus type.

1802

1255

dbus_name: D-Bus name of the variable

1805

1258

variant_level: D-Bus variant level. Default: 1

1806

1259

"""

1807

1260

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

1808

1809

1261

def setter(self, value):

1810

1262

if hasattr(self, "dbus_object_path"):

1811

1263

if (not hasattr(self, attrname) or

1812

1264

type_func(getattr(self, attrname, None))

1813

1265

!= type_func(value)):

1814

1266

if invalidate_only:

1815

self.PropertiesChanged(

1816

_interface, dbus.Dictionary(),

1817

dbus.Array((dbus_name, )))

1267

self.PropertiesChanged(_interface,

1268

dbus.Dictionary(),

1269

dbus.Array

1270

((dbus_name,)))

1818

1271

else:

1819

dbus_value = transform_func(

1820

type_func(value),

1821

variant_level=variant_level)

1272

dbus_value = transform_func(type_func(value),

1273

variant_level

1274

=variant_level)

1822

1275

self.PropertyChanged(dbus.String(dbus_name),

1823

1276

dbus_value)

1824

self.PropertiesChanged(

1825

_interface,

1826

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

1827

dbus_value}),

1828

dbus.Array())

1277

self.PropertiesChanged(_interface,

1278

dbus.Dictionary({

1279

dbus.String(dbus_name):

1280

dbus_value }), dbus.Array())

1829

1281

setattr(self, attrname, value)

1830

1282

1831

1283

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

1832

1284

1833

1285

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1834

1286

approvals_pending = notifychangeproperty(dbus.Boolean,

1835

1287

"ApprovalPending",

1836

type_func=bool)

1288

type_func = bool)

1837

1289

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

1838

1290

last_enabled = notifychangeproperty(datetime_to_dbus,

1839

1291

"LastEnabled")

1840

checker = notifychangeproperty(

1841

dbus.Boolean, "CheckerRunning",

1842

type_func=lambda checker: checker is not None)

1292

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

1293

type_func = lambda checker:

1294

checker is not None)

1843

1295

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1844

1296

"LastCheckedOK")

1845

1297

last_checker_status = notifychangeproperty(dbus.Int16,

1848

1300

datetime_to_dbus, "LastApprovalRequest")

1849

1301

approved_by_default = notifychangeproperty(dbus.Boolean,

1850

1302

"ApprovedByDefault")

1851

approval_delay = notifychangeproperty(

1852

dbus.UInt64, "ApprovalDelay",

1853

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)

1854

1308

approval_duration = notifychangeproperty(

1855

1309

dbus.UInt64, "ApprovalDuration",

1856

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

1310

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

1857

1311

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

1858

timeout = notifychangeproperty(

1859

dbus.UInt64, "Timeout",

1860

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

1312

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

1313

type_func = lambda td:

1314

td.total_seconds() * 1000)

1861

1315

extended_timeout = notifychangeproperty(

1862

1316

dbus.UInt64, "ExtendedTimeout",

1863

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

1864

interval = notifychangeproperty(

1865

dbus.UInt64, "Interval",

1866

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)

1867

1323

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

1868

1324

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

1869

1325

invalidate_only=True)

1870

1326

1871

1327

del notifychangeproperty

1872

1328

1873

1329

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

1874

1330

try:

1875

1331

self.remove_from_connection()

1878

1334

if hasattr(DBusObjectWithProperties, "__del__"):

1879

1335

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

1880

1336

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

1881

1882

def checker_callback(self, source, condition,

1883

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

1884

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

1885

connection, command, *args,

1886

**kwargs)

1887

exitstatus = self.last_checker_status

1888

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)

1889

1344

# Emit D-Bus signal

1890

1345

self.CheckerCompleted(dbus.Int16(exitstatus),

1891

# This is specific to GNU libC

1892

dbus.Int64(exitstatus << 8),

1346

dbus.Int64(condition),

1893

1347

dbus.String(command))

1894

1348

else:

1895

1349

# Emit D-Bus signal

1896

1350

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

1897

dbus.Int64(

1898

# This is specific to GNU libC

1899

(exitstatus << 8)

1900

| self.last_checker_signal),

1351

dbus.Int64(condition),

1901

1352

dbus.String(command))

1902

return ret

1903

1353

1354

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

1355

*args, **kwargs)

1356

1904

1357

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

1905

1358

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

1906

1359

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

1910

1363

# Emit D-Bus signal

1911

1364

self.CheckerStarted(self.current_checker_command)

1912

1365

return r

1913

1366

1914

1367

def _reset_approved(self):

1915

1368

self.approved = None

1916

1369

return False

1917

1370

1918

1371

def approve(self, value=True):

1919

1372

self.approved = value

1920

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

1921

* 1000), self._reset_approved)

1373

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

1374

* 1000), self._reset_approved)

1922

1375

self.send_changedstate()

1923

1924

# D-Bus methods, signals & properties

1925

1926

# Interfaces

1927

1928

# Signals

1929

1376

1377

## D-Bus methods, signals & properties

1378

1379

## Interfaces

1380

1381

## Signals

1382

1930

1383

# CheckerCompleted - signal

1931

1384

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

1932

1385

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

1933

1386

"D-Bus signal"

1934

1387

pass

1935

1388

1936

1389

# CheckerStarted - signal

1937

1390

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

1938

1391

def CheckerStarted(self, command):

1939

1392

"D-Bus signal"

1940

1393

pass

1941

1394

1942

1395

# PropertyChanged - signal

1943

1396

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

1944

1397

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

1945

1398

def PropertyChanged(self, property, value):

1946

1399

"D-Bus signal"

1947

1400

pass

1948

1401

1949

1402

# GotSecret - signal

1950

1403

@dbus.service.signal(_interface)

1951

1404

def GotSecret(self):

1954

1407

server to mandos-client

1955

1408

"""

1956

1409

pass

1957

1410

1958

1411

# Rejected - signal

1959

1412

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

1960

1413

def Rejected(self, reason):

1961

1414

"D-Bus signal"

1962

1415

pass

1963

1416

1964

1417

# NeedApproval - signal

1965

1418

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

1966

1419

def NeedApproval(self, timeout, default):

1967

1420

"D-Bus signal"

1968

1421

return self.need_approval()

1969

1970

# Methods

1971

1422

1423

## Methods

1424

1972

1425

# Approve - method

1973

1426

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

1974

1427

def Approve(self, value):

1975

1428

self.approve(value)

1976

1429

1977

1430

# CheckedOK - method

1978

1431

@dbus.service.method(_interface)

1979

1432

def CheckedOK(self):

1980

1433

self.checked_ok()

1981

1434

1982

1435

# Enable - method

1983

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

1984

1436

@dbus.service.method(_interface)

1985

1437

def Enable(self):

1986

1438

"D-Bus method"

1987

1439

self.enable()

1988

1440

1989

1441

# StartChecker - method

1990

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

1991

1442

@dbus.service.method(_interface)

1992

1443

def StartChecker(self):

1993

1444

"D-Bus method"

1994

1445

self.start_checker()

1995

1446

1996

1447

# Disable - method

1997

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

1998

1448

@dbus.service.method(_interface)

1999

1449

def Disable(self):

2000

1450

"D-Bus method"

2001

1451

self.disable()

2002

1452

2003

1453

# StopChecker - method

2004

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

2005

1454

@dbus.service.method(_interface)

2006

1455

def StopChecker(self):

2007

1456

self.stop_checker()

2008

2009

# Properties

2010

1457

1458

## Properties

1459

2011

1460

# ApprovalPending - property

2012

1461

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

2013

1462

def ApprovalPending_dbus_property(self):

2014

1463

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

2015

1464

2016

1465

# ApprovedByDefault - property

2017

@dbus_service_property(_interface,

2018

signature="b",

1466

@dbus_service_property(_interface, signature="b",

2019

1467

access="readwrite")

2020

1468

def ApprovedByDefault_dbus_property(self, value=None):

2021

1469

if value is None: # get

2022

1470

return dbus.Boolean(self.approved_by_default)

2023

1471

self.approved_by_default = bool(value)

2024

1472

2025

1473

# ApprovalDelay - property

2026

@dbus_service_property(_interface,

2027

signature="t",

1474

@dbus_service_property(_interface, signature="t",

2028

1475

access="readwrite")

2029

1476

def ApprovalDelay_dbus_property(self, value=None):

2030

1477

if value is None: # get

2031

1478

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

2032

1479

* 1000)

2033

1480

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

2034

1481

2035

1482

# ApprovalDuration - property

2036

@dbus_service_property(_interface,

2037

signature="t",

1483

@dbus_service_property(_interface, signature="t",

2038

1484

access="readwrite")

2039

1485

def ApprovalDuration_dbus_property(self, value=None):

2040

1486

if value is None: # get

2041

1487

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

2042

1488

* 1000)

2043

1489

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

2044

1490

2045

1491

# Name - property

2046

@dbus_annotations(

2047

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

2048

1492

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

2049

1493

def Name_dbus_property(self):

2050

1494

return dbus.String(self.name)

2051

2052

# KeyID - property

2053

@dbus_annotations(

2054

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

2055

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

2056

def KeyID_dbus_property(self):

2057

return dbus.String(self.key_id)

2058

1495

2059

1496

# Fingerprint - property

2060

@dbus_annotations(

2061

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

2062

1497

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

2063

1498

def Fingerprint_dbus_property(self):

2064

1499

return dbus.String(self.fingerprint)

2065

1500

2066

1501

# Host - property

2067

@dbus_service_property(_interface,

2068

signature="s",

1502

@dbus_service_property(_interface, signature="s",

2069

1503

access="readwrite")

2070

1504

def Host_dbus_property(self, value=None):

2071

1505

if value is None: # get

2072

1506

return dbus.String(self.host)

2073

1507

self.host = str(value)

2074

1508

2075

1509

# Created - property

2076

@dbus_annotations(

2077

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

2078

1510

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

2079

1511

def Created_dbus_property(self):

2080

1512

return datetime_to_dbus(self.created)

2081

1513

2082

1514

# LastEnabled - property

2083

1515

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

2084

1516

def LastEnabled_dbus_property(self):

2085

1517

return datetime_to_dbus(self.last_enabled)

2086

1518

2087

1519

# Enabled - property

2088

@dbus_service_property(_interface,

2089

signature="b",

1520

@dbus_service_property(_interface, signature="b",

2090

1521

access="readwrite")

2091

1522

def Enabled_dbus_property(self, value=None):

2092

1523

if value is None: # get

2095

1526

self.enable()

2096

1527

else:

2097

1528

self.disable()

2098

1529

2099

1530

# LastCheckedOK - property

2100

@dbus_service_property(_interface,

2101

signature="s",

1531

@dbus_service_property(_interface, signature="s",

2102

1532

access="readwrite")

2103

1533

def LastCheckedOK_dbus_property(self, value=None):

2104

1534

if value is not None:

2105

1535

self.checked_ok()

2106

1536

return

2107

1537

return datetime_to_dbus(self.last_checked_ok)

2108

1538

2109

1539

# LastCheckerStatus - property

2110

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

1540

@dbus_service_property(_interface, signature="n",

1541

access="read")

2111

1542

def LastCheckerStatus_dbus_property(self):

2112

1543

return dbus.Int16(self.last_checker_status)

2113

1544

2114

1545

# Expires - property

2115

1546

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

2116

1547

def Expires_dbus_property(self):

2117

1548

return datetime_to_dbus(self.expires)

2118

1549

2119

1550

# LastApprovalRequest - property

2120

1551

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

2121

1552

def LastApprovalRequest_dbus_property(self):

2122

1553

return datetime_to_dbus(self.last_approval_request)

2123

1554

2124

1555

# Timeout - property

2125

@dbus_service_property(_interface,

2126

signature="t",

1556

@dbus_service_property(_interface, signature="t",

2127

1557

access="readwrite")

2128

1558

def Timeout_dbus_property(self, value=None):

2129

1559

if value is None: # get

2141

1571

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

2142

1572

is None):

2143

1573

return

2144

GLib.source_remove(self.disable_initiator_tag)

2145

self.disable_initiator_tag = GLib.timeout_add(

2146

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

2147

self.disable)

2148

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

2149

1580

# ExtendedTimeout - property

2150

@dbus_service_property(_interface,

2151

signature="t",

1581

@dbus_service_property(_interface, signature="t",

2152

1582

access="readwrite")

2153

1583

def ExtendedTimeout_dbus_property(self, value=None):

2154

1584

if value is None: # get

2155

1585

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

2156

1586

* 1000)

2157

1587

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

2158

1588

2159

1589

# Interval - property

2160

@dbus_service_property(_interface,

2161

signature="t",

1590

@dbus_service_property(_interface, signature="t",

2162

1591

access="readwrite")

2163

1592

def Interval_dbus_property(self, value=None):

2164

1593

if value is None: # get

2168

1597

return

2169

1598

if self.enabled:

2170

1599

# Reschedule checker run

2171

GLib.source_remove(self.checker_initiator_tag)

2172

self.checker_initiator_tag = GLib.timeout_add(

2173

value, self.start_checker)

2174

self.start_checker() # Start one now, too

2175

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

2176

1605

# Checker - property

2177

@dbus_service_property(_interface,

2178

signature="s",

1606

@dbus_service_property(_interface, signature="s",

2179

1607

access="readwrite")

2180

1608

def Checker_dbus_property(self, value=None):

2181

1609

if value is None: # get

2182

1610

return dbus.String(self.checker_command)

2183

1611

self.checker_command = str(value)

2184

1612

2185

1613

# CheckerRunning - property

2186

@dbus_service_property(_interface,

2187

signature="b",

1614

@dbus_service_property(_interface, signature="b",

2188

1615

access="readwrite")

2189

1616

def CheckerRunning_dbus_property(self, value=None):

2190

1617

if value is None: # get

2193

1620

self.start_checker()

2194

1621

else:

2195

1622

self.stop_checker()

2196

1623

2197

1624

# ObjectPath - property

2198

@dbus_annotations(

2199

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

2200

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

2201

1625

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

2202

1626

def ObjectPath_dbus_property(self):

2203

return self.dbus_object_path # is already a dbus.ObjectPath

2204

1627

return self.dbus_object_path # is already a dbus.ObjectPath

1628

2205

1629

# Secret = property

2206

@dbus_annotations(

2207

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

2208

"invalidates"})

2209

@dbus_service_property(_interface,

2210

signature="ay",

2211

access="write",

2212

byte_arrays=True)

1630

@dbus_service_property(_interface, signature="ay",

1631

access="write", byte_arrays=True)

2213

1632

def Secret_dbus_property(self, value):

2214

1633

self.secret = bytes(value)

2215

1634

2216

1635

del _interface

2217

1636

2218

1637

2219

class ProxyClient:

2220

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

1638

class ProxyClient(object):

1639

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

2221

1640

self._pipe = child_pipe

2222

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

1641

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

2223

1642

if not self._pipe.recv():

2224

raise KeyError(key_id or fpr)

2225

1643

raise KeyError()

1644

2226

1645

def __getattribute__(self, name):

2227

1646

if name == '_pipe':

2228

1647

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

2231

1650

if data[0] == 'data':

2232

1651

return data[1]

2233

1652

if data[0] == 'function':

2234

2235

1653

def func(*args, **kwargs):

2236

1654

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

2237

1655

return self._pipe.recv()[1]

2238

2239

1656

return func

2240

1657

2241

1658

def __setattr__(self, name, value):

2242

1659

if name == '_pipe':

2243

1660

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

2246

1663

2247

1664

class ClientHandler(socketserver.BaseRequestHandler, object):

2248

1665

"""A class to handle client connections.

2249

1666

2250

1667

Instantiated once for each connection to handle it.

2251

1668

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

2252

1669

2253

1670

def handle(self):

2254

1671

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

2255

1672

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

2256

1673

str(self.client_address))

2257

1674

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

2258

1675

self.server.child_pipe.fileno())

2259

2260

session = gnutls.ClientSession(self.request)

2261

2262

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

2263

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

2264

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

2265

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

2266

1691

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

2267

1692

priority = self.server.gnutls_priority

2268

1693

if priority is None:

2269

1694

priority = "NORMAL"

2270

gnutls.priority_set_direct(session._c_object,

2271

priority.encode("utf-8"),

2272

None)

2273

1695

(gnutls.library.functions

1696

.gnutls_priority_set_direct(session._c_object,

1697

priority, None))

1698

2274

1699

# Start communication using the Mandos protocol

2275

1700

# Get protocol number

2276

1701

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

2281

1706

except (ValueError, IndexError, RuntimeError) as error:

2282

1707

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

2283

1708

return

2284

1709

2285

1710

# Start GnuTLS connection

2286

1711

try:

2287

1712

session.handshake()

2288

except gnutls.Error as error:

1713

except gnutls.errors.GNUTLSError as error:

2289

1714

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

2290

1715

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

2291

1716

# established. Just abandon the request.

2292

1717

return

2293

1718

logger.debug("Handshake succeeded")

2294

1719

2295

1720

approval_required = False

2296

1721

try:

2297

if gnutls.has_rawpk:

2298

fpr = b""

2299

try:

2300

key_id = self.key_id(

2301

self.peer_certificate(session))

2302

except (TypeError, gnutls.Error) as error:

2303

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

2304

return

2305

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

2306

2307

else:

2308

key_id = b""

2309

try:

2310

fpr = self.fingerprint(

2311

self.peer_certificate(session))

2312

except (TypeError, gnutls.Error) as error:

2313

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

2314

return

2315

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

2316

2317

try:

2318

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,

2319

1733

self.client_address)

2320

1734

except KeyError:

2321

1735

return

2322

1736

2323

1737

if client.approval_delay:

2324

1738

delay = client.approval_delay

2325

1739

client.approvals_pending += 1

2326

1740

approval_required = True

2327

1741

2328

1742

while True:

2329

1743

if not client.enabled:

2330

1744

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

2331

client.name)

1745

client.name)

2332

1746

if self.server.use_dbus:

2333

1747

# Emit D-Bus signal

2334

1748

client.Rejected("Disabled")

2335

1749

return

2336

1750

2337

1751

if client.approved or not client.approval_delay:

2338

# We are approved or approval is disabled

1752

#We are approved or approval is disabled

2339

1753

break

2340

1754

elif client.approved is None:

2341

1755

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

2352

1766

# Emit D-Bus signal

2353

1767

client.Rejected("Denied")

2354

1768

return

2355

2356

# wait until timeout or approved

1769

1770

#wait until timeout or approved

2357

1771

time = datetime.datetime.now()

2358

1772

client.changedstate.acquire()

2359

1773

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

2372

1786

break

2373

1787

else:

2374

1788

delay -= time2 - time

2375

2376

try:

2377

session.send(client.secret)

2378

except gnutls.Error as error:

2379

logger.warning("gnutls send failed",

2380

exc_info=error)

2381

return

2382

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

2383

1803

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

2384

1804

# bump the timeout using extended_timeout

2385

1805

client.bump_timeout(client.extended_timeout)

2386

1806

if self.server.use_dbus:

2387

1807

# Emit D-Bus signal

2388

1808

client.GotSecret()

2389

1809

2390

1810

finally:

2391

1811

if approval_required:

2392

1812

client.approvals_pending -= 1

2393

1813

try:

2394

1814

session.bye()

2395

except gnutls.Error as error:

1815

except gnutls.errors.GNUTLSError as error:

2396

1816

logger.warning("GnuTLS bye failed",

2397

1817

exc_info=error)

2398

1818

2399

1819

@staticmethod

2400

1820

def peer_certificate(session):

2401

"Return the peer's certificate as a bytestring"

2402

try:

2403

cert_type = gnutls.certificate_type_get2(session._c_object,

2404

gnutls.CTYPE_PEERS)

2405

except AttributeError:

2406

cert_type = gnutls.certificate_type_get(session._c_object)

2407

if gnutls.has_rawpk:

2408

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2409

else:

2410

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2411

# If not a valid certificate type...

2412

if cert_type not in valid_cert_types:

2413

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

2414

valid_cert_types)

2415

# ...return invalid data

2416

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

2417

1828

list_size = ctypes.c_uint(1)

2418

cert_list = (gnutls.certificate_get_peers

1829

cert_list = (gnutls.library.functions

1830

.gnutls_certificate_get_peers

2419

1831

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

2420

1832

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

2421

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

1833

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

1834

" certificate")

2422

1835

if list_size.value == 0:

2423

1836

return None

2424

1837

cert = cert_list[0]

2425

1838

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

2426

2427

@staticmethod

2428

def key_id(certificate):

2429

"Convert a certificate bytestring to a hexdigit key ID"

2430

# New GnuTLS "datum" with the public key

2431

datum = gnutls.datum_t(

2432

ctypes.cast(ctypes.c_char_p(certificate),

2433

ctypes.POINTER(ctypes.c_ubyte)),

2434

ctypes.c_uint(len(certificate)))

2435

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

2436

# New empty GnuTLS certificate

2437

pubkey = gnutls.pubkey_t()

2438

gnutls.pubkey_init(ctypes.byref(pubkey))

2439

# Import the raw public key into the certificate

2440

gnutls.pubkey_import(pubkey,

2441

ctypes.byref(datum),

2442

gnutls.X509_FMT_DER)

2443

# New buffer for the key ID

2444

buf = ctypes.create_string_buffer(32)

2445

buf_len = ctypes.c_size_t(len(buf))

2446

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

2447

gnutls.pubkey_get_key_id(pubkey,

2448

gnutls.KEYID_USE_SHA256,

2449

ctypes.cast(ctypes.byref(buf),

2450

ctypes.POINTER(ctypes.c_ubyte)),

2451

ctypes.byref(buf_len))

2452

# Deinit the certificate

2453

gnutls.pubkey_deinit(pubkey)

2454

2455

# Convert the buffer to a Python bytestring

2456

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

2457

# Convert the bytestring to hexadecimal notation

2458

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

2459

return hex_key_id

2460

1839

2461

1840

@staticmethod

2462

1841

def fingerprint(openpgp):

2463

1842

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2464

1843

# New GnuTLS "datum" with the OpenPGP public key

2465

datum = gnutls.datum_t(

2466

ctypes.cast(ctypes.c_char_p(openpgp),

2467

ctypes.POINTER(ctypes.c_ubyte)),

2468

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

2469

1849

# New empty GnuTLS certificate

2470

crt = gnutls.openpgp_crt_t()

2471

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

2472

1853

# Import the OpenPGP public key into the certificate

2473

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

2474

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

2475

1858

# Verify the self signature in the key

2476

1859

crtverify = ctypes.c_uint()

2477

gnutls.openpgp_crt_verify_self(crt, 0,

2478

ctypes.byref(crtverify))

1860

(gnutls.library.functions

1861

.gnutls_openpgp_crt_verify_self(crt, 0,

1862

ctypes.byref(crtverify)))

2479

1863

if crtverify.value != 0:

2480

gnutls.openpgp_crt_deinit(crt)

2481

raise gnutls.CertificateSecurityError(code

2482

=crtverify.value)

1864

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1865

raise (gnutls.errors.CertificateSecurityError

1866

("Verify failed"))

2483

1867

# New buffer for the fingerprint

2484

1868

buf = ctypes.create_string_buffer(20)

2485

1869

buf_len = ctypes.c_size_t()

2486

1870

# Get the fingerprint from the certificate into the buffer

2487

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

2488

ctypes.byref(buf_len))

1871

(gnutls.library.functions

1872

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

1873

ctypes.byref(buf_len)))

2489

1874

# Deinit the certificate

2490

gnutls.openpgp_crt_deinit(crt)

1875

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2491

1876

# Convert the buffer to a Python bytestring

2492

1877

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

2493

1878

# Convert the bytestring to hexadecimal notation

2495

1880

return hex_fpr

2496

1881

2497

1882

2498

class MultiprocessingMixIn:

1883

class MultiprocessingMixIn(object):

2499

1884

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

2500

2501

1885

def sub_process_main(self, request, address):

2502

1886

try:

2503

1887

self.finish_request(request, address)

2504

1888

except Exception:

2505

1889

self.handle_error(request, address)

2506

1890

self.close_request(request)

2507

1891

2508

1892

def process_request(self, request, address):

2509

1893

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

2510

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

2511

args=(request, address))

1894

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

1895

args = (request, address))

2512

1896

proc.start()

2513

1897

return proc

2514

1898

2515

1899

2516

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1900

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2517

1901

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

2518

2519

1902

def process_request(self, request, client_address):

2520

1903

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

2521

1904

2522

1905

This function creates a new pipe in self.pipe

2523

1906

"""

2524

1907

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2525

1908

2526

1909

proc = MultiprocessingMixIn.process_request(self, request,

2527

1910

client_address)

2528

1911

self.child_pipe.close()

2529

1912

self.add_pipe(parent_pipe, proc)

2530

1913

2531

1914

def add_pipe(self, parent_pipe, proc):

2532

1915

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

2533

1916

raise NotImplementedError()

2534

1917

2535

1918

2536

1919

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2537

socketserver.TCPServer):

1920

socketserver.TCPServer, object):

2538

1921

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

2539

1922

2540

1923

Attributes:

2541

1924

enabled: Boolean; whether this server is activated yet

2542

1925

interface: None or a network interface name (string)

2543

1926

use_ipv6: Boolean; to use IPv6 or not

2544

1927

"""

2545

2546

1928

def __init__(self, server_address, RequestHandlerClass,

2547

interface=None,

2548

use_ipv6=True,

2549

socketfd=None):

1929

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

2550

1930

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

2551

1931

creating a new one with socket.socket().

2552

1932

"""

2558

1938

self.socketfd = socketfd

2559

1939

# Save the original socket.socket() function

2560

1940

self.socket_socket = socket.socket

2561

2562

1941

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

2563

#

1942

#

2564

1943

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

2565

1944

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

2566

1945

# patching socket.socket.)

2567

#

1946

#

2568

1947

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

2569

1948

@functools.wraps(socket.socket)

2570

1949

def socket_wrapper(*args, **kwargs):

2582

1961

# socket_wrapper(), if socketfd was set.

2583

1962

socketserver.TCPServer.__init__(self, server_address,

2584

1963

RequestHandlerClass)

2585

1964

2586

1965

def server_bind(self):

2587

1966

"""This overrides the normal server_bind() function

2588

1967

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

2589

1968

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

2590

global SO_BINDTODEVICE

2591

1969

if self.interface is not None:

2592

1970

if SO_BINDTODEVICE is None:

2593

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

2594

# common enough.

2595

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

2596

SO_BINDTODEVICE = 25

2597

try:

2598

self.socket.setsockopt(

2599

socket.SOL_SOCKET, SO_BINDTODEVICE,

2600

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

2601

except socket.error as error:

2602

if error.errno == errno.EPERM:

2603

logger.error("No permission to bind to"

2604

" interface %s", self.interface)

2605

elif error.errno == errno.ENOPROTOOPT:

2606

logger.error("SO_BINDTODEVICE not available;"

2607

" cannot bind to interface %s",

2608

self.interface)

2609

elif error.errno == errno.ENODEV:

2610

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

2611

" cannot bind", self.interface)

2612

else:

2613

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

2614

1993

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

2615

1994

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

2616

if self.server_address[1]:

2617

self.allow_reuse_address = True

2618

1995

if not self.server_address[0]:

2619

1996

if self.address_family == socket.AF_INET6:

2620

any_address = "::" # in6addr_any

1997

any_address = "::" # in6addr_any

2621

1998

else:

2622

any_address = "0.0.0.0" # INADDR_ANY

1999

any_address = "0.0.0.0" # INADDR_ANY

2623

2000

self.server_address = (any_address,

2624

2001

self.server_address[1])

2625

2002

elif not self.server_address[1]:

2626

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

2003

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

2004

0)

2627

2005

# if self.interface:

2628

2006

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

2629

2007

# 0, # port

2635

2013

2636

2014

class MandosServer(IPv6_TCPServer):

2637

2015

"""Mandos server.

2638

2016

2639

2017

Attributes:

2640

2018

clients: set of Client objects

2641

2019

gnutls_priority GnuTLS priority string

2642

2020

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

2643

2644

Assumes a GLib.MainLoop event loop.

2021

2022

Assumes a gobject.MainLoop event loop.

2645

2023

"""

2646

2647

2024

def __init__(self, server_address, RequestHandlerClass,

2648

interface=None,

2649

use_ipv6=True,

2650

clients=None,

2651

gnutls_priority=None,

2652

use_dbus=True,

2653

socketfd=None):

2025

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

2026

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

2654

2027

self.enabled = False

2655

2028

self.clients = clients

2656

2029

if self.clients is None:

2659

2032

self.gnutls_priority = gnutls_priority

2660

2033

IPv6_TCPServer.__init__(self, server_address,

2661

2034

RequestHandlerClass,

2662

interface=interface,

2663

use_ipv6=use_ipv6,

2664

socketfd=socketfd)

2665

2035

interface = interface,

2036

use_ipv6 = use_ipv6,

2037

socketfd = socketfd)

2666

2038

def server_activate(self):

2667

2039

if self.enabled:

2668

2040

return socketserver.TCPServer.server_activate(self)

2669

2041

2670

2042

def enable(self):

2671

2043

self.enabled = True

2672

2044

2673

2045

def add_pipe(self, parent_pipe, proc):

2674

2046

# Call "handle_ipc" for both data and EOF events

2675

GLib.io_add_watch(

2676

parent_pipe.fileno(),

2677

GLib.IO_IN | GLib.IO_HUP,

2678

functools.partial(self.handle_ipc,

2679

parent_pipe=parent_pipe,

2680

proc=proc))

2681

2682

def handle_ipc(self, source, condition,

2683

parent_pipe=None,

2684

proc=None,

2685

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

2686

2056

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

2687

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

2057

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

2688

2058

# Wait for other process to exit

2689

2059

proc.join()

2690

2060

return False

2691

2061

2692

2062

# Read a request from the child

2693

2063

request = parent_pipe.recv()

2694

2064

command = request[0]

2695

2065

2696

2066

if command == 'init':

2697

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

2698

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

2699

address = request[3]

2700

2701

for c in self.clients.values():

2702

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2703

continue

2704

if key_id and c.key_id == key_id:

2705

client = c

2706

break

2707

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:

2708

2072

client = c

2709

2073

break

2710

2074

else:

2711

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

2712

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

2075

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

2076

"dress: %s", fpr, address)

2713

2077

if self.use_dbus:

2714

2078

# Emit D-Bus signal

2715

mandos_dbus_service.ClientNotFound(key_id or fpr,

2079

mandos_dbus_service.ClientNotFound(fpr,

2716

2080

address[0])

2717

2081

parent_pipe.send(False)

2718

2082

return False

2719

2720

GLib.io_add_watch(

2721

parent_pipe.fileno(),

2722

GLib.IO_IN | GLib.IO_HUP,

2723

functools.partial(self.handle_ipc,

2724

parent_pipe=parent_pipe,

2725

proc=proc,

2726

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

2727

2092

parent_pipe.send(True)

2728

2093

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

2729

2094

# same fileno

2732

2097

funcname = request[1]

2733

2098

args = request[2]

2734

2099

kwargs = request[3]

2735

2100

2736

2101

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

2737

2102

funcname)(*args,

2738

**kwargs)))

2739

2103

**kwargs)))

2104

2740

2105

if command == 'getattr':

2741

2106

attrname = request[1]

2742

if isinstance(client_object.__getattribute__(attrname),

2743

collections.Callable):

2744

parent_pipe.send(('function', ))

2107

if callable(client_object.__getattribute__(attrname)):

2108

parent_pipe.send(('function',))

2745

2109

else:

2746

parent_pipe.send((

2747

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

2748

2110

parent_pipe.send(('data', client_object

2111

.__getattribute__(attrname)))

2112

2749

2113

if command == 'setattr':

2750

2114

attrname = request[1]

2751

2115

value = request[2]

2752

2116

setattr(client_object, attrname, value)

2753

2117

2754

2118

return True

2755

2119

2756

2120

2757

2121

def rfc3339_duration_to_delta(duration):

2758

2122

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

2759

2123

2760

2124

>>> rfc3339_duration_to_delta("P7D")

2761

2125

datetime.timedelta(7)

2762

2126

>>> rfc3339_duration_to_delta("PT60S")

2772

2136

>>> rfc3339_duration_to_delta("P1DT3M20S")

2773

2137

datetime.timedelta(1, 200)

2774

2138

"""

2775

2139

2776

2140

# Parsing an RFC 3339 duration with regular expressions is not

2777

2141

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

2778

2142

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

2779

2143

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

2780

2144

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

2781

2145

# avoid excessive use of external libraries.

2782

2146

2783

2147

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

2784

Token = collections.namedtuple("Token", (

2785

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

2786

# a "group" containing digits

2787

"value", # datetime.timedelta or None

2788

"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

2789

2157

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

2790

2158

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

2791

2159

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

2792

2160

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

2793

2161

datetime.timedelta(seconds=1),

2794

frozenset((token_end, )))

2162

frozenset((token_end,)))

2795

2163

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

2796

2164

datetime.timedelta(minutes=1),

2797

2165

frozenset((token_second, token_end)))

2813

2181

frozenset((token_month, token_end)))

2814

2182

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

2815

2183

datetime.timedelta(weeks=1),

2816

frozenset((token_end, )))

2184

frozenset((token_end,)))

2817

2185

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

2818

2186

frozenset((token_year, token_month,

2819

2187

token_day, token_time,

2820

2188

token_week)))

2821

# Define starting values:

2822

# Value so far

2823

value = datetime.timedelta()

2189

# Define starting values

2190

value = datetime.timedelta() # Value so far

2824

2191

found_token = None

2825

# Following valid tokens

2826

followers = frozenset((token_duration, ))

2827

# String left to parse

2828

s = duration

2192

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

2193

s = duration # String left to parse

2829

2194

# Loop until end token is found

2830

2195

while found_token is not token_end:

2831

2196

# Search for any currently valid tokens

2847

2212

break

2848

2213

else:

2849

2214

# No currently valid tokens were found

2850

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

2851

.format(duration))

2215

raise ValueError("Invalid RFC 3339 duration")

2852

2216

# End token found

2853

2217

return value

2854

2218

2855

2219

2856

2220

def string_to_delta(interval):

2857

2221

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

2858

2222

2859

2223

>>> string_to_delta('7d')

2860

2224

datetime.timedelta(7)

2861

2225

>>> string_to_delta('60s')

2869

2233

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

2870

2234

datetime.timedelta(0, 330)

2871

2235

"""

2872

2236

2873

2237

try:

2874

2238

return rfc3339_duration_to_delta(interval)

2875

2239

except ValueError:

2876

2240

pass

2877

2241

2878

2242

timevalue = datetime.timedelta(0)

2879

2243

for s in interval.split():

2880

2244

try:

2891

2255

elif suffix == "w":

2892

2256

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

2893

2257

else:

2894

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

2258

raise ValueError("Unknown suffix {!r}"

2259

.format(suffix))

2895

2260

except IndexError as e:

2896

2261

raise ValueError(*(e.args))

2897

2262

timevalue += delta

2898

2263

return timevalue

2899

2264

2900

2265

2901

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

2266

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

2902

2267

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

2903

2268

2904

2269

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

2905

2270

if os.fork():

2906

2271

sys.exit()

2913

2278

# Close all standard open file descriptors

2914

2279

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

2915

2280

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

2916

raise OSError(errno.ENODEV,

2917

"{} not a character device"

2281

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

2918

2282

.format(os.devnull))

2919

2283

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

2920

2284

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

2924

2288

2925

2289

2926

2290

def main():

2927

2291

2928

2292

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

2929

2293

# Parsing of options, both command line and config file

2930

2294

2931

2295

parser = argparse.ArgumentParser()

2932

2296

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

2933

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

2297

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

2934

2298

help="show version number and exit")

2935

2299

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

2936

2300

help="Bind to interface IF")

2972

2336

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

2973

2337

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

2974

2338

default=None)

2975

2339

2976

2340

options = parser.parse_args()

2977

2341

2978

2342

if options.check:

2979

2343

import doctest

2980

2344

fail_count, test_count = doctest.testmod()

2981

2345

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

2982

2346

2983

2347

# Default values for config file for server-global settings

2984

if gnutls.has_rawpk:

2985

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

2986

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

2987

else:

2988

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

2989

":+SIGN-DSA-SHA256")

2990

server_defaults = {"interface": "",

2991

"address": "",

2992

"port": "",

2993

"debug": "False",

2994

"priority": priority,

2995

"servicename": "Mandos",

2996

"use_dbus": "True",

2997

"use_ipv6": "True",

2998

"debuglevel": "",

2999

"restore": "True",

3000

"socket": "",

3001

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

3002

"foreground": "False",

3003

"zeroconf": "True",

3004

}

3005

del priority

3006

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

3007

2365

# Parse config file for server-global settings

3008

server_config = configparser.ConfigParser(server_defaults)

2366

server_config = configparser.SafeConfigParser(server_defaults)

3009

2367

del server_defaults

3010

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

3011

# 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

3012

2371

server_settings = server_config.defaults()

3013

2372

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

3014

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

3015

"foreground", "zeroconf"):

2373

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

3016

2374

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

3017

2375

option)

3018

2376

if server_settings["port"]:

3028

2386

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

3029

2387

["socket"])

3030

2388

del server_config

3031

2389

3032

2390

# Override the settings from the config file with command line

3033

2391

# options, if set.

3034

2392

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

3035

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

3036

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

3037

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

2393

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

2394

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

2395

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

3038

2396

value = getattr(options, option)

3039

2397

if value is not None:

3040

2398

server_settings[option] = value

3052

2410

if server_settings["debug"]:

3053

2411

server_settings["foreground"] = True

3054

2412

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

3055

2413

3056

2414

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

3057

3058

if (not server_settings["zeroconf"]

3059

and not (server_settings["port"]

3060

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

3061

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

3062

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

3063

2422

# For convenience

3064

2423

debug = server_settings["debug"]

3065

2424

debuglevel = server_settings["debuglevel"]

3069

2428

stored_state_file)

3070

2429

foreground = server_settings["foreground"]

3071

2430

zeroconf = server_settings["zeroconf"]

3072

2431

3073

2432

if debug:

3074

2433

initlogger(debug, logging.DEBUG)

3075

2434

else:

3078

2437

else:

3079

2438

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

3080

2439

initlogger(debug, level)

3081

2440

3082

2441

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

3083

syslogger.setFormatter(

3084

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

3085

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

3086

server_settings["servicename"])))

3087

2442

syslogger.setFormatter(logging.Formatter

2443

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

2444

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

2445

.format(server_settings

2446

["servicename"])))

2447

3088

2448

# Parse config file with clients

3089

client_config = configparser.ConfigParser(Client.client_defaults)

2449

client_config = configparser.SafeConfigParser(Client

2450

.client_defaults)

3090

2451

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

3091

2452

"clients.conf"))

3092

2453

3093

2454

global mandos_dbus_service

3094

2455

mandos_dbus_service = None

3095

2456

3096

2457

socketfd = None

3097

2458

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

3098

2459

socketfd = server_settings["socket"]

3099

tcp_server = MandosServer(

3100

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

3101

ClientHandler,

3102

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

3103

use_ipv6=use_ipv6,

3104

gnutls_priority=server_settings["priority"],

3105

use_dbus=use_dbus,

3106

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)

3107

2470

if not foreground:

3108

2471

pidfilename = "/run/mandos.pid"

3109

2472

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

3110

2473

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

3111

2474

pidfile = None

3112

2475

try:

3113

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

2476

pidfile = open(pidfilename, "w")

3114

2477

except IOError as e:

3115

2478

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

3116

2479

exc_info=e)

3117

3118

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

3119

("mandos", "mandos"),

3120

("nobody", "nogroup")):

2480

2481

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

3121

2482

try:

3122

2483

uid = pwd.getpwnam(name).pw_uid

3123

gid = pwd.getpwnam(group).pw_gid

2484

gid = pwd.getpwnam(name).pw_gid

3124

2485

break

3125

2486

except KeyError:

3126

2487

continue

3130

2491

try:

3131

2492

os.setgid(gid)

3132

2493

os.setuid(uid)

3133

if debug:

3134

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

3135

gid))

3136

2494

except OSError as error:

3137

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

3138

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

3139

2495

if error.errno != errno.EPERM:

3140

2496

raise

3141

2497

3142

2498

if debug:

3143

2499

# Enable all possible GnuTLS debugging

3144

2500

3145

2501

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

3146

2502

# - GnuTLS manual

3147

gnutls.global_set_log_level(11)

3148

3149

@gnutls.log_func

2503

gnutls.library.functions.gnutls_global_set_log_level(11)

2504

2505

@gnutls.library.types.gnutls_log_func

3150

2506

def debug_gnutls(level, string):

3151

2507

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

3152

3153

gnutls.global_set_log_function(debug_gnutls)

3154

2508

2509

(gnutls.library.functions

2510

.gnutls_global_set_log_function(debug_gnutls))

2511

3155

2512

# Redirect stdin so all checkers get /dev/null

3156

2513

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

3157

2514

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

3158

2515

if null > 2:

3159

2516

os.close(null)

3160

2517

3161

2518

# Need to fork before connecting to D-Bus

3162

2519

if not foreground:

3163

2520

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

3164

2521

daemon()

3165

3166

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

3167

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

3168

# need to inform GLib that threads will be used.

3169

GLib.threads_init()

3170

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

3171

2527

global main_loop

3172

2528

# From the Avahi example code

3173

2529

DBusGMainLoop(set_as_default=True)

3174

main_loop = GLib.MainLoop()

2530

main_loop = gobject.MainLoop()

3175

2531

bus = dbus.SystemBus()

3176

2532

# End of Avahi example code

3177

2533

if use_dbus:

3178

2534

try:

3179

2535

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

3180

bus,

3181

do_not_queue=True)

3182

old_bus_name = dbus.service.BusName(

3183

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

3184

do_not_queue=True)

3185

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:

3186

2541

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

3187

2542

use_dbus = False

3188

2543

server_settings["use_dbus"] = False

3189

2544

tcp_server.use_dbus = False

3190

2545

if zeroconf:

3191

2546

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3192

service = AvahiServiceToSyslog(

3193

name=server_settings["servicename"],

3194

servicetype="_mandos._tcp",

3195

protocol=protocol,

3196

bus=bus)

2547

service = AvahiServiceToSyslog(name =

2548

server_settings["servicename"],

2549

servicetype = "_mandos._tcp",

2550

protocol = protocol, bus = bus)

3197

2551

if server_settings["interface"]:

3198

service.interface = if_nametoindex(

3199

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

3200

2552

service.interface = (if_nametoindex

2553

(server_settings["interface"]

2554

.encode("utf-8")))

2555

3201

2556

global multiprocessing_manager

3202

2557

multiprocessing_manager = multiprocessing.Manager()

3203

2558

3204

2559

client_class = Client

3205

2560

if use_dbus:

3206

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

3207

2561

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

2562

3208

2563

client_settings = Client.config_parser(client_config)

3209

2564

old_client_settings = {}

3210

2565

clients_data = {}

3211

2566

3212

2567

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

3213

2568

global wnull

3214

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

2569

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

3215

2570

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

3216

2571

# mode

3217

2572

if debug or not foreground:

3218

2573

wnull.close()

3219

2574

3220

2575

# Get client data and settings from last running state.

3221

2576

if server_settings["restore"]:

3222

2577

try:

3223

2578

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

3224

if sys.version_info.major == 2:

3225

clients_data, old_client_settings = pickle.load(

3226

stored_state)

3227

else:

3228

bytes_clients_data, bytes_old_client_settings = (

3229

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

3230

# Fix bytes to strings

3231

# clients_data

3232

# .keys()

3233

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

3234

if isinstance(key, bytes)

3235

else key): value

3236

for key, value in

3237

bytes_clients_data.items()}

3238

del bytes_clients_data

3239

for key in clients_data:

3240

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

3241

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

3242

for k, v in

3243

clients_data[key].items()}

3244

clients_data[key] = value

3245

# .client_structure

3246

value["client_structure"] = [

3247

(s.decode("utf-8")

3248

if isinstance(s, bytes)

3249

else s) for s in

3250

value["client_structure"]]

3251

# .name & .host

3252

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

3253

if isinstance(value[k], bytes):

3254

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

3255

if "key_id" not in value:

3256

value["key_id"] = ""

3257

elif "fingerprint" not in value:

3258

value["fingerprint"] = ""

3259

# old_client_settings

3260

# .keys()

3261

old_client_settings = {

3262

(key.decode("utf-8")

3263

if isinstance(key, bytes)

3264

else key): value

3265

for key, value in

3266

bytes_old_client_settings.items()}

3267

del bytes_old_client_settings

3268

# .host

3269

for value in old_client_settings.values():

3270

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

3271

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

3272

.decode("utf-8"))

2579

clients_data, old_client_settings = (pickle.load

2580

(stored_state))

3273

2581

os.remove(stored_state_path)

3274

2582

except IOError as e:

3275

2583

if e.errno == errno.ENOENT:

3276

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

3277

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

2584

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

2585

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

3278

2586

else:

3279

2587

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

3280

2588

exc_info=e)

3281

2589

raise

3282

2590

except EOFError as e:

3283

2591

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

3284

"EOFError:",

3285

exc_info=e)

3286

2592

"EOFError:", exc_info=e)

2593

3287

2594

with PGPEngine() as pgp:

3288

2595

for client_name, client in clients_data.items():

3289

2596

# Skip removed clients

3290

2597

if client_name not in client_settings:

3291

2598

continue

3292

2599

3293

2600

# Decide which value to use after restoring saved state.

3294

2601

# We have three different values: Old config file,

3295

2602

# new config file, and saved state.

3300

2607

# For each value in new config, check if it

3301

2608

# differs from the old config value (Except for

3302

2609

# the "secret" attribute)

3303

if (name != "secret"

3304

and (value !=

3305

old_client_settings[client_name][name])):

2610

if (name != "secret" and

2611

value != old_client_settings[client_name]

2612

[name]):

3306

2613

client[name] = value

3307

2614

except KeyError:

3308

2615

pass

3309

2616

3310

2617

# Clients who has passed its expire date can still be

3311

# enabled if its last checker was successful. A Client

2618

# enabled if its last checker was successful. Clients

3312

2619

# whose checker succeeded before we stored its state is

3313

2620

# assumed to have successfully run all checkers during

3314

2621

# downtime.

3317

2624

if not client["last_checked_ok"]:

3318

2625

logger.warning(

3319

2626

"disabling client {} - Client never "

3320

"performed a successful checker".format(

3321

client_name))

2627

"performed a successful checker"

2628

.format(client_name))

3322

2629

client["enabled"] = False

3323

2630

elif client["last_checker_status"] != 0:

3324

2631

logger.warning(

3325

2632

"disabling client {} - Client last"

3326

" checker failed with error code"

3327

" {}".format(

3328

client_name,

3329

client["last_checker_status"]))

2633

" checker failed with error code {}"

2634

.format(client_name,

2635

client["last_checker_status"]))

3330

2636

client["enabled"] = False

3331

2637

else:

3332

client["expires"] = (

3333

datetime.datetime.utcnow()

3334

+ client["timeout"])

2638

client["expires"] = (datetime.datetime

2639

.utcnow()

2640

+ client["timeout"])

3335

2641

logger.debug("Last checker succeeded,"

3336

" keeping {} enabled".format(

3337

client_name))

2642

" keeping {} enabled"

2643

.format(client_name))

3338

2644

try:

3339

client["secret"] = pgp.decrypt(

3340

client["encrypted_secret"],

3341

client_settings[client_name]["secret"])

2645

client["secret"] = (

2646

pgp.decrypt(client["encrypted_secret"],

2647

client_settings[client_name]

2648

["secret"]))

3342

2649

except PGPError:

3343

2650

# If decryption fails, we use secret from new settings

3344

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

3345

client_name))

3346

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

3347

["secret"])

3348

2651

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

2652

.format(client_name))

2653

client["secret"] = (

2654

client_settings[client_name]["secret"])

2655

3349

2656

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

3350

2657

for client_name in (set(old_client_settings)

3351

2658

- set(client_settings)):

3353

2660

for client_name in (set(client_settings)

3354

2661

- set(old_client_settings)):

3355

2662

clients_data[client_name] = client_settings[client_name]

3356

2663

3357

2664

# Create all client objects

3358

2665

for client_name, client in clients_data.items():

3359

2666

tcp_server.clients[client_name] = client_class(

3360

name=client_name,

3361

settings=client,

3362

server_settings=server_settings)

3363

2667

name = client_name, settings = client,

2668

server_settings = server_settings)

2669

3364

2670

if not tcp_server.clients:

3365

2671

logger.warning("No clients defined")

3366

2672

3367

2673

if not foreground:

3368

2674

if pidfile is not None:

3369

pid = os.getpid()

3370

2675

try:

3371

2676

with pidfile:

3372

print(pid, file=pidfile)

2677

pid = os.getpid()

2678

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

3373

2679

except IOError:

3374

2680

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

3375

2681

pidfilename, pid)

3376

2682

del pidfile

3377

2683

del pidfilename

3378

3379

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

3380

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3381

lambda: main_loop.quit() and False)

3382

2684

2685

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

2686

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

2687

3383

2688

if use_dbus:

3384

3385

@alternate_dbus_interfaces(

3386

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

3387

class MandosDBusService(DBusObjectWithObjectManager):

2689

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

2690

"se.bsnet.fukt.Mandos"})

2691

class MandosDBusService(DBusObjectWithProperties):

3388

2692

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

3389

3390

2693

def __init__(self):

3391

2694

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

3392

3393

2695

_interface = "se.recompile.Mandos"

3394

2696

2697

@dbus_interface_annotations(_interface)

2698

def _foo(self):

2699

return { "org.freedesktop.DBus.Property"

2700

".EmitsChangedSignal":

2701

"false"}

2702

3395

2703

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

3396

2704

def ClientAdded(self, objpath):

3397

2705

"D-Bus signal"

3398

2706

pass

3399

2707

3400

2708

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

3401

def ClientNotFound(self, key_id, address):

2709

def ClientNotFound(self, fingerprint, address):

3402

2710

"D-Bus signal"

3403

2711

pass

3404

3405

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

3406

"true"})

2712

3407

2713

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

3408

2714

def ClientRemoved(self, objpath, name):

3409

2715

"D-Bus signal"

3410

2716

pass

3411

3412

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

3413

"true"})

2717

3414

2718

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

3415

2719

def GetAllClients(self):

3416

2720

"D-Bus method"

3417

return dbus.Array(c.dbus_object_path for c in

3418

tcp_server.clients.values())

3419

3420

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

3421

"true"})

2721

return dbus.Array(c.dbus_object_path

2722

for c in

2723

tcp_server.clients.itervalues())

2724

3422

2725

@dbus.service.method(_interface,

3423

2726

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

3424

2727

def GetAllClientsWithProperties(self):

3425

2728

"D-Bus method"

3426

2729

return dbus.Dictionary(

3427

{c.dbus_object_path: c.GetAll(

3428

"se.recompile.Mandos.Client")

3429

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

2730

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

2731

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

3430

2732

signature="oa{sv}")

3431

2733

3432

2734

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

3433

2735

def RemoveClient(self, object_path):

3434

2736

"D-Bus method"

3435

for c in tcp_server.clients.values():

2737

for c in tcp_server.clients.itervalues():

3436

2738

if c.dbus_object_path == object_path:

3437

2739

del tcp_server.clients[c.name]

3438

2740

c.remove_from_connection()

3439

# Don't signal the disabling

2741

# Don't signal anything except ClientRemoved

3440

2742

c.disable(quiet=True)

3441

# Emit D-Bus signal for removal

3442

self.client_removed_signal(c)

2743

# Emit D-Bus signal

2744

self.ClientRemoved(object_path, c.name)

3443

2745

return

3444

2746

raise KeyError(object_path)

3445

2747

3446

2748

del _interface

3447

3448

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3449

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

3450

def GetManagedObjects(self):

3451

"""D-Bus method"""

3452

return dbus.Dictionary(

3453

{client.dbus_object_path:

3454

dbus.Dictionary(

3455

{interface: client.GetAll(interface)

3456

for interface in

3457

client._get_all_interface_names()})

3458

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

3459

3460

def client_added_signal(self, client):

3461

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

3462

if use_dbus:

3463

# New standard signal

3464

self.InterfacesAdded(

3465

client.dbus_object_path,

3466

dbus.Dictionary(

3467

{interface: client.GetAll(interface)

3468

for interface in

3469

client._get_all_interface_names()}))

3470

# Old signal

3471

self.ClientAdded(client.dbus_object_path)

3472

3473

def client_removed_signal(self, client):

3474

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

3475

if use_dbus:

3476

# New standard signal

3477

self.InterfacesRemoved(

3478

client.dbus_object_path,

3479

client._get_all_interface_names())

3480

# Old signal

3481

self.ClientRemoved(client.dbus_object_path,

3482

client.name)

3483

2749

3484

2750

mandos_dbus_service = MandosDBusService()

3485

3486

# Save modules to variables to exempt the modules from being

3487

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

3488

mp = multiprocessing

3489

wn = wnull

3490

2751

3491

2752

def cleanup():

3492

2753

"Cleanup function; run on exit"

3493

2754

if zeroconf:

3494

2755

service.cleanup()

3495

3496

mp.active_children()

3497

wn.close()

2756

2757

multiprocessing.active_children()

2758

wnull.close()

3498

2759

if not (tcp_server.clients or client_settings):

3499

2760

return

3500

2761

3501

2762

# Store client before exiting. Secrets are encrypted with key

3502

2763

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

3503

2764

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

3504

2765

clients = {}

3505

2766

with PGPEngine() as pgp:

3506

for client in tcp_server.clients.values():

2767

for client in tcp_server.clients.itervalues():

3507

2768

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

3508

2769

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

3509

2770

key)

3510

2771

client_dict = {}

3511

2772

3512

2773

# A list of attributes that can not be pickled

3513

2774

# + secret.

3514

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

3515

"checker", "server_settings"}

3516

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

3517

.Object):

2775

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

2776

"checker", "server_settings" }

2777

for name, typ in (inspect.getmembers

2778

(dbus.service.Object)):

3518

2779

exclude.add(name)

3519

2780

3520

2781

client_dict["encrypted_secret"] = (client

3521

2782

.encrypted_secret)

3522

2783

for attr in client.client_structure:

3523

2784

if attr not in exclude:

3524

2785

client_dict[attr] = getattr(client, attr)

3525

2786

3526

2787

clients[client.name] = client_dict

3527

2788

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

3528

2789

3529

2790

try:

3530

with tempfile.NamedTemporaryFile(

3531

mode='wb',

3532

suffix=".pickle",

3533

prefix='clients-',

3534

dir=os.path.dirname(stored_state_path),

3535

delete=False) as stored_state:

3536

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

3537

protocol=2)

3538

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

3539

2797

os.rename(tempname, stored_state_path)

3540

2798

except (IOError, OSError) as e:

3541

2799

if not debug:

3550

2808

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

3551

2809

exc_info=e)

3552

2810

raise

3553

2811

3554

2812

# Delete all clients, and settings from config

3555

2813

while tcp_server.clients:

3556

2814

name, client = tcp_server.clients.popitem()

3557

2815

if use_dbus:

3558

2816

client.remove_from_connection()

3559

# Don't signal the disabling

2817

# Don't signal anything except ClientRemoved

3560

2818

client.disable(quiet=True)

3561

# Emit D-Bus signal for removal

3562

2819

if use_dbus:

3563

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)

3564

2824

client_settings.clear()

3565

2825

3566

2826

atexit.register(cleanup)

3567

3568

for client in tcp_server.clients.values():

2827

2828

for client in tcp_server.clients.itervalues():

3569

2829

if use_dbus:

3570

# Emit D-Bus signal for adding

3571

mandos_dbus_service.client_added_signal(client)

2830

# Emit D-Bus signal

2831

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3572

2832

# Need to initiate checking of clients

3573

2833

if client.enabled:

3574

2834

client.init_checker()

3575

2835

3576

2836

tcp_server.enable()

3577

2837

tcp_server.server_activate()

3578

2838

3579

2839

# Find out what port we got

3580

2840

if zeroconf:

3581

2841

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

3586

2846

else: # IPv4

3587

2847

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

3588

2848

*tcp_server.socket.getsockname())

3589

3590

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

3591

2849

2850

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

2851

3592

2852

try:

3593

2853

if zeroconf:

3594

2854

# From the Avahi example code

3599

2859

cleanup()

3600

2860

sys.exit(1)

3601

2861

# End of Avahi example code

3602

3603

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

3604

lambda *args, **kwargs:

3605

(tcp_server.handle_request

3606

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

3607

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

3608

2868

logger.debug("Starting main loop")

3609

2869

main_loop.run()

3610

2870

except AvahiError as error:

3619

2879

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

3620

2880

cleanup()

3621

2881

3622

3623

2882

if __name__ == '__main__':

3624

2883

main()