/mandos/release : revision 237.7.174

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

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

89

SO_BINDTODEVICE = None

90

91

version = "1.6.1"

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

syslogger = None

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

152

98

153

99

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

156

103

except (OSError, AttributeError):

157

158

104

def if_nametoindex(interface):

159

105

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

160

106

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

161

107

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

162

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

163

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

164

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

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

165

113

return interface_index

166

114

167

115

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

116

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

185

117

"""init logger and add loglevel"""

186

187

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

118

191

119

syslogger.setFormatter(logging.Formatter

192

120

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

193

121

' %(message)s'))

194

122

logger.addHandler(syslogger)

195

123

196

124

if debug:

197

125

console = logging.StreamHandler()

198

126

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

208

136

pass

209

137

210

138

211

class PGPEngine:

139

class PGPEngine(object):

212

140

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

213

214

141

def __init__(self):

215

142

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

143

self.gnupgargs = ['--batch',

228

'--homedir', self.tempdir,

144

'--home', self.tempdir,

229

145

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

146

'--quiet',

147

'--no-use-agent']

148

235

149

def __enter__(self):

236

150

return self

237

151

238

152

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

239

153

self._cleanup()

240

154

return False

241

155

242

156

def __del__(self):

243

157

self._cleanup()

244

158

245

159

def _cleanup(self):

246

160

if self.tempdir is not None:

247

161

# Delete contents of tempdir

248

162

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

249

topdown=False):

163

topdown = False):

250

164

for filename in files:

251

165

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

252

166

for dirname in dirs:

254

168

# Remove tempdir

255

169

os.rmdir(self.tempdir)

256

170

self.tempdir = None

257

171

258

172

def password_encode(self, password):

259

173

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

260

174

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

261

encoded = b"mandos" + binascii.hexlify(password)

262

if len(encoded) > 2048:

263

# GnuPG can't handle long passwords, so encode differently

264

encoded = (b"mandos" + password.replace(b"\\", b"\\\\")

265

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

266

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

267

return encoded

268

175

return b"mandos" + binascii.hexlify(password)

176

269

177

def encrypt(self, data, password):

270

178

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

179

with tempfile.NamedTemporaryFile(dir=self.tempdir

180

) as passfile:

273

181

passfile.write(passphrase)

274

182

passfile.flush()

275

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

183

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

276

184

'--passphrase-file',

277

185

passfile.name]

278

186

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

187

stdin = subprocess.PIPE,

188

stdout = subprocess.PIPE,

189

stderr = subprocess.PIPE)

190

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

283

191

if proc.returncode != 0:

284

192

raise PGPError(err)

285

193

return ciphertext

286

194

287

195

def decrypt(self, data, password):

288

196

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

197

with tempfile.NamedTemporaryFile(dir = self.tempdir

198

) as passfile:

291

199

passfile.write(passphrase)

292

200

passfile.flush()

293

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

201

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

294

202

'--passphrase-file',

295

203

passfile.name]

296

204

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

205

stdin = subprocess.PIPE,

206

stdout = subprocess.PIPE,

207

stderr = subprocess.PIPE)

208

decrypted_plaintext, err = proc.communicate(input

209

= data)

301

210

if proc.returncode != 0:

302

211

raise PGPError(err)

303

212

return decrypted_plaintext

304

213

305

214

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

215

class AvahiError(Exception):

333

216

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

334

217

self.value = value

335

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

336

**kwargs)

337

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

338

221

339

222

class AvahiServiceError(AvahiError):

340

223

pass

341

224

342

343

225

class AvahiGroupError(AvahiError):

344

226

pass

345

227

346

228

347

class AvahiService:

229

class AvahiService(object):

348

230

"""An Avahi (Zeroconf) service.

349

231

350

232

Attributes:

351

233

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

352

234

Used to optionally bind to the specified interface.

364

246

server: D-Bus Server

365

247

bus: dbus.SystemBus()

366

248

"""

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

249

250

def __init__(self, interface = avahi.IF_UNSPEC, name = None,

251

servicetype = None, port = None, TXT = None,

252

domain = "", host = "", max_renames = 32768,

253

protocol = avahi.PROTO_UNSPEC, bus = None):

379

254

self.interface = interface

380

255

self.name = name

381

256

self.type = servicetype

390

265

self.server = None

391

266

self.bus = bus

392

267

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

268

269

def rename(self):

395

270

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

396

271

if self.rename_count >= self.max_renames:

397

272

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

398

273

" after %i retries, exiting.",

399

274

self.rename_count)

400

275

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

404

278

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

405

279

self.name)

406

if remove:

407

self.remove()

280

self.remove()

408

281

try:

409

282

self.add()

410

283

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

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

288

420

289

def remove(self):

421

290

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

422

291

if self.entry_group_state_changed_match is not None:

424

293

self.entry_group_state_changed_match = None

425

294

if self.group is not None:

426

295

self.group.Reset()

427

296

428

297

def add(self):

429

298

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

430

299

self.remove()

447

316

dbus.UInt16(self.port),

448

317

avahi.string_array_to_txt_array(self.TXT))

449

318

self.group.Commit()

450

319

451

320

def entry_group_state_changed(self, state, error):

452

321

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

453

322

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

454

323

455

324

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

325

logger.debug("Zeroconf service established.")

457

326

elif state == avahi.ENTRY_GROUP_COLLISION:

459

328

self.rename()

460

329

elif state == avahi.ENTRY_GROUP_FAILURE:

461

330

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

462

str(error))

463

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

464

331

unicode(error))

332

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

333

.format(error))

334

465

335

def cleanup(self):

466

336

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

467

337

if self.group is not None:

472

342

pass

473

343

self.group = None

474

344

self.remove()

475

345

476

346

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

477

347

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

478

348

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

}

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

485

356

if state in bad_states:

486

357

if bad_states[state] is not None:

487

358

if error is None:

490

361

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

491

362

self.cleanup()

492

363

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)

364

self.add()

505

365

else:

506

366

if error is None:

507

367

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

508

368

else:

509

369

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

510

370

511

371

def activate(self):

512

372

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

513

373

if self.server is None:

517

377

follow_name_owner_changes=True),

518

378

avahi.DBUS_INTERFACE_SERVER)

519

379

self.server.connect_to_signal("StateChanged",

520

self.server_state_changed)

380

self.server_state_changed)

521

381

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

522

382

523

383

524

384

class AvahiServiceToSyslog(AvahiService):

525

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

385

def rename(self):

526

386

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

527

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

528

**kwargs)

529

syslogger.setFormatter(logging.Formatter(

530

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

531

.format(self.name)))

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

532

392

return ret

533

393

534

394

535

# Pretend that we have a GnuTLS module

536

class gnutls:

537

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

538

539

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

540

if library is None:

541

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

542

_library = ctypes.cdll.LoadLibrary(library)

543

del library

544

545

# Unless otherwise indicated, the constants and types below are

546

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

547

548

# Constants

549

E_SUCCESS = 0

550

E_INTERRUPTED = -52

551

E_AGAIN = -28

552

CRT_OPENPGP = 2

553

CRT_RAWPK = 3

554

CLIENT = 2

555

SHUT_RDWR = 0

556

CRD_CERTIFICATE = 1

557

E_NO_CERTIFICATE_FOUND = -49

558

X509_FMT_DER = 0

559

NO_TICKETS = 1<<10

560

ENABLE_RAWPK = 1<<18

561

CTYPE_PEERS = 3

562

KEYID_USE_SHA256 = 1 # gnutls/x509.h

563

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

564

565

# Types

566

class _session_int(ctypes.Structure):

567

_fields_ = []

568

session_t = ctypes.POINTER(_session_int)

569

570

class certificate_credentials_st(ctypes.Structure):

571

_fields_ = []

572

certificate_credentials_t = ctypes.POINTER(

573

certificate_credentials_st)

574

certificate_type_t = ctypes.c_int

575

576

class datum_t(ctypes.Structure):

577

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

578

('size', ctypes.c_uint)]

579

580

class _openpgp_crt_int(ctypes.Structure):

581

_fields_ = []

582

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

583

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

584

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

585

credentials_type_t = ctypes.c_int

586

transport_ptr_t = ctypes.c_void_p

587

close_request_t = ctypes.c_int

588

589

# Exceptions

590

class Error(Exception):

591

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

592

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

593

# code is passed, convert it to a string with

594

# gnutls.strerror()

595

self.code = code

596

if message is None and code is not None:

597

message = gnutls.strerror(code).decode(

598

"utf-8", errors="replace")

599

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

600

message, *args)

601

602

class CertificateSecurityError(Error):

603

pass

604

605

class PointerTo:

606

def __init__(self, cls):

607

self.cls = cls

608

609

def from_param(self, obj):

610

if not isinstance(obj, self.cls):

611

raise TypeError("Not of type {}: {!r}"

612

.format(self.cls.__name__, obj))

613

return ctypes.byref(obj.from_param(obj))

614

615

class CastToVoidPointer:

616

def __init__(self, cls):

617

self.cls = cls

618

619

def from_param(self, obj):

620

if not isinstance(obj, self.cls):

621

raise TypeError("Not of type {}: {!r}"

622

.format(self.cls.__name__, obj))

623

return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)

624

625

class With_from_param:

626

@classmethod

627

def from_param(cls, obj):

628

return obj._as_parameter_

629

630

# Classes

631

class Credentials(With_from_param):

632

def __init__(self):

633

self._as_parameter_ = gnutls.certificate_credentials_t()

634

gnutls.certificate_allocate_credentials(self)

635

self.type = gnutls.CRD_CERTIFICATE

636

637

def __del__(self):

638

gnutls.certificate_free_credentials(self)

639

640

class ClientSession(With_from_param):

641

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

642

self._as_parameter_ = gnutls.session_t()

643

gnutls_flags = gnutls.CLIENT

644

if gnutls.check_version(b"3.5.6"):

645

gnutls_flags |= gnutls.NO_TICKETS

646

if gnutls.has_rawpk:

647

gnutls_flags |= gnutls.ENABLE_RAWPK

648

gnutls.init(self, gnutls_flags)

649

del gnutls_flags

650

gnutls.set_default_priority(self)

651

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

652

gnutls.handshake_set_private_extensions(self, True)

653

self.socket = socket

654

if credentials is None:

655

credentials = gnutls.Credentials()

656

gnutls.credentials_set(self, credentials.type,

657

credentials)

658

self.credentials = credentials

659

660

def __del__(self):

661

gnutls.deinit(self)

662

663

def handshake(self):

664

return gnutls.handshake(self)

665

666

def send(self, data):

667

data = bytes(data)

668

data_len = len(data)

669

while data_len > 0:

670

data_len -= gnutls.record_send(self, data[-data_len:],

671

data_len)

672

673

def bye(self):

674

return gnutls.bye(self, gnutls.SHUT_RDWR)

675

676

# Error handling functions

677

def _error_code(result):

678

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

679

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

680

if result >= gnutls.E_SUCCESS:

681

return result

682

if result == gnutls.E_NO_CERTIFICATE_FOUND:

683

raise gnutls.CertificateSecurityError(code=result)

684

raise gnutls.Error(code=result)

685

686

def _retry_on_error(result, func, arguments,

687

_error_code=_error_code):

688

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

689

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

690

while result < gnutls.E_SUCCESS:

691

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

692

return _error_code(result)

693

result = func(*arguments)

694

return result

695

696

# Unless otherwise indicated, the function declarations below are

697

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

698

699

# Functions

700

priority_set_direct = _library.gnutls_priority_set_direct

701

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

702

ctypes.POINTER(ctypes.c_char_p)]

703

priority_set_direct.restype = _error_code

704

705

init = _library.gnutls_init

706

init.argtypes = [PointerTo(ClientSession), ctypes.c_int]

707

init.restype = _error_code

708

709

set_default_priority = _library.gnutls_set_default_priority

710

set_default_priority.argtypes = [ClientSession]

711

set_default_priority.restype = _error_code

712

713

record_send = _library.gnutls_record_send

714

record_send.argtypes = [ClientSession, ctypes.c_void_p,

715

ctypes.c_size_t]

716

record_send.restype = ctypes.c_ssize_t

717

record_send.errcheck = _retry_on_error

718

719

certificate_allocate_credentials = (

720

_library.gnutls_certificate_allocate_credentials)

721

certificate_allocate_credentials.argtypes = [

722

PointerTo(Credentials)]

723

certificate_allocate_credentials.restype = _error_code

724

725

certificate_free_credentials = (

726

_library.gnutls_certificate_free_credentials)

727

certificate_free_credentials.argtypes = [Credentials]

728

certificate_free_credentials.restype = None

729

730

handshake_set_private_extensions = (

731

_library.gnutls_handshake_set_private_extensions)

732

handshake_set_private_extensions.argtypes = [ClientSession,

733

ctypes.c_int]

734

handshake_set_private_extensions.restype = None

735

736

credentials_set = _library.gnutls_credentials_set

737

credentials_set.argtypes = [ClientSession, credentials_type_t,

738

CastToVoidPointer(Credentials)]

739

credentials_set.restype = _error_code

740

741

strerror = _library.gnutls_strerror

742

strerror.argtypes = [ctypes.c_int]

743

strerror.restype = ctypes.c_char_p

744

745

certificate_type_get = _library.gnutls_certificate_type_get

746

certificate_type_get.argtypes = [ClientSession]

747

certificate_type_get.restype = _error_code

748

749

certificate_get_peers = _library.gnutls_certificate_get_peers

750

certificate_get_peers.argtypes = [ClientSession,

751

ctypes.POINTER(ctypes.c_uint)]

752

certificate_get_peers.restype = ctypes.POINTER(datum_t)

753

754

global_set_log_level = _library.gnutls_global_set_log_level

755

global_set_log_level.argtypes = [ctypes.c_int]

756

global_set_log_level.restype = None

757

758

global_set_log_function = _library.gnutls_global_set_log_function

759

global_set_log_function.argtypes = [log_func]

760

global_set_log_function.restype = None

761

762

deinit = _library.gnutls_deinit

763

deinit.argtypes = [ClientSession]

764

deinit.restype = None

765

766

handshake = _library.gnutls_handshake

767

handshake.argtypes = [ClientSession]

768

handshake.restype = ctypes.c_int

769

handshake.errcheck = _retry_on_error

770

771

transport_set_ptr = _library.gnutls_transport_set_ptr

772

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

773

transport_set_ptr.restype = None

774

775

bye = _library.gnutls_bye

776

bye.argtypes = [ClientSession, close_request_t]

777

bye.restype = ctypes.c_int

778

bye.errcheck = _retry_on_error

779

780

check_version = _library.gnutls_check_version

781

check_version.argtypes = [ctypes.c_char_p]

782

check_version.restype = ctypes.c_char_p

783

784

_need_version = b"3.3.0"

785

if check_version(_need_version) is None:

786

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

787

.format(_need_version))

788

789

_tls_rawpk_version = b"3.6.6"

790

has_rawpk = bool(check_version(_tls_rawpk_version))

791

792

if has_rawpk:

793

# Types

794

class pubkey_st(ctypes.Structure):

795

_fields = []

796

pubkey_t = ctypes.POINTER(pubkey_st)

797

798

x509_crt_fmt_t = ctypes.c_int

799

800

# All the function declarations below are from

801

# gnutls/abstract.h

802

pubkey_init = _library.gnutls_pubkey_init

803

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

804

pubkey_init.restype = _error_code

805

806

pubkey_import = _library.gnutls_pubkey_import

807

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

808

x509_crt_fmt_t]

809

pubkey_import.restype = _error_code

810

811

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

812

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

813

ctypes.POINTER(ctypes.c_ubyte),

814

ctypes.POINTER(ctypes.c_size_t)]

815

pubkey_get_key_id.restype = _error_code

816

817

pubkey_deinit = _library.gnutls_pubkey_deinit

818

pubkey_deinit.argtypes = [pubkey_t]

819

pubkey_deinit.restype = None

820

else:

821

# All the function declarations below are from

822

# gnutls/openpgp.h

823

824

openpgp_crt_init = _library.gnutls_openpgp_crt_init

825

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

826

openpgp_crt_init.restype = _error_code

827

828

openpgp_crt_import = _library.gnutls_openpgp_crt_import

829

openpgp_crt_import.argtypes = [openpgp_crt_t,

830

ctypes.POINTER(datum_t),

831

openpgp_crt_fmt_t]

832

openpgp_crt_import.restype = _error_code

833

834

openpgp_crt_verify_self = \

835

_library.gnutls_openpgp_crt_verify_self

836

openpgp_crt_verify_self.argtypes = [

837

openpgp_crt_t,

838

ctypes.c_uint,

839

ctypes.POINTER(ctypes.c_uint),

840

]

841

openpgp_crt_verify_self.restype = _error_code

842

843

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

844

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

845

openpgp_crt_deinit.restype = None

846

847

openpgp_crt_get_fingerprint = (

848

_library.gnutls_openpgp_crt_get_fingerprint)

849

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

850

ctypes.c_void_p,

851

ctypes.POINTER(

852

ctypes.c_size_t)]

853

openpgp_crt_get_fingerprint.restype = _error_code

854

855

if check_version(b"3.6.4"):

856

certificate_type_get2 = _library.gnutls_certificate_type_get2

857

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

858

certificate_type_get2.restype = _error_code

859

860

# Remove non-public functions

861

del _error_code, _retry_on_error

862

863

864

def call_pipe(connection, # : multiprocessing.Connection

865

func, *args, **kwargs):

866

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

867

868

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

869

return value on the provided multiprocessing.Connection.

870

"""

871

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

872

connection.close()

873

874

875

class Client:

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

400

401

402

class Client(object):

876

403

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

877

404

878

405

Attributes:

879

406

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

880

407

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

881

408

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

882

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

883

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

884

running.

885

checker_callback_tag: a GLib event source tag, or None

409

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

410

to see if the client lives.

411

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

886

413

checker_command: string; External command which is run to check

887

414

if client lives. %() expansions are done at

888

415

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

889

416

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

890

checker_initiator_tag: a GLib event source tag, or None

417

checker_initiator_tag: a gobject event source tag, or None

891

418

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

892

419

client_structure: Object describing what attributes a client has

893

420

and is used for storing the client at exit

894

421

current_checker_command: string; current running checker_command

895

disable_initiator_tag: a GLib event source tag, or None

422

disable_initiator_tag: a gobject event source tag, or None

896

423

enabled: bool()

897

424

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

898

uniquely identify an OpenPGP client

899

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

900

a client using raw public keys

425

uniquely identify the client

901

426

host: string; available for use by the checker command

902

427

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

903

428

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

905

430

last_checker_status: integer between 0 and 255 reflecting exit

906

431

status of last checker. -1 reflects crashed

907

432

checker, -2 means no checker completed yet.

908

last_checker_signal: The signal which killed the last checker, if

909

last_checker_status is -1

910

433

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

911

434

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

912

435

D-Bus identifiers

919

442

disabled, or None

920

443

server_settings: The server_settings dict from main()

921

444

"""

922

445

923

446

runtime_expansions = ("approval_delay", "approval_duration",

924

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

447

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

925

448

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

926

449

"last_approval_request", "last_checked_ok",

927

450

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

928

client_defaults = {

929

"timeout": "PT5M",

930

"extended_timeout": "PT15M",

931

"interval": "PT2M",

932

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

933

"host": "",

934

"approval_delay": "PT0S",

935

"approval_duration": "PT1S",

936

"approved_by_default": "True",

937

"enabled": "True",

938

}

939

451

client_defaults = { "timeout": "PT5M",

452

"extended_timeout": "PT15M",

453

"interval": "PT2M",

454

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

455

"host": "",

456

"approval_delay": "PT0S",

457

"approval_duration": "PT1S",

458

"approved_by_default": "True",

459

"enabled": "True",

460

}

461

462

def timeout_milliseconds(self):

463

"Return the 'timeout' attribute in milliseconds"

464

return timedelta_to_milliseconds(self.timeout)

465

466

def extended_timeout_milliseconds(self):

467

"Return the 'extended_timeout' attribute in milliseconds"

468

return timedelta_to_milliseconds(self.extended_timeout)

469

470

def interval_milliseconds(self):

471

"Return the 'interval' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.interval)

473

474

def approval_delay_milliseconds(self):

475

return timedelta_to_milliseconds(self.approval_delay)

476

940

477

@staticmethod

941

478

def config_parser(config):

942

479

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

949

486

for client_name in config.sections():

950

487

section = dict(config.items(client_name))

951

488

client = settings[client_name] = {}

952

489

953

490

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

954

491

# Reformat values from string types to Python types

955

492

client["approved_by_default"] = config.getboolean(

956

493

client_name, "approved_by_default")

957

494

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

958

495

"enabled")

959

960

# Uppercase and remove spaces from key_id and fingerprint

961

# for later comparison purposes with return value from the

962

# key_id() and fingerprint() functions

963

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

964

.replace(" ", ""))

496

965

497

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

966

498

.replace(" ", ""))

967

499

if "secret" in section:

968

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

969

.encode("utf-8"),

970

"base64")

500

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

971

501

elif "secfile" in section:

972

502

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

973

503

(section["secfile"])),

974

504

"rb") as secfile:

975

505

client["secret"] = secfile.read()

976

506

else:

977

raise TypeError("No secret or secfile for section {}"

507

raise TypeError("No secret or secfile for section {0}"

978

508

.format(section))

979

509

client["timeout"] = string_to_delta(section["timeout"])

980

510

client["extended_timeout"] = string_to_delta(

988

518

client["last_approval_request"] = None

989

519

client["last_checked_ok"] = None

990

520

client["last_checker_status"] = -2

991

521

992

522

return settings

993

994

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

523

524

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

995

525

self.name = name

996

526

if server_settings is None:

997

527

server_settings = {}

998

528

self.server_settings = server_settings

999

529

# adding all client settings

1000

for setting, value in settings.items():

530

for setting, value in settings.iteritems():

1001

531

setattr(self, setting, value)

1002

532

1003

533

if self.enabled:

1004

534

if not hasattr(self, "last_enabled"):

1005

535

self.last_enabled = datetime.datetime.utcnow()

1009

539

else:

1010

540

self.last_enabled = None

1011

541

self.expires = None

1012

542

1013

543

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

1014

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

544

# Uppercase and remove spaces from fingerprint for later

545

# comparison purposes with return value from the fingerprint()

546

# function

1015

547

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

1016

548

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

1017

549

datetime.datetime.utcnow())

1018

550

1019

551

# attributes specific for this server instance

1020

552

self.checker = None

1021

553

self.checker_initiator_tag = None

1024

556

self.current_checker_command = None

1025

557

self.approved = None

1026

558

self.approvals_pending = 0

1027

self.changedstate = multiprocessing_manager.Condition(

1028

multiprocessing_manager.Lock())

1029

self.client_structure = [attr

1030

for attr in self.__dict__.keys()

559

self.changedstate = (multiprocessing_manager

560

.Condition(multiprocessing_manager

561

.Lock()))

562

self.client_structure = [attr for attr in

563

self.__dict__.iterkeys()

1031

564

if not attr.startswith("_")]

1032

565

self.client_structure.append("client_structure")

1033

1034

for name, t in inspect.getmembers(

1035

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

566

567

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

568

lambda obj:

569

isinstance(obj,

570

property)):

1036

571

if not name.startswith("_"):

1037

572

self.client_structure.append(name)

1038

573

1039

574

# Send notice to process children that client state has changed

1040

575

def send_changedstate(self):

1041

576

with self.changedstate:

1042

577

self.changedstate.notify_all()

1043

578

1044

579

def enable(self):

1045

580

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

1046

581

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

1051

586

self.last_enabled = datetime.datetime.utcnow()

1052

587

self.init_checker()

1053

588

self.send_changedstate()

1054

589

1055

590

def disable(self, quiet=True):

1056

591

"""Disable this client."""

1057

592

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

1059

594

if not quiet:

1060

595

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

1061

596

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

1062

GLib.source_remove(self.disable_initiator_tag)

597

gobject.source_remove(self.disable_initiator_tag)

1063

598

self.disable_initiator_tag = None

1064

599

self.expires = None

1065

600

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

1066

GLib.source_remove(self.checker_initiator_tag)

601

gobject.source_remove(self.checker_initiator_tag)

1067

602

self.checker_initiator_tag = None

1068

603

self.stop_checker()

1069

604

self.enabled = False

1070

605

if not quiet:

1071

606

self.send_changedstate()

1072

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

607

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

1073

608

return False

1074

609

1075

610

def __del__(self):

1076

611

self.disable()

1077

612

1078

613

def init_checker(self):

1079

614

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

1080

615

# and every interval from then on.

1081

616

if self.checker_initiator_tag is not None:

1082

GLib.source_remove(self.checker_initiator_tag)

1083

self.checker_initiator_tag = GLib.timeout_add(

1084

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

1085

+ 1)),

1086

self.start_checker)

617

gobject.source_remove(self.checker_initiator_tag)

618

self.checker_initiator_tag = (gobject.timeout_add

619

(self.interval_milliseconds(),

620

self.start_checker))

1087

621

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

1088

622

if self.disable_initiator_tag is not None:

1089

GLib.source_remove(self.disable_initiator_tag)

1090

self.disable_initiator_tag = GLib.timeout_add(

1091

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

623

gobject.source_remove(self.disable_initiator_tag)

624

self.disable_initiator_tag = (gobject.timeout_add

625

(self.timeout_milliseconds(),

626

self.disable))

1092

627

# Also start a new checker *right now*.

1093

628

self.start_checker()

1094

1095

def checker_callback(self, source, condition, connection,

1096

command):

629

630

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

1097

631

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

1098

# Read return code from connection (see call_pipe)

1099

returncode = connection.recv()

1100

connection.close()

1101

if self.checker is not None:

1102

self.checker.join()

1103

632

self.checker_callback_tag = None

1104

633

self.checker = None

1105

1106

if returncode >= 0:

1107

self.last_checker_status = returncode

1108

self.last_checker_signal = None

634

if os.WIFEXITED(condition):

635

self.last_checker_status = os.WEXITSTATUS(condition)

1109

636

if self.last_checker_status == 0:

1110

637

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

1111

638

vars(self))

1112

639

self.checked_ok()

1113

640

else:

1114

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

641

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

642

vars(self))

1115

643

else:

1116

644

self.last_checker_status = -1

1117

self.last_checker_signal = -returncode

1118

645

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

1119

646

vars(self))

1120

return False

1121

647

1122

648

def checked_ok(self):

1123

649

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

1124

650

self.last_checked_ok = datetime.datetime.utcnow()

1125

651

self.last_checker_status = 0

1126

self.last_checker_signal = None

1127

652

self.bump_timeout()

1128

653

1129

654

def bump_timeout(self, timeout=None):

1130

655

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

1131

656

if timeout is None:

1132

657

timeout = self.timeout

1133

658

if self.disable_initiator_tag is not None:

1134

GLib.source_remove(self.disable_initiator_tag)

659

gobject.source_remove(self.disable_initiator_tag)

1135

660

self.disable_initiator_tag = None

1136

661

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

1137

self.disable_initiator_tag = GLib.timeout_add(

1138

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

662

self.disable_initiator_tag = (gobject.timeout_add

663

(timedelta_to_milliseconds

664

(timeout), self.disable))

1139

665

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

1140

666

1141

667

def need_approval(self):

1142

668

self.last_approval_request = datetime.datetime.utcnow()

1143

669

1144

670

def start_checker(self):

1145

671

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

1146

672

1147

673

If a checker already exists, leave it running and do

1148

674

nothing."""

1149

675

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

1154

680

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

1155

681

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

1156

682

# should be.

1157

1158

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

1159

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

1160

self.checker.join()

1161

self.checker = None

683

684

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

685

try:

686

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

687

except (AttributeError, OSError) as error:

688

if (isinstance(error, OSError)

689

and error.errno != errno.ECHILD):

690

raise error

691

else:

692

if pid:

693

logger.warning("Checker was a zombie")

694

gobject.source_remove(self.checker_callback_tag)

695

self.checker_callback(pid, status,

696

self.current_checker_command)

1162

697

# Start a new checker if needed

1163

698

if self.checker is None:

1164

699

# Escape attributes for the shell

1165

escaped_attrs = {

1166

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

1167

for attr in self.runtime_expansions}

700

escaped_attrs = dict(

701

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

702

for attr in

703

self.runtime_expansions)

1168

704

try:

1169

705

command = self.checker_command % escaped_attrs

1170

706

except TypeError as error:

1171

707

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

1172

self.checker_command,

708

self.checker_command, exc_info=error)

709

return True # Try again later

710

self.current_checker_command = command

711

try:

712

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

713

command, self.name)

714

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

715

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

716

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

717

# always replaced by /dev/null.)

718

# The exception is when not debugging but nevertheless

719

# running in the foreground; use the previously

720

# created wnull.

721

popen_args = {}

722

if (not self.server_settings["debug"]

723

and self.server_settings["foreground"]):

724

popen_args.update({"stdout": wnull,

725

"stderr": wnull })

726

self.checker = subprocess.Popen(command,

727

close_fds=True,

728

shell=True, cwd="/",

729

**popen_args)

730

except OSError as error:

731

logger.error("Failed to start subprocess",

1173

732

exc_info=error)

1174

return True # Try again later

1175

self.current_checker_command = command

1176

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

1177

self.name)

1178

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

1179

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

1180

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

1181

# always replaced by /dev/null.)

1182

# The exception is when not debugging but nevertheless

1183

# running in the foreground; use the previously

1184

# created wnull.

1185

popen_args = {"close_fds": True,

1186

"shell": True,

1187

"cwd": "/"}

1188

if (not self.server_settings["debug"]

1189

and self.server_settings["foreground"]):

1190

popen_args.update({"stdout": wnull,

1191

"stderr": wnull})

1192

pipe = multiprocessing.Pipe(duplex=False)

1193

self.checker = multiprocessing.Process(

1194

target=call_pipe,

1195

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

1196

kwargs=popen_args)

1197

self.checker.start()

1198

self.checker_callback_tag = GLib.io_add_watch(

1199

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

1200

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1201

self.checker_callback, pipe[0], command)

1202

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

733

return True

734

self.checker_callback_tag = (gobject.child_watch_add

735

(self.checker.pid,

736

self.checker_callback,

737

data=command))

738

# The checker may have completed before the gobject

739

# watch was added. Check for this.

740

try:

741

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

742

except OSError as error:

743

if error.errno == errno.ECHILD:

744

# This should never happen

745

logger.error("Child process vanished",

746

exc_info=error)

747

return True

748

raise

749

if pid:

750

gobject.source_remove(self.checker_callback_tag)

751

self.checker_callback(pid, status, command)

752

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

1203

753

return True

1204

754

1205

755

def stop_checker(self):

1206

756

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

1207

757

if self.checker_callback_tag:

1208

GLib.source_remove(self.checker_callback_tag)

758

gobject.source_remove(self.checker_callback_tag)

1209

759

self.checker_callback_tag = None

1210

760

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

1211

761

return

1212

762

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

1213

self.checker.terminate()

763

try:

764

self.checker.terminate()

765

#time.sleep(0.5)

766

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

767

# self.checker.kill()

768

except OSError as error:

769

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

770

raise

1214

771

self.checker = None

1215

772

1216

773

1217

def dbus_service_property(dbus_interface,

1218

signature="v",

1219

access="readwrite",

1220

byte_arrays=False):

774

def dbus_service_property(dbus_interface, signature="v",

775

access="readwrite", byte_arrays=False):

1221

776

"""Decorators for marking methods of a DBusObjectWithProperties to

1222

777

become properties on the D-Bus.

1223

778

1224

779

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

1225

780

and with one argument by "Set".

1226

781

1227

782

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

1228

783

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

1229

784

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

1232

787

# "Set" method, so we fail early here:

1233

788

if byte_arrays and signature != "ay":

1234

789

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

1235

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

1236

790

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

1237

791

def decorator(func):

1238

792

func._dbus_is_property = True

1239

793

func._dbus_interface = dbus_interface

1242

796

func._dbus_name = func.__name__

1243

797

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

1244

798

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

1245

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

799

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1246

800

return func

1247

1248

801

return decorator

1249

802

1250

803

1251

804

def dbus_interface_annotations(dbus_interface):

1252

805

"""Decorator for marking functions returning interface annotations

1253

806

1254

807

Usage:

1255

808

1256

809

@dbus_interface_annotations("org.example.Interface")

1257

810

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

1258

811

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

1259

812

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

1260

813

"false"}

1261

814

"""

1262

1263

815

def decorator(func):

1264

816

func._dbus_is_interface = True

1265

817

func._dbus_interface = dbus_interface

1266

818

func._dbus_name = dbus_interface

1267

819

return func

1268

1269

820

return decorator

1270

821

1271

822

1272

823

def dbus_annotations(annotations):

1273

824

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

1274

825

Usage:

1275

1276

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

1277

"org.freedesktop.DBus.Property."

1278

"EmitsChangedSignal": "false"})

826

1279

827

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

1280

828

access="r")

829

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

830

"org.freedesktop.DBus.Property."

831

"EmitsChangedSignal": "false"})

1281

832

def Property_dbus_property(self):

1282

833

return dbus.Boolean(False)

1283

1284

See also the DBusObjectWithAnnotations class.

1285

834

"""

1286

1287

835

def decorator(func):

1288

836

func._dbus_annotations = annotations

1289

837

return func

1290

1291

838

return decorator

1292

839

1293

840

1294

841

class DBusPropertyException(dbus.exceptions.DBusException):

1295

842

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

1296

843

"""

1297

pass

844

def __unicode__(self):

845

return unicode(str(self))

1298

846

1299

847

1300

848

class DBusPropertyAccessException(DBusPropertyException):

1309

857

pass

1310

858

1311

859

1312

class DBusObjectWithAnnotations(dbus.service.Object):

1313

"""A D-Bus object with annotations.

1314

1315

Classes inheriting from this can use the dbus_annotations

1316

decorator to add annotations to methods or signals.

860

class DBusObjectWithProperties(dbus.service.Object):

861

"""A D-Bus object with properties.

862

863

Classes inheriting from this can use the dbus_service_property

864

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

865

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

1317

866

"""

1318

867

1319

868

@staticmethod

1320

869

def _is_dbus_thing(thing):

1321

870

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

1322

871

1323

872

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

1324

873

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

1325

874

"""

1326

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

875

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

1327

876

False)

1328

877

1329

878

def _get_all_dbus_things(self, thing):

1330

879

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

1331

880

"""

1332

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

881

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

882

name),

1333

883

athing.__get__(self))

1334

884

for cls in self.__class__.__mro__

1335

885

for name, athing in

1336

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

1337

1338

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1339

out_signature="s",

1340

path_keyword='object_path',

1341

connection_keyword='connection')

1342

def Introspect(self, object_path, connection):

1343

"""Overloading of standard D-Bus method.

1344

1345

Inserts annotation tags on methods and signals.

1346

"""

1347

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

1348

connection)

1349

try:

1350

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

1351

1352

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

1353

# Add annotation tags

1354

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

1355

for tag in if_tag.getElementsByTagName(typ):

1356

annots = dict()

1357

for name, prop in (self.

1358

_get_all_dbus_things(typ)):

1359

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

1360

and prop._dbus_interface

1361

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

1362

annots.update(getattr(

1363

prop, "_dbus_annotations", {}))

1364

for name, value in annots.items():

1365

ann_tag = document.createElement(

1366

"annotation")

1367

ann_tag.setAttribute("name", name)

1368

ann_tag.setAttribute("value", value)

1369

tag.appendChild(ann_tag)

1370

# Add interface annotation tags

1371

for annotation, value in dict(

1372

itertools.chain.from_iterable(

1373

annotations().items()

1374

for name, annotations

1375

in self._get_all_dbus_things("interface")

1376

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

1377

)).items():

1378

ann_tag = document.createElement("annotation")

1379

ann_tag.setAttribute("name", annotation)

1380

ann_tag.setAttribute("value", value)

1381

if_tag.appendChild(ann_tag)

1382

# Fix argument name for the Introspect method itself

1383

if (if_tag.getAttribute("name")

1384

== dbus.INTROSPECTABLE_IFACE):

1385

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

1386

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

1387

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

1388

if (arg.getAttribute("direction")

1389

== "out"):

1390

arg.setAttribute("name",

1391

"xml_data")

1392

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

1393

document.unlink()

1394

except (AttributeError, xml.dom.DOMException,

1395

xml.parsers.expat.ExpatError) as error:

1396

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

1397

exc_info=error)

1398

return xmlstring

1399

1400

1401

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1402

"""A D-Bus object with properties.

1403

1404

Classes inheriting from this can use the dbus_service_property

1405

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

1406

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

1407

"""

1408

886

inspect.getmembers(cls,

887

self._is_dbus_thing(thing)))

888

1409

889

def _get_dbus_property(self, interface_name, property_name):

1410

890

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

1411

891

property with the specified name and interface.

1412

892

"""

1413

for cls in self.__class__.__mro__:

1414

for name, value in inspect.getmembers(

1415

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

893

for cls in self.__class__.__mro__:

894

for name, value in (inspect.getmembers

895

(cls,

896

self._is_dbus_thing("property"))):

1416

897

if (value._dbus_name == property_name

1417

898

and value._dbus_interface == interface_name):

1418

899

return value.__get__(self)

1419

900

1420

901

# No such property

1421

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

1422

self.dbus_object_path, interface_name, property_name))

1423

1424

@classmethod

1425

def _get_all_interface_names(cls):

1426

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

1427

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

1428

"_dbus_interface", None)

1429

for x in (inspect.getmro(cls))

1430

for attr in dir(x))

1431

if name is not None)

1432

1433

@dbus.service.method(dbus.PROPERTIES_IFACE,

1434

in_signature="ss",

902

raise DBusPropertyNotFound(self.dbus_object_path + ":"

903

+ interface_name + "."

904

+ property_name)

905

906

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

1435

907

out_signature="v")

1436

908

def Get(self, interface_name, property_name):

1437

909

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

1443

915

if not hasattr(value, "variant_level"):

1444

916

return value

1445

917

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

1446

918

1447

919

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

1448

920

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

1449

921

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

1455

927

# The byte_arrays option is not supported yet on

1456

928

# signatures other than "ay".

1457

929

if prop._dbus_signature != "ay":

1458

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

1459

"'ay' signature {!r}"

1460

.format(prop._dbus_signature))

1461

value = dbus.ByteArray(bytes(value))

930

raise ValueError

931

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

932

for byte in value))

1462

933

prop(value)

1463

1464

@dbus.service.method(dbus.PROPERTIES_IFACE,

1465

in_signature="s",

934

935

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

1466

936

out_signature="a{sv}")

1467

937

def GetAll(self, interface_name):

1468

938

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

1469

939

standard.

1470

940

1471

941

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

1472

942

"""

1473

943

properties = {}

1483

953

if not hasattr(value, "variant_level"):

1484

954

properties[name] = value

1485

955

continue

1486

properties[name] = type(value)(

1487

value, variant_level=value.variant_level + 1)

956

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

957

value.variant_level+1)

1488

958

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

1489

1490

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

1491

def PropertiesChanged(self, interface_name, changed_properties,

1492

invalidated_properties):

1493

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

1494

standard.

1495

"""

1496

pass

1497

959

1498

960

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1499

961

out_signature="s",

1500

962

path_keyword='object_path',

1501

963

connection_keyword='connection')

1502

964

def Introspect(self, object_path, connection):

1503

965

"""Overloading of standard D-Bus method.

1504

966

1505

967

Inserts property tags and interface annotation tags.

1506

968

"""

1507

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1508

object_path,

1509

connection)

969

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

970

connection)

1510

971

try:

1511

972

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

1512

1513

973

def make_tag(document, name, prop):

1514

974

e = document.createElement("property")

1515

975

e.setAttribute("name", name)

1516

976

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

1517

977

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

1518

978

return e

1519

1520

979

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

1521

980

# Add property tags

1522

981

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

1525

984

if prop._dbus_interface

1526

985

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

1527

986

if_tag.appendChild(tag)

1528

# Add annotation tags for properties

1529

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

1530

annots = dict()

1531

for name, prop in self._get_all_dbus_things(

1532

"property"):

1533

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

1534

and prop._dbus_interface

1535

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

1536

annots.update(getattr(

1537

prop, "_dbus_annotations", {}))

1538

for name, value in annots.items():

1539

ann_tag = document.createElement(

1540

"annotation")

1541

ann_tag.setAttribute("name", name)

1542

ann_tag.setAttribute("value", value)

1543

tag.appendChild(ann_tag)

987

# Add annotation tags

988

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

989

for tag in if_tag.getElementsByTagName(typ):

990

annots = dict()

991

for name, prop in (self.

992

_get_all_dbus_things(typ)):

993

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

994

and prop._dbus_interface

995

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

996

annots.update(getattr

997

(prop,

998

"_dbus_annotations",

999

{}))

1000

for name, value in annots.iteritems():

1001

ann_tag = document.createElement(

1002

"annotation")

1003

ann_tag.setAttribute("name", name)

1004

ann_tag.setAttribute("value", value)

1005

tag.appendChild(ann_tag)

1006

# Add interface annotation tags

1007

for annotation, value in dict(

1008

itertools.chain.from_iterable(

1009

annotations().iteritems()

1010

for name, annotations in

1011

self._get_all_dbus_things("interface")

1012

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

1013

)).iteritems():

1014

ann_tag = document.createElement("annotation")

1015

ann_tag.setAttribute("name", annotation)

1016

ann_tag.setAttribute("value", value)

1017

if_tag.appendChild(ann_tag)

1544

1018

# Add the names to the return values for the

1545

1019

# "org.freedesktop.DBus.Properties" methods

1546

1020

if (if_tag.getAttribute("name")

1565

1039

return xmlstring

1566

1040

1567

1041

1568

try:

1569

dbus.OBJECT_MANAGER_IFACE

1570

except AttributeError:

1571

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

1572

1573

1574

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1575

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

1576

1577

Classes inheriting from this exposes the standard

1578

GetManagedObjects call and the InterfacesAdded and

1579

InterfacesRemoved signals on the standard

1580

"org.freedesktop.DBus.ObjectManager" interface.

1581

1582

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

1583

manually.

1584

"""

1585

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1586

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

1587

def GetManagedObjects(self):

1588

"""This function must be overridden"""

1589

raise NotImplementedError()

1590

1591

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1592

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

1593

def InterfacesAdded(self, object_path, interfaces_and_properties):

1594

pass

1595

1596

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

1597

def InterfacesRemoved(self, object_path, interfaces):

1598

pass

1599

1600

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1601

out_signature="s",

1602

path_keyword='object_path',

1603

connection_keyword='connection')

1604

def Introspect(self, object_path, connection):

1605

"""Overloading of standard D-Bus method.

1606

1607

Override return argument name of GetManagedObjects to be

1608

"objpath_interfaces_and_properties"

1609

"""

1610

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1611

object_path,

1612

connection)

1613

try:

1614

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

1615

1616

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

1617

# Fix argument name for the GetManagedObjects method

1618

if (if_tag.getAttribute("name")

1619

== dbus.OBJECT_MANAGER_IFACE):

1620

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

1621

if (cn.getAttribute("name")

1622

== "GetManagedObjects"):

1623

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

1624

if (arg.getAttribute("direction")

1625

== "out"):

1626

arg.setAttribute(

1627

"name",

1628

"objpath_interfaces"

1629

"_and_properties")

1630

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

1631

document.unlink()

1632

except (AttributeError, xml.dom.DOMException,

1633

xml.parsers.expat.ExpatError) as error:

1634

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

1635

exc_info=error)

1636

return xmlstring

1637

1638

1639

1042

def datetime_to_dbus(dt, variant_level=0):

1640

1043

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

1641

1044

if dt is None:

1642

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

1643

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

1045

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

1046

return dbus.String(dt.isoformat(),

1047

variant_level=variant_level)

1644

1048

1645

1049

1646

1050

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1648

1052

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

1649

1053

interface names according to the "alt_interface_names" mapping.

1650

1054

Usage:

1651

1055

1652

1056

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

1653

1057

"net.example.AlternateInterface"})

1654

1058

class SampleDBusObject(dbus.service.Object):

1655

1059

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

1656

1060

def SampleDBusMethod():

1657

1061

pass

1658

1062

1659

1063

The above "SampleDBusMethod" on "SampleDBusObject" will be

1660

1064

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

1661

1065

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

1662

1066

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

1663

1067

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

1664

1068

1665

1069

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

1666

1070

(from DBusObjectWithProperties) and interfaces (from the

1667

1071

dbus_interface_annotations decorator).

1668

1072

"""

1669

1670

1073

def wrapper(cls):

1671

1074

for orig_interface_name, alt_interface_name in (

1672

alt_interface_names.items()):

1075

alt_interface_names.iteritems()):

1673

1076

attr = {}

1674

1077

interface_names = set()

1675

1078

# Go though all attributes of the class

1677

1080

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

1678

1081

# with the wrong interface name

1679

1082

if (not hasattr(attribute, "_dbus_interface")

1680

or not attribute._dbus_interface.startswith(

1681

orig_interface_name)):

1083

or not attribute._dbus_interface

1084

.startswith(orig_interface_name)):

1682

1085

continue

1683

1086

# Create an alternate D-Bus interface name based on

1684

1087

# the current name

1685

alt_interface = attribute._dbus_interface.replace(

1686

orig_interface_name, alt_interface_name)

1088

alt_interface = (attribute._dbus_interface

1089

.replace(orig_interface_name,

1090

alt_interface_name))

1687

1091

interface_names.add(alt_interface)

1688

1092

# Is this a D-Bus signal?

1689

1093

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

1690

1094

# Extract the original non-method undecorated

1691

1095

# function by black magic

1692

if sys.version_info.major == 2:

1693

nonmethod_func = (dict(

1096

nonmethod_func = (dict(

1694

1097

zip(attribute.func_code.co_freevars,

1695

attribute.__closure__))

1696

["func"].cell_contents)

1697

else:

1698

nonmethod_func = (dict(

1699

zip(attribute.__code__.co_freevars,

1700

attribute.__closure__))

1701

["func"].cell_contents)

1098

attribute.__closure__))["func"]

1099

.cell_contents)

1702

1100

# Create a new, but exactly alike, function

1703

1101

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

1704

1102

# with the alternate D-Bus interface name

1705

new_function = copy_function(nonmethod_func)

1706

new_function = (dbus.service.signal(

1707

alt_interface,

1708

attribute._dbus_signature)(new_function))

1103

new_function = (dbus.service.signal

1104

(alt_interface,

1105

attribute._dbus_signature)

1106

(types.FunctionType(

1107

nonmethod_func.func_code,

1108

nonmethod_func.func_globals,

1109

nonmethod_func.func_name,

1110

nonmethod_func.func_defaults,

1111

nonmethod_func.func_closure)))

1709

1112

# Copy annotations, if any

1710

1113

try:

1711

new_function._dbus_annotations = dict(

1712

attribute._dbus_annotations)

1114

new_function._dbus_annotations = (

1115

dict(attribute._dbus_annotations))

1713

1116

except AttributeError:

1714

1117

pass

1715

1716

1118

# Define a creator of a function to call both the

1717

1119

# original and alternate functions, so both the

1718

1120

# original and alternate signals gets sent when

1721

1123

"""This function is a scope container to pass

1722

1124

func1 and func2 to the "call_both" function

1723

1125

outside of its arguments"""

1724

1725

@functools.wraps(func2)

1726

1126

def call_both(*args, **kwargs):

1727

1127

"""This function will emit two D-Bus

1728

1128

signals by calling func1 and func2"""

1729

1129

func1(*args, **kwargs)

1730

1130

func2(*args, **kwargs)

1731

# Make wrapper function look like a D-Bus

1732

# signal

1733

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

1734

if name.startswith("_dbus_"):

1735

setattr(call_both, name, attr)

1736

1737

1131

return call_both

1738

1132

# Create the "call_both" function and add it to

1739

1133

# the class

1744

1138

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

1745

1139

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

1746

1140

# to the class.

1747

attr[attrname] = (

1748

dbus.service.method(

1749

alt_interface,

1750

attribute._dbus_in_signature,

1751

attribute._dbus_out_signature)

1752

(copy_function(attribute)))

1141

attr[attrname] = (dbus.service.method

1142

(alt_interface,

1143

attribute._dbus_in_signature,

1144

attribute._dbus_out_signature)

1145

(types.FunctionType

1146

(attribute.func_code,

1147

attribute.func_globals,

1148

attribute.func_name,

1149

attribute.func_defaults,

1150

attribute.func_closure)))

1753

1151

# Copy annotations, if any

1754

1152

try:

1755

attr[attrname]._dbus_annotations = dict(

1756

attribute._dbus_annotations)

1153

attr[attrname]._dbus_annotations = (

1154

dict(attribute._dbus_annotations))

1757

1155

except AttributeError:

1758

1156

pass

1759

1157

# Is this a D-Bus property?

1762

1160

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

1763

1161

# property with the alternate D-Bus interface

1764

1162

# name. Add it to the class.

1765

attr[attrname] = (dbus_service_property(

1766

alt_interface, attribute._dbus_signature,

1767

attribute._dbus_access,

1768

attribute._dbus_get_args_options

1769

["byte_arrays"])

1770

(copy_function(attribute)))

1163

attr[attrname] = (dbus_service_property

1164

(alt_interface,

1165

attribute._dbus_signature,

1166

attribute._dbus_access,

1167

attribute

1168

._dbus_get_args_options

1169

["byte_arrays"])

1170

(types.FunctionType

1171

(attribute.func_code,

1172

attribute.func_globals,

1173

attribute.func_name,

1174

attribute.func_defaults,

1175

attribute.func_closure)))

1771

1176

# Copy annotations, if any

1772

1177

try:

1773

attr[attrname]._dbus_annotations = dict(

1774

attribute._dbus_annotations)

1178

attr[attrname]._dbus_annotations = (

1179

dict(attribute._dbus_annotations))

1775

1180

except AttributeError:

1776

1181

pass

1777

1182

# Is this a D-Bus interface?

1780

1185

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

1781

1186

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

1782

1187

# to the class.

1783

attr[attrname] = (

1784

dbus_interface_annotations(alt_interface)

1785

(copy_function(attribute)))

1188

attr[attrname] = (dbus_interface_annotations

1189

(alt_interface)

1190

(types.FunctionType

1191

(attribute.func_code,

1192

attribute.func_globals,

1193

attribute.func_name,

1194

attribute.func_defaults,

1195

attribute.func_closure)))

1786

1196

if deprecate:

1787

1197

# Deprecate all alternate interfaces

1788

iname = "_AlternateDBusNames_interface_annotation{}"

1198

iname="_AlternateDBusNames_interface_annotation{0}"

1789

1199

for interface_name in interface_names:

1790

1791

1200

@dbus_interface_annotations(interface_name)

1792

1201

def func(self):

1793

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

1794

"true"}

1202

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

1203

"true" }

1795

1204

# Find an unused name

1796

1205

for aname in (iname.format(i)

1797

1206

for i in itertools.count()):

1801

1210

if interface_names:

1802

1211

# Replace the class with a new subclass of it with

1803

1212

# methods, signals, etc. as created above.

1804

if sys.version_info.major == 2:

1805

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

1806

(cls, ), attr)

1807

else:

1808

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

1809

(cls, ), attr)

1213

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

1214

(cls,), attr)

1810

1215

return cls

1811

1812

1216

return wrapper

1813

1217

1814

1218

1815

1219

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

1816

"se.bsnet.fukt.Mandos"})

1220

"se.bsnet.fukt.Mandos"})

1817

1221

class ClientDBus(Client, DBusObjectWithProperties):

1818

1222

"""A Client class using D-Bus

1819

1223

1820

1224

Attributes:

1821

1225

dbus_object_path: dbus.ObjectPath

1822

1226

bus: dbus.SystemBus()

1823

1227

"""

1824

1228

1825

1229

runtime_expansions = (Client.runtime_expansions

1826

+ ("dbus_object_path", ))

1827

1828

_interface = "se.recompile.Mandos.Client"

1829

1230

+ ("dbus_object_path",))

1231

1830

1232

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

1831

1832

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

1233

1234

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

1833

1235

self.bus = bus

1834

1236

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

1835

1237

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

1836

1238

# the D-Bus

1837

client_object_name = str(self.name).translate(

1239

client_object_name = unicode(self.name).translate(

1838

1240

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

1839

1241

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

1840

self.dbus_object_path = dbus.ObjectPath(

1841

"/clients/" + client_object_name)

1242

self.dbus_object_path = (dbus.ObjectPath

1243

("/clients/" + client_object_name))

1842

1244

DBusObjectWithProperties.__init__(self, self.bus,

1843

1245

self.dbus_object_path)

1844

1845

def notifychangeproperty(transform_func, dbus_name,

1846

type_func=lambda x: x,

1847

variant_level=1,

1848

invalidate_only=False,

1849

_interface=_interface):

1246

1247

def notifychangeproperty(transform_func,

1248

dbus_name, type_func=lambda x: x,

1249

variant_level=1):

1850

1250

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

1851

1251

its changes to DBus.

1852

1252

1853

1253

transform_fun: Function that takes a value and a variant_level

1854

1254

and transforms it to a D-Bus type.

1855

1255

dbus_name: D-Bus name of the variable

1857

1257

to the D-Bus. Default: no transform

1858

1258

variant_level: D-Bus variant level. Default: 1

1859

1259

"""

1860

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

1861

1260

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

1862

1261

def setter(self, value):

1863

1262

if hasattr(self, "dbus_object_path"):

1864

1263

if (not hasattr(self, attrname) or

1865

1264

type_func(getattr(self, attrname, None))

1866

1265

!= type_func(value)):

1867

if invalidate_only:

1868

self.PropertiesChanged(

1869

_interface, dbus.Dictionary(),

1870

dbus.Array((dbus_name, )))

1871

else:

1872

dbus_value = transform_func(

1873

type_func(value),

1874

variant_level=variant_level)

1875

self.PropertyChanged(dbus.String(dbus_name),

1876

dbus_value)

1877

self.PropertiesChanged(

1878

_interface,

1879

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

1880

dbus_value}),

1881

dbus.Array())

1266

dbus_value = transform_func(type_func(value),

1267

variant_level

1268

=variant_level)

1269

self.PropertyChanged(dbus.String(dbus_name),

1270

dbus_value)

1882

1271

setattr(self, attrname, value)

1883

1272

1884

1273

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

1885

1274

1886

1275

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1887

1276

approvals_pending = notifychangeproperty(dbus.Boolean,

1888

1277

"ApprovalPending",

1889

type_func=bool)

1278

type_func = bool)

1890

1279

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

1891

1280

last_enabled = notifychangeproperty(datetime_to_dbus,

1892

1281

"LastEnabled")

1893

checker = notifychangeproperty(

1894

dbus.Boolean, "CheckerRunning",

1895

type_func=lambda checker: checker is not None)

1282

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

1283

type_func = lambda checker:

1284

checker is not None)

1896

1285

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1897

1286

"LastCheckedOK")

1898

1287

last_checker_status = notifychangeproperty(dbus.Int16,

1901

1290

datetime_to_dbus, "LastApprovalRequest")

1902

1291

approved_by_default = notifychangeproperty(dbus.Boolean,

1903

1292

"ApprovedByDefault")

1904

approval_delay = notifychangeproperty(

1905

dbus.UInt64, "ApprovalDelay",

1906

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

1293

approval_delay = notifychangeproperty(dbus.UInt64,

1294

"ApprovalDelay",

1295

type_func =

1296

timedelta_to_milliseconds)

1907

1297

approval_duration = notifychangeproperty(

1908

1298

dbus.UInt64, "ApprovalDuration",

1909

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

1299

type_func = timedelta_to_milliseconds)

1910

1300

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

1911

timeout = notifychangeproperty(

1912

dbus.UInt64, "Timeout",

1913

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

1301

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

1302

type_func =

1303

timedelta_to_milliseconds)

1914

1304

extended_timeout = notifychangeproperty(

1915

1305

dbus.UInt64, "ExtendedTimeout",

1916

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

1917

interval = notifychangeproperty(

1918

dbus.UInt64, "Interval",

1919

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

1306

type_func = timedelta_to_milliseconds)

1307

interval = notifychangeproperty(dbus.UInt64,

1308

"Interval",

1309

type_func =

1310

timedelta_to_milliseconds)

1920

1311

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

1921

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

1922

invalidate_only=True)

1923

1312

1924

1313

del notifychangeproperty

1925

1314

1926

1315

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

1927

1316

try:

1928

1317

self.remove_from_connection()

1931

1320

if hasattr(DBusObjectWithProperties, "__del__"):

1932

1321

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

1933

1322

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

1934

1935

def checker_callback(self, source, condition,

1936

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

1937

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

1938

connection, command, *args,

1939

**kwargs)

1940

exitstatus = self.last_checker_status

1941

if exitstatus >= 0:

1323

1324

def checker_callback(self, pid, condition, command,

1325

*args, **kwargs):

1326

self.checker_callback_tag = None

1327

self.checker = None

1328

if os.WIFEXITED(condition):

1329

exitstatus = os.WEXITSTATUS(condition)

1942

1330

# Emit D-Bus signal

1943

1331

self.CheckerCompleted(dbus.Int16(exitstatus),

1944

# This is specific to GNU libC

1945

dbus.Int64(exitstatus << 8),

1332

dbus.Int64(condition),

1946

1333

dbus.String(command))

1947

1334

else:

1948

1335

# Emit D-Bus signal

1949

1336

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

1950

dbus.Int64(

1951

# This is specific to GNU libC

1952

(exitstatus << 8)

1953

| self.last_checker_signal),

1337

dbus.Int64(condition),

1954

1338

dbus.String(command))

1955

return ret

1956

1339

1340

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

1341

*args, **kwargs)

1342

1957

1343

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

1958

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

1344

old_checker = self.checker

1345

if self.checker is not None:

1346

old_checker_pid = self.checker.pid

1347

else:

1348

old_checker_pid = None

1959

1349

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

1960

1350

# Only if new checker process was started

1961

1351

if (self.checker is not None

1963

1353

# Emit D-Bus signal

1964

1354

self.CheckerStarted(self.current_checker_command)

1965

1355

return r

1966

1356

1967

1357

def _reset_approved(self):

1968

1358

self.approved = None

1969

1359

return False

1970

1360

1971

1361

def approve(self, value=True):

1972

1362

self.approved = value

1973

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

1974

* 1000), self._reset_approved)

1363

gobject.timeout_add(timedelta_to_milliseconds

1364

(self.approval_duration),

1365

self._reset_approved)

1975

1366

self.send_changedstate()

1976

1977

# D-Bus methods, signals & properties

1978

1979

# Interfaces

1980

1981

# Signals

1982

1367

1368

## D-Bus methods, signals & properties

1369

_interface = "se.recompile.Mandos.Client"

1370

1371

## Interfaces

1372

1373

@dbus_interface_annotations(_interface)

1374

def _foo(self):

1375

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

1376

"false"}

1377

1378

## Signals

1379

1983

1380

# CheckerCompleted - signal

1984

1381

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

1985

1382

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

1986

1383

"D-Bus signal"

1987

1384

pass

1988

1385

1989

1386

# CheckerStarted - signal

1990

1387

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

1991

1388

def CheckerStarted(self, command):

1992

1389

"D-Bus signal"

1993

1390

pass

1994

1391

1995

1392

# PropertyChanged - signal

1996

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

1997

1393

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

1998

1394

def PropertyChanged(self, property, value):

1999

1395

"D-Bus signal"

2000

1396

pass

2001

1397

2002

1398

# GotSecret - signal

2003

1399

@dbus.service.signal(_interface)

2004

1400

def GotSecret(self):

2007

1403

server to mandos-client

2008

1404

"""

2009

1405

pass

2010

1406

2011

1407

# Rejected - signal

2012

1408

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

2013

1409

def Rejected(self, reason):

2014

1410

"D-Bus signal"

2015

1411

pass

2016

1412

2017

1413

# NeedApproval - signal

2018

1414

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

2019

1415

def NeedApproval(self, timeout, default):

2020

1416

"D-Bus signal"

2021

1417

return self.need_approval()

2022

2023

# Methods

2024

1418

1419

## Methods

1420

2025

1421

# Approve - method

2026

1422

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

2027

1423

def Approve(self, value):

2028

1424

self.approve(value)

2029

1425

2030

1426

# CheckedOK - method

2031

1427

@dbus.service.method(_interface)

2032

1428

def CheckedOK(self):

2033

1429

self.checked_ok()

2034

1430

2035

1431

# Enable - method

2036

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

2037

1432

@dbus.service.method(_interface)

2038

1433

def Enable(self):

2039

1434

"D-Bus method"

2040

1435

self.enable()

2041

1436

2042

1437

# StartChecker - method

2043

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

2044

1438

@dbus.service.method(_interface)

2045

1439

def StartChecker(self):

2046

1440

"D-Bus method"

2047

1441

self.start_checker()

2048

1442

2049

1443

# Disable - method

2050

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

2051

1444

@dbus.service.method(_interface)

2052

1445

def Disable(self):

2053

1446

"D-Bus method"

2054

1447

self.disable()

2055

1448

2056

1449

# StopChecker - method

2057

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

2058

1450

@dbus.service.method(_interface)

2059

1451

def StopChecker(self):

2060

1452

self.stop_checker()

2061

2062

# Properties

2063

1453

1454

## Properties

1455

2064

1456

# ApprovalPending - property

2065

1457

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

2066

1458

def ApprovalPending_dbus_property(self):

2067

1459

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

2068

1460

2069

1461

# ApprovedByDefault - property

2070

@dbus_service_property(_interface,

2071

signature="b",

1462

@dbus_service_property(_interface, signature="b",

2072

1463

access="readwrite")

2073

1464

def ApprovedByDefault_dbus_property(self, value=None):

2074

1465

if value is None: # get

2075

1466

return dbus.Boolean(self.approved_by_default)

2076

1467

self.approved_by_default = bool(value)

2077

1468

2078

1469

# ApprovalDelay - property

2079

@dbus_service_property(_interface,

2080

signature="t",

1470

@dbus_service_property(_interface, signature="t",

2081

1471

access="readwrite")

2082

1472

def ApprovalDelay_dbus_property(self, value=None):

2083

1473

if value is None: # get

2084

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

2085

* 1000)

1474

return dbus.UInt64(self.approval_delay_milliseconds())

2086

1475

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

2087

1476

2088

1477

# ApprovalDuration - property

2089

@dbus_service_property(_interface,

2090

signature="t",

1478

@dbus_service_property(_interface, signature="t",

2091

1479

access="readwrite")

2092

1480

def ApprovalDuration_dbus_property(self, value=None):

2093

1481

if value is None: # get

2094

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

2095

* 1000)

1482

return dbus.UInt64(timedelta_to_milliseconds(

1483

self.approval_duration))

2096

1484

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

2097

1485

2098

1486

# Name - property

2099

@dbus_annotations(

2100

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

2101

1487

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

2102

1488

def Name_dbus_property(self):

2103

1489

return dbus.String(self.name)

2104

2105

# KeyID - property

2106

@dbus_annotations(

2107

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

2108

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

2109

def KeyID_dbus_property(self):

2110

return dbus.String(self.key_id)

2111

1490

2112

1491

# Fingerprint - property

2113

@dbus_annotations(

2114

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

2115

1492

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

2116

1493

def Fingerprint_dbus_property(self):

2117

1494

return dbus.String(self.fingerprint)

2118

1495

2119

1496

# Host - property

2120

@dbus_service_property(_interface,

2121

signature="s",

1497

@dbus_service_property(_interface, signature="s",

2122

1498

access="readwrite")

2123

1499

def Host_dbus_property(self, value=None):

2124

1500

if value is None: # get

2125

1501

return dbus.String(self.host)

2126

self.host = str(value)

2127

1502

self.host = unicode(value)

1503

2128

1504

# Created - property

2129

@dbus_annotations(

2130

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

2131

1505

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

2132

1506

def Created_dbus_property(self):

2133

1507

return datetime_to_dbus(self.created)

2134

1508

2135

1509

# LastEnabled - property

2136

1510

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

2137

1511

def LastEnabled_dbus_property(self):

2138

1512

return datetime_to_dbus(self.last_enabled)

2139

1513

2140

1514

# Enabled - property

2141

@dbus_service_property(_interface,

2142

signature="b",

1515

@dbus_service_property(_interface, signature="b",

2143

1516

access="readwrite")

2144

1517

def Enabled_dbus_property(self, value=None):

2145

1518

if value is None: # get

2148

1521

self.enable()

2149

1522

else:

2150

1523

self.disable()

2151

1524

2152

1525

# LastCheckedOK - property

2153

@dbus_service_property(_interface,

2154

signature="s",

1526

@dbus_service_property(_interface, signature="s",

2155

1527

access="readwrite")

2156

1528

def LastCheckedOK_dbus_property(self, value=None):

2157

1529

if value is not None:

2158

1530

self.checked_ok()

2159

1531

return

2160

1532

return datetime_to_dbus(self.last_checked_ok)

2161

1533

2162

1534

# LastCheckerStatus - property

2163

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

1535

@dbus_service_property(_interface, signature="n",

1536

access="read")

2164

1537

def LastCheckerStatus_dbus_property(self):

2165

1538

return dbus.Int16(self.last_checker_status)

2166

1539

2167

1540

# Expires - property

2168

1541

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

2169

1542

def Expires_dbus_property(self):

2170

1543

return datetime_to_dbus(self.expires)

2171

1544

2172

1545

# LastApprovalRequest - property

2173

1546

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

2174

1547

def LastApprovalRequest_dbus_property(self):

2175

1548

return datetime_to_dbus(self.last_approval_request)

2176

1549

2177

1550

# Timeout - property

2178

@dbus_service_property(_interface,

2179

signature="t",

1551

@dbus_service_property(_interface, signature="t",

2180

1552

access="readwrite")

2181

1553

def Timeout_dbus_property(self, value=None):

2182

1554

if value is None: # get

2183

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

1555

return dbus.UInt64(self.timeout_milliseconds())

2184

1556

old_timeout = self.timeout

2185

1557

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

2186

1558

# Reschedule disabling

2194

1566

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

2195

1567

is None):

2196

1568

return

2197

GLib.source_remove(self.disable_initiator_tag)

2198

self.disable_initiator_tag = GLib.timeout_add(

2199

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

2200

self.disable)

2201

1569

gobject.source_remove(self.disable_initiator_tag)

1570

self.disable_initiator_tag = (

1571

gobject.timeout_add(

1572

timedelta_to_milliseconds(self.expires - now),

1573

self.disable))

1574

2202

1575

# ExtendedTimeout - property

2203

@dbus_service_property(_interface,

2204

signature="t",

1576

@dbus_service_property(_interface, signature="t",

2205

1577

access="readwrite")

2206

1578

def ExtendedTimeout_dbus_property(self, value=None):

2207

1579

if value is None: # get

2208

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

2209

* 1000)

1580

return dbus.UInt64(self.extended_timeout_milliseconds())

2210

1581

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

2211

1582

2212

1583

# Interval - property

2213

@dbus_service_property(_interface,

2214

signature="t",

1584

@dbus_service_property(_interface, signature="t",

2215

1585

access="readwrite")

2216

1586

def Interval_dbus_property(self, value=None):

2217

1587

if value is None: # get

2218

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

1588

return dbus.UInt64(self.interval_milliseconds())

2219

1589

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

2220

1590

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

2221

1591

return

2222

1592

if self.enabled:

2223

1593

# Reschedule checker run

2224

GLib.source_remove(self.checker_initiator_tag)

2225

self.checker_initiator_tag = GLib.timeout_add(

2226

value, self.start_checker)

2227

self.start_checker() # Start one now, too

2228

1594

gobject.source_remove(self.checker_initiator_tag)

1595

self.checker_initiator_tag = (gobject.timeout_add

1596

(value, self.start_checker))

1597

self.start_checker() # Start one now, too

1598

2229

1599

# Checker - property

2230

@dbus_service_property(_interface,

2231

signature="s",

1600

@dbus_service_property(_interface, signature="s",

2232

1601

access="readwrite")

2233

1602

def Checker_dbus_property(self, value=None):

2234

1603

if value is None: # get

2235

1604

return dbus.String(self.checker_command)

2236

self.checker_command = str(value)

2237

1605

self.checker_command = unicode(value)

1606

2238

1607

# CheckerRunning - property

2239

@dbus_service_property(_interface,

2240

signature="b",

1608

@dbus_service_property(_interface, signature="b",

2241

1609

access="readwrite")

2242

1610

def CheckerRunning_dbus_property(self, value=None):

2243

1611

if value is None: # get

2246

1614

self.start_checker()

2247

1615

else:

2248

1616

self.stop_checker()

2249

1617

2250

1618

# ObjectPath - property

2251

@dbus_annotations(

2252

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

2253

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

2254

1619

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

2255

1620

def ObjectPath_dbus_property(self):

2256

return self.dbus_object_path # is already a dbus.ObjectPath

2257

1621

return self.dbus_object_path # is already a dbus.ObjectPath

1622

2258

1623

# Secret = property

2259

@dbus_annotations(

2260

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

2261

"invalidates"})

2262

@dbus_service_property(_interface,

2263

signature="ay",

2264

access="write",

2265

byte_arrays=True)

1624

@dbus_service_property(_interface, signature="ay",

1625

access="write", byte_arrays=True)

2266

1626

def Secret_dbus_property(self, value):

2267

self.secret = bytes(value)

2268

1627

self.secret = str(value)

1628

2269

1629

del _interface

2270

1630

2271

1631

2272

class ProxyClient:

2273

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

1632

class ProxyClient(object):

1633

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

2274

1634

self._pipe = child_pipe

2275

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

1635

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

2276

1636

if not self._pipe.recv():

2277

raise KeyError(key_id or fpr)

2278

1637

raise KeyError()

1638

2279

1639

def __getattribute__(self, name):

2280

1640

if name == '_pipe':

2281

1641

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

2284

1644

if data[0] == 'data':

2285

1645

return data[1]

2286

1646

if data[0] == 'function':

2287

2288

1647

def func(*args, **kwargs):

2289

1648

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

2290

1649

return self._pipe.recv()[1]

2291

2292

1650

return func

2293

1651

2294

1652

def __setattr__(self, name, value):

2295

1653

if name == '_pipe':

2296

1654

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

2299

1657

2300

1658

class ClientHandler(socketserver.BaseRequestHandler, object):

2301

1659

"""A class to handle client connections.

2302

1660

2303

1661

Instantiated once for each connection to handle it.

2304

1662

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

2305

1663

2306

1664

def handle(self):

2307

1665

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

2308

1666

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

2309

str(self.client_address))

1667

unicode(self.client_address))

2310

1668

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

2311

1669

self.server.child_pipe.fileno())

2312

2313

session = gnutls.ClientSession(self.request)

2314

2315

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

2316

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

2317

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

2318

# "+DHE-DSS"))

1670

1671

session = (gnutls.connection

1672

.ClientSession(self.request,

1673

gnutls.connection

1674

.X509Credentials()))

1675

1676

# Note: gnutls.connection.X509Credentials is really a

1677

# generic GnuTLS certificate credentials object so long as

1678

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

1679

# here despite using OpenPGP certificates.

1680

1681

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

1682

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

1683

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

1684

# "+DHE-DSS"))

2319

1685

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

2320

1686

priority = self.server.gnutls_priority

2321

1687

if priority is None:

2322

1688

priority = "NORMAL"

2323

gnutls.priority_set_direct(session,

2324

priority.encode("utf-8"), None)

2325

1689

(gnutls.library.functions

1690

.gnutls_priority_set_direct(session._c_object,

1691

priority, None))

1692

2326

1693

# Start communication using the Mandos protocol

2327

1694

# Get protocol number

2328

1695

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

2329

1696

logger.debug("Protocol version: %r", line)

2330

1697

try:

2331

1698

if int(line.strip().split()[0]) > 1:

2332

raise RuntimeError(line)

1699

raise RuntimeError

2333

1700

except (ValueError, IndexError, RuntimeError) as error:

2334

1701

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

2335

1702

return

2336

1703

2337

1704

# Start GnuTLS connection

2338

1705

try:

2339

1706

session.handshake()

2340

except gnutls.Error as error:

1707

except gnutls.errors.GNUTLSError as error:

2341

1708

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

2342

1709

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

2343

1710

# established. Just abandon the request.

2344

1711

return

2345

1712

logger.debug("Handshake succeeded")

2346

1713

2347

1714

approval_required = False

2348

1715

try:

2349

if gnutls.has_rawpk:

2350

fpr = b""

2351

try:

2352

key_id = self.key_id(

2353

self.peer_certificate(session))

2354

except (TypeError, gnutls.Error) as error:

2355

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

2356

return

2357

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

2358

key_id.decode("utf-8",

2359

errors="replace"))

2360

2361

else:

2362

key_id = b""

2363

try:

2364

fpr = self.fingerprint(

2365

self.peer_certificate(session))

2366

except (TypeError, gnutls.Error) as error:

2367

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

2368

return

2369

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

2370

2371

try:

2372

client = ProxyClient(child_pipe, key_id, fpr,

1716

try:

1717

fpr = self.fingerprint(self.peer_certificate

1718

(session))

1719

except (TypeError,

1720

gnutls.errors.GNUTLSError) as error:

1721

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

1722

return

1723

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

1724

1725

try:

1726

client = ProxyClient(child_pipe, fpr,

2373

1727

self.client_address)

2374

1728

except KeyError:

2375

1729

return

2376

1730

2377

1731

if client.approval_delay:

2378

1732

delay = client.approval_delay

2379

1733

client.approvals_pending += 1

2380

1734

approval_required = True

2381

1735

2382

1736

while True:

2383

1737

if not client.enabled:

2384

1738

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

2385

client.name)

1739

client.name)

2386

1740

if self.server.use_dbus:

2387

1741

# Emit D-Bus signal

2388

1742

client.Rejected("Disabled")

2389

1743

return

2390

1744

2391

1745

if client.approved or not client.approval_delay:

2392

# We are approved or approval is disabled

1746

#We are approved or approval is disabled

2393

1747

break

2394

1748

elif client.approved is None:

2395

1749

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

2397

1751

if self.server.use_dbus:

2398

1752

# Emit D-Bus signal

2399

1753

client.NeedApproval(

2400

client.approval_delay.total_seconds()

2401

* 1000, client.approved_by_default)

1754

client.approval_delay_milliseconds(),

1755

client.approved_by_default)

2402

1756

else:

2403

1757

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

2404

1758

client.name)

2406

1760

# Emit D-Bus signal

2407

1761

client.Rejected("Denied")

2408

1762

return

2409

2410

# wait until timeout or approved

1763

1764

#wait until timeout or approved

2411

1765

time = datetime.datetime.now()

2412

1766

client.changedstate.acquire()

2413

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

1767

client.changedstate.wait(

1768

float(timedelta_to_milliseconds(delay)

1769

/ 1000))

2414

1770

client.changedstate.release()

2415

1771

time2 = datetime.datetime.now()

2416

1772

if (time2 - time) >= delay:

2426

1782

break

2427

1783

else:

2428

1784

delay -= time2 - time

2429

2430

try:

2431

session.send(client.secret)

2432

except gnutls.Error as error:

2433

logger.warning("gnutls send failed",

2434

exc_info=error)

2435

return

2436

1785

1786

sent_size = 0

1787

while sent_size < len(client.secret):

1788

try:

1789

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

1790

except gnutls.errors.GNUTLSError as error:

1791

logger.warning("gnutls send failed",

1792

exc_info=error)

1793

return

1794

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

1795

sent, len(client.secret)

1796

- (sent_size + sent))

1797

sent_size += sent

1798

2437

1799

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

2438

1800

# bump the timeout using extended_timeout

2439

1801

client.bump_timeout(client.extended_timeout)

2440

1802

if self.server.use_dbus:

2441

1803

# Emit D-Bus signal

2442

1804

client.GotSecret()

2443

1805

2444

1806

finally:

2445

1807

if approval_required:

2446

1808

client.approvals_pending -= 1

2447

1809

try:

2448

1810

session.bye()

2449

except gnutls.Error as error:

1811

except gnutls.errors.GNUTLSError as error:

2450

1812

logger.warning("GnuTLS bye failed",

2451

1813

exc_info=error)

2452

1814

2453

1815

@staticmethod

2454

1816

def peer_certificate(session):

2455

"Return the peer's certificate as a bytestring"

2456

try:

2457

cert_type = gnutls.certificate_type_get2(

2458

session, gnutls.CTYPE_PEERS)

2459

except AttributeError:

2460

cert_type = gnutls.certificate_type_get(session)

2461

if gnutls.has_rawpk:

2462

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2463

else:

2464

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2465

# If not a valid certificate type...

2466

if cert_type not in valid_cert_types:

2467

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

2468

valid_cert_types)

2469

# ...return invalid data

2470

return b""

1817

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

1818

# If not an OpenPGP certificate...

1819

if (gnutls.library.functions

1820

.gnutls_certificate_type_get(session._c_object)

1821

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1822

# ...do the normal thing

1823

return session.peer_certificate

2471

1824

list_size = ctypes.c_uint(1)

2472

cert_list = (gnutls.certificate_get_peers

2473

(session, ctypes.byref(list_size)))

1825

cert_list = (gnutls.library.functions

1826

.gnutls_certificate_get_peers

1827

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

2474

1828

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

2475

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

1829

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

1830

" certificate")

2476

1831

if list_size.value == 0:

2477

1832

return None

2478

1833

cert = cert_list[0]

2479

1834

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

2480

2481

@staticmethod

2482

def key_id(certificate):

2483

"Convert a certificate bytestring to a hexdigit key ID"

2484

# New GnuTLS "datum" with the public key

2485

datum = gnutls.datum_t(

2486

ctypes.cast(ctypes.c_char_p(certificate),

2487

ctypes.POINTER(ctypes.c_ubyte)),

2488

ctypes.c_uint(len(certificate)))

2489

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

2490

# New empty GnuTLS certificate

2491

pubkey = gnutls.pubkey_t()

2492

gnutls.pubkey_init(ctypes.byref(pubkey))

2493

# Import the raw public key into the certificate

2494

gnutls.pubkey_import(pubkey,

2495

ctypes.byref(datum),

2496

gnutls.X509_FMT_DER)

2497

# New buffer for the key ID

2498

buf = ctypes.create_string_buffer(32)

2499

buf_len = ctypes.c_size_t(len(buf))

2500

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

2501

gnutls.pubkey_get_key_id(

2502

pubkey,

2503

gnutls.KEYID_USE_SHA256,

2504

ctypes.cast(ctypes.byref(buf),

2505

ctypes.POINTER(ctypes.c_ubyte)),

2506

ctypes.byref(buf_len))

2507

# Deinit the certificate

2508

gnutls.pubkey_deinit(pubkey)

2509

2510

# Convert the buffer to a Python bytestring

2511

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

2512

# Convert the bytestring to hexadecimal notation

2513

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

2514

return hex_key_id

2515

1835

2516

1836

@staticmethod

2517

1837

def fingerprint(openpgp):

2518

1838

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2519

1839

# New GnuTLS "datum" with the OpenPGP public key

2520

datum = gnutls.datum_t(

2521

ctypes.cast(ctypes.c_char_p(openpgp),

2522

ctypes.POINTER(ctypes.c_ubyte)),

2523

ctypes.c_uint(len(openpgp)))

1840

datum = (gnutls.library.types

1841

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

1842

ctypes.POINTER

1843

(ctypes.c_ubyte)),

1844

ctypes.c_uint(len(openpgp))))

2524

1845

# New empty GnuTLS certificate

2525

crt = gnutls.openpgp_crt_t()

2526

gnutls.openpgp_crt_init(ctypes.byref(crt))

1846

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1847

(gnutls.library.functions

1848

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2527

1849

# Import the OpenPGP public key into the certificate

2528

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

2529

gnutls.OPENPGP_FMT_RAW)

1850

(gnutls.library.functions

1851

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

1852

gnutls.library.constants

1853

.GNUTLS_OPENPGP_FMT_RAW))

2530

1854

# Verify the self signature in the key

2531

1855

crtverify = ctypes.c_uint()

2532

gnutls.openpgp_crt_verify_self(crt, 0,

2533

ctypes.byref(crtverify))

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_verify_self(crt, 0,

1858

ctypes.byref(crtverify)))

2534

1859

if crtverify.value != 0:

2535

gnutls.openpgp_crt_deinit(crt)

2536

raise gnutls.CertificateSecurityError(code

2537

=crtverify.value)

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1861

raise (gnutls.errors.CertificateSecurityError

1862

("Verify failed"))

2538

1863

# New buffer for the fingerprint

2539

1864

buf = ctypes.create_string_buffer(20)

2540

1865

buf_len = ctypes.c_size_t()

2541

1866

# Get the fingerprint from the certificate into the buffer

2542

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

2543

ctypes.byref(buf_len))

1867

(gnutls.library.functions

1868

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

1869

ctypes.byref(buf_len)))

2544

1870

# Deinit the certificate

2545

gnutls.openpgp_crt_deinit(crt)

1871

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2546

1872

# Convert the buffer to a Python bytestring

2547

1873

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

2548

1874

# Convert the bytestring to hexadecimal notation

2550

1876

return hex_fpr

2551

1877

2552

1878

2553

class MultiprocessingMixIn:

1879

class MultiprocessingMixIn(object):

2554

1880

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

2555

2556

1881

def sub_process_main(self, request, address):

2557

1882

try:

2558

1883

self.finish_request(request, address)

2559

1884

except Exception:

2560

1885

self.handle_error(request, address)

2561

1886

self.close_request(request)

2562

1887

2563

1888

def process_request(self, request, address):

2564

1889

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

2565

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

2566

args=(request, address))

1890

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

1891

args = (request, address))

2567

1892

proc.start()

2568

1893

return proc

2569

1894

2570

1895

2571

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1896

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2572

1897

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

2573

2574

1898

def process_request(self, request, client_address):

2575

1899

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

2576

1900

2577

1901

This function creates a new pipe in self.pipe

2578

1902

"""

2579

1903

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2580

1904

2581

1905

proc = MultiprocessingMixIn.process_request(self, request,

2582

1906

client_address)

2583

1907

self.child_pipe.close()

2584

1908

self.add_pipe(parent_pipe, proc)

2585

1909

2586

1910

def add_pipe(self, parent_pipe, proc):

2587

1911

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

2588

raise NotImplementedError()

1912

raise NotImplementedError

2589

1913

2590

1914

2591

1915

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2592

socketserver.TCPServer):

1916

socketserver.TCPServer, object):

2593

1917

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

2594

1918

2595

1919

Attributes:

2596

1920

enabled: Boolean; whether this server is activated yet

2597

1921

interface: None or a network interface name (string)

2598

1922

use_ipv6: Boolean; to use IPv6 or not

2599

1923

"""

2600

2601

1924

def __init__(self, server_address, RequestHandlerClass,

2602

interface=None,

2603

use_ipv6=True,

2604

socketfd=None):

1925

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

2605

1926

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

2606

1927

creating a new one with socket.socket().

2607

1928

"""

2613

1934

self.socketfd = socketfd

2614

1935

# Save the original socket.socket() function

2615

1936

self.socket_socket = socket.socket

2616

2617

1937

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

2618

#

1938

#

2619

1939

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

2620

1940

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

2621

1941

# patching socket.socket.)

2622

#

1942

#

2623

1943

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

2624

1944

@functools.wraps(socket.socket)

2625

1945

def socket_wrapper(*args, **kwargs):

2637

1957

# socket_wrapper(), if socketfd was set.

2638

1958

socketserver.TCPServer.__init__(self, server_address,

2639

1959

RequestHandlerClass)

2640

1960

2641

1961

def server_bind(self):

2642

1962

"""This overrides the normal server_bind() function

2643

1963

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

2644

1964

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

2645

global SO_BINDTODEVICE

2646

1965

if self.interface is not None:

2647

1966

if SO_BINDTODEVICE is None:

2648

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

2649

# common enough.

2650

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

2651

SO_BINDTODEVICE = 25

2652

try:

2653

self.socket.setsockopt(

2654

socket.SOL_SOCKET, SO_BINDTODEVICE,

2655

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

2656

except socket.error as error:

2657

if error.errno == errno.EPERM:

2658

logger.error("No permission to bind to"

2659

" interface %s", self.interface)

2660

elif error.errno == errno.ENOPROTOOPT:

2661

logger.error("SO_BINDTODEVICE not available;"

2662

" cannot bind to interface %s",

2663

self.interface)

2664

elif error.errno == errno.ENODEV:

2665

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

2666

" cannot bind", self.interface)

2667

else:

2668

raise

1967

logger.error("SO_BINDTODEVICE does not exist;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

else:

1971

try:

1972

self.socket.setsockopt(socket.SOL_SOCKET,

1973

SO_BINDTODEVICE,

1974

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

1975

except socket.error as error:

1976

if error.errno == errno.EPERM:

1977

logger.error("No permission to bind to"

1978

" interface %s", self.interface)

1979

elif error.errno == errno.ENOPROTOOPT:

1980

logger.error("SO_BINDTODEVICE not available;"

1981

" cannot bind to interface %s",

1982

self.interface)

1983

elif error.errno == errno.ENODEV:

1984

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

1985

" cannot bind", self.interface)

1986

else:

1987

raise

2669

1988

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

2670

1989

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

2671

if self.server_address[1]:

2672

self.allow_reuse_address = True

2673

1990

if not self.server_address[0]:

2674

1991

if self.address_family == socket.AF_INET6:

2675

any_address = "::" # in6addr_any

1992

any_address = "::" # in6addr_any

2676

1993

else:

2677

any_address = "0.0.0.0" # INADDR_ANY

1994

any_address = "0.0.0.0" # INADDR_ANY

2678

1995

self.server_address = (any_address,

2679

1996

self.server_address[1])

2680

1997

elif not self.server_address[1]:

2681

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

1998

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

1999

0)

2682

2000

# if self.interface:

2683

2001

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

2684

2002

# 0, # port

2690

2008

2691

2009

class MandosServer(IPv6_TCPServer):

2692

2010

"""Mandos server.

2693

2011

2694

2012

Attributes:

2695

2013

clients: set of Client objects

2696

2014

gnutls_priority GnuTLS priority string

2697

2015

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

2698

2699

Assumes a GLib.MainLoop event loop.

2016

2017

Assumes a gobject.MainLoop event loop.

2700

2018

"""

2701

2702

2019

def __init__(self, server_address, RequestHandlerClass,

2703

interface=None,

2704

use_ipv6=True,

2705

clients=None,

2706

gnutls_priority=None,

2707

use_dbus=True,

2708

socketfd=None):

2020

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

2021

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

2709

2022

self.enabled = False

2710

2023

self.clients = clients

2711

2024

if self.clients is None:

2714

2027

self.gnutls_priority = gnutls_priority

2715

2028

IPv6_TCPServer.__init__(self, server_address,

2716

2029

RequestHandlerClass,

2717

interface=interface,

2718

use_ipv6=use_ipv6,

2719

socketfd=socketfd)

2720

2030

interface = interface,

2031

use_ipv6 = use_ipv6,

2032

socketfd = socketfd)

2721

2033

def server_activate(self):

2722

2034

if self.enabled:

2723

2035

return socketserver.TCPServer.server_activate(self)

2724

2036

2725

2037

def enable(self):

2726

2038

self.enabled = True

2727

2039

2728

2040

def add_pipe(self, parent_pipe, proc):

2729

2041

# Call "handle_ipc" for both data and EOF events

2730

GLib.io_add_watch(

2731

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

2732

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

2733

functools.partial(self.handle_ipc,

2734

parent_pipe=parent_pipe,

2735

proc=proc))

2736

2737

def handle_ipc(self, source, condition,

2738

parent_pipe=None,

2739

proc=None,

2740

client_object=None):

2042

gobject.io_add_watch(parent_pipe.fileno(),

2043

gobject.IO_IN | gobject.IO_HUP,

2044

functools.partial(self.handle_ipc,

2045

parent_pipe =

2046

parent_pipe,

2047

proc = proc))

2048

2049

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

2050

proc = None, client_object=None):

2741

2051

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

2742

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

2052

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

2743

2053

# Wait for other process to exit

2744

2054

proc.join()

2745

2055

return False

2746

2056

2747

2057

# Read a request from the child

2748

2058

request = parent_pipe.recv()

2749

2059

command = request[0]

2750

2060

2751

2061

if command == 'init':

2752

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

2753

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

2754

address = request[3]

2755

2756

for c in self.clients.values():

2757

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2758

"27AE41E4649B934CA495991B7852B855"):

2759

continue

2760

if key_id and c.key_id == key_id:

2761

client = c

2762

break

2763

if fpr and c.fingerprint == fpr:

2062

fpr = request[1]

2063

address = request[2]

2064

2065

for c in self.clients.itervalues():

2066

if c.fingerprint == fpr:

2764

2067

client = c

2765

2068

break

2766

2069

else:

2767

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

2768

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

2070

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

2071

"dress: %s", fpr, address)

2769

2072

if self.use_dbus:

2770

2073

# Emit D-Bus signal

2771

mandos_dbus_service.ClientNotFound(key_id or fpr,

2074

mandos_dbus_service.ClientNotFound(fpr,

2772

2075

address[0])

2773

2076

parent_pipe.send(False)

2774

2077

return False

2775

2776

GLib.io_add_watch(

2777

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

2778

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

2779

functools.partial(self.handle_ipc,

2780

parent_pipe=parent_pipe,

2781

proc=proc,

2782

client_object=client))

2078

2079

gobject.io_add_watch(parent_pipe.fileno(),

2080

gobject.IO_IN | gobject.IO_HUP,

2081

functools.partial(self.handle_ipc,

2082

parent_pipe =

2083

parent_pipe,

2084

proc = proc,

2085

client_object =

2086

client))

2783

2087

parent_pipe.send(True)

2784

2088

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

2785

2089

# same fileno

2788

2092

funcname = request[1]

2789

2093

args = request[2]

2790

2094

kwargs = request[3]

2791

2095

2792

2096

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

2793

2097

funcname)(*args,

2794

**kwargs)))

2795

2098

**kwargs)))

2099

2796

2100

if command == 'getattr':

2797

2101

attrname = request[1]

2798

if isinstance(client_object.__getattribute__(attrname),

2799

collections.abc.Callable):

2800

parent_pipe.send(('function', ))

2102

if callable(client_object.__getattribute__(attrname)):

2103

parent_pipe.send(('function',))

2801

2104

else:

2802

parent_pipe.send((

2803

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

2804

2105

parent_pipe.send(('data', client_object

2106

.__getattribute__(attrname)))

2107

2805

2108

if command == 'setattr':

2806

2109

attrname = request[1]

2807

2110

value = request[2]

2808

2111

setattr(client_object, attrname, value)

2809

2112

2810

2113

return True

2811

2114

2812

2115

2813

2116

def rfc3339_duration_to_delta(duration):

2814

2117

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

2815

2816

>>> timedelta = datetime.timedelta

2817

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

2818

True

2819

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

2820

True

2821

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

2822

True

2823

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

2824

True

2825

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

2826

True

2827

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

2828

True

2829

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

2830

True

2831

>>> del timedelta

2118

2119

>>> rfc3339_duration_to_delta("P7D")

2120

datetime.timedelta(7)

2121

>>> rfc3339_duration_to_delta("PT60S")

2122

datetime.timedelta(0, 60)

2123

>>> rfc3339_duration_to_delta("PT60M")

2124

datetime.timedelta(0, 3600)

2125

>>> rfc3339_duration_to_delta("PT24H")

2126

datetime.timedelta(1)

2127

>>> rfc3339_duration_to_delta("P1W")

2128

datetime.timedelta(7)

2129

>>> rfc3339_duration_to_delta("PT5M30S")

2130

datetime.timedelta(0, 330)

2131

>>> rfc3339_duration_to_delta("P1DT3M20S")

2132

datetime.timedelta(1, 200)

2832

2133

"""

2833

2134

2834

2135

# Parsing an RFC 3339 duration with regular expressions is not

2835

2136

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

2836

2137

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

2837

2138

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

2838

2139

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

2839

2140

# avoid excessive use of external libraries.

2840

2141

2841

2142

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

2842

Token = collections.namedtuple("Token", (

2843

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

2844

# a "group" containing digits

2845

"value", # datetime.timedelta or None

2846

"followers")) # Tokens valid after this token

2143

Token = collections.namedtuple("Token",

2144

("regexp", # To match token; if

2145

# "value" is not None,

2146

# must have a "group"

2147

# containing digits

2148

"value", # datetime.timedelta or

2149

# None

2150

"followers")) # Tokens valid after

2151

# this token

2847

2152

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

2848

2153

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

2849

2154

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

2850

2155

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

2851

2156

datetime.timedelta(seconds=1),

2852

frozenset((token_end, )))

2157

frozenset((token_end,)))

2853

2158

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

2854

2159

datetime.timedelta(minutes=1),

2855

2160

frozenset((token_second, token_end)))

2871

2176

frozenset((token_month, token_end)))

2872

2177

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

2873

2178

datetime.timedelta(weeks=1),

2874

frozenset((token_end, )))

2179

frozenset((token_end,)))

2875

2180

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

2876

2181

frozenset((token_year, token_month,

2877

2182

token_day, token_time,

2878

token_week)))

2879

# Define starting values:

2880

# Value so far

2881

value = datetime.timedelta()

2183

token_week))),

2184

# Define starting values

2185

value = datetime.timedelta() # Value so far

2882

2186

found_token = None

2883

# Following valid tokens

2884

followers = frozenset((token_duration, ))

2885

# String left to parse

2886

s = duration

2187

followers = frozenset(token_duration,) # Following valid tokens

2188

s = duration # String left to parse

2887

2189

# Loop until end token is found

2888

2190

while found_token is not token_end:

2889

2191

# Search for any currently valid tokens

2905

2207

break

2906

2208

else:

2907

2209

# No currently valid tokens were found

2908

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

2909

.format(duration))

2210

raise ValueError("Invalid RFC 3339 duration")

2910

2211

# End token found

2911

2212

return value

2912

2213

2913

2214

2914

2215

def string_to_delta(interval):

2915

2216

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

2916

2917

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

2918

True

2919

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

2920

True

2921

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

2922

True

2923

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

2924

True

2925

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

2926

True

2927

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

2928

True

2217

2218

>>> string_to_delta('7d')

2219

datetime.timedelta(7)

2220

>>> string_to_delta('60s')

2221

datetime.timedelta(0, 60)

2222

>>> string_to_delta('60m')

2223

datetime.timedelta(0, 3600)

2224

>>> string_to_delta('24h')

2225

datetime.timedelta(1)

2226

>>> string_to_delta('1w')

2227

datetime.timedelta(7)

2228

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

2229

datetime.timedelta(0, 330)

2929

2230

"""

2930

2231

2931

2232

try:

2932

2233

return rfc3339_duration_to_delta(interval)

2933

2234

except ValueError:

2934

2235

pass

2935

2236

2936

2237

timevalue = datetime.timedelta(0)

2937

2238

for s in interval.split():

2938

2239

try:

2939

suffix = s[-1]

2240

suffix = unicode(s[-1])

2940

2241

value = int(s[:-1])

2941

2242

if suffix == "d":

2942

2243

delta = datetime.timedelta(value)

2949

2250

elif suffix == "w":

2950

2251

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

2951

2252

else:

2952

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

2953

except IndexError as e:

2253

raise ValueError("Unknown suffix {0!r}"

2254

.format(suffix))

2255

except (ValueError, IndexError) as e:

2954

2256

raise ValueError(*(e.args))

2955

2257

timevalue += delta

2956

2258

return timevalue

2957

2259

2958

2260

2959

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

2261

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

2960

2262

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

2961

2263

2962

2264

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

2963

2265

if os.fork():

2964

2266

sys.exit()

2972

2274

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

2973

2275

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

2974

2276

raise OSError(errno.ENODEV,

2975

"{} not a character device"

2277

"{0} not a character device"

2976

2278

.format(os.devnull))

2977

2279

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

2978

2280

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

2982

2284

2983

2285

2984

2286

def main():

2985

2287

2986

2288

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

2987

2289

# Parsing of options, both command line and config file

2988

2290

2989

2291

parser = argparse.ArgumentParser()

2990

2292

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

2991

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

2293

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

2992

2294

help="show version number and exit")

2993

2295

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

2994

2296

help="Bind to interface IF")

3027

2329

help="Directory to save/restore state in")

3028

2330

parser.add_argument("--foreground", action="store_true",

3029

2331

help="Run in foreground", default=None)

3030

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

3031

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

3032

default=None)

3033

2332

3034

2333

options = parser.parse_args()

3035

2334

2335

if options.check:

2336

import doctest

2337

doctest.testmod()

2338

sys.exit()

2339

3036

2340

# Default values for config file for server-global settings

3037

if gnutls.has_rawpk:

3038

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

3039

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

3040

else:

3041

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

3042

":+SIGN-DSA-SHA256")

3043

server_defaults = {"interface": "",

3044

"address": "",

3045

"port": "",

3046

"debug": "False",

3047

"priority": priority,

3048

"servicename": "Mandos",

3049

"use_dbus": "True",

3050

"use_ipv6": "True",

3051

"debuglevel": "",

3052

"restore": "True",

3053

"socket": "",

3054

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

3055

"foreground": "False",

3056

"zeroconf": "True",

3057

}

3058

del priority

3059

2341

server_defaults = { "interface": "",

2342

"address": "",

2343

"port": "",

2344

"debug": "False",

2345

"priority":

2346

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

2347

"servicename": "Mandos",

2348

"use_dbus": "True",

2349

"use_ipv6": "True",

2350

"debuglevel": "",

2351

"restore": "True",

2352

"socket": "",

2353

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

2354

"foreground": "False",

2355

}

2356

3060

2357

# Parse config file for server-global settings

3061

server_config = configparser.ConfigParser(server_defaults)

2358

server_config = configparser.SafeConfigParser(server_defaults)

3062

2359

del server_defaults

3063

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

3064

# Convert the ConfigParser object to a dict

2360

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

2361

"mandos.conf"))

2362

# Convert the SafeConfigParser object to a dict

3065

2363

server_settings = server_config.defaults()

3066

2364

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

3067

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

3068

"foreground", "zeroconf"):

2365

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

3069

2366

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

3070

2367

option)

3071

2368

if server_settings["port"]:

3081

2378

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

3082

2379

["socket"])

3083

2380

del server_config

3084

2381

3085

2382

# Override the settings from the config file with command line

3086

2383

# options, if set.

3087

2384

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

3088

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

3089

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

3090

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

2385

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

2386

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

2387

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

3091

2388

value = getattr(options, option)

3092

2389

if value is not None:

3093

2390

server_settings[option] = value

3094

2391

del options

3095

2392

# Force all strings to be unicode

3096

2393

for option in server_settings.keys():

3097

if isinstance(server_settings[option], bytes):

3098

server_settings[option] = (server_settings[option]

3099

.decode("utf-8"))

2394

if type(server_settings[option]) is str:

2395

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

3100

2396

# Force all boolean options to be boolean

3101

2397

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

3102

"foreground", "zeroconf"):

2398

"foreground"):

3103

2399

server_settings[option] = bool(server_settings[option])

3104

2400

# Debug implies foreground

3105

2401

if server_settings["debug"]:

3106

2402

server_settings["foreground"] = True

3107

2403

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

3108

2404

3109

2405

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

3110

3111

if (not server_settings["zeroconf"]

3112

and not (server_settings["port"]

3113

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

3114

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

3115

2406

3116

2407

# For convenience

3117

2408

debug = server_settings["debug"]

3118

2409

debuglevel = server_settings["debuglevel"]

3121

2412

stored_state_path = os.path.join(server_settings["statedir"],

3122

2413

stored_state_file)

3123

2414

foreground = server_settings["foreground"]

3124

zeroconf = server_settings["zeroconf"]

3125

2415

3126

2416

if debug:

3127

2417

initlogger(debug, logging.DEBUG)

3128

2418

else:

3131

2421

else:

3132

2422

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

3133

2423

initlogger(debug, level)

3134

2424

3135

2425

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

3136

syslogger.setFormatter(

3137

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

3138

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

3139

server_settings["servicename"])))

3140

2426

syslogger.setFormatter(logging.Formatter

2427

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

2428

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

2429

.format(server_settings

2430

["servicename"])))

2431

3141

2432

# Parse config file with clients

3142

client_config = configparser.ConfigParser(Client.client_defaults)

2433

client_config = configparser.SafeConfigParser(Client

2434

.client_defaults)

3143

2435

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

3144

2436

"clients.conf"))

3145

2437

3146

2438

global mandos_dbus_service

3147

2439

mandos_dbus_service = None

3148

3149

socketfd = None

3150

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

3151

socketfd = server_settings["socket"]

3152

tcp_server = MandosServer(

3153

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

3154

ClientHandler,

3155

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

3156

use_ipv6=use_ipv6,

3157

gnutls_priority=server_settings["priority"],

3158

use_dbus=use_dbus,

3159

socketfd=socketfd)

2440

2441

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

2442

server_settings["port"]),

2443

ClientHandler,

2444

interface=(server_settings["interface"]

2445

or None),

2446

use_ipv6=use_ipv6,

2447

gnutls_priority=

2448

server_settings["priority"],

2449

use_dbus=use_dbus,

2450

socketfd=(server_settings["socket"]

2451

or None))

3160

2452

if not foreground:

3161

2453

pidfilename = "/run/mandos.pid"

3162

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

3163

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

3164

2454

pidfile = None

3165

2455

try:

3166

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

2456

pidfile = open(pidfilename, "w")

3167

2457

except IOError as e:

3168

2458

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

3169

2459

exc_info=e)

3170

3171

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

3172

("mandos", "mandos"),

3173

("nobody", "nogroup")):

2460

2461

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

3174

2462

try:

3175

2463

uid = pwd.getpwnam(name).pw_uid

3176

gid = pwd.getpwnam(group).pw_gid

2464

gid = pwd.getpwnam(name).pw_gid

3177

2465

break

3178

2466

except KeyError:

3179

2467

continue

3183

2471

try:

3184

2472

os.setgid(gid)

3185

2473

os.setuid(uid)

3186

if debug:

3187

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

3188

gid))

3189

2474

except OSError as error:

3190

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

3191

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

3192

2475

if error.errno != errno.EPERM:

3193

raise

3194

2476

raise error

2477

3195

2478

if debug:

3196

2479

# Enable all possible GnuTLS debugging

3197

2480

3198

2481

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

3199

2482

# - GnuTLS manual

3200

gnutls.global_set_log_level(11)

3201

3202

@gnutls.log_func

2483

gnutls.library.functions.gnutls_global_set_log_level(11)

2484

2485

@gnutls.library.types.gnutls_log_func

3203

2486

def debug_gnutls(level, string):

3204

logger.debug("GnuTLS: %s",

3205

string[:-1].decode("utf-8",

3206

errors="replace"))

3207

3208

gnutls.global_set_log_function(debug_gnutls)

3209

2487

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

2488

2489

(gnutls.library.functions

2490

.gnutls_global_set_log_function(debug_gnutls))

2491

3210

2492

# Redirect stdin so all checkers get /dev/null

3211

2493

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

3212

2494

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

3213

2495

if null > 2:

3214

2496

os.close(null)

3215

2497

3216

2498

# Need to fork before connecting to D-Bus

3217

2499

if not foreground:

3218

2500

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

3219

2501

daemon()

3220

3221

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

3222

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

3223

# need to inform GLib that threads will be used.

3224

GLib.threads_init()

3225

2502

2503

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

2504

# need to inform gobject that threads will be used.

2505

gobject.threads_init()

2506

3226

2507

global main_loop

3227

2508

# From the Avahi example code

3228

2509

DBusGMainLoop(set_as_default=True)

3229

main_loop = GLib.MainLoop()

2510

main_loop = gobject.MainLoop()

3230

2511

bus = dbus.SystemBus()

3231

2512

# End of Avahi example code

3232

2513

if use_dbus:

3233

2514

try:

3234

2515

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

3235

bus,

3236

do_not_queue=True)

3237

old_bus_name = dbus.service.BusName(

3238

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

3239

do_not_queue=True)

3240

except dbus.exceptions.DBusException as e:

2516

bus, do_not_queue=True)

2517

old_bus_name = (dbus.service.BusName

2518

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

2519

do_not_queue=True))

2520

except dbus.exceptions.NameExistsException as e:

3241

2521

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

3242

2522

use_dbus = False

3243

2523

server_settings["use_dbus"] = False

3244

2524

tcp_server.use_dbus = False

3245

if zeroconf:

3246

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3247

service = AvahiServiceToSyslog(

3248

name=server_settings["servicename"],

3249

servicetype="_mandos._tcp",

3250

protocol=protocol,

3251

bus=bus)

3252

if server_settings["interface"]:

3253

service.interface = if_nametoindex(

3254

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

3255

2525

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2526

service = AvahiServiceToSyslog(name =

2527

server_settings["servicename"],

2528

servicetype = "_mandos._tcp",

2529

protocol = protocol, bus = bus)

2530

if server_settings["interface"]:

2531

service.interface = (if_nametoindex

2532

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

2533

3256

2534

global multiprocessing_manager

3257

2535

multiprocessing_manager = multiprocessing.Manager()

3258

2536

3259

2537

client_class = Client

3260

2538

if use_dbus:

3261

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

3262

2539

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

2540

3263

2541

client_settings = Client.config_parser(client_config)

3264

2542

old_client_settings = {}

3265

2543

clients_data = {}

3266

2544

3267

2545

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

3268

2546

global wnull

3269

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

2547

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

3270

2548

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

3271

2549

# mode

3272

2550

if debug or not foreground:

3273

2551

wnull.close()

3274

2552

3275

2553

# Get client data and settings from last running state.

3276

2554

if server_settings["restore"]:

3277

2555

try:

3278

2556

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

3279

if sys.version_info.major == 2:

3280

clients_data, old_client_settings = pickle.load(

3281

stored_state)

3282

else:

3283

bytes_clients_data, bytes_old_client_settings = (

3284

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

3285

# Fix bytes to strings

3286

# clients_data

3287

# .keys()

3288

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

3289

if isinstance(key, bytes)

3290

else key): value

3291

for key, value in

3292

bytes_clients_data.items()}

3293

del bytes_clients_data

3294

for key in clients_data:

3295

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

3296

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

3297

for k, v in

3298

clients_data[key].items()}

3299

clients_data[key] = value

3300

# .client_structure

3301

value["client_structure"] = [

3302

(s.decode("utf-8")

3303

if isinstance(s, bytes)

3304

else s) for s in

3305

value["client_structure"]]

3306

# .name, .host, and .checker_command

3307

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

3308

if isinstance(value[k], bytes):

3309

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

3310

if "key_id" not in value:

3311

value["key_id"] = ""

3312

elif "fingerprint" not in value:

3313

value["fingerprint"] = ""

3314

# old_client_settings

3315

# .keys()

3316

old_client_settings = {

3317

(key.decode("utf-8")

3318

if isinstance(key, bytes)

3319

else key): value

3320

for key, value in

3321

bytes_old_client_settings.items()}

3322

del bytes_old_client_settings

3323

# .host and .checker_command

3324

for value in old_client_settings.values():

3325

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

3326

if isinstance(value[attribute], bytes):

3327

value[attribute] = (value[attribute]

3328

.decode("utf-8"))

2557

clients_data, old_client_settings = (pickle.load

2558

(stored_state))

3329

2559

os.remove(stored_state_path)

3330

2560

except IOError as e:

3331

2561

if e.errno == errno.ENOENT:

3332

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

3333

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

2562

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

2563

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

3334

2564

else:

3335

2565

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

3336

2566

exc_info=e)

3337

2567

raise

3338

2568

except EOFError as e:

3339

2569

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

3340

"EOFError:",

3341

exc_info=e)

3342

2570

"EOFError:", exc_info=e)

2571

3343

2572

with PGPEngine() as pgp:

3344

for client_name, client in clients_data.items():

2573

for client_name, client in clients_data.iteritems():

3345

2574

# Skip removed clients

3346

2575

if client_name not in client_settings:

3347

2576

continue

3348

2577

3349

2578

# Decide which value to use after restoring saved state.

3350

2579

# We have three different values: Old config file,

3351

2580

# new config file, and saved state.

3356

2585

# For each value in new config, check if it

3357

2586

# differs from the old config value (Except for

3358

2587

# the "secret" attribute)

3359

if (name != "secret"

3360

and (value !=

3361

old_client_settings[client_name][name])):

2588

if (name != "secret" and

2589

value != old_client_settings[client_name]

2590

[name]):

3362

2591

client[name] = value

3363

2592

except KeyError:

3364

2593

pass

3365

2594

3366

2595

# Clients who has passed its expire date can still be

3367

# enabled if its last checker was successful. A Client

2596

# enabled if its last checker was successful. Clients

3368

2597

# whose checker succeeded before we stored its state is

3369

2598

# assumed to have successfully run all checkers during

3370

2599

# downtime.

3372

2601

if datetime.datetime.utcnow() >= client["expires"]:

3373

2602

if not client["last_checked_ok"]:

3374

2603

logger.warning(

3375

"disabling client {} - Client never "

3376

"performed a successful checker".format(

3377

client_name))

2604

"disabling client {0} - Client never "

2605

"performed a successful checker"

2606

.format(client_name))

3378

2607

client["enabled"] = False

3379

2608

elif client["last_checker_status"] != 0:

3380

2609

logger.warning(

3381

"disabling client {} - Client last"

3382

" checker failed with error code"

3383

" {}".format(

3384

client_name,

3385

client["last_checker_status"]))

2610

"disabling client {0} - Client "

2611

"last checker failed with error code {1}"

2612

.format(client_name,

2613

client["last_checker_status"]))

3386

2614

client["enabled"] = False

3387

2615

else:

3388

client["expires"] = (

3389

datetime.datetime.utcnow()

3390

+ client["timeout"])

2616

client["expires"] = (datetime.datetime

2617

.utcnow()

2618

+ client["timeout"])

3391

2619

logger.debug("Last checker succeeded,"

3392

" keeping {} enabled".format(

3393

client_name))

2620

" keeping {0} enabled"

2621

.format(client_name))

3394

2622

try:

3395

client["secret"] = pgp.decrypt(

3396

client["encrypted_secret"],

3397

client_settings[client_name]["secret"])

2623

client["secret"] = (

2624

pgp.decrypt(client["encrypted_secret"],

2625

client_settings[client_name]

2626

["secret"]))

3398

2627

except PGPError:

3399

2628

# If decryption fails, we use secret from new settings

3400

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

3401

client_name))

3402

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

3403

["secret"])

3404

2629

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

2630

.format(client_name))

2631

client["secret"] = (

2632

client_settings[client_name]["secret"])

2633

3405

2634

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

3406

2635

for client_name in (set(old_client_settings)

3407

2636

- set(client_settings)):

3409

2638

for client_name in (set(client_settings)

3410

2639

- set(old_client_settings)):

3411

2640

clients_data[client_name] = client_settings[client_name]

3412

2641

3413

2642

# Create all client objects

3414

for client_name, client in clients_data.items():

2643

for client_name, client in clients_data.iteritems():

3415

2644

tcp_server.clients[client_name] = client_class(

3416

name=client_name,

3417

settings=client,

3418

server_settings=server_settings)

3419

2645

name = client_name, settings = client,

2646

server_settings = server_settings)

2647

3420

2648

if not tcp_server.clients:

3421

2649

logger.warning("No clients defined")

3422

2650

3423

2651

if not foreground:

3424

2652

if pidfile is not None:

3425

pid = os.getpid()

3426

2653

try:

3427

2654

with pidfile:

3428

print(pid, file=pidfile)

2655

pid = os.getpid()

2656

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

3429

2657

except IOError:

3430

2658

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

3431

2659

pidfilename, pid)

3432

2660

del pidfile

3433

2661

del pidfilename

3434

3435

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

3436

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3437

lambda: main_loop.quit() and False)

3438

2662

2663

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

2664

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

2665

3439

2666

if use_dbus:

3440

3441

@alternate_dbus_interfaces(

3442

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

3443

class MandosDBusService(DBusObjectWithObjectManager):

2667

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

2668

"se.bsnet.fukt.Mandos"})

2669

class MandosDBusService(DBusObjectWithProperties):

3444

2670

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

3445

3446

2671

def __init__(self):

3447

2672

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

3448

3449

2673

_interface = "se.recompile.Mandos"

3450

2674

2675

@dbus_interface_annotations(_interface)

2676

def _foo(self):

2677

return { "org.freedesktop.DBus.Property"

2678

".EmitsChangedSignal":

2679

"false"}

2680

3451

2681

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

3452

2682

def ClientAdded(self, objpath):

3453

2683

"D-Bus signal"

3454

2684

pass

3455

2685

3456

2686

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

3457

def ClientNotFound(self, key_id, address):

2687

def ClientNotFound(self, fingerprint, address):

3458

2688

"D-Bus signal"

3459

2689

pass

3460

3461

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

3462

"true"})

2690

3463

2691

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

3464

2692

def ClientRemoved(self, objpath, name):

3465

2693

"D-Bus signal"

3466

2694

pass

3467

3468

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

3469

"true"})

2695

3470

2696

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

3471

2697

def GetAllClients(self):

3472

2698

"D-Bus method"

3473

return dbus.Array(c.dbus_object_path for c in

3474

tcp_server.clients.values())

3475

3476

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

3477

"true"})

2699

return dbus.Array(c.dbus_object_path

2700

for c in

2701

tcp_server.clients.itervalues())

2702

3478

2703

@dbus.service.method(_interface,

3479

2704

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

3480

2705

def GetAllClientsWithProperties(self):

3481

2706

"D-Bus method"

3482

2707

return dbus.Dictionary(

3483

{c.dbus_object_path: c.GetAll(

3484

"se.recompile.Mandos.Client")

3485

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

2708

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

2709

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

3486

2710

signature="oa{sv}")

3487

2711

3488

2712

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

3489

2713

def RemoveClient(self, object_path):

3490

2714

"D-Bus method"

3491

for c in tcp_server.clients.values():

2715

for c in tcp_server.clients.itervalues():

3492

2716

if c.dbus_object_path == object_path:

3493

2717

del tcp_server.clients[c.name]

3494

2718

c.remove_from_connection()

3495

# Don't signal the disabling

2719

# Don't signal anything except ClientRemoved

3496

2720

c.disable(quiet=True)

3497

# Emit D-Bus signal for removal

3498

self.client_removed_signal(c)

2721

# Emit D-Bus signal

2722

self.ClientRemoved(object_path, c.name)

3499

2723

return

3500

2724

raise KeyError(object_path)

3501

2725

3502

2726

del _interface

3503

3504

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3505

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

3506

def GetManagedObjects(self):

3507

"""D-Bus method"""

3508

return dbus.Dictionary(

3509

{client.dbus_object_path:

3510

dbus.Dictionary(

3511

{interface: client.GetAll(interface)

3512

for interface in

3513

client._get_all_interface_names()})

3514

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

3515

3516

def client_added_signal(self, client):

3517

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

3518

if use_dbus:

3519

# New standard signal

3520

self.InterfacesAdded(

3521

client.dbus_object_path,

3522

dbus.Dictionary(

3523

{interface: client.GetAll(interface)

3524

for interface in

3525

client._get_all_interface_names()}))

3526

# Old signal

3527

self.ClientAdded(client.dbus_object_path)

3528

3529

def client_removed_signal(self, client):

3530

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

3531

if use_dbus:

3532

# New standard signal

3533

self.InterfacesRemoved(

3534

client.dbus_object_path,

3535

client._get_all_interface_names())

3536

# Old signal

3537

self.ClientRemoved(client.dbus_object_path,

3538

client.name)

3539

2727

3540

2728

mandos_dbus_service = MandosDBusService()

3541

3542

# Save modules to variables to exempt the modules from being

3543

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

3544

mp = multiprocessing

3545

wn = wnull

3546

2729

3547

2730

def cleanup():

3548

2731

"Cleanup function; run on exit"

3549

if zeroconf:

3550

service.cleanup()

3551

3552

mp.active_children()

3553

wn.close()

2732

service.cleanup()

2733

2734

multiprocessing.active_children()

2735

wnull.close()

3554

2736

if not (tcp_server.clients or client_settings):

3555

2737

return

3556

2738

3557

2739

# Store client before exiting. Secrets are encrypted with key

3558

2740

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

3559

2741

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

3560

2742

clients = {}

3561

2743

with PGPEngine() as pgp:

3562

for client in tcp_server.clients.values():

2744

for client in tcp_server.clients.itervalues():

3563

2745

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

3564

2746

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

3565

2747

key)

3566

2748

client_dict = {}

3567

2749

3568

2750

# A list of attributes that can not be pickled

3569

2751

# + secret.

3570

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

3571

"checker", "server_settings"}

3572

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

3573

.Object):

2752

exclude = set(("bus", "changedstate", "secret",

2753

"checker", "server_settings"))

2754

for name, typ in (inspect.getmembers

2755

(dbus.service.Object)):

3574

2756

exclude.add(name)

3575

2757

3576

2758

client_dict["encrypted_secret"] = (client

3577

2759

.encrypted_secret)

3578

2760

for attr in client.client_structure:

3579

2761

if attr not in exclude:

3580

2762

client_dict[attr] = getattr(client, attr)

3581

2763

3582

2764

clients[client.name] = client_dict

3583

2765

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

3584

2766

3585

2767

try:

3586

with tempfile.NamedTemporaryFile(

3587

mode='wb',

3588

suffix=".pickle",

3589

prefix='clients-',

3590

dir=os.path.dirname(stored_state_path),

3591

delete=False) as stored_state:

3592

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

3593

protocol=2)

3594

tempname = stored_state.name

2768

with (tempfile.NamedTemporaryFile

2769

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

2770

dir=os.path.dirname(stored_state_path),

2771

delete=False)) as stored_state:

2772

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

2773

tempname=stored_state.name

3595

2774

os.rename(tempname, stored_state_path)

3596

2775

except (IOError, OSError) as e:

3597

2776

if not debug:

3600

2779

except NameError:

3601

2780

pass

3602

2781

if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):

3603

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

2782

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

3604

2783

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

3605

2784

else:

3606

2785

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

3607

2786

exc_info=e)

3608

raise

3609

2787

raise e

2788

3610

2789

# Delete all clients, and settings from config

3611

2790

while tcp_server.clients:

3612

2791

name, client = tcp_server.clients.popitem()

3613

2792

if use_dbus:

3614

2793

client.remove_from_connection()

3615

# Don't signal the disabling

2794

# Don't signal anything except ClientRemoved

3616

2795

client.disable(quiet=True)

3617

# Emit D-Bus signal for removal

3618

2796

if use_dbus:

3619

mandos_dbus_service.client_removed_signal(client)

2797

# Emit D-Bus signal

2798

mandos_dbus_service.ClientRemoved(client

2799

.dbus_object_path,

2800

client.name)

3620

2801

client_settings.clear()

3621

2802

3622

2803

atexit.register(cleanup)

3623

3624

for client in tcp_server.clients.values():

2804

2805

for client in tcp_server.clients.itervalues():

3625

2806

if use_dbus:

3626

# Emit D-Bus signal for adding

3627

mandos_dbus_service.client_added_signal(client)

2807

# Emit D-Bus signal

2808

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3628

2809

# Need to initiate checking of clients

3629

2810

if client.enabled:

3630

2811

client.init_checker()

3631

2812

3632

2813

tcp_server.enable()

3633

2814

tcp_server.server_activate()

3634

2815

3635

2816

# Find out what port we got

3636

if zeroconf:

3637

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

2817

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

3638

2818

if use_ipv6:

3639

2819

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

3640

2820

" flowinfo %d, scope_id %d",

3642

2822

else: # IPv4

3643

2823

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

3644

2824

*tcp_server.socket.getsockname())

3645

3646

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

3647

2825

2826

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

2827

3648

2828

try:

3649

if zeroconf:

3650

# From the Avahi example code

3651

try:

3652

service.activate()

3653

except dbus.exceptions.DBusException as error:

3654

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

3655

cleanup()

3656

sys.exit(1)

3657

# End of Avahi example code

3658

3659

GLib.io_add_watch(

3660

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

3661

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3662

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

3663

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

3664

2829

# From the Avahi example code

2830

try:

2831

service.activate()

2832

except dbus.exceptions.DBusException as error:

2833

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

2834

cleanup()

2835

sys.exit(1)

2836

# End of Avahi example code

2837

2838

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

2839

lambda *args, **kwargs:

2840

(tcp_server.handle_request

2841

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

2842

3665

2843

logger.debug("Starting main loop")

3666

2844

main_loop.run()

3667

2845

except AvahiError as error:

3676

2854

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

3677

2855

cleanup()

3678

2856

3679

3680

def should_only_run_tests():

3681

parser = argparse.ArgumentParser(add_help=False)

3682

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

3683

args, unknown_args = parser.parse_known_args()

3684

run_tests = args.check

3685

if run_tests:

3686

# Remove --check argument from sys.argv

3687

sys.argv[1:] = unknown_args

3688

return run_tests

3689

3690

# Add all tests from doctest strings

3691

def load_tests(loader, tests, none):

3692

import doctest

3693

tests.addTests(doctest.DocTestSuite())

3694

return tests

3695

3696

2857

if __name__ == '__main__':

3697

try:

3698

if should_only_run_tests():

3699

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

3700

unittest.main()

3701

else:

3702

main()

3703

finally:

3704

logging.shutdown()

2858

main()