/mandos/trunk : revision 581

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

89

SO_BINDTODEVICE = None

90

91

version = "1.5.3"

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

238

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

153

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

524

382

class AvahiServiceToSyslog(AvahiService):

525

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

383

def rename(self):

526

384

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

527

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

528

syslogger.setFormatter(logging.Formatter(

529

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

530

.format(self.name)))

385

ret = AvahiService.rename(self)

386

syslogger.setFormatter(logging.Formatter

387

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

388

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

389

.format(self.name)))

531

390

return ret

532

391

533

534

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

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

539

if library is None:

540

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

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

544

# Unless otherwise indicated, the constants and types below are

545

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

546

547

# Constants

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

CLIENT = 2

554

SHUT_RDWR = 0

555

CRD_CERTIFICATE = 1

556

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

564

# Types

565

class session_int(ctypes.Structure):

566

_fields_ = []

567

session_t = ctypes.POINTER(session_int)

568

569

class certificate_credentials_st(ctypes.Structure):

570

_fields_ = []

571

certificate_credentials_t = ctypes.POINTER(

572

certificate_credentials_st)

573

certificate_type_t = ctypes.c_int

574

575

class datum_t(ctypes.Structure):

576

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

577

('size', ctypes.c_uint)]

578

579

class openpgp_crt_int(ctypes.Structure):

580

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

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

584

credentials_type_t = ctypes.c_int

585

transport_ptr_t = ctypes.c_void_p

586

close_request_t = ctypes.c_int

587

588

# Exceptions

589

class Error(Exception):

590

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

591

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

592

# code is passed, convert it to a string with

593

# gnutls.strerror()

594

self.code = code

595

if message is None and code is not None:

596

message = gnutls.strerror(code)

597

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

598

message, *args)

599

600

class CertificateSecurityError(Error):

601

pass

602

603

# Classes

604

class Credentials:

605

def __init__(self):

606

self._c_object = gnutls.certificate_credentials_t()

607

gnutls.certificate_allocate_credentials(

608

ctypes.byref(self._c_object))

609

self.type = gnutls.CRD_CERTIFICATE

610

611

def __del__(self):

612

gnutls.certificate_free_credentials(self._c_object)

613

614

class ClientSession:

615

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

616

self._c_object = gnutls.session_t()

617

gnutls_flags = gnutls.CLIENT

618

if gnutls.check_version(b"3.5.6"):

619

gnutls_flags |= gnutls.NO_TICKETS

620

if gnutls.has_rawpk:

621

gnutls_flags |= gnutls.ENABLE_RAWPK

622

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

623

del gnutls_flags

624

gnutls.set_default_priority(self._c_object)

625

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

626

gnutls.handshake_set_private_extensions(self._c_object,

627

True)

628

self.socket = socket

629

if credentials is None:

630

credentials = gnutls.Credentials()

631

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

632

ctypes.cast(credentials._c_object,

633

ctypes.c_void_p))

634

self.credentials = credentials

635

636

def __del__(self):

637

gnutls.deinit(self._c_object)

638

639

def handshake(self):

640

return gnutls.handshake(self._c_object)

641

642

def send(self, data):

643

data = bytes(data)

644

data_len = len(data)

645

while data_len > 0:

646

data_len -= gnutls.record_send(self._c_object,

647

data[-data_len:],

648

data_len)

649

650

def bye(self):

651

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

652

653

# Error handling functions

654

def _error_code(result):

655

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

656

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

657

if result >= 0:

658

return result

659

if result == gnutls.E_NO_CERTIFICATE_FOUND:

660

raise gnutls.CertificateSecurityError(code=result)

661

raise gnutls.Error(code=result)

662

663

def _retry_on_error(result, func, arguments):

664

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

665

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

666

while result < 0:

667

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

668

return _error_code(result)

669

result = func(*arguments)

670

return result

671

672

# Unless otherwise indicated, the function declarations below are

673

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

674

675

# Functions

676

priority_set_direct = _library.gnutls_priority_set_direct

677

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

678

ctypes.POINTER(ctypes.c_char_p)]

679

priority_set_direct.restype = _error_code

680

681

init = _library.gnutls_init

682

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

683

init.restype = _error_code

684

685

set_default_priority = _library.gnutls_set_default_priority

686

set_default_priority.argtypes = [session_t]

687

set_default_priority.restype = _error_code

688

689

record_send = _library.gnutls_record_send

690

record_send.argtypes = [session_t, ctypes.c_void_p,

691

ctypes.c_size_t]

692

record_send.restype = ctypes.c_ssize_t

693

record_send.errcheck = _retry_on_error

694

695

certificate_allocate_credentials = (

696

_library.gnutls_certificate_allocate_credentials)

697

certificate_allocate_credentials.argtypes = [

698

ctypes.POINTER(certificate_credentials_t)]

699

certificate_allocate_credentials.restype = _error_code

700

701

certificate_free_credentials = (

702

_library.gnutls_certificate_free_credentials)

703

certificate_free_credentials.argtypes = [

704

certificate_credentials_t]

705

certificate_free_credentials.restype = None

706

707

handshake_set_private_extensions = (

708

_library.gnutls_handshake_set_private_extensions)

709

handshake_set_private_extensions.argtypes = [session_t,

710

ctypes.c_int]

711

handshake_set_private_extensions.restype = None

712

713

credentials_set = _library.gnutls_credentials_set

714

credentials_set.argtypes = [session_t, credentials_type_t,

715

ctypes.c_void_p]

716

credentials_set.restype = _error_code

717

718

strerror = _library.gnutls_strerror

719

strerror.argtypes = [ctypes.c_int]

720

strerror.restype = ctypes.c_char_p

721

722

certificate_type_get = _library.gnutls_certificate_type_get

723

certificate_type_get.argtypes = [session_t]

724

certificate_type_get.restype = _error_code

725

726

certificate_get_peers = _library.gnutls_certificate_get_peers

727

certificate_get_peers.argtypes = [session_t,

728

ctypes.POINTER(ctypes.c_uint)]

729

certificate_get_peers.restype = ctypes.POINTER(datum_t)

730

731

global_set_log_level = _library.gnutls_global_set_log_level

732

global_set_log_level.argtypes = [ctypes.c_int]

733

global_set_log_level.restype = None

734

735

global_set_log_function = _library.gnutls_global_set_log_function

736

global_set_log_function.argtypes = [log_func]

737

global_set_log_function.restype = None

738

739

deinit = _library.gnutls_deinit

740

deinit.argtypes = [session_t]

741

deinit.restype = None

742

743

handshake = _library.gnutls_handshake

744

handshake.argtypes = [session_t]

745

handshake.restype = _error_code

746

handshake.errcheck = _retry_on_error

747

748

transport_set_ptr = _library.gnutls_transport_set_ptr

749

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

750

transport_set_ptr.restype = None

751

752

bye = _library.gnutls_bye

753

bye.argtypes = [session_t, close_request_t]

754

bye.restype = _error_code

755

bye.errcheck = _retry_on_error

756

757

check_version = _library.gnutls_check_version

758

check_version.argtypes = [ctypes.c_char_p]

759

check_version.restype = ctypes.c_char_p

760

761

_need_version = b"3.3.0"

762

if check_version(_need_version) is None:

763

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

764

.format(_need_version))

765

766

_tls_rawpk_version = b"3.6.6"

767

has_rawpk = bool(check_version(_tls_rawpk_version))

768

769

if has_rawpk:

770

# Types

771

class pubkey_st(ctypes.Structure):

772

_fields = []

773

pubkey_t = ctypes.POINTER(pubkey_st)

774

775

x509_crt_fmt_t = ctypes.c_int

776

777

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

778

pubkey_init = _library.gnutls_pubkey_init

779

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

780

pubkey_init.restype = _error_code

781

782

pubkey_import = _library.gnutls_pubkey_import

783

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

784

x509_crt_fmt_t]

785

pubkey_import.restype = _error_code

786

787

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

788

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

789

ctypes.POINTER(ctypes.c_ubyte),

790

ctypes.POINTER(ctypes.c_size_t)]

791

pubkey_get_key_id.restype = _error_code

792

793

pubkey_deinit = _library.gnutls_pubkey_deinit

794

pubkey_deinit.argtypes = [pubkey_t]

795

pubkey_deinit.restype = None

796

else:

797

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

798

799

openpgp_crt_init = _library.gnutls_openpgp_crt_init

800

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

801

openpgp_crt_init.restype = _error_code

802

803

openpgp_crt_import = _library.gnutls_openpgp_crt_import

804

openpgp_crt_import.argtypes = [openpgp_crt_t,

805

ctypes.POINTER(datum_t),

806

openpgp_crt_fmt_t]

807

openpgp_crt_import.restype = _error_code

808

809

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

810

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

811

ctypes.POINTER(ctypes.c_uint)]

812

openpgp_crt_verify_self.restype = _error_code

813

814

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

815

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

816

openpgp_crt_deinit.restype = None

817

818

openpgp_crt_get_fingerprint = (

819

_library.gnutls_openpgp_crt_get_fingerprint)

820

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

821

ctypes.c_void_p,

822

ctypes.POINTER(

823

ctypes.c_size_t)]

824

openpgp_crt_get_fingerprint.restype = _error_code

825

826

if check_version(b"3.6.4"):

827

certificate_type_get2 = _library.gnutls_certificate_type_get2

828

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

829

certificate_type_get2.restype = _error_code

830

831

# Remove non-public functions

832

del _error_code, _retry_on_error

833

834

835

def call_pipe(connection, # : multiprocessing.Connection

836

func, *args, **kwargs):

837

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

838

839

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

840

return value on the provided multiprocessing.Connection.

841

"""

842

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

843

connection.close()

844

845

846

class Client:

392

def timedelta_to_milliseconds(td):

393

"Convert a datetime.timedelta() to milliseconds"

394

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

395

+ (td.seconds * 1000)

396

+ (td.microseconds // 1000))

397

398

class Client(object):

847

399

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

848

400

849

401

Attributes:

850

402

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

851

403

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

852

404

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

853

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

854

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

855

running.

856

checker_callback_tag: a GLib event source tag, or None

405

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

406

to see if the client lives.

407

'None' if no process is running.

408

checker_callback_tag: a gobject event source tag, or None

857

409

checker_command: string; External command which is run to check

858

410

if client lives. %() expansions are done at

859

411

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

860

412

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

861

checker_initiator_tag: a GLib event source tag, or None

413

checker_initiator_tag: a gobject event source tag, or None

862

414

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

863

415

client_structure: Object describing what attributes a client has

864

416

and is used for storing the client at exit

865

417

current_checker_command: string; current running checker_command

866

disable_initiator_tag: a GLib event source tag, or None

418

disable_initiator_tag: a gobject event source tag, or None

867

419

enabled: bool()

868

420

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

869

uniquely identify an OpenPGP client

870

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

871

a client using raw public keys

421

uniquely identify the client

872

422

host: string; available for use by the checker command

873

423

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

874

424

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

876

426

last_checker_status: integer between 0 and 255 reflecting exit

877

427

status of last checker. -1 reflects crashed

878

428

checker, -2 means no checker completed yet.

879

last_checker_signal: The signal which killed the last checker, if

880

last_checker_status is -1

881

429

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

882

430

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

883

431

D-Bus identifiers

888

436

runtime_expansions: Allowed attributes for runtime expansion.

889

437

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

890

438

disabled, or None

891

server_settings: The server_settings dict from main()

892

439

"""

893

440

894

441

runtime_expansions = ("approval_delay", "approval_duration",

895

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

896

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

897

"last_approval_request", "last_checked_ok",

442

"created", "enabled", "fingerprint",

443

"host", "interval", "last_checked_ok",

898

444

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

899

client_defaults = {

900

"timeout": "PT5M",

901

"extended_timeout": "PT15M",

902

"interval": "PT2M",

903

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

904

"host": "",

905

"approval_delay": "PT0S",

906

"approval_duration": "PT1S",

907

"approved_by_default": "True",

908

"enabled": "True",

909

}

910

445

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

446

"extended_timeout": "15m",

447

"interval": "2m",

448

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

449

"host": "",

450

"approval_delay": "0s",

451

"approval_duration": "1s",

452

"approved_by_default": "True",

453

"enabled": "True",

454

}

455

456

def timeout_milliseconds(self):

457

"Return the 'timeout' attribute in milliseconds"

458

return timedelta_to_milliseconds(self.timeout)

459

460

def extended_timeout_milliseconds(self):

461

"Return the 'extended_timeout' attribute in milliseconds"

462

return timedelta_to_milliseconds(self.extended_timeout)

463

464

def interval_milliseconds(self):

465

"Return the 'interval' attribute in milliseconds"

466

return timedelta_to_milliseconds(self.interval)

467

468

def approval_delay_milliseconds(self):

469

return timedelta_to_milliseconds(self.approval_delay)

470

911

471

@staticmethod

912

472

def config_parser(config):

913

473

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

920

480

for client_name in config.sections():

921

481

section = dict(config.items(client_name))

922

482

client = settings[client_name] = {}

923

483

924

484

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

925

485

# Reformat values from string types to Python types

926

486

client["approved_by_default"] = config.getboolean(

927

487

client_name, "approved_by_default")

928

488

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

929

489

"enabled")

930

931

# Uppercase and remove spaces from key_id and fingerprint

932

# for later comparison purposes with return value from the

933

# key_id() and fingerprint() functions

934

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

935

.replace(" ", ""))

490

936

491

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

937

492

.replace(" ", ""))

938

493

if "secret" in section:

939

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

940

.encode("utf-8"),

941

"base64")

494

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

942

495

elif "secfile" in section:

943

496

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

944

497

(section["secfile"])),

945

498

"rb") as secfile:

946

499

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

947

500

else:

948

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

501

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

949

502

.format(section))

950

503

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

951

504

client["extended_timeout"] = string_to_delta(

959

512

client["last_approval_request"] = None

960

513

client["last_checked_ok"] = None

961

514

client["last_checker_status"] = -2

962

515

963

516

return settings

964

965

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

517

518

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

966

519

self.name = name

967

if server_settings is None:

968

server_settings = {}

969

self.server_settings = server_settings

970

520

# adding all client settings

971

for setting, value in settings.items():

521

for setting, value in settings.iteritems():

972

522

setattr(self, setting, value)

973

523

974

524

if self.enabled:

975

525

if not hasattr(self, "last_enabled"):

976

526

self.last_enabled = datetime.datetime.utcnow()

980

530

else:

981

531

self.last_enabled = None

982

532

self.expires = None

983

533

984

534

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

985

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

535

# Uppercase and remove spaces from fingerprint for later

536

# comparison purposes with return value from the fingerprint()

537

# function

986

538

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

987

539

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

988

540

datetime.datetime.utcnow())

989

541

990

542

# attributes specific for this server instance

991

543

self.checker = None

992

544

self.checker_initiator_tag = None

995

547

self.current_checker_command = None

996

548

self.approved = None

997

549

self.approvals_pending = 0

998

self.changedstate = multiprocessing_manager.Condition(

999

multiprocessing_manager.Lock())

1000

self.client_structure = [attr

1001

for attr in self.__dict__.keys()

550

self.changedstate = (multiprocessing_manager

551

.Condition(multiprocessing_manager

552

.Lock()))

553

self.client_structure = [attr for attr in

554

self.__dict__.iterkeys()

1002

555

if not attr.startswith("_")]

1003

556

self.client_structure.append("client_structure")

1004

1005

for name, t in inspect.getmembers(

1006

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

557

558

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

559

lambda obj:

560

isinstance(obj,

561

property)):

1007

562

if not name.startswith("_"):

1008

563

self.client_structure.append(name)

1009

564

1010

565

# Send notice to process children that client state has changed

1011

566

def send_changedstate(self):

1012

567

with self.changedstate:

1013

568

self.changedstate.notify_all()

1014

569

1015

570

def enable(self):

1016

571

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

1017

572

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

1022

577

self.last_enabled = datetime.datetime.utcnow()

1023

578

self.init_checker()

1024

579

self.send_changedstate()

1025

580

1026

581

def disable(self, quiet=True):

1027

582

"""Disable this client."""

1028

583

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

1030

585

if not quiet:

1031

586

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

1032

587

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

1033

GLib.source_remove(self.disable_initiator_tag)

588

gobject.source_remove(self.disable_initiator_tag)

1034

589

self.disable_initiator_tag = None

1035

590

self.expires = None

1036

591

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

1037

GLib.source_remove(self.checker_initiator_tag)

592

gobject.source_remove(self.checker_initiator_tag)

1038

593

self.checker_initiator_tag = None

1039

594

self.stop_checker()

1040

595

self.enabled = False

1041

596

if not quiet:

1042

597

self.send_changedstate()

1043

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

598

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

1044

599

return False

1045

600

1046

601

def __del__(self):

1047

602

self.disable()

1048

603

1049

604

def init_checker(self):

1050

605

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

1051

606

# and every interval from then on.

1052

607

if self.checker_initiator_tag is not None:

1053

GLib.source_remove(self.checker_initiator_tag)

1054

self.checker_initiator_tag = GLib.timeout_add(

1055

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

1056

+ 1)),

1057

self.start_checker)

608

gobject.source_remove(self.checker_initiator_tag)

609

self.checker_initiator_tag = (gobject.timeout_add

610

(self.interval_milliseconds(),

611

self.start_checker))

1058

612

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

1059

613

if self.disable_initiator_tag is not None:

1060

GLib.source_remove(self.disable_initiator_tag)

1061

self.disable_initiator_tag = GLib.timeout_add(

1062

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

614

gobject.source_remove(self.disable_initiator_tag)

615

self.disable_initiator_tag = (gobject.timeout_add

616

(self.timeout_milliseconds(),

617

self.disable))

1063

618

# Also start a new checker *right now*.

1064

619

self.start_checker()

1065

1066

def checker_callback(self, source, condition, connection,

1067

command):

620

621

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

1068

622

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

1069

# Read return code from connection (see call_pipe)

1070

returncode = connection.recv()

1071

connection.close()

1072

if self.checker is not None:

1073

self.checker.join()

1074

623

self.checker_callback_tag = None

1075

624

self.checker = None

1076

1077

if returncode >= 0:

1078

self.last_checker_status = returncode

1079

self.last_checker_signal = None

625

if os.WIFEXITED(condition):

626

self.last_checker_status = os.WEXITSTATUS(condition)

1080

627

if self.last_checker_status == 0:

1081

628

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

1082

629

vars(self))

1083

630

self.checked_ok()

1084

631

else:

1085

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

632

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

633

vars(self))

1086

634

else:

1087

635

self.last_checker_status = -1

1088

self.last_checker_signal = -returncode

1089

636

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

1090

637

vars(self))

1091

return False

1092

638

1093

639

def checked_ok(self):

1094

640

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

1095

641

self.last_checked_ok = datetime.datetime.utcnow()

1096

642

self.last_checker_status = 0

1097

self.last_checker_signal = None

1098

643

self.bump_timeout()

1099

644

1100

645

def bump_timeout(self, timeout=None):

1101

646

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

1102

647

if timeout is None:

1103

648

timeout = self.timeout

1104

649

if self.disable_initiator_tag is not None:

1105

GLib.source_remove(self.disable_initiator_tag)

650

gobject.source_remove(self.disable_initiator_tag)

1106

651

self.disable_initiator_tag = None

1107

652

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

1108

self.disable_initiator_tag = GLib.timeout_add(

1109

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

653

self.disable_initiator_tag = (gobject.timeout_add

654

(timedelta_to_milliseconds

655

(timeout), self.disable))

1110

656

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

1111

657

1112

658

def need_approval(self):

1113

659

self.last_approval_request = datetime.datetime.utcnow()

1114

660

1115

661

def start_checker(self):

1116

662

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

1117

663

1118

664

If a checker already exists, leave it running and do

1119

665

nothing."""

1120

666

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

1125

671

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

1126

672

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

1127

673

# should be.

1128

1129

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

1130

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

1131

self.checker.join()

1132

self.checker = None

674

675

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

676

try:

677

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

678

except (AttributeError, OSError) as error:

679

if (isinstance(error, OSError)

680

and error.errno != errno.ECHILD):

681

raise error

682

else:

683

if pid:

684

logger.warning("Checker was a zombie")

685

gobject.source_remove(self.checker_callback_tag)

686

self.checker_callback(pid, status,

687

self.current_checker_command)

1133

688

# Start a new checker if needed

1134

689

if self.checker is None:

1135

# Escape attributes for the shell

1136

escaped_attrs = {

1137

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

1138

for attr in self.runtime_expansions}

1139

try:

1140

command = self.checker_command % escaped_attrs

1141

except TypeError as error:

1142

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

1143

self.checker_command,

690

try:

691

# In case checker_command has exactly one % operator

692

command = self.checker_command % self.host

693

except TypeError:

694

# Escape attributes for the shell

695

escaped_attrs = dict(

696

(attr,

697

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

698

errors=

699

'replace')))

700

for attr in

701

self.runtime_expansions)

702

703

try:

704

command = self.checker_command % escaped_attrs

705

except TypeError as error:

706

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

707

self.checker_command, exc_info=error)

708

return True # Try again later

709

self.current_checker_command = command

710

try:

711

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

712

command, self.name)

713

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

714

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

715

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

716

# always replaced by /dev/null.)

717

self.checker = subprocess.Popen(command,

718

close_fds=True,

719

shell=True, cwd="/")

720

self.checker_callback_tag = (gobject.child_watch_add

721

(self.checker.pid,

722

self.checker_callback,

723

data=command))

724

# The checker may have completed before the gobject

725

# watch was added. Check for this.

726

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

727

if pid:

728

gobject.source_remove(self.checker_callback_tag)

729

self.checker_callback(pid, status, command)

730

except OSError as error:

731

logger.error("Failed to start subprocess",

1144

732

exc_info=error)

1145

return True # Try again later

1146

self.current_checker_command = command

1147

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

1148

self.name)

1149

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

1150

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

1151

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

1152

# always replaced by /dev/null.)

1153

# The exception is when not debugging but nevertheless

1154

# running in the foreground; use the previously

1155

# created wnull.

1156

popen_args = {"close_fds": True,

1157

"shell": True,

1158

"cwd": "/"}

1159

if (not self.server_settings["debug"]

1160

and self.server_settings["foreground"]):

1161

popen_args.update({"stdout": wnull,

1162

"stderr": wnull})

1163

pipe = multiprocessing.Pipe(duplex=False)

1164

self.checker = multiprocessing.Process(

1165

target=call_pipe,

1166

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

1167

kwargs=popen_args)

1168

self.checker.start()

1169

self.checker_callback_tag = GLib.io_add_watch(

1170

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

1171

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1172

self.checker_callback, pipe[0], command)

1173

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

733

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

1174

734

return True

1175

735

1176

736

def stop_checker(self):

1177

737

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

1178

738

if self.checker_callback_tag:

1179

GLib.source_remove(self.checker_callback_tag)

739

gobject.source_remove(self.checker_callback_tag)

1180

740

self.checker_callback_tag = None

1181

741

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

1182

742

return

1183

743

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

1184

self.checker.terminate()

744

try:

745

self.checker.terminate()

746

#time.sleep(0.5)

747

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

748

# self.checker.kill()

749

except OSError as error:

750

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

751

raise

1185

752

self.checker = None

1186

753

1187

754

1188

def dbus_service_property(dbus_interface,

1189

signature="v",

1190

access="readwrite",

1191

byte_arrays=False):

755

def dbus_service_property(dbus_interface, signature="v",

756

access="readwrite", byte_arrays=False):

1192

757

"""Decorators for marking methods of a DBusObjectWithProperties to

1193

758

become properties on the D-Bus.

1194

759

1195

760

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

1196

761

and with one argument by "Set".

1197

762

1198

763

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

1199

764

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

1200

765

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

1203

768

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

1204

769

if byte_arrays and signature != "ay":

1205

770

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

1206

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

1207

771

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

1208

772

def decorator(func):

1209

773

func._dbus_is_property = True

1210

774

func._dbus_interface = dbus_interface

1213

777

func._dbus_name = func.__name__

1214

778

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

1215

779

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

1216

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

780

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1217

781

return func

1218

1219

782

return decorator

1220

783

1221

784

1222

785

def dbus_interface_annotations(dbus_interface):

1223

786

"""Decorator for marking functions returning interface annotations

1224

787

1225

788

Usage:

1226

789

1227

790

@dbus_interface_annotations("org.example.Interface")

1228

791

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

1229

792

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

1230

793

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

1231

794

"false"}

1232

795

"""

1233

1234

796

def decorator(func):

1235

797

func._dbus_is_interface = True

1236

798

func._dbus_interface = dbus_interface

1237

799

func._dbus_name = dbus_interface

1238

800

return func

1239

1240

801

return decorator

1241

802

1242

803

1243

804

def dbus_annotations(annotations):

1244

805

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

1245

806

Usage:

1246

1247

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

1248

"org.freedesktop.DBus.Property."

1249

"EmitsChangedSignal": "false"})

807

1250

808

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

1251

809

access="r")

810

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

811

"org.freedesktop.DBus.Property."

812

"EmitsChangedSignal": "false"})

1252

813

def Property_dbus_property(self):

1253

814

return dbus.Boolean(False)

1254

1255

See also the DBusObjectWithAnnotations class.

1256

815

"""

1257

1258

816

def decorator(func):

1259

817

func._dbus_annotations = annotations

1260

818

return func

1261

1262

819

return decorator

1263

820

1264

821

1265

822

class DBusPropertyException(dbus.exceptions.DBusException):

1266

823

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

1267

824

"""

1268

pass

825

def __unicode__(self):

826

return unicode(str(self))

1269

827

1270

828

1271

829

class DBusPropertyAccessException(DBusPropertyException):

1280

838

pass

1281

839

1282

840

1283

class DBusObjectWithAnnotations(dbus.service.Object):

1284

"""A D-Bus object with annotations.

1285

1286

Classes inheriting from this can use the dbus_annotations

1287

decorator to add annotations to methods or signals.

841

class DBusObjectWithProperties(dbus.service.Object):

842

"""A D-Bus object with properties.

843

844

Classes inheriting from this can use the dbus_service_property

845

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

846

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

1288

847

"""

1289

848

1290

849

@staticmethod

1291

850

def _is_dbus_thing(thing):

1292

851

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

1293

852

1294

853

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

1295

854

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

1296

855

"""

1297

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

856

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

1298

857

False)

1299

858

1300

859

def _get_all_dbus_things(self, thing):

1301

860

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

1302

861

"""

1303

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

862

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

863

name),

1304

864

athing.__get__(self))

1305

865

for cls in self.__class__.__mro__

1306

866

for name, athing in

1307

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

1308

1309

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1310

out_signature="s",

1311

path_keyword='object_path',

1312

connection_keyword='connection')

1313

def Introspect(self, object_path, connection):

1314

"""Overloading of standard D-Bus method.

1315

1316

Inserts annotation tags on methods and signals.

1317

"""

1318

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

1319

connection)

1320

try:

1321

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

1322

1323

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

1324

# Add annotation tags

1325

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

1326

for tag in if_tag.getElementsByTagName(typ):

1327

annots = dict()

1328

for name, prop in (self.

1329

_get_all_dbus_things(typ)):

1330

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

1331

and prop._dbus_interface

1332

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

1333

annots.update(getattr(

1334

prop, "_dbus_annotations", {}))

1335

for name, value in annots.items():

1336

ann_tag = document.createElement(

1337

"annotation")

1338

ann_tag.setAttribute("name", name)

1339

ann_tag.setAttribute("value", value)

1340

tag.appendChild(ann_tag)

1341

# Add interface annotation tags

1342

for annotation, value in dict(

1343

itertools.chain.from_iterable(

1344

annotations().items()

1345

for name, annotations

1346

in self._get_all_dbus_things("interface")

1347

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

1348

)).items():

1349

ann_tag = document.createElement("annotation")

1350

ann_tag.setAttribute("name", annotation)

1351

ann_tag.setAttribute("value", value)

1352

if_tag.appendChild(ann_tag)

1353

# Fix argument name for the Introspect method itself

1354

if (if_tag.getAttribute("name")

1355

== dbus.INTROSPECTABLE_IFACE):

1356

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

1357

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

1358

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

1359

if (arg.getAttribute("direction")

1360

== "out"):

1361

arg.setAttribute("name",

1362

"xml_data")

1363

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

1364

document.unlink()

1365

except (AttributeError, xml.dom.DOMException,

1366

xml.parsers.expat.ExpatError) as error:

1367

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

1368

exc_info=error)

1369

return xmlstring

1370

1371

1372

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1373

"""A D-Bus object with properties.

1374

1375

Classes inheriting from this can use the dbus_service_property

1376

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

1377

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

1378

"""

1379

867

inspect.getmembers(cls,

868

self._is_dbus_thing(thing)))

869

1380

870

def _get_dbus_property(self, interface_name, property_name):

1381

871

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

1382

872

property with the specified name and interface.

1383

873

"""

1384

for cls in self.__class__.__mro__:

1385

for name, value in inspect.getmembers(

1386

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

874

for cls in self.__class__.__mro__:

875

for name, value in (inspect.getmembers

876

(cls,

877

self._is_dbus_thing("property"))):

1387

878

if (value._dbus_name == property_name

1388

879

and value._dbus_interface == interface_name):

1389

880

return value.__get__(self)

1390

881

1391

882

# No such property

1392

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

1393

self.dbus_object_path, interface_name, property_name))

1394

1395

@classmethod

1396

def _get_all_interface_names(cls):

1397

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

1398

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

1399

"_dbus_interface", None)

1400

for x in (inspect.getmro(cls))

1401

for attr in dir(x))

1402

if name is not None)

1403

1404

@dbus.service.method(dbus.PROPERTIES_IFACE,

1405

in_signature="ss",

883

raise DBusPropertyNotFound(self.dbus_object_path + ":"

884

+ interface_name + "."

885

+ property_name)

886

887

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

1406

888

out_signature="v")

1407

889

def Get(self, interface_name, property_name):

1408

890

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

1414

896

if not hasattr(value, "variant_level"):

1415

897

return value

1416

898

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

1417

899

1418

900

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

1419

901

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

1420

902

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

1426

908

# The byte_arrays option is not supported yet on

1427

909

# signatures other than "ay".

1428

910

if prop._dbus_signature != "ay":

1429

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

1430

"'ay' signature {!r}"

1431

.format(prop._dbus_signature))

1432

value = dbus.ByteArray(bytes(value))

911

raise ValueError

912

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

913

for byte in value))

1433

914

prop(value)

1434

1435

@dbus.service.method(dbus.PROPERTIES_IFACE,

1436

in_signature="s",

915

916

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

1437

917

out_signature="a{sv}")

1438

918

def GetAll(self, interface_name):

1439

919

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

1440

920

standard.

1441

921

1442

922

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

1443

923

"""

1444

924

properties = {}

1454

934

if not hasattr(value, "variant_level"):

1455

935

properties[name] = value

1456

936

continue

1457

properties[name] = type(value)(

1458

value, variant_level=value.variant_level + 1)

937

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

938

value.variant_level+1)

1459

939

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

1460

1461

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

1462

def PropertiesChanged(self, interface_name, changed_properties,

1463

invalidated_properties):

1464

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

1465

standard.

1466

"""

1467

pass

1468

940

1469

941

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1470

942

out_signature="s",

1471

943

path_keyword='object_path',

1472

944

connection_keyword='connection')

1473

945

def Introspect(self, object_path, connection):

1474

946

"""Overloading of standard D-Bus method.

1475

947

1476

948

Inserts property tags and interface annotation tags.

1477

949

"""

1478

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1479

object_path,

1480

connection)

950

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

951

connection)

1481

952

try:

1482

953

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

1483

1484

954

def make_tag(document, name, prop):

1485

955

e = document.createElement("property")

1486

956

e.setAttribute("name", name)

1487

957

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

1488

958

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

1489

959

return e

1490

1491

960

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

1492

961

# Add property tags

1493

962

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

1496

965

if prop._dbus_interface

1497

966

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

1498

967

if_tag.appendChild(tag)

1499

# Add annotation tags for properties

1500

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

1501

annots = dict()

1502

for name, prop in self._get_all_dbus_things(

1503

"property"):

1504

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

1505

and prop._dbus_interface

1506

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

1507

annots.update(getattr(

1508

prop, "_dbus_annotations", {}))

1509

for name, value in annots.items():

1510

ann_tag = document.createElement(

1511

"annotation")

1512

ann_tag.setAttribute("name", name)

1513

ann_tag.setAttribute("value", value)

1514

tag.appendChild(ann_tag)

968

# Add annotation tags

969

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

970

for tag in if_tag.getElementsByTagName(typ):

971

annots = dict()

972

for name, prop in (self.

973

_get_all_dbus_things(typ)):

974

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

975

and prop._dbus_interface

976

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

977

annots.update(getattr

978

(prop,

979

"_dbus_annotations",

980

{}))

981

for name, value in annots.iteritems():

982

ann_tag = document.createElement(

983

"annotation")

984

ann_tag.setAttribute("name", name)

985

ann_tag.setAttribute("value", value)

986

tag.appendChild(ann_tag)

987

# Add interface annotation tags

988

for annotation, value in dict(

989

itertools.chain.from_iterable(

990

annotations().iteritems()

991

for name, annotations in

992

self._get_all_dbus_things("interface")

993

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

994

)).iteritems():

995

ann_tag = document.createElement("annotation")

996

ann_tag.setAttribute("name", annotation)

997

ann_tag.setAttribute("value", value)

998

if_tag.appendChild(ann_tag)

1515

999

# Add the names to the return values for the

1516

1000

# "org.freedesktop.DBus.Properties" methods

1517

1001

if (if_tag.getAttribute("name")

1536

1020

return xmlstring

1537

1021

1538

1022

1539

try:

1540

dbus.OBJECT_MANAGER_IFACE

1541

except AttributeError:

1542

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

1543

1544

1545

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1546

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

1547

1548

Classes inheriting from this exposes the standard

1549

GetManagedObjects call and the InterfacesAdded and

1550

InterfacesRemoved signals on the standard

1551

"org.freedesktop.DBus.ObjectManager" interface.

1552

1553

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

1554

manually.

1555

"""

1556

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1557

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

1558

def GetManagedObjects(self):

1559

"""This function must be overridden"""

1560

raise NotImplementedError()

1561

1562

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1563

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

1564

def InterfacesAdded(self, object_path, interfaces_and_properties):

1565

pass

1566

1567

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

1568

def InterfacesRemoved(self, object_path, interfaces):

1569

pass

1570

1571

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1572

out_signature="s",

1573

path_keyword='object_path',

1574

connection_keyword='connection')

1575

def Introspect(self, object_path, connection):

1576

"""Overloading of standard D-Bus method.

1577

1578

Override return argument name of GetManagedObjects to be

1579

"objpath_interfaces_and_properties"

1580

"""

1581

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1582

object_path,

1583

connection)

1584

try:

1585

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

1586

1587

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

1588

# Fix argument name for the GetManagedObjects method

1589

if (if_tag.getAttribute("name")

1590

== dbus.OBJECT_MANAGER_IFACE):

1591

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

1592

if (cn.getAttribute("name")

1593

== "GetManagedObjects"):

1594

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

1595

if (arg.getAttribute("direction")

1596

== "out"):

1597

arg.setAttribute(

1598

"name",

1599

"objpath_interfaces"

1600

"_and_properties")

1601

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

1602

document.unlink()

1603

except (AttributeError, xml.dom.DOMException,

1604

xml.parsers.expat.ExpatError) as error:

1605

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

1606

exc_info=error)

1607

return xmlstring

1608

1609

1610

def datetime_to_dbus(dt, variant_level=0):

1023

def datetime_to_dbus (dt, variant_level=0):

1611

1024

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

1612

1025

if dt is None:

1613

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

1614

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

1026

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

1027

return dbus.String(dt.isoformat(),

1028

variant_level=variant_level)

1615

1029

1616

1030

1617

1031

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1619

1033

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

1620

1034

interface names according to the "alt_interface_names" mapping.

1621

1035

Usage:

1622

1623

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

1624

"net.example.AlternateInterface"})

1036

1037

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

1038

"net.example.AlternateInterface"})

1625

1039

class SampleDBusObject(dbus.service.Object):

1626

1040

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

1627

1041

def SampleDBusMethod():

1628

1042

pass

1629

1043

1630

1044

The above "SampleDBusMethod" on "SampleDBusObject" will be

1631

1045

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

1632

1046

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

1633

1047

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

1634

1048

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

1635

1049

1636

1050

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

1637

1051

(from DBusObjectWithProperties) and interfaces (from the

1638

1052

dbus_interface_annotations decorator).

1639

1053

"""

1640

1641

1054

def wrapper(cls):

1642

1055

for orig_interface_name, alt_interface_name in (

1643

alt_interface_names.items()):

1056

alt_interface_names.iteritems()):

1644

1057

attr = {}

1645

1058

interface_names = set()

1646

1059

# Go though all attributes of the class

1648

1061

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

1649

1062

# with the wrong interface name

1650

1063

if (not hasattr(attribute, "_dbus_interface")

1651

or not attribute._dbus_interface.startswith(

1652

orig_interface_name)):

1064

or not attribute._dbus_interface

1065

.startswith(orig_interface_name)):

1653

1066

continue

1654

1067

# Create an alternate D-Bus interface name based on

1655

1068

# the current name

1656

alt_interface = attribute._dbus_interface.replace(

1657

orig_interface_name, alt_interface_name)

1069

alt_interface = (attribute._dbus_interface

1070

.replace(orig_interface_name,

1071

alt_interface_name))

1658

1072

interface_names.add(alt_interface)

1659

1073

# Is this a D-Bus signal?

1660

1074

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

1661

# Extract the original non-method undecorated

1662

# function by black magic

1663

if sys.version_info.major == 2:

1664

nonmethod_func = (dict(

1075

# Extract the original non-method function by

1076

# black magic

1077

nonmethod_func = (dict(

1665

1078

zip(attribute.func_code.co_freevars,

1666

attribute.__closure__))

1667

["func"].cell_contents)

1668

else:

1669

nonmethod_func = (dict(

1670

zip(attribute.__code__.co_freevars,

1671

attribute.__closure__))

1672

["func"].cell_contents)

1079

attribute.__closure__))["func"]

1080

.cell_contents)

1673

1081

# Create a new, but exactly alike, function

1674

1082

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

1675

1083

# with the alternate D-Bus interface name

1676

new_function = copy_function(nonmethod_func)

1677

new_function = (dbus.service.signal(

1678

alt_interface,

1679

attribute._dbus_signature)(new_function))

1084

new_function = (dbus.service.signal

1085

(alt_interface,

1086

attribute._dbus_signature)

1087

(types.FunctionType(

1088

nonmethod_func.func_code,

1089

nonmethod_func.func_globals,

1090

nonmethod_func.func_name,

1091

nonmethod_func.func_defaults,

1092

nonmethod_func.func_closure)))

1680

1093

# Copy annotations, if any

1681

1094

try:

1682

new_function._dbus_annotations = dict(

1683

attribute._dbus_annotations)

1095

new_function._dbus_annotations = (

1096

dict(attribute._dbus_annotations))

1684

1097

except AttributeError:

1685

1098

pass

1686

1687

1099

# Define a creator of a function to call both the

1688

1100

# original and alternate functions, so both the

1689

1101

# original and alternate signals gets sent when

1692

1104

"""This function is a scope container to pass

1693

1105

func1 and func2 to the "call_both" function

1694

1106

outside of its arguments"""

1695

1696

@functools.wraps(func2)

1697

1107

def call_both(*args, **kwargs):

1698

1108

"""This function will emit two D-Bus

1699

1109

signals by calling func1 and func2"""

1700

1110

func1(*args, **kwargs)

1701

1111

func2(*args, **kwargs)

1702

# Make wrapper function look like a D-Bus

1703

# signal

1704

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

1705

if name.startswith("_dbus_"):

1706

setattr(call_both, name, attr)

1707

1708

1112

return call_both

1709

1113

# Create the "call_both" function and add it to

1710

1114

# the class

1715

1119

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

1716

1120

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

1717

1121

# to the class.

1718

attr[attrname] = (

1719

dbus.service.method(

1720

alt_interface,

1721

attribute._dbus_in_signature,

1722

attribute._dbus_out_signature)

1723

(copy_function(attribute)))

1122

attr[attrname] = (dbus.service.method

1123

(alt_interface,

1124

attribute._dbus_in_signature,

1125

attribute._dbus_out_signature)

1126

(types.FunctionType

1127

(attribute.func_code,

1128

attribute.func_globals,

1129

attribute.func_name,

1130

attribute.func_defaults,

1131

attribute.func_closure)))

1724

1132

# Copy annotations, if any

1725

1133

try:

1726

attr[attrname]._dbus_annotations = dict(

1727

attribute._dbus_annotations)

1134

attr[attrname]._dbus_annotations = (

1135

dict(attribute._dbus_annotations))

1728

1136

except AttributeError:

1729

1137

pass

1730

1138

# Is this a D-Bus property?

1733

1141

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

1734

1142

# property with the alternate D-Bus interface

1735

1143

# name. Add it to the class.

1736

attr[attrname] = (dbus_service_property(

1737

alt_interface, attribute._dbus_signature,

1738

attribute._dbus_access,

1739

attribute._dbus_get_args_options

1740

["byte_arrays"])

1741

(copy_function(attribute)))

1144

attr[attrname] = (dbus_service_property

1145

(alt_interface,

1146

attribute._dbus_signature,

1147

attribute._dbus_access,

1148

attribute

1149

._dbus_get_args_options

1150

["byte_arrays"])

1151

(types.FunctionType

1152

(attribute.func_code,

1153

attribute.func_globals,

1154

attribute.func_name,

1155

attribute.func_defaults,

1156

attribute.func_closure)))

1742

1157

# Copy annotations, if any

1743

1158

try:

1744

attr[attrname]._dbus_annotations = dict(

1745

attribute._dbus_annotations)

1159

attr[attrname]._dbus_annotations = (

1160

dict(attribute._dbus_annotations))

1746

1161

except AttributeError:

1747

1162

pass

1748

1163

# Is this a D-Bus interface?

1751

1166

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

1752

1167

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

1753

1168

# to the class.

1754

attr[attrname] = (

1755

dbus_interface_annotations(alt_interface)

1756

(copy_function(attribute)))

1169

attr[attrname] = (dbus_interface_annotations

1170

(alt_interface)

1171

(types.FunctionType

1172

(attribute.func_code,

1173

attribute.func_globals,

1174

attribute.func_name,

1175

attribute.func_defaults,

1176

attribute.func_closure)))

1757

1177

if deprecate:

1758

1178

# Deprecate all alternate interfaces

1759

iname = "_AlternateDBusNames_interface_annotation{}"

1179

iname="_AlternateDBusNames_interface_annotation{0}"

1760

1180

for interface_name in interface_names:

1761

1762

1181

@dbus_interface_annotations(interface_name)

1763

1182

def func(self):

1764

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

1765

"true"}

1183

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

1184

"true" }

1766

1185

# Find an unused name

1767

1186

for aname in (iname.format(i)

1768

1187

for i in itertools.count()):

1772

1191

if interface_names:

1773

1192

# Replace the class with a new subclass of it with

1774

1193

# methods, signals, etc. as created above.

1775

if sys.version_info.major == 2:

1776

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

1777

(cls, ), attr)

1778

else:

1779

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

1780

(cls, ), attr)

1194

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

1195

(cls,), attr)

1781

1196

return cls

1782

1783

1197

return wrapper

1784

1198

1785

1199

1786

1200

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

1787

"se.bsnet.fukt.Mandos"})

1201

"se.bsnet.fukt.Mandos"})

1788

1202

class ClientDBus(Client, DBusObjectWithProperties):

1789

1203

"""A Client class using D-Bus

1790

1204

1791

1205

Attributes:

1792

1206

dbus_object_path: dbus.ObjectPath

1793

1207

bus: dbus.SystemBus()

1794

1208

"""

1795

1209

1796

1210

runtime_expansions = (Client.runtime_expansions

1797

+ ("dbus_object_path", ))

1798

1799

_interface = "se.recompile.Mandos.Client"

1800

1211

+ ("dbus_object_path",))

1212

1801

1213

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

1802

1803

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

1214

1215

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

1804

1216

self.bus = bus

1805

1217

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

1806

1218

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

1807

1219

# the D-Bus

1808

client_object_name = str(self.name).translate(

1220

client_object_name = unicode(self.name).translate(

1809

1221

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

1810

1222

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

1811

self.dbus_object_path = dbus.ObjectPath(

1812

"/clients/" + client_object_name)

1223

self.dbus_object_path = (dbus.ObjectPath

1224

("/clients/" + client_object_name))

1813

1225

DBusObjectWithProperties.__init__(self, self.bus,

1814

1226

self.dbus_object_path)

1815

1816

def notifychangeproperty(transform_func, dbus_name,

1817

type_func=lambda x: x,

1818

variant_level=1,

1819

invalidate_only=False,

1820

_interface=_interface):

1227

1228

def notifychangeproperty(transform_func,

1229

dbus_name, type_func=lambda x: x,

1230

variant_level=1):

1821

1231

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

1822

1232

its changes to DBus.

1823

1233

1824

1234

transform_fun: Function that takes a value and a variant_level

1825

1235

and transforms it to a D-Bus type.

1826

1236

dbus_name: D-Bus name of the variable

1828

1238

to the D-Bus. Default: no transform

1829

1239

variant_level: D-Bus variant level. Default: 1

1830

1240

"""

1831

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

1832

1241

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

1833

1242

def setter(self, value):

1834

1243

if hasattr(self, "dbus_object_path"):

1835

1244

if (not hasattr(self, attrname) or

1836

1245

type_func(getattr(self, attrname, None))

1837

1246

!= type_func(value)):

1838

if invalidate_only:

1839

self.PropertiesChanged(

1840

_interface, dbus.Dictionary(),

1841

dbus.Array((dbus_name, )))

1842

else:

1843

dbus_value = transform_func(

1844

type_func(value),

1845

variant_level=variant_level)

1846

self.PropertyChanged(dbus.String(dbus_name),

1847

dbus_value)

1848

self.PropertiesChanged(

1849

_interface,

1850

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

1851

dbus_value}),

1852

dbus.Array())

1247

dbus_value = transform_func(type_func(value),

1248

variant_level

1249

=variant_level)

1250

self.PropertyChanged(dbus.String(dbus_name),

1251

dbus_value)

1853

1252

setattr(self, attrname, value)

1854

1253

1855

1254

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

1856

1255

1857

1256

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1858

1257

approvals_pending = notifychangeproperty(dbus.Boolean,

1859

1258

"ApprovalPending",

1860

type_func=bool)

1259

type_func = bool)

1861

1260

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

1862

1261

last_enabled = notifychangeproperty(datetime_to_dbus,

1863

1262

"LastEnabled")

1864

checker = notifychangeproperty(

1865

dbus.Boolean, "CheckerRunning",

1866

type_func=lambda checker: checker is not None)

1263

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

1264

type_func = lambda checker:

1265

checker is not None)

1867

1266

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1868

1267

"LastCheckedOK")

1869

1268

last_checker_status = notifychangeproperty(dbus.Int16,

1872

1271

datetime_to_dbus, "LastApprovalRequest")

1873

1272

approved_by_default = notifychangeproperty(dbus.Boolean,

1874

1273

"ApprovedByDefault")

1875

approval_delay = notifychangeproperty(

1876

dbus.UInt64, "ApprovalDelay",

1877

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

1274

approval_delay = notifychangeproperty(dbus.UInt64,

1275

"ApprovalDelay",

1276

type_func =

1277

timedelta_to_milliseconds)

1878

1278

approval_duration = notifychangeproperty(

1879

1279

dbus.UInt64, "ApprovalDuration",

1880

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

1280

type_func = timedelta_to_milliseconds)

1881

1281

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

1882

timeout = notifychangeproperty(

1883

dbus.UInt64, "Timeout",

1884

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

1282

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

1283

type_func =

1284

timedelta_to_milliseconds)

1885

1285

extended_timeout = notifychangeproperty(

1886

1286

dbus.UInt64, "ExtendedTimeout",

1887

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

1888

interval = notifychangeproperty(

1889

dbus.UInt64, "Interval",

1890

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

1287

type_func = timedelta_to_milliseconds)

1288

interval = notifychangeproperty(dbus.UInt64,

1289

"Interval",

1290

type_func =

1291

timedelta_to_milliseconds)

1891

1292

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

1892

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

1893

invalidate_only=True)

1894

1293

1895

1294

del notifychangeproperty

1896

1295

1897

1296

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

1898

1297

try:

1899

1298

self.remove_from_connection()

1902

1301

if hasattr(DBusObjectWithProperties, "__del__"):

1903

1302

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

1904

1303

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

1905

1906

def checker_callback(self, source, condition,

1907

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

1908

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

1909

connection, command, *args,

1910

**kwargs)

1911

exitstatus = self.last_checker_status

1912

if exitstatus >= 0:

1304

1305

def checker_callback(self, pid, condition, command,

1306

*args, **kwargs):

1307

self.checker_callback_tag = None

1308

self.checker = None

1309

if os.WIFEXITED(condition):

1310

exitstatus = os.WEXITSTATUS(condition)

1913

1311

# Emit D-Bus signal

1914

1312

self.CheckerCompleted(dbus.Int16(exitstatus),

1915

# This is specific to GNU libC

1916

dbus.Int64(exitstatus << 8),

1313

dbus.Int64(condition),

1917

1314

dbus.String(command))

1918

1315

else:

1919

1316

# Emit D-Bus signal

1920

1317

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

1921

dbus.Int64(

1922

# This is specific to GNU libC

1923

(exitstatus << 8)

1924

| self.last_checker_signal),

1318

dbus.Int64(condition),

1925

1319

dbus.String(command))

1926

return ret

1927

1320

1321

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

1322

*args, **kwargs)

1323

1928

1324

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

1929

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

1325

old_checker = self.checker

1326

if self.checker is not None:

1327

old_checker_pid = self.checker.pid

1328

else:

1329

old_checker_pid = None

1930

1330

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

1931

1331

# Only if new checker process was started

1932

1332

if (self.checker is not None

1934

1334

# Emit D-Bus signal

1935

1335

self.CheckerStarted(self.current_checker_command)

1936

1336

return r

1937

1337

1938

1338

def _reset_approved(self):

1939

1339

self.approved = None

1940

1340

return False

1941

1341

1942

1342

def approve(self, value=True):

1943

1343

self.approved = value

1944

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

1945

* 1000), self._reset_approved)

1344

gobject.timeout_add(timedelta_to_milliseconds

1345

(self.approval_duration),

1346

self._reset_approved)

1946

1347

self.send_changedstate()

1947

1948

# D-Bus methods, signals & properties

1949

1950

# Interfaces

1951

1952

# Signals

1953

1348

1349

## D-Bus methods, signals & properties

1350

_interface = "se.recompile.Mandos.Client"

1351

1352

## Interfaces

1353

1354

@dbus_interface_annotations(_interface)

1355

def _foo(self):

1356

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

1357

"false"}

1358

1359

## Signals

1360

1954

1361

# CheckerCompleted - signal

1955

1362

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

1956

1363

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

1957

1364

"D-Bus signal"

1958

1365

pass

1959

1366

1960

1367

# CheckerStarted - signal

1961

1368

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

1962

1369

def CheckerStarted(self, command):

1963

1370

"D-Bus signal"

1964

1371

pass

1965

1372

1966

1373

# PropertyChanged - signal

1967

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

1968

1374

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

1969

1375

def PropertyChanged(self, property, value):

1970

1376

"D-Bus signal"

1971

1377

pass

1972

1378

1973

1379

# GotSecret - signal

1974

1380

@dbus.service.signal(_interface)

1975

1381

def GotSecret(self):

1978

1384

server to mandos-client

1979

1385

"""

1980

1386

pass

1981

1387

1982

1388

# Rejected - signal

1983

1389

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

1984

1390

def Rejected(self, reason):

1985

1391

"D-Bus signal"

1986

1392

pass

1987

1393

1988

1394

# NeedApproval - signal

1989

1395

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

1990

1396

def NeedApproval(self, timeout, default):

1991

1397

"D-Bus signal"

1992

1398

return self.need_approval()

1993

1994

# Methods

1995

1399

1400

## Methods

1401

1996

1402

# Approve - method

1997

1403

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

1998

1404

def Approve(self, value):

1999

1405

self.approve(value)

2000

1406

2001

1407

# CheckedOK - method

2002

1408

@dbus.service.method(_interface)

2003

1409

def CheckedOK(self):

2004

1410

self.checked_ok()

2005

1411

2006

1412

# Enable - method

2007

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

2008

1413

@dbus.service.method(_interface)

2009

1414

def Enable(self):

2010

1415

"D-Bus method"

2011

1416

self.enable()

2012

1417

2013

1418

# StartChecker - method

2014

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

2015

1419

@dbus.service.method(_interface)

2016

1420

def StartChecker(self):

2017

1421

"D-Bus method"

2018

1422

self.start_checker()

2019

1423

2020

1424

# Disable - method

2021

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

2022

1425

@dbus.service.method(_interface)

2023

1426

def Disable(self):

2024

1427

"D-Bus method"

2025

1428

self.disable()

2026

1429

2027

1430

# StopChecker - method

2028

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

2029

1431

@dbus.service.method(_interface)

2030

1432

def StopChecker(self):

2031

1433

self.stop_checker()

2032

2033

# Properties

2034

1434

1435

## Properties

1436

2035

1437

# ApprovalPending - property

2036

1438

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

2037

1439

def ApprovalPending_dbus_property(self):

2038

1440

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

2039

1441

2040

1442

# ApprovedByDefault - property

2041

@dbus_service_property(_interface,

2042

signature="b",

1443

@dbus_service_property(_interface, signature="b",

2043

1444

access="readwrite")

2044

1445

def ApprovedByDefault_dbus_property(self, value=None):

2045

1446

if value is None: # get

2046

1447

return dbus.Boolean(self.approved_by_default)

2047

1448

self.approved_by_default = bool(value)

2048

1449

2049

1450

# ApprovalDelay - property

2050

@dbus_service_property(_interface,

2051

signature="t",

1451

@dbus_service_property(_interface, signature="t",

2052

1452

access="readwrite")

2053

1453

def ApprovalDelay_dbus_property(self, value=None):

2054

1454

if value is None: # get

2055

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

2056

* 1000)

1455

return dbus.UInt64(self.approval_delay_milliseconds())

2057

1456

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

2058

1457

2059

1458

# ApprovalDuration - property

2060

@dbus_service_property(_interface,

2061

signature="t",

1459

@dbus_service_property(_interface, signature="t",

2062

1460

access="readwrite")

2063

1461

def ApprovalDuration_dbus_property(self, value=None):

2064

1462

if value is None: # get

2065

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

2066

* 1000)

1463

return dbus.UInt64(timedelta_to_milliseconds(

1464

self.approval_duration))

2067

1465

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

2068

1466

2069

1467

# Name - property

2070

@dbus_annotations(

2071

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

2072

1468

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

2073

1469

def Name_dbus_property(self):

2074

1470

return dbus.String(self.name)

2075

2076

# KeyID - property

2077

@dbus_annotations(

2078

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

2079

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

2080

def KeyID_dbus_property(self):

2081

return dbus.String(self.key_id)

2082

1471

2083

1472

# Fingerprint - property

2084

@dbus_annotations(

2085

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

2086

1473

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

2087

1474

def Fingerprint_dbus_property(self):

2088

1475

return dbus.String(self.fingerprint)

2089

1476

2090

1477

# Host - property

2091

@dbus_service_property(_interface,

2092

signature="s",

1478

@dbus_service_property(_interface, signature="s",

2093

1479

access="readwrite")

2094

1480

def Host_dbus_property(self, value=None):

2095

1481

if value is None: # get

2096

1482

return dbus.String(self.host)

2097

self.host = str(value)

2098

1483

self.host = unicode(value)

1484

2099

1485

# Created - property

2100

@dbus_annotations(

2101

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

2102

1486

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

2103

1487

def Created_dbus_property(self):

2104

1488

return datetime_to_dbus(self.created)

2105

1489

2106

1490

# LastEnabled - property

2107

1491

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

2108

1492

def LastEnabled_dbus_property(self):

2109

1493

return datetime_to_dbus(self.last_enabled)

2110

1494

2111

1495

# Enabled - property

2112

@dbus_service_property(_interface,

2113

signature="b",

1496

@dbus_service_property(_interface, signature="b",

2114

1497

access="readwrite")

2115

1498

def Enabled_dbus_property(self, value=None):

2116

1499

if value is None: # get

2119

1502

self.enable()

2120

1503

else:

2121

1504

self.disable()

2122

1505

2123

1506

# LastCheckedOK - property

2124

@dbus_service_property(_interface,

2125

signature="s",

1507

@dbus_service_property(_interface, signature="s",

2126

1508

access="readwrite")

2127

1509

def LastCheckedOK_dbus_property(self, value=None):

2128

1510

if value is not None:

2129

1511

self.checked_ok()

2130

1512

return

2131

1513

return datetime_to_dbus(self.last_checked_ok)

2132

1514

2133

1515

# LastCheckerStatus - property

2134

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

1516

@dbus_service_property(_interface, signature="n",

1517

access="read")

2135

1518

def LastCheckerStatus_dbus_property(self):

2136

1519

return dbus.Int16(self.last_checker_status)

2137

1520

2138

1521

# Expires - property

2139

1522

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

2140

1523

def Expires_dbus_property(self):

2141

1524

return datetime_to_dbus(self.expires)

2142

1525

2143

1526

# LastApprovalRequest - property

2144

1527

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

2145

1528

def LastApprovalRequest_dbus_property(self):

2146

1529

return datetime_to_dbus(self.last_approval_request)

2147

1530

2148

1531

# Timeout - property

2149

@dbus_service_property(_interface,

2150

signature="t",

1532

@dbus_service_property(_interface, signature="t",

2151

1533

access="readwrite")

2152

1534

def Timeout_dbus_property(self, value=None):

2153

1535

if value is None: # get

2154

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

1536

return dbus.UInt64(self.timeout_milliseconds())

2155

1537

old_timeout = self.timeout

2156

1538

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

2157

1539

# Reschedule disabling

2165

1547

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

2166

1548

is None):

2167

1549

return

2168

GLib.source_remove(self.disable_initiator_tag)

2169

self.disable_initiator_tag = GLib.timeout_add(

2170

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

2171

self.disable)

2172

1550

gobject.source_remove(self.disable_initiator_tag)

1551

self.disable_initiator_tag = (

1552

gobject.timeout_add(

1553

timedelta_to_milliseconds(self.expires - now),

1554

self.disable))

1555

2173

1556

# ExtendedTimeout - property

2174

@dbus_service_property(_interface,

2175

signature="t",

1557

@dbus_service_property(_interface, signature="t",

2176

1558

access="readwrite")

2177

1559

def ExtendedTimeout_dbus_property(self, value=None):

2178

1560

if value is None: # get

2179

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

2180

* 1000)

1561

return dbus.UInt64(self.extended_timeout_milliseconds())

2181

1562

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

2182

1563

2183

1564

# Interval - property

2184

@dbus_service_property(_interface,

2185

signature="t",

1565

@dbus_service_property(_interface, signature="t",

2186

1566

access="readwrite")

2187

1567

def Interval_dbus_property(self, value=None):

2188

1568

if value is None: # get

2189

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

1569

return dbus.UInt64(self.interval_milliseconds())

2190

1570

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

2191

1571

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

2192

1572

return

2193

1573

if self.enabled:

2194

1574

# Reschedule checker run

2195

GLib.source_remove(self.checker_initiator_tag)

2196

self.checker_initiator_tag = GLib.timeout_add(

2197

value, self.start_checker)

2198

self.start_checker() # Start one now, too

2199

1575

gobject.source_remove(self.checker_initiator_tag)

1576

self.checker_initiator_tag = (gobject.timeout_add

1577

(value, self.start_checker))

1578

self.start_checker() # Start one now, too

1579

2200

1580

# Checker - property

2201

@dbus_service_property(_interface,

2202

signature="s",

1581

@dbus_service_property(_interface, signature="s",

2203

1582

access="readwrite")

2204

1583

def Checker_dbus_property(self, value=None):

2205

1584

if value is None: # get

2206

1585

return dbus.String(self.checker_command)

2207

self.checker_command = str(value)

2208

1586

self.checker_command = unicode(value)

1587

2209

1588

# CheckerRunning - property

2210

@dbus_service_property(_interface,

2211

signature="b",

1589

@dbus_service_property(_interface, signature="b",

2212

1590

access="readwrite")

2213

1591

def CheckerRunning_dbus_property(self, value=None):

2214

1592

if value is None: # get

2217

1595

self.start_checker()

2218

1596

else:

2219

1597

self.stop_checker()

2220

1598

2221

1599

# ObjectPath - property

2222

@dbus_annotations(

2223

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

2224

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

2225

1600

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

2226

1601

def ObjectPath_dbus_property(self):

2227

return self.dbus_object_path # is already a dbus.ObjectPath

2228

1602

return self.dbus_object_path # is already a dbus.ObjectPath

1603

2229

1604

# Secret = property

2230

@dbus_annotations(

2231

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

2232

"invalidates"})

2233

@dbus_service_property(_interface,

2234

signature="ay",

2235

access="write",

2236

byte_arrays=True)

1605

@dbus_service_property(_interface, signature="ay",

1606

access="write", byte_arrays=True)

2237

1607

def Secret_dbus_property(self, value):

2238

self.secret = bytes(value)

2239

1608

self.secret = str(value)

1609

2240

1610

del _interface

2241

1611

2242

1612

2243

class ProxyClient:

2244

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

1613

class ProxyClient(object):

1614

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

2245

1615

self._pipe = child_pipe

2246

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

1616

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

2247

1617

if not self._pipe.recv():

2248

raise KeyError(key_id or fpr)

2249

1618

raise KeyError()

1619

2250

1620

def __getattribute__(self, name):

2251

1621

if name == '_pipe':

2252

1622

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

2255

1625

if data[0] == 'data':

2256

1626

return data[1]

2257

1627

if data[0] == 'function':

2258

2259

1628

def func(*args, **kwargs):

2260

1629

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

2261

1630

return self._pipe.recv()[1]

2262

2263

1631

return func

2264

1632

2265

1633

def __setattr__(self, name, value):

2266

1634

if name == '_pipe':

2267

1635

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

2270

1638

2271

1639

class ClientHandler(socketserver.BaseRequestHandler, object):

2272

1640

"""A class to handle client connections.

2273

1641

2274

1642

Instantiated once for each connection to handle it.

2275

1643

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

2276

1644

2277

1645

def handle(self):

2278

1646

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

2279

1647

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

2280

str(self.client_address))

1648

unicode(self.client_address))

2281

1649

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

2282

1650

self.server.child_pipe.fileno())

2283

2284

session = gnutls.ClientSession(self.request)

2285

2286

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

2287

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

2288

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

2289

# "+DHE-DSS"))

1651

1652

session = (gnutls.connection

1653

.ClientSession(self.request,

1654

gnutls.connection

1655

.X509Credentials()))

1656

1657

# Note: gnutls.connection.X509Credentials is really a

1658

# generic GnuTLS certificate credentials object so long as

1659

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

1660

# here despite using OpenPGP certificates.

1661

1662

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

1663

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

1664

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

1665

# "+DHE-DSS"))

2290

1666

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

2291

1667

priority = self.server.gnutls_priority

2292

1668

if priority is None:

2293

1669

priority = "NORMAL"

2294

gnutls.priority_set_direct(session._c_object,

2295

priority.encode("utf-8"),

2296

None)

2297

1670

(gnutls.library.functions

1671

.gnutls_priority_set_direct(session._c_object,

1672

priority, None))

1673

2298

1674

# Start communication using the Mandos protocol

2299

1675

# Get protocol number

2300

1676

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

2301

1677

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

2302

1678

try:

2303

1679

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

2304

raise RuntimeError(line)

1680

raise RuntimeError

2305

1681

except (ValueError, IndexError, RuntimeError) as error:

2306

1682

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

2307

1683

return

2308

1684

2309

1685

# Start GnuTLS connection

2310

1686

try:

2311

1687

session.handshake()

2312

except gnutls.Error as error:

1688

except gnutls.errors.GNUTLSError as error:

2313

1689

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

2314

1690

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

2315

1691

# established. Just abandon the request.

2316

1692

return

2317

1693

logger.debug("Handshake succeeded")

2318

1694

2319

1695

approval_required = False

2320

1696

try:

2321

if gnutls.has_rawpk:

2322

fpr = b""

2323

try:

2324

key_id = self.key_id(

2325

self.peer_certificate(session))

2326

except (TypeError, gnutls.Error) as error:

2327

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

2328

return

2329

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

2330

2331

else:

2332

key_id = b""

2333

try:

2334

fpr = self.fingerprint(

2335

self.peer_certificate(session))

2336

except (TypeError, gnutls.Error) as error:

2337

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

2338

return

2339

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

2340

2341

try:

2342

client = ProxyClient(child_pipe, key_id, fpr,

1697

try:

1698

fpr = self.fingerprint(self.peer_certificate

1699

(session))

1700

except (TypeError,

1701

gnutls.errors.GNUTLSError) as error:

1702

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

1703

return

1704

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

1705

1706

try:

1707

client = ProxyClient(child_pipe, fpr,

2343

1708

self.client_address)

2344

1709

except KeyError:

2345

1710

return

2346

1711

2347

1712

if client.approval_delay:

2348

1713

delay = client.approval_delay

2349

1714

client.approvals_pending += 1

2350

1715

approval_required = True

2351

1716

2352

1717

while True:

2353

1718

if not client.enabled:

2354

1719

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

2355

client.name)

1720

client.name)

2356

1721

if self.server.use_dbus:

2357

1722

# Emit D-Bus signal

2358

1723

client.Rejected("Disabled")

2359

1724

return

2360

1725

2361

1726

if client.approved or not client.approval_delay:

2362

# We are approved or approval is disabled

1727

#We are approved or approval is disabled

2363

1728

break

2364

1729

elif client.approved is None:

2365

1730

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

2367

1732

if self.server.use_dbus:

2368

1733

# Emit D-Bus signal

2369

1734

client.NeedApproval(

2370

client.approval_delay.total_seconds()

2371

* 1000, client.approved_by_default)

1735

client.approval_delay_milliseconds(),

1736

client.approved_by_default)

2372

1737

else:

2373

1738

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

2374

1739

client.name)

2376

1741

# Emit D-Bus signal

2377

1742

client.Rejected("Denied")

2378

1743

return

2379

2380

# wait until timeout or approved

1744

1745

#wait until timeout or approved

2381

1746

time = datetime.datetime.now()

2382

1747

client.changedstate.acquire()

2383

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

1748

client.changedstate.wait(

1749

float(timedelta_to_milliseconds(delay)

1750

/ 1000))

2384

1751

client.changedstate.release()

2385

1752

time2 = datetime.datetime.now()

2386

1753

if (time2 - time) >= delay:

2396

1763

break

2397

1764

else:

2398

1765

delay -= time2 - time

2399

2400

try:

2401

session.send(client.secret)

2402

except gnutls.Error as error:

2403

logger.warning("gnutls send failed",

2404

exc_info=error)

2405

return

2406

1766

1767

sent_size = 0

1768

while sent_size < len(client.secret):

1769

try:

1770

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

1771

except gnutls.errors.GNUTLSError as error:

1772

logger.warning("gnutls send failed",

1773

exc_info=error)

1774

return

1775

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

1776

sent, len(client.secret)

1777

- (sent_size + sent))

1778

sent_size += sent

1779

2407

1780

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

2408

1781

# bump the timeout using extended_timeout

2409

1782

client.bump_timeout(client.extended_timeout)

2410

1783

if self.server.use_dbus:

2411

1784

# Emit D-Bus signal

2412

1785

client.GotSecret()

2413

1786

2414

1787

finally:

2415

1788

if approval_required:

2416

1789

client.approvals_pending -= 1

2417

1790

try:

2418

1791

session.bye()

2419

except gnutls.Error as error:

1792

except gnutls.errors.GNUTLSError as error:

2420

1793

logger.warning("GnuTLS bye failed",

2421

1794

exc_info=error)

2422

1795

2423

1796

@staticmethod

2424

1797

def peer_certificate(session):

2425

"Return the peer's certificate as a bytestring"

2426

try:

2427

cert_type = gnutls.certificate_type_get2(session._c_object,

2428

gnutls.CTYPE_PEERS)

2429

except AttributeError:

2430

cert_type = gnutls.certificate_type_get(session._c_object)

2431

if gnutls.has_rawpk:

2432

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2433

else:

2434

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2435

# If not a valid certificate type...

2436

if cert_type not in valid_cert_types:

2437

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

2438

valid_cert_types)

2439

# ...return invalid data

2440

return b""

1798

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

1799

# If not an OpenPGP certificate...

1800

if (gnutls.library.functions

1801

.gnutls_certificate_type_get(session._c_object)

1802

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1803

# ...do the normal thing

1804

return session.peer_certificate

2441

1805

list_size = ctypes.c_uint(1)

2442

cert_list = (gnutls.certificate_get_peers

1806

cert_list = (gnutls.library.functions

1807

.gnutls_certificate_get_peers

2443

1808

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

2444

1809

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

2445

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

1810

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

1811

" certificate")

2446

1812

if list_size.value == 0:

2447

1813

return None

2448

1814

cert = cert_list[0]

2449

1815

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

2450

2451

@staticmethod

2452

def key_id(certificate):

2453

"Convert a certificate bytestring to a hexdigit key ID"

2454

# New GnuTLS "datum" with the public key

2455

datum = gnutls.datum_t(

2456

ctypes.cast(ctypes.c_char_p(certificate),

2457

ctypes.POINTER(ctypes.c_ubyte)),

2458

ctypes.c_uint(len(certificate)))

2459

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

2460

# New empty GnuTLS certificate

2461

pubkey = gnutls.pubkey_t()

2462

gnutls.pubkey_init(ctypes.byref(pubkey))

2463

# Import the raw public key into the certificate

2464

gnutls.pubkey_import(pubkey,

2465

ctypes.byref(datum),

2466

gnutls.X509_FMT_DER)

2467

# New buffer for the key ID

2468

buf = ctypes.create_string_buffer(32)

2469

buf_len = ctypes.c_size_t(len(buf))

2470

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

2471

gnutls.pubkey_get_key_id(pubkey,

2472

gnutls.KEYID_USE_SHA256,

2473

ctypes.cast(ctypes.byref(buf),

2474

ctypes.POINTER(ctypes.c_ubyte)),

2475

ctypes.byref(buf_len))

2476

# Deinit the certificate

2477

gnutls.pubkey_deinit(pubkey)

2478

2479

# Convert the buffer to a Python bytestring

2480

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

2481

# Convert the bytestring to hexadecimal notation

2482

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

2483

return hex_key_id

2484

1816

2485

1817

@staticmethod

2486

1818

def fingerprint(openpgp):

2487

1819

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2488

1820

# New GnuTLS "datum" with the OpenPGP public key

2489

datum = gnutls.datum_t(

2490

ctypes.cast(ctypes.c_char_p(openpgp),

2491

ctypes.POINTER(ctypes.c_ubyte)),

2492

ctypes.c_uint(len(openpgp)))

1821

datum = (gnutls.library.types

1822

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

1823

ctypes.POINTER

1824

(ctypes.c_ubyte)),

1825

ctypes.c_uint(len(openpgp))))

2493

1826

# New empty GnuTLS certificate

2494

crt = gnutls.openpgp_crt_t()

2495

gnutls.openpgp_crt_init(ctypes.byref(crt))

1827

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1828

(gnutls.library.functions

1829

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2496

1830

# Import the OpenPGP public key into the certificate

2497

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

2498

gnutls.OPENPGP_FMT_RAW)

1831

(gnutls.library.functions

1832

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

1833

gnutls.library.constants

1834

.GNUTLS_OPENPGP_FMT_RAW))

2499

1835

# Verify the self signature in the key

2500

1836

crtverify = ctypes.c_uint()

2501

gnutls.openpgp_crt_verify_self(crt, 0,

2502

ctypes.byref(crtverify))

1837

(gnutls.library.functions

1838

.gnutls_openpgp_crt_verify_self(crt, 0,

1839

ctypes.byref(crtverify)))

2503

1840

if crtverify.value != 0:

2504

gnutls.openpgp_crt_deinit(crt)

2505

raise gnutls.CertificateSecurityError(code

2506

=crtverify.value)

1841

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1842

raise (gnutls.errors.CertificateSecurityError

1843

("Verify failed"))

2507

1844

# New buffer for the fingerprint

2508

1845

buf = ctypes.create_string_buffer(20)

2509

1846

buf_len = ctypes.c_size_t()

2510

1847

# Get the fingerprint from the certificate into the buffer

2511

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

2512

ctypes.byref(buf_len))

1848

(gnutls.library.functions

1849

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

1850

ctypes.byref(buf_len)))

2513

1851

# Deinit the certificate

2514

gnutls.openpgp_crt_deinit(crt)

1852

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2515

1853

# Convert the buffer to a Python bytestring

2516

1854

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

2517

1855

# Convert the bytestring to hexadecimal notation

2519

1857

return hex_fpr

2520

1858

2521

1859

2522

class MultiprocessingMixIn:

1860

class MultiprocessingMixIn(object):

2523

1861

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

2524

2525

1862

def sub_process_main(self, request, address):

2526

1863

try:

2527

1864

self.finish_request(request, address)

2528

1865

except Exception:

2529

1866

self.handle_error(request, address)

2530

1867

self.close_request(request)

2531

1868

2532

1869

def process_request(self, request, address):

2533

1870

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

2534

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

2535

args=(request, address))

1871

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

1872

args = (request, address))

2536

1873

proc.start()

2537

1874

return proc

2538

1875

2539

1876

2540

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1877

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2541

1878

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

2542

2543

1879

def process_request(self, request, client_address):

2544

1880

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

2545

1881

2546

1882

This function creates a new pipe in self.pipe

2547

1883

"""

2548

1884

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2549

1885

2550

1886

proc = MultiprocessingMixIn.process_request(self, request,

2551

1887

client_address)

2552

1888

self.child_pipe.close()

2553

1889

self.add_pipe(parent_pipe, proc)

2554

1890

2555

1891

def add_pipe(self, parent_pipe, proc):

2556

1892

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

2557

raise NotImplementedError()

1893

raise NotImplementedError

2558

1894

2559

1895

2560

1896

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2561

socketserver.TCPServer):

1897

socketserver.TCPServer, object):

2562

1898

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

2563

1899

2564

1900

Attributes:

2565

1901

enabled: Boolean; whether this server is activated yet

2566

1902

interface: None or a network interface name (string)

2567

1903

use_ipv6: Boolean; to use IPv6 or not

2568

1904

"""

2569

2570

1905

def __init__(self, server_address, RequestHandlerClass,

2571

interface=None,

2572

use_ipv6=True,

2573

socketfd=None):

2574

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

2575

creating a new one with socket.socket().

2576

"""

1906

interface=None, use_ipv6=True):

2577

1907

self.interface = interface

2578

1908

if use_ipv6:

2579

1909

self.address_family = socket.AF_INET6

2580

if socketfd is not None:

2581

# Save the file descriptor

2582

self.socketfd = socketfd

2583

# Save the original socket.socket() function

2584

self.socket_socket = socket.socket

2585

2586

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

2587

#

2588

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

2589

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

2590

# patching socket.socket.)

2591

#

2592

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

2593

@functools.wraps(socket.socket)

2594

def socket_wrapper(*args, **kwargs):

2595

# Restore original function so subsequent calls are

2596

# not affected.

2597

socket.socket = self.socket_socket

2598

del self.socket_socket

2599

# This time only, return a new socket object from the

2600

# saved file descriptor.

2601

return socket.fromfd(self.socketfd, *args, **kwargs)

2602

# Replace socket.socket() function with wrapper

2603

socket.socket = socket_wrapper

2604

# The socketserver.TCPServer.__init__ will call

2605

# socket.socket(), which might be our replacement,

2606

# socket_wrapper(), if socketfd was set.

2607

1910

socketserver.TCPServer.__init__(self, server_address,

2608

1911

RequestHandlerClass)

2609

2610

1912

def server_bind(self):

2611

1913

"""This overrides the normal server_bind() function

2612

1914

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

2613

1915

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

2614

global SO_BINDTODEVICE

2615

1916

if self.interface is not None:

2616

1917

if SO_BINDTODEVICE is None:

2617

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

2618

# common enough.

2619

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

2620

SO_BINDTODEVICE = 25

2621

try:

2622

self.socket.setsockopt(

2623

socket.SOL_SOCKET, SO_BINDTODEVICE,

2624

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

2625

except socket.error as error:

2626

if error.errno == errno.EPERM:

2627

logger.error("No permission to bind to"

2628

" interface %s", self.interface)

2629

elif error.errno == errno.ENOPROTOOPT:

2630

logger.error("SO_BINDTODEVICE not available;"

2631

" cannot bind to interface %s",

2632

self.interface)

2633

elif error.errno == errno.ENODEV:

2634

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

2635

" cannot bind", self.interface)

2636

else:

2637

raise

1918

logger.error("SO_BINDTODEVICE does not exist;"

1919

" cannot bind to interface %s",

1920

self.interface)

1921

else:

1922

try:

1923

self.socket.setsockopt(socket.SOL_SOCKET,

1924

SO_BINDTODEVICE,

1925

str(self.interface

1926

+ '\0'))

1927

except socket.error as error:

1928

if error[0] == errno.EPERM:

1929

logger.error("No permission to"

1930

" bind to interface %s",

1931

self.interface)

1932

elif error[0] == errno.ENOPROTOOPT:

1933

logger.error("SO_BINDTODEVICE not available;"

1934

" cannot bind to interface %s",

1935

self.interface)

1936

else:

1937

raise

2638

1938

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

2639

1939

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

2640

if self.server_address[1]:

2641

self.allow_reuse_address = True

2642

1940

if not self.server_address[0]:

2643

1941

if self.address_family == socket.AF_INET6:

2644

any_address = "::" # in6addr_any

1942

any_address = "::" # in6addr_any

2645

1943

else:

2646

any_address = "0.0.0.0" # INADDR_ANY

1944

any_address = socket.INADDR_ANY

2647

1945

self.server_address = (any_address,

2648

1946

self.server_address[1])

2649

1947

elif not self.server_address[1]:

2650

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

1948

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

1949

0)

2651

1950

# if self.interface:

2652

1951

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

2653

1952

# 0, # port

2659

1958

2660

1959

class MandosServer(IPv6_TCPServer):

2661

1960

"""Mandos server.

2662

1961

2663

1962

Attributes:

2664

1963

clients: set of Client objects

2665

1964

gnutls_priority GnuTLS priority string

2666

1965

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

2667

2668

Assumes a GLib.MainLoop event loop.

1966

1967

Assumes a gobject.MainLoop event loop.

2669

1968

"""

2670

2671

1969

def __init__(self, server_address, RequestHandlerClass,

2672

interface=None,

2673

use_ipv6=True,

2674

clients=None,

2675

gnutls_priority=None,

2676

use_dbus=True,

2677

socketfd=None):

1970

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

1971

gnutls_priority=None, use_dbus=True):

2678

1972

self.enabled = False

2679

1973

self.clients = clients

2680

1974

if self.clients is None:

2683

1977

self.gnutls_priority = gnutls_priority

2684

1978

IPv6_TCPServer.__init__(self, server_address,

2685

1979

RequestHandlerClass,

2686

interface=interface,

2687

use_ipv6=use_ipv6,

2688

socketfd=socketfd)

2689

1980

interface = interface,

1981

use_ipv6 = use_ipv6)

2690

1982

def server_activate(self):

2691

1983

if self.enabled:

2692

1984

return socketserver.TCPServer.server_activate(self)

2693

1985

2694

1986

def enable(self):

2695

1987

self.enabled = True

2696

1988

2697

1989

def add_pipe(self, parent_pipe, proc):

2698

1990

# Call "handle_ipc" for both data and EOF events

2699

GLib.io_add_watch(

2700

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

2701

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

2702

functools.partial(self.handle_ipc,

2703

parent_pipe=parent_pipe,

2704

proc=proc))

2705

2706

def handle_ipc(self, source, condition,

2707

parent_pipe=None,

2708

proc=None,

2709

client_object=None):

1991

gobject.io_add_watch(parent_pipe.fileno(),

1992

gobject.IO_IN | gobject.IO_HUP,

1993

functools.partial(self.handle_ipc,

1994

parent_pipe =

1995

parent_pipe,

1996

proc = proc))

1997

1998

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

1999

proc = None, client_object=None):

2710

2000

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

2711

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

2001

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

2712

2002

# Wait for other process to exit

2713

2003

proc.join()

2714

2004

return False

2715

2005

2716

2006

# Read a request from the child

2717

2007

request = parent_pipe.recv()

2718

2008

command = request[0]

2719

2009

2720

2010

if command == 'init':

2721

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

2722

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

2723

address = request[3]

2724

2725

for c in self.clients.values():

2726

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2727

continue

2728

if key_id and c.key_id == key_id:

2729

client = c

2730

break

2731

if fpr and c.fingerprint == fpr:

2011

fpr = request[1]

2012

address = request[2]

2013

2014

for c in self.clients.itervalues():

2015

if c.fingerprint == fpr:

2732

2016

client = c

2733

2017

break

2734

2018

else:

2735

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

2736

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

2019

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

2020

"dress: %s", fpr, address)

2737

2021

if self.use_dbus:

2738

2022

# Emit D-Bus signal

2739

mandos_dbus_service.ClientNotFound(key_id or fpr,

2023

mandos_dbus_service.ClientNotFound(fpr,

2740

2024

address[0])

2741

2025

parent_pipe.send(False)

2742

2026

return False

2743

2744

GLib.io_add_watch(

2745

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

2746

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

2747

functools.partial(self.handle_ipc,

2748

parent_pipe=parent_pipe,

2749

proc=proc,

2750

client_object=client))

2027

2028

gobject.io_add_watch(parent_pipe.fileno(),

2029

gobject.IO_IN | gobject.IO_HUP,

2030

functools.partial(self.handle_ipc,

2031

parent_pipe =

2032

parent_pipe,

2033

proc = proc,

2034

client_object =

2035

client))

2751

2036

parent_pipe.send(True)

2752

2037

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

2753

2038

# same fileno

2756

2041

funcname = request[1]

2757

2042

args = request[2]

2758

2043

kwargs = request[3]

2759

2044

2760

2045

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

2761

2046

funcname)(*args,

2762

**kwargs)))

2763

2047

**kwargs)))

2048

2764

2049

if command == 'getattr':

2765

2050

attrname = request[1]

2766

if isinstance(client_object.__getattribute__(attrname),

2767

collections.abc.Callable):

2768

parent_pipe.send(('function', ))

2051

if callable(client_object.__getattribute__(attrname)):

2052

parent_pipe.send(('function',))

2769

2053

else:

2770

parent_pipe.send((

2771

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

2772

2054

parent_pipe.send(('data', client_object

2055

.__getattribute__(attrname)))

2056

2773

2057

if command == 'setattr':

2774

2058

attrname = request[1]

2775

2059

value = request[2]

2776

2060

setattr(client_object, attrname, value)

2777

2061

2778

2062

return True

2779

2063

2780

2064

2781

def rfc3339_duration_to_delta(duration):

2782

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

2783

2784

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

2785

True

2786

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

2787

True

2788

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

2789

True

2790

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

2791

True

2792

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

2793

True

2794

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

2795

True

2796

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

2797

True

2798

"""

2799

2800

# Parsing an RFC 3339 duration with regular expressions is not

2801

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

2802

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

2803

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

2804

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

2805

# avoid excessive use of external libraries.

2806

2807

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

2808

Token = collections.namedtuple("Token", (

2809

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

2810

# a "group" containing digits

2811

"value", # datetime.timedelta or None

2812

"followers")) # Tokens valid after this token

2813

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

2814

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

2815

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

2816

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

2817

datetime.timedelta(seconds=1),

2818

frozenset((token_end, )))

2819

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

2820

datetime.timedelta(minutes=1),

2821

frozenset((token_second, token_end)))

2822

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

2823

datetime.timedelta(hours=1),

2824

frozenset((token_minute, token_end)))

2825

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

2826

None,

2827

frozenset((token_hour, token_minute,

2828

token_second)))

2829

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

2830

datetime.timedelta(days=1),

2831

frozenset((token_time, token_end)))

2832

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

2833

datetime.timedelta(weeks=4),

2834

frozenset((token_day, token_end)))

2835

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

2836

datetime.timedelta(weeks=52),

2837

frozenset((token_month, token_end)))

2838

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

2839

datetime.timedelta(weeks=1),

2840

frozenset((token_end, )))

2841

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

2842

frozenset((token_year, token_month,

2843

token_day, token_time,

2844

token_week)))

2845

# Define starting values:

2846

# Value so far

2847

value = datetime.timedelta()

2848

found_token = None

2849

# Following valid tokens

2850

followers = frozenset((token_duration, ))

2851

# String left to parse

2852

s = duration

2853

# Loop until end token is found

2854

while found_token is not token_end:

2855

# Search for any currently valid tokens

2856

for token in followers:

2857

match = token.regexp.match(s)

2858

if match is not None:

2859

# Token found

2860

if token.value is not None:

2861

# Value found, parse digits

2862

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

2863

# Add to value so far

2864

value += factor * token.value

2865

# Strip token from string

2866

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

2867

# Go to found token

2868

found_token = token

2869

# Set valid next tokens

2870

followers = found_token.followers

2871

break

2872

else:

2873

# No currently valid tokens were found

2874

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

2875

.format(duration))

2876

# End token found

2877

return value

2878

2879

2880

2065

def string_to_delta(interval):

2881

2066

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

2882

2883

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

2884

True

2885

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

2886

True

2887

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

2888

True

2889

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

2890

True

2891

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

2892

True

2893

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

2894

True

2067

2068

>>> string_to_delta('7d')

2069

datetime.timedelta(7)

2070

>>> string_to_delta('60s')

2071

datetime.timedelta(0, 60)

2072

>>> string_to_delta('60m')

2073

datetime.timedelta(0, 3600)

2074

>>> string_to_delta('24h')

2075

datetime.timedelta(1)

2076

>>> string_to_delta('1w')

2077

datetime.timedelta(7)

2078

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

2079

datetime.timedelta(0, 330)

2895

2080

"""

2896

2897

try:

2898

return rfc3339_duration_to_delta(interval)

2899

except ValueError:

2900

pass

2901

2902

2081

timevalue = datetime.timedelta(0)

2903

2082

for s in interval.split():

2904

2083

try:

2905

suffix = s[-1]

2084

suffix = unicode(s[-1])

2906

2085

value = int(s[:-1])

2907

2086

if suffix == "d":

2908

2087

delta = datetime.timedelta(value)

2915

2094

elif suffix == "w":

2916

2095

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

2917

2096

else:

2918

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

2919

except IndexError as e:

2097

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

2098

.format(suffix))

2099

except (ValueError, IndexError) as e:

2920

2100

raise ValueError(*(e.args))

2921

2101

timevalue += delta

2922

2102

return timevalue

2923

2103

2924

2104

2925

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

2105

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

2926

2106

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

2927

2107

2928

2108

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

2929

2109

if os.fork():

2930

2110

sys.exit()

2938

2118

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

2939

2119

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

2940

2120

raise OSError(errno.ENODEV,

2941

"{} not a character device"

2121

"{0} not a character device"

2942

2122

.format(os.devnull))

2943

2123

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

2944

2124

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

2948

2128

2949

2129

2950

2130

def main():

2951

2131

2952

2132

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

2953

2133

# Parsing of options, both command line and config file

2954

2134

2955

2135

parser = argparse.ArgumentParser()

2956

2136

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

2957

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

2137

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

2958

2138

help="show version number and exit")

2959

2139

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

2960

2140

help="Bind to interface IF")

2966

2146

help="Run self-test")

2967

2147

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

2968

2148

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

2969

" to terminal", default=None)

2149

" to terminal")

2970

2150

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

2971

2151

help="Debug level for stdout output")

2972

2152

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

2979

2159

" files")

2980

2160

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

2981

2161

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

2982

" system bus interface", default=None)

2162

" system bus interface")

2983

2163

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

2984

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

2985

default=None)

2164

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

2986

2165

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

2987

2166

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

2988

" state", default=None)

2989

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

2990

help="Specify a file descriptor to a network"

2991

" socket to use instead of creating one")

2167

" state")

2992

2168

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

2993

2169

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

2994

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

2995

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

2996

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

2997

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

2998

default=None)

2999

2170

3000

2171

options = parser.parse_args()

3001

2172

2173

if options.check:

2174

import doctest

2175

doctest.testmod()

2176

sys.exit()

2177

3002

2178

# Default values for config file for server-global settings

3003

if gnutls.has_rawpk:

3004

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

3005

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

3006

else:

3007

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

3008

":+SIGN-DSA-SHA256")

3009

server_defaults = {"interface": "",

3010

"address": "",

3011

"port": "",

3012

"debug": "False",

3013

"priority": priority,

3014

"servicename": "Mandos",

3015

"use_dbus": "True",

3016

"use_ipv6": "True",

3017

"debuglevel": "",

3018

"restore": "True",

3019

"socket": "",

3020

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

3021

"foreground": "False",

3022

"zeroconf": "True",

3023

}

3024

del priority

3025

2179

server_defaults = { "interface": "",

2180

"address": "",

2181

"port": "",

2182

"debug": "False",

2183

"priority":

2184

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

2185

"servicename": "Mandos",

2186

"use_dbus": "True",

2187

"use_ipv6": "True",

2188

"debuglevel": "",

2189

"restore": "True",

2190

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

2191

}

2192

3026

2193

# Parse config file for server-global settings

3027

server_config = configparser.ConfigParser(server_defaults)

2194

server_config = configparser.SafeConfigParser(server_defaults)

3028

2195

del server_defaults

3029

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

3030

# Convert the ConfigParser object to a dict

2196

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

2197

"mandos.conf"))

2198

# Convert the SafeConfigParser object to a dict

3031

2199

server_settings = server_config.defaults()

3032

2200

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

3033

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

3034

"foreground", "zeroconf"):

2201

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

3035

2202

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

3036

2203

option)

3037

2204

if server_settings["port"]:

3038

2205

server_settings["port"] = server_config.getint("DEFAULT",

3039

2206

"port")

3040

if server_settings["socket"]:

3041

server_settings["socket"] = server_config.getint("DEFAULT",

3042

"socket")

3043

# Later, stdin will, and stdout and stderr might, be dup'ed

3044

# over with an opened os.devnull. But we don't want this to

3045

# happen with a supplied network socket.

3046

if 0 <= server_settings["socket"] <= 2:

3047

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

3048

["socket"])

3049

2207

del server_config

3050

2208

3051

2209

# Override the settings from the config file with command line

3052

2210

# options, if set.

3053

2211

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

3054

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

3055

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

3056

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

2212

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

2213

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

2214

"statedir"):

3057

2215

value = getattr(options, option)

3058

2216

if value is not None:

3059

2217

server_settings[option] = value

3060

2218

del options

3061

2219

# Force all strings to be unicode

3062

2220

for option in server_settings.keys():

3063

if isinstance(server_settings[option], bytes):

3064

server_settings[option] = (server_settings[option]

3065

.decode("utf-8"))

3066

# Force all boolean options to be boolean

3067

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

3068

"foreground", "zeroconf"):

3069

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

3070

# Debug implies foreground

3071

if server_settings["debug"]:

3072

server_settings["foreground"] = True

2221

if type(server_settings[option]) is str:

2222

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

3073

2223

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

3074

2224

3075

2225

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

3076

3077

if (not server_settings["zeroconf"]

3078

and not (server_settings["port"]

3079

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

3080

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

3081

2226

3082

2227

# For convenience

3083

2228

debug = server_settings["debug"]

3084

2229

debuglevel = server_settings["debuglevel"]

3086

2231

use_ipv6 = server_settings["use_ipv6"]

3087

2232

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

3088

2233

stored_state_file)

3089

foreground = server_settings["foreground"]

3090

zeroconf = server_settings["zeroconf"]

3091

2234

3092

2235

if debug:

3093

2236

initlogger(debug, logging.DEBUG)

3094

2237

else:

3097

2240

else:

3098

2241

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

3099

2242

initlogger(debug, level)

3100

2243

3101

2244

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

3102

syslogger.setFormatter(

3103

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

3104

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

3105

server_settings["servicename"])))

3106

2245

syslogger.setFormatter(logging.Formatter

2246

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

2247

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

2248

.format(server_settings

2249

["servicename"])))

2250

3107

2251

# Parse config file with clients

3108

client_config = configparser.ConfigParser(Client.client_defaults)

2252

client_config = configparser.SafeConfigParser(Client

2253

.client_defaults)

3109

2254

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

3110

2255

"clients.conf"))

3111

2256

3112

2257

global mandos_dbus_service

3113

2258

mandos_dbus_service = None

3114

3115

socketfd = None

3116

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

3117

socketfd = server_settings["socket"]

3118

tcp_server = MandosServer(

3119

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

3120

ClientHandler,

3121

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

3122

use_ipv6=use_ipv6,

3123

gnutls_priority=server_settings["priority"],

3124

use_dbus=use_dbus,

3125

socketfd=socketfd)

3126

if not foreground:

3127

pidfilename = "/run/mandos.pid"

3128

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

3129

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

3130

pidfile = None

2259

2260

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

2261

server_settings["port"]),

2262

ClientHandler,

2263

interface=(server_settings["interface"]

2264

or None),

2265

use_ipv6=use_ipv6,

2266

gnutls_priority=

2267

server_settings["priority"],

2268

use_dbus=use_dbus)

2269

if not debug:

2270

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

3131

2271

try:

3132

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

2272

pidfile = open(pidfilename, "w")

3133

2273

except IOError as e:

3134

2274

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

3135

2275

exc_info=e)

3136

3137

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

3138

("mandos", "mandos"),

3139

("nobody", "nogroup")):

2276

2277

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

3140

2278

try:

3141

2279

uid = pwd.getpwnam(name).pw_uid

3142

gid = pwd.getpwnam(group).pw_gid

2280

gid = pwd.getpwnam(name).pw_gid

3143

2281

break

3144

2282

except KeyError:

3145

2283

continue

3149

2287

try:

3150

2288

os.setgid(gid)

3151

2289

os.setuid(uid)

3152

if debug:

3153

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

3154

gid))

3155

2290

except OSError as error:

3156

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

3157

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

3158

if error.errno != errno.EPERM:

3159

raise

3160

2291

if error[0] != errno.EPERM:

2292

raise error

2293

3161

2294

if debug:

3162

2295

# Enable all possible GnuTLS debugging

3163

2296

3164

2297

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

3165

2298

# - GnuTLS manual

3166

gnutls.global_set_log_level(11)

3167

3168

@gnutls.log_func

2299

gnutls.library.functions.gnutls_global_set_log_level(11)

2300

2301

@gnutls.library.types.gnutls_log_func

3169

2302

def debug_gnutls(level, string):

3170

2303

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

3171

3172

gnutls.global_set_log_function(debug_gnutls)

3173

2304

2305

(gnutls.library.functions

2306

.gnutls_global_set_log_function(debug_gnutls))

2307

3174

2308

# Redirect stdin so all checkers get /dev/null

3175

2309

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

3176

2310

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

3177

2311

if null > 2:

3178

2312

os.close(null)

3179

2313

3180

2314

# Need to fork before connecting to D-Bus

3181

if not foreground:

2315

if not debug:

3182

2316

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

3183

2317

daemon()

3184

3185

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

3186

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

3187

# need to inform GLib that threads will be used.

3188

GLib.threads_init()

3189

2318

2319

gobject.threads_init()

2320

3190

2321

global main_loop

3191

2322

# From the Avahi example code

3192

2323

DBusGMainLoop(set_as_default=True)

3193

main_loop = GLib.MainLoop()

2324

main_loop = gobject.MainLoop()

3194

2325

bus = dbus.SystemBus()

3195

2326

# End of Avahi example code

3196

2327

if use_dbus:

3197

2328

try:

3198

2329

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

3199

bus,

3200

do_not_queue=True)

3201

old_bus_name = dbus.service.BusName(

3202

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

3203

do_not_queue=True)

3204

except dbus.exceptions.DBusException as e:

2330

bus, do_not_queue=True)

2331

old_bus_name = (dbus.service.BusName

2332

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

2333

do_not_queue=True))

2334

except dbus.exceptions.NameExistsException as e:

3205

2335

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

3206

2336

use_dbus = False

3207

2337

server_settings["use_dbus"] = False

3208

2338

tcp_server.use_dbus = False

3209

if zeroconf:

3210

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3211

service = AvahiServiceToSyslog(

3212

name=server_settings["servicename"],

3213

servicetype="_mandos._tcp",

3214

protocol=protocol,

3215

bus=bus)

3216

if server_settings["interface"]:

3217

service.interface = if_nametoindex(

3218

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

3219

2339

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2340

service = AvahiServiceToSyslog(name =

2341

server_settings["servicename"],

2342

servicetype = "_mandos._tcp",

2343

protocol = protocol, bus = bus)

2344

if server_settings["interface"]:

2345

service.interface = (if_nametoindex

2346

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

2347

3220

2348

global multiprocessing_manager

3221

2349

multiprocessing_manager = multiprocessing.Manager()

3222

2350

3223

2351

client_class = Client

3224

2352

if use_dbus:

3225

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

3226

2353

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

2354

3227

2355

client_settings = Client.config_parser(client_config)

3228

2356

old_client_settings = {}

3229

2357

clients_data = {}

3230

3231

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

3232

global wnull

3233

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

3234

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

3235

# mode

3236

if debug or not foreground:

3237

wnull.close()

3238

2358

3239

2359

# Get client data and settings from last running state.

3240

2360

if server_settings["restore"]:

3241

2361

try:

3242

2362

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

3243

if sys.version_info.major == 2:

3244

clients_data, old_client_settings = pickle.load(

3245

stored_state)

3246

else:

3247

bytes_clients_data, bytes_old_client_settings = (

3248

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

3249

# Fix bytes to strings

3250

# clients_data

3251

# .keys()

3252

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

3253

if isinstance(key, bytes)

3254

else key): value

3255

for key, value in

3256

bytes_clients_data.items()}

3257

del bytes_clients_data

3258

for key in clients_data:

3259

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

3260

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

3261

for k, v in

3262

clients_data[key].items()}

3263

clients_data[key] = value

3264

# .client_structure

3265

value["client_structure"] = [

3266

(s.decode("utf-8")

3267

if isinstance(s, bytes)

3268

else s) for s in

3269

value["client_structure"]]

3270

# .name, .host, and .checker_command

3271

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

3272

if isinstance(value[k], bytes):

3273

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

3274

if "key_id" not in value:

3275

value["key_id"] = ""

3276

elif "fingerprint" not in value:

3277

value["fingerprint"] = ""

3278

# old_client_settings

3279

# .keys()

3280

old_client_settings = {

3281

(key.decode("utf-8")

3282

if isinstance(key, bytes)

3283

else key): value

3284

for key, value in

3285

bytes_old_client_settings.items()}

3286

del bytes_old_client_settings

3287

# .host and .checker_command

3288

for value in old_client_settings.values():

3289

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

3290

if isinstance(value[attribute], bytes):

3291

value[attribute] = (value[attribute]

3292

.decode("utf-8"))

2363

clients_data, old_client_settings = (pickle.load

2364

(stored_state))

3293

2365

os.remove(stored_state_path)

3294

2366

except IOError as e:

3295

2367

if e.errno == errno.ENOENT:

3296

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

3297

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

2368

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

2369

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

3298

2370

else:

3299

2371

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

3300

2372

exc_info=e)

3301

2373

raise

3302

2374

except EOFError as e:

3303

2375

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

3304

"EOFError:",

3305

exc_info=e)

3306

2376

"EOFError:", exc_info=e)

2377

3307

2378

with PGPEngine() as pgp:

3308

for client_name, client in clients_data.items():

3309

# Skip removed clients

3310

if client_name not in client_settings:

3311

continue

3312

2379

for client_name, client in clients_data.iteritems():

3313

2380

# Decide which value to use after restoring saved state.

3314

2381

# We have three different values: Old config file,

3315

2382

# new config file, and saved state.

3320

2387

# For each value in new config, check if it

3321

2388

# differs from the old config value (Except for

3322

2389

# the "secret" attribute)

3323

if (name != "secret"

3324

and (value !=

3325

old_client_settings[client_name][name])):

2390

if (name != "secret" and

2391

value != old_client_settings[client_name]

2392

[name]):

3326

2393

client[name] = value

3327

2394

except KeyError:

3328

2395

pass

3329

2396

3330

2397

# Clients who has passed its expire date can still be

3331

# enabled if its last checker was successful. A Client

2398

# enabled if its last checker was successful. Clients

3332

2399

# whose checker succeeded before we stored its state is

3333

2400

# assumed to have successfully run all checkers during

3334

2401

# downtime.

3336

2403

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

3337

2404

if not client["last_checked_ok"]:

3338

2405

logger.warning(

3339

"disabling client {} - Client never "

3340

"performed a successful checker".format(

3341

client_name))

2406

"disabling client {0} - Client never "

2407

"performed a successful checker"

2408

.format(client_name))

3342

2409

client["enabled"] = False

3343

2410

elif client["last_checker_status"] != 0:

3344

2411

logger.warning(

3345

"disabling client {} - Client last"

3346

" checker failed with error code"

3347

" {}".format(

3348

client_name,

3349

client["last_checker_status"]))

2412

"disabling client {0} - Client "

2413

"last checker failed with error code {1}"

2414

.format(client_name,

2415

client["last_checker_status"]))

3350

2416

client["enabled"] = False

3351

2417

else:

3352

client["expires"] = (

3353

datetime.datetime.utcnow()

3354

+ client["timeout"])

2418

client["expires"] = (datetime.datetime

2419

.utcnow()

2420

+ client["timeout"])

3355

2421

logger.debug("Last checker succeeded,"

3356

" keeping {} enabled".format(

3357

client_name))

2422

" keeping {0} enabled"

2423

.format(client_name))

3358

2424

try:

3359

client["secret"] = pgp.decrypt(

3360

client["encrypted_secret"],

3361

client_settings[client_name]["secret"])

2425

client["secret"] = (

2426

pgp.decrypt(client["encrypted_secret"],

2427

client_settings[client_name]

2428

["secret"]))

3362

2429

except PGPError:

3363

2430

# If decryption fails, we use secret from new settings

3364

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

3365

client_name))

3366

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

3367

["secret"])

3368

2431

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

2432

.format(client_name))

2433

client["secret"] = (

2434

client_settings[client_name]["secret"])

2435

3369

2436

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

3370

2437

for client_name in (set(old_client_settings)

3371

2438

- set(client_settings)):

3373

2440

for client_name in (set(client_settings)

3374

2441

- set(old_client_settings)):

3375

2442

clients_data[client_name] = client_settings[client_name]

3376

2443

3377

2444

# Create all client objects

3378

for client_name, client in clients_data.items():

2445

for client_name, client in clients_data.iteritems():

3379

2446

tcp_server.clients[client_name] = client_class(

3380

name=client_name,

3381

settings=client,

3382

server_settings=server_settings)

3383

2447

name = client_name, settings = client)

2448

3384

2449

if not tcp_server.clients:

3385

2450

logger.warning("No clients defined")

3386

3387

if not foreground:

3388

if pidfile is not None:

3389

pid = os.getpid()

3390

try:

3391

with pidfile:

3392

print(pid, file=pidfile)

3393

except IOError:

3394

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

3395

pidfilename, pid)

3396

del pidfile

2451

2452

if not debug:

2453

try:

2454

with pidfile:

2455

pid = os.getpid()

2456

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

2457

del pidfile

2458

except IOError:

2459

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

2460

pidfilename, pid)

2461

except NameError:

2462

# "pidfile" was never created

2463

pass

3397

2464

del pidfilename

3398

3399

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

3400

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3401

lambda: main_loop.quit() and False)

3402

2465

signal.signal(signal.SIGINT, signal.SIG_IGN)

2466

2467

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

2468

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

2469

3403

2470

if use_dbus:

3404

3405

@alternate_dbus_interfaces(

3406

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

3407

class MandosDBusService(DBusObjectWithObjectManager):

2471

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

2472

"se.bsnet.fukt.Mandos"})

2473

class MandosDBusService(DBusObjectWithProperties):

3408

2474

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

3409

3410

2475

def __init__(self):

3411

2476

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

3412

3413

2477

_interface = "se.recompile.Mandos"

3414

2478

2479

@dbus_interface_annotations(_interface)

2480

def _foo(self):

2481

return { "org.freedesktop.DBus.Property"

2482

".EmitsChangedSignal":

2483

"false"}

2484

3415

2485

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

3416

2486

def ClientAdded(self, objpath):

3417

2487

"D-Bus signal"

3418

2488

pass

3419

2489

3420

2490

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

3421

def ClientNotFound(self, key_id, address):

2491

def ClientNotFound(self, fingerprint, address):

3422

2492

"D-Bus signal"

3423

2493

pass

3424

3425

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

3426

"true"})

2494

3427

2495

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

3428

2496

def ClientRemoved(self, objpath, name):

3429

2497

"D-Bus signal"

3430

2498

pass

3431

3432

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

3433

"true"})

2499

3434

2500

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

3435

2501

def GetAllClients(self):

3436

2502

"D-Bus method"

3437

return dbus.Array(c.dbus_object_path for c in

3438

tcp_server.clients.values())

3439

3440

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

3441

"true"})

2503

return dbus.Array(c.dbus_object_path

2504

for c in

2505

tcp_server.clients.itervalues())

2506

3442

2507

@dbus.service.method(_interface,

3443

2508

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

3444

2509

def GetAllClientsWithProperties(self):

3445

2510

"D-Bus method"

3446

2511

return dbus.Dictionary(

3447

{c.dbus_object_path: c.GetAll(

3448

"se.recompile.Mandos.Client")

3449

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

2512

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

2513

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

3450

2514

signature="oa{sv}")

3451

2515

3452

2516

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

3453

2517

def RemoveClient(self, object_path):

3454

2518

"D-Bus method"

3455

for c in tcp_server.clients.values():

2519

for c in tcp_server.clients.itervalues():

3456

2520

if c.dbus_object_path == object_path:

3457

2521

del tcp_server.clients[c.name]

3458

2522

c.remove_from_connection()

3459

# Don't signal the disabling

2523

# Don't signal anything except ClientRemoved

3460

2524

c.disable(quiet=True)

3461

# Emit D-Bus signal for removal

3462

self.client_removed_signal(c)

2525

# Emit D-Bus signal

2526

self.ClientRemoved(object_path, c.name)

3463

2527

return

3464

2528

raise KeyError(object_path)

3465

2529

3466

2530

del _interface

3467

3468

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3469

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

3470

def GetManagedObjects(self):

3471

"""D-Bus method"""

3472

return dbus.Dictionary(

3473

{client.dbus_object_path:

3474

dbus.Dictionary(

3475

{interface: client.GetAll(interface)

3476

for interface in

3477

client._get_all_interface_names()})

3478

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

3479

3480

def client_added_signal(self, client):

3481

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

3482

if use_dbus:

3483

# New standard signal

3484

self.InterfacesAdded(

3485

client.dbus_object_path,

3486

dbus.Dictionary(

3487

{interface: client.GetAll(interface)

3488

for interface in

3489

client._get_all_interface_names()}))

3490

# Old signal

3491

self.ClientAdded(client.dbus_object_path)

3492

3493

def client_removed_signal(self, client):

3494

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

3495

if use_dbus:

3496

# New standard signal

3497

self.InterfacesRemoved(

3498

client.dbus_object_path,

3499

client._get_all_interface_names())

3500

# Old signal

3501

self.ClientRemoved(client.dbus_object_path,

3502

client.name)

3503

2531

3504

2532

mandos_dbus_service = MandosDBusService()

3505

3506

# Save modules to variables to exempt the modules from being

3507

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

3508

mp = multiprocessing

3509

wn = wnull

3510

2533

3511

2534

def cleanup():

3512

2535

"Cleanup function; run on exit"

3513

if zeroconf:

3514

service.cleanup()

3515

3516

mp.active_children()

3517

wn.close()

2536

service.cleanup()

2537

2538

multiprocessing.active_children()

3518

2539

if not (tcp_server.clients or client_settings):

3519

2540

return

3520

2541

3521

2542

# Store client before exiting. Secrets are encrypted with key

3522

2543

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

3523

2544

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

3524

2545

clients = {}

3525

2546

with PGPEngine() as pgp:

3526

for client in tcp_server.clients.values():

2547

for client in tcp_server.clients.itervalues():

3527

2548

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

3528

2549

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

3529

2550

key)

3530

2551

client_dict = {}

3531

2552

3532

2553

# A list of attributes that can not be pickled

3533

2554

# + secret.

3534

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

3535

"checker", "server_settings"}

3536

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

3537

.Object):

2555

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

2556

"checker"))

2557

for name, typ in (inspect.getmembers

2558

(dbus.service.Object)):

3538

2559

exclude.add(name)

3539

2560

3540

2561

client_dict["encrypted_secret"] = (client

3541

2562

.encrypted_secret)

3542

2563

for attr in client.client_structure:

3543

2564

if attr not in exclude:

3544

2565

client_dict[attr] = getattr(client, attr)

3545

2566

3546

2567

clients[client.name] = client_dict

3547

2568

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

3548

2569

3549

2570

try:

3550

with tempfile.NamedTemporaryFile(

3551

mode='wb',

3552

suffix=".pickle",

3553

prefix='clients-',

3554

dir=os.path.dirname(stored_state_path),

3555

delete=False) as stored_state:

3556

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

3557

protocol=2)

3558

tempname = stored_state.name

2571

with (tempfile.NamedTemporaryFile

2572

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

2573

dir=os.path.dirname(stored_state_path),

2574

delete=False)) as stored_state:

2575

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

2576

tempname=stored_state.name

3559

2577

os.rename(tempname, stored_state_path)

3560

2578

except (IOError, OSError) as e:

3561

2579

if not debug:

3564

2582

except NameError:

3565

2583

pass

3566

2584

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

3567

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

2585

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

3568

2586

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

3569

2587

else:

3570

2588

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

3571

2589

exc_info=e)

3572

raise

3573

2590

raise e

2591

3574

2592

# Delete all clients, and settings from config

3575

2593

while tcp_server.clients:

3576

2594

name, client = tcp_server.clients.popitem()

3577

2595

if use_dbus:

3578

2596

client.remove_from_connection()

3579

# Don't signal the disabling

2597

# Don't signal anything except ClientRemoved

3580

2598

client.disable(quiet=True)

3581

# Emit D-Bus signal for removal

3582

2599

if use_dbus:

3583

mandos_dbus_service.client_removed_signal(client)

2600

# Emit D-Bus signal

2601

mandos_dbus_service.ClientRemoved(client

2602

.dbus_object_path,

2603

client.name)

3584

2604

client_settings.clear()

3585

2605

3586

2606

atexit.register(cleanup)

3587

3588

for client in tcp_server.clients.values():

2607

2608

for client in tcp_server.clients.itervalues():

3589

2609

if use_dbus:

3590

# Emit D-Bus signal for adding

3591

mandos_dbus_service.client_added_signal(client)

2610

# Emit D-Bus signal

2611

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3592

2612

# Need to initiate checking of clients

3593

2613

if client.enabled:

3594

2614

client.init_checker()

3595

2615

3596

2616

tcp_server.enable()

3597

2617

tcp_server.server_activate()

3598

2618

3599

2619

# Find out what port we got

3600

if zeroconf:

3601

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

2620

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

3602

2621

if use_ipv6:

3603

2622

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

3604

2623

" flowinfo %d, scope_id %d",

3606

2625

else: # IPv4

3607

2626

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

3608

2627

*tcp_server.socket.getsockname())

3609

3610

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

3611

2628

2629

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

2630

3612

2631

try:

3613

if zeroconf:

3614

# From the Avahi example code

3615

try:

3616

service.activate()

3617

except dbus.exceptions.DBusException as error:

3618

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

3619

cleanup()

3620

sys.exit(1)

3621

# End of Avahi example code

3622

3623

GLib.io_add_watch(

3624

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

3625

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3626

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

3627

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

3628

2632

# From the Avahi example code

2633

try:

2634

service.activate()

2635

except dbus.exceptions.DBusException as error:

2636

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

2637

cleanup()

2638

sys.exit(1)

2639

# End of Avahi example code

2640

2641

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

2642

lambda *args, **kwargs:

2643

(tcp_server.handle_request

2644

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

2645

3629

2646

logger.debug("Starting main loop")

3630

2647

main_loop.run()

3631

2648

except AvahiError as error:

3640

2657

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

3641

2658

cleanup()

3642

2659

3643

3644

def should_only_run_tests():

3645

parser = argparse.ArgumentParser(add_help=False)

3646

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

3647

args, unknown_args = parser.parse_known_args()

3648

run_tests = args.check

3649

if run_tests:

3650

# Remove --check argument from sys.argv

3651

sys.argv[1:] = unknown_args

3652

return run_tests

3653

3654

# Add all tests from doctest strings

3655

def load_tests(loader, tests, none):

3656

import doctest

3657

tests.addTests(doctest.DocTestSuite())

3658

return tests

3659

3660

2660

if __name__ == '__main__':

3661

try:

3662

if should_only_run_tests():

3663

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

3664

unittest.main()

3665

else:

3666

main()

3667

finally:

3668

logging.shutdown()

2661

main()