/mandos/trunk : revision 594.1.3

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

import collections

79

import codecs

80

import unittest

81

import random

82

import shlex

83

71

84

72

import dbus

85

73

import dbus.service

86

import gi

87

from gi.repository import GLib

74

import gobject

75

import avahi

88

76

from dbus.mainloop.glib import DBusGMainLoop

89

77

import ctypes

90

78

import ctypes.util

91

79

import xml.dom.minidom

92

80

import inspect

93

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:

81

import GnuPGInterface

82

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

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

142

self.gnupg = GnuPGInterface.GnuPG()

215

143

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

self.gnupgargs = ['--batch',

228

'--homedir', self.tempdir,

229

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

144

self.gnupg = GnuPGInterface.GnuPG()

145

self.gnupg.options.meta_interactive = False

146

self.gnupg.options.homedir = self.tempdir

147

self.gnupg.options.extra_args.extend(['--force-mdc',

148

'--quiet',

149

'--no-use-agent'])

150

235

151

def __enter__(self):

236

152

return self

237

153

238

154

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

239

155

self._cleanup()

240

156

return False

241

157

242

158

def __del__(self):

243

159

self._cleanup()

244

160

245

161

def _cleanup(self):

246

162

if self.tempdir is not None:

247

163

# Delete contents of tempdir

248

164

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

249

topdown=False):

165

topdown = False):

250

166

for filename in files:

251

167

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

252

168

for dirname in dirs:

254

170

# Remove tempdir

255

171

os.rmdir(self.tempdir)

256

172

self.tempdir = None

257

173

258

174

def password_encode(self, password):

259

175

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

260

176

# 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

177

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

178

269

179

def encrypt(self, data, password):

270

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

273

passfile.write(passphrase)

274

passfile.flush()

275

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

276

'--passphrase-file',

277

passfile.name]

278

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

283

if proc.returncode != 0:

284

raise PGPError(err)

180

self.gnupg.passphrase = self.password_encode(password)

181

with open(os.devnull, "w") as devnull:

182

try:

183

proc = self.gnupg.run(['--symmetric'],

184

create_fhs=['stdin', 'stdout'],

185

attach_fhs={'stderr': devnull})

186

with contextlib.closing(proc.handles['stdin']) as f:

187

f.write(data)

188

with contextlib.closing(proc.handles['stdout']) as f:

189

ciphertext = f.read()

190

proc.wait()

191

except IOError as e:

192

raise PGPError(e)

193

self.gnupg.passphrase = None

285

194

return ciphertext

286

195

287

196

def decrypt(self, data, password):

288

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

291

passfile.write(passphrase)

292

passfile.flush()

293

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

294

'--passphrase-file',

295

passfile.name]

296

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

301

if proc.returncode != 0:

302

raise PGPError(err)

197

self.gnupg.passphrase = self.password_encode(password)

198

with open(os.devnull, "w") as devnull:

199

try:

200

proc = self.gnupg.run(['--decrypt'],

201

create_fhs=['stdin', 'stdout'],

202

attach_fhs={'stderr': devnull})

203

with contextlib.closing(proc.handles['stdin']) as f:

204

f.write(data)

205

with contextlib.closing(proc.handles['stdout']) as f:

206

decrypted_plaintext = f.read()

207

proc.wait()

208

except IOError as e:

209

raise PGPError(e)

210

self.gnupg.passphrase = None

303

211

return decrypted_plaintext

304

212

305

213

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

214

class AvahiError(Exception):

333

215

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

334

216

self.value = value

335

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

336

**kwargs)

337

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

338

220

339

221

class AvahiServiceError(AvahiError):

340

222

pass

341

223

342

343

224

class AvahiGroupError(AvahiError):

344

225

pass

345

226

346

227

347

class AvahiService:

228

class AvahiService(object):

348

229

"""An Avahi (Zeroconf) service.

349

230

350

231

Attributes:

351

232

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

352

233

Used to optionally bind to the specified interface.

353

234

name: string; Example: 'Mandos'

354

235

type: string; Example: '_mandos._tcp'.

355

See <https://www.iana.org/assignments/service-names-port-numbers>

236

See <http://www.dns-sd.org/ServiceTypes.html>

356

237

port: integer; what port to announce

357

238

TXT: list of strings; TXT record for the service

358

239

domain: string; Domain to publish on, default to .local if empty.

364

245

server: D-Bus Server

365

246

bus: dbus.SystemBus()

366

247

"""

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

248

249

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

250

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

251

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

252

protocol = avahi.PROTO_UNSPEC, bus = None):

379

253

self.interface = interface

380

254

self.name = name

381

255

self.type = servicetype

390

264

self.server = None

391

265

self.bus = bus

392

266

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

267

268

def rename(self):

395

269

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

396

270

if self.rename_count >= self.max_renames:

397

271

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

398

272

" after %i retries, exiting.",

399

273

self.rename_count)

400

274

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

404

277

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

405

278

self.name)

406

if remove:

407

self.remove()

279

self.remove()

408

280

try:

409

281

self.add()

410

282

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

283

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

284

self.cleanup()

285

os._exit(1)

286

self.rename_count += 1

287

420

288

def remove(self):

421

289

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

422

290

if self.entry_group_state_changed_match is not None:

424

292

self.entry_group_state_changed_match = None

425

293

if self.group is not None:

426

294

self.group.Reset()

427

295

428

296

def add(self):

429

297

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

430

298

self.remove()

447

315

dbus.UInt16(self.port),

448

316

avahi.string_array_to_txt_array(self.TXT))

449

317

self.group.Commit()

450

318

451

319

def entry_group_state_changed(self, state, error):

452

320

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

453

321

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

454

322

455

323

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

324

logger.debug("Zeroconf service established.")

457

325

elif state == avahi.ENTRY_GROUP_COLLISION:

459

327

self.rename()

460

328

elif state == avahi.ENTRY_GROUP_FAILURE:

461

329

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

462

str(error))

463

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

464

330

unicode(error))

331

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

332

.format(error))

333

465

334

def cleanup(self):

466

335

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

467

336

if self.group is not None:

472

341

pass

473

342

self.group = None

474

343

self.remove()

475

344

476

345

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

477

346

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

478

347

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

}

348

bad_states = { avahi.SERVER_INVALID:

349

"Zeroconf server invalid",

350

avahi.SERVER_REGISTERING: None,

351

avahi.SERVER_COLLISION:

352

"Zeroconf server name collision",

353

avahi.SERVER_FAILURE:

354

"Zeroconf server failure" }

485

355

if state in bad_states:

486

356

if bad_states[state] is not None:

487

357

if error is None:

490

360

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

491

361

self.cleanup()

492

362

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)

363

self.add()

505

364

else:

506

365

if error is None:

507

366

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

508

367

else:

509

368

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

510

369

511

370

def activate(self):

512

371

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

513

372

if self.server is None:

517

376

follow_name_owner_changes=True),

518

377

avahi.DBUS_INTERFACE_SERVER)

519

378

self.server.connect_to_signal("StateChanged",

520

self.server_state_changed)

379

self.server_state_changed)

521

380

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

522

381

523

382

524

383

class AvahiServiceToSyslog(AvahiService):

525

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

384

def rename(self):

526

385

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

386

ret = AvahiService.rename(self)

387

syslogger.setFormatter(logging.Formatter

388

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

389

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

390

.format(self.name)))

532

391

return ret

533

392

534

393

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)

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

# Classes

605

class Credentials:

606

def __init__(self):

607

self._c_object = gnutls.certificate_credentials_t()

608

gnutls.certificate_allocate_credentials(

609

ctypes.byref(self._c_object))

610

self.type = gnutls.CRD_CERTIFICATE

611

612

def __del__(self):

613

gnutls.certificate_free_credentials(self._c_object)

614

615

class ClientSession:

616

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

617

self._c_object = gnutls.session_t()

618

gnutls_flags = gnutls.CLIENT

619

if gnutls.check_version(b"3.5.6"):

620

gnutls_flags |= gnutls.NO_TICKETS

621

if gnutls.has_rawpk:

622

gnutls_flags |= gnutls.ENABLE_RAWPK

623

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

624

del gnutls_flags

625

gnutls.set_default_priority(self._c_object)

626

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

627

gnutls.handshake_set_private_extensions(self._c_object,

628

True)

629

self.socket = socket

630

if credentials is None:

631

credentials = gnutls.Credentials()

632

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

633

ctypes.cast(credentials._c_object,

634

ctypes.c_void_p))

635

self.credentials = credentials

636

637

def __del__(self):

638

gnutls.deinit(self._c_object)

639

640

def handshake(self):

641

return gnutls.handshake(self._c_object)

642

643

def send(self, data):

644

data = bytes(data)

645

data_len = len(data)

646

while data_len > 0:

647

data_len -= gnutls.record_send(self._c_object,

648

data[-data_len:],

649

data_len)

650

651

def bye(self):

652

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

653

654

# Error handling functions

655

def _error_code(result):

656

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

657

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

658

if result >= 0:

659

return result

660

if result == gnutls.E_NO_CERTIFICATE_FOUND:

661

raise gnutls.CertificateSecurityError(code=result)

662

raise gnutls.Error(code=result)

663

664

def _retry_on_error(result, func, arguments,

665

_error_code=_error_code):

666

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

667

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

668

while result < 0:

669

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

670

return _error_code(result)

671

result = func(*arguments)

672

return result

673

674

# Unless otherwise indicated, the function declarations below are

675

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

676

677

# Functions

678

priority_set_direct = _library.gnutls_priority_set_direct

679

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

680

ctypes.POINTER(ctypes.c_char_p)]

681

priority_set_direct.restype = _error_code

682

683

init = _library.gnutls_init

684

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

685

init.restype = _error_code

686

687

set_default_priority = _library.gnutls_set_default_priority

688

set_default_priority.argtypes = [session_t]

689

set_default_priority.restype = _error_code

690

691

record_send = _library.gnutls_record_send

692

record_send.argtypes = [session_t, ctypes.c_void_p,

693

ctypes.c_size_t]

694

record_send.restype = ctypes.c_ssize_t

695

record_send.errcheck = _retry_on_error

696

697

certificate_allocate_credentials = (

698

_library.gnutls_certificate_allocate_credentials)

699

certificate_allocate_credentials.argtypes = [

700

ctypes.POINTER(certificate_credentials_t)]

701

certificate_allocate_credentials.restype = _error_code

702

703

certificate_free_credentials = (

704

_library.gnutls_certificate_free_credentials)

705

certificate_free_credentials.argtypes = [

706

certificate_credentials_t]

707

certificate_free_credentials.restype = None

708

709

handshake_set_private_extensions = (

710

_library.gnutls_handshake_set_private_extensions)

711

handshake_set_private_extensions.argtypes = [session_t,

712

ctypes.c_int]

713

handshake_set_private_extensions.restype = None

714

715

credentials_set = _library.gnutls_credentials_set

716

credentials_set.argtypes = [session_t, credentials_type_t,

717

ctypes.c_void_p]

718

credentials_set.restype = _error_code

719

720

strerror = _library.gnutls_strerror

721

strerror.argtypes = [ctypes.c_int]

722

strerror.restype = ctypes.c_char_p

723

724

certificate_type_get = _library.gnutls_certificate_type_get

725

certificate_type_get.argtypes = [session_t]

726

certificate_type_get.restype = _error_code

727

728

certificate_get_peers = _library.gnutls_certificate_get_peers

729

certificate_get_peers.argtypes = [session_t,

730

ctypes.POINTER(ctypes.c_uint)]

731

certificate_get_peers.restype = ctypes.POINTER(datum_t)

732

733

global_set_log_level = _library.gnutls_global_set_log_level

734

global_set_log_level.argtypes = [ctypes.c_int]

735

global_set_log_level.restype = None

736

737

global_set_log_function = _library.gnutls_global_set_log_function

738

global_set_log_function.argtypes = [log_func]

739

global_set_log_function.restype = None

740

741

deinit = _library.gnutls_deinit

742

deinit.argtypes = [session_t]

743

deinit.restype = None

744

745

handshake = _library.gnutls_handshake

746

handshake.argtypes = [session_t]

747

handshake.restype = _error_code

748

handshake.errcheck = _retry_on_error

749

750

transport_set_ptr = _library.gnutls_transport_set_ptr

751

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

752

transport_set_ptr.restype = None

753

754

bye = _library.gnutls_bye

755

bye.argtypes = [session_t, close_request_t]

756

bye.restype = _error_code

757

bye.errcheck = _retry_on_error

758

759

check_version = _library.gnutls_check_version

760

check_version.argtypes = [ctypes.c_char_p]

761

check_version.restype = ctypes.c_char_p

762

763

_need_version = b"3.3.0"

764

if check_version(_need_version) is None:

765

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

766

.format(_need_version))

767

768

_tls_rawpk_version = b"3.6.6"

769

has_rawpk = bool(check_version(_tls_rawpk_version))

770

771

if has_rawpk:

772

# Types

773

class pubkey_st(ctypes.Structure):

774

_fields = []

775

pubkey_t = ctypes.POINTER(pubkey_st)

776

777

x509_crt_fmt_t = ctypes.c_int

778

779

# All the function declarations below are from

780

# gnutls/abstract.h

781

pubkey_init = _library.gnutls_pubkey_init

782

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

783

pubkey_init.restype = _error_code

784

785

pubkey_import = _library.gnutls_pubkey_import

786

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

787

x509_crt_fmt_t]

788

pubkey_import.restype = _error_code

789

790

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

791

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

792

ctypes.POINTER(ctypes.c_ubyte),

793

ctypes.POINTER(ctypes.c_size_t)]

794

pubkey_get_key_id.restype = _error_code

795

796

pubkey_deinit = _library.gnutls_pubkey_deinit

797

pubkey_deinit.argtypes = [pubkey_t]

798

pubkey_deinit.restype = None

799

else:

800

# All the function declarations below are from

801

# gnutls/openpgp.h

802

803

openpgp_crt_init = _library.gnutls_openpgp_crt_init

804

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

805

openpgp_crt_init.restype = _error_code

806

807

openpgp_crt_import = _library.gnutls_openpgp_crt_import

808

openpgp_crt_import.argtypes = [openpgp_crt_t,

809

ctypes.POINTER(datum_t),

810

openpgp_crt_fmt_t]

811

openpgp_crt_import.restype = _error_code

812

813

openpgp_crt_verify_self = \

814

_library.gnutls_openpgp_crt_verify_self

815

openpgp_crt_verify_self.argtypes = [

816

openpgp_crt_t,

817

ctypes.c_uint,

818

ctypes.POINTER(ctypes.c_uint),

819

]

820

openpgp_crt_verify_self.restype = _error_code

821

822

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

823

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

824

openpgp_crt_deinit.restype = None

825

826

openpgp_crt_get_fingerprint = (

827

_library.gnutls_openpgp_crt_get_fingerprint)

828

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

829

ctypes.c_void_p,

830

ctypes.POINTER(

831

ctypes.c_size_t)]

832

openpgp_crt_get_fingerprint.restype = _error_code

833

834

if check_version(b"3.6.4"):

835

certificate_type_get2 = _library.gnutls_certificate_type_get2

836

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

837

certificate_type_get2.restype = _error_code

838

839

# Remove non-public functions

840

del _error_code, _retry_on_error

841

842

843

def call_pipe(connection, # : multiprocessing.Connection

844

func, *args, **kwargs):

845

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

846

847

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

848

return value on the provided multiprocessing.Connection.

849

"""

850

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

851

connection.close()

852

853

854

class Client:

394

def timedelta_to_milliseconds(td):

395

"Convert a datetime.timedelta() to milliseconds"

396

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

397

+ (td.seconds * 1000)

398

+ (td.microseconds // 1000))

399

400

401

class Client(object):

855

402

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

856

403

857

404

Attributes:

858

405

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

859

406

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

860

407

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

861

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

862

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

863

running.

864

checker_callback_tag: a GLib event source tag, or None

408

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

409

to see if the client lives.

410

'None' if no process is running.

411

checker_callback_tag: a gobject event source tag, or None

865

412

checker_command: string; External command which is run to check

866

413

if client lives. %() expansions are done at

867

414

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

868

415

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

869

checker_initiator_tag: a GLib event source tag, or None

416

checker_initiator_tag: a gobject event source tag, or None

870

417

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

871

418

client_structure: Object describing what attributes a client has

872

419

and is used for storing the client at exit

873

420

current_checker_command: string; current running checker_command

874

disable_initiator_tag: a GLib event source tag, or None

421

disable_initiator_tag: a gobject event source tag, or None

875

422

enabled: bool()

876

423

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

877

uniquely identify an OpenPGP client

878

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

879

a client using raw public keys

424

uniquely identify the client

880

425

host: string; available for use by the checker command

881

426

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

882

427

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

884

429

last_checker_status: integer between 0 and 255 reflecting exit

885

430

status of last checker. -1 reflects crashed

886

431

checker, -2 means no checker completed yet.

887

last_checker_signal: The signal which killed the last checker, if

888

last_checker_status is -1

889

432

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

890

433

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

891

434

D-Bus identifiers

896

439

runtime_expansions: Allowed attributes for runtime expansion.

897

440

expires: datetime.datetime(); time (UTC) when a client will be

898

441

disabled, or None

899

server_settings: The server_settings dict from main()

900

442

"""

901

443

902

444

runtime_expansions = ("approval_delay", "approval_duration",

903

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

445

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

904

446

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

905

447

"last_approval_request", "last_checked_ok",

906

448

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

907

client_defaults = {

908

"timeout": "PT5M",

909

"extended_timeout": "PT15M",

910

"interval": "PT2M",

911

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

912

"host": "",

913

"approval_delay": "PT0S",

914

"approval_duration": "PT1S",

915

"approved_by_default": "True",

916

"enabled": "True",

917

}

918

449

client_defaults = { "timeout": "5m",

450

"extended_timeout": "15m",

451

"interval": "2m",

452

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

453

"host": "",

454

"approval_delay": "0s",

455

"approval_duration": "1s",

456

"approved_by_default": "True",

457

"enabled": "True",

458

}

459

460

def timeout_milliseconds(self):

461

"Return the 'timeout' attribute in milliseconds"

462

return timedelta_to_milliseconds(self.timeout)

463

464

def extended_timeout_milliseconds(self):

465

"Return the 'extended_timeout' attribute in milliseconds"

466

return timedelta_to_milliseconds(self.extended_timeout)

467

468

def interval_milliseconds(self):

469

"Return the 'interval' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.interval)

471

472

def approval_delay_milliseconds(self):

473

return timedelta_to_milliseconds(self.approval_delay)

474

919

475

@staticmethod

920

476

def config_parser(config):

921

477

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

928

484

for client_name in config.sections():

929

485

section = dict(config.items(client_name))

930

486

client = settings[client_name] = {}

931

487

932

488

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

933

489

# Reformat values from string types to Python types

934

490

client["approved_by_default"] = config.getboolean(

935

491

client_name, "approved_by_default")

936

492

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

937

493

"enabled")

938

939

# Uppercase and remove spaces from key_id and fingerprint

940

# for later comparison purposes with return value from the

941

# key_id() and fingerprint() functions

942

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

943

.replace(" ", ""))

494

944

495

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

945

496

.replace(" ", ""))

946

497

if "secret" in section:

947

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

948

.encode("utf-8"),

949

"base64")

498

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

950

499

elif "secfile" in section:

951

500

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

952

501

(section["secfile"])),

953

502

"rb") as secfile:

954

503

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

955

504

else:

956

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

505

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

957

506

.format(section))

958

507

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

959

508

client["extended_timeout"] = string_to_delta(

967

516

client["last_approval_request"] = None

968

517

client["last_checked_ok"] = None

969

518

client["last_checker_status"] = -2

970

519

971

520

return settings

972

973

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

521

522

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

974

523

self.name = name

975

if server_settings is None:

976

server_settings = {}

977

self.server_settings = server_settings

978

524

# adding all client settings

979

for setting, value in settings.items():

525

for setting, value in settings.iteritems():

980

526

setattr(self, setting, value)

981

527

982

528

if self.enabled:

983

529

if not hasattr(self, "last_enabled"):

984

530

self.last_enabled = datetime.datetime.utcnow()

988

534

else:

989

535

self.last_enabled = None

990

536

self.expires = None

991

537

992

538

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

993

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

539

# Uppercase and remove spaces from fingerprint for later

540

# comparison purposes with return value from the fingerprint()

541

# function

994

542

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

995

543

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

996

544

datetime.datetime.utcnow())

997

545

998

546

# attributes specific for this server instance

999

547

self.checker = None

1000

548

self.checker_initiator_tag = None

1003

551

self.current_checker_command = None

1004

552

self.approved = None

1005

553

self.approvals_pending = 0

1006

self.changedstate = multiprocessing_manager.Condition(

1007

multiprocessing_manager.Lock())

1008

self.client_structure = [attr

1009

for attr in self.__dict__.keys()

554

self.changedstate = (multiprocessing_manager

555

.Condition(multiprocessing_manager

556

.Lock()))

557

self.client_structure = [attr for attr in

558

self.__dict__.iterkeys()

1010

559

if not attr.startswith("_")]

1011

560

self.client_structure.append("client_structure")

1012

1013

for name, t in inspect.getmembers(

1014

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

561

562

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

563

lambda obj:

564

isinstance(obj,

565

property)):

1015

566

if not name.startswith("_"):

1016

567

self.client_structure.append(name)

1017

568

1018

569

# Send notice to process children that client state has changed

1019

570

def send_changedstate(self):

1020

571

with self.changedstate:

1021

572

self.changedstate.notify_all()

1022

573

1023

574

def enable(self):

1024

575

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

1025

576

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

1030

581

self.last_enabled = datetime.datetime.utcnow()

1031

582

self.init_checker()

1032

583

self.send_changedstate()

1033

584

1034

585

def disable(self, quiet=True):

1035

586

"""Disable this client."""

1036

587

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

1038

589

if not quiet:

1039

590

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

1040

591

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

1041

GLib.source_remove(self.disable_initiator_tag)

592

gobject.source_remove(self.disable_initiator_tag)

1042

593

self.disable_initiator_tag = None

1043

594

self.expires = None

1044

595

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

1045

GLib.source_remove(self.checker_initiator_tag)

596

gobject.source_remove(self.checker_initiator_tag)

1046

597

self.checker_initiator_tag = None

1047

598

self.stop_checker()

1048

599

self.enabled = False

1049

600

if not quiet:

1050

601

self.send_changedstate()

1051

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

602

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

1052

603

return False

1053

604

1054

605

def __del__(self):

1055

606

self.disable()

1056

607

1057

608

def init_checker(self):

1058

609

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

1059

610

# and every interval from then on.

1060

611

if self.checker_initiator_tag is not None:

1061

GLib.source_remove(self.checker_initiator_tag)

1062

self.checker_initiator_tag = GLib.timeout_add(

1063

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

1064

+ 1)),

1065

self.start_checker)

612

gobject.source_remove(self.checker_initiator_tag)

613

self.checker_initiator_tag = (gobject.timeout_add

614

(self.interval_milliseconds(),

615

self.start_checker))

1066

616

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

1067

617

if self.disable_initiator_tag is not None:

1068

GLib.source_remove(self.disable_initiator_tag)

1069

self.disable_initiator_tag = GLib.timeout_add(

1070

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

618

gobject.source_remove(self.disable_initiator_tag)

619

self.disable_initiator_tag = (gobject.timeout_add

620

(self.timeout_milliseconds(),

621

self.disable))

1071

622

# Also start a new checker *right now*.

1072

623

self.start_checker()

1073

1074

def checker_callback(self, source, condition, connection,

1075

command):

624

625

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

1076

626

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

1077

# Read return code from connection (see call_pipe)

1078

returncode = connection.recv()

1079

connection.close()

1080

if self.checker is not None:

1081

self.checker.join()

1082

627

self.checker_callback_tag = None

1083

628

self.checker = None

1084

1085

if returncode >= 0:

1086

self.last_checker_status = returncode

1087

self.last_checker_signal = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1088

631

if self.last_checker_status == 0:

1089

632

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

1090

633

vars(self))

1091

634

self.checked_ok()

1092

635

else:

1093

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

636

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

637

vars(self))

1094

638

else:

1095

639

self.last_checker_status = -1

1096

self.last_checker_signal = -returncode

1097

640

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

1098

641

vars(self))

1099

return False

1100

642

1101

643

def checked_ok(self):

1102

644

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

1103

645

self.last_checked_ok = datetime.datetime.utcnow()

1104

646

self.last_checker_status = 0

1105

self.last_checker_signal = None

1106

647

self.bump_timeout()

1107

648

1108

649

def bump_timeout(self, timeout=None):

1109

650

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

1110

651

if timeout is None:

1111

652

timeout = self.timeout

1112

653

if self.disable_initiator_tag is not None:

1113

GLib.source_remove(self.disable_initiator_tag)

654

gobject.source_remove(self.disable_initiator_tag)

1114

655

self.disable_initiator_tag = None

1115

656

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

1116

self.disable_initiator_tag = GLib.timeout_add(

1117

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(timedelta_to_milliseconds

659

(timeout), self.disable))

1118

660

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

1119

661

1120

662

def need_approval(self):

1121

663

self.last_approval_request = datetime.datetime.utcnow()

1122

664

1123

665

def start_checker(self):

1124

666

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

1125

667

1126

668

If a checker already exists, leave it running and do

1127

669

nothing."""

1128

670

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

1133

675

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

1134

676

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

1135

677

# should be.

1136

1137

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

1138

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

1139

self.checker.join()

1140

self.checker = None

678

679

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

680

try:

681

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

682

except (AttributeError, OSError) as error:

683

if (isinstance(error, OSError)

684

and error.errno != errno.ECHILD):

685

raise error

686

else:

687

if pid:

688

logger.warning("Checker was a zombie")

689

gobject.source_remove(self.checker_callback_tag)

690

self.checker_callback(pid, status,

691

self.current_checker_command)

1141

692

# Start a new checker if needed

1142

693

if self.checker is None:

1143

694

# Escape attributes for the shell

1144

escaped_attrs = {

1145

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

1146

for attr in self.runtime_expansions}

695

escaped_attrs = dict(

696

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

697

for attr in

698

self.runtime_expansions)

1147

699

try:

1148

700

command = self.checker_command % escaped_attrs

1149

701

except TypeError as error:

1150

702

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

1151

self.checker_command,

703

self.checker_command, exc_info=error)

704

return True # Try again later

705

self.current_checker_command = command

706

try:

707

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

708

command, self.name)

709

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

710

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

711

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

712

# always replaced by /dev/null.)

713

self.checker = subprocess.Popen(command,

714

close_fds=True,

715

shell=True, cwd="/")

716

except OSError as error:

717

logger.error("Failed to start subprocess",

1152

718

exc_info=error)

1153

return True # Try again later

1154

self.current_checker_command = command

1155

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

1156

self.name)

1157

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

1158

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

1159

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

1160

# always replaced by /dev/null.)

1161

# The exception is when not debugging but nevertheless

1162

# running in the foreground; use the previously

1163

# created wnull.

1164

popen_args = {"close_fds": True,

1165

"shell": True,

1166

"cwd": "/"}

1167

if (not self.server_settings["debug"]

1168

and self.server_settings["foreground"]):

1169

popen_args.update({"stdout": wnull,

1170

"stderr": wnull})

1171

pipe = multiprocessing.Pipe(duplex=False)

1172

self.checker = multiprocessing.Process(

1173

target=call_pipe,

1174

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

1175

kwargs=popen_args)

1176

self.checker.start()

1177

self.checker_callback_tag = GLib.io_add_watch(

1178

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

1179

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1180

self.checker_callback, pipe[0], command)

1181

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

719

self.checker_callback_tag = (gobject.child_watch_add

720

(self.checker.pid,

721

self.checker_callback,

722

data=command))

723

# The checker may have completed before the gobject

724

# watch was added. Check for this.

725

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

726

if pid:

727

gobject.source_remove(self.checker_callback_tag)

728

self.checker_callback(pid, status, command)

729

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

1182

730

return True

1183

731

1184

732

def stop_checker(self):

1185

733

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

1186

734

if self.checker_callback_tag:

1187

GLib.source_remove(self.checker_callback_tag)

735

gobject.source_remove(self.checker_callback_tag)

1188

736

self.checker_callback_tag = None

1189

737

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

1190

738

return

1191

739

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

1192

self.checker.terminate()

740

try:

741

self.checker.terminate()

742

#time.sleep(0.5)

743

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

744

# self.checker.kill()

745

except OSError as error:

746

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

747

raise

1193

748

self.checker = None

1194

749

1195

750

1196

def dbus_service_property(dbus_interface,

1197

signature="v",

1198

access="readwrite",

1199

byte_arrays=False):

751

def dbus_service_property(dbus_interface, signature="v",

752

access="readwrite", byte_arrays=False):

1200

753

"""Decorators for marking methods of a DBusObjectWithProperties to

1201

754

become properties on the D-Bus.

1202

755

1203

756

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

1204

757

and with one argument by "Set".

1205

758

1206

759

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

1207

760

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

1208

761

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

1211

764

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

1212

765

if byte_arrays and signature != "ay":

1213

766

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

1214

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

1215

767

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

1216

768

def decorator(func):

1217

769

func._dbus_is_property = True

1218

770

func._dbus_interface = dbus_interface

1221

773

func._dbus_name = func.__name__

1222

774

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

1223

775

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

1224

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

776

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1225

777

return func

1226

1227

778

return decorator

1228

779

1229

780

1230

781

def dbus_interface_annotations(dbus_interface):

1231

782

"""Decorator for marking functions returning interface annotations

1232

783

1233

784

Usage:

1234

785

1235

786

@dbus_interface_annotations("org.example.Interface")

1236

787

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

1237

788

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

1238

789

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

1239

790

"false"}

1240

791

"""

1241

1242

792

def decorator(func):

1243

793

func._dbus_is_interface = True

1244

794

func._dbus_interface = dbus_interface

1245

795

func._dbus_name = dbus_interface

1246

796

return func

1247

1248

797

return decorator

1249

798

1250

799

1251

800

def dbus_annotations(annotations):

1252

801

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

1253

802

Usage:

1254

1255

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

1256

"org.freedesktop.DBus.Property."

1257

"EmitsChangedSignal": "false"})

803

1258

804

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

1259

805

access="r")

806

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

807

"org.freedesktop.DBus.Property."

808

"EmitsChangedSignal": "false"})

1260

809

def Property_dbus_property(self):

1261

810

return dbus.Boolean(False)

1262

1263

See also the DBusObjectWithAnnotations class.

1264

811

"""

1265

1266

812

def decorator(func):

1267

813

func._dbus_annotations = annotations

1268

814

return func

1269

1270

815

return decorator

1271

816

1272

817

1273

818

class DBusPropertyException(dbus.exceptions.DBusException):

1274

819

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

1275

820

"""

1276

pass

821

def __unicode__(self):

822

return unicode(str(self))

1277

823

1278

824

1279

825

class DBusPropertyAccessException(DBusPropertyException):

1288

834

pass

1289

835

1290

836

1291

class DBusObjectWithAnnotations(dbus.service.Object):

1292

"""A D-Bus object with annotations.

1293

1294

Classes inheriting from this can use the dbus_annotations

1295

decorator to add annotations to methods or signals.

837

class DBusObjectWithProperties(dbus.service.Object):

838

"""A D-Bus object with properties.

839

840

Classes inheriting from this can use the dbus_service_property

841

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

842

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

1296

843

"""

1297

844

1298

845

@staticmethod

1299

846

def _is_dbus_thing(thing):

1300

847

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

1301

848

1302

849

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

1303

850

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

1304

851

"""

1305

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

852

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

1306

853

False)

1307

854

1308

855

def _get_all_dbus_things(self, thing):

1309

856

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

1310

857

"""

1311

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

858

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

859

name),

1312

860

athing.__get__(self))

1313

861

for cls in self.__class__.__mro__

1314

862

for name, athing in

1315

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

1316

1317

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1318

out_signature="s",

1319

path_keyword='object_path',

1320

connection_keyword='connection')

1321

def Introspect(self, object_path, connection):

1322

"""Overloading of standard D-Bus method.

1323

1324

Inserts annotation tags on methods and signals.

1325

"""

1326

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

1327

connection)

1328

try:

1329

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

1330

1331

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

1332

# Add annotation tags

1333

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

1334

for tag in if_tag.getElementsByTagName(typ):

1335

annots = dict()

1336

for name, prop in (self.

1337

_get_all_dbus_things(typ)):

1338

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

1339

and prop._dbus_interface

1340

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

1341

annots.update(getattr(

1342

prop, "_dbus_annotations", {}))

1343

for name, value in annots.items():

1344

ann_tag = document.createElement(

1345

"annotation")

1346

ann_tag.setAttribute("name", name)

1347

ann_tag.setAttribute("value", value)

1348

tag.appendChild(ann_tag)

1349

# Add interface annotation tags

1350

for annotation, value in dict(

1351

itertools.chain.from_iterable(

1352

annotations().items()

1353

for name, annotations

1354

in self._get_all_dbus_things("interface")

1355

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

1356

)).items():

1357

ann_tag = document.createElement("annotation")

1358

ann_tag.setAttribute("name", annotation)

1359

ann_tag.setAttribute("value", value)

1360

if_tag.appendChild(ann_tag)

1361

# Fix argument name for the Introspect method itself

1362

if (if_tag.getAttribute("name")

1363

== dbus.INTROSPECTABLE_IFACE):

1364

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

1365

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

1366

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

1367

if (arg.getAttribute("direction")

1368

== "out"):

1369

arg.setAttribute("name",

1370

"xml_data")

1371

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

1372

document.unlink()

1373

except (AttributeError, xml.dom.DOMException,

1374

xml.parsers.expat.ExpatError) as error:

1375

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

1376

exc_info=error)

1377

return xmlstring

1378

1379

1380

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1381

"""A D-Bus object with properties.

1382

1383

Classes inheriting from this can use the dbus_service_property

1384

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

1385

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

1386

"""

1387

863

inspect.getmembers(cls,

864

self._is_dbus_thing(thing)))

865

1388

866

def _get_dbus_property(self, interface_name, property_name):

1389

867

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

1390

868

property with the specified name and interface.

1391

869

"""

1392

for cls in self.__class__.__mro__:

1393

for name, value in inspect.getmembers(

1394

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

870

for cls in self.__class__.__mro__:

871

for name, value in (inspect.getmembers

872

(cls,

873

self._is_dbus_thing("property"))):

1395

874

if (value._dbus_name == property_name

1396

875

and value._dbus_interface == interface_name):

1397

876

return value.__get__(self)

1398

877

1399

878

# No such property

1400

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

1401

self.dbus_object_path, interface_name, property_name))

1402

1403

@classmethod

1404

def _get_all_interface_names(cls):

1405

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

1406

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

1407

"_dbus_interface", None)

1408

for x in (inspect.getmro(cls))

1409

for attr in dir(x))

1410

if name is not None)

1411

1412

@dbus.service.method(dbus.PROPERTIES_IFACE,

1413

in_signature="ss",

879

raise DBusPropertyNotFound(self.dbus_object_path + ":"

880

+ interface_name + "."

881

+ property_name)

882

883

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

1414

884

out_signature="v")

1415

885

def Get(self, interface_name, property_name):

1416

886

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

1422

892

if not hasattr(value, "variant_level"):

1423

893

return value

1424

894

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

1425

895

1426

896

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

1427

897

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

1428

898

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

1434

904

# The byte_arrays option is not supported yet on

1435

905

# signatures other than "ay".

1436

906

if prop._dbus_signature != "ay":

1437

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

1438

"'ay' signature {!r}"

1439

.format(prop._dbus_signature))

1440

value = dbus.ByteArray(bytes(value))

907

raise ValueError

908

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

909

for byte in value))

1441

910

prop(value)

1442

1443

@dbus.service.method(dbus.PROPERTIES_IFACE,

1444

in_signature="s",

911

912

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

1445

913

out_signature="a{sv}")

1446

914

def GetAll(self, interface_name):

1447

915

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

1448

916

standard.

1449

917

1450

918

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

1451

919

"""

1452

920

properties = {}

1462

930

if not hasattr(value, "variant_level"):

1463

931

properties[name] = value

1464

932

continue

1465

properties[name] = type(value)(

1466

value, variant_level=value.variant_level + 1)

933

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

934

value.variant_level+1)

1467

935

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

1468

1469

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

1470

def PropertiesChanged(self, interface_name, changed_properties,

1471

invalidated_properties):

1472

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

1473

standard.

1474

"""

1475

pass

1476

936

1477

937

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1478

938

out_signature="s",

1479

939

path_keyword='object_path',

1480

940

connection_keyword='connection')

1481

941

def Introspect(self, object_path, connection):

1482

942

"""Overloading of standard D-Bus method.

1483

943

1484

944

Inserts property tags and interface annotation tags.

1485

945

"""

1486

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1487

object_path,

1488

connection)

946

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

947

connection)

1489

948

try:

1490

949

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

1491

1492

950

def make_tag(document, name, prop):

1493

951

e = document.createElement("property")

1494

952

e.setAttribute("name", name)

1495

953

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

1496

954

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

1497

955

return e

1498

1499

956

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

1500

957

# Add property tags

1501

958

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

1504

961

if prop._dbus_interface

1505

962

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

1506

963

if_tag.appendChild(tag)

1507

# Add annotation tags for properties

1508

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

1509

annots = dict()

1510

for name, prop in self._get_all_dbus_things(

1511

"property"):

1512

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

1513

and prop._dbus_interface

1514

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

1515

annots.update(getattr(

1516

prop, "_dbus_annotations", {}))

1517

for name, value in annots.items():

1518

ann_tag = document.createElement(

1519

"annotation")

1520

ann_tag.setAttribute("name", name)

1521

ann_tag.setAttribute("value", value)

1522

tag.appendChild(ann_tag)

964

# Add annotation tags

965

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

966

for tag in if_tag.getElementsByTagName(typ):

967

annots = dict()

968

for name, prop in (self.

969

_get_all_dbus_things(typ)):

970

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

971

and prop._dbus_interface

972

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

973

annots.update(getattr

974

(prop,

975

"_dbus_annotations",

976

{}))

977

for name, value in annots.iteritems():

978

ann_tag = document.createElement(

979

"annotation")

980

ann_tag.setAttribute("name", name)

981

ann_tag.setAttribute("value", value)

982

tag.appendChild(ann_tag)

983

# Add interface annotation tags

984

for annotation, value in dict(

985

itertools.chain.from_iterable(

986

annotations().iteritems()

987

for name, annotations in

988

self._get_all_dbus_things("interface")

989

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

990

)).iteritems():

991

ann_tag = document.createElement("annotation")

992

ann_tag.setAttribute("name", annotation)

993

ann_tag.setAttribute("value", value)

994

if_tag.appendChild(ann_tag)

1523

995

# Add the names to the return values for the

1524

996

# "org.freedesktop.DBus.Properties" methods

1525

997

if (if_tag.getAttribute("name")

1544

1016

return xmlstring

1545

1017

1546

1018

1547

try:

1548

dbus.OBJECT_MANAGER_IFACE

1549

except AttributeError:

1550

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

1551

1552

1553

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1554

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

1555

1556

Classes inheriting from this exposes the standard

1557

GetManagedObjects call and the InterfacesAdded and

1558

InterfacesRemoved signals on the standard

1559

"org.freedesktop.DBus.ObjectManager" interface.

1560

1561

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

1562

manually.

1563

"""

1564

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1565

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

1566

def GetManagedObjects(self):

1567

"""This function must be overridden"""

1568

raise NotImplementedError()

1569

1570

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1571

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

1572

def InterfacesAdded(self, object_path, interfaces_and_properties):

1573

pass

1574

1575

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

1576

def InterfacesRemoved(self, object_path, interfaces):

1577

pass

1578

1579

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1580

out_signature="s",

1581

path_keyword='object_path',

1582

connection_keyword='connection')

1583

def Introspect(self, object_path, connection):

1584

"""Overloading of standard D-Bus method.

1585

1586

Override return argument name of GetManagedObjects to be

1587

"objpath_interfaces_and_properties"

1588

"""

1589

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1590

object_path,

1591

connection)

1592

try:

1593

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

1594

1595

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

1596

# Fix argument name for the GetManagedObjects method

1597

if (if_tag.getAttribute("name")

1598

== dbus.OBJECT_MANAGER_IFACE):

1599

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

1600

if (cn.getAttribute("name")

1601

== "GetManagedObjects"):

1602

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

1603

if (arg.getAttribute("direction")

1604

== "out"):

1605

arg.setAttribute(

1606

"name",

1607

"objpath_interfaces"

1608

"_and_properties")

1609

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

1610

document.unlink()

1611

except (AttributeError, xml.dom.DOMException,

1612

xml.parsers.expat.ExpatError) as error:

1613

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

1614

exc_info=error)

1615

return xmlstring

1616

1617

1618

1019

def datetime_to_dbus(dt, variant_level=0):

1619

1020

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

1620

1021

if dt is None:

1621

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

1622

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

1022

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

1023

return dbus.String(dt.isoformat(),

1024

variant_level=variant_level)

1623

1025

1624

1026

1625

1027

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1627

1029

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

1628

1030

interface names according to the "alt_interface_names" mapping.

1629

1031

Usage:

1630

1032

1631

1033

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

1632

1034

"net.example.AlternateInterface"})

1633

1035

class SampleDBusObject(dbus.service.Object):

1634

1036

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

1635

1037

def SampleDBusMethod():

1636

1038

pass

1637

1039

1638

1040

The above "SampleDBusMethod" on "SampleDBusObject" will be

1639

1041

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

1640

1042

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

1641

1043

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

1642

1044

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

1643

1045

1644

1046

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

1645

1047

(from DBusObjectWithProperties) and interfaces (from the

1646

1048

dbus_interface_annotations decorator).

1647

1049

"""

1648

1649

1050

def wrapper(cls):

1650

1051

for orig_interface_name, alt_interface_name in (

1651

alt_interface_names.items()):

1052

alt_interface_names.iteritems()):

1652

1053

attr = {}

1653

1054

interface_names = set()

1654

1055

# Go though all attributes of the class

1656

1057

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

1657

1058

# with the wrong interface name

1658

1059

if (not hasattr(attribute, "_dbus_interface")

1659

or not attribute._dbus_interface.startswith(

1660

orig_interface_name)):

1060

or not attribute._dbus_interface

1061

.startswith(orig_interface_name)):

1661

1062

continue

1662

1063

# Create an alternate D-Bus interface name based on

1663

1064

# the current name

1664

alt_interface = attribute._dbus_interface.replace(

1665

orig_interface_name, alt_interface_name)

1065

alt_interface = (attribute._dbus_interface

1066

.replace(orig_interface_name,

1067

alt_interface_name))

1666

1068

interface_names.add(alt_interface)

1667

1069

# Is this a D-Bus signal?

1668

1070

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

1669

# Extract the original non-method undecorated

1670

# function by black magic

1671

if sys.version_info.major == 2:

1672

nonmethod_func = (dict(

1071

# Extract the original non-method function by

1072

# black magic

1073

nonmethod_func = (dict(

1673

1074

zip(attribute.func_code.co_freevars,

1674

attribute.__closure__))

1675

["func"].cell_contents)

1676

else:

1677

nonmethod_func = (dict(

1678

zip(attribute.__code__.co_freevars,

1679

attribute.__closure__))

1680

["func"].cell_contents)

1075

attribute.__closure__))["func"]

1076

.cell_contents)

1681

1077

# Create a new, but exactly alike, function

1682

1078

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

1683

1079

# with the alternate D-Bus interface name

1684

new_function = copy_function(nonmethod_func)

1685

new_function = (dbus.service.signal(

1686

alt_interface,

1687

attribute._dbus_signature)(new_function))

1080

new_function = (dbus.service.signal

1081

(alt_interface,

1082

attribute._dbus_signature)

1083

(types.FunctionType(

1084

nonmethod_func.func_code,

1085

nonmethod_func.func_globals,

1086

nonmethod_func.func_name,

1087

nonmethod_func.func_defaults,

1088

nonmethod_func.func_closure)))

1688

1089

# Copy annotations, if any

1689

1090

try:

1690

new_function._dbus_annotations = dict(

1691

attribute._dbus_annotations)

1091

new_function._dbus_annotations = (

1092

dict(attribute._dbus_annotations))

1692

1093

except AttributeError:

1693

1094

pass

1694

1695

1095

# Define a creator of a function to call both the

1696

1096

# original and alternate functions, so both the

1697

1097

# original and alternate signals gets sent when

1700

1100

"""This function is a scope container to pass

1701

1101

func1 and func2 to the "call_both" function

1702

1102

outside of its arguments"""

1703

1704

@functools.wraps(func2)

1705

1103

def call_both(*args, **kwargs):

1706

1104

"""This function will emit two D-Bus

1707

1105

signals by calling func1 and func2"""

1708

1106

func1(*args, **kwargs)

1709

1107

func2(*args, **kwargs)

1710

# Make wrapper function look like a D-Bus

1711

# signal

1712

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

1713

if name.startswith("_dbus_"):

1714

setattr(call_both, name, attr)

1715

1716

1108

return call_both

1717

1109

# Create the "call_both" function and add it to

1718

1110

# the class

1723

1115

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

1724

1116

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

1725

1117

# to the class.

1726

attr[attrname] = (

1727

dbus.service.method(

1728

alt_interface,

1729

attribute._dbus_in_signature,

1730

attribute._dbus_out_signature)

1731

(copy_function(attribute)))

1118

attr[attrname] = (dbus.service.method

1119

(alt_interface,

1120

attribute._dbus_in_signature,

1121

attribute._dbus_out_signature)

1122

(types.FunctionType

1123

(attribute.func_code,

1124

attribute.func_globals,

1125

attribute.func_name,

1126

attribute.func_defaults,

1127

attribute.func_closure)))

1732

1128

# Copy annotations, if any

1733

1129

try:

1734

attr[attrname]._dbus_annotations = dict(

1735

attribute._dbus_annotations)

1130

attr[attrname]._dbus_annotations = (

1131

dict(attribute._dbus_annotations))

1736

1132

except AttributeError:

1737

1133

pass

1738

1134

# Is this a D-Bus property?

1741

1137

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

1742

1138

# property with the alternate D-Bus interface

1743

1139

# name. Add it to the class.

1744

attr[attrname] = (dbus_service_property(

1745

alt_interface, attribute._dbus_signature,

1746

attribute._dbus_access,

1747

attribute._dbus_get_args_options

1748

["byte_arrays"])

1749

(copy_function(attribute)))

1140

attr[attrname] = (dbus_service_property

1141

(alt_interface,

1142

attribute._dbus_signature,

1143

attribute._dbus_access,

1144

attribute

1145

._dbus_get_args_options

1146

["byte_arrays"])

1147

(types.FunctionType

1148

(attribute.func_code,

1149

attribute.func_globals,

1150

attribute.func_name,

1151

attribute.func_defaults,

1152

attribute.func_closure)))

1750

1153

# Copy annotations, if any

1751

1154

try:

1752

attr[attrname]._dbus_annotations = dict(

1753

attribute._dbus_annotations)

1155

attr[attrname]._dbus_annotations = (

1156

dict(attribute._dbus_annotations))

1754

1157

except AttributeError:

1755

1158

pass

1756

1159

# Is this a D-Bus interface?

1759

1162

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

1760

1163

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

1761

1164

# to the class.

1762

attr[attrname] = (

1763

dbus_interface_annotations(alt_interface)

1764

(copy_function(attribute)))

1165

attr[attrname] = (dbus_interface_annotations

1166

(alt_interface)

1167

(types.FunctionType

1168

(attribute.func_code,

1169

attribute.func_globals,

1170

attribute.func_name,

1171

attribute.func_defaults,

1172

attribute.func_closure)))

1765

1173

if deprecate:

1766

1174

# Deprecate all alternate interfaces

1767

iname = "_AlternateDBusNames_interface_annotation{}"

1175

iname="_AlternateDBusNames_interface_annotation{0}"

1768

1176

for interface_name in interface_names:

1769

1770

1177

@dbus_interface_annotations(interface_name)

1771

1178

def func(self):

1772

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

1773

"true"}

1179

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

1180

"true" }

1774

1181

# Find an unused name

1775

1182

for aname in (iname.format(i)

1776

1183

for i in itertools.count()):

1780

1187

if interface_names:

1781

1188

# Replace the class with a new subclass of it with

1782

1189

# methods, signals, etc. as created above.

1783

if sys.version_info.major == 2:

1784

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

1785

(cls, ), attr)

1786

else:

1787

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

1788

(cls, ), attr)

1190

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

1191

(cls,), attr)

1789

1192

return cls

1790

1791

1193

return wrapper

1792

1194

1793

1195

1794

1196

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

1795

"se.bsnet.fukt.Mandos"})

1197

"se.bsnet.fukt.Mandos"})

1796

1198

class ClientDBus(Client, DBusObjectWithProperties):

1797

1199

"""A Client class using D-Bus

1798

1200

1799

1201

Attributes:

1800

1202

dbus_object_path: dbus.ObjectPath

1801

1203

bus: dbus.SystemBus()

1802

1204

"""

1803

1205

1804

1206

runtime_expansions = (Client.runtime_expansions

1805

+ ("dbus_object_path", ))

1806

1807

_interface = "se.recompile.Mandos.Client"

1808

1207

+ ("dbus_object_path",))

1208

1809

1209

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

1810

1811

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

1210

1211

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

1812

1212

self.bus = bus

1813

1213

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

1814

1214

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

1815

1215

# the D-Bus

1816

client_object_name = str(self.name).translate(

1216

client_object_name = unicode(self.name).translate(

1817

1217

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

1818

1218

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

1819

self.dbus_object_path = dbus.ObjectPath(

1820

"/clients/" + client_object_name)

1219

self.dbus_object_path = (dbus.ObjectPath

1220

("/clients/" + client_object_name))

1821

1221

DBusObjectWithProperties.__init__(self, self.bus,

1822

1222

self.dbus_object_path)

1823

1824

def notifychangeproperty(transform_func, dbus_name,

1825

type_func=lambda x: x,

1826

variant_level=1,

1827

invalidate_only=False,

1828

_interface=_interface):

1223

1224

def notifychangeproperty(transform_func,

1225

dbus_name, type_func=lambda x: x,

1226

variant_level=1):

1829

1227

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

1830

1228

its changes to DBus.

1831

1229

1832

1230

transform_fun: Function that takes a value and a variant_level

1833

1231

and transforms it to a D-Bus type.

1834

1232

dbus_name: D-Bus name of the variable

1836

1234

to the D-Bus. Default: no transform

1837

1235

variant_level: D-Bus variant level. Default: 1

1838

1236

"""

1839

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

1840

1237

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

1841

1238

def setter(self, value):

1842

1239

if hasattr(self, "dbus_object_path"):

1843

1240

if (not hasattr(self, attrname) or

1844

1241

type_func(getattr(self, attrname, None))

1845

1242

!= type_func(value)):

1846

if invalidate_only:

1847

self.PropertiesChanged(

1848

_interface, dbus.Dictionary(),

1849

dbus.Array((dbus_name, )))

1850

else:

1851

dbus_value = transform_func(

1852

type_func(value),

1853

variant_level=variant_level)

1854

self.PropertyChanged(dbus.String(dbus_name),

1855

dbus_value)

1856

self.PropertiesChanged(

1857

_interface,

1858

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

1859

dbus_value}),

1860

dbus.Array())

1243

dbus_value = transform_func(type_func(value),

1244

variant_level

1245

=variant_level)

1246

self.PropertyChanged(dbus.String(dbus_name),

1247

dbus_value)

1861

1248

setattr(self, attrname, value)

1862

1249

1863

1250

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

1864

1251

1865

1252

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1866

1253

approvals_pending = notifychangeproperty(dbus.Boolean,

1867

1254

"ApprovalPending",

1868

type_func=bool)

1255

type_func = bool)

1869

1256

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

1870

1257

last_enabled = notifychangeproperty(datetime_to_dbus,

1871

1258

"LastEnabled")

1872

checker = notifychangeproperty(

1873

dbus.Boolean, "CheckerRunning",

1874

type_func=lambda checker: checker is not None)

1259

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

1260

type_func = lambda checker:

1261

checker is not None)

1875

1262

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1876

1263

"LastCheckedOK")

1877

1264

last_checker_status = notifychangeproperty(dbus.Int16,

1880

1267

datetime_to_dbus, "LastApprovalRequest")

1881

1268

approved_by_default = notifychangeproperty(dbus.Boolean,

1882

1269

"ApprovedByDefault")

1883

approval_delay = notifychangeproperty(

1884

dbus.UInt64, "ApprovalDelay",

1885

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

1270

approval_delay = notifychangeproperty(dbus.UInt64,

1271

"ApprovalDelay",

1272

type_func =

1273

timedelta_to_milliseconds)

1886

1274

approval_duration = notifychangeproperty(

1887

1275

dbus.UInt64, "ApprovalDuration",

1888

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

1276

type_func = timedelta_to_milliseconds)

1889

1277

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

1890

timeout = notifychangeproperty(

1891

dbus.UInt64, "Timeout",

1892

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

1278

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

1279

type_func =

1280

timedelta_to_milliseconds)

1893

1281

extended_timeout = notifychangeproperty(

1894

1282

dbus.UInt64, "ExtendedTimeout",

1895

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

1896

interval = notifychangeproperty(

1897

dbus.UInt64, "Interval",

1898

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

1283

type_func = timedelta_to_milliseconds)

1284

interval = notifychangeproperty(dbus.UInt64,

1285

"Interval",

1286

type_func =

1287

timedelta_to_milliseconds)

1899

1288

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

1900

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

1901

invalidate_only=True)

1902

1289

1903

1290

del notifychangeproperty

1904

1291

1905

1292

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

1906

1293

try:

1907

1294

self.remove_from_connection()

1910

1297

if hasattr(DBusObjectWithProperties, "__del__"):

1911

1298

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

1912

1299

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

1913

1914

def checker_callback(self, source, condition,

1915

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

1916

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

1917

connection, command, *args,

1918

**kwargs)

1919

exitstatus = self.last_checker_status

1920

if exitstatus >= 0:

1300

1301

def checker_callback(self, pid, condition, command,

1302

*args, **kwargs):

1303

self.checker_callback_tag = None

1304

self.checker = None

1305

if os.WIFEXITED(condition):

1306

exitstatus = os.WEXITSTATUS(condition)

1921

1307

# Emit D-Bus signal

1922

1308

self.CheckerCompleted(dbus.Int16(exitstatus),

1923

# This is specific to GNU libC

1924

dbus.Int64(exitstatus << 8),

1309

dbus.Int64(condition),

1925

1310

dbus.String(command))

1926

1311

else:

1927

1312

# Emit D-Bus signal

1928

1313

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

1929

dbus.Int64(

1930

# This is specific to GNU libC

1931

(exitstatus << 8)

1932

| self.last_checker_signal),

1314

dbus.Int64(condition),

1933

1315

dbus.String(command))

1934

return ret

1935

1316

1317

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

1318

*args, **kwargs)

1319

1936

1320

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

1937

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

1321

old_checker = self.checker

1322

if self.checker is not None:

1323

old_checker_pid = self.checker.pid

1324

else:

1325

old_checker_pid = None

1938

1326

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

1939

1327

# Only if new checker process was started

1940

1328

if (self.checker is not None

1942

1330

# Emit D-Bus signal

1943

1331

self.CheckerStarted(self.current_checker_command)

1944

1332

return r

1945

1333

1946

1334

def _reset_approved(self):

1947

1335

self.approved = None

1948

1336

return False

1949

1337

1950

1338

def approve(self, value=True):

1951

1339

self.approved = value

1952

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

1953

* 1000), self._reset_approved)

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1954

1343

self.send_changedstate()

1955

1956

# D-Bus methods, signals & properties

1957

1958

# Interfaces

1959

1960

# Signals

1961

1344

1345

## D-Bus methods, signals & properties

1346

_interface = "se.recompile.Mandos.Client"

1347

1348

## Interfaces

1349

1350

@dbus_interface_annotations(_interface)

1351

def _foo(self):

1352

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

1353

"false"}

1354

1355

## Signals

1356

1962

1357

# CheckerCompleted - signal

1963

1358

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

1964

1359

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

1965

1360

"D-Bus signal"

1966

1361

pass

1967

1362

1968

1363

# CheckerStarted - signal

1969

1364

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

1970

1365

def CheckerStarted(self, command):

1971

1366

"D-Bus signal"

1972

1367

pass

1973

1368

1974

1369

# PropertyChanged - signal

1975

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

1976

1370

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

1977

1371

def PropertyChanged(self, property, value):

1978

1372

"D-Bus signal"

1979

1373

pass

1980

1374

1981

1375

# GotSecret - signal

1982

1376

@dbus.service.signal(_interface)

1983

1377

def GotSecret(self):

1986

1380

server to mandos-client

1987

1381

"""

1988

1382

pass

1989

1383

1990

1384

# Rejected - signal

1991

1385

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

1992

1386

def Rejected(self, reason):

1993

1387

"D-Bus signal"

1994

1388

pass

1995

1389

1996

1390

# NeedApproval - signal

1997

1391

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

1998

1392

def NeedApproval(self, timeout, default):

1999

1393

"D-Bus signal"

2000

1394

return self.need_approval()

2001

2002

# Methods

2003

1395

1396

## Methods

1397

2004

1398

# Approve - method

2005

1399

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

2006

1400

def Approve(self, value):

2007

1401

self.approve(value)

2008

1402

2009

1403

# CheckedOK - method

2010

1404

@dbus.service.method(_interface)

2011

1405

def CheckedOK(self):

2012

1406

self.checked_ok()

2013

1407

2014

1408

# Enable - method

2015

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

2016

1409

@dbus.service.method(_interface)

2017

1410

def Enable(self):

2018

1411

"D-Bus method"

2019

1412

self.enable()

2020

1413

2021

1414

# StartChecker - method

2022

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

2023

1415

@dbus.service.method(_interface)

2024

1416

def StartChecker(self):

2025

1417

"D-Bus method"

2026

1418

self.start_checker()

2027

1419

2028

1420

# Disable - method

2029

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

2030

1421

@dbus.service.method(_interface)

2031

1422

def Disable(self):

2032

1423

"D-Bus method"

2033

1424

self.disable()

2034

1425

2035

1426

# StopChecker - method

2036

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

2037

1427

@dbus.service.method(_interface)

2038

1428

def StopChecker(self):

2039

1429

self.stop_checker()

2040

2041

# Properties

2042

1430

1431

## Properties

1432

2043

1433

# ApprovalPending - property

2044

1434

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

2045

1435

def ApprovalPending_dbus_property(self):

2046

1436

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

2047

1437

2048

1438

# ApprovedByDefault - property

2049

@dbus_service_property(_interface,

2050

signature="b",

1439

@dbus_service_property(_interface, signature="b",

2051

1440

access="readwrite")

2052

1441

def ApprovedByDefault_dbus_property(self, value=None):

2053

1442

if value is None: # get

2054

1443

return dbus.Boolean(self.approved_by_default)

2055

1444

self.approved_by_default = bool(value)

2056

1445

2057

1446

# ApprovalDelay - property

2058

@dbus_service_property(_interface,

2059

signature="t",

1447

@dbus_service_property(_interface, signature="t",

2060

1448

access="readwrite")

2061

1449

def ApprovalDelay_dbus_property(self, value=None):

2062

1450

if value is None: # get

2063

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

2064

* 1000)

1451

return dbus.UInt64(self.approval_delay_milliseconds())

2065

1452

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

2066

1453

2067

1454

# ApprovalDuration - property

2068

@dbus_service_property(_interface,

2069

signature="t",

1455

@dbus_service_property(_interface, signature="t",

2070

1456

access="readwrite")

2071

1457

def ApprovalDuration_dbus_property(self, value=None):

2072

1458

if value is None: # get

2073

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

2074

* 1000)

1459

return dbus.UInt64(timedelta_to_milliseconds(

1460

self.approval_duration))

2075

1461

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

2076

1462

2077

1463

# Name - property

2078

@dbus_annotations(

2079

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

2080

1464

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

2081

1465

def Name_dbus_property(self):

2082

1466

return dbus.String(self.name)

2083

2084

# KeyID - property

2085

@dbus_annotations(

2086

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

2087

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

2088

def KeyID_dbus_property(self):

2089

return dbus.String(self.key_id)

2090

1467

2091

1468

# Fingerprint - property

2092

@dbus_annotations(

2093

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

2094

1469

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

2095

1470

def Fingerprint_dbus_property(self):

2096

1471

return dbus.String(self.fingerprint)

2097

1472

2098

1473

# Host - property

2099

@dbus_service_property(_interface,

2100

signature="s",

1474

@dbus_service_property(_interface, signature="s",

2101

1475

access="readwrite")

2102

1476

def Host_dbus_property(self, value=None):

2103

1477

if value is None: # get

2104

1478

return dbus.String(self.host)

2105

self.host = str(value)

2106

1479

self.host = unicode(value)

1480

2107

1481

# Created - property

2108

@dbus_annotations(

2109

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

2110

1482

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

2111

1483

def Created_dbus_property(self):

2112

1484

return datetime_to_dbus(self.created)

2113

1485

2114

1486

# LastEnabled - property

2115

1487

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

2116

1488

def LastEnabled_dbus_property(self):

2117

1489

return datetime_to_dbus(self.last_enabled)

2118

1490

2119

1491

# Enabled - property

2120

@dbus_service_property(_interface,

2121

signature="b",

1492

@dbus_service_property(_interface, signature="b",

2122

1493

access="readwrite")

2123

1494

def Enabled_dbus_property(self, value=None):

2124

1495

if value is None: # get

2127

1498

self.enable()

2128

1499

else:

2129

1500

self.disable()

2130

1501

2131

1502

# LastCheckedOK - property

2132

@dbus_service_property(_interface,

2133

signature="s",

1503

@dbus_service_property(_interface, signature="s",

2134

1504

access="readwrite")

2135

1505

def LastCheckedOK_dbus_property(self, value=None):

2136

1506

if value is not None:

2137

1507

self.checked_ok()

2138

1508

return

2139

1509

return datetime_to_dbus(self.last_checked_ok)

2140

1510

2141

1511

# LastCheckerStatus - property

2142

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

1512

@dbus_service_property(_interface, signature="n",

1513

access="read")

2143

1514

def LastCheckerStatus_dbus_property(self):

2144

1515

return dbus.Int16(self.last_checker_status)

2145

1516

2146

1517

# Expires - property

2147

1518

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

2148

1519

def Expires_dbus_property(self):

2149

1520

return datetime_to_dbus(self.expires)

2150

1521

2151

1522

# LastApprovalRequest - property

2152

1523

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

2153

1524

def LastApprovalRequest_dbus_property(self):

2154

1525

return datetime_to_dbus(self.last_approval_request)

2155

1526

2156

1527

# Timeout - property

2157

@dbus_service_property(_interface,

2158

signature="t",

1528

@dbus_service_property(_interface, signature="t",

2159

1529

access="readwrite")

2160

1530

def Timeout_dbus_property(self, value=None):

2161

1531

if value is None: # get

2162

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

1532

return dbus.UInt64(self.timeout_milliseconds())

2163

1533

old_timeout = self.timeout

2164

1534

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

2165

1535

# Reschedule disabling

2173

1543

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

2174

1544

is None):

2175

1545

return

2176

GLib.source_remove(self.disable_initiator_tag)

2177

self.disable_initiator_tag = GLib.timeout_add(

2178

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

2179

self.disable)

2180

1546

gobject.source_remove(self.disable_initiator_tag)

1547

self.disable_initiator_tag = (

1548

gobject.timeout_add(

1549

timedelta_to_milliseconds(self.expires - now),

1550

self.disable))

1551

2181

1552

# ExtendedTimeout - property

2182

@dbus_service_property(_interface,

2183

signature="t",

1553

@dbus_service_property(_interface, signature="t",

2184

1554

access="readwrite")

2185

1555

def ExtendedTimeout_dbus_property(self, value=None):

2186

1556

if value is None: # get

2187

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

2188

* 1000)

1557

return dbus.UInt64(self.extended_timeout_milliseconds())

2189

1558

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

2190

1559

2191

1560

# Interval - property

2192

@dbus_service_property(_interface,

2193

signature="t",

1561

@dbus_service_property(_interface, signature="t",

2194

1562

access="readwrite")

2195

1563

def Interval_dbus_property(self, value=None):

2196

1564

if value is None: # get

2197

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

1565

return dbus.UInt64(self.interval_milliseconds())

2198

1566

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

2199

1567

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

2200

1568

return

2201

1569

if self.enabled:

2202

1570

# Reschedule checker run

2203

GLib.source_remove(self.checker_initiator_tag)

2204

self.checker_initiator_tag = GLib.timeout_add(

2205

value, self.start_checker)

2206

self.start_checker() # Start one now, too

2207

1571

gobject.source_remove(self.checker_initiator_tag)

1572

self.checker_initiator_tag = (gobject.timeout_add

1573

(value, self.start_checker))

1574

self.start_checker() # Start one now, too

1575

2208

1576

# Checker - property

2209

@dbus_service_property(_interface,

2210

signature="s",

1577

@dbus_service_property(_interface, signature="s",

2211

1578

access="readwrite")

2212

1579

def Checker_dbus_property(self, value=None):

2213

1580

if value is None: # get

2214

1581

return dbus.String(self.checker_command)

2215

self.checker_command = str(value)

2216

1582

self.checker_command = unicode(value)

1583

2217

1584

# CheckerRunning - property

2218

@dbus_service_property(_interface,

2219

signature="b",

1585

@dbus_service_property(_interface, signature="b",

2220

1586

access="readwrite")

2221

1587

def CheckerRunning_dbus_property(self, value=None):

2222

1588

if value is None: # get

2225

1591

self.start_checker()

2226

1592

else:

2227

1593

self.stop_checker()

2228

1594

2229

1595

# ObjectPath - property

2230

@dbus_annotations(

2231

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

2232

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

2233

1596

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

2234

1597

def ObjectPath_dbus_property(self):

2235

return self.dbus_object_path # is already a dbus.ObjectPath

2236

1598

return self.dbus_object_path # is already a dbus.ObjectPath

1599

2237

1600

# Secret = property

2238

@dbus_annotations(

2239

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

2240

"invalidates"})

2241

@dbus_service_property(_interface,

2242

signature="ay",

2243

access="write",

2244

byte_arrays=True)

1601

@dbus_service_property(_interface, signature="ay",

1602

access="write", byte_arrays=True)

2245

1603

def Secret_dbus_property(self, value):

2246

self.secret = bytes(value)

2247

1604

self.secret = str(value)

1605

2248

1606

del _interface

2249

1607

2250

1608

2251

class ProxyClient:

2252

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

1609

class ProxyClient(object):

1610

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

2253

1611

self._pipe = child_pipe

2254

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

1612

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

2255

1613

if not self._pipe.recv():

2256

raise KeyError(key_id or fpr)

2257

1614

raise KeyError()

1615

2258

1616

def __getattribute__(self, name):

2259

1617

if name == '_pipe':

2260

1618

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

2263

1621

if data[0] == 'data':

2264

1622

return data[1]

2265

1623

if data[0] == 'function':

2266

2267

1624

def func(*args, **kwargs):

2268

1625

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

2269

1626

return self._pipe.recv()[1]

2270

2271

1627

return func

2272

1628

2273

1629

def __setattr__(self, name, value):

2274

1630

if name == '_pipe':

2275

1631

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

2278

1634

2279

1635

class ClientHandler(socketserver.BaseRequestHandler, object):

2280

1636

"""A class to handle client connections.

2281

1637

2282

1638

Instantiated once for each connection to handle it.

2283

1639

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

2284

1640

2285

1641

def handle(self):

2286

1642

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

2287

1643

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

2288

str(self.client_address))

1644

unicode(self.client_address))

2289

1645

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

2290

1646

self.server.child_pipe.fileno())

2291

2292

session = gnutls.ClientSession(self.request)

2293

2294

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

2295

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

2296

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

2297

# "+DHE-DSS"))

1647

1648

session = (gnutls.connection

1649

.ClientSession(self.request,

1650

gnutls.connection

1651

.X509Credentials()))

1652

1653

# Note: gnutls.connection.X509Credentials is really a

1654

# generic GnuTLS certificate credentials object so long as

1655

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

1656

# here despite using OpenPGP certificates.

1657

1658

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

1659

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

1660

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

1661

# "+DHE-DSS"))

2298

1662

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

2299

1663

priority = self.server.gnutls_priority

2300

1664

if priority is None:

2301

1665

priority = "NORMAL"

2302

gnutls.priority_set_direct(session._c_object,

2303

priority.encode("utf-8"),

2304

None)

2305

1666

(gnutls.library.functions

1667

.gnutls_priority_set_direct(session._c_object,

1668

priority, None))

1669

2306

1670

# Start communication using the Mandos protocol

2307

1671

# Get protocol number

2308

1672

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

2309

1673

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

2310

1674

try:

2311

1675

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

2312

raise RuntimeError(line)

1676

raise RuntimeError

2313

1677

except (ValueError, IndexError, RuntimeError) as error:

2314

1678

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

2315

1679

return

2316

1680

2317

1681

# Start GnuTLS connection

2318

1682

try:

2319

1683

session.handshake()

2320

except gnutls.Error as error:

1684

except gnutls.errors.GNUTLSError as error:

2321

1685

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

2322

1686

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

2323

1687

# established. Just abandon the request.

2324

1688

return

2325

1689

logger.debug("Handshake succeeded")

2326

1690

2327

1691

approval_required = False

2328

1692

try:

2329

if gnutls.has_rawpk:

2330

fpr = b""

2331

try:

2332

key_id = self.key_id(

2333

self.peer_certificate(session))

2334

except (TypeError, gnutls.Error) as error:

2335

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

2336

return

2337

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

2338

2339

else:

2340

key_id = b""

2341

try:

2342

fpr = self.fingerprint(

2343

self.peer_certificate(session))

2344

except (TypeError, gnutls.Error) as error:

2345

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

2346

return

2347

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

2348

2349

try:

2350

client = ProxyClient(child_pipe, key_id, fpr,

1693

try:

1694

fpr = self.fingerprint(self.peer_certificate

1695

(session))

1696

except (TypeError,

1697

gnutls.errors.GNUTLSError) as error:

1698

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

1699

return

1700

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

1701

1702

try:

1703

client = ProxyClient(child_pipe, fpr,

2351

1704

self.client_address)

2352

1705

except KeyError:

2353

1706

return

2354

1707

2355

1708

if client.approval_delay:

2356

1709

delay = client.approval_delay

2357

1710

client.approvals_pending += 1

2358

1711

approval_required = True

2359

1712

2360

1713

while True:

2361

1714

if not client.enabled:

2362

1715

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

2363

client.name)

1716

client.name)

2364

1717

if self.server.use_dbus:

2365

1718

# Emit D-Bus signal

2366

1719

client.Rejected("Disabled")

2367

1720

return

2368

1721

2369

1722

if client.approved or not client.approval_delay:

2370

# We are approved or approval is disabled

1723

#We are approved or approval is disabled

2371

1724

break

2372

1725

elif client.approved is None:

2373

1726

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

2375

1728

if self.server.use_dbus:

2376

1729

# Emit D-Bus signal

2377

1730

client.NeedApproval(

2378

client.approval_delay.total_seconds()

2379

* 1000, client.approved_by_default)

1731

client.approval_delay_milliseconds(),

1732

client.approved_by_default)

2380

1733

else:

2381

1734

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

2382

1735

client.name)

2384

1737

# Emit D-Bus signal

2385

1738

client.Rejected("Denied")

2386

1739

return

2387

2388

# wait until timeout or approved

1740

1741

#wait until timeout or approved

2389

1742

time = datetime.datetime.now()

2390

1743

client.changedstate.acquire()

2391

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

1744

client.changedstate.wait(

1745

float(timedelta_to_milliseconds(delay)

1746

/ 1000))

2392

1747

client.changedstate.release()

2393

1748

time2 = datetime.datetime.now()

2394

1749

if (time2 - time) >= delay:

2404

1759

break

2405

1760

else:

2406

1761

delay -= time2 - time

2407

2408

try:

2409

session.send(client.secret)

2410

except gnutls.Error as error:

2411

logger.warning("gnutls send failed",

2412

exc_info=error)

2413

return

2414

1762

1763

sent_size = 0

1764

while sent_size < len(client.secret):

1765

try:

1766

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

1767

except gnutls.errors.GNUTLSError as error:

1768

logger.warning("gnutls send failed",

1769

exc_info=error)

1770

return

1771

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

1772

sent, len(client.secret)

1773

- (sent_size + sent))

1774

sent_size += sent

1775

2415

1776

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

2416

1777

# bump the timeout using extended_timeout

2417

1778

client.bump_timeout(client.extended_timeout)

2418

1779

if self.server.use_dbus:

2419

1780

# Emit D-Bus signal

2420

1781

client.GotSecret()

2421

1782

2422

1783

finally:

2423

1784

if approval_required:

2424

1785

client.approvals_pending -= 1

2425

1786

try:

2426

1787

session.bye()

2427

except gnutls.Error as error:

1788

except gnutls.errors.GNUTLSError as error:

2428

1789

logger.warning("GnuTLS bye failed",

2429

1790

exc_info=error)

2430

1791

2431

1792

@staticmethod

2432

1793

def peer_certificate(session):

2433

"Return the peer's certificate as a bytestring"

2434

try:

2435

cert_type = gnutls.certificate_type_get2(session._c_object,

2436

gnutls.CTYPE_PEERS)

2437

except AttributeError:

2438

cert_type = gnutls.certificate_type_get(session._c_object)

2439

if gnutls.has_rawpk:

2440

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2441

else:

2442

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2443

# If not a valid certificate type...

2444

if cert_type not in valid_cert_types:

2445

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

2446

valid_cert_types)

2447

# ...return invalid data

2448

return b""

1794

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

1795

# If not an OpenPGP certificate...

1796

if (gnutls.library.functions

1797

.gnutls_certificate_type_get(session._c_object)

1798

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1799

# ...do the normal thing

1800

return session.peer_certificate

2449

1801

list_size = ctypes.c_uint(1)

2450

cert_list = (gnutls.certificate_get_peers

1802

cert_list = (gnutls.library.functions

1803

.gnutls_certificate_get_peers

2451

1804

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

2452

1805

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

2453

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

1806

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

1807

" certificate")

2454

1808

if list_size.value == 0:

2455

1809

return None

2456

1810

cert = cert_list[0]

2457

1811

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

2458

2459

@staticmethod

2460

def key_id(certificate):

2461

"Convert a certificate bytestring to a hexdigit key ID"

2462

# New GnuTLS "datum" with the public key

2463

datum = gnutls.datum_t(

2464

ctypes.cast(ctypes.c_char_p(certificate),

2465

ctypes.POINTER(ctypes.c_ubyte)),

2466

ctypes.c_uint(len(certificate)))

2467

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

2468

# New empty GnuTLS certificate

2469

pubkey = gnutls.pubkey_t()

2470

gnutls.pubkey_init(ctypes.byref(pubkey))

2471

# Import the raw public key into the certificate

2472

gnutls.pubkey_import(pubkey,

2473

ctypes.byref(datum),

2474

gnutls.X509_FMT_DER)

2475

# New buffer for the key ID

2476

buf = ctypes.create_string_buffer(32)

2477

buf_len = ctypes.c_size_t(len(buf))

2478

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

2479

gnutls.pubkey_get_key_id(

2480

pubkey,

2481

gnutls.KEYID_USE_SHA256,

2482

ctypes.cast(ctypes.byref(buf),

2483

ctypes.POINTER(ctypes.c_ubyte)),

2484

ctypes.byref(buf_len))

2485

# Deinit the certificate

2486

gnutls.pubkey_deinit(pubkey)

2487

2488

# Convert the buffer to a Python bytestring

2489

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

2490

# Convert the bytestring to hexadecimal notation

2491

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

2492

return hex_key_id

2493

1812

2494

1813

@staticmethod

2495

1814

def fingerprint(openpgp):

2496

1815

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2497

1816

# New GnuTLS "datum" with the OpenPGP public key

2498

datum = gnutls.datum_t(

2499

ctypes.cast(ctypes.c_char_p(openpgp),

2500

ctypes.POINTER(ctypes.c_ubyte)),

2501

ctypes.c_uint(len(openpgp)))

1817

datum = (gnutls.library.types

1818

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

1819

ctypes.POINTER

1820

(ctypes.c_ubyte)),

1821

ctypes.c_uint(len(openpgp))))

2502

1822

# New empty GnuTLS certificate

2503

crt = gnutls.openpgp_crt_t()

2504

gnutls.openpgp_crt_init(ctypes.byref(crt))

1823

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1824

(gnutls.library.functions

1825

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2505

1826

# Import the OpenPGP public key into the certificate

2506

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

2507

gnutls.OPENPGP_FMT_RAW)

1827

(gnutls.library.functions

1828

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

1829

gnutls.library.constants

1830

.GNUTLS_OPENPGP_FMT_RAW))

2508

1831

# Verify the self signature in the key

2509

1832

crtverify = ctypes.c_uint()

2510

gnutls.openpgp_crt_verify_self(crt, 0,

2511

ctypes.byref(crtverify))

1833

(gnutls.library.functions

1834

.gnutls_openpgp_crt_verify_self(crt, 0,

1835

ctypes.byref(crtverify)))

2512

1836

if crtverify.value != 0:

2513

gnutls.openpgp_crt_deinit(crt)

2514

raise gnutls.CertificateSecurityError(code

2515

=crtverify.value)

1837

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1838

raise (gnutls.errors.CertificateSecurityError

1839

("Verify failed"))

2516

1840

# New buffer for the fingerprint

2517

1841

buf = ctypes.create_string_buffer(20)

2518

1842

buf_len = ctypes.c_size_t()

2519

1843

# Get the fingerprint from the certificate into the buffer

2520

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

2521

ctypes.byref(buf_len))

1844

(gnutls.library.functions

1845

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

1846

ctypes.byref(buf_len)))

2522

1847

# Deinit the certificate

2523

gnutls.openpgp_crt_deinit(crt)

1848

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2524

1849

# Convert the buffer to a Python bytestring

2525

1850

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

2526

1851

# Convert the bytestring to hexadecimal notation

2528

1853

return hex_fpr

2529

1854

2530

1855

2531

class MultiprocessingMixIn:

1856

class MultiprocessingMixIn(object):

2532

1857

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

2533

2534

1858

def sub_process_main(self, request, address):

2535

1859

try:

2536

1860

self.finish_request(request, address)

2537

1861

except Exception:

2538

1862

self.handle_error(request, address)

2539

1863

self.close_request(request)

2540

1864

2541

1865

def process_request(self, request, address):

2542

1866

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

2543

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

2544

args=(request, address))

1867

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

1868

args = (request, address))

2545

1869

proc.start()

2546

1870

return proc

2547

1871

2548

1872

2549

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1873

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2550

1874

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

2551

2552

1875

def process_request(self, request, client_address):

2553

1876

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

2554

1877

2555

1878

This function creates a new pipe in self.pipe

2556

1879

"""

2557

1880

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2558

1881

2559

1882

proc = MultiprocessingMixIn.process_request(self, request,

2560

1883

client_address)

2561

1884

self.child_pipe.close()

2562

1885

self.add_pipe(parent_pipe, proc)

2563

1886

2564

1887

def add_pipe(self, parent_pipe, proc):

2565

1888

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

2566

raise NotImplementedError()

1889

raise NotImplementedError

2567

1890

2568

1891

2569

1892

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2570

socketserver.TCPServer):

1893

socketserver.TCPServer, object):

2571

1894

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

2572

1895

2573

1896

Attributes:

2574

1897

enabled: Boolean; whether this server is activated yet

2575

1898

interface: None or a network interface name (string)

2576

1899

use_ipv6: Boolean; to use IPv6 or not

2577

1900

"""

2578

2579

1901

def __init__(self, server_address, RequestHandlerClass,

2580

interface=None,

2581

use_ipv6=True,

2582

socketfd=None):

1902

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

2583

1903

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

2584

1904

creating a new one with socket.socket().

2585

1905

"""

2591

1911

self.socketfd = socketfd

2592

1912

# Save the original socket.socket() function

2593

1913

self.socket_socket = socket.socket

2594

2595

1914

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

2596

#

1915

#

2597

1916

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

2598

1917

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

2599

1918

# patching socket.socket.)

2600

#

1919

#

2601

1920

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

2602

1921

@functools.wraps(socket.socket)

2603

1922

def socket_wrapper(*args, **kwargs):

2615

1934

# socket_wrapper(), if socketfd was set.

2616

1935

socketserver.TCPServer.__init__(self, server_address,

2617

1936

RequestHandlerClass)

2618

1937

2619

1938

def server_bind(self):

2620

1939

"""This overrides the normal server_bind() function

2621

1940

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

2622

1941

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

2623

global SO_BINDTODEVICE

2624

1942

if self.interface is not None:

2625

1943

if SO_BINDTODEVICE is None:

2626

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

2627

# common enough.

2628

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

2629

SO_BINDTODEVICE = 25

2630

try:

2631

self.socket.setsockopt(

2632

socket.SOL_SOCKET, SO_BINDTODEVICE,

2633

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

2634

except socket.error as error:

2635

if error.errno == errno.EPERM:

2636

logger.error("No permission to bind to"

2637

" interface %s", self.interface)

2638

elif error.errno == errno.ENOPROTOOPT:

2639

logger.error("SO_BINDTODEVICE not available;"

2640

" cannot bind to interface %s",

2641

self.interface)

2642

elif error.errno == errno.ENODEV:

2643

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

2644

" cannot bind", self.interface)

2645

else:

2646

raise

1944

logger.error("SO_BINDTODEVICE does not exist;"

1945

" cannot bind to interface %s",

1946

self.interface)

1947

else:

1948

try:

1949

self.socket.setsockopt(socket.SOL_SOCKET,

1950

SO_BINDTODEVICE,

1951

str(self.interface

1952

+ '\0'))

1953

except socket.error as error:

1954

if error.errno == errno.EPERM:

1955

logger.error("No permission to"

1956

" bind to interface %s",

1957

self.interface)

1958

elif error.errno == errno.ENOPROTOOPT:

1959

logger.error("SO_BINDTODEVICE not available;"

1960

" cannot bind to interface %s",

1961

self.interface)

1962

elif error.errno == errno.ENODEV:

1963

logger.error("Interface %s does not"

1964

" exist, cannot bind",

1965

self.interface)

1966

else:

1967

raise

2647

1968

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

2648

1969

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

2649

if self.server_address[1]:

2650

self.allow_reuse_address = True

2651

1970

if not self.server_address[0]:

2652

1971

if self.address_family == socket.AF_INET6:

2653

any_address = "::" # in6addr_any

1972

any_address = "::" # in6addr_any

2654

1973

else:

2655

any_address = "0.0.0.0" # INADDR_ANY

1974

any_address = socket.INADDR_ANY

2656

1975

self.server_address = (any_address,

2657

1976

self.server_address[1])

2658

1977

elif not self.server_address[1]:

2659

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

1978

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

1979

0)

2660

1980

# if self.interface:

2661

1981

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

2662

1982

# 0, # port

2668

1988

2669

1989

class MandosServer(IPv6_TCPServer):

2670

1990

"""Mandos server.

2671

1991

2672

1992

Attributes:

2673

1993

clients: set of Client objects

2674

1994

gnutls_priority GnuTLS priority string

2675

1995

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

2676

2677

Assumes a GLib.MainLoop event loop.

1996

1997

Assumes a gobject.MainLoop event loop.

2678

1998

"""

2679

2680

1999

def __init__(self, server_address, RequestHandlerClass,

2681

interface=None,

2682

use_ipv6=True,

2683

clients=None,

2684

gnutls_priority=None,

2685

use_dbus=True,

2686

socketfd=None):

2000

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

2001

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

2687

2002

self.enabled = False

2688

2003

self.clients = clients

2689

2004

if self.clients is None:

2692

2007

self.gnutls_priority = gnutls_priority

2693

2008

IPv6_TCPServer.__init__(self, server_address,

2694

2009

RequestHandlerClass,

2695

interface=interface,

2696

use_ipv6=use_ipv6,

2697

socketfd=socketfd)

2698

2010

interface = interface,

2011

use_ipv6 = use_ipv6,

2012

socketfd = socketfd)

2699

2013

def server_activate(self):

2700

2014

if self.enabled:

2701

2015

return socketserver.TCPServer.server_activate(self)

2702

2016

2703

2017

def enable(self):

2704

2018

self.enabled = True

2705

2019

2706

2020

def add_pipe(self, parent_pipe, proc):

2707

2021

# Call "handle_ipc" for both data and EOF events

2708

GLib.io_add_watch(

2709

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

2710

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

2711

functools.partial(self.handle_ipc,

2712

parent_pipe=parent_pipe,

2713

proc=proc))

2714

2715

def handle_ipc(self, source, condition,

2716

parent_pipe=None,

2717

proc=None,

2718

client_object=None):

2022

gobject.io_add_watch(parent_pipe.fileno(),

2023

gobject.IO_IN | gobject.IO_HUP,

2024

functools.partial(self.handle_ipc,

2025

parent_pipe =

2026

parent_pipe,

2027

proc = proc))

2028

2029

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

2030

proc = None, client_object=None):

2719

2031

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

2720

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

2032

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

2721

2033

# Wait for other process to exit

2722

2034

proc.join()

2723

2035

return False

2724

2036

2725

2037

# Read a request from the child

2726

2038

request = parent_pipe.recv()

2727

2039

command = request[0]

2728

2040

2729

2041

if command == 'init':

2730

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

2731

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

2732

address = request[3]

2733

2734

for c in self.clients.values():

2735

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2736

"27AE41E4649B934CA495991B7852B855"):

2737

continue

2738

if key_id and c.key_id == key_id:

2739

client = c

2740

break

2741

if fpr and c.fingerprint == fpr:

2042

fpr = request[1]

2043

address = request[2]

2044

2045

for c in self.clients.itervalues():

2046

if c.fingerprint == fpr:

2742

2047

client = c

2743

2048

break

2744

2049

else:

2745

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

2746

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

2050

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

2051

"dress: %s", fpr, address)

2747

2052

if self.use_dbus:

2748

2053

# Emit D-Bus signal

2749

mandos_dbus_service.ClientNotFound(key_id or fpr,

2054

mandos_dbus_service.ClientNotFound(fpr,

2750

2055

address[0])

2751

2056

parent_pipe.send(False)

2752

2057

return False

2753

2754

GLib.io_add_watch(

2755

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

2756

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

2757

functools.partial(self.handle_ipc,

2758

parent_pipe=parent_pipe,

2759

proc=proc,

2760

client_object=client))

2058

2059

gobject.io_add_watch(parent_pipe.fileno(),

2060

gobject.IO_IN | gobject.IO_HUP,

2061

functools.partial(self.handle_ipc,

2062

parent_pipe =

2063

parent_pipe,

2064

proc = proc,

2065

client_object =

2066

client))

2761

2067

parent_pipe.send(True)

2762

2068

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

2763

2069

# same fileno

2766

2072

funcname = request[1]

2767

2073

args = request[2]

2768

2074

kwargs = request[3]

2769

2075

2770

2076

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

2771

2077

funcname)(*args,

2772

**kwargs)))

2773

2078

**kwargs)))

2079

2774

2080

if command == 'getattr':

2775

2081

attrname = request[1]

2776

if isinstance(client_object.__getattribute__(attrname),

2777

collections.abc.Callable):

2778

parent_pipe.send(('function', ))

2082

if callable(client_object.__getattribute__(attrname)):

2083

parent_pipe.send(('function',))

2779

2084

else:

2780

parent_pipe.send((

2781

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

2782

2085

parent_pipe.send(('data', client_object

2086

.__getattribute__(attrname)))

2087

2783

2088

if command == 'setattr':

2784

2089

attrname = request[1]

2785

2090

value = request[2]

2786

2091

setattr(client_object, attrname, value)

2787

2092

2788

2093

return True

2789

2094

2790

2095

2791

def rfc3339_duration_to_delta(duration):

2792

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

2793

2794

>>> timedelta = datetime.timedelta

2795

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

2796

True

2797

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

2798

True

2799

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

2800

True

2801

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

2802

True

2803

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

2804

True

2805

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

2806

True

2807

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

2808

True

2809

>>> del timedelta

2810

"""

2811

2812

# Parsing an RFC 3339 duration with regular expressions is not

2813

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

2814

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

2815

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

2816

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

2817

# avoid excessive use of external libraries.

2818

2819

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

2820

Token = collections.namedtuple("Token", (

2821

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

2822

# a "group" containing digits

2823

"value", # datetime.timedelta or None

2824

"followers")) # Tokens valid after this token

2825

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

2826

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

2827

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

2828

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

2829

datetime.timedelta(seconds=1),

2830

frozenset((token_end, )))

2831

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

2832

datetime.timedelta(minutes=1),

2833

frozenset((token_second, token_end)))

2834

token_hour = Token(re.compile(r"(\d+)H"),

2835

datetime.timedelta(hours=1),

2836

frozenset((token_minute, token_end)))

2837

token_time = Token(re.compile(r"T"),

2838

None,

2839

frozenset((token_hour, token_minute,

2840

token_second)))

2841

token_day = Token(re.compile(r"(\d+)D"),

2842

datetime.timedelta(days=1),

2843

frozenset((token_time, token_end)))

2844

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

2845

datetime.timedelta(weeks=4),

2846

frozenset((token_day, token_end)))

2847

token_year = Token(re.compile(r"(\d+)Y"),

2848

datetime.timedelta(weeks=52),

2849

frozenset((token_month, token_end)))

2850

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

2851

datetime.timedelta(weeks=1),

2852

frozenset((token_end, )))

2853

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

2854

frozenset((token_year, token_month,

2855

token_day, token_time,

2856

token_week)))

2857

# Define starting values:

2858

# Value so far

2859

value = datetime.timedelta()

2860

found_token = None

2861

# Following valid tokens

2862

followers = frozenset((token_duration, ))

2863

# String left to parse

2864

s = duration

2865

# Loop until end token is found

2866

while found_token is not token_end:

2867

# Search for any currently valid tokens

2868

for token in followers:

2869

match = token.regexp.match(s)

2870

if match is not None:

2871

# Token found

2872

if token.value is not None:

2873

# Value found, parse digits

2874

factor = int(match.group(1), 10)

2875

# Add to value so far

2876

value += factor * token.value

2877

# Strip token from string

2878

s = token.regexp.sub("", s, 1)

2879

# Go to found token

2880

found_token = token

2881

# Set valid next tokens

2882

followers = found_token.followers

2883

break

2884

else:

2885

# No currently valid tokens were found

2886

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

2887

.format(duration))

2888

# End token found

2889

return value

2890

2891

2892

2096

def string_to_delta(interval):

2893

2097

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

2894

2895

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

2896

True

2897

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

2898

True

2899

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

2900

True

2901

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

2902

True

2903

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

2904

True

2905

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

2906

True

2098

2099

>>> string_to_delta('7d')

2100

datetime.timedelta(7)

2101

>>> string_to_delta('60s')

2102

datetime.timedelta(0, 60)

2103

>>> string_to_delta('60m')

2104

datetime.timedelta(0, 3600)

2105

>>> string_to_delta('24h')

2106

datetime.timedelta(1)

2107

>>> string_to_delta('1w')

2108

datetime.timedelta(7)

2109

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

2110

datetime.timedelta(0, 330)

2907

2111

"""

2908

2909

try:

2910

return rfc3339_duration_to_delta(interval)

2911

except ValueError:

2912

pass

2913

2914

2112

timevalue = datetime.timedelta(0)

2915

2113

for s in interval.split():

2916

2114

try:

2917

suffix = s[-1]

2115

suffix = unicode(s[-1])

2918

2116

value = int(s[:-1])

2919

2117

if suffix == "d":

2920

2118

delta = datetime.timedelta(value)

2927

2125

elif suffix == "w":

2928

2126

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

2929

2127

else:

2930

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

2931

except IndexError as e:

2128

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

2129

.format(suffix))

2130

except (ValueError, IndexError) as e:

2932

2131

raise ValueError(*(e.args))

2933

2132

timevalue += delta

2934

2133

return timevalue

2935

2134

2936

2135

2937

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

2136

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

2938

2137

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

2939

2138

2940

2139

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

2941

2140

if os.fork():

2942

2141

sys.exit()

2950

2149

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

2951

2150

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

2952

2151

raise OSError(errno.ENODEV,

2953

"{} not a character device"

2152

"{0} not a character device"

2954

2153

.format(os.devnull))

2955

2154

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

2956

2155

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

2960

2159

2961

2160

2962

2161

def main():

2963

2162

2964

2163

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

2965

2164

# Parsing of options, both command line and config file

2966

2165

2967

2166

parser = argparse.ArgumentParser()

2968

2167

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

2969

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

2168

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

2970

2169

help="show version number and exit")

2971

2170

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

2972

2171

help="Bind to interface IF")

2978

2177

help="Run self-test")

2979

2178

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

2980

2179

help="Debug mode; run in foreground and log"

2981

" to terminal", default=None)

2180

" to terminal")

2982

2181

parser.add_argument("--debuglevel", metavar="LEVEL",

2983

2182

help="Debug level for stdout output")

2984

2183

parser.add_argument("--priority", help="GnuTLS"

2991

2190

" files")

2992

2191

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

2993

2192

dest="use_dbus", help="Do not provide D-Bus"

2994

" system bus interface", default=None)

2193

" system bus interface")

2995

2194

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

2996

dest="use_ipv6", help="Do not use IPv6",

2997

default=None)

2195

dest="use_ipv6", help="Do not use IPv6")

2998

2196

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

2999

2197

dest="restore", help="Do not restore stored"

3000

" state", default=None)

2198

" state")

3001

2199

parser.add_argument("--socket", type=int,

3002

2200

help="Specify a file descriptor to a network"

3003

2201

" socket to use instead of creating one")

3004

2202

parser.add_argument("--statedir", metavar="DIR",

3005

2203

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

3006

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

3007

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

3008

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

3009

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

3010

default=None)

3011

2204

3012

2205

options = parser.parse_args()

3013

2206

2207

if options.check:

2208

import doctest

2209

doctest.testmod()

2210

sys.exit()

2211

3014

2212

# Default values for config file for server-global settings

3015

if gnutls.has_rawpk:

3016

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

3017

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

3018

else:

3019

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

3020

":+SIGN-DSA-SHA256")

3021

server_defaults = {"interface": "",

3022

"address": "",

3023

"port": "",

3024

"debug": "False",

3025

"priority": priority,

3026

"servicename": "Mandos",

3027

"use_dbus": "True",

3028

"use_ipv6": "True",

3029

"debuglevel": "",

3030

"restore": "True",

3031

"socket": "",

3032

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

3033

"foreground": "False",

3034

"zeroconf": "True",

3035

}

3036

del priority

3037

2213

server_defaults = { "interface": "",

2214

"address": "",

2215

"port": "",

2216

"debug": "False",

2217

"priority":

2218

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

2219

"servicename": "Mandos",

2220

"use_dbus": "True",

2221

"use_ipv6": "True",

2222

"debuglevel": "",

2223

"restore": "True",

2224

"socket": "",

2225

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

2226

}

2227

3038

2228

# Parse config file for server-global settings

3039

server_config = configparser.ConfigParser(server_defaults)

2229

server_config = configparser.SafeConfigParser(server_defaults)

3040

2230

del server_defaults

3041

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

3042

# Convert the ConfigParser object to a dict

2231

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

2232

"mandos.conf"))

2233

# Convert the SafeConfigParser object to a dict

3043

2234

server_settings = server_config.defaults()

3044

2235

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

3045

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

3046

"foreground", "zeroconf"):

2236

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

3047

2237

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

3048

2238

option)

3049

2239

if server_settings["port"]:

3059

2249

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

3060

2250

["socket"])

3061

2251

del server_config

3062

2252

3063

2253

# Override the settings from the config file with command line

3064

2254

# options, if set.

3065

2255

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

3066

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

3067

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

3068

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

2256

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

2257

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

2258

"statedir", "socket"):

3069

2259

value = getattr(options, option)

3070

2260

if value is not None:

3071

2261

server_settings[option] = value

3072

2262

del options

3073

2263

# Force all strings to be unicode

3074

2264

for option in server_settings.keys():

3075

if isinstance(server_settings[option], bytes):

3076

server_settings[option] = (server_settings[option]

3077

.decode("utf-8"))

3078

# Force all boolean options to be boolean

3079

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

3080

"foreground", "zeroconf"):

3081

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

3082

# Debug implies foreground

3083

if server_settings["debug"]:

3084

server_settings["foreground"] = True

2265

if type(server_settings[option]) is str:

2266

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

3085

2267

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

3086

2268

3087

2269

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

3088

3089

if (not server_settings["zeroconf"]

3090

and not (server_settings["port"]

3091

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

3092

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

3093

2270

3094

2271

# For convenience

3095

2272

debug = server_settings["debug"]

3096

2273

debuglevel = server_settings["debuglevel"]

3098

2275

use_ipv6 = server_settings["use_ipv6"]

3099

2276

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

3100

2277

stored_state_file)

3101

foreground = server_settings["foreground"]

3102

zeroconf = server_settings["zeroconf"]

3103

2278

3104

2279

if debug:

3105

2280

initlogger(debug, logging.DEBUG)

3106

2281

else:

3109

2284

else:

3110

2285

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

3111

2286

initlogger(debug, level)

3112

2287

3113

2288

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

3114

syslogger.setFormatter(

3115

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

3116

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

3117

server_settings["servicename"])))

3118

2289

syslogger.setFormatter(logging.Formatter

2290

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

2291

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

2292

.format(server_settings

2293

["servicename"])))

2294

3119

2295

# Parse config file with clients

3120

client_config = configparser.ConfigParser(Client.client_defaults)

2296

client_config = configparser.SafeConfigParser(Client

2297

.client_defaults)

3121

2298

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

3122

2299

"clients.conf"))

3123

2300

3124

2301

global mandos_dbus_service

3125

2302

mandos_dbus_service = None

3126

3127

socketfd = None

3128

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

3129

socketfd = server_settings["socket"]

3130

tcp_server = MandosServer(

3131

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

3132

ClientHandler,

3133

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

3134

use_ipv6=use_ipv6,

3135

gnutls_priority=server_settings["priority"],

3136

use_dbus=use_dbus,

3137

socketfd=socketfd)

3138

if not foreground:

3139

pidfilename = "/run/mandos.pid"

3140

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

3141

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

3142

pidfile = None

2303

2304

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

2305

server_settings["port"]),

2306

ClientHandler,

2307

interface=(server_settings["interface"]

2308

or None),

2309

use_ipv6=use_ipv6,

2310

gnutls_priority=

2311

server_settings["priority"],

2312

use_dbus=use_dbus,

2313

socketfd=(server_settings["socket"]

2314

or None))

2315

if not debug:

2316

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

3143

2317

try:

3144

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

2318

pidfile = open(pidfilename, "w")

3145

2319

except IOError as e:

3146

2320

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

3147

2321

exc_info=e)

3148

3149

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

3150

("mandos", "mandos"),

3151

("nobody", "nogroup")):

2322

2323

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

3152

2324

try:

3153

2325

uid = pwd.getpwnam(name).pw_uid

3154

gid = pwd.getpwnam(group).pw_gid

2326

gid = pwd.getpwnam(name).pw_gid

3155

2327

break

3156

2328

except KeyError:

3157

2329

continue

3161

2333

try:

3162

2334

os.setgid(gid)

3163

2335

os.setuid(uid)

3164

if debug:

3165

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

3166

gid))

3167

2336

except OSError as error:

3168

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

3169

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

3170

2337

if error.errno != errno.EPERM:

3171

raise

3172

2338

raise error

2339

3173

2340

if debug:

3174

2341

# Enable all possible GnuTLS debugging

3175

2342

3176

2343

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

3177

2344

# - GnuTLS manual

3178

gnutls.global_set_log_level(11)

3179

3180

@gnutls.log_func

2345

gnutls.library.functions.gnutls_global_set_log_level(11)

2346

2347

@gnutls.library.types.gnutls_log_func

3181

2348

def debug_gnutls(level, string):

3182

2349

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

3183

3184

gnutls.global_set_log_function(debug_gnutls)

3185

2350

2351

(gnutls.library.functions

2352

.gnutls_global_set_log_function(debug_gnutls))

2353

3186

2354

# Redirect stdin so all checkers get /dev/null

3187

2355

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

3188

2356

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

3189

2357

if null > 2:

3190

2358

os.close(null)

3191

2359

3192

2360

# Need to fork before connecting to D-Bus

3193

if not foreground:

2361

if not debug:

3194

2362

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

3195

2363

daemon()

3196

3197

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

3198

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

3199

# need to inform GLib that threads will be used.

3200

GLib.threads_init()

3201

2364

2365

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

2366

# need to inform gobject that threads will be used.

2367

gobject.threads_init()

2368

3202

2369

global main_loop

3203

2370

# From the Avahi example code

3204

2371

DBusGMainLoop(set_as_default=True)

3205

main_loop = GLib.MainLoop()

2372

main_loop = gobject.MainLoop()

3206

2373

bus = dbus.SystemBus()

3207

2374

# End of Avahi example code

3208

2375

if use_dbus:

3209

2376

try:

3210

2377

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

3211

bus,

3212

do_not_queue=True)

3213

old_bus_name = dbus.service.BusName(

3214

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

3215

do_not_queue=True)

3216

except dbus.exceptions.DBusException as e:

2378

bus, do_not_queue=True)

2379

old_bus_name = (dbus.service.BusName

2380

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

2381

do_not_queue=True))

2382

except dbus.exceptions.NameExistsException as e:

3217

2383

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

3218

2384

use_dbus = False

3219

2385

server_settings["use_dbus"] = False

3220

2386

tcp_server.use_dbus = False

3221

if zeroconf:

3222

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3223

service = AvahiServiceToSyslog(

3224

name=server_settings["servicename"],

3225

servicetype="_mandos._tcp",

3226

protocol=protocol,

3227

bus=bus)

3228

if server_settings["interface"]:

3229

service.interface = if_nametoindex(

3230

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

3231

2387

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2388

service = AvahiServiceToSyslog(name =

2389

server_settings["servicename"],

2390

servicetype = "_mandos._tcp",

2391

protocol = protocol, bus = bus)

2392

if server_settings["interface"]:

2393

service.interface = (if_nametoindex

2394

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

2395

3232

2396

global multiprocessing_manager

3233

2397

multiprocessing_manager = multiprocessing.Manager()

3234

2398

3235

2399

client_class = Client

3236

2400

if use_dbus:

3237

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

3238

2401

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

2402

3239

2403

client_settings = Client.config_parser(client_config)

3240

2404

old_client_settings = {}

3241

2405

clients_data = {}

3242

3243

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

3244

global wnull

3245

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

3246

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

3247

# mode

3248

if debug or not foreground:

3249

wnull.close()

3250

2406

3251

2407

# Get client data and settings from last running state.

3252

2408

if server_settings["restore"]:

3253

2409

try:

3254

2410

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

3255

if sys.version_info.major == 2:

3256

clients_data, old_client_settings = pickle.load(

3257

stored_state)

3258

else:

3259

bytes_clients_data, bytes_old_client_settings = (

3260

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

3261

# Fix bytes to strings

3262

# clients_data

3263

# .keys()

3264

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

3265

if isinstance(key, bytes)

3266

else key): value

3267

for key, value in

3268

bytes_clients_data.items()}

3269

del bytes_clients_data

3270

for key in clients_data:

3271

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

3272

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

3273

for k, v in

3274

clients_data[key].items()}

3275

clients_data[key] = value

3276

# .client_structure

3277

value["client_structure"] = [

3278

(s.decode("utf-8")

3279

if isinstance(s, bytes)

3280

else s) for s in

3281

value["client_structure"]]

3282

# .name, .host, and .checker_command

3283

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

3284

if isinstance(value[k], bytes):

3285

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

3286

if "key_id" not in value:

3287

value["key_id"] = ""

3288

elif "fingerprint" not in value:

3289

value["fingerprint"] = ""

3290

# old_client_settings

3291

# .keys()

3292

old_client_settings = {

3293

(key.decode("utf-8")

3294

if isinstance(key, bytes)

3295

else key): value

3296

for key, value in

3297

bytes_old_client_settings.items()}

3298

del bytes_old_client_settings

3299

# .host and .checker_command

3300

for value in old_client_settings.values():

3301

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

3302

if isinstance(value[attribute], bytes):

3303

value[attribute] = (value[attribute]

3304

.decode("utf-8"))

2411

clients_data, old_client_settings = (pickle.load

2412

(stored_state))

3305

2413

os.remove(stored_state_path)

3306

2414

except IOError as e:

3307

2415

if e.errno == errno.ENOENT:

3308

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

3309

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

2416

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

2417

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

3310

2418

else:

3311

2419

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

3312

2420

exc_info=e)

3313

2421

raise

3314

2422

except EOFError as e:

3315

2423

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

3316

"EOFError:",

3317

exc_info=e)

3318

2424

"EOFError:", exc_info=e)

2425

3319

2426

with PGPEngine() as pgp:

3320

for client_name, client in clients_data.items():

3321

# Skip removed clients

3322

if client_name not in client_settings:

3323

continue

3324

2427

for client_name, client in clients_data.iteritems():

3325

2428

# Decide which value to use after restoring saved state.

3326

2429

# We have three different values: Old config file,

3327

2430

# new config file, and saved state.

3332

2435

# For each value in new config, check if it

3333

2436

# differs from the old config value (Except for

3334

2437

# the "secret" attribute)

3335

if (name != "secret"

3336

and (value !=

3337

old_client_settings[client_name][name])):

2438

if (name != "secret" and

2439

value != old_client_settings[client_name]

2440

[name]):

3338

2441

client[name] = value

3339

2442

except KeyError:

3340

2443

pass

3341

2444

3342

2445

# Clients who has passed its expire date can still be

3343

# enabled if its last checker was successful. A Client

2446

# enabled if its last checker was successful. Clients

3344

2447

# whose checker succeeded before we stored its state is

3345

2448

# assumed to have successfully run all checkers during

3346

2449

# downtime.

3348

2451

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

3349

2452

if not client["last_checked_ok"]:

3350

2453

logger.warning(

3351

"disabling client {} - Client never "

3352

"performed a successful checker".format(

3353

client_name))

2454

"disabling client {0} - Client never "

2455

"performed a successful checker"

2456

.format(client_name))

3354

2457

client["enabled"] = False

3355

2458

elif client["last_checker_status"] != 0:

3356

2459

logger.warning(

3357

"disabling client {} - Client last"

3358

" checker failed with error code"

3359

" {}".format(

3360

client_name,

3361

client["last_checker_status"]))

2460

"disabling client {0} - Client "

2461

"last checker failed with error code {1}"

2462

.format(client_name,

2463

client["last_checker_status"]))

3362

2464

client["enabled"] = False

3363

2465

else:

3364

client["expires"] = (

3365

datetime.datetime.utcnow()

3366

+ client["timeout"])

2466

client["expires"] = (datetime.datetime

2467

.utcnow()

2468

+ client["timeout"])

3367

2469

logger.debug("Last checker succeeded,"

3368

" keeping {} enabled".format(

3369

client_name))

2470

" keeping {0} enabled"

2471

.format(client_name))

3370

2472

try:

3371

client["secret"] = pgp.decrypt(

3372

client["encrypted_secret"],

3373

client_settings[client_name]["secret"])

2473

client["secret"] = (

2474

pgp.decrypt(client["encrypted_secret"],

2475

client_settings[client_name]

2476

["secret"]))

3374

2477

except PGPError:

3375

2478

# If decryption fails, we use secret from new settings

3376

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

3377

client_name))

3378

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

3379

["secret"])

3380

2479

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

2480

.format(client_name))

2481

client["secret"] = (

2482

client_settings[client_name]["secret"])

2483

3381

2484

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

3382

2485

for client_name in (set(old_client_settings)

3383

2486

- set(client_settings)):

3385

2488

for client_name in (set(client_settings)

3386

2489

- set(old_client_settings)):

3387

2490

clients_data[client_name] = client_settings[client_name]

3388

2491

3389

2492

# Create all client objects

3390

for client_name, client in clients_data.items():

2493

for client_name, client in clients_data.iteritems():

3391

2494

tcp_server.clients[client_name] = client_class(

3392

name=client_name,

3393

settings=client,

3394

server_settings=server_settings)

3395

2495

name = client_name, settings = client)

2496

3396

2497

if not tcp_server.clients:

3397

2498

logger.warning("No clients defined")

3398

3399

if not foreground:

3400

if pidfile is not None:

3401

pid = os.getpid()

3402

try:

3403

with pidfile:

3404

print(pid, file=pidfile)

3405

except IOError:

3406

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

3407

pidfilename, pid)

3408

del pidfile

2499

2500

if not debug:

2501

try:

2502

with pidfile:

2503

pid = os.getpid()

2504

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

2505

del pidfile

2506

except IOError:

2507

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

2508

pidfilename, pid)

2509

except NameError:

2510

# "pidfile" was never created

2511

pass

3409

2512

del pidfilename

3410

3411

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

3412

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3413

lambda: main_loop.quit() and False)

3414

2513

2514

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

2515

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

2516

3415

2517

if use_dbus:

3416

3417

@alternate_dbus_interfaces(

3418

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

3419

class MandosDBusService(DBusObjectWithObjectManager):

2518

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

2519

"se.bsnet.fukt.Mandos"})

2520

class MandosDBusService(DBusObjectWithProperties):

3420

2521

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

3421

3422

2522

def __init__(self):

3423

2523

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

3424

3425

2524

_interface = "se.recompile.Mandos"

3426

2525

2526

@dbus_interface_annotations(_interface)

2527

def _foo(self):

2528

return { "org.freedesktop.DBus.Property"

2529

".EmitsChangedSignal":

2530

"false"}

2531

3427

2532

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

3428

2533

def ClientAdded(self, objpath):

3429

2534

"D-Bus signal"

3430

2535

pass

3431

2536

3432

2537

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

3433

def ClientNotFound(self, key_id, address):

2538

def ClientNotFound(self, fingerprint, address):

3434

2539

"D-Bus signal"

3435

2540

pass

3436

3437

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

3438

"true"})

2541

3439

2542

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

3440

2543

def ClientRemoved(self, objpath, name):

3441

2544

"D-Bus signal"

3442

2545

pass

3443

3444

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

3445

"true"})

2546

3446

2547

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

3447

2548

def GetAllClients(self):

3448

2549

"D-Bus method"

3449

return dbus.Array(c.dbus_object_path for c in

3450

tcp_server.clients.values())

3451

3452

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

3453

"true"})

2550

return dbus.Array(c.dbus_object_path

2551

for c in

2552

tcp_server.clients.itervalues())

2553

3454

2554

@dbus.service.method(_interface,

3455

2555

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

3456

2556

def GetAllClientsWithProperties(self):

3457

2557

"D-Bus method"

3458

2558

return dbus.Dictionary(

3459

{c.dbus_object_path: c.GetAll(

3460

"se.recompile.Mandos.Client")

3461

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

2559

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

2560

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

3462

2561

signature="oa{sv}")

3463

2562

3464

2563

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

3465

2564

def RemoveClient(self, object_path):

3466

2565

"D-Bus method"

3467

for c in tcp_server.clients.values():

2566

for c in tcp_server.clients.itervalues():

3468

2567

if c.dbus_object_path == object_path:

3469

2568

del tcp_server.clients[c.name]

3470

2569

c.remove_from_connection()

3471

# Don't signal the disabling

2570

# Don't signal anything except ClientRemoved

3472

2571

c.disable(quiet=True)

3473

# Emit D-Bus signal for removal

3474

self.client_removed_signal(c)

2572

# Emit D-Bus signal

2573

self.ClientRemoved(object_path, c.name)

3475

2574

return

3476

2575

raise KeyError(object_path)

3477

2576

3478

2577

del _interface

3479

3480

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3481

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

3482

def GetManagedObjects(self):

3483

"""D-Bus method"""

3484

return dbus.Dictionary(

3485

{client.dbus_object_path:

3486

dbus.Dictionary(

3487

{interface: client.GetAll(interface)

3488

for interface in

3489

client._get_all_interface_names()})

3490

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

3491

3492

def client_added_signal(self, client):

3493

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

3494

if use_dbus:

3495

# New standard signal

3496

self.InterfacesAdded(

3497

client.dbus_object_path,

3498

dbus.Dictionary(

3499

{interface: client.GetAll(interface)

3500

for interface in

3501

client._get_all_interface_names()}))

3502

# Old signal

3503

self.ClientAdded(client.dbus_object_path)

3504

3505

def client_removed_signal(self, client):

3506

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

3507

if use_dbus:

3508

# New standard signal

3509

self.InterfacesRemoved(

3510

client.dbus_object_path,

3511

client._get_all_interface_names())

3512

# Old signal

3513

self.ClientRemoved(client.dbus_object_path,

3514

client.name)

3515

2578

3516

2579

mandos_dbus_service = MandosDBusService()

3517

3518

# Save modules to variables to exempt the modules from being

3519

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

3520

mp = multiprocessing

3521

wn = wnull

3522

2580

3523

2581

def cleanup():

3524

2582

"Cleanup function; run on exit"

3525

if zeroconf:

3526

service.cleanup()

3527

3528

mp.active_children()

3529

wn.close()

2583

service.cleanup()

2584

2585

multiprocessing.active_children()

3530

2586

if not (tcp_server.clients or client_settings):

3531

2587

return

3532

2588

3533

2589

# Store client before exiting. Secrets are encrypted with key

3534

2590

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

3535

2591

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

3536

2592

clients = {}

3537

2593

with PGPEngine() as pgp:

3538

for client in tcp_server.clients.values():

2594

for client in tcp_server.clients.itervalues():

3539

2595

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

3540

2596

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

3541

2597

key)

3542

2598

client_dict = {}

3543

2599

3544

2600

# A list of attributes that can not be pickled

3545

2601

# + secret.

3546

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

3547

"checker", "server_settings"}

3548

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

3549

.Object):

2602

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

2603

"checker"))

2604

for name, typ in (inspect.getmembers

2605

(dbus.service.Object)):

3550

2606

exclude.add(name)

3551

2607

3552

2608

client_dict["encrypted_secret"] = (client

3553

2609

.encrypted_secret)

3554

2610

for attr in client.client_structure:

3555

2611

if attr not in exclude:

3556

2612

client_dict[attr] = getattr(client, attr)

3557

2613

3558

2614

clients[client.name] = client_dict

3559

2615

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

3560

2616

3561

2617

try:

3562

with tempfile.NamedTemporaryFile(

3563

mode='wb',

3564

suffix=".pickle",

3565

prefix='clients-',

3566

dir=os.path.dirname(stored_state_path),

3567

delete=False) as stored_state:

3568

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

3569

protocol=2)

3570

tempname = stored_state.name

2618

with (tempfile.NamedTemporaryFile

2619

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

2620

dir=os.path.dirname(stored_state_path),

2621

delete=False)) as stored_state:

2622

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

2623

tempname=stored_state.name

3571

2624

os.rename(tempname, stored_state_path)

3572

2625

except (IOError, OSError) as e:

3573

2626

if not debug:

3576

2629

except NameError:

3577

2630

pass

3578

2631

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

3579

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

2632

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

3580

2633

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

3581

2634

else:

3582

2635

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

3583

2636

exc_info=e)

3584

raise

3585

2637

raise e

2638

3586

2639

# Delete all clients, and settings from config

3587

2640

while tcp_server.clients:

3588

2641

name, client = tcp_server.clients.popitem()

3589

2642

if use_dbus:

3590

2643

client.remove_from_connection()

3591

# Don't signal the disabling

2644

# Don't signal anything except ClientRemoved

3592

2645

client.disable(quiet=True)

3593

# Emit D-Bus signal for removal

3594

2646

if use_dbus:

3595

mandos_dbus_service.client_removed_signal(client)

2647

# Emit D-Bus signal

2648

mandos_dbus_service.ClientRemoved(client

2649

.dbus_object_path,

2650

client.name)

3596

2651

client_settings.clear()

3597

2652

3598

2653

atexit.register(cleanup)

3599

3600

for client in tcp_server.clients.values():

2654

2655

for client in tcp_server.clients.itervalues():

3601

2656

if use_dbus:

3602

# Emit D-Bus signal for adding

3603

mandos_dbus_service.client_added_signal(client)

2657

# Emit D-Bus signal

2658

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3604

2659

# Need to initiate checking of clients

3605

2660

if client.enabled:

3606

2661

client.init_checker()

3607

2662

3608

2663

tcp_server.enable()

3609

2664

tcp_server.server_activate()

3610

2665

3611

2666

# Find out what port we got

3612

if zeroconf:

3613

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

2667

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

3614

2668

if use_ipv6:

3615

2669

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

3616

2670

" flowinfo %d, scope_id %d",

3618

2672

else: # IPv4

3619

2673

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

3620

2674

*tcp_server.socket.getsockname())

3621

3622

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

3623

2675

2676

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

2677

3624

2678

try:

3625

if zeroconf:

3626

# From the Avahi example code

3627

try:

3628

service.activate()

3629

except dbus.exceptions.DBusException as error:

3630

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

3631

cleanup()

3632

sys.exit(1)

3633

# End of Avahi example code

3634

3635

GLib.io_add_watch(

3636

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

3637

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3638

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

3639

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

3640

2679

# From the Avahi example code

2680

try:

2681

service.activate()

2682

except dbus.exceptions.DBusException as error:

2683

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

2684

cleanup()

2685

sys.exit(1)

2686

# End of Avahi example code

2687

2688

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

2689

lambda *args, **kwargs:

2690

(tcp_server.handle_request

2691

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

2692

3641

2693

logger.debug("Starting main loop")

3642

2694

main_loop.run()

3643

2695

except AvahiError as error:

3652

2704

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

3653

2705

cleanup()

3654

2706

3655

3656

def should_only_run_tests():

3657

parser = argparse.ArgumentParser(add_help=False)

3658

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

3659

args, unknown_args = parser.parse_known_args()

3660

run_tests = args.check

3661

if run_tests:

3662

# Remove --check argument from sys.argv

3663

sys.argv[1:] = unknown_args

3664

return run_tests

3665

3666

# Add all tests from doctest strings

3667

def load_tests(loader, tests, none):

3668

import doctest

3669

tests.addTests(doctest.DocTestSuite())

3670

return tests

3671

3672

2707

if __name__ == '__main__':

3673

try:

3674

if should_only_run_tests():

3675

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

3676

unittest.main()

3677

else:

3678

main()

3679

finally:

3680

logging.shutdown()

2708

main()