/mandos/trunk : revision 723.1.5

1

#!/usr/bin/python3 -bI

2

# -*- mode: python; after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-

3

#

1

#!/usr/bin/python2.7

2

# -*- mode: python; coding: utf-8 -*-

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

import unittest

81

import random

82

import shlex

83

72

84

73

import dbus

85

74

import dbus.service

86

import gi

87

from gi.repository import GLib

75

import gobject

76

import avahi

88

77

from dbus.mainloop.glib import DBusGMainLoop

89

78

import ctypes

90

79

import ctypes.util

91

80

import xml.dom.minidom

92

81

import inspect

93

82

94

if sys.version_info.major == 2:

95

__metaclass__ = type

96

str = unicode

97

98

# Add collections.abc.Callable if it does not exist

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

83

try:

122

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

85

except AttributeError:

124

86

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

87

from IN import SO_BINDTODEVICE

128

88

except ImportError:

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.11"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.7"

147

92

stored_state_file = "clients.pickle"

148

93

149

94

logger = logging.getLogger()

150

logging.captureWarnings(True) # Show warnings via the logging system

151

95

syslogger = None

152

96

153

97

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

156

101

except (OSError, AttributeError):

157

158

102

def if_nametoindex(interface):

159

103

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

160

104

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

161

105

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

162

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

163

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

164

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

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

165

111

return interface_index

166

112

167

113

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

184

114

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

185

115

"""init logger and add loglevel"""

186

116

187

117

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

191

122

syslogger.setFormatter(logging.Formatter

192

123

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

193

124

' %(message)s'))

194

125

logger.addHandler(syslogger)

195

126

196

127

if debug:

197

128

console = logging.StreamHandler()

198

129

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

208

139

pass

209

140

210

141

211

class PGPEngine:

142

class PGPEngine(object):

212

143

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

213

214

144

def __init__(self):

215

145

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

146

self.gnupgargs = ['--batch',

228

'--homedir', self.tempdir,

147

'--home', self.tempdir,

229

148

'--force-mdc',

230

'--quiet']

231

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

232

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

233

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

234

149

'--quiet',

150

'--no-use-agent']

151

235

152

def __enter__(self):

236

153

return self

237

154

238

155

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

239

156

self._cleanup()

240

157

return False

241

158

242

159

def __del__(self):

243

160

self._cleanup()

244

161

245

162

def _cleanup(self):

246

163

if self.tempdir is not None:

247

164

# Delete contents of tempdir

248

165

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

249

topdown=False):

166

topdown = False):

250

167

for filename in files:

251

168

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

252

169

for dirname in dirs:

254

171

# Remove tempdir

255

172

os.rmdir(self.tempdir)

256

173

self.tempdir = None

257

174

258

175

def password_encode(self, password):

259

176

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

260

177

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

265

182

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

266

183

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

267

184

return encoded

268

185

269

186

def encrypt(self, data, password):

270

187

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

273

190

passfile.write(passphrase)

274

191

passfile.flush()

275

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

192

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

276

193

'--passphrase-file',

277

194

passfile.name]

278

195

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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

283

200

if proc.returncode != 0:

284

201

raise PGPError(err)

285

202

return ciphertext

286

203

287

204

def decrypt(self, data, password):

288

205

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

291

208

passfile.write(passphrase)

292

209

passfile.flush()

293

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

210

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

294

211

'--passphrase-file',

295

212

passfile.name]

296

213

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

301

219

if proc.returncode != 0:

302

220

raise PGPError(err)

303

221

return decrypted_plaintext

304

222

305

223

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

332

224

class AvahiError(Exception):

333

225

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

334

226

self.value = value

335

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

336

**kwargs)

337

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

338

230

339

231

class AvahiServiceError(AvahiError):

340

232

pass

341

233

342

343

234

class AvahiGroupError(AvahiError):

344

235

pass

345

236

346

237

347

class AvahiService:

238

class AvahiService(object):

348

239

"""An Avahi (Zeroconf) service.

349

240

350

241

Attributes:

351

242

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

352

243

Used to optionally bind to the specified interface.

364

255

server: D-Bus Server

365

256

bus: dbus.SystemBus()

366

257

"""

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

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

379

263

self.interface = interface

380

264

self.name = name

381

265

self.type = servicetype

390

274

self.server = None

391

275

self.bus = bus

392

276

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

277

278

def rename(self):

395

279

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

396

280

if self.rename_count >= self.max_renames:

397

281

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

398

282

" after %i retries, exiting.",

399

283

self.rename_count)

400

284

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

404

287

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

405

288

self.name)

406

if remove:

407

self.remove()

289

self.remove()

408

290

try:

409

291

self.add()

410

292

except dbus.exceptions.DBusException as error:

411

if (error.get_dbus_name()

412

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

413

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

414

return self.rename(remove=False)

415

else:

416

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

417

self.cleanup()

418

os._exit(1)

419

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

420

298

def remove(self):

421

299

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

422

300

if self.entry_group_state_changed_match is not None:

424

302

self.entry_group_state_changed_match = None

425

303

if self.group is not None:

426

304

self.group.Reset()

427

305

428

306

def add(self):

429

307

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

430

308

self.remove()

447

325

dbus.UInt16(self.port),

448

326

avahi.string_array_to_txt_array(self.TXT))

449

327

self.group.Commit()

450

328

451

329

def entry_group_state_changed(self, state, error):

452

330

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

453

331

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

454

332

455

333

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

334

logger.debug("Zeroconf service established.")

457

335

elif state == avahi.ENTRY_GROUP_COLLISION:

459

337

self.rename()

460

338

elif state == avahi.ENTRY_GROUP_FAILURE:

461

339

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

462

str(error))

463

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

464

340

unicode(error))

341

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

342

.format(error))

343

465

344

def cleanup(self):

466

345

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

467

346

if self.group is not None:

472

351

pass

473

352

self.group = None

474

353

self.remove()

475

354

476

355

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

477

356

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

478

357

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

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

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

485

365

if state in bad_states:

486

366

if bad_states[state] is not None:

487

367

if error is None:

490

370

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

491

371

self.cleanup()

492

372

elif state == avahi.SERVER_RUNNING:

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

logger.info("Local Zeroconf service name"

499

" collision.")

500

return self.rename(remove=False)

501

else:

502

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

503

self.cleanup()

504

os._exit(1)

373

self.add()

505

374

else:

506

375

if error is None:

507

376

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

508

377

else:

509

378

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

510

379

511

380

def activate(self):

512

381

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

513

382

if self.server is None:

517

386

follow_name_owner_changes=True),

518

387

avahi.DBUS_INTERFACE_SERVER)

519

388

self.server.connect_to_signal("StateChanged",

520

self.server_state_changed)

389

self.server_state_changed)

521

390

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

522

391

523

392

524

393

class AvahiServiceToSyslog(AvahiService):

525

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

394

def rename(self):

526

395

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

527

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

528

syslogger.setFormatter(logging.Formatter(

529

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

530

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

531

401

return ret

532

402

533

403

534

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

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

539

if library is None:

540

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

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

544

# Unless otherwise indicated, the constants and types below are

545

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

546

547

# Constants

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

CLIENT = 2

554

SHUT_RDWR = 0

555

CRD_CERTIFICATE = 1

556

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

564

# Types

565

class session_int(ctypes.Structure):

566

_fields_ = []

567

session_t = ctypes.POINTER(session_int)

568

569

class certificate_credentials_st(ctypes.Structure):

570

_fields_ = []

571

certificate_credentials_t = ctypes.POINTER(

572

certificate_credentials_st)

573

certificate_type_t = ctypes.c_int

574

575

class datum_t(ctypes.Structure):

576

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

577

('size', ctypes.c_uint)]

578

579

class openpgp_crt_int(ctypes.Structure):

580

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

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

584

credentials_type_t = ctypes.c_int

585

transport_ptr_t = ctypes.c_void_p

586

close_request_t = ctypes.c_int

587

588

# Exceptions

589

class Error(Exception):

590

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

591

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

592

# code is passed, convert it to a string with

593

# gnutls.strerror()

594

self.code = code

595

if message is None and code is not None:

596

message = gnutls.strerror(code)

597

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

598

message, *args)

599

600

class CertificateSecurityError(Error):

601

pass

602

603

# Classes

604

class Credentials:

605

def __init__(self):

606

self._c_object = gnutls.certificate_credentials_t()

607

gnutls.certificate_allocate_credentials(

608

ctypes.byref(self._c_object))

609

self.type = gnutls.CRD_CERTIFICATE

610

611

def __del__(self):

612

gnutls.certificate_free_credentials(self._c_object)

613

614

class ClientSession:

615

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

616

self._c_object = gnutls.session_t()

617

gnutls_flags = gnutls.CLIENT

618

if gnutls.check_version(b"3.5.6"):

619

gnutls_flags |= gnutls.NO_TICKETS

620

if gnutls.has_rawpk:

621

gnutls_flags |= gnutls.ENABLE_RAWPK

622

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

623

del gnutls_flags

624

gnutls.set_default_priority(self._c_object)

625

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

626

gnutls.handshake_set_private_extensions(self._c_object,

627

True)

628

self.socket = socket

629

if credentials is None:

630

credentials = gnutls.Credentials()

631

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

632

ctypes.cast(credentials._c_object,

633

ctypes.c_void_p))

634

self.credentials = credentials

635

636

def __del__(self):

637

gnutls.deinit(self._c_object)

638

639

def handshake(self):

640

return gnutls.handshake(self._c_object)

641

642

def send(self, data):

643

data = bytes(data)

644

data_len = len(data)

645

while data_len > 0:

646

data_len -= gnutls.record_send(self._c_object,

647

data[-data_len:],

648

data_len)

649

650

def bye(self):

651

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

652

653

# Error handling functions

654

def _error_code(result):

655

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

656

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

657

if result >= 0:

658

return result

659

if result == gnutls.E_NO_CERTIFICATE_FOUND:

660

raise gnutls.CertificateSecurityError(code=result)

661

raise gnutls.Error(code=result)

662

663

def _retry_on_error(result, func, arguments):

664

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

665

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

666

while result < 0:

667

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

668

return _error_code(result)

669

result = func(*arguments)

670

return result

671

672

# Unless otherwise indicated, the function declarations below are

673

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

674

675

# Functions

676

priority_set_direct = _library.gnutls_priority_set_direct

677

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

678

ctypes.POINTER(ctypes.c_char_p)]

679

priority_set_direct.restype = _error_code

680

681

init = _library.gnutls_init

682

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

683

init.restype = _error_code

684

685

set_default_priority = _library.gnutls_set_default_priority

686

set_default_priority.argtypes = [session_t]

687

set_default_priority.restype = _error_code

688

689

record_send = _library.gnutls_record_send

690

record_send.argtypes = [session_t, ctypes.c_void_p,

691

ctypes.c_size_t]

692

record_send.restype = ctypes.c_ssize_t

693

record_send.errcheck = _retry_on_error

694

695

certificate_allocate_credentials = (

696

_library.gnutls_certificate_allocate_credentials)

697

certificate_allocate_credentials.argtypes = [

698

ctypes.POINTER(certificate_credentials_t)]

699

certificate_allocate_credentials.restype = _error_code

700

701

certificate_free_credentials = (

702

_library.gnutls_certificate_free_credentials)

703

certificate_free_credentials.argtypes = [

704

certificate_credentials_t]

705

certificate_free_credentials.restype = None

706

707

handshake_set_private_extensions = (

708

_library.gnutls_handshake_set_private_extensions)

709

handshake_set_private_extensions.argtypes = [session_t,

710

ctypes.c_int]

711

handshake_set_private_extensions.restype = None

712

713

credentials_set = _library.gnutls_credentials_set

714

credentials_set.argtypes = [session_t, credentials_type_t,

715

ctypes.c_void_p]

716

credentials_set.restype = _error_code

717

718

strerror = _library.gnutls_strerror

719

strerror.argtypes = [ctypes.c_int]

720

strerror.restype = ctypes.c_char_p

721

722

certificate_type_get = _library.gnutls_certificate_type_get

723

certificate_type_get.argtypes = [session_t]

724

certificate_type_get.restype = _error_code

725

726

certificate_get_peers = _library.gnutls_certificate_get_peers

727

certificate_get_peers.argtypes = [session_t,

728

ctypes.POINTER(ctypes.c_uint)]

729

certificate_get_peers.restype = ctypes.POINTER(datum_t)

730

731

global_set_log_level = _library.gnutls_global_set_log_level

732

global_set_log_level.argtypes = [ctypes.c_int]

733

global_set_log_level.restype = None

734

735

global_set_log_function = _library.gnutls_global_set_log_function

736

global_set_log_function.argtypes = [log_func]

737

global_set_log_function.restype = None

738

739

deinit = _library.gnutls_deinit

740

deinit.argtypes = [session_t]

741

deinit.restype = None

742

743

handshake = _library.gnutls_handshake

744

handshake.argtypes = [session_t]

745

handshake.restype = _error_code

746

handshake.errcheck = _retry_on_error

747

748

transport_set_ptr = _library.gnutls_transport_set_ptr

749

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

750

transport_set_ptr.restype = None

751

752

bye = _library.gnutls_bye

753

bye.argtypes = [session_t, close_request_t]

754

bye.restype = _error_code

755

bye.errcheck = _retry_on_error

756

757

check_version = _library.gnutls_check_version

758

check_version.argtypes = [ctypes.c_char_p]

759

check_version.restype = ctypes.c_char_p

760

761

_need_version = b"3.3.0"

762

if check_version(_need_version) is None:

763

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

764

.format(_need_version))

765

766

_tls_rawpk_version = b"3.6.6"

767

has_rawpk = bool(check_version(_tls_rawpk_version))

768

769

if has_rawpk:

770

# Types

771

class pubkey_st(ctypes.Structure):

772

_fields = []

773

pubkey_t = ctypes.POINTER(pubkey_st)

774

775

x509_crt_fmt_t = ctypes.c_int

776

777

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

778

pubkey_init = _library.gnutls_pubkey_init

779

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

780

pubkey_init.restype = _error_code

781

782

pubkey_import = _library.gnutls_pubkey_import

783

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

784

x509_crt_fmt_t]

785

pubkey_import.restype = _error_code

786

787

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

788

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

789

ctypes.POINTER(ctypes.c_ubyte),

790

ctypes.POINTER(ctypes.c_size_t)]

791

pubkey_get_key_id.restype = _error_code

792

793

pubkey_deinit = _library.gnutls_pubkey_deinit

794

pubkey_deinit.argtypes = [pubkey_t]

795

pubkey_deinit.restype = None

796

else:

797

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

798

799

openpgp_crt_init = _library.gnutls_openpgp_crt_init

800

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

801

openpgp_crt_init.restype = _error_code

802

803

openpgp_crt_import = _library.gnutls_openpgp_crt_import

804

openpgp_crt_import.argtypes = [openpgp_crt_t,

805

ctypes.POINTER(datum_t),

806

openpgp_crt_fmt_t]

807

openpgp_crt_import.restype = _error_code

808

809

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

810

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

811

ctypes.POINTER(ctypes.c_uint)]

812

openpgp_crt_verify_self.restype = _error_code

813

814

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

815

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

816

openpgp_crt_deinit.restype = None

817

818

openpgp_crt_get_fingerprint = (

819

_library.gnutls_openpgp_crt_get_fingerprint)

820

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

821

ctypes.c_void_p,

822

ctypes.POINTER(

823

ctypes.c_size_t)]

824

openpgp_crt_get_fingerprint.restype = _error_code

825

826

if check_version(b"3.6.4"):

827

certificate_type_get2 = _library.gnutls_certificate_type_get2

828

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

829

certificate_type_get2.restype = _error_code

830

831

# Remove non-public functions

832

del _error_code, _retry_on_error

833

834

835

def call_pipe(connection, # : multiprocessing.Connection

836

func, *args, **kwargs):

837

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

838

839

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

840

return value on the provided multiprocessing.Connection.

841

"""

842

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

843

connection.close()

844

845

846

class Client:

404

def timedelta_to_milliseconds(td):

405

"Convert a datetime.timedelta() to milliseconds"

406

return ((td.days * 24 * 60 * 60 * 1000)

407

+ (td.seconds * 1000)

408

+ (td.microseconds // 1000))

409

410

411

class Client(object):

847

412

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

848

413

849

414

Attributes:

850

415

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

851

416

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

852

417

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

853

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

854

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

855

running.

856

checker_callback_tag: a GLib event source tag, or None

418

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

419

to see if the client lives.

420

'None' if no process is running.

421

checker_callback_tag: a gobject event source tag, or None

857

422

checker_command: string; External command which is run to check

858

423

if client lives. %() expansions are done at

859

424

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

860

425

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

861

checker_initiator_tag: a GLib event source tag, or None

426

checker_initiator_tag: a gobject event source tag, or None

862

427

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

863

428

client_structure: Object describing what attributes a client has

864

429

and is used for storing the client at exit

865

430

current_checker_command: string; current running checker_command

866

disable_initiator_tag: a GLib event source tag, or None

431

disable_initiator_tag: a gobject event source tag, or None

867

432

enabled: bool()

868

433

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

869

uniquely identify an OpenPGP client

870

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

871

a client using raw public keys

434

uniquely identify the client

872

435

host: string; available for use by the checker command

873

436

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

874

437

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

876

439

last_checker_status: integer between 0 and 255 reflecting exit

877

440

status of last checker. -1 reflects crashed

878

441

checker, -2 means no checker completed yet.

879

last_checker_signal: The signal which killed the last checker, if

880

last_checker_status is -1

881

442

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

882

443

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

883

444

D-Bus identifiers

890

451

disabled, or None

891

452

server_settings: The server_settings dict from main()

892

453

"""

893

454

894

455

runtime_expansions = ("approval_delay", "approval_duration",

895

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

456

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

896

457

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

897

458

"last_approval_request", "last_checked_ok",

898

459

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

899

client_defaults = {

900

"timeout": "PT5M",

901

"extended_timeout": "PT15M",

902

"interval": "PT2M",

903

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

904

"host": "",

905

"approval_delay": "PT0S",

906

"approval_duration": "PT1S",

907

"approved_by_default": "True",

908

"enabled": "True",

909

}

910

460

client_defaults = { "timeout": "PT5M",

461

"extended_timeout": "PT15M",

462

"interval": "PT2M",

463

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

464

"host": "",

465

"approval_delay": "PT0S",

466

"approval_duration": "PT1S",

467

"approved_by_default": "True",

468

"enabled": "True",

469

}

470

471

def timeout_milliseconds(self):

472

"Return the 'timeout' attribute in milliseconds"

473

return timedelta_to_milliseconds(self.timeout)

474

475

def extended_timeout_milliseconds(self):

476

"Return the 'extended_timeout' attribute in milliseconds"

477

return timedelta_to_milliseconds(self.extended_timeout)

478

479

def interval_milliseconds(self):

480

"Return the 'interval' attribute in milliseconds"

481

return timedelta_to_milliseconds(self.interval)

482

483

def approval_delay_milliseconds(self):

484

return timedelta_to_milliseconds(self.approval_delay)

485

911

486

@staticmethod

912

487

def config_parser(config):

913

488

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

920

495

for client_name in config.sections():

921

496

section = dict(config.items(client_name))

922

497

client = settings[client_name] = {}

923

498

924

499

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

925

500

# Reformat values from string types to Python types

926

501

client["approved_by_default"] = config.getboolean(

927

502

client_name, "approved_by_default")

928

503

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

929

504

"enabled")

930

931

# Uppercase and remove spaces from key_id and fingerprint

932

# for later comparison purposes with return value from the

933

# key_id() and fingerprint() functions

934

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

935

.replace(" ", ""))

505

936

506

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

937

507

.replace(" ", ""))

938

508

if "secret" in section:

939

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

940

.encode("utf-8"),

941

"base64")

509

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

942

510

elif "secfile" in section:

943

511

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

944

512

(section["secfile"])),

959

527

client["last_approval_request"] = None

960

528

client["last_checked_ok"] = None

961

529

client["last_checker_status"] = -2

962

530

963

531

return settings

964

965

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

532

533

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

966

534

self.name = name

967

535

if server_settings is None:

968

536

server_settings = {}

970

538

# adding all client settings

971

539

for setting, value in settings.items():

972

540

setattr(self, setting, value)

973

541

974

542

if self.enabled:

975

543

if not hasattr(self, "last_enabled"):

976

544

self.last_enabled = datetime.datetime.utcnow()

980

548

else:

981

549

self.last_enabled = None

982

550

self.expires = None

983

551

984

552

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

985

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

553

# Uppercase and remove spaces from fingerprint for later

554

# comparison purposes with return value from the fingerprint()

555

# function

986

556

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

987

557

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

988

558

datetime.datetime.utcnow())

989

559

990

560

# attributes specific for this server instance

991

561

self.checker = None

992

562

self.checker_initiator_tag = None

995

565

self.current_checker_command = None

996

566

self.approved = None

997

567

self.approvals_pending = 0

998

self.changedstate = multiprocessing_manager.Condition(

999

multiprocessing_manager.Lock())

1000

self.client_structure = [attr

1001

for attr in self.__dict__.keys()

568

self.changedstate = (multiprocessing_manager

569

.Condition(multiprocessing_manager

570

.Lock()))

571

self.client_structure = [attr for attr in

572

self.__dict__.iterkeys()

1002

573

if not attr.startswith("_")]

1003

574

self.client_structure.append("client_structure")

1004

1005

for name, t in inspect.getmembers(

1006

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

575

576

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

577

lambda obj:

578

isinstance(obj,

579

property)):

1007

580

if not name.startswith("_"):

1008

581

self.client_structure.append(name)

1009

582

1010

583

# Send notice to process children that client state has changed

1011

584

def send_changedstate(self):

1012

585

with self.changedstate:

1013

586

self.changedstate.notify_all()

1014

587

1015

588

def enable(self):

1016

589

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

1017

590

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

1022

595

self.last_enabled = datetime.datetime.utcnow()

1023

596

self.init_checker()

1024

597

self.send_changedstate()

1025

598

1026

599

def disable(self, quiet=True):

1027

600

"""Disable this client."""

1028

601

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

1030

603

if not quiet:

1031

604

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

1032

605

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

1033

GLib.source_remove(self.disable_initiator_tag)

606

gobject.source_remove(self.disable_initiator_tag)

1034

607

self.disable_initiator_tag = None

1035

608

self.expires = None

1036

609

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

1037

GLib.source_remove(self.checker_initiator_tag)

610

gobject.source_remove(self.checker_initiator_tag)

1038

611

self.checker_initiator_tag = None

1039

612

self.stop_checker()

1040

613

self.enabled = False

1041

614

if not quiet:

1042

615

self.send_changedstate()

1043

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

616

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

1044

617

return False

1045

618

1046

619

def __del__(self):

1047

620

self.disable()

1048

621

1049

622

def init_checker(self):

1050

623

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

1051

624

# and every interval from then on.

1052

625

if self.checker_initiator_tag is not None:

1053

GLib.source_remove(self.checker_initiator_tag)

1054

self.checker_initiator_tag = GLib.timeout_add(

1055

random.randrange(int(self.interval.total_seconds() * 1000

1056

+ 1)),

1057

self.start_checker)

626

gobject.source_remove(self.checker_initiator_tag)

627

self.checker_initiator_tag = (gobject.timeout_add

628

(self.interval_milliseconds(),

629

self.start_checker))

1058

630

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

1059

631

if self.disable_initiator_tag is not None:

1060

GLib.source_remove(self.disable_initiator_tag)

1061

self.disable_initiator_tag = GLib.timeout_add(

1062

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

632

gobject.source_remove(self.disable_initiator_tag)

633

self.disable_initiator_tag = (gobject.timeout_add

634

(self.timeout_milliseconds(),

635

self.disable))

1063

636

# Also start a new checker *right now*.

1064

637

self.start_checker()

1065

1066

def checker_callback(self, source, condition, connection,

1067

command):

638

639

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

1068

640

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

1069

# Read return code from connection (see call_pipe)

1070

returncode = connection.recv()

1071

connection.close()

1072

if self.checker is not None:

1073

self.checker.join()

1074

641

self.checker_callback_tag = None

1075

642

self.checker = None

1076

1077

if returncode >= 0:

1078

self.last_checker_status = returncode

1079

self.last_checker_signal = None

643

if os.WIFEXITED(condition):

644

self.last_checker_status = os.WEXITSTATUS(condition)

1080

645

if self.last_checker_status == 0:

1081

646

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

1082

647

vars(self))

1083

648

self.checked_ok()

1084

649

else:

1085

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

650

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

651

vars(self))

1086

652

else:

1087

653

self.last_checker_status = -1

1088

self.last_checker_signal = -returncode

1089

654

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

1090

655

vars(self))

1091

return False

1092

656

1093

657

def checked_ok(self):

1094

658

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

1095

659

self.last_checked_ok = datetime.datetime.utcnow()

1096

660

self.last_checker_status = 0

1097

self.last_checker_signal = None

1098

661

self.bump_timeout()

1099

662

1100

663

def bump_timeout(self, timeout=None):

1101

664

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

1102

665

if timeout is None:

1103

666

timeout = self.timeout

1104

667

if self.disable_initiator_tag is not None:

1105

GLib.source_remove(self.disable_initiator_tag)

668

gobject.source_remove(self.disable_initiator_tag)

1106

669

self.disable_initiator_tag = None

1107

670

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

1108

self.disable_initiator_tag = GLib.timeout_add(

1109

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

671

self.disable_initiator_tag = (gobject.timeout_add

672

(timedelta_to_milliseconds

673

(timeout), self.disable))

1110

674

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

1111

675

1112

676

def need_approval(self):

1113

677

self.last_approval_request = datetime.datetime.utcnow()

1114

678

1115

679

def start_checker(self):

1116

680

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

1117

681

1118

682

If a checker already exists, leave it running and do

1119

683

nothing."""

1120

684

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

1125

689

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

1126

690

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

1127

691

# should be.

1128

1129

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

1130

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

1131

self.checker.join()

1132

self.checker = None

692

693

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

694

try:

695

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

696

except AttributeError:

697

pass

698

except OSError as error:

699

if error.errno != errno.ECHILD:

700

raise

701

else:

702

if pid:

703

logger.warning("Checker was a zombie")

704

gobject.source_remove(self.checker_callback_tag)

705

self.checker_callback(pid, status,

706

self.current_checker_command)

1133

707

# Start a new checker if needed

1134

708

if self.checker is None:

1135

709

# Escape attributes for the shell

1136

escaped_attrs = {

1137

attr: shlex.quote(str(getattr(self, attr)))

1138

for attr in self.runtime_expansions}

710

escaped_attrs = { attr:

711

re.escape(unicode(getattr(self,

712

attr)))

713

for attr in self.runtime_expansions }

1139

714

try:

1140

715

command = self.checker_command % escaped_attrs

1141

716

except TypeError as error:

1142

717

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

1143

self.checker_command,

718

self.checker_command, exc_info=error)

719

return True # Try again later

720

self.current_checker_command = command

721

try:

722

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

723

command, self.name)

724

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

725

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

726

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

727

# always replaced by /dev/null.)

728

# The exception is when not debugging but nevertheless

729

# running in the foreground; use the previously

730

# created wnull.

731

popen_args = {}

732

if (not self.server_settings["debug"]

733

and self.server_settings["foreground"]):

734

popen_args.update({"stdout": wnull,

735

"stderr": wnull })

736

self.checker = subprocess.Popen(command,

737

close_fds=True,

738

shell=True, cwd="/",

739

**popen_args)

740

except OSError as error:

741

logger.error("Failed to start subprocess",

1144

742

exc_info=error)

1145

return True # Try again later

1146

self.current_checker_command = command

1147

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

1148

self.name)

1149

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

1150

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

1151

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

1152

# always replaced by /dev/null.)

1153

# The exception is when not debugging but nevertheless

1154

# running in the foreground; use the previously

1155

# created wnull.

1156

popen_args = {"close_fds": True,

1157

"shell": True,

1158

"cwd": "/"}

1159

if (not self.server_settings["debug"]

1160

and self.server_settings["foreground"]):

1161

popen_args.update({"stdout": wnull,

1162

"stderr": wnull})

1163

pipe = multiprocessing.Pipe(duplex=False)

1164

self.checker = multiprocessing.Process(

1165

target=call_pipe,

1166

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

1167

kwargs=popen_args)

1168

self.checker.start()

1169

self.checker_callback_tag = GLib.io_add_watch(

1170

GLib.IOChannel.unix_new(pipe[0].fileno()),

1171

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1172

self.checker_callback, pipe[0], command)

1173

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

743

return True

744

self.checker_callback_tag = (gobject.child_watch_add

745

(self.checker.pid,

746

self.checker_callback,

747

data=command))

748

# The checker may have completed before the gobject

749

# watch was added. Check for this.

750

try:

751

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

752

except OSError as error:

753

if error.errno == errno.ECHILD:

754

# This should never happen

755

logger.error("Child process vanished",

756

exc_info=error)

757

return True

758

raise

759

if pid:

760

gobject.source_remove(self.checker_callback_tag)

761

self.checker_callback(pid, status, command)

762

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

1174

763

return True

1175

764

1176

765

def stop_checker(self):

1177

766

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

1178

767

if self.checker_callback_tag:

1179

GLib.source_remove(self.checker_callback_tag)

768

gobject.source_remove(self.checker_callback_tag)

1180

769

self.checker_callback_tag = None

1181

770

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

1182

771

return

1183

772

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

1184

self.checker.terminate()

773

try:

774

self.checker.terminate()

775

#time.sleep(0.5)

776

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

777

# self.checker.kill()

778

except OSError as error:

779

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

780

raise

1185

781

self.checker = None

1186

782

1187

783

1188

def dbus_service_property(dbus_interface,

1189

signature="v",

1190

access="readwrite",

1191

byte_arrays=False):

784

def dbus_service_property(dbus_interface, signature="v",

785

access="readwrite", byte_arrays=False):

1192

786

"""Decorators for marking methods of a DBusObjectWithProperties to

1193

787

become properties on the D-Bus.

1194

788

1195

789

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

1196

790

and with one argument by "Set".

1197

791

1198

792

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

1199

793

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

1200

794

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

1204

798

if byte_arrays and signature != "ay":

1205

799

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

1206

800

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

1207

1208

801

def decorator(func):

1209

802

func._dbus_is_property = True

1210

803

func._dbus_interface = dbus_interface

1213

806

func._dbus_name = func.__name__

1214

807

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

1215

808

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

1216

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

809

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1217

810

return func

1218

1219

811

return decorator

1220

812

1221

813

1222

814

def dbus_interface_annotations(dbus_interface):

1223

815

"""Decorator for marking functions returning interface annotations

1224

816

1225

817

Usage:

1226

818

1227

819

@dbus_interface_annotations("org.example.Interface")

1228

820

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

1229

821

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

1230

822

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

1231

823

"false"}

1232

824

"""

1233

1234

825

def decorator(func):

1235

826

func._dbus_is_interface = True

1236

827

func._dbus_interface = dbus_interface

1237

828

func._dbus_name = dbus_interface

1238

829

return func

1239

1240

830

return decorator

1241

831

1242

832

1243

833

def dbus_annotations(annotations):

1244

834

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

1245

835

Usage:

1246

1247

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

1248

"org.freedesktop.DBus.Property."

1249

"EmitsChangedSignal": "false"})

836

1250

837

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

1251

838

access="r")

839

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

840

"org.freedesktop.DBus.Property."

841

"EmitsChangedSignal": "false"})

1252

842

def Property_dbus_property(self):

1253

843

return dbus.Boolean(False)

1254

1255

See also the DBusObjectWithAnnotations class.

1256

844

"""

1257

1258

845

def decorator(func):

1259

846

func._dbus_annotations = annotations

1260

847

return func

1261

1262

848

return decorator

1263

849

1264

850

1265

851

class DBusPropertyException(dbus.exceptions.DBusException):

1266

852

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

1267

853

"""

1268

pass

854

def __unicode__(self):

855

return unicode(str(self))

1269

856

1270

857

1271

858

class DBusPropertyAccessException(DBusPropertyException):

1280

867

pass

1281

868

1282

869

1283

class DBusObjectWithAnnotations(dbus.service.Object):

1284

"""A D-Bus object with annotations.

1285

1286

Classes inheriting from this can use the dbus_annotations

1287

decorator to add annotations to methods or signals.

870

class DBusObjectWithProperties(dbus.service.Object):

871

"""A D-Bus object with properties.

872

873

Classes inheriting from this can use the dbus_service_property

874

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

875

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

1288

876

"""

1289

877

1290

878

@staticmethod

1291

879

def _is_dbus_thing(thing):

1292

880

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

1293

881

1294

882

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

1295

883

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

1296

884

"""

1297

885

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

1298

886

False)

1299

887

1300

888

def _get_all_dbus_things(self, thing):

1301

889

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

1302

890

"""

1303

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

891

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

892

name),

1304

893

athing.__get__(self))

1305

894

for cls in self.__class__.__mro__

1306

895

for name, athing in

1307

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

1308

1309

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1310

out_signature="s",

1311

path_keyword='object_path',

1312

connection_keyword='connection')

1313

def Introspect(self, object_path, connection):

1314

"""Overloading of standard D-Bus method.

1315

1316

Inserts annotation tags on methods and signals.

1317

"""

1318

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

1319

connection)

1320

try:

1321

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

1322

1323

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

1324

# Add annotation tags

1325

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

1326

for tag in if_tag.getElementsByTagName(typ):

1327

annots = dict()

1328

for name, prop in (self.

1329

_get_all_dbus_things(typ)):

1330

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

1331

and prop._dbus_interface

1332

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

1333

annots.update(getattr(

1334

prop, "_dbus_annotations", {}))

1335

for name, value in annots.items():

1336

ann_tag = document.createElement(

1337

"annotation")

1338

ann_tag.setAttribute("name", name)

1339

ann_tag.setAttribute("value", value)

1340

tag.appendChild(ann_tag)

1341

# Add interface annotation tags

1342

for annotation, value in dict(

1343

itertools.chain.from_iterable(

1344

annotations().items()

1345

for name, annotations

1346

in self._get_all_dbus_things("interface")

1347

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

1348

)).items():

1349

ann_tag = document.createElement("annotation")

1350

ann_tag.setAttribute("name", annotation)

1351

ann_tag.setAttribute("value", value)

1352

if_tag.appendChild(ann_tag)

1353

# Fix argument name for the Introspect method itself

1354

if (if_tag.getAttribute("name")

1355

== dbus.INTROSPECTABLE_IFACE):

1356

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

1357

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

1358

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

1359

if (arg.getAttribute("direction")

1360

== "out"):

1361

arg.setAttribute("name",

1362

"xml_data")

1363

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

1364

document.unlink()

1365

except (AttributeError, xml.dom.DOMException,

1366

xml.parsers.expat.ExpatError) as error:

1367

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

1368

exc_info=error)

1369

return xmlstring

1370

1371

1372

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1373

"""A D-Bus object with properties.

1374

1375

Classes inheriting from this can use the dbus_service_property

1376

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

1377

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

1378

"""

1379

896

inspect.getmembers(cls,

897

self._is_dbus_thing(thing)))

898

1380

899

def _get_dbus_property(self, interface_name, property_name):

1381

900

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

1382

901

property with the specified name and interface.

1383

902

"""

1384

for cls in self.__class__.__mro__:

1385

for name, value in inspect.getmembers(

1386

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

903

for cls in self.__class__.__mro__:

904

for name, value in (inspect.getmembers

905

(cls,

906

self._is_dbus_thing("property"))):

1387

907

if (value._dbus_name == property_name

1388

908

and value._dbus_interface == interface_name):

1389

909

return value.__get__(self)

1390

910

1391

911

# No such property

1392

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

1393

self.dbus_object_path, interface_name, property_name))

1394

1395

@classmethod

1396

def _get_all_interface_names(cls):

1397

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

1398

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

1399

"_dbus_interface", None)

1400

for x in (inspect.getmro(cls))

1401

for attr in dir(x))

1402

if name is not None)

1403

1404

@dbus.service.method(dbus.PROPERTIES_IFACE,

1405

in_signature="ss",

912

raise DBusPropertyNotFound(self.dbus_object_path + ":"

913

+ interface_name + "."

914

+ property_name)

915

916

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

1406

917

out_signature="v")

1407

918

def Get(self, interface_name, property_name):

1408

919

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

1414

925

if not hasattr(value, "variant_level"):

1415

926

return value

1416

927

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

1417

928

1418

929

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

1419

930

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

1420

931

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

1429

940

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

1430

941

"'ay' signature {!r}"

1431

942

.format(prop._dbus_signature))

1432

value = dbus.ByteArray(bytes(value))

943

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

944

for byte in value))

1433

945

prop(value)

1434

1435

@dbus.service.method(dbus.PROPERTIES_IFACE,

1436

in_signature="s",

946

947

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

1437

948

out_signature="a{sv}")

1438

949

def GetAll(self, interface_name):

1439

950

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

1440

951

standard.

1441

952

1442

953

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

1443

954

"""

1444

955

properties = {}

1454

965

if not hasattr(value, "variant_level"):

1455

966

properties[name] = value

1456

967

continue

1457

properties[name] = type(value)(

1458

value, variant_level=value.variant_level + 1)

968

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

969

value.variant_level+1)

1459

970

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

1460

1461

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

1462

def PropertiesChanged(self, interface_name, changed_properties,

1463

invalidated_properties):

1464

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

1465

standard.

1466

"""

1467

pass

1468

971

1469

972

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1470

973

out_signature="s",

1471

974

path_keyword='object_path',

1472

975

connection_keyword='connection')

1473

976

def Introspect(self, object_path, connection):

1474

977

"""Overloading of standard D-Bus method.

1475

978

1476

979

Inserts property tags and interface annotation tags.

1477

980

"""

1478

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1479

object_path,

1480

connection)

981

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

982

connection)

1481

983

try:

1482

984

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

1483

1484

985

def make_tag(document, name, prop):

1485

986

e = document.createElement("property")

1486

987

e.setAttribute("name", name)

1487

988

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

1488

989

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

1489

990

return e

1490

1491

991

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

1492

992

# Add property tags

1493

993

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

1496

996

if prop._dbus_interface

1497

997

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

1498

998

if_tag.appendChild(tag)

1499

# Add annotation tags for properties

1500

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

1501

annots = dict()

1502

for name, prop in self._get_all_dbus_things(

1503

"property"):

1504

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

1505

and prop._dbus_interface

1506

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

1507

annots.update(getattr(

1508

prop, "_dbus_annotations", {}))

1509

for name, value in annots.items():

1510

ann_tag = document.createElement(

1511

"annotation")

1512

ann_tag.setAttribute("name", name)

1513

ann_tag.setAttribute("value", value)

1514

tag.appendChild(ann_tag)

999

# Add annotation tags

1000

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

1001

for tag in if_tag.getElementsByTagName(typ):

1002

annots = dict()

1003

for name, prop in (self.

1004

_get_all_dbus_things(typ)):

1005

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

1006

and prop._dbus_interface

1007

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

1008

annots.update(getattr

1009

(prop,

1010

"_dbus_annotations",

1011

{}))

1012

for name, value in annots.items():

1013

ann_tag = document.createElement(

1014

"annotation")

1015

ann_tag.setAttribute("name", name)

1016

ann_tag.setAttribute("value", value)

1017

tag.appendChild(ann_tag)

1018

# Add interface annotation tags

1019

for annotation, value in dict(

1020

itertools.chain.from_iterable(

1021

annotations().items()

1022

for name, annotations in

1023

self._get_all_dbus_things("interface")

1024

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

1025

)).items():

1026

ann_tag = document.createElement("annotation")

1027

ann_tag.setAttribute("name", annotation)

1028

ann_tag.setAttribute("value", value)

1029

if_tag.appendChild(ann_tag)

1515

1030

# Add the names to the return values for the

1516

1031

# "org.freedesktop.DBus.Properties" methods

1517

1032

if (if_tag.getAttribute("name")

1536

1051

return xmlstring

1537

1052

1538

1053

1539

try:

1540

dbus.OBJECT_MANAGER_IFACE

1541

except AttributeError:

1542

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

1543

1544

1545

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1546

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

1547

1548

Classes inheriting from this exposes the standard

1549

GetManagedObjects call and the InterfacesAdded and

1550

InterfacesRemoved signals on the standard

1551

"org.freedesktop.DBus.ObjectManager" interface.

1552

1553

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

1554

manually.

1555

"""

1556

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1557

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

1558

def GetManagedObjects(self):

1559

"""This function must be overridden"""

1560

raise NotImplementedError()

1561

1562

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1563

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

1564

def InterfacesAdded(self, object_path, interfaces_and_properties):

1565

pass

1566

1567

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

1568

def InterfacesRemoved(self, object_path, interfaces):

1569

pass

1570

1571

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1572

out_signature="s",

1573

path_keyword='object_path',

1574

connection_keyword='connection')

1575

def Introspect(self, object_path, connection):

1576

"""Overloading of standard D-Bus method.

1577

1578

Override return argument name of GetManagedObjects to be

1579

"objpath_interfaces_and_properties"

1580

"""

1581

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1582

object_path,

1583

connection)

1584

try:

1585

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

1586

1587

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

1588

# Fix argument name for the GetManagedObjects method

1589

if (if_tag.getAttribute("name")

1590

== dbus.OBJECT_MANAGER_IFACE):

1591

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

1592

if (cn.getAttribute("name")

1593

== "GetManagedObjects"):

1594

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

1595

if (arg.getAttribute("direction")

1596

== "out"):

1597

arg.setAttribute(

1598

"name",

1599

"objpath_interfaces"

1600

"_and_properties")

1601

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

1602

document.unlink()

1603

except (AttributeError, xml.dom.DOMException,

1604

xml.parsers.expat.ExpatError) as error:

1605

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

1606

exc_info=error)

1607

return xmlstring

1608

1609

1610

1054

def datetime_to_dbus(dt, variant_level=0):

1611

1055

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

1612

1056

if dt is None:

1613

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

1614

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

1057

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

1058

return dbus.String(dt.isoformat(),

1059

variant_level=variant_level)

1615

1060

1616

1061

1617

1062

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1619

1064

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

1620

1065

interface names according to the "alt_interface_names" mapping.

1621

1066

Usage:

1622

1067

1623

1068

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

1624

1069

"net.example.AlternateInterface"})

1625

1070

class SampleDBusObject(dbus.service.Object):

1626

1071

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

1627

1072

def SampleDBusMethod():

1628

1073

pass

1629

1074

1630

1075

The above "SampleDBusMethod" on "SampleDBusObject" will be

1631

1076

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

1632

1077

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

1633

1078

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

1634

1079

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

1635

1080

1636

1081

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

1637

1082

(from DBusObjectWithProperties) and interfaces (from the

1638

1083

dbus_interface_annotations decorator).

1639

1084

"""

1640

1641

1085

def wrapper(cls):

1642

1086

for orig_interface_name, alt_interface_name in (

1643

alt_interface_names.items()):

1087

alt_interface_names.items()):

1644

1088

attr = {}

1645

1089

interface_names = set()

1646

1090

# Go though all attributes of the class

1648

1092

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

1649

1093

# with the wrong interface name

1650

1094

if (not hasattr(attribute, "_dbus_interface")

1651

or not attribute._dbus_interface.startswith(

1652

orig_interface_name)):

1095

or not attribute._dbus_interface

1096

.startswith(orig_interface_name)):

1653

1097

continue

1654

1098

# Create an alternate D-Bus interface name based on

1655

1099

# the current name

1656

alt_interface = attribute._dbus_interface.replace(

1657

orig_interface_name, alt_interface_name)

1100

alt_interface = (attribute._dbus_interface

1101

.replace(orig_interface_name,

1102

alt_interface_name))

1658

1103

interface_names.add(alt_interface)

1659

1104

# Is this a D-Bus signal?

1660

1105

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

1661

1106

# Extract the original non-method undecorated

1662

1107

# function by black magic

1663

if sys.version_info.major == 2:

1664

nonmethod_func = (dict(

1108

nonmethod_func = (dict(

1665

1109

zip(attribute.func_code.co_freevars,

1666

attribute.__closure__))

1667

["func"].cell_contents)

1668

else:

1669

nonmethod_func = (dict(

1670

zip(attribute.__code__.co_freevars,

1671

attribute.__closure__))

1672

["func"].cell_contents)

1110

attribute.__closure__))["func"]

1111

.cell_contents)

1673

1112

# Create a new, but exactly alike, function

1674

1113

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

1675

1114

# with the alternate D-Bus interface name

1676

new_function = copy_function(nonmethod_func)

1677

new_function = (dbus.service.signal(

1678

alt_interface,

1679

attribute._dbus_signature)(new_function))

1115

new_function = (dbus.service.signal

1116

(alt_interface,

1117

attribute._dbus_signature)

1118

(types.FunctionType(

1119

nonmethod_func.func_code,

1120

nonmethod_func.func_globals,

1121

nonmethod_func.func_name,

1122

nonmethod_func.func_defaults,

1123

nonmethod_func.func_closure)))

1680

1124

# Copy annotations, if any

1681

1125

try:

1682

new_function._dbus_annotations = dict(

1683

attribute._dbus_annotations)

1126

new_function._dbus_annotations = (

1127

dict(attribute._dbus_annotations))

1684

1128

except AttributeError:

1685

1129

pass

1686

1687

1130

# Define a creator of a function to call both the

1688

1131

# original and alternate functions, so both the

1689

1132

# original and alternate signals gets sent when

1692

1135

"""This function is a scope container to pass

1693

1136

func1 and func2 to the "call_both" function

1694

1137

outside of its arguments"""

1695

1696

@functools.wraps(func2)

1697

1138

def call_both(*args, **kwargs):

1698

1139

"""This function will emit two D-Bus

1699

1140

signals by calling func1 and func2"""

1700

1141

func1(*args, **kwargs)

1701

1142

func2(*args, **kwargs)

1702

# Make wrapper function look like a D-Bus

1703

# signal

1704

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

1705

if name.startswith("_dbus_"):

1706

setattr(call_both, name, attr)

1707

1708

1143

return call_both

1709

1144

# Create the "call_both" function and add it to

1710

1145

# the class

1715

1150

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

1716

1151

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

1717

1152

# to the class.

1718

attr[attrname] = (

1719

dbus.service.method(

1720

alt_interface,

1721

attribute._dbus_in_signature,

1722

attribute._dbus_out_signature)

1723

(copy_function(attribute)))

1153

attr[attrname] = (dbus.service.method

1154

(alt_interface,

1155

attribute._dbus_in_signature,

1156

attribute._dbus_out_signature)

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1724

1163

# Copy annotations, if any

1725

1164

try:

1726

attr[attrname]._dbus_annotations = dict(

1727

attribute._dbus_annotations)

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1728

1167

except AttributeError:

1729

1168

pass

1730

1169

# Is this a D-Bus property?

1733

1172

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

1734

1173

# property with the alternate D-Bus interface

1735

1174

# name. Add it to the class.

1736

attr[attrname] = (dbus_service_property(

1737

alt_interface, attribute._dbus_signature,

1738

attribute._dbus_access,

1739

attribute._dbus_get_args_options

1740

["byte_arrays"])

1741

(copy_function(attribute)))

1175

attr[attrname] = (dbus_service_property

1176

(alt_interface,

1177

attribute._dbus_signature,

1178

attribute._dbus_access,

1179

attribute

1180

._dbus_get_args_options

1181

["byte_arrays"])

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

attribute.func_closure)))

1742

1188

# Copy annotations, if any

1743

1189

try:

1744

attr[attrname]._dbus_annotations = dict(

1745

attribute._dbus_annotations)

1190

attr[attrname]._dbus_annotations = (

1191

dict(attribute._dbus_annotations))

1746

1192

except AttributeError:

1747

1193

pass

1748

1194

# Is this a D-Bus interface?

1751

1197

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

1752

1198

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

1753

1199

# to the class.

1754

attr[attrname] = (

1755

dbus_interface_annotations(alt_interface)

1756

(copy_function(attribute)))

1200

attr[attrname] = (dbus_interface_annotations

1201

(alt_interface)

1202

(types.FunctionType

1203

(attribute.func_code,

1204

attribute.func_globals,

1205

attribute.func_name,

1206

attribute.func_defaults,

1207

attribute.func_closure)))

1757

1208

if deprecate:

1758

1209

# Deprecate all alternate interfaces

1759

iname = "_AlternateDBusNames_interface_annotation{}"

1210

iname="_AlternateDBusNames_interface_annotation{}"

1760

1211

for interface_name in interface_names:

1761

1762

1212

@dbus_interface_annotations(interface_name)

1763

1213

def func(self):

1764

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

1765

"true"}

1214

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

1215

"true" }

1766

1216

# Find an unused name

1767

1217

for aname in (iname.format(i)

1768

1218

for i in itertools.count()):

1772

1222

if interface_names:

1773

1223

# Replace the class with a new subclass of it with

1774

1224

# methods, signals, etc. as created above.

1775

if sys.version_info.major == 2:

1776

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

1777

(cls, ), attr)

1778

else:

1779

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

1780

(cls, ), attr)

1225

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

1226

(cls,), attr)

1781

1227

return cls

1782

1783

1228

return wrapper

1784

1229

1785

1230

1786

1231

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

1787

"se.bsnet.fukt.Mandos"})

1232

"se.bsnet.fukt.Mandos"})

1788

1233

class ClientDBus(Client, DBusObjectWithProperties):

1789

1234

"""A Client class using D-Bus

1790

1235

1791

1236

Attributes:

1792

1237

dbus_object_path: dbus.ObjectPath

1793

1238

bus: dbus.SystemBus()

1794

1239

"""

1795

1240

1796

1241

runtime_expansions = (Client.runtime_expansions

1797

+ ("dbus_object_path", ))

1798

1799

_interface = "se.recompile.Mandos.Client"

1800

1242

+ ("dbus_object_path",))

1243

1801

1244

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

1802

1803

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

1245

1246

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

1804

1247

self.bus = bus

1805

1248

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

1806

1249

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

1807

1250

# the D-Bus

1808

client_object_name = str(self.name).translate(

1251

client_object_name = unicode(self.name).translate(

1809

1252

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

1810

1253

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

1811

self.dbus_object_path = dbus.ObjectPath(

1812

"/clients/" + client_object_name)

1254

self.dbus_object_path = (dbus.ObjectPath

1255

("/clients/" + client_object_name))

1813

1256

DBusObjectWithProperties.__init__(self, self.bus,

1814

1257

self.dbus_object_path)

1815

1816

def notifychangeproperty(transform_func, dbus_name,

1817

type_func=lambda x: x,

1818

variant_level=1,

1819

invalidate_only=False,

1820

_interface=_interface):

1258

1259

def notifychangeproperty(transform_func,

1260

dbus_name, type_func=lambda x: x,

1261

variant_level=1):

1821

1262

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

1822

1263

its changes to DBus.

1823

1264

1824

1265

transform_fun: Function that takes a value and a variant_level

1825

1266

and transforms it to a D-Bus type.

1826

1267

dbus_name: D-Bus name of the variable

1829

1270

variant_level: D-Bus variant level. Default: 1

1830

1271

"""

1831

1272

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

1832

1833

1273

def setter(self, value):

1834

1274

if hasattr(self, "dbus_object_path"):

1835

1275

if (not hasattr(self, attrname) or

1836

1276

type_func(getattr(self, attrname, None))

1837

1277

!= type_func(value)):

1838

if invalidate_only:

1839

self.PropertiesChanged(

1840

_interface, dbus.Dictionary(),

1841

dbus.Array((dbus_name, )))

1842

else:

1843

dbus_value = transform_func(

1844

type_func(value),

1845

variant_level=variant_level)

1846

self.PropertyChanged(dbus.String(dbus_name),

1847

dbus_value)

1848

self.PropertiesChanged(

1849

_interface,

1850

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

1851

dbus_value}),

1852

dbus.Array())

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1281

self.PropertyChanged(dbus.String(dbus_name),

1282

dbus_value)

1853

1283

setattr(self, attrname, value)

1854

1284

1855

1285

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

1856

1286

1857

1287

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1858

1288

approvals_pending = notifychangeproperty(dbus.Boolean,

1859

1289

"ApprovalPending",

1860

type_func=bool)

1290

type_func = bool)

1861

1291

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

1862

1292

last_enabled = notifychangeproperty(datetime_to_dbus,

1863

1293

"LastEnabled")

1864

checker = notifychangeproperty(

1865

dbus.Boolean, "CheckerRunning",

1866

type_func=lambda checker: checker is not None)

1294

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

1295

type_func = lambda checker:

1296

checker is not None)

1867

1297

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1868

1298

"LastCheckedOK")

1869

1299

last_checker_status = notifychangeproperty(dbus.Int16,

1872

1302

datetime_to_dbus, "LastApprovalRequest")

1873

1303

approved_by_default = notifychangeproperty(dbus.Boolean,

1874

1304

"ApprovedByDefault")

1875

approval_delay = notifychangeproperty(

1876

dbus.UInt64, "ApprovalDelay",

1877

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

1305

approval_delay = notifychangeproperty(dbus.UInt64,

1306

"ApprovalDelay",

1307

type_func =

1308

timedelta_to_milliseconds)

1878

1309

approval_duration = notifychangeproperty(

1879

1310

dbus.UInt64, "ApprovalDuration",

1880

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

1311

type_func = timedelta_to_milliseconds)

1881

1312

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

1882

timeout = notifychangeproperty(

1883

dbus.UInt64, "Timeout",

1884

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

1313

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

1314

type_func =

1315

timedelta_to_milliseconds)

1885

1316

extended_timeout = notifychangeproperty(

1886

1317

dbus.UInt64, "ExtendedTimeout",

1887

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

1888

interval = notifychangeproperty(

1889

dbus.UInt64, "Interval",

1890

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

1318

type_func = timedelta_to_milliseconds)

1319

interval = notifychangeproperty(dbus.UInt64,

1320

"Interval",

1321

type_func =

1322

timedelta_to_milliseconds)

1891

1323

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

1892

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

1893

invalidate_only=True)

1894

1324

1895

1325

del notifychangeproperty

1896

1326

1897

1327

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

1898

1328

try:

1899

1329

self.remove_from_connection()

1902

1332

if hasattr(DBusObjectWithProperties, "__del__"):

1903

1333

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

1904

1334

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

1905

1906

def checker_callback(self, source, condition,

1907

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

1908

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

1909

connection, command, *args,

1910

**kwargs)

1911

exitstatus = self.last_checker_status

1912

if exitstatus >= 0:

1335

1336

def checker_callback(self, pid, condition, command,

1337

*args, **kwargs):

1338

self.checker_callback_tag = None

1339

self.checker = None

1340

if os.WIFEXITED(condition):

1341

exitstatus = os.WEXITSTATUS(condition)

1913

1342

# Emit D-Bus signal

1914

1343

self.CheckerCompleted(dbus.Int16(exitstatus),

1915

# This is specific to GNU libC

1916

dbus.Int64(exitstatus << 8),

1344

dbus.Int64(condition),

1917

1345

dbus.String(command))

1918

1346

else:

1919

1347

# Emit D-Bus signal

1920

1348

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

1921

dbus.Int64(

1922

# This is specific to GNU libC

1923

(exitstatus << 8)

1924

| self.last_checker_signal),

1349

dbus.Int64(condition),

1925

1350

dbus.String(command))

1926

return ret

1927

1351

1352

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

1353

*args, **kwargs)

1354

1928

1355

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

1929

1356

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

1930

1357

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

1934

1361

# Emit D-Bus signal

1935

1362

self.CheckerStarted(self.current_checker_command)

1936

1363

return r

1937

1364

1938

1365

def _reset_approved(self):

1939

1366

self.approved = None

1940

1367

return False

1941

1368

1942

1369

def approve(self, value=True):

1943

1370

self.approved = value

1944

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

1945

* 1000), self._reset_approved)

1371

gobject.timeout_add(timedelta_to_milliseconds

1372

(self.approval_duration),

1373

self._reset_approved)

1946

1374

self.send_changedstate()

1947

1948

# D-Bus methods, signals & properties

1949

1950

# Interfaces

1951

1952

# Signals

1953

1375

1376

## D-Bus methods, signals & properties

1377

_interface = "se.recompile.Mandos.Client"

1378

1379

## Interfaces

1380

1381

@dbus_interface_annotations(_interface)

1382

def _foo(self):

1383

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

1384

"false"}

1385

1386

## Signals

1387

1954

1388

# CheckerCompleted - signal

1955

1389

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

1956

1390

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

1957

1391

"D-Bus signal"

1958

1392

pass

1959

1393

1960

1394

# CheckerStarted - signal

1961

1395

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

1962

1396

def CheckerStarted(self, command):

1963

1397

"D-Bus signal"

1964

1398

pass

1965

1399

1966

1400

# PropertyChanged - signal

1967

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

1968

1401

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

1969

1402

def PropertyChanged(self, property, value):

1970

1403

"D-Bus signal"

1971

1404

pass

1972

1405

1973

1406

# GotSecret - signal

1974

1407

@dbus.service.signal(_interface)

1975

1408

def GotSecret(self):

1978

1411

server to mandos-client

1979

1412

"""

1980

1413

pass

1981

1414

1982

1415

# Rejected - signal

1983

1416

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

1984

1417

def Rejected(self, reason):

1985

1418

"D-Bus signal"

1986

1419

pass

1987

1420

1988

1421

# NeedApproval - signal

1989

1422

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

1990

1423

def NeedApproval(self, timeout, default):

1991

1424

"D-Bus signal"

1992

1425

return self.need_approval()

1993

1994

# Methods

1995

1426

1427

## Methods

1428

1996

1429

# Approve - method

1997

1430

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

1998

1431

def Approve(self, value):

1999

1432

self.approve(value)

2000

1433

2001

1434

# CheckedOK - method

2002

1435

@dbus.service.method(_interface)

2003

1436

def CheckedOK(self):

2004

1437

self.checked_ok()

2005

1438

2006

1439

# Enable - method

2007

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

2008

1440

@dbus.service.method(_interface)

2009

1441

def Enable(self):

2010

1442

"D-Bus method"

2011

1443

self.enable()

2012

1444

2013

1445

# StartChecker - method

2014

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

2015

1446

@dbus.service.method(_interface)

2016

1447

def StartChecker(self):

2017

1448

"D-Bus method"

2018

1449

self.start_checker()

2019

1450

2020

1451

# Disable - method

2021

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

2022

1452

@dbus.service.method(_interface)

2023

1453

def Disable(self):

2024

1454

"D-Bus method"

2025

1455

self.disable()

2026

1456

2027

1457

# StopChecker - method

2028

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

2029

1458

@dbus.service.method(_interface)

2030

1459

def StopChecker(self):

2031

1460

self.stop_checker()

2032

2033

# Properties

2034

1461

1462

## Properties

1463

2035

1464

# ApprovalPending - property

2036

1465

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

2037

1466

def ApprovalPending_dbus_property(self):

2038

1467

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

2039

1468

2040

1469

# ApprovedByDefault - property

2041

@dbus_service_property(_interface,

2042

signature="b",

1470

@dbus_service_property(_interface, signature="b",

2043

1471

access="readwrite")

2044

1472

def ApprovedByDefault_dbus_property(self, value=None):

2045

1473

if value is None: # get

2046

1474

return dbus.Boolean(self.approved_by_default)

2047

1475

self.approved_by_default = bool(value)

2048

1476

2049

1477

# ApprovalDelay - property

2050

@dbus_service_property(_interface,

2051

signature="t",

1478

@dbus_service_property(_interface, signature="t",

2052

1479

access="readwrite")

2053

1480

def ApprovalDelay_dbus_property(self, value=None):

2054

1481

if value is None: # get

2055

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

2056

* 1000)

1482

return dbus.UInt64(self.approval_delay_milliseconds())

2057

1483

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

2058

1484

2059

1485

# ApprovalDuration - property

2060

@dbus_service_property(_interface,

2061

signature="t",

1486

@dbus_service_property(_interface, signature="t",

2062

1487

access="readwrite")

2063

1488

def ApprovalDuration_dbus_property(self, value=None):

2064

1489

if value is None: # get

2065

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

2066

* 1000)

1490

return dbus.UInt64(timedelta_to_milliseconds(

1491

self.approval_duration))

2067

1492

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

2068

1493

2069

1494

# Name - property

2070

@dbus_annotations(

2071

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

2072

1495

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

2073

1496

def Name_dbus_property(self):

2074

1497

return dbus.String(self.name)

2075

2076

# KeyID - property

2077

@dbus_annotations(

2078

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

2079

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

2080

def KeyID_dbus_property(self):

2081

return dbus.String(self.key_id)

2082

1498

2083

1499

# Fingerprint - property

2084

@dbus_annotations(

2085

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

2086

1500

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

2087

1501

def Fingerprint_dbus_property(self):

2088

1502

return dbus.String(self.fingerprint)

2089

1503

2090

1504

# Host - property

2091

@dbus_service_property(_interface,

2092

signature="s",

1505

@dbus_service_property(_interface, signature="s",

2093

1506

access="readwrite")

2094

1507

def Host_dbus_property(self, value=None):

2095

1508

if value is None: # get

2096

1509

return dbus.String(self.host)

2097

self.host = str(value)

2098

1510

self.host = unicode(value)

1511

2099

1512

# Created - property

2100

@dbus_annotations(

2101

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

2102

1513

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

2103

1514

def Created_dbus_property(self):

2104

1515

return datetime_to_dbus(self.created)

2105

1516

2106

1517

# LastEnabled - property

2107

1518

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

2108

1519

def LastEnabled_dbus_property(self):

2109

1520

return datetime_to_dbus(self.last_enabled)

2110

1521

2111

1522

# Enabled - property

2112

@dbus_service_property(_interface,

2113

signature="b",

1523

@dbus_service_property(_interface, signature="b",

2114

1524

access="readwrite")

2115

1525

def Enabled_dbus_property(self, value=None):

2116

1526

if value is None: # get

2119

1529

self.enable()

2120

1530

else:

2121

1531

self.disable()

2122

1532

2123

1533

# LastCheckedOK - property

2124

@dbus_service_property(_interface,

2125

signature="s",

1534

@dbus_service_property(_interface, signature="s",

2126

1535

access="readwrite")

2127

1536

def LastCheckedOK_dbus_property(self, value=None):

2128

1537

if value is not None:

2129

1538

self.checked_ok()

2130

1539

return

2131

1540

return datetime_to_dbus(self.last_checked_ok)

2132

1541

2133

1542

# LastCheckerStatus - property

2134

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

1543

@dbus_service_property(_interface, signature="n",

1544

access="read")

2135

1545

def LastCheckerStatus_dbus_property(self):

2136

1546

return dbus.Int16(self.last_checker_status)

2137

1547

2138

1548

# Expires - property

2139

1549

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

2140

1550

def Expires_dbus_property(self):

2141

1551

return datetime_to_dbus(self.expires)

2142

1552

2143

1553

# LastApprovalRequest - property

2144

1554

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

2145

1555

def LastApprovalRequest_dbus_property(self):

2146

1556

return datetime_to_dbus(self.last_approval_request)

2147

1557

2148

1558

# Timeout - property

2149

@dbus_service_property(_interface,

2150

signature="t",

1559

@dbus_service_property(_interface, signature="t",

2151

1560

access="readwrite")

2152

1561

def Timeout_dbus_property(self, value=None):

2153

1562

if value is None: # get

2154

return dbus.UInt64(self.timeout.total_seconds() * 1000)

1563

return dbus.UInt64(self.timeout_milliseconds())

2155

1564

old_timeout = self.timeout

2156

1565

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

2157

1566

# Reschedule disabling

2165

1574

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

2166

1575

is None):

2167

1576

return

2168

GLib.source_remove(self.disable_initiator_tag)

2169

self.disable_initiator_tag = GLib.timeout_add(

2170

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

2171

self.disable)

2172

1577

gobject.source_remove(self.disable_initiator_tag)

1578

self.disable_initiator_tag = (

1579

gobject.timeout_add(

1580

timedelta_to_milliseconds(self.expires - now),

1581

self.disable))

1582

2173

1583

# ExtendedTimeout - property

2174

@dbus_service_property(_interface,

2175

signature="t",

1584

@dbus_service_property(_interface, signature="t",

2176

1585

access="readwrite")

2177

1586

def ExtendedTimeout_dbus_property(self, value=None):

2178

1587

if value is None: # get

2179

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

2180

* 1000)

1588

return dbus.UInt64(self.extended_timeout_milliseconds())

2181

1589

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

2182

1590

2183

1591

# Interval - property

2184

@dbus_service_property(_interface,

2185

signature="t",

1592

@dbus_service_property(_interface, signature="t",

2186

1593

access="readwrite")

2187

1594

def Interval_dbus_property(self, value=None):

2188

1595

if value is None: # get

2189

return dbus.UInt64(self.interval.total_seconds() * 1000)

1596

return dbus.UInt64(self.interval_milliseconds())

2190

1597

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

2191

1598

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

2192

1599

return

2193

1600

if self.enabled:

2194

1601

# Reschedule checker run

2195

GLib.source_remove(self.checker_initiator_tag)

2196

self.checker_initiator_tag = GLib.timeout_add(

2197

value, self.start_checker)

2198

self.start_checker() # Start one now, too

2199

1602

gobject.source_remove(self.checker_initiator_tag)

1603

self.checker_initiator_tag = (gobject.timeout_add

1604

(value, self.start_checker))

1605

self.start_checker() # Start one now, too

1606

2200

1607

# Checker - property

2201

@dbus_service_property(_interface,

2202

signature="s",

1608

@dbus_service_property(_interface, signature="s",

2203

1609

access="readwrite")

2204

1610

def Checker_dbus_property(self, value=None):

2205

1611

if value is None: # get

2206

1612

return dbus.String(self.checker_command)

2207

self.checker_command = str(value)

2208

1613

self.checker_command = unicode(value)

1614

2209

1615

# CheckerRunning - property

2210

@dbus_service_property(_interface,

2211

signature="b",

1616

@dbus_service_property(_interface, signature="b",

2212

1617

access="readwrite")

2213

1618

def CheckerRunning_dbus_property(self, value=None):

2214

1619

if value is None: # get

2217

1622

self.start_checker()

2218

1623

else:

2219

1624

self.stop_checker()

2220

1625

2221

1626

# ObjectPath - property

2222

@dbus_annotations(

2223

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

2224

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

2225

1627

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

2226

1628

def ObjectPath_dbus_property(self):

2227

return self.dbus_object_path # is already a dbus.ObjectPath

2228

1629

return self.dbus_object_path # is already a dbus.ObjectPath

1630

2229

1631

# Secret = property

2230

@dbus_annotations(

2231

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

2232

"invalidates"})

2233

@dbus_service_property(_interface,

2234

signature="ay",

2235

access="write",

2236

byte_arrays=True)

1632

@dbus_service_property(_interface, signature="ay",

1633

access="write", byte_arrays=True)

2237

1634

def Secret_dbus_property(self, value):

2238

self.secret = bytes(value)

2239

1635

self.secret = str(value)

1636

2240

1637

del _interface

2241

1638

2242

1639

2243

class ProxyClient:

2244

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

1640

class ProxyClient(object):

1641

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

2245

1642

self._pipe = child_pipe

2246

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

1643

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

2247

1644

if not self._pipe.recv():

2248

raise KeyError(key_id or fpr)

2249

1645

raise KeyError()

1646

2250

1647

def __getattribute__(self, name):

2251

1648

if name == '_pipe':

2252

1649

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

2255

1652

if data[0] == 'data':

2256

1653

return data[1]

2257

1654

if data[0] == 'function':

2258

2259

1655

def func(*args, **kwargs):

2260

1656

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

2261

1657

return self._pipe.recv()[1]

2262

2263

1658

return func

2264

1659

2265

1660

def __setattr__(self, name, value):

2266

1661

if name == '_pipe':

2267

1662

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

2270

1665

2271

1666

class ClientHandler(socketserver.BaseRequestHandler, object):

2272

1667

"""A class to handle client connections.

2273

1668

2274

1669

Instantiated once for each connection to handle it.

2275

1670

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

2276

1671

2277

1672

def handle(self):

2278

1673

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

2279

1674

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

2280

str(self.client_address))

1675

unicode(self.client_address))

2281

1676

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

2282

1677

self.server.child_pipe.fileno())

2283

2284

session = gnutls.ClientSession(self.request)

2285

2286

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

2287

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

2288

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

2289

# "+DHE-DSS"))

1678

1679

session = (gnutls.connection

1680

.ClientSession(self.request,

1681

gnutls.connection

1682

.X509Credentials()))

1683

1684

# Note: gnutls.connection.X509Credentials is really a

1685

# generic GnuTLS certificate credentials object so long as

1686

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

1687

# here despite using OpenPGP certificates.

1688

1689

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

1690

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

1691

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

1692

# "+DHE-DSS"))

2290

1693

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

2291

1694

priority = self.server.gnutls_priority

2292

1695

if priority is None:

2293

1696

priority = "NORMAL"

2294

gnutls.priority_set_direct(session._c_object,

2295

priority.encode("utf-8"),

2296

None)

2297

1697

(gnutls.library.functions

1698

.gnutls_priority_set_direct(session._c_object,

1699

priority, None))

1700

2298

1701

# Start communication using the Mandos protocol

2299

1702

# Get protocol number

2300

1703

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

2305

1708

except (ValueError, IndexError, RuntimeError) as error:

2306

1709

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

2307

1710

return

2308

1711

2309

1712

# Start GnuTLS connection

2310

1713

try:

2311

1714

session.handshake()

2312

except gnutls.Error as error:

1715

except gnutls.errors.GNUTLSError as error:

2313

1716

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

2314

1717

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

2315

1718

# established. Just abandon the request.

2316

1719

return

2317

1720

logger.debug("Handshake succeeded")

2318

1721

2319

1722

approval_required = False

2320

1723

try:

2321

if gnutls.has_rawpk:

2322

fpr = b""

2323

try:

2324

key_id = self.key_id(

2325

self.peer_certificate(session))

2326

except (TypeError, gnutls.Error) as error:

2327

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

2328

return

2329

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

2330

2331

else:

2332

key_id = b""

2333

try:

2334

fpr = self.fingerprint(

2335

self.peer_certificate(session))

2336

except (TypeError, gnutls.Error) as error:

2337

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

2338

return

2339

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

2340

2341

try:

2342

client = ProxyClient(child_pipe, key_id, fpr,

1724

try:

1725

fpr = self.fingerprint(self.peer_certificate

1726

(session))

1727

except (TypeError,

1728

gnutls.errors.GNUTLSError) as error:

1729

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

1730

return

1731

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

1732

1733

try:

1734

client = ProxyClient(child_pipe, fpr,

2343

1735

self.client_address)

2344

1736

except KeyError:

2345

1737

return

2346

1738

2347

1739

if client.approval_delay:

2348

1740

delay = client.approval_delay

2349

1741

client.approvals_pending += 1

2350

1742

approval_required = True

2351

1743

2352

1744

while True:

2353

1745

if not client.enabled:

2354

1746

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

2355

client.name)

1747

client.name)

2356

1748

if self.server.use_dbus:

2357

1749

# Emit D-Bus signal

2358

1750

client.Rejected("Disabled")

2359

1751

return

2360

1752

2361

1753

if client.approved or not client.approval_delay:

2362

# We are approved or approval is disabled

1754

#We are approved or approval is disabled

2363

1755

break

2364

1756

elif client.approved is None:

2365

1757

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

2367

1759

if self.server.use_dbus:

2368

1760

# Emit D-Bus signal

2369

1761

client.NeedApproval(

2370

client.approval_delay.total_seconds()

2371

* 1000, client.approved_by_default)

1762

client.approval_delay_milliseconds(),

1763

client.approved_by_default)

2372

1764

else:

2373

1765

logger.warning("Client %s was not approved",

2374

1766

client.name)

2376

1768

# Emit D-Bus signal

2377

1769

client.Rejected("Denied")

2378

1770

return

2379

2380

# wait until timeout or approved

1771

1772

#wait until timeout or approved

2381

1773

time = datetime.datetime.now()

2382

1774

client.changedstate.acquire()

2383

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

1775

client.changedstate.wait(

1776

float(timedelta_to_milliseconds(delay)

1777

/ 1000))

2384

1778

client.changedstate.release()

2385

1779

time2 = datetime.datetime.now()

2386

1780

if (time2 - time) >= delay:

2396

1790

break

2397

1791

else:

2398

1792

delay -= time2 - time

2399

2400

try:

2401

session.send(client.secret)

2402

except gnutls.Error as error:

2403

logger.warning("gnutls send failed",

2404

exc_info=error)

2405

return

2406

1793

1794

sent_size = 0

1795

while sent_size < len(client.secret):

1796

try:

1797

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

1798

except gnutls.errors.GNUTLSError as error:

1799

logger.warning("gnutls send failed",

1800

exc_info=error)

1801

return

1802

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

1803

sent, len(client.secret)

1804

- (sent_size + sent))

1805

sent_size += sent

1806

2407

1807

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

2408

1808

# bump the timeout using extended_timeout

2409

1809

client.bump_timeout(client.extended_timeout)

2410

1810

if self.server.use_dbus:

2411

1811

# Emit D-Bus signal

2412

1812

client.GotSecret()

2413

1813

2414

1814

finally:

2415

1815

if approval_required:

2416

1816

client.approvals_pending -= 1

2417

1817

try:

2418

1818

session.bye()

2419

except gnutls.Error as error:

1819

except gnutls.errors.GNUTLSError as error:

2420

1820

logger.warning("GnuTLS bye failed",

2421

1821

exc_info=error)

2422

1822

2423

1823

@staticmethod

2424

1824

def peer_certificate(session):

2425

"Return the peer's certificate as a bytestring"

2426

try:

2427

cert_type = gnutls.certificate_type_get2(session._c_object,

2428

gnutls.CTYPE_PEERS)

2429

except AttributeError:

2430

cert_type = gnutls.certificate_type_get(session._c_object)

2431

if gnutls.has_rawpk:

2432

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2433

else:

2434

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2435

# If not a valid certificate type...

2436

if cert_type not in valid_cert_types:

2437

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

2438

valid_cert_types)

2439

# ...return invalid data

2440

return b""

1825

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

1826

# If not an OpenPGP certificate...

1827

if (gnutls.library.functions

1828

.gnutls_certificate_type_get(session._c_object)

1829

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1830

# ...do the normal thing

1831

return session.peer_certificate

2441

1832

list_size = ctypes.c_uint(1)

2442

cert_list = (gnutls.certificate_get_peers

1833

cert_list = (gnutls.library.functions

1834

.gnutls_certificate_get_peers

2443

1835

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

2444

1836

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

2445

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

1837

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

1838

" certificate")

2446

1839

if list_size.value == 0:

2447

1840

return None

2448

1841

cert = cert_list[0]

2449

1842

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

2450

2451

@staticmethod

2452

def key_id(certificate):

2453

"Convert a certificate bytestring to a hexdigit key ID"

2454

# New GnuTLS "datum" with the public key

2455

datum = gnutls.datum_t(

2456

ctypes.cast(ctypes.c_char_p(certificate),

2457

ctypes.POINTER(ctypes.c_ubyte)),

2458

ctypes.c_uint(len(certificate)))

2459

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

2460

# New empty GnuTLS certificate

2461

pubkey = gnutls.pubkey_t()

2462

gnutls.pubkey_init(ctypes.byref(pubkey))

2463

# Import the raw public key into the certificate

2464

gnutls.pubkey_import(pubkey,

2465

ctypes.byref(datum),

2466

gnutls.X509_FMT_DER)

2467

# New buffer for the key ID

2468

buf = ctypes.create_string_buffer(32)

2469

buf_len = ctypes.c_size_t(len(buf))

2470

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

2471

gnutls.pubkey_get_key_id(pubkey,

2472

gnutls.KEYID_USE_SHA256,

2473

ctypes.cast(ctypes.byref(buf),

2474

ctypes.POINTER(ctypes.c_ubyte)),

2475

ctypes.byref(buf_len))

2476

# Deinit the certificate

2477

gnutls.pubkey_deinit(pubkey)

2478

2479

# Convert the buffer to a Python bytestring

2480

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

2481

# Convert the bytestring to hexadecimal notation

2482

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

2483

return hex_key_id

2484

1843

2485

1844

@staticmethod

2486

1845

def fingerprint(openpgp):

2487

1846

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2488

1847

# New GnuTLS "datum" with the OpenPGP public key

2489

datum = gnutls.datum_t(

2490

ctypes.cast(ctypes.c_char_p(openpgp),

2491

ctypes.POINTER(ctypes.c_ubyte)),

2492

ctypes.c_uint(len(openpgp)))

1848

datum = (gnutls.library.types

1849

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

1850

ctypes.POINTER

1851

(ctypes.c_ubyte)),

1852

ctypes.c_uint(len(openpgp))))

2493

1853

# New empty GnuTLS certificate

2494

crt = gnutls.openpgp_crt_t()

2495

gnutls.openpgp_crt_init(ctypes.byref(crt))

1854

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1855

(gnutls.library.functions

1856

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2496

1857

# Import the OpenPGP public key into the certificate

2497

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

2498

gnutls.OPENPGP_FMT_RAW)

1858

(gnutls.library.functions

1859

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

1860

gnutls.library.constants

1861

.GNUTLS_OPENPGP_FMT_RAW))

2499

1862

# Verify the self signature in the key

2500

1863

crtverify = ctypes.c_uint()

2501

gnutls.openpgp_crt_verify_self(crt, 0,

2502

ctypes.byref(crtverify))

1864

(gnutls.library.functions

1865

.gnutls_openpgp_crt_verify_self(crt, 0,

1866

ctypes.byref(crtverify)))

2503

1867

if crtverify.value != 0:

2504

gnutls.openpgp_crt_deinit(crt)

2505

raise gnutls.CertificateSecurityError(code

2506

=crtverify.value)

1868

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1869

raise (gnutls.errors.CertificateSecurityError

1870

("Verify failed"))

2507

1871

# New buffer for the fingerprint

2508

1872

buf = ctypes.create_string_buffer(20)

2509

1873

buf_len = ctypes.c_size_t()

2510

1874

# Get the fingerprint from the certificate into the buffer

2511

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

2512

ctypes.byref(buf_len))

1875

(gnutls.library.functions

1876

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

1877

ctypes.byref(buf_len)))

2513

1878

# Deinit the certificate

2514

gnutls.openpgp_crt_deinit(crt)

1879

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2515

1880

# Convert the buffer to a Python bytestring

2516

1881

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

2517

1882

# Convert the bytestring to hexadecimal notation

2519

1884

return hex_fpr

2520

1885

2521

1886

2522

class MultiprocessingMixIn:

1887

class MultiprocessingMixIn(object):

2523

1888

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

2524

2525

1889

def sub_process_main(self, request, address):

2526

1890

try:

2527

1891

self.finish_request(request, address)

2528

1892

except Exception:

2529

1893

self.handle_error(request, address)

2530

1894

self.close_request(request)

2531

1895

2532

1896

def process_request(self, request, address):

2533

1897

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

2534

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

2535

args=(request, address))

1898

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

1899

args = (request, address))

2536

1900

proc.start()

2537

1901

return proc

2538

1902

2539

1903

2540

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1904

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2541

1905

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

2542

2543

1906

def process_request(self, request, client_address):

2544

1907

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

2545

1908

2546

1909

This function creates a new pipe in self.pipe

2547

1910

"""

2548

1911

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2549

1912

2550

1913

proc = MultiprocessingMixIn.process_request(self, request,

2551

1914

client_address)

2552

1915

self.child_pipe.close()

2553

1916

self.add_pipe(parent_pipe, proc)

2554

1917

2555

1918

def add_pipe(self, parent_pipe, proc):

2556

1919

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

2557

1920

raise NotImplementedError()

2558

1921

2559

1922

2560

1923

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2561

socketserver.TCPServer):

1924

socketserver.TCPServer, object):

2562

1925

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

2563

1926

2564

1927

Attributes:

2565

1928

enabled: Boolean; whether this server is activated yet

2566

1929

interface: None or a network interface name (string)

2567

1930

use_ipv6: Boolean; to use IPv6 or not

2568

1931

"""

2569

2570

1932

def __init__(self, server_address, RequestHandlerClass,

2571

interface=None,

2572

use_ipv6=True,

2573

socketfd=None):

1933

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

2574

1934

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

2575

1935

creating a new one with socket.socket().

2576

1936

"""

2582

1942

self.socketfd = socketfd

2583

1943

# Save the original socket.socket() function

2584

1944

self.socket_socket = socket.socket

2585

2586

1945

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

2587

#

1946

#

2588

1947

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

2589

1948

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

2590

1949

# patching socket.socket.)

2591

#

1950

#

2592

1951

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

2593

1952

@functools.wraps(socket.socket)

2594

1953

def socket_wrapper(*args, **kwargs):

2606

1965

# socket_wrapper(), if socketfd was set.

2607

1966

socketserver.TCPServer.__init__(self, server_address,

2608

1967

RequestHandlerClass)

2609

1968

2610

1969

def server_bind(self):

2611

1970

"""This overrides the normal server_bind() function

2612

1971

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

2613

1972

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

2614

global SO_BINDTODEVICE

2615

1973

if self.interface is not None:

2616

1974

if SO_BINDTODEVICE is None:

2617

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

2618

# common enough.

2619

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

2620

SO_BINDTODEVICE = 25

2621

try:

2622

self.socket.setsockopt(

2623

socket.SOL_SOCKET, SO_BINDTODEVICE,

2624

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

2625

except socket.error as error:

2626

if error.errno == errno.EPERM:

2627

logger.error("No permission to bind to"

2628

" interface %s", self.interface)

2629

elif error.errno == errno.ENOPROTOOPT:

2630

logger.error("SO_BINDTODEVICE not available;"

2631

" cannot bind to interface %s",

2632

self.interface)

2633

elif error.errno == errno.ENODEV:

2634

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

2635

" cannot bind", self.interface)

2636

else:

2637

raise

1975

logger.error("SO_BINDTODEVICE does not exist;"

1976

" cannot bind to interface %s",

1977

self.interface)

1978

else:

1979

try:

1980

self.socket.setsockopt(socket.SOL_SOCKET,

1981

SO_BINDTODEVICE,

1982

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

1983

except socket.error as error:

1984

if error.errno == errno.EPERM:

1985

logger.error("No permission to bind to"

1986

" interface %s", self.interface)

1987

elif error.errno == errno.ENOPROTOOPT:

1988

logger.error("SO_BINDTODEVICE not available;"

1989

" cannot bind to interface %s",

1990

self.interface)

1991

elif error.errno == errno.ENODEV:

1992

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

1993

" cannot bind", self.interface)

1994

else:

1995

raise

2638

1996

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

2639

1997

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

2640

if self.server_address[1]:

2641

self.allow_reuse_address = True

2642

1998

if not self.server_address[0]:

2643

1999

if self.address_family == socket.AF_INET6:

2644

any_address = "::" # in6addr_any

2000

any_address = "::" # in6addr_any

2645

2001

else:

2646

any_address = "0.0.0.0" # INADDR_ANY

2002

any_address = "0.0.0.0" # INADDR_ANY

2647

2003

self.server_address = (any_address,

2648

2004

self.server_address[1])

2649

2005

elif not self.server_address[1]:

2650

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

2006

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

2007

0)

2651

2008

# if self.interface:

2652

2009

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

2653

2010

# 0, # port

2659

2016

2660

2017

class MandosServer(IPv6_TCPServer):

2661

2018

"""Mandos server.

2662

2019

2663

2020

Attributes:

2664

2021

clients: set of Client objects

2665

2022

gnutls_priority GnuTLS priority string

2666

2023

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

2667

2668

Assumes a GLib.MainLoop event loop.

2024

2025

Assumes a gobject.MainLoop event loop.

2669

2026

"""

2670

2671

2027

def __init__(self, server_address, RequestHandlerClass,

2672

interface=None,

2673

use_ipv6=True,

2674

clients=None,

2675

gnutls_priority=None,

2676

use_dbus=True,

2677

socketfd=None):

2028

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

2029

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

2678

2030

self.enabled = False

2679

2031

self.clients = clients

2680

2032

if self.clients is None:

2683

2035

self.gnutls_priority = gnutls_priority

2684

2036

IPv6_TCPServer.__init__(self, server_address,

2685

2037

RequestHandlerClass,

2686

interface=interface,

2687

use_ipv6=use_ipv6,

2688

socketfd=socketfd)

2689

2038

interface = interface,

2039

use_ipv6 = use_ipv6,

2040

socketfd = socketfd)

2690

2041

def server_activate(self):

2691

2042

if self.enabled:

2692

2043

return socketserver.TCPServer.server_activate(self)

2693

2044

2694

2045

def enable(self):

2695

2046

self.enabled = True

2696

2047

2697

2048

def add_pipe(self, parent_pipe, proc):

2698

2049

# Call "handle_ipc" for both data and EOF events

2699

GLib.io_add_watch(

2700

GLib.IOChannel.unix_new(parent_pipe.fileno()),

2701

GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,

2702

functools.partial(self.handle_ipc,

2703

parent_pipe=parent_pipe,

2704

proc=proc))

2705

2706

def handle_ipc(self, source, condition,

2707

parent_pipe=None,

2708

proc=None,

2709

client_object=None):

2050

gobject.io_add_watch(parent_pipe.fileno(),

2051

gobject.IO_IN | gobject.IO_HUP,

2052

functools.partial(self.handle_ipc,

2053

parent_pipe =

2054

parent_pipe,

2055

proc = proc))

2056

2057

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

2058

proc = None, client_object=None):

2710

2059

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

2711

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

2060

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

2712

2061

# Wait for other process to exit

2713

2062

proc.join()

2714

2063

return False

2715

2064

2716

2065

# Read a request from the child

2717

2066

request = parent_pipe.recv()

2718

2067

command = request[0]

2719

2068

2720

2069

if command == 'init':

2721

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

2722

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

2723

address = request[3]

2724

2725

for c in self.clients.values():

2726

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2727

continue

2728

if key_id and c.key_id == key_id:

2729

client = c

2730

break

2731

if fpr and c.fingerprint == fpr:

2070

fpr = request[1]

2071

address = request[2]

2072

2073

for c in self.clients.itervalues():

2074

if c.fingerprint == fpr:

2732

2075

client = c

2733

2076

break

2734

2077

else:

2735

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

2736

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

2078

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

2079

"dress: %s", fpr, address)

2737

2080

if self.use_dbus:

2738

2081

# Emit D-Bus signal

2739

mandos_dbus_service.ClientNotFound(key_id or fpr,

2082

mandos_dbus_service.ClientNotFound(fpr,

2740

2083

address[0])

2741

2084

parent_pipe.send(False)

2742

2085

return False

2743

2744

GLib.io_add_watch(

2745

GLib.IOChannel.unix_new(parent_pipe.fileno()),

2746

GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,

2747

functools.partial(self.handle_ipc,

2748

parent_pipe=parent_pipe,

2749

proc=proc,

2750

client_object=client))

2086

2087

gobject.io_add_watch(parent_pipe.fileno(),

2088

gobject.IO_IN | gobject.IO_HUP,

2089

functools.partial(self.handle_ipc,

2090

parent_pipe =

2091

parent_pipe,

2092

proc = proc,

2093

client_object =

2094

client))

2751

2095

parent_pipe.send(True)

2752

2096

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

2753

2097

# same fileno

2756

2100

funcname = request[1]

2757

2101

args = request[2]

2758

2102

kwargs = request[3]

2759

2103

2760

2104

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

2761

2105

funcname)(*args,

2762

**kwargs)))

2763

2106

**kwargs)))

2107

2764

2108

if command == 'getattr':

2765

2109

attrname = request[1]

2766

if isinstance(client_object.__getattribute__(attrname),

2767

collections.abc.Callable):

2768

parent_pipe.send(('function', ))

2110

if callable(client_object.__getattribute__(attrname)):

2111

parent_pipe.send(('function',))

2769

2112

else:

2770

parent_pipe.send((

2771

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

2772

2113

parent_pipe.send(('data', client_object

2114

.__getattribute__(attrname)))

2115

2773

2116

if command == 'setattr':

2774

2117

attrname = request[1]

2775

2118

value = request[2]

2776

2119

setattr(client_object, attrname, value)

2777

2120

2778

2121

return True

2779

2122

2780

2123

2781

2124

def rfc3339_duration_to_delta(duration):

2782

2125

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

2783

2784

>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)

2785

True

2786

>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)

2787

True

2788

>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)

2789

True

2790

>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)

2791

True

2792

>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)

2793

True

2794

>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)

2795

True

2796

>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)

2797

True

2126

2127

>>> rfc3339_duration_to_delta("P7D")

2128

datetime.timedelta(7)

2129

>>> rfc3339_duration_to_delta("PT60S")

2130

datetime.timedelta(0, 60)

2131

>>> rfc3339_duration_to_delta("PT60M")

2132

datetime.timedelta(0, 3600)

2133

>>> rfc3339_duration_to_delta("PT24H")

2134

datetime.timedelta(1)

2135

>>> rfc3339_duration_to_delta("P1W")

2136

datetime.timedelta(7)

2137

>>> rfc3339_duration_to_delta("PT5M30S")

2138

datetime.timedelta(0, 330)

2139

>>> rfc3339_duration_to_delta("P1DT3M20S")

2140

datetime.timedelta(1, 200)

2798

2141

"""

2799

2142

2800

2143

# Parsing an RFC 3339 duration with regular expressions is not

2801

2144

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

2802

2145

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

2803

2146

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

2804

2147

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

2805

2148

# avoid excessive use of external libraries.

2806

2149

2807

2150

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

2808

Token = collections.namedtuple("Token", (

2809

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

2810

# a "group" containing digits

2811

"value", # datetime.timedelta or None

2812

"followers")) # Tokens valid after this token

2151

Token = collections.namedtuple("Token",

2152

("regexp", # To match token; if

2153

# "value" is not None,

2154

# must have a "group"

2155

# containing digits

2156

"value", # datetime.timedelta or

2157

# None

2158

"followers")) # Tokens valid after

2159

# this token

2813

2160

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

2814

2161

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

2815

2162

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

2816

2163

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

2817

2164

datetime.timedelta(seconds=1),

2818

frozenset((token_end, )))

2165

frozenset((token_end,)))

2819

2166

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

2820

2167

datetime.timedelta(minutes=1),

2821

2168

frozenset((token_second, token_end)))

2837

2184

frozenset((token_month, token_end)))

2838

2185

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

2839

2186

datetime.timedelta(weeks=1),

2840

frozenset((token_end, )))

2187

frozenset((token_end,)))

2841

2188

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

2842

2189

frozenset((token_year, token_month,

2843

2190

token_day, token_time,

2844

2191

token_week)))

2845

# Define starting values:

2846

# Value so far

2847

value = datetime.timedelta()

2192

# Define starting values

2193

value = datetime.timedelta() # Value so far

2848

2194

found_token = None

2849

# Following valid tokens

2850

followers = frozenset((token_duration, ))

2851

# String left to parse

2852

s = duration

2195

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

2196

s = duration # String left to parse

2853

2197

# Loop until end token is found

2854

2198

while found_token is not token_end:

2855

2199

# Search for any currently valid tokens

2871

2215

break

2872

2216

else:

2873

2217

# No currently valid tokens were found

2874

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

2875

.format(duration))

2218

raise ValueError("Invalid RFC 3339 duration")

2876

2219

# End token found

2877

2220

return value

2878

2221

2879

2222

2880

2223

def string_to_delta(interval):

2881

2224

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

2882

2883

>>> string_to_delta('7d') == datetime.timedelta(7)

2884

True

2885

>>> string_to_delta('60s') == datetime.timedelta(0, 60)

2886

True

2887

>>> string_to_delta('60m') == datetime.timedelta(0, 3600)

2888

True

2889

>>> string_to_delta('24h') == datetime.timedelta(1)

2890

True

2891

>>> string_to_delta('1w') == datetime.timedelta(7)

2892

True

2893

>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)

2894

True

2225

2226

>>> string_to_delta('7d')

2227

datetime.timedelta(7)

2228

>>> string_to_delta('60s')

2229

datetime.timedelta(0, 60)

2230

>>> string_to_delta('60m')

2231

datetime.timedelta(0, 3600)

2232

>>> string_to_delta('24h')

2233

datetime.timedelta(1)

2234

>>> string_to_delta('1w')

2235

datetime.timedelta(7)

2236

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

2237

datetime.timedelta(0, 330)

2895

2238

"""

2896

2239

2897

2240

try:

2898

2241

return rfc3339_duration_to_delta(interval)

2899

2242

except ValueError:

2900

2243

pass

2901

2244

2902

2245

timevalue = datetime.timedelta(0)

2903

2246

for s in interval.split():

2904

2247

try:

2905

suffix = s[-1]

2248

suffix = unicode(s[-1])

2906

2249

value = int(s[:-1])

2907

2250

if suffix == "d":

2908

2251

delta = datetime.timedelta(value)

2915

2258

elif suffix == "w":

2916

2259

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

2917

2260

else:

2918

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

2261

raise ValueError("Unknown suffix {!r}"

2262

.format(suffix))

2919

2263

except IndexError as e:

2920

2264

raise ValueError(*(e.args))

2921

2265

timevalue += delta

2922

2266

return timevalue

2923

2267

2924

2268

2925

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

2269

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

2926

2270

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

2927

2271

2928

2272

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

2929

2273

if os.fork():

2930

2274

sys.exit()

2937

2281

# Close all standard open file descriptors

2938

2282

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

2939

2283

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

2940

raise OSError(errno.ENODEV,

2941

"{} not a character device"

2284

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

2942

2285

.format(os.devnull))

2943

2286

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

2944

2287

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

2948

2291

2949

2292

2950

2293

def main():

2951

2294

2952

2295

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

2953

2296

# Parsing of options, both command line and config file

2954

2297

2955

2298

parser = argparse.ArgumentParser()

2956

2299

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

2957

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

2300

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

2958

2301

help="show version number and exit")

2959

2302

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

2960

2303

help="Bind to interface IF")

2996

2339

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

2997

2340

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

2998

2341

default=None)

2999

2342

3000

2343

options = parser.parse_args()

3001

2344

2345

if options.check:

2346

import doctest

2347

fail_count, test_count = doctest.testmod()

2348

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

2349

3002

2350

# Default values for config file for server-global settings

3003

if gnutls.has_rawpk:

3004

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

3005

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

3006

else:

3007

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

3008

":+SIGN-DSA-SHA256")

3009

server_defaults = {"interface": "",

3010

"address": "",

3011

"port": "",

3012

"debug": "False",

3013

"priority": priority,

3014

"servicename": "Mandos",

3015

"use_dbus": "True",

3016

"use_ipv6": "True",

3017

"debuglevel": "",

3018

"restore": "True",

3019

"socket": "",

3020

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

3021

"foreground": "False",

3022

"zeroconf": "True",

3023

}

3024

del priority

3025

2351

server_defaults = { "interface": "",

2352

"address": "",

2353

"port": "",

2354

"debug": "False",

2355

"priority":

2356

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

2357

"servicename": "Mandos",

2358

"use_dbus": "True",

2359

"use_ipv6": "True",

2360

"debuglevel": "",

2361

"restore": "True",

2362

"socket": "",

2363

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

2364

"foreground": "False",

2365

"zeroconf": "True",

2366

}

2367

3026

2368

# Parse config file for server-global settings

3027

server_config = configparser.ConfigParser(server_defaults)

2369

server_config = configparser.SafeConfigParser(server_defaults)

3028

2370

del server_defaults

3029

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

3030

# Convert the ConfigParser object to a dict

2371

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

2372

"mandos.conf"))

2373

# Convert the SafeConfigParser object to a dict

3031

2374

server_settings = server_config.defaults()

3032

2375

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

3033

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

3034

"foreground", "zeroconf"):

2376

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

3035

2377

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

3036

2378

option)

3037

2379

if server_settings["port"]:

3047

2389

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

3048

2390

["socket"])

3049

2391

del server_config

3050

2392

3051

2393

# Override the settings from the config file with command line

3052

2394

# options, if set.

3053

2395

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

3054

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

3055

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

3056

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

2396

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

2397

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

2398

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

3057

2399

value = getattr(options, option)

3058

2400

if value is not None:

3059

2401

server_settings[option] = value

3060

2402

del options

3061

2403

# Force all strings to be unicode

3062

2404

for option in server_settings.keys():

3063

if isinstance(server_settings[option], bytes):

3064

server_settings[option] = (server_settings[option]

3065

.decode("utf-8"))

2405

if type(server_settings[option]) is str:

2406

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

3066

2407

# Force all boolean options to be boolean

3067

2408

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

3068

2409

"foreground", "zeroconf"):

3071

2412

if server_settings["debug"]:

3072

2413

server_settings["foreground"] = True

3073

2414

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

3074

2415

3075

2416

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

3076

3077

if (not server_settings["zeroconf"]

3078

and not (server_settings["port"]

3079

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

3080

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

3081

2417

2418

if (not server_settings["zeroconf"] and

2419

not (server_settings["port"]

2420

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

2421

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

2422

" Zeroconf")

2423

3082

2424

# For convenience

3083

2425

debug = server_settings["debug"]

3084

2426

debuglevel = server_settings["debuglevel"]

3088

2430

stored_state_file)

3089

2431

foreground = server_settings["foreground"]

3090

2432

zeroconf = server_settings["zeroconf"]

3091

2433

3092

2434

if debug:

3093

2435

initlogger(debug, logging.DEBUG)

3094

2436

else:

3097

2439

else:

3098

2440

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

3099

2441

initlogger(debug, level)

3100

2442

3101

2443

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

3102

syslogger.setFormatter(

3103

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

3104

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

3105

server_settings["servicename"])))

3106

2444

syslogger.setFormatter(logging.Formatter

2445

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

2446

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

2447

.format(server_settings

2448

["servicename"])))

2449

3107

2450

# Parse config file with clients

3108

client_config = configparser.ConfigParser(Client.client_defaults)

2451

client_config = configparser.SafeConfigParser(Client

2452

.client_defaults)

3109

2453

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

3110

2454

"clients.conf"))

3111

2455

3112

2456

global mandos_dbus_service

3113

2457

mandos_dbus_service = None

3114

2458

3115

2459

socketfd = None

3116

2460

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

3117

2461

socketfd = server_settings["socket"]

3118

tcp_server = MandosServer(

3119

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

3120

ClientHandler,

3121

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

3122

use_ipv6=use_ipv6,

3123

gnutls_priority=server_settings["priority"],

3124

use_dbus=use_dbus,

3125

socketfd=socketfd)

2462

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

2463

server_settings["port"]),

2464

ClientHandler,

2465

interface=(server_settings["interface"]

2466

or None),

2467

use_ipv6=use_ipv6,

2468

gnutls_priority=

2469

server_settings["priority"],

2470

use_dbus=use_dbus,

2471

socketfd=socketfd)

3126

2472

if not foreground:

3127

2473

pidfilename = "/run/mandos.pid"

3128

2474

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

3129

2475

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

3130

2476

pidfile = None

3131

2477

try:

3132

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

2478

pidfile = open(pidfilename, "w")

3133

2479

except IOError as e:

3134

2480

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

3135

2481

exc_info=e)

3136

3137

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

3138

("mandos", "mandos"),

3139

("nobody", "nogroup")):

2482

2483

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

3140

2484

try:

3141

2485

uid = pwd.getpwnam(name).pw_uid

3142

gid = pwd.getpwnam(group).pw_gid

2486

gid = pwd.getpwnam(name).pw_gid

3143

2487

break

3144

2488

except KeyError:

3145

2489

continue

3149

2493

try:

3150

2494

os.setgid(gid)

3151

2495

os.setuid(uid)

3152

if debug:

3153

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

3154

gid))

3155

2496

except OSError as error:

3156

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

3157

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

3158

2497

if error.errno != errno.EPERM:

3159

2498

raise

3160

2499

3161

2500

if debug:

3162

2501

# Enable all possible GnuTLS debugging

3163

2502

3164

2503

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

3165

2504

# - GnuTLS manual

3166

gnutls.global_set_log_level(11)

3167

3168

@gnutls.log_func

2505

gnutls.library.functions.gnutls_global_set_log_level(11)

2506

2507

@gnutls.library.types.gnutls_log_func

3169

2508

def debug_gnutls(level, string):

3170

2509

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

3171

3172

gnutls.global_set_log_function(debug_gnutls)

3173

2510

2511

(gnutls.library.functions

2512

.gnutls_global_set_log_function(debug_gnutls))

2513

3174

2514

# Redirect stdin so all checkers get /dev/null

3175

2515

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

3176

2516

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

3177

2517

if null > 2:

3178

2518

os.close(null)

3179

2519

3180

2520

# Need to fork before connecting to D-Bus

3181

2521

if not foreground:

3182

2522

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

3183

2523

daemon()

3184

3185

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

3186

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

3187

# need to inform GLib that threads will be used.

3188

GLib.threads_init()

3189

2524

2525

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

2526

# need to inform gobject that threads will be used.

2527

gobject.threads_init()

2528

3190

2529

global main_loop

3191

2530

# From the Avahi example code

3192

2531

DBusGMainLoop(set_as_default=True)

3193

main_loop = GLib.MainLoop()

2532

main_loop = gobject.MainLoop()

3194

2533

bus = dbus.SystemBus()

3195

2534

# End of Avahi example code

3196

2535

if use_dbus:

3197

2536

try:

3198

2537

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

3199

bus,

3200

do_not_queue=True)

3201

old_bus_name = dbus.service.BusName(

3202

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

3203

do_not_queue=True)

3204

except dbus.exceptions.DBusException as e:

2538

bus, do_not_queue=True)

2539

old_bus_name = (dbus.service.BusName

2540

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

2541

do_not_queue=True))

2542

except dbus.exceptions.NameExistsException as e:

3205

2543

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

3206

2544

use_dbus = False

3207

2545

server_settings["use_dbus"] = False

3208

2546

tcp_server.use_dbus = False

3209

2547

if zeroconf:

3210

2548

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3211

service = AvahiServiceToSyslog(

3212

name=server_settings["servicename"],

3213

servicetype="_mandos._tcp",

3214

protocol=protocol,

3215

bus=bus)

2549

service = AvahiServiceToSyslog(name =

2550

server_settings["servicename"],

2551

servicetype = "_mandos._tcp",

2552

protocol = protocol, bus = bus)

3216

2553

if server_settings["interface"]:

3217

service.interface = if_nametoindex(

3218

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

3219

2554

service.interface = (if_nametoindex

2555

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

2556

3220

2557

global multiprocessing_manager

3221

2558

multiprocessing_manager = multiprocessing.Manager()

3222

2559

3223

2560

client_class = Client

3224

2561

if use_dbus:

3225

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

3226

2562

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

2563

3227

2564

client_settings = Client.config_parser(client_config)

3228

2565

old_client_settings = {}

3229

2566

clients_data = {}

3230

2567

3231

2568

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

3232

2569

global wnull

3233

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

2570

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

3234

2571

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

3235

2572

# mode

3236

2573

if debug or not foreground:

3237

2574

wnull.close()

3238

2575

3239

2576

# Get client data and settings from last running state.

3240

2577

if server_settings["restore"]:

3241

2578

try:

3242

2579

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

3243

if sys.version_info.major == 2:

3244

clients_data, old_client_settings = pickle.load(

3245

stored_state)

3246

else:

3247

bytes_clients_data, bytes_old_client_settings = (

3248

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

3249

# Fix bytes to strings

3250

# clients_data

3251

# .keys()

3252

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

3253

if isinstance(key, bytes)

3254

else key): value

3255

for key, value in

3256

bytes_clients_data.items()}

3257

del bytes_clients_data

3258

for key in clients_data:

3259

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

3260

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

3261

for k, v in

3262

clients_data[key].items()}

3263

clients_data[key] = value

3264

# .client_structure

3265

value["client_structure"] = [

3266

(s.decode("utf-8")

3267

if isinstance(s, bytes)

3268

else s) for s in

3269

value["client_structure"]]

3270

# .name, .host, and .checker_command

3271

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

3272

if isinstance(value[k], bytes):

3273

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

3274

if "key_id" not in value:

3275

value["key_id"] = ""

3276

elif "fingerprint" not in value:

3277

value["fingerprint"] = ""

3278

# old_client_settings

3279

# .keys()

3280

old_client_settings = {

3281

(key.decode("utf-8")

3282

if isinstance(key, bytes)

3283

else key): value

3284

for key, value in

3285

bytes_old_client_settings.items()}

3286

del bytes_old_client_settings

3287

# .host and .checker_command

3288

for value in old_client_settings.values():

3289

for attribute in ("host", "checker_command"):

3290

if isinstance(value[attribute], bytes):

3291

value[attribute] = (value[attribute]

3292

.decode("utf-8"))

2580

clients_data, old_client_settings = (pickle.load

2581

(stored_state))

3293

2582

os.remove(stored_state_path)

3294

2583

except IOError as e:

3295

2584

if e.errno == errno.ENOENT:

3296

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

3297

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

2585

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

2586

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

3298

2587

else:

3299

2588

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

3300

2589

exc_info=e)

3301

2590

raise

3302

2591

except EOFError as e:

3303

2592

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

3304

"EOFError:",

3305

exc_info=e)

3306

2593

"EOFError:", exc_info=e)

2594

3307

2595

with PGPEngine() as pgp:

3308

2596

for client_name, client in clients_data.items():

3309

2597

# Skip removed clients

3310

2598

if client_name not in client_settings:

3311

2599

continue

3312

2600

3313

2601

# Decide which value to use after restoring saved state.

3314

2602

# We have three different values: Old config file,

3315

2603

# new config file, and saved state.

3320

2608

# For each value in new config, check if it

3321

2609

# differs from the old config value (Except for

3322

2610

# the "secret" attribute)

3323

if (name != "secret"

3324

and (value !=

3325

old_client_settings[client_name][name])):

2611

if (name != "secret" and

2612

value != old_client_settings[client_name]

2613

[name]):

3326

2614

client[name] = value

3327

2615

except KeyError:

3328

2616

pass

3329

2617

3330

2618

# Clients who has passed its expire date can still be

3331

# enabled if its last checker was successful. A Client

2619

# enabled if its last checker was successful. Clients

3332

2620

# whose checker succeeded before we stored its state is

3333

2621

# assumed to have successfully run all checkers during

3334

2622

# downtime.

3337

2625

if not client["last_checked_ok"]:

3338

2626

logger.warning(

3339

2627

"disabling client {} - Client never "

3340

"performed a successful checker".format(

3341

client_name))

2628

"performed a successful checker"

2629

.format(client_name))

3342

2630

client["enabled"] = False

3343

2631

elif client["last_checker_status"] != 0:

3344

2632

logger.warning(

3345

2633

"disabling client {} - Client last"

3346

" checker failed with error code"

3347

" {}".format(

3348

client_name,

3349

client["last_checker_status"]))

2634

" checker failed with error code {}"

2635

.format(client_name,

2636

client["last_checker_status"]))

3350

2637

client["enabled"] = False

3351

2638

else:

3352

client["expires"] = (

3353

datetime.datetime.utcnow()

3354

+ client["timeout"])

2639

client["expires"] = (datetime.datetime

2640

.utcnow()

2641

+ client["timeout"])

3355

2642

logger.debug("Last checker succeeded,"

3356

" keeping {} enabled".format(

3357

client_name))

2643

" keeping {} enabled"

2644

.format(client_name))

3358

2645

try:

3359

client["secret"] = pgp.decrypt(

3360

client["encrypted_secret"],

3361

client_settings[client_name]["secret"])

2646

client["secret"] = (

2647

pgp.decrypt(client["encrypted_secret"],

2648

client_settings[client_name]

2649

["secret"]))

3362

2650

except PGPError:

3363

2651

# If decryption fails, we use secret from new settings

3364

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

3365

client_name))

3366

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

3367

["secret"])

3368

2652

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

2653

.format(client_name))

2654

client["secret"] = (

2655

client_settings[client_name]["secret"])

2656

3369

2657

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

3370

2658

for client_name in (set(old_client_settings)

3371

2659

- set(client_settings)):

3373

2661

for client_name in (set(client_settings)

3374

2662

- set(old_client_settings)):

3375

2663

clients_data[client_name] = client_settings[client_name]

3376

2664

3377

2665

# Create all client objects

3378

2666

for client_name, client in clients_data.items():

3379

2667

tcp_server.clients[client_name] = client_class(

3380

name=client_name,

3381

settings=client,

3382

server_settings=server_settings)

3383

2668

name = client_name, settings = client,

2669

server_settings = server_settings)

2670

3384

2671

if not tcp_server.clients:

3385

2672

logger.warning("No clients defined")

3386

2673

3387

2674

if not foreground:

3388

2675

if pidfile is not None:

3389

pid = os.getpid()

3390

2676

try:

3391

2677

with pidfile:

3392

print(pid, file=pidfile)

2678

pid = os.getpid()

2679

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

3393

2680

except IOError:

3394

2681

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

3395

2682

pidfilename, pid)

3396

2683

del pidfile

3397

2684

del pidfilename

3398

3399

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

3400

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3401

lambda: main_loop.quit() and False)

3402

2685

2686

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

2687

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

2688

3403

2689

if use_dbus:

3404

3405

@alternate_dbus_interfaces(

3406

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

3407

class MandosDBusService(DBusObjectWithObjectManager):

2690

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

2691

"se.bsnet.fukt.Mandos"})

2692

class MandosDBusService(DBusObjectWithProperties):

3408

2693

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

3409

3410

2694

def __init__(self):

3411

2695

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

3412

3413

2696

_interface = "se.recompile.Mandos"

3414

2697

2698

@dbus_interface_annotations(_interface)

2699

def _foo(self):

2700

return { "org.freedesktop.DBus.Property"

2701

".EmitsChangedSignal":

2702

"false"}

2703

3415

2704

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

3416

2705

def ClientAdded(self, objpath):

3417

2706

"D-Bus signal"

3418

2707

pass

3419

2708

3420

2709

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

3421

def ClientNotFound(self, key_id, address):

2710

def ClientNotFound(self, fingerprint, address):

3422

2711

"D-Bus signal"

3423

2712

pass

3424

3425

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

3426

"true"})

2713

3427

2714

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

3428

2715

def ClientRemoved(self, objpath, name):

3429

2716

"D-Bus signal"

3430

2717

pass

3431

3432

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

3433

"true"})

2718

3434

2719

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

3435

2720

def GetAllClients(self):

3436

2721

"D-Bus method"

3437

return dbus.Array(c.dbus_object_path for c in

3438

tcp_server.clients.values())

3439

3440

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

3441

"true"})

2722

return dbus.Array(c.dbus_object_path

2723

for c in

2724

tcp_server.clients.itervalues())

2725

3442

2726

@dbus.service.method(_interface,

3443

2727

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

3444

2728

def GetAllClientsWithProperties(self):

3445

2729

"D-Bus method"

3446

2730

return dbus.Dictionary(

3447

{c.dbus_object_path: c.GetAll(

3448

"se.recompile.Mandos.Client")

3449

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

2731

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

2732

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

3450

2733

signature="oa{sv}")

3451

2734

3452

2735

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

3453

2736

def RemoveClient(self, object_path):

3454

2737

"D-Bus method"

3455

for c in tcp_server.clients.values():

2738

for c in tcp_server.clients.itervalues():

3456

2739

if c.dbus_object_path == object_path:

3457

2740

del tcp_server.clients[c.name]

3458

2741

c.remove_from_connection()

3459

# Don't signal the disabling

2742

# Don't signal anything except ClientRemoved

3460

2743

c.disable(quiet=True)

3461

# Emit D-Bus signal for removal

3462

self.client_removed_signal(c)

2744

# Emit D-Bus signal

2745

self.ClientRemoved(object_path, c.name)

3463

2746

return

3464

2747

raise KeyError(object_path)

3465

2748

3466

2749

del _interface

3467

3468

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3469

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

3470

def GetManagedObjects(self):

3471

"""D-Bus method"""

3472

return dbus.Dictionary(

3473

{client.dbus_object_path:

3474

dbus.Dictionary(

3475

{interface: client.GetAll(interface)

3476

for interface in

3477

client._get_all_interface_names()})

3478

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

3479

3480

def client_added_signal(self, client):

3481

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

3482

if use_dbus:

3483

# New standard signal

3484

self.InterfacesAdded(

3485

client.dbus_object_path,

3486

dbus.Dictionary(

3487

{interface: client.GetAll(interface)

3488

for interface in

3489

client._get_all_interface_names()}))

3490

# Old signal

3491

self.ClientAdded(client.dbus_object_path)

3492

3493

def client_removed_signal(self, client):

3494

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

3495

if use_dbus:

3496

# New standard signal

3497

self.InterfacesRemoved(

3498

client.dbus_object_path,

3499

client._get_all_interface_names())

3500

# Old signal

3501

self.ClientRemoved(client.dbus_object_path,

3502

client.name)

3503

2750

3504

2751

mandos_dbus_service = MandosDBusService()

3505

3506

# Save modules to variables to exempt the modules from being

3507

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

3508

mp = multiprocessing

3509

wn = wnull

3510

2752

3511

2753

def cleanup():

3512

2754

"Cleanup function; run on exit"

3513

2755

if zeroconf:

3514

2756

service.cleanup()

3515

3516

mp.active_children()

3517

wn.close()

2757

2758

multiprocessing.active_children()

2759

wnull.close()

3518

2760

if not (tcp_server.clients or client_settings):

3519

2761

return

3520

2762

3521

2763

# Store client before exiting. Secrets are encrypted with key

3522

2764

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

3523

2765

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

3524

2766

clients = {}

3525

2767

with PGPEngine() as pgp:

3526

for client in tcp_server.clients.values():

2768

for client in tcp_server.clients.itervalues():

3527

2769

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

3528

2770

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

3529

2771

key)

3530

2772

client_dict = {}

3531

2773

3532

2774

# A list of attributes that can not be pickled

3533

2775

# + secret.

3534

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

3535

"checker", "server_settings"}

3536

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

3537

.Object):

2776

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

2777

"checker", "server_settings" }

2778

for name, typ in (inspect.getmembers

2779

(dbus.service.Object)):

3538

2780

exclude.add(name)

3539

2781

3540

2782

client_dict["encrypted_secret"] = (client

3541

2783

.encrypted_secret)

3542

2784

for attr in client.client_structure:

3543

2785

if attr not in exclude:

3544

2786

client_dict[attr] = getattr(client, attr)

3545

2787

3546

2788

clients[client.name] = client_dict

3547

2789

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

3548

2790

3549

2791

try:

3550

with tempfile.NamedTemporaryFile(

3551

mode='wb',

3552

suffix=".pickle",

3553

prefix='clients-',

3554

dir=os.path.dirname(stored_state_path),

3555

delete=False) as stored_state:

3556

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

3557

protocol=2)

3558

tempname = stored_state.name

2792

with (tempfile.NamedTemporaryFile

2793

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

2794

dir=os.path.dirname(stored_state_path),

2795

delete=False)) as stored_state:

2796

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

2797

tempname=stored_state.name

3559

2798

os.rename(tempname, stored_state_path)

3560

2799

except (IOError, OSError) as e:

3561

2800

if not debug:

3570

2809

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

3571

2810

exc_info=e)

3572

2811

raise

3573

2812

3574

2813

# Delete all clients, and settings from config

3575

2814

while tcp_server.clients:

3576

2815

name, client = tcp_server.clients.popitem()

3577

2816

if use_dbus:

3578

2817

client.remove_from_connection()

3579

# Don't signal the disabling

2818

# Don't signal anything except ClientRemoved

3580

2819

client.disable(quiet=True)

3581

# Emit D-Bus signal for removal

3582

2820

if use_dbus:

3583

mandos_dbus_service.client_removed_signal(client)

2821

# Emit D-Bus signal

2822

mandos_dbus_service.ClientRemoved(client

2823

.dbus_object_path,

2824

client.name)

3584

2825

client_settings.clear()

3585

2826

3586

2827

atexit.register(cleanup)

3587

3588

for client in tcp_server.clients.values():

2828

2829

for client in tcp_server.clients.itervalues():

3589

2830

if use_dbus:

3590

# Emit D-Bus signal for adding

3591

mandos_dbus_service.client_added_signal(client)

2831

# Emit D-Bus signal

2832

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3592

2833

# Need to initiate checking of clients

3593

2834

if client.enabled:

3594

2835

client.init_checker()

3595

2836

3596

2837

tcp_server.enable()

3597

2838

tcp_server.server_activate()

3598

2839

3599

2840

# Find out what port we got

3600

2841

if zeroconf:

3601

2842

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

3606

2847

else: # IPv4

3607

2848

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

3608

2849

*tcp_server.socket.getsockname())

3609

3610

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

3611

2850

2851

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

2852

3612

2853

try:

3613

2854

if zeroconf:

3614

2855

# From the Avahi example code

3619

2860

cleanup()

3620

2861

sys.exit(1)

3621

2862

# End of Avahi example code

3622

3623

GLib.io_add_watch(

3624

GLib.IOChannel.unix_new(tcp_server.fileno()),

3625

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3626

lambda *args, **kwargs: (tcp_server.handle_request

3627

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

3628

2863

2864

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

2865

lambda *args, **kwargs:

2866

(tcp_server.handle_request

2867

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

2868

3629

2869

logger.debug("Starting main loop")

3630

2870

main_loop.run()

3631

2871

except AvahiError as error:

3640

2880

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

3641

2881

cleanup()

3642

2882

3643

3644

def should_only_run_tests():

3645

parser = argparse.ArgumentParser(add_help=False)

3646

parser.add_argument("--check", action='store_true')

3647

args, unknown_args = parser.parse_known_args()

3648

run_tests = args.check

3649

if run_tests:

3650

# Remove --check argument from sys.argv

3651

sys.argv[1:] = unknown_args

3652

return run_tests

3653

3654

# Add all tests from doctest strings

3655

def load_tests(loader, tests, none):

3656

import doctest

3657

tests.addTests(doctest.DocTestSuite())

3658

return tests

3659

3660

2883

if __name__ == '__main__':

3661

try:

3662

if should_only_run_tests():

3663

# Call using ./mandos --check [--verbose]

3664

unittest.main()

3665

else:

3666

main()

3667

finally:

3668

logging.shutdown()

2884

main()