/mandos/release : revision 237.7.157

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python

2

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

3

#

4

# Mandos server - give out binary blobs to connecting clients.

5

#

5

#

6

# This program is partly derived from an example program for an Avahi

7

# service publisher, downloaded from

8

# <http://avahi.org/wiki/PythonPublishExample>. This includes the

9

# methods "add", "remove", "server_state_changed",

10

# "entry_group_state_changed", "cleanup", and "activate" in the

11

# "AvahiService" class, and some lines in "main".

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

# Mandos is free software: you can redistribute it and/or modify it

20

# under the terms of the GNU General Public License as published by

14

15

16

#

17

# This program is free software: you can redistribute it and/or modify

18

# it under the terms of the GNU General Public License as published by

21

19

# the Free Software Foundation, either version 3 of the License, or

22

20

# (at your option) any later version.

23

21

#

24

# Mandos is distributed in the hope that it will be useful, but

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

# This program is distributed in the hope that it will be useful,

23

# but WITHOUT ANY WARRANTY; without even the implied warranty of

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

# You should have received a copy of the GNU General Public License

30

# along with Mandos. If not, see <http://www.gnu.org/licenses/>.

31

#

28

# along with this program. If not, see

29

# <http://www.gnu.org/licenses/>.

30

#

32

31

# Contact the authors at <mandos@recompile.se>.

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import unittest

81

import random

82

import shlex

83

72

84

73

import dbus

85

74

import dbus.service

86

import gi

87

from gi.repository import GLib

75

import gobject

76

import avahi

88

77

from dbus.mainloop.glib import DBusGMainLoop

89

78

import ctypes

90

79

import ctypes.util

91

80

import xml.dom.minidom

92

81

import inspect

93

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:

82

import GnuPGInterface

83

84

try:

122

85

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

86

except AttributeError:

124

87

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

88

from IN import SO_BINDTODEVICE

128

89

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

90

SO_BINDTODEVICE = None

91

92

version = "1.6.0"

147

93

stored_state_file = "clients.pickle"

148

94

149

95

logger = logging.getLogger()

150

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

151

syslogger = None

96

syslogger = (logging.handlers.SysLogHandler

97

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

98

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

152

99

153

100

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

156

104

except (OSError, AttributeError):

157

158

105

def if_nametoindex(interface):

159

106

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

160

107

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

161

108

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

162

109

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

163

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

164

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

110

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

111

interface))

112

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

113

ifreq[16:20])[0]

165

114

return interface_index

166

115

167

116

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

117

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

185

118

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

119

191

120

syslogger.setFormatter(logging.Formatter

192

121

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

193

122

' %(message)s'))

194

123

logger.addHandler(syslogger)

195

124

196

125

if debug:

197

126

console = logging.StreamHandler()

198

127

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

208

137

pass

209

138

210

139

211

class PGPEngine:

140

class PGPEngine(object):

212

141

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

213

214

142

def __init__(self):

143

self.gnupg = GnuPGInterface.GnuPG()

215

144

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

145

self.gnupg = GnuPGInterface.GnuPG()

146

self.gnupg.options.meta_interactive = False

147

self.gnupg.options.homedir = self.tempdir

148

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

149

'--quiet',

150

'--no-use-agent'])

151

235

152

def __enter__(self):

236

153

return self

237

154

238

155

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

239

156

self._cleanup()

240

157

return False

241

158

242

159

def __del__(self):

243

160

self._cleanup()

244

161

245

162

def _cleanup(self):

246

163

if self.tempdir is not None:

247

164

# Delete contents of tempdir

248

165

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

249

topdown=False):

166

topdown = False):

250

167

for filename in files:

251

168

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

252

169

for dirname in dirs:

254

171

# Remove tempdir

255

172

os.rmdir(self.tempdir)

256

173

self.tempdir = None

257

174

258

175

def password_encode(self, password):

259

176

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

260

177

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

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

178

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

179

269

180

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)

181

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

182

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

183

try:

184

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

185

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

186

attach_fhs={'stderr': devnull})

187

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

188

f.write(data)

189

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

190

ciphertext = f.read()

191

proc.wait()

192

except IOError as e:

193

raise PGPError(e)

194

self.gnupg.passphrase = None

285

195

return ciphertext

286

196

287

197

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)

198

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

199

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

200

try:

201

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

202

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

203

attach_fhs={'stderr': devnull})

204

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

205

f.write(data)

206

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

207

decrypted_plaintext = f.read()

208

proc.wait()

209

except IOError as e:

210

raise PGPError(e)

211

self.gnupg.passphrase = None

303

212

return decrypted_plaintext

304

213

305

214

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

332

215

class AvahiError(Exception):

333

216

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

334

217

self.value = value

335

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

336

**kwargs)

337

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

338

221

339

222

class AvahiServiceError(AvahiError):

340

223

pass

341

224

342

343

225

class AvahiGroupError(AvahiError):

344

226

pass

345

227

346

228

347

class AvahiService:

229

class AvahiService(object):

348

230

"""An Avahi (Zeroconf) service.

349

231

350

232

Attributes:

351

233

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

352

234

Used to optionally bind to the specified interface.

353

235

name: string; Example: 'Mandos'

354

236

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

355

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

237

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

356

238

port: integer; what port to announce

357

239

TXT: list of strings; TXT record for the service

358

240

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

364

246

server: D-Bus Server

365

247

bus: dbus.SystemBus()

366

248

"""

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

249

250

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

251

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

252

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

253

protocol = avahi.PROTO_UNSPEC, bus = None):

379

254

self.interface = interface

380

255

self.name = name

381

256

self.type = servicetype

390

265

self.server = None

391

266

self.bus = bus

392

267

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

268

269

def rename(self):

395

270

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

396

271

if self.rename_count >= self.max_renames:

397

272

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

398

273

" after %i retries, exiting.",

399

274

self.rename_count)

400

275

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

404

278

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

405

279

self.name)

406

if remove:

407

self.remove()

280

self.remove()

408

281

try:

409

282

self.add()

410

283

except dbus.exceptions.DBusException as error:

411

if (error.get_dbus_name()

412

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

413

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

414

return self.rename(remove=False)

415

else:

416

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

417

self.cleanup()

418

os._exit(1)

419

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

288

420

289

def remove(self):

421

290

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

422

291

if self.entry_group_state_changed_match is not None:

424

293

self.entry_group_state_changed_match = None

425

294

if self.group is not None:

426

295

self.group.Reset()

427

296

428

297

def add(self):

429

298

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

430

299

self.remove()

447

316

dbus.UInt16(self.port),

448

317

avahi.string_array_to_txt_array(self.TXT))

449

318

self.group.Commit()

450

319

451

320

def entry_group_state_changed(self, state, error):

452

321

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

453

322

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

454

323

455

324

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

325

logger.debug("Zeroconf service established.")

457

326

elif state == avahi.ENTRY_GROUP_COLLISION:

459

328

self.rename()

460

329

elif state == avahi.ENTRY_GROUP_FAILURE:

461

330

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

462

str(error))

463

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

464

331

unicode(error))

332

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

333

.format(error))

334

465

335

def cleanup(self):

466

336

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

467

337

if self.group is not None:

472

342

pass

473

343

self.group = None

474

344

self.remove()

475

345

476

346

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

477

347

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

478

348

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

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

485

356

if state in bad_states:

486

357

if bad_states[state] is not None:

487

358

if error is None:

490

361

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

491

362

self.cleanup()

492

363

elif state == avahi.SERVER_RUNNING:

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

logger.info("Local Zeroconf service name"

499

" collision.")

500

return self.rename(remove=False)

501

else:

502

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

503

self.cleanup()

504

os._exit(1)

364

self.add()

505

365

else:

506

366

if error is None:

507

367

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

508

368

else:

509

369

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

510

370

511

371

def activate(self):

512

372

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

513

373

if self.server is None:

517

377

follow_name_owner_changes=True),

518

378

avahi.DBUS_INTERFACE_SERVER)

519

379

self.server.connect_to_signal("StateChanged",

520

self.server_state_changed)

380

self.server_state_changed)

521

381

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

522

382

523

383

524

384

class AvahiServiceToSyslog(AvahiService):

525

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

385

def rename(self):

526

386

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

527

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

528

**kwargs)

529

syslogger.setFormatter(logging.Formatter(

530

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

531

.format(self.name)))

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

532

392

return ret

533

393

534

394

535

# Pretend that we have a GnuTLS module

536

class gnutls:

537

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

538

539

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

540

if library is None:

541

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

542

_library = ctypes.cdll.LoadLibrary(library)

543

del library

544

545

# Unless otherwise indicated, the constants and types below are

546

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

547

548

# Constants

549

E_SUCCESS = 0

550

E_INTERRUPTED = -52

551

E_AGAIN = -28

552

CRT_OPENPGP = 2

553

CRT_RAWPK = 3

554

CLIENT = 2

555

SHUT_RDWR = 0

556

CRD_CERTIFICATE = 1

557

E_NO_CERTIFICATE_FOUND = -49

558

X509_FMT_DER = 0

559

NO_TICKETS = 1<<10

560

ENABLE_RAWPK = 1<<18

561

CTYPE_PEERS = 3

562

KEYID_USE_SHA256 = 1 # gnutls/x509.h

563

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

564

565

# Types

566

class session_int(ctypes.Structure):

567

_fields_ = []

568

session_t = ctypes.POINTER(session_int)

569

570

class certificate_credentials_st(ctypes.Structure):

571

_fields_ = []

572

certificate_credentials_t = ctypes.POINTER(

573

certificate_credentials_st)

574

certificate_type_t = ctypes.c_int

575

576

class datum_t(ctypes.Structure):

577

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

578

('size', ctypes.c_uint)]

579

580

class openpgp_crt_int(ctypes.Structure):

581

_fields_ = []

582

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

583

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

584

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

585

credentials_type_t = ctypes.c_int

586

transport_ptr_t = ctypes.c_void_p

587

close_request_t = ctypes.c_int

588

589

# Exceptions

590

class Error(Exception):

591

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

592

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

593

# code is passed, convert it to a string with

594

# gnutls.strerror()

595

self.code = code

596

if message is None and code is not None:

597

message = gnutls.strerror(code)

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

# Classes

605

class Credentials:

606

def __init__(self):

607

self._c_object = gnutls.certificate_credentials_t()

608

gnutls.certificate_allocate_credentials(

609

ctypes.byref(self._c_object))

610

self.type = gnutls.CRD_CERTIFICATE

611

612

def __del__(self):

613

gnutls.certificate_free_credentials(self._c_object)

614

615

class ClientSession:

616

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

617

self._c_object = gnutls.session_t()

618

gnutls_flags = gnutls.CLIENT

619

if gnutls.check_version(b"3.5.6"):

620

gnutls_flags |= gnutls.NO_TICKETS

621

if gnutls.has_rawpk:

622

gnutls_flags |= gnutls.ENABLE_RAWPK

623

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

624

del gnutls_flags

625

gnutls.set_default_priority(self._c_object)

626

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

627

gnutls.handshake_set_private_extensions(self._c_object,

628

True)

629

self.socket = socket

630

if credentials is None:

631

credentials = gnutls.Credentials()

632

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

633

ctypes.cast(credentials._c_object,

634

ctypes.c_void_p))

635

self.credentials = credentials

636

637

def __del__(self):

638

gnutls.deinit(self._c_object)

639

640

def handshake(self):

641

return gnutls.handshake(self._c_object)

642

643

def send(self, data):

644

data = bytes(data)

645

data_len = len(data)

646

while data_len > 0:

647

data_len -= gnutls.record_send(self._c_object,

648

data[-data_len:],

649

data_len)

650

651

def bye(self):

652

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

653

654

# Error handling functions

655

def _error_code(result):

656

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

657

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

658

if result >= 0:

659

return result

660

if result == gnutls.E_NO_CERTIFICATE_FOUND:

661

raise gnutls.CertificateSecurityError(code=result)

662

raise gnutls.Error(code=result)

663

664

def _retry_on_error(result, func, arguments):

665

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

666

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

667

while result < 0:

668

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

669

return _error_code(result)

670

result = func(*arguments)

671

return result

672

673

# Unless otherwise indicated, the function declarations below are

674

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

675

676

# Functions

677

priority_set_direct = _library.gnutls_priority_set_direct

678

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

679

ctypes.POINTER(ctypes.c_char_p)]

680

priority_set_direct.restype = _error_code

681

682

init = _library.gnutls_init

683

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

684

init.restype = _error_code

685

686

set_default_priority = _library.gnutls_set_default_priority

687

set_default_priority.argtypes = [session_t]

688

set_default_priority.restype = _error_code

689

690

record_send = _library.gnutls_record_send

691

record_send.argtypes = [session_t, ctypes.c_void_p,

692

ctypes.c_size_t]

693

record_send.restype = ctypes.c_ssize_t

694

record_send.errcheck = _retry_on_error

695

696

certificate_allocate_credentials = (

697

_library.gnutls_certificate_allocate_credentials)

698

certificate_allocate_credentials.argtypes = [

699

ctypes.POINTER(certificate_credentials_t)]

700

certificate_allocate_credentials.restype = _error_code

701

702

certificate_free_credentials = (

703

_library.gnutls_certificate_free_credentials)

704

certificate_free_credentials.argtypes = [

705

certificate_credentials_t]

706

certificate_free_credentials.restype = None

707

708

handshake_set_private_extensions = (

709

_library.gnutls_handshake_set_private_extensions)

710

handshake_set_private_extensions.argtypes = [session_t,

711

ctypes.c_int]

712

handshake_set_private_extensions.restype = None

713

714

credentials_set = _library.gnutls_credentials_set

715

credentials_set.argtypes = [session_t, credentials_type_t,

716

ctypes.c_void_p]

717

credentials_set.restype = _error_code

718

719

strerror = _library.gnutls_strerror

720

strerror.argtypes = [ctypes.c_int]

721

strerror.restype = ctypes.c_char_p

722

723

certificate_type_get = _library.gnutls_certificate_type_get

724

certificate_type_get.argtypes = [session_t]

725

certificate_type_get.restype = _error_code

726

727

certificate_get_peers = _library.gnutls_certificate_get_peers

728

certificate_get_peers.argtypes = [session_t,

729

ctypes.POINTER(ctypes.c_uint)]

730

certificate_get_peers.restype = ctypes.POINTER(datum_t)

731

732

global_set_log_level = _library.gnutls_global_set_log_level

733

global_set_log_level.argtypes = [ctypes.c_int]

734

global_set_log_level.restype = None

735

736

global_set_log_function = _library.gnutls_global_set_log_function

737

global_set_log_function.argtypes = [log_func]

738

global_set_log_function.restype = None

739

740

deinit = _library.gnutls_deinit

741

deinit.argtypes = [session_t]

742

deinit.restype = None

743

744

handshake = _library.gnutls_handshake

745

handshake.argtypes = [session_t]

746

handshake.restype = _error_code

747

handshake.errcheck = _retry_on_error

748

749

transport_set_ptr = _library.gnutls_transport_set_ptr

750

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

751

transport_set_ptr.restype = None

752

753

bye = _library.gnutls_bye

754

bye.argtypes = [session_t, close_request_t]

755

bye.restype = _error_code

756

bye.errcheck = _retry_on_error

757

758

check_version = _library.gnutls_check_version

759

check_version.argtypes = [ctypes.c_char_p]

760

check_version.restype = ctypes.c_char_p

761

762

_need_version = b"3.3.0"

763

if check_version(_need_version) is None:

764

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

765

.format(_need_version))

766

767

_tls_rawpk_version = b"3.6.6"

768

has_rawpk = bool(check_version(_tls_rawpk_version))

769

770

if has_rawpk:

771

# Types

772

class pubkey_st(ctypes.Structure):

773

_fields = []

774

pubkey_t = ctypes.POINTER(pubkey_st)

775

776

x509_crt_fmt_t = ctypes.c_int

777

778

# All the function declarations below are from

779

# gnutls/abstract.h

780

pubkey_init = _library.gnutls_pubkey_init

781

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

782

pubkey_init.restype = _error_code

783

784

pubkey_import = _library.gnutls_pubkey_import

785

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

786

x509_crt_fmt_t]

787

pubkey_import.restype = _error_code

788

789

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

790

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

791

ctypes.POINTER(ctypes.c_ubyte),

792

ctypes.POINTER(ctypes.c_size_t)]

793

pubkey_get_key_id.restype = _error_code

794

795

pubkey_deinit = _library.gnutls_pubkey_deinit

796

pubkey_deinit.argtypes = [pubkey_t]

797

pubkey_deinit.restype = None

798

else:

799

# All the function declarations below are from

800

# gnutls/openpgp.h

801

802

openpgp_crt_init = _library.gnutls_openpgp_crt_init

803

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

804

openpgp_crt_init.restype = _error_code

805

806

openpgp_crt_import = _library.gnutls_openpgp_crt_import

807

openpgp_crt_import.argtypes = [openpgp_crt_t,

808

ctypes.POINTER(datum_t),

809

openpgp_crt_fmt_t]

810

openpgp_crt_import.restype = _error_code

811

812

openpgp_crt_verify_self = \

813

_library.gnutls_openpgp_crt_verify_self

814

openpgp_crt_verify_self.argtypes = [

815

openpgp_crt_t,

816

ctypes.c_uint,

817

ctypes.POINTER(ctypes.c_uint),

818

]

819

openpgp_crt_verify_self.restype = _error_code

820

821

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

822

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

823

openpgp_crt_deinit.restype = None

824

825

openpgp_crt_get_fingerprint = (

826

_library.gnutls_openpgp_crt_get_fingerprint)

827

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

828

ctypes.c_void_p,

829

ctypes.POINTER(

830

ctypes.c_size_t)]

831

openpgp_crt_get_fingerprint.restype = _error_code

832

833

if check_version(b"3.6.4"):

834

certificate_type_get2 = _library.gnutls_certificate_type_get2

835

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

836

certificate_type_get2.restype = _error_code

837

838

# Remove non-public functions

839

del _error_code, _retry_on_error

840

841

842

def call_pipe(connection, # : multiprocessing.Connection

843

func, *args, **kwargs):

844

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

845

846

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

847

return value on the provided multiprocessing.Connection.

848

"""

849

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

850

connection.close()

851

852

853

class Client:

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

400

401

402

class Client(object):

854

403

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

855

404

856

405

Attributes:

857

406

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

858

407

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

859

408

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

860

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

861

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

862

running.

863

checker_callback_tag: a GLib event source tag, or None

409

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

410

to see if the client lives.

411

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

864

413

checker_command: string; External command which is run to check

865

414

if client lives. %() expansions are done at

866

415

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

867

416

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

868

checker_initiator_tag: a GLib event source tag, or None

417

checker_initiator_tag: a gobject event source tag, or None

869

418

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

870

419

client_structure: Object describing what attributes a client has

871

420

and is used for storing the client at exit

872

421

current_checker_command: string; current running checker_command

873

disable_initiator_tag: a GLib event source tag, or None

422

disable_initiator_tag: a gobject event source tag, or None

874

423

enabled: bool()

875

424

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

876

uniquely identify an OpenPGP client

877

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

878

a client using raw public keys

425

uniquely identify the client

879

426

host: string; available for use by the checker command

880

427

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

881

428

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

883

430

last_checker_status: integer between 0 and 255 reflecting exit

884

431

status of last checker. -1 reflects crashed

885

432

checker, -2 means no checker completed yet.

886

last_checker_signal: The signal which killed the last checker, if

887

last_checker_status is -1

888

433

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

889

434

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

890

435

D-Bus identifiers

895

440

runtime_expansions: Allowed attributes for runtime expansion.

896

441

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

897

442

disabled, or None

898

server_settings: The server_settings dict from main()

899

443

"""

900

444

901

445

runtime_expansions = ("approval_delay", "approval_duration",

902

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

446

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

903

447

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

904

448

"last_approval_request", "last_checked_ok",

905

449

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

906

client_defaults = {

907

"timeout": "PT5M",

908

"extended_timeout": "PT15M",

909

"interval": "PT2M",

910

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

911

"host": "",

912

"approval_delay": "PT0S",

913

"approval_duration": "PT1S",

914

"approved_by_default": "True",

915

"enabled": "True",

916

}

917

450

client_defaults = { "timeout": "PT5M",

451

"extended_timeout": "PT15M",

452

"interval": "PT2M",

453

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

454

"host": "",

455

"approval_delay": "PT0S",

456

"approval_duration": "PT1S",

457

"approved_by_default": "True",

458

"enabled": "True",

459

}

460

461

def timeout_milliseconds(self):

462

"Return the 'timeout' attribute in milliseconds"

463

return timedelta_to_milliseconds(self.timeout)

464

465

def extended_timeout_milliseconds(self):

466

"Return the 'extended_timeout' attribute in milliseconds"

467

return timedelta_to_milliseconds(self.extended_timeout)

468

469

def interval_milliseconds(self):

470

"Return the 'interval' attribute in milliseconds"

471

return timedelta_to_milliseconds(self.interval)

472

473

def approval_delay_milliseconds(self):

474

return timedelta_to_milliseconds(self.approval_delay)

475

918

476

@staticmethod

919

477

def config_parser(config):

920

478

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

927

485

for client_name in config.sections():

928

486

section = dict(config.items(client_name))

929

487

client = settings[client_name] = {}

930

488

931

489

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

932

490

# Reformat values from string types to Python types

933

491

client["approved_by_default"] = config.getboolean(

934

492

client_name, "approved_by_default")

935

493

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

936

494

"enabled")

937

938

# Uppercase and remove spaces from key_id and fingerprint

939

# for later comparison purposes with return value from the

940

# key_id() and fingerprint() functions

941

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

942

.replace(" ", ""))

495

943

496

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

944

497

.replace(" ", ""))

945

498

if "secret" in section:

946

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

947

.encode("utf-8"),

948

"base64")

499

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

949

500

elif "secfile" in section:

950

501

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

951

502

(section["secfile"])),

952

503

"rb") as secfile:

953

504

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

954

505

else:

955

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

506

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

956

507

.format(section))

957

508

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

958

509

client["extended_timeout"] = string_to_delta(

966

517

client["last_approval_request"] = None

967

518

client["last_checked_ok"] = None

968

519

client["last_checker_status"] = -2

969

520

970

521

return settings

971

972

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

522

523

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

973

524

self.name = name

974

if server_settings is None:

975

server_settings = {}

976

self.server_settings = server_settings

977

525

# adding all client settings

978

for setting, value in settings.items():

526

for setting, value in settings.iteritems():

979

527

setattr(self, setting, value)

980

528

981

529

if self.enabled:

982

530

if not hasattr(self, "last_enabled"):

983

531

self.last_enabled = datetime.datetime.utcnow()

987

535

else:

988

536

self.last_enabled = None

989

537

self.expires = None

990

538

991

539

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

992

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

540

# Uppercase and remove spaces from fingerprint for later

541

# comparison purposes with return value from the fingerprint()

542

# function

993

543

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

994

544

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

995

545

datetime.datetime.utcnow())

996

546

997

547

# attributes specific for this server instance

998

548

self.checker = None

999

549

self.checker_initiator_tag = None

1002

552

self.current_checker_command = None

1003

553

self.approved = None

1004

554

self.approvals_pending = 0

1005

self.changedstate = multiprocessing_manager.Condition(

1006

multiprocessing_manager.Lock())

1007

self.client_structure = [attr

1008

for attr in self.__dict__.keys()

555

self.changedstate = (multiprocessing_manager

556

.Condition(multiprocessing_manager

557

.Lock()))

558

self.client_structure = [attr for attr in

559

self.__dict__.iterkeys()

1009

560

if not attr.startswith("_")]

1010

561

self.client_structure.append("client_structure")

1011

1012

for name, t in inspect.getmembers(

1013

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

562

563

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

564

lambda obj:

565

isinstance(obj,

566

property)):

1014

567

if not name.startswith("_"):

1015

568

self.client_structure.append(name)

1016

569

1017

570

# Send notice to process children that client state has changed

1018

571

def send_changedstate(self):

1019

572

with self.changedstate:

1020

573

self.changedstate.notify_all()

1021

574

1022

575

def enable(self):

1023

576

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

1024

577

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

1029

582

self.last_enabled = datetime.datetime.utcnow()

1030

583

self.init_checker()

1031

584

self.send_changedstate()

1032

585

1033

586

def disable(self, quiet=True):

1034

587

"""Disable this client."""

1035

588

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

1037

590

if not quiet:

1038

591

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

1039

592

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

1040

GLib.source_remove(self.disable_initiator_tag)

593

gobject.source_remove(self.disable_initiator_tag)

1041

594

self.disable_initiator_tag = None

1042

595

self.expires = None

1043

596

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

1044

GLib.source_remove(self.checker_initiator_tag)

597

gobject.source_remove(self.checker_initiator_tag)

1045

598

self.checker_initiator_tag = None

1046

599

self.stop_checker()

1047

600

self.enabled = False

1048

601

if not quiet:

1049

602

self.send_changedstate()

1050

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

603

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

1051

604

return False

1052

605

1053

606

def __del__(self):

1054

607

self.disable()

1055

608

1056

609

def init_checker(self):

1057

610

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

1058

611

# and every interval from then on.

1059

612

if self.checker_initiator_tag is not None:

1060

GLib.source_remove(self.checker_initiator_tag)

1061

self.checker_initiator_tag = GLib.timeout_add(

1062

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

1063

+ 1)),

1064

self.start_checker)

613

gobject.source_remove(self.checker_initiator_tag)

614

self.checker_initiator_tag = (gobject.timeout_add

615

(self.interval_milliseconds(),

616

self.start_checker))

1065

617

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

1066

618

if self.disable_initiator_tag is not None:

1067

GLib.source_remove(self.disable_initiator_tag)

1068

self.disable_initiator_tag = GLib.timeout_add(

1069

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

619

gobject.source_remove(self.disable_initiator_tag)

620

self.disable_initiator_tag = (gobject.timeout_add

621

(self.timeout_milliseconds(),

622

self.disable))

1070

623

# Also start a new checker *right now*.

1071

624

self.start_checker()

1072

1073

def checker_callback(self, source, condition, connection,

1074

command):

625

626

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

1075

627

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

1076

# Read return code from connection (see call_pipe)

1077

returncode = connection.recv()

1078

connection.close()

1079

if self.checker is not None:

1080

self.checker.join()

1081

628

self.checker_callback_tag = None

1082

629

self.checker = None

1083

1084

if returncode >= 0:

1085

self.last_checker_status = returncode

1086

self.last_checker_signal = None

630

if os.WIFEXITED(condition):

631

self.last_checker_status = os.WEXITSTATUS(condition)

1087

632

if self.last_checker_status == 0:

1088

633

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

1089

634

vars(self))

1090

635

self.checked_ok()

1091

636

else:

1092

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

637

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

638

vars(self))

1093

639

else:

1094

640

self.last_checker_status = -1

1095

self.last_checker_signal = -returncode

1096

641

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

1097

642

vars(self))

1098

return False

1099

643

1100

644

def checked_ok(self):

1101

645

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

1102

646

self.last_checked_ok = datetime.datetime.utcnow()

1103

647

self.last_checker_status = 0

1104

self.last_checker_signal = None

1105

648

self.bump_timeout()

1106

649

1107

650

def bump_timeout(self, timeout=None):

1108

651

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

1109

652

if timeout is None:

1110

653

timeout = self.timeout

1111

654

if self.disable_initiator_tag is not None:

1112

GLib.source_remove(self.disable_initiator_tag)

655

gobject.source_remove(self.disable_initiator_tag)

1113

656

self.disable_initiator_tag = None

1114

657

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

1115

self.disable_initiator_tag = GLib.timeout_add(

1116

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

658

self.disable_initiator_tag = (gobject.timeout_add

659

(timedelta_to_milliseconds

660

(timeout), self.disable))

1117

661

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

1118

662

1119

663

def need_approval(self):

1120

664

self.last_approval_request = datetime.datetime.utcnow()

1121

665

1122

666

def start_checker(self):

1123

667

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

1124

668

1125

669

If a checker already exists, leave it running and do

1126

670

nothing."""

1127

671

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

1132

676

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

1133

677

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

1134

678

# should be.

1135

1136

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

1137

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

1138

self.checker.join()

1139

self.checker = None

679

680

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

681

try:

682

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

683

except (AttributeError, OSError) as error:

684

if (isinstance(error, OSError)

685

and error.errno != errno.ECHILD):

686

raise error

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

1140

693

# Start a new checker if needed

1141

694

if self.checker is None:

1142

695

# Escape attributes for the shell

1143

escaped_attrs = {

1144

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

1145

for attr in self.runtime_expansions}

696

escaped_attrs = dict(

697

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

698

for attr in

699

self.runtime_expansions)

1146

700

try:

1147

701

command = self.checker_command % escaped_attrs

1148

702

except TypeError as error:

1149

703

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

1150

self.checker_command,

704

self.checker_command, exc_info=error)

705

return True # Try again later

706

self.current_checker_command = command

707

try:

708

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

709

command, self.name)

710

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

711

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

712

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

713

# always replaced by /dev/null.)

714

self.checker = subprocess.Popen(command,

715

close_fds=True,

716

shell=True, cwd="/")

717

except OSError as error:

718

logger.error("Failed to start subprocess",

1151

719

exc_info=error)

1152

return True # Try again later

1153

self.current_checker_command = command

1154

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

1155

self.name)

1156

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

1157

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

1158

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

1159

# always replaced by /dev/null.)

1160

# The exception is when not debugging but nevertheless

1161

# running in the foreground; use the previously

1162

# created wnull.

1163

popen_args = {"close_fds": True,

1164

"shell": True,

1165

"cwd": "/"}

1166

if (not self.server_settings["debug"]

1167

and self.server_settings["foreground"]):

1168

popen_args.update({"stdout": wnull,

1169

"stderr": wnull})

1170

pipe = multiprocessing.Pipe(duplex=False)

1171

self.checker = multiprocessing.Process(

1172

target=call_pipe,

1173

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

1174

kwargs=popen_args)

1175

self.checker.start()

1176

self.checker_callback_tag = GLib.io_add_watch(

1177

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

1178

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1179

self.checker_callback, pipe[0], command)

1180

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

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

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

1181

731

return True

1182

732

1183

733

def stop_checker(self):

1184

734

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

1185

735

if self.checker_callback_tag:

1186

GLib.source_remove(self.checker_callback_tag)

736

gobject.source_remove(self.checker_callback_tag)

1187

737

self.checker_callback_tag = None

1188

738

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

1189

739

return

1190

740

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

1191

self.checker.terminate()

741

try:

742

self.checker.terminate()

743

#time.sleep(0.5)

744

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

745

# self.checker.kill()

746

except OSError as error:

747

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

748

raise

1192

749

self.checker = None

1193

750

1194

751

1195

def dbus_service_property(dbus_interface,

1196

signature="v",

1197

access="readwrite",

1198

byte_arrays=False):

752

def dbus_service_property(dbus_interface, signature="v",

753

access="readwrite", byte_arrays=False):

1199

754

"""Decorators for marking methods of a DBusObjectWithProperties to

1200

755

become properties on the D-Bus.

1201

756

1202

757

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

1203

758

and with one argument by "Set".

1204

759

1205

760

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

1206

761

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

1207

762

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

1210

765

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

1211

766

if byte_arrays and signature != "ay":

1212

767

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

1213

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

1214

768

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

1215

769

def decorator(func):

1216

770

func._dbus_is_property = True

1217

771

func._dbus_interface = dbus_interface

1220

774

func._dbus_name = func.__name__

1221

775

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

1222

776

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

1223

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

777

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1224

778

return func

1225

1226

779

return decorator

1227

780

1228

781

1229

782

def dbus_interface_annotations(dbus_interface):

1230

783

"""Decorator for marking functions returning interface annotations

1231

784

1232

785

Usage:

1233

786

1234

787

@dbus_interface_annotations("org.example.Interface")

1235

788

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

1236

789

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

1237

790

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

1238

791

"false"}

1239

792

"""

1240

1241

793

def decorator(func):

1242

794

func._dbus_is_interface = True

1243

795

func._dbus_interface = dbus_interface

1244

796

func._dbus_name = dbus_interface

1245

797

return func

1246

1247

798

return decorator

1248

799

1249

800

1250

801

def dbus_annotations(annotations):

1251

802

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

1252

803

Usage:

1253

1254

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

1255

"org.freedesktop.DBus.Property."

1256

"EmitsChangedSignal": "false"})

804

1257

805

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

1258

806

access="r")

807

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

808

"org.freedesktop.DBus.Property."

809

"EmitsChangedSignal": "false"})

1259

810

def Property_dbus_property(self):

1260

811

return dbus.Boolean(False)

1261

1262

See also the DBusObjectWithAnnotations class.

1263

812

"""

1264

1265

813

def decorator(func):

1266

814

func._dbus_annotations = annotations

1267

815

return func

1268

1269

816

return decorator

1270

817

1271

818

1272

819

class DBusPropertyException(dbus.exceptions.DBusException):

1273

820

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

1274

821

"""

1275

pass

822

def __unicode__(self):

823

return unicode(str(self))

1276

824

1277

825

1278

826

class DBusPropertyAccessException(DBusPropertyException):

1287

835

pass

1288

836

1289

837

1290

class DBusObjectWithAnnotations(dbus.service.Object):

1291

"""A D-Bus object with annotations.

1292

1293

Classes inheriting from this can use the dbus_annotations

1294

decorator to add annotations to methods or signals.

838

class DBusObjectWithProperties(dbus.service.Object):

839

"""A D-Bus object with properties.

840

841

Classes inheriting from this can use the dbus_service_property

842

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

843

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

1295

844

"""

1296

845

1297

846

@staticmethod

1298

847

def _is_dbus_thing(thing):

1299

848

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

1300

849

1301

850

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

1302

851

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

1303

852

"""

1304

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

853

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

1305

854

False)

1306

855

1307

856

def _get_all_dbus_things(self, thing):

1308

857

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

1309

858

"""

1310

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

859

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

860

name),

1311

861

athing.__get__(self))

1312

862

for cls in self.__class__.__mro__

1313

863

for name, athing in

1314

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

1315

1316

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1317

out_signature="s",

1318

path_keyword='object_path',

1319

connection_keyword='connection')

1320

def Introspect(self, object_path, connection):

1321

"""Overloading of standard D-Bus method.

1322

1323

Inserts annotation tags on methods and signals.

1324

"""

1325

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

1326

connection)

1327

try:

1328

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

1329

1330

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

1331

# Add annotation tags

1332

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

1333

for tag in if_tag.getElementsByTagName(typ):

1334

annots = dict()

1335

for name, prop in (self.

1336

_get_all_dbus_things(typ)):

1337

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

1338

and prop._dbus_interface

1339

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

1340

annots.update(getattr(

1341

prop, "_dbus_annotations", {}))

1342

for name, value in annots.items():

1343

ann_tag = document.createElement(

1344

"annotation")

1345

ann_tag.setAttribute("name", name)

1346

ann_tag.setAttribute("value", value)

1347

tag.appendChild(ann_tag)

1348

# Add interface annotation tags

1349

for annotation, value in dict(

1350

itertools.chain.from_iterable(

1351

annotations().items()

1352

for name, annotations

1353

in self._get_all_dbus_things("interface")

1354

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

1355

)).items():

1356

ann_tag = document.createElement("annotation")

1357

ann_tag.setAttribute("name", annotation)

1358

ann_tag.setAttribute("value", value)

1359

if_tag.appendChild(ann_tag)

1360

# Fix argument name for the Introspect method itself

1361

if (if_tag.getAttribute("name")

1362

== dbus.INTROSPECTABLE_IFACE):

1363

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

1364

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

1365

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

1366

if (arg.getAttribute("direction")

1367

== "out"):

1368

arg.setAttribute("name",

1369

"xml_data")

1370

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

1371

document.unlink()

1372

except (AttributeError, xml.dom.DOMException,

1373

xml.parsers.expat.ExpatError) as error:

1374

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

1375

exc_info=error)

1376

return xmlstring

1377

1378

1379

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1380

"""A D-Bus object with properties.

1381

1382

Classes inheriting from this can use the dbus_service_property

1383

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

1384

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

1385

"""

1386

864

inspect.getmembers(cls,

865

self._is_dbus_thing(thing)))

866

1387

867

def _get_dbus_property(self, interface_name, property_name):

1388

868

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

1389

869

property with the specified name and interface.

1390

870

"""

1391

for cls in self.__class__.__mro__:

1392

for name, value in inspect.getmembers(

1393

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

871

for cls in self.__class__.__mro__:

872

for name, value in (inspect.getmembers

873

(cls,

874

self._is_dbus_thing("property"))):

1394

875

if (value._dbus_name == property_name

1395

876

and value._dbus_interface == interface_name):

1396

877

return value.__get__(self)

1397

878

1398

879

# No such property

1399

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

1400

self.dbus_object_path, interface_name, property_name))

1401

1402

@classmethod

1403

def _get_all_interface_names(cls):

1404

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

1405

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

1406

"_dbus_interface", None)

1407

for x in (inspect.getmro(cls))

1408

for attr in dir(x))

1409

if name is not None)

1410

1411

@dbus.service.method(dbus.PROPERTIES_IFACE,

1412

in_signature="ss",

880

raise DBusPropertyNotFound(self.dbus_object_path + ":"

881

+ interface_name + "."

882

+ property_name)

883

884

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

1413

885

out_signature="v")

1414

886

def Get(self, interface_name, property_name):

1415

887

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

1421

893

if not hasattr(value, "variant_level"):

1422

894

return value

1423

895

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

1424

896

1425

897

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

1426

898

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

1427

899

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

1433

905

# The byte_arrays option is not supported yet on

1434

906

# signatures other than "ay".

1435

907

if prop._dbus_signature != "ay":

1436

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

1437

"'ay' signature {!r}"

1438

.format(prop._dbus_signature))

1439

value = dbus.ByteArray(bytes(value))

908

raise ValueError

909

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

910

for byte in value))

1440

911

prop(value)

1441

1442

@dbus.service.method(dbus.PROPERTIES_IFACE,

1443

in_signature="s",

912

913

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

1444

914

out_signature="a{sv}")

1445

915

def GetAll(self, interface_name):

1446

916

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

1447

917

standard.

1448

918

1449

919

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

1450

920

"""

1451

921

properties = {}

1461

931

if not hasattr(value, "variant_level"):

1462

932

properties[name] = value

1463

933

continue

1464

properties[name] = type(value)(

1465

value, variant_level=value.variant_level + 1)

934

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

935

value.variant_level+1)

1466

936

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

1467

1468

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

1469

def PropertiesChanged(self, interface_name, changed_properties,

1470

invalidated_properties):

1471

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

1472

standard.

1473

"""

1474

pass

1475

937

1476

938

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1477

939

out_signature="s",

1478

940

path_keyword='object_path',

1479

941

connection_keyword='connection')

1480

942

def Introspect(self, object_path, connection):

1481

943

"""Overloading of standard D-Bus method.

1482

944

1483

945

Inserts property tags and interface annotation tags.

1484

946

"""

1485

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1486

object_path,

1487

connection)

947

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

948

connection)

1488

949

try:

1489

950

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

1490

1491

951

def make_tag(document, name, prop):

1492

952

e = document.createElement("property")

1493

953

e.setAttribute("name", name)

1494

954

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

1495

955

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

1496

956

return e

1497

1498

957

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

1499

958

# Add property tags

1500

959

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

1503

962

if prop._dbus_interface

1504

963

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

1505

964

if_tag.appendChild(tag)

1506

# Add annotation tags for properties

1507

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

1508

annots = dict()

1509

for name, prop in self._get_all_dbus_things(

1510

"property"):

1511

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

1512

and prop._dbus_interface

1513

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

1514

annots.update(getattr(

1515

prop, "_dbus_annotations", {}))

1516

for name, value in annots.items():

1517

ann_tag = document.createElement(

1518

"annotation")

1519

ann_tag.setAttribute("name", name)

1520

ann_tag.setAttribute("value", value)

1521

tag.appendChild(ann_tag)

965

# Add annotation tags

966

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

967

for tag in if_tag.getElementsByTagName(typ):

968

annots = dict()

969

for name, prop in (self.

970

_get_all_dbus_things(typ)):

971

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

972

and prop._dbus_interface

973

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

974

annots.update(getattr

975

(prop,

976

"_dbus_annotations",

977

{}))

978

for name, value in annots.iteritems():

979

ann_tag = document.createElement(

980

"annotation")

981

ann_tag.setAttribute("name", name)

982

ann_tag.setAttribute("value", value)

983

tag.appendChild(ann_tag)

984

# Add interface annotation tags

985

for annotation, value in dict(

986

itertools.chain.from_iterable(

987

annotations().iteritems()

988

for name, annotations in

989

self._get_all_dbus_things("interface")

990

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

991

)).iteritems():

992

ann_tag = document.createElement("annotation")

993

ann_tag.setAttribute("name", annotation)

994

ann_tag.setAttribute("value", value)

995

if_tag.appendChild(ann_tag)

1522

996

# Add the names to the return values for the

1523

997

# "org.freedesktop.DBus.Properties" methods

1524

998

if (if_tag.getAttribute("name")

1543

1017

return xmlstring

1544

1018

1545

1019

1546

try:

1547

dbus.OBJECT_MANAGER_IFACE

1548

except AttributeError:

1549

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

1550

1551

1552

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1553

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

1554

1555

Classes inheriting from this exposes the standard

1556

GetManagedObjects call and the InterfacesAdded and

1557

InterfacesRemoved signals on the standard

1558

"org.freedesktop.DBus.ObjectManager" interface.

1559

1560

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

1561

manually.

1562

"""

1563

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1564

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

1565

def GetManagedObjects(self):

1566

"""This function must be overridden"""

1567

raise NotImplementedError()

1568

1569

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1570

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

1571

def InterfacesAdded(self, object_path, interfaces_and_properties):

1572

pass

1573

1574

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

1575

def InterfacesRemoved(self, object_path, interfaces):

1576

pass

1577

1578

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1579

out_signature="s",

1580

path_keyword='object_path',

1581

connection_keyword='connection')

1582

def Introspect(self, object_path, connection):

1583

"""Overloading of standard D-Bus method.

1584

1585

Override return argument name of GetManagedObjects to be

1586

"objpath_interfaces_and_properties"

1587

"""

1588

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1589

object_path,

1590

connection)

1591

try:

1592

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

1593

1594

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

1595

# Fix argument name for the GetManagedObjects method

1596

if (if_tag.getAttribute("name")

1597

== dbus.OBJECT_MANAGER_IFACE):

1598

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

1599

if (cn.getAttribute("name")

1600

== "GetManagedObjects"):

1601

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

1602

if (arg.getAttribute("direction")

1603

== "out"):

1604

arg.setAttribute(

1605

"name",

1606

"objpath_interfaces"

1607

"_and_properties")

1608

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

1609

document.unlink()

1610

except (AttributeError, xml.dom.DOMException,

1611

xml.parsers.expat.ExpatError) as error:

1612

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

1613

exc_info=error)

1614

return xmlstring

1615

1616

1617

1020

def datetime_to_dbus(dt, variant_level=0):

1618

1021

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

1619

1022

if dt is None:

1620

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

1621

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

1023

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

1024

return dbus.String(dt.isoformat(),

1025

variant_level=variant_level)

1622

1026

1623

1027

1624

1028

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1626

1030

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

1627

1031

interface names according to the "alt_interface_names" mapping.

1628

1032

Usage:

1629

1033

1630

1034

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

1631

1035

"net.example.AlternateInterface"})

1632

1036

class SampleDBusObject(dbus.service.Object):

1633

1037

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

1634

1038

def SampleDBusMethod():

1635

1039

pass

1636

1040

1637

1041

The above "SampleDBusMethod" on "SampleDBusObject" will be

1638

1042

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

1639

1043

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

1640

1044

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

1641

1045

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

1642

1046

1643

1047

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

1644

1048

(from DBusObjectWithProperties) and interfaces (from the

1645

1049

dbus_interface_annotations decorator).

1646

1050

"""

1647

1648

1051

def wrapper(cls):

1649

1052

for orig_interface_name, alt_interface_name in (

1650

alt_interface_names.items()):

1053

alt_interface_names.iteritems()):

1651

1054

attr = {}

1652

1055

interface_names = set()

1653

1056

# Go though all attributes of the class

1655

1058

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

1656

1059

# with the wrong interface name

1657

1060

if (not hasattr(attribute, "_dbus_interface")

1658

or not attribute._dbus_interface.startswith(

1659

orig_interface_name)):

1061

or not attribute._dbus_interface

1062

.startswith(orig_interface_name)):

1660

1063

continue

1661

1064

# Create an alternate D-Bus interface name based on

1662

1065

# the current name

1663

alt_interface = attribute._dbus_interface.replace(

1664

orig_interface_name, alt_interface_name)

1066

alt_interface = (attribute._dbus_interface

1067

.replace(orig_interface_name,

1068

alt_interface_name))

1665

1069

interface_names.add(alt_interface)

1666

1070

# Is this a D-Bus signal?

1667

1071

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

1668

# Extract the original non-method undecorated

1669

# function by black magic

1670

if sys.version_info.major == 2:

1671

nonmethod_func = (dict(

1072

# Extract the original non-method function by

1073

# black magic

1074

nonmethod_func = (dict(

1672

1075

zip(attribute.func_code.co_freevars,

1673

attribute.__closure__))

1674

["func"].cell_contents)

1675

else:

1676

nonmethod_func = (dict(

1677

zip(attribute.__code__.co_freevars,

1678

attribute.__closure__))

1679

["func"].cell_contents)

1076

attribute.__closure__))["func"]

1077

.cell_contents)

1680

1078

# Create a new, but exactly alike, function

1681

1079

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

1682

1080

# with the alternate D-Bus interface name

1683

new_function = copy_function(nonmethod_func)

1684

new_function = (dbus.service.signal(

1685

alt_interface,

1686

attribute._dbus_signature)(new_function))

1081

new_function = (dbus.service.signal

1082

(alt_interface,

1083

attribute._dbus_signature)

1084

(types.FunctionType(

1085

nonmethod_func.func_code,

1086

nonmethod_func.func_globals,

1087

nonmethod_func.func_name,

1088

nonmethod_func.func_defaults,

1089

nonmethod_func.func_closure)))

1687

1090

# Copy annotations, if any

1688

1091

try:

1689

new_function._dbus_annotations = dict(

1690

attribute._dbus_annotations)

1092

new_function._dbus_annotations = (

1093

dict(attribute._dbus_annotations))

1691

1094

except AttributeError:

1692

1095

pass

1693

1694

1096

# Define a creator of a function to call both the

1695

1097

# original and alternate functions, so both the

1696

1098

# original and alternate signals gets sent when

1699

1101

"""This function is a scope container to pass

1700

1102

func1 and func2 to the "call_both" function

1701

1103

outside of its arguments"""

1702

1703

@functools.wraps(func2)

1704

1104

def call_both(*args, **kwargs):

1705

1105

"""This function will emit two D-Bus

1706

1106

signals by calling func1 and func2"""

1707

1107

func1(*args, **kwargs)

1708

1108

func2(*args, **kwargs)

1709

# Make wrapper function look like a D-Bus

1710

# signal

1711

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

1712

if name.startswith("_dbus_"):

1713

setattr(call_both, name, attr)

1714

1715

1109

return call_both

1716

1110

# Create the "call_both" function and add it to

1717

1111

# the class

1722

1116

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

1723

1117

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

1724

1118

# to the class.

1725

attr[attrname] = (

1726

dbus.service.method(

1727

alt_interface,

1728

attribute._dbus_in_signature,

1729

attribute._dbus_out_signature)

1730

(copy_function(attribute)))

1119

attr[attrname] = (dbus.service.method

1120

(alt_interface,

1121

attribute._dbus_in_signature,

1122

attribute._dbus_out_signature)

1123

(types.FunctionType

1124

(attribute.func_code,

1125

attribute.func_globals,

1126

attribute.func_name,

1127

attribute.func_defaults,

1128

attribute.func_closure)))

1731

1129

# Copy annotations, if any

1732

1130

try:

1733

attr[attrname]._dbus_annotations = dict(

1734

attribute._dbus_annotations)

1131

attr[attrname]._dbus_annotations = (

1132

dict(attribute._dbus_annotations))

1735

1133

except AttributeError:

1736

1134

pass

1737

1135

# Is this a D-Bus property?

1740

1138

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

1741

1139

# property with the alternate D-Bus interface

1742

1140

# name. Add it to the class.

1743

attr[attrname] = (dbus_service_property(

1744

alt_interface, attribute._dbus_signature,

1745

attribute._dbus_access,

1746

attribute._dbus_get_args_options

1747

["byte_arrays"])

1748

(copy_function(attribute)))

1141

attr[attrname] = (dbus_service_property

1142

(alt_interface,

1143

attribute._dbus_signature,

1144

attribute._dbus_access,

1145

attribute

1146

._dbus_get_args_options

1147

["byte_arrays"])

1148

(types.FunctionType

1149

(attribute.func_code,

1150

attribute.func_globals,

1151

attribute.func_name,

1152

attribute.func_defaults,

1153

attribute.func_closure)))

1749

1154

# Copy annotations, if any

1750

1155

try:

1751

attr[attrname]._dbus_annotations = dict(

1752

attribute._dbus_annotations)

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1753

1158

except AttributeError:

1754

1159

pass

1755

1160

# Is this a D-Bus interface?

1758

1163

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

1759

1164

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

1760

1165

# to the class.

1761

attr[attrname] = (

1762

dbus_interface_annotations(alt_interface)

1763

(copy_function(attribute)))

1166

attr[attrname] = (dbus_interface_annotations

1167

(alt_interface)

1168

(types.FunctionType

1169

(attribute.func_code,

1170

attribute.func_globals,

1171

attribute.func_name,

1172

attribute.func_defaults,

1173

attribute.func_closure)))

1764

1174

if deprecate:

1765

1175

# Deprecate all alternate interfaces

1766

iname = "_AlternateDBusNames_interface_annotation{}"

1176

iname="_AlternateDBusNames_interface_annotation{0}"

1767

1177

for interface_name in interface_names:

1768

1769

1178

@dbus_interface_annotations(interface_name)

1770

1179

def func(self):

1771

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

1772

"true"}

1180

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

1181

"true" }

1773

1182

# Find an unused name

1774

1183

for aname in (iname.format(i)

1775

1184

for i in itertools.count()):

1779

1188

if interface_names:

1780

1189

# Replace the class with a new subclass of it with

1781

1190

# methods, signals, etc. as created above.

1782

if sys.version_info.major == 2:

1783

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

1784

(cls, ), attr)

1785

else:

1786

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

1787

(cls, ), attr)

1191

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

1192

(cls,), attr)

1788

1193

return cls

1789

1790

1194

return wrapper

1791

1195

1792

1196

1793

1197

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

1794

"se.bsnet.fukt.Mandos"})

1198

"se.bsnet.fukt.Mandos"})

1795

1199

class ClientDBus(Client, DBusObjectWithProperties):

1796

1200

"""A Client class using D-Bus

1797

1201

1798

1202

Attributes:

1799

1203

dbus_object_path: dbus.ObjectPath

1800

1204

bus: dbus.SystemBus()

1801

1205

"""

1802

1206

1803

1207

runtime_expansions = (Client.runtime_expansions

1804

+ ("dbus_object_path", ))

1805

1806

_interface = "se.recompile.Mandos.Client"

1807

1208

+ ("dbus_object_path",))

1209

1808

1210

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

1809

1810

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

1211

1212

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

1811

1213

self.bus = bus

1812

1214

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

1813

1215

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

1814

1216

# the D-Bus

1815

client_object_name = str(self.name).translate(

1217

client_object_name = unicode(self.name).translate(

1816

1218

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

1817

1219

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

1818

self.dbus_object_path = dbus.ObjectPath(

1819

"/clients/" + client_object_name)

1220

self.dbus_object_path = (dbus.ObjectPath

1221

("/clients/" + client_object_name))

1820

1222

DBusObjectWithProperties.__init__(self, self.bus,

1821

1223

self.dbus_object_path)

1822

1823

def notifychangeproperty(transform_func, dbus_name,

1824

type_func=lambda x: x,

1825

variant_level=1,

1826

invalidate_only=False,

1827

_interface=_interface):

1224

1225

def notifychangeproperty(transform_func,

1226

dbus_name, type_func=lambda x: x,

1227

variant_level=1):

1828

1228

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

1829

1229

its changes to DBus.

1830

1230

1831

1231

transform_fun: Function that takes a value and a variant_level

1832

1232

and transforms it to a D-Bus type.

1833

1233

dbus_name: D-Bus name of the variable

1835

1235

to the D-Bus. Default: no transform

1836

1236

variant_level: D-Bus variant level. Default: 1

1837

1237

"""

1838

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

1839

1238

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

1840

1239

def setter(self, value):

1841

1240

if hasattr(self, "dbus_object_path"):

1842

1241

if (not hasattr(self, attrname) or

1843

1242

type_func(getattr(self, attrname, None))

1844

1243

!= type_func(value)):

1845

if invalidate_only:

1846

self.PropertiesChanged(

1847

_interface, dbus.Dictionary(),

1848

dbus.Array((dbus_name, )))

1849

else:

1850

dbus_value = transform_func(

1851

type_func(value),

1852

variant_level=variant_level)

1853

self.PropertyChanged(dbus.String(dbus_name),

1854

dbus_value)

1855

self.PropertiesChanged(

1856

_interface,

1857

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

1858

dbus_value}),

1859

dbus.Array())

1244

dbus_value = transform_func(type_func(value),

1245

variant_level

1246

=variant_level)

1247

self.PropertyChanged(dbus.String(dbus_name),

1248

dbus_value)

1860

1249

setattr(self, attrname, value)

1861

1250

1862

1251

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

1863

1252

1864

1253

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1865

1254

approvals_pending = notifychangeproperty(dbus.Boolean,

1866

1255

"ApprovalPending",

1867

type_func=bool)

1256

type_func = bool)

1868

1257

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

1869

1258

last_enabled = notifychangeproperty(datetime_to_dbus,

1870

1259

"LastEnabled")

1871

checker = notifychangeproperty(

1872

dbus.Boolean, "CheckerRunning",

1873

type_func=lambda checker: checker is not None)

1260

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

1261

type_func = lambda checker:

1262

checker is not None)

1874

1263

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1875

1264

"LastCheckedOK")

1876

1265

last_checker_status = notifychangeproperty(dbus.Int16,

1879

1268

datetime_to_dbus, "LastApprovalRequest")

1880

1269

approved_by_default = notifychangeproperty(dbus.Boolean,

1881

1270

"ApprovedByDefault")

1882

approval_delay = notifychangeproperty(

1883

dbus.UInt64, "ApprovalDelay",

1884

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

1271

approval_delay = notifychangeproperty(dbus.UInt64,

1272

"ApprovalDelay",

1273

type_func =

1274

timedelta_to_milliseconds)

1885

1275

approval_duration = notifychangeproperty(

1886

1276

dbus.UInt64, "ApprovalDuration",

1887

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

1277

type_func = timedelta_to_milliseconds)

1888

1278

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

1889

timeout = notifychangeproperty(

1890

dbus.UInt64, "Timeout",

1891

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

1279

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

1280

type_func =

1281

timedelta_to_milliseconds)

1892

1282

extended_timeout = notifychangeproperty(

1893

1283

dbus.UInt64, "ExtendedTimeout",

1894

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

1895

interval = notifychangeproperty(

1896

dbus.UInt64, "Interval",

1897

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

1284

type_func = timedelta_to_milliseconds)

1285

interval = notifychangeproperty(dbus.UInt64,

1286

"Interval",

1287

type_func =

1288

timedelta_to_milliseconds)

1898

1289

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

1899

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

1900

invalidate_only=True)

1901

1290

1902

1291

del notifychangeproperty

1903

1292

1904

1293

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

1905

1294

try:

1906

1295

self.remove_from_connection()

1909

1298

if hasattr(DBusObjectWithProperties, "__del__"):

1910

1299

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

1911

1300

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

1912

1913

def checker_callback(self, source, condition,

1914

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

1915

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

1916

connection, command, *args,

1917

**kwargs)

1918

exitstatus = self.last_checker_status

1919

if exitstatus >= 0:

1301

1302

def checker_callback(self, pid, condition, command,

1303

*args, **kwargs):

1304

self.checker_callback_tag = None

1305

self.checker = None

1306

if os.WIFEXITED(condition):

1307

exitstatus = os.WEXITSTATUS(condition)

1920

1308

# Emit D-Bus signal

1921

1309

self.CheckerCompleted(dbus.Int16(exitstatus),

1922

# This is specific to GNU libC

1923

dbus.Int64(exitstatus << 8),

1310

dbus.Int64(condition),

1924

1311

dbus.String(command))

1925

1312

else:

1926

1313

# Emit D-Bus signal

1927

1314

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

1928

dbus.Int64(

1929

# This is specific to GNU libC

1930

(exitstatus << 8)

1931

| self.last_checker_signal),

1315

dbus.Int64(condition),

1932

1316

dbus.String(command))

1933

return ret

1934

1317

1318

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

1319

*args, **kwargs)

1320

1935

1321

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

1936

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

1322

old_checker = self.checker

1323

if self.checker is not None:

1324

old_checker_pid = self.checker.pid

1325

else:

1326

old_checker_pid = None

1937

1327

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

1938

1328

# Only if new checker process was started

1939

1329

if (self.checker is not None

1941

1331

# Emit D-Bus signal

1942

1332

self.CheckerStarted(self.current_checker_command)

1943

1333

return r

1944

1334

1945

1335

def _reset_approved(self):

1946

1336

self.approved = None

1947

1337

return False

1948

1338

1949

1339

def approve(self, value=True):

1950

1340

self.approved = value

1951

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

1952

* 1000), self._reset_approved)

1341

gobject.timeout_add(timedelta_to_milliseconds

1342

(self.approval_duration),

1343

self._reset_approved)

1953

1344

self.send_changedstate()

1954

1955

# D-Bus methods, signals & properties

1956

1957

# Interfaces

1958

1959

# Signals

1960

1345

1346

## D-Bus methods, signals & properties

1347

_interface = "se.recompile.Mandos.Client"

1348

1349

## Interfaces

1350

1351

@dbus_interface_annotations(_interface)

1352

def _foo(self):

1353

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

1354

"false"}

1355

1356

## Signals

1357

1961

1358

# CheckerCompleted - signal

1962

1359

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

1963

1360

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

1964

1361

"D-Bus signal"

1965

1362

pass

1966

1363

1967

1364

# CheckerStarted - signal

1968

1365

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

1969

1366

def CheckerStarted(self, command):

1970

1367

"D-Bus signal"

1971

1368

pass

1972

1369

1973

1370

# PropertyChanged - signal

1974

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

1975

1371

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

1976

1372

def PropertyChanged(self, property, value):

1977

1373

"D-Bus signal"

1978

1374

pass

1979

1375

1980

1376

# GotSecret - signal

1981

1377

@dbus.service.signal(_interface)

1982

1378

def GotSecret(self):

1985

1381

server to mandos-client

1986

1382

"""

1987

1383

pass

1988

1384

1989

1385

# Rejected - signal

1990

1386

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

1991

1387

def Rejected(self, reason):

1992

1388

"D-Bus signal"

1993

1389

pass

1994

1390

1995

1391

# NeedApproval - signal

1996

1392

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

1997

1393

def NeedApproval(self, timeout, default):

1998

1394

"D-Bus signal"

1999

1395

return self.need_approval()

2000

2001

# Methods

2002

1396

1397

## Methods

1398

2003

1399

# Approve - method

2004

1400

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

2005

1401

def Approve(self, value):

2006

1402

self.approve(value)

2007

1403

2008

1404

# CheckedOK - method

2009

1405

@dbus.service.method(_interface)

2010

1406

def CheckedOK(self):

2011

1407

self.checked_ok()

2012

1408

2013

1409

# Enable - method

2014

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

2015

1410

@dbus.service.method(_interface)

2016

1411

def Enable(self):

2017

1412

"D-Bus method"

2018

1413

self.enable()

2019

1414

2020

1415

# StartChecker - method

2021

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

2022

1416

@dbus.service.method(_interface)

2023

1417

def StartChecker(self):

2024

1418

"D-Bus method"

2025

1419

self.start_checker()

2026

1420

2027

1421

# Disable - method

2028

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

2029

1422

@dbus.service.method(_interface)

2030

1423

def Disable(self):

2031

1424

"D-Bus method"

2032

1425

self.disable()

2033

1426

2034

1427

# StopChecker - method

2035

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

2036

1428

@dbus.service.method(_interface)

2037

1429

def StopChecker(self):

2038

1430

self.stop_checker()

2039

2040

# Properties

2041

1431

1432

## Properties

1433

2042

1434

# ApprovalPending - property

2043

1435

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

2044

1436

def ApprovalPending_dbus_property(self):

2045

1437

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

2046

1438

2047

1439

# ApprovedByDefault - property

2048

@dbus_service_property(_interface,

2049

signature="b",

1440

@dbus_service_property(_interface, signature="b",

2050

1441

access="readwrite")

2051

1442

def ApprovedByDefault_dbus_property(self, value=None):

2052

1443

if value is None: # get

2053

1444

return dbus.Boolean(self.approved_by_default)

2054

1445

self.approved_by_default = bool(value)

2055

1446

2056

1447

# ApprovalDelay - property

2057

@dbus_service_property(_interface,

2058

signature="t",

1448

@dbus_service_property(_interface, signature="t",

2059

1449

access="readwrite")

2060

1450

def ApprovalDelay_dbus_property(self, value=None):

2061

1451

if value is None: # get

2062

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

2063

* 1000)

1452

return dbus.UInt64(self.approval_delay_milliseconds())

2064

1453

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

2065

1454

2066

1455

# ApprovalDuration - property

2067

@dbus_service_property(_interface,

2068

signature="t",

1456

@dbus_service_property(_interface, signature="t",

2069

1457

access="readwrite")

2070

1458

def ApprovalDuration_dbus_property(self, value=None):

2071

1459

if value is None: # get

2072

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

2073

* 1000)

1460

return dbus.UInt64(timedelta_to_milliseconds(

1461

self.approval_duration))

2074

1462

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

2075

1463

2076

1464

# Name - property

2077

@dbus_annotations(

2078

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

2079

1465

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

2080

1466

def Name_dbus_property(self):

2081

1467

return dbus.String(self.name)

2082

2083

# KeyID - property

2084

@dbus_annotations(

2085

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

2086

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

2087

def KeyID_dbus_property(self):

2088

return dbus.String(self.key_id)

2089

1468

2090

1469

# Fingerprint - property

2091

@dbus_annotations(

2092

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

2093

1470

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

2094

1471

def Fingerprint_dbus_property(self):

2095

1472

return dbus.String(self.fingerprint)

2096

1473

2097

1474

# Host - property

2098

@dbus_service_property(_interface,

2099

signature="s",

1475

@dbus_service_property(_interface, signature="s",

2100

1476

access="readwrite")

2101

1477

def Host_dbus_property(self, value=None):

2102

1478

if value is None: # get

2103

1479

return dbus.String(self.host)

2104

self.host = str(value)

2105

1480

self.host = unicode(value)

1481

2106

1482

# Created - property

2107

@dbus_annotations(

2108

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

2109

1483

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

2110

1484

def Created_dbus_property(self):

2111

1485

return datetime_to_dbus(self.created)

2112

1486

2113

1487

# LastEnabled - property

2114

1488

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

2115

1489

def LastEnabled_dbus_property(self):

2116

1490

return datetime_to_dbus(self.last_enabled)

2117

1491

2118

1492

# Enabled - property

2119

@dbus_service_property(_interface,

2120

signature="b",

1493

@dbus_service_property(_interface, signature="b",

2121

1494

access="readwrite")

2122

1495

def Enabled_dbus_property(self, value=None):

2123

1496

if value is None: # get

2126

1499

self.enable()

2127

1500

else:

2128

1501

self.disable()

2129

1502

2130

1503

# LastCheckedOK - property

2131

@dbus_service_property(_interface,

2132

signature="s",

1504

@dbus_service_property(_interface, signature="s",

2133

1505

access="readwrite")

2134

1506

def LastCheckedOK_dbus_property(self, value=None):

2135

1507

if value is not None:

2136

1508

self.checked_ok()

2137

1509

return

2138

1510

return datetime_to_dbus(self.last_checked_ok)

2139

1511

2140

1512

# LastCheckerStatus - property

2141

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

1513

@dbus_service_property(_interface, signature="n",

1514

access="read")

2142

1515

def LastCheckerStatus_dbus_property(self):

2143

1516

return dbus.Int16(self.last_checker_status)

2144

1517

2145

1518

# Expires - property

2146

1519

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

2147

1520

def Expires_dbus_property(self):

2148

1521

return datetime_to_dbus(self.expires)

2149

1522

2150

1523

# LastApprovalRequest - property

2151

1524

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

2152

1525

def LastApprovalRequest_dbus_property(self):

2153

1526

return datetime_to_dbus(self.last_approval_request)

2154

1527

2155

1528

# Timeout - property

2156

@dbus_service_property(_interface,

2157

signature="t",

1529

@dbus_service_property(_interface, signature="t",

2158

1530

access="readwrite")

2159

1531

def Timeout_dbus_property(self, value=None):

2160

1532

if value is None: # get

2161

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

1533

return dbus.UInt64(self.timeout_milliseconds())

2162

1534

old_timeout = self.timeout

2163

1535

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

2164

1536

# Reschedule disabling

2172

1544

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

2173

1545

is None):

2174

1546

return

2175

GLib.source_remove(self.disable_initiator_tag)

2176

self.disable_initiator_tag = GLib.timeout_add(

2177

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

2178

self.disable)

2179

1547

gobject.source_remove(self.disable_initiator_tag)

1548

self.disable_initiator_tag = (

1549

gobject.timeout_add(

1550

timedelta_to_milliseconds(self.expires - now),

1551

self.disable))

1552

2180

1553

# ExtendedTimeout - property

2181

@dbus_service_property(_interface,

2182

signature="t",

1554

@dbus_service_property(_interface, signature="t",

2183

1555

access="readwrite")

2184

1556

def ExtendedTimeout_dbus_property(self, value=None):

2185

1557

if value is None: # get

2186

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

2187

* 1000)

1558

return dbus.UInt64(self.extended_timeout_milliseconds())

2188

1559

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

2189

1560

2190

1561

# Interval - property

2191

@dbus_service_property(_interface,

2192

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2193

1563

access="readwrite")

2194

1564

def Interval_dbus_property(self, value=None):

2195

1565

if value is None: # get

2196

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

1566

return dbus.UInt64(self.interval_milliseconds())

2197

1567

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

2198

1568

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

2199

1569

return

2200

1570

if self.enabled:

2201

1571

# Reschedule checker run

2202

GLib.source_remove(self.checker_initiator_tag)

2203

self.checker_initiator_tag = GLib.timeout_add(

2204

value, self.start_checker)

2205

self.start_checker() # Start one now, too

2206

1572

gobject.source_remove(self.checker_initiator_tag)

1573

self.checker_initiator_tag = (gobject.timeout_add

1574

(value, self.start_checker))

1575

self.start_checker() # Start one now, too

1576

2207

1577

# Checker - property

2208

@dbus_service_property(_interface,

2209

signature="s",

1578

@dbus_service_property(_interface, signature="s",

2210

1579

access="readwrite")

2211

1580

def Checker_dbus_property(self, value=None):

2212

1581

if value is None: # get

2213

1582

return dbus.String(self.checker_command)

2214

self.checker_command = str(value)

2215

1583

self.checker_command = unicode(value)

1584

2216

1585

# CheckerRunning - property

2217

@dbus_service_property(_interface,

2218

signature="b",

1586

@dbus_service_property(_interface, signature="b",

2219

1587

access="readwrite")

2220

1588

def CheckerRunning_dbus_property(self, value=None):

2221

1589

if value is None: # get

2224

1592

self.start_checker()

2225

1593

else:

2226

1594

self.stop_checker()

2227

1595

2228

1596

# ObjectPath - property

2229

@dbus_annotations(

2230

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

2231

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

2232

1597

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

2233

1598

def ObjectPath_dbus_property(self):

2234

return self.dbus_object_path # is already a dbus.ObjectPath

2235

1599

return self.dbus_object_path # is already a dbus.ObjectPath

1600

2236

1601

# Secret = property

2237

@dbus_annotations(

2238

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

2239

"invalidates"})

2240

@dbus_service_property(_interface,

2241

signature="ay",

2242

access="write",

2243

byte_arrays=True)

1602

@dbus_service_property(_interface, signature="ay",

1603

access="write", byte_arrays=True)

2244

1604

def Secret_dbus_property(self, value):

2245

self.secret = bytes(value)

2246

1605

self.secret = str(value)

1606

2247

1607

del _interface

2248

1608

2249

1609

2250

class ProxyClient:

2251

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

1610

class ProxyClient(object):

1611

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

2252

1612

self._pipe = child_pipe

2253

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

1613

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

2254

1614

if not self._pipe.recv():

2255

raise KeyError(key_id or fpr)

2256

1615

raise KeyError()

1616

2257

1617

def __getattribute__(self, name):

2258

1618

if name == '_pipe':

2259

1619

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

2262

1622

if data[0] == 'data':

2263

1623

return data[1]

2264

1624

if data[0] == 'function':

2265

2266

1625

def func(*args, **kwargs):

2267

1626

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

2268

1627

return self._pipe.recv()[1]

2269

2270

1628

return func

2271

1629

2272

1630

def __setattr__(self, name, value):

2273

1631

if name == '_pipe':

2274

1632

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

2277

1635

2278

1636

class ClientHandler(socketserver.BaseRequestHandler, object):

2279

1637

"""A class to handle client connections.

2280

1638

2281

1639

Instantiated once for each connection to handle it.

2282

1640

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

2283

1641

2284

1642

def handle(self):

2285

1643

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

2286

1644

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

2287

str(self.client_address))

1645

unicode(self.client_address))

2288

1646

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

2289

1647

self.server.child_pipe.fileno())

2290

2291

session = gnutls.ClientSession(self.request)

2292

2293

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

2294

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

2295

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

2296

# "+DHE-DSS"))

1648

1649

session = (gnutls.connection

1650

.ClientSession(self.request,

1651

gnutls.connection

1652

.X509Credentials()))

1653

1654

# Note: gnutls.connection.X509Credentials is really a

1655

# generic GnuTLS certificate credentials object so long as

1656

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

1657

# here despite using OpenPGP certificates.

1658

1659

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

1660

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

1661

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

1662

# "+DHE-DSS"))

2297

1663

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

2298

1664

priority = self.server.gnutls_priority

2299

1665

if priority is None:

2300

1666

priority = "NORMAL"

2301

gnutls.priority_set_direct(session._c_object,

2302

priority.encode("utf-8"),

2303

None)

2304

1667

(gnutls.library.functions

1668

.gnutls_priority_set_direct(session._c_object,

1669

priority, None))

1670

2305

1671

# Start communication using the Mandos protocol

2306

1672

# Get protocol number

2307

1673

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

2308

1674

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

2309

1675

try:

2310

1676

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

2311

raise RuntimeError(line)

1677

raise RuntimeError

2312

1678

except (ValueError, IndexError, RuntimeError) as error:

2313

1679

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

2314

1680

return

2315

1681

2316

1682

# Start GnuTLS connection

2317

1683

try:

2318

1684

session.handshake()

2319

except gnutls.Error as error:

1685

except gnutls.errors.GNUTLSError as error:

2320

1686

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

2321

1687

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

2322

1688

# established. Just abandon the request.

2323

1689

return

2324

1690

logger.debug("Handshake succeeded")

2325

1691

2326

1692

approval_required = False

2327

1693

try:

2328

if gnutls.has_rawpk:

2329

fpr = b""

2330

try:

2331

key_id = self.key_id(

2332

self.peer_certificate(session))

2333

except (TypeError, gnutls.Error) as error:

2334

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

2335

return

2336

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

2337

2338

else:

2339

key_id = b""

2340

try:

2341

fpr = self.fingerprint(

2342

self.peer_certificate(session))

2343

except (TypeError, gnutls.Error) as error:

2344

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

2345

return

2346

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

2347

2348

try:

2349

client = ProxyClient(child_pipe, key_id, fpr,

1694

try:

1695

fpr = self.fingerprint(self.peer_certificate

1696

(session))

1697

except (TypeError,

1698

gnutls.errors.GNUTLSError) as error:

1699

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

1700

return

1701

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

1702

1703

try:

1704

client = ProxyClient(child_pipe, fpr,

2350

1705

self.client_address)

2351

1706

except KeyError:

2352

1707

return

2353

1708

2354

1709

if client.approval_delay:

2355

1710

delay = client.approval_delay

2356

1711

client.approvals_pending += 1

2357

1712

approval_required = True

2358

1713

2359

1714

while True:

2360

1715

if not client.enabled:

2361

1716

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

2362

client.name)

1717

client.name)

2363

1718

if self.server.use_dbus:

2364

1719

# Emit D-Bus signal

2365

1720

client.Rejected("Disabled")

2366

1721

return

2367

1722

2368

1723

if client.approved or not client.approval_delay:

2369

# We are approved or approval is disabled

1724

#We are approved or approval is disabled

2370

1725

break

2371

1726

elif client.approved is None:

2372

1727

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

2374

1729

if self.server.use_dbus:

2375

1730

# Emit D-Bus signal

2376

1731

client.NeedApproval(

2377

client.approval_delay.total_seconds()

2378

* 1000, client.approved_by_default)

1732

client.approval_delay_milliseconds(),

1733

client.approved_by_default)

2379

1734

else:

2380

1735

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

2381

1736

client.name)

2383

1738

# Emit D-Bus signal

2384

1739

client.Rejected("Denied")

2385

1740

return

2386

2387

# wait until timeout or approved

1741

1742

#wait until timeout or approved

2388

1743

time = datetime.datetime.now()

2389

1744

client.changedstate.acquire()

2390

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

1745

client.changedstate.wait(

1746

float(timedelta_to_milliseconds(delay)

1747

/ 1000))

2391

1748

client.changedstate.release()

2392

1749

time2 = datetime.datetime.now()

2393

1750

if (time2 - time) >= delay:

2403

1760

break

2404

1761

else:

2405

1762

delay -= time2 - time

2406

2407

try:

2408

session.send(client.secret)

2409

except gnutls.Error as error:

2410

logger.warning("gnutls send failed",

2411

exc_info=error)

2412

return

2413

1763

1764

sent_size = 0

1765

while sent_size < len(client.secret):

1766

try:

1767

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

1768

except gnutls.errors.GNUTLSError as error:

1769

logger.warning("gnutls send failed",

1770

exc_info=error)

1771

return

1772

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

1773

sent, len(client.secret)

1774

- (sent_size + sent))

1775

sent_size += sent

1776

2414

1777

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

2415

1778

# bump the timeout using extended_timeout

2416

1779

client.bump_timeout(client.extended_timeout)

2417

1780

if self.server.use_dbus:

2418

1781

# Emit D-Bus signal

2419

1782

client.GotSecret()

2420

1783

2421

1784

finally:

2422

1785

if approval_required:

2423

1786

client.approvals_pending -= 1

2424

1787

try:

2425

1788

session.bye()

2426

except gnutls.Error as error:

1789

except gnutls.errors.GNUTLSError as error:

2427

1790

logger.warning("GnuTLS bye failed",

2428

1791

exc_info=error)

2429

1792

2430

1793

@staticmethod

2431

1794

def peer_certificate(session):

2432

"Return the peer's certificate as a bytestring"

2433

try:

2434

cert_type = gnutls.certificate_type_get2(session._c_object,

2435

gnutls.CTYPE_PEERS)

2436

except AttributeError:

2437

cert_type = gnutls.certificate_type_get(session._c_object)

2438

if gnutls.has_rawpk:

2439

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2440

else:

2441

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2442

# If not a valid certificate type...

2443

if cert_type not in valid_cert_types:

2444

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

2445

valid_cert_types)

2446

# ...return invalid data

2447

return b""

1795

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

1796

# If not an OpenPGP certificate...

1797

if (gnutls.library.functions

1798

.gnutls_certificate_type_get(session._c_object)

1799

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1800

# ...do the normal thing

1801

return session.peer_certificate

2448

1802

list_size = ctypes.c_uint(1)

2449

cert_list = (gnutls.certificate_get_peers

1803

cert_list = (gnutls.library.functions

1804

.gnutls_certificate_get_peers

2450

1805

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

2451

1806

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

2452

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

1807

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

1808

" certificate")

2453

1809

if list_size.value == 0:

2454

1810

return None

2455

1811

cert = cert_list[0]

2456

1812

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

2457

2458

@staticmethod

2459

def key_id(certificate):

2460

"Convert a certificate bytestring to a hexdigit key ID"

2461

# New GnuTLS "datum" with the public key

2462

datum = gnutls.datum_t(

2463

ctypes.cast(ctypes.c_char_p(certificate),

2464

ctypes.POINTER(ctypes.c_ubyte)),

2465

ctypes.c_uint(len(certificate)))

2466

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

2467

# New empty GnuTLS certificate

2468

pubkey = gnutls.pubkey_t()

2469

gnutls.pubkey_init(ctypes.byref(pubkey))

2470

# Import the raw public key into the certificate

2471

gnutls.pubkey_import(pubkey,

2472

ctypes.byref(datum),

2473

gnutls.X509_FMT_DER)

2474

# New buffer for the key ID

2475

buf = ctypes.create_string_buffer(32)

2476

buf_len = ctypes.c_size_t(len(buf))

2477

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

2478

gnutls.pubkey_get_key_id(

2479

pubkey,

2480

gnutls.KEYID_USE_SHA256,

2481

ctypes.cast(ctypes.byref(buf),

2482

ctypes.POINTER(ctypes.c_ubyte)),

2483

ctypes.byref(buf_len))

2484

# Deinit the certificate

2485

gnutls.pubkey_deinit(pubkey)

2486

2487

# Convert the buffer to a Python bytestring

2488

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

2489

# Convert the bytestring to hexadecimal notation

2490

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

2491

return hex_key_id

2492

1813

2493

1814

@staticmethod

2494

1815

def fingerprint(openpgp):

2495

1816

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2496

1817

# New GnuTLS "datum" with the OpenPGP public key

2497

datum = gnutls.datum_t(

2498

ctypes.cast(ctypes.c_char_p(openpgp),

2499

ctypes.POINTER(ctypes.c_ubyte)),

2500

ctypes.c_uint(len(openpgp)))

1818

datum = (gnutls.library.types

1819

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

1820

ctypes.POINTER

1821

(ctypes.c_ubyte)),

1822

ctypes.c_uint(len(openpgp))))

2501

1823

# New empty GnuTLS certificate

2502

crt = gnutls.openpgp_crt_t()

2503

gnutls.openpgp_crt_init(ctypes.byref(crt))

1824

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1825

(gnutls.library.functions

1826

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2504

1827

# Import the OpenPGP public key into the certificate

2505

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

2506

gnutls.OPENPGP_FMT_RAW)

1828

(gnutls.library.functions

1829

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

1830

gnutls.library.constants

1831

.GNUTLS_OPENPGP_FMT_RAW))

2507

1832

# Verify the self signature in the key

2508

1833

crtverify = ctypes.c_uint()

2509

gnutls.openpgp_crt_verify_self(crt, 0,

2510

ctypes.byref(crtverify))

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_verify_self(crt, 0,

1836

ctypes.byref(crtverify)))

2511

1837

if crtverify.value != 0:

2512

gnutls.openpgp_crt_deinit(crt)

2513

raise gnutls.CertificateSecurityError(code

2514

=crtverify.value)

1838

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1839

raise (gnutls.errors.CertificateSecurityError

1840

("Verify failed"))

2515

1841

# New buffer for the fingerprint

2516

1842

buf = ctypes.create_string_buffer(20)

2517

1843

buf_len = ctypes.c_size_t()

2518

1844

# Get the fingerprint from the certificate into the buffer

2519

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

2520

ctypes.byref(buf_len))

1845

(gnutls.library.functions

1846

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

1847

ctypes.byref(buf_len)))

2521

1848

# Deinit the certificate

2522

gnutls.openpgp_crt_deinit(crt)

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2523

1850

# Convert the buffer to a Python bytestring

2524

1851

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

2525

1852

# Convert the bytestring to hexadecimal notation

2527

1854

return hex_fpr

2528

1855

2529

1856

2530

class MultiprocessingMixIn:

1857

class MultiprocessingMixIn(object):

2531

1858

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

2532

2533

1859

def sub_process_main(self, request, address):

2534

1860

try:

2535

1861

self.finish_request(request, address)

2536

1862

except Exception:

2537

1863

self.handle_error(request, address)

2538

1864

self.close_request(request)

2539

1865

2540

1866

def process_request(self, request, address):

2541

1867

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

2542

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

2543

args=(request, address))

1868

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

1869

args = (request, address))

2544

1870

proc.start()

2545

1871

return proc

2546

1872

2547

1873

2548

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1874

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2549

1875

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

2550

2551

1876

def process_request(self, request, client_address):

2552

1877

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

2553

1878

2554

1879

This function creates a new pipe in self.pipe

2555

1880

"""

2556

1881

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2557

1882

2558

1883

proc = MultiprocessingMixIn.process_request(self, request,

2559

1884

client_address)

2560

1885

self.child_pipe.close()

2561

1886

self.add_pipe(parent_pipe, proc)

2562

1887

2563

1888

def add_pipe(self, parent_pipe, proc):

2564

1889

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

2565

raise NotImplementedError()

1890

raise NotImplementedError

2566

1891

2567

1892

2568

1893

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2569

socketserver.TCPServer):

1894

socketserver.TCPServer, object):

2570

1895

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

2571

1896

2572

1897

Attributes:

2573

1898

enabled: Boolean; whether this server is activated yet

2574

1899

interface: None or a network interface name (string)

2575

1900

use_ipv6: Boolean; to use IPv6 or not

2576

1901

"""

2577

2578

1902

def __init__(self, server_address, RequestHandlerClass,

2579

interface=None,

2580

use_ipv6=True,

2581

socketfd=None):

1903

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

2582

1904

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

2583

1905

creating a new one with socket.socket().

2584

1906

"""

2590

1912

self.socketfd = socketfd

2591

1913

# Save the original socket.socket() function

2592

1914

self.socket_socket = socket.socket

2593

2594

1915

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

2595

#

1916

#

2596

1917

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

2597

1918

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

2598

1919

# patching socket.socket.)

2599

#

1920

#

2600

1921

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

2601

1922

@functools.wraps(socket.socket)

2602

1923

def socket_wrapper(*args, **kwargs):

2614

1935

# socket_wrapper(), if socketfd was set.

2615

1936

socketserver.TCPServer.__init__(self, server_address,

2616

1937

RequestHandlerClass)

2617

1938

2618

1939

def server_bind(self):

2619

1940

"""This overrides the normal server_bind() function

2620

1941

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

2621

1942

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

2622

global SO_BINDTODEVICE

2623

1943

if self.interface is not None:

2624

1944

if SO_BINDTODEVICE is None:

2625

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

2626

# common enough.

2627

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

2628

SO_BINDTODEVICE = 25

2629

try:

2630

self.socket.setsockopt(

2631

socket.SOL_SOCKET, SO_BINDTODEVICE,

2632

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

2633

except socket.error as error:

2634

if error.errno == errno.EPERM:

2635

logger.error("No permission to bind to"

2636

" interface %s", self.interface)

2637

elif error.errno == errno.ENOPROTOOPT:

2638

logger.error("SO_BINDTODEVICE not available;"

2639

" cannot bind to interface %s",

2640

self.interface)

2641

elif error.errno == errno.ENODEV:

2642

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

2643

" cannot bind", self.interface)

2644

else:

2645

raise

1945

logger.error("SO_BINDTODEVICE does not exist;"

1946

" cannot bind to interface %s",

1947

self.interface)

1948

else:

1949

try:

1950

self.socket.setsockopt(socket.SOL_SOCKET,

1951

SO_BINDTODEVICE,

1952

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

1953

except socket.error as error:

1954

if error.errno == errno.EPERM:

1955

logger.error("No permission to bind to"

1956

" interface %s", self.interface)

1957

elif error.errno == errno.ENOPROTOOPT:

1958

logger.error("SO_BINDTODEVICE not available;"

1959

" cannot bind to interface %s",

1960

self.interface)

1961

elif error.errno == errno.ENODEV:

1962

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

1963

" cannot bind", self.interface)

1964

else:

1965

raise

2646

1966

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

2647

1967

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

2648

if self.server_address[1]:

2649

self.allow_reuse_address = True

2650

1968

if not self.server_address[0]:

2651

1969

if self.address_family == socket.AF_INET6:

2652

any_address = "::" # in6addr_any

1970

any_address = "::" # in6addr_any

2653

1971

else:

2654

any_address = "0.0.0.0" # INADDR_ANY

1972

any_address = socket.INADDR_ANY

2655

1973

self.server_address = (any_address,

2656

1974

self.server_address[1])

2657

1975

elif not self.server_address[1]:

2658

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

1976

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

1977

0)

2659

1978

# if self.interface:

2660

1979

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

2661

1980

# 0, # port

2667

1986

2668

1987

class MandosServer(IPv6_TCPServer):

2669

1988

"""Mandos server.

2670

1989

2671

1990

Attributes:

2672

1991

clients: set of Client objects

2673

1992

gnutls_priority GnuTLS priority string

2674

1993

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

2675

2676

Assumes a GLib.MainLoop event loop.

1994

1995

Assumes a gobject.MainLoop event loop.

2677

1996

"""

2678

2679

1997

def __init__(self, server_address, RequestHandlerClass,

2680

interface=None,

2681

use_ipv6=True,

2682

clients=None,

2683

gnutls_priority=None,

2684

use_dbus=True,

2685

socketfd=None):

1998

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

1999

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

2686

2000

self.enabled = False

2687

2001

self.clients = clients

2688

2002

if self.clients is None:

2691

2005

self.gnutls_priority = gnutls_priority

2692

2006

IPv6_TCPServer.__init__(self, server_address,

2693

2007

RequestHandlerClass,

2694

interface=interface,

2695

use_ipv6=use_ipv6,

2696

socketfd=socketfd)

2697

2008

interface = interface,

2009

use_ipv6 = use_ipv6,

2010

socketfd = socketfd)

2698

2011

def server_activate(self):

2699

2012

if self.enabled:

2700

2013

return socketserver.TCPServer.server_activate(self)

2701

2014

2702

2015

def enable(self):

2703

2016

self.enabled = True

2704

2017

2705

2018

def add_pipe(self, parent_pipe, proc):

2706

2019

# Call "handle_ipc" for both data and EOF events

2707

GLib.io_add_watch(

2708

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

2709

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

2710

functools.partial(self.handle_ipc,

2711

parent_pipe=parent_pipe,

2712

proc=proc))

2713

2714

def handle_ipc(self, source, condition,

2715

parent_pipe=None,

2716

proc=None,

2717

client_object=None):

2020

gobject.io_add_watch(parent_pipe.fileno(),

2021

gobject.IO_IN | gobject.IO_HUP,

2022

functools.partial(self.handle_ipc,

2023

parent_pipe =

2024

parent_pipe,

2025

proc = proc))

2026

2027

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

2028

proc = None, client_object=None):

2718

2029

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

2719

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

2030

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

2720

2031

# Wait for other process to exit

2721

2032

proc.join()

2722

2033

return False

2723

2034

2724

2035

# Read a request from the child

2725

2036

request = parent_pipe.recv()

2726

2037

command = request[0]

2727

2038

2728

2039

if command == 'init':

2729

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

2730

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

2731

address = request[3]

2732

2733

for c in self.clients.values():

2734

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2735

"27AE41E4649B934CA495991B7852B855"):

2736

continue

2737

if key_id and c.key_id == key_id:

2738

client = c

2739

break

2740

if fpr and c.fingerprint == fpr:

2040

fpr = request[1]

2041

address = request[2]

2042

2043

for c in self.clients.itervalues():

2044

if c.fingerprint == fpr:

2741

2045

client = c

2742

2046

break

2743

2047

else:

2744

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

2745

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

2048

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

2049

"dress: %s", fpr, address)

2746

2050

if self.use_dbus:

2747

2051

# Emit D-Bus signal

2748

mandos_dbus_service.ClientNotFound(key_id or fpr,

2052

mandos_dbus_service.ClientNotFound(fpr,

2749

2053

address[0])

2750

2054

parent_pipe.send(False)

2751

2055

return False

2752

2753

GLib.io_add_watch(

2754

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

2755

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

2756

functools.partial(self.handle_ipc,

2757

parent_pipe=parent_pipe,

2758

proc=proc,

2759

client_object=client))

2056

2057

gobject.io_add_watch(parent_pipe.fileno(),

2058

gobject.IO_IN | gobject.IO_HUP,

2059

functools.partial(self.handle_ipc,

2060

parent_pipe =

2061

parent_pipe,

2062

proc = proc,

2063

client_object =

2064

client))

2760

2065

parent_pipe.send(True)

2761

2066

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

2762

2067

# same fileno

2765

2070

funcname = request[1]

2766

2071

args = request[2]

2767

2072

kwargs = request[3]

2768

2073

2769

2074

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

2770

2075

funcname)(*args,

2771

**kwargs)))

2772

2076

**kwargs)))

2077

2773

2078

if command == 'getattr':

2774

2079

attrname = request[1]

2775

if isinstance(client_object.__getattribute__(attrname),

2776

collections.abc.Callable):

2777

parent_pipe.send(('function', ))

2080

if callable(client_object.__getattribute__(attrname)):

2081

parent_pipe.send(('function',))

2778

2082

else:

2779

parent_pipe.send((

2780

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

2781

2083

parent_pipe.send(('data', client_object

2084

.__getattribute__(attrname)))

2085

2782

2086

if command == 'setattr':

2783

2087

attrname = request[1]

2784

2088

value = request[2]

2785

2089

setattr(client_object, attrname, value)

2786

2090

2787

2091

return True

2788

2092

2789

2093

2790

2094

def rfc3339_duration_to_delta(duration):

2791

2095

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

2792

2793

>>> timedelta = datetime.timedelta

2794

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

2795

True

2796

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

2797

True

2798

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

2799

True

2800

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

2801

True

2802

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

2803

True

2804

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

2805

True

2806

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

2807

True

2808

>>> del timedelta

2096

2097

>>> rfc3339_duration_to_delta("P7D")

2098

datetime.timedelta(7)

2099

>>> rfc3339_duration_to_delta("PT60S")

2100

datetime.timedelta(0, 60)

2101

>>> rfc3339_duration_to_delta("PT60M")

2102

datetime.timedelta(0, 3600)

2103

>>> rfc3339_duration_to_delta("PT24H")

2104

datetime.timedelta(1)

2105

>>> rfc3339_duration_to_delta("P1W")

2106

datetime.timedelta(7)

2107

>>> rfc3339_duration_to_delta("PT5M30S")

2108

datetime.timedelta(0, 330)

2109

>>> rfc3339_duration_to_delta("P1DT3M20S")

2110

datetime.timedelta(1, 200)

2809

2111

"""

2810

2112

2811

2113

# Parsing an RFC 3339 duration with regular expressions is not

2812

2114

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

2813

2115

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

2814

2116

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

2815

2117

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

2816

2118

# avoid excessive use of external libraries.

2817

2119

2818

2120

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

2819

Token = collections.namedtuple("Token", (

2820

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

2821

# a "group" containing digits

2822

"value", # datetime.timedelta or None

2823

"followers")) # Tokens valid after this token

2121

Token = collections.namedtuple("Token",

2122

("regexp", # To match token; if

2123

# "value" is not None,

2124

# must have a "group"

2125

# containing digits

2126

"value", # datetime.timedelta or

2127

# None

2128

"followers")) # Tokens valid after

2129

# this token

2824

2130

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

2825

2131

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

2826

2132

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

2827

2133

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

2828

2134

datetime.timedelta(seconds=1),

2829

frozenset((token_end, )))

2135

frozenset((token_end,)))

2830

2136

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

2831

2137

datetime.timedelta(minutes=1),

2832

2138

frozenset((token_second, token_end)))

2848

2154

frozenset((token_month, token_end)))

2849

2155

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

2850

2156

datetime.timedelta(weeks=1),

2851

frozenset((token_end, )))

2157

frozenset((token_end,)))

2852

2158

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

2853

2159

frozenset((token_year, token_month,

2854

2160

token_day, token_time,

2855

token_week)))

2856

# Define starting values:

2857

# Value so far

2858

value = datetime.timedelta()

2161

token_week))),

2162

# Define starting values

2163

value = datetime.timedelta() # Value so far

2859

2164

found_token = None

2860

# Following valid tokens

2861

followers = frozenset((token_duration, ))

2862

# String left to parse

2863

s = duration

2165

followers = frozenset(token_duration,) # Following valid tokens

2166

s = duration # String left to parse

2864

2167

# Loop until end token is found

2865

2168

while found_token is not token_end:

2866

2169

# Search for any currently valid tokens

2882

2185

break

2883

2186

else:

2884

2187

# No currently valid tokens were found

2885

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

2886

.format(duration))

2188

raise ValueError("Invalid RFC 3339 duration")

2887

2189

# End token found

2888

2190

return value

2889

2191

2890

2192

2891

2193

def string_to_delta(interval):

2892

2194

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

2893

2894

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

2895

True

2896

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

2897

True

2898

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

2899

True

2900

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

2901

True

2902

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

2903

True

2904

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

2905

True

2195

2196

>>> string_to_delta('7d')

2197

datetime.timedelta(7)

2198

>>> string_to_delta('60s')

2199

datetime.timedelta(0, 60)

2200

>>> string_to_delta('60m')

2201

datetime.timedelta(0, 3600)

2202

>>> string_to_delta('24h')

2203

datetime.timedelta(1)

2204

>>> string_to_delta('1w')

2205

datetime.timedelta(7)

2206

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

2207

datetime.timedelta(0, 330)

2906

2208

"""

2907

2209

2908

2210

try:

2909

2211

return rfc3339_duration_to_delta(interval)

2910

2212

except ValueError:

2911

2213

pass

2912

2214

2913

2215

timevalue = datetime.timedelta(0)

2914

2216

for s in interval.split():

2915

2217

try:

2916

suffix = s[-1]

2218

suffix = unicode(s[-1])

2917

2219

value = int(s[:-1])

2918

2220

if suffix == "d":

2919

2221

delta = datetime.timedelta(value)

2926

2228

elif suffix == "w":

2927

2229

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

2928

2230

else:

2929

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

2930

except IndexError as e:

2231

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

2232

.format(suffix))

2233

except (ValueError, IndexError) as e:

2931

2234

raise ValueError(*(e.args))

2932

2235

timevalue += delta

2933

2236

return timevalue

2934

2237

2935

2238

2936

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

2239

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

2937

2240

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

2938

2241

2939

2242

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

2940

2243

if os.fork():

2941

2244

sys.exit()

2949

2252

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

2950

2253

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

2951

2254

raise OSError(errno.ENODEV,

2952

"{} not a character device"

2255

"{0} not a character device"

2953

2256

.format(os.devnull))

2954

2257

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

2955

2258

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

2959

2262

2960

2263

2961

2264

def main():

2962

2265

2963

2266

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

2964

2267

# Parsing of options, both command line and config file

2965

2268

2966

2269

parser = argparse.ArgumentParser()

2967

2270

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

2968

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

2271

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

2969

2272

help="show version number and exit")

2970

2273

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

2971

2274

help="Bind to interface IF")

2977

2280

help="Run self-test")

2978

2281

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

2979

2282

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

2980

" to terminal", default=None)

2283

" to terminal")

2981

2284

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

2982

2285

help="Debug level for stdout output")

2983

2286

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

2990

2293

" files")

2991

2294

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

2992

2295

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

2993

" system bus interface", default=None)

2296

" system bus interface")

2994

2297

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

2995

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

2996

default=None)

2298

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

2997

2299

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

2998

2300

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

2999

" state", default=None)

2301

" state")

3000

2302

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

3001

2303

help="Specify a file descriptor to a network"

3002

2304

" socket to use instead of creating one")

3003

2305

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

3004

2306

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

3005

2307

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

3006

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

3007

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

3008

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

3009

default=None)

3010

2308

help="Run in foreground")

2309

3011

2310

options = parser.parse_args()

3012

2311

2312

if options.check:

2313

import doctest

2314

doctest.testmod()

2315

sys.exit()

2316

3013

2317

# Default values for config file for server-global settings

3014

if gnutls.has_rawpk:

3015

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

3016

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

3017

else:

3018

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

3019

":+SIGN-DSA-SHA256")

3020

server_defaults = {"interface": "",

3021

"address": "",

3022

"port": "",

3023

"debug": "False",

3024

"priority": priority,

3025

"servicename": "Mandos",

3026

"use_dbus": "True",

3027

"use_ipv6": "True",

3028

"debuglevel": "",

3029

"restore": "True",

3030

"socket": "",

3031

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

3032

"foreground": "False",

3033

"zeroconf": "True",

3034

}

3035

del priority

3036

2318

server_defaults = { "interface": "",

2319

"address": "",

2320

"port": "",

2321

"debug": "False",

2322

"priority":

2323

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

2324

"servicename": "Mandos",

2325

"use_dbus": "True",

2326

"use_ipv6": "True",

2327

"debuglevel": "",

2328

"restore": "True",

2329

"socket": "",

2330

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

2331

"foreground": "False",

2332

}

2333

3037

2334

# Parse config file for server-global settings

3038

server_config = configparser.ConfigParser(server_defaults)

2335

server_config = configparser.SafeConfigParser(server_defaults)

3039

2336

del server_defaults

3040

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

3041

# Convert the ConfigParser object to a dict

2337

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

2338

"mandos.conf"))

2339

# Convert the SafeConfigParser object to a dict

3042

2340

server_settings = server_config.defaults()

3043

2341

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

3044

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

3045

"foreground", "zeroconf"):

2342

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

3046

2343

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

3047

2344

option)

3048

2345

if server_settings["port"]:

3058

2355

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

3059

2356

["socket"])

3060

2357

del server_config

3061

2358

3062

2359

# Override the settings from the config file with command line

3063

2360

# options, if set.

3064

2361

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

3065

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

3066

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

3067

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

2362

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

2363

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

2364

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

3068

2365

value = getattr(options, option)

3069

2366

if value is not None:

3070

2367

server_settings[option] = value

3071

2368

del options

3072

2369

# Force all strings to be unicode

3073

2370

for option in server_settings.keys():

3074

if isinstance(server_settings[option], bytes):

3075

server_settings[option] = (server_settings[option]

3076

.decode("utf-8"))

3077

# Force all boolean options to be boolean

3078

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

3079

"foreground", "zeroconf"):

3080

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

2371

if type(server_settings[option]) is str:

2372

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

3081

2373

# Debug implies foreground

3082

2374

if server_settings["debug"]:

3083

2375

server_settings["foreground"] = True

3084

2376

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

3085

2377

3086

2378

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

3087

3088

if (not server_settings["zeroconf"]

3089

and not (server_settings["port"]

3090

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

3091

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

3092

2379

3093

2380

# For convenience

3094

2381

debug = server_settings["debug"]

3095

2382

debuglevel = server_settings["debuglevel"]

3098

2385

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

3099

2386

stored_state_file)

3100

2387

foreground = server_settings["foreground"]

3101

zeroconf = server_settings["zeroconf"]

3102

2388

3103

2389

if debug:

3104

2390

initlogger(debug, logging.DEBUG)

3105

2391

else:

3108

2394

else:

3109

2395

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

3110

2396

initlogger(debug, level)

3111

2397

3112

2398

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

3113

syslogger.setFormatter(

3114

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

3115

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

3116

server_settings["servicename"])))

3117

2399

syslogger.setFormatter(logging.Formatter

2400

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

2401

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

2402

.format(server_settings

2403

["servicename"])))

2404

3118

2405

# Parse config file with clients

3119

client_config = configparser.ConfigParser(Client.client_defaults)

2406

client_config = configparser.SafeConfigParser(Client

2407

.client_defaults)

3120

2408

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

3121

2409

"clients.conf"))

3122

2410

3123

2411

global mandos_dbus_service

3124

2412

mandos_dbus_service = None

3125

3126

socketfd = None

3127

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

3128

socketfd = server_settings["socket"]

3129

tcp_server = MandosServer(

3130

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

3131

ClientHandler,

3132

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

3133

use_ipv6=use_ipv6,

3134

gnutls_priority=server_settings["priority"],

3135

use_dbus=use_dbus,

3136

socketfd=socketfd)

2413

2414

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

2415

server_settings["port"]),

2416

ClientHandler,

2417

interface=(server_settings["interface"]

2418

or None),

2419

use_ipv6=use_ipv6,

2420

gnutls_priority=

2421

server_settings["priority"],

2422

use_dbus=use_dbus,

2423

socketfd=(server_settings["socket"]

2424

or None))

3137

2425

if not foreground:

3138

pidfilename = "/run/mandos.pid"

3139

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

3140

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

2426

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

3141

2427

pidfile = None

3142

2428

try:

3143

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

2429

pidfile = open(pidfilename, "w")

3144

2430

except IOError as e:

3145

2431

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

3146

2432

exc_info=e)

3147

3148

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

3149

("mandos", "mandos"),

3150

("nobody", "nogroup")):

2433

2434

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

3151

2435

try:

3152

2436

uid = pwd.getpwnam(name).pw_uid

3153

gid = pwd.getpwnam(group).pw_gid

2437

gid = pwd.getpwnam(name).pw_gid

3154

2438

break

3155

2439

except KeyError:

3156

2440

continue

3160

2444

try:

3161

2445

os.setgid(gid)

3162

2446

os.setuid(uid)

3163

if debug:

3164

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

3165

gid))

3166

2447

except OSError as error:

3167

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

3168

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

3169

2448

if error.errno != errno.EPERM:

3170

raise

3171

2449

raise error

2450

3172

2451

if debug:

3173

2452

# Enable all possible GnuTLS debugging

3174

2453

3175

2454

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

3176

2455

# - GnuTLS manual

3177

gnutls.global_set_log_level(11)

3178

3179

@gnutls.log_func

2456

gnutls.library.functions.gnutls_global_set_log_level(11)

2457

2458

@gnutls.library.types.gnutls_log_func

3180

2459

def debug_gnutls(level, string):

3181

2460

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

3182

3183

gnutls.global_set_log_function(debug_gnutls)

3184

2461

2462

(gnutls.library.functions

2463

.gnutls_global_set_log_function(debug_gnutls))

2464

3185

2465

# Redirect stdin so all checkers get /dev/null

3186

2466

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

3187

2467

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

3188

2468

if null > 2:

3189

2469

os.close(null)

3190

2470

3191

2471

# Need to fork before connecting to D-Bus

3192

2472

if not foreground:

3193

2473

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

3194

2474

daemon()

3195

3196

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

3197

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

3198

# need to inform GLib that threads will be used.

3199

GLib.threads_init()

3200

2475

2476

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

2477

# need to inform gobject that threads will be used.

2478

gobject.threads_init()

2479

3201

2480

global main_loop

3202

2481

# From the Avahi example code

3203

2482

DBusGMainLoop(set_as_default=True)

3204

main_loop = GLib.MainLoop()

2483

main_loop = gobject.MainLoop()

3205

2484

bus = dbus.SystemBus()

3206

2485

# End of Avahi example code

3207

2486

if use_dbus:

3208

2487

try:

3209

2488

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

3210

bus,

3211

do_not_queue=True)

3212

old_bus_name = dbus.service.BusName(

3213

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

3214

do_not_queue=True)

3215

except dbus.exceptions.DBusException as e:

2489

bus, do_not_queue=True)

2490

old_bus_name = (dbus.service.BusName

2491

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

2492

do_not_queue=True))

2493

except dbus.exceptions.NameExistsException as e:

3216

2494

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

3217

2495

use_dbus = False

3218

2496

server_settings["use_dbus"] = False

3219

2497

tcp_server.use_dbus = False

3220

if zeroconf:

3221

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3222

service = AvahiServiceToSyslog(

3223

name=server_settings["servicename"],

3224

servicetype="_mandos._tcp",

3225

protocol=protocol,

3226

bus=bus)

3227

if server_settings["interface"]:

3228

service.interface = if_nametoindex(

3229

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

3230

2498

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2499

service = AvahiServiceToSyslog(name =

2500

server_settings["servicename"],

2501

servicetype = "_mandos._tcp",

2502

protocol = protocol, bus = bus)

2503

if server_settings["interface"]:

2504

service.interface = (if_nametoindex

2505

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

2506

3231

2507

global multiprocessing_manager

3232

2508

multiprocessing_manager = multiprocessing.Manager()

3233

2509

3234

2510

client_class = Client

3235

2511

if use_dbus:

3236

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

3237

2512

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

2513

3238

2514

client_settings = Client.config_parser(client_config)

3239

2515

old_client_settings = {}

3240

2516

clients_data = {}

3241

3242

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

3243

global wnull

3244

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

3245

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

3246

# mode

3247

if debug or not foreground:

3248

wnull.close()

3249

2517

3250

2518

# Get client data and settings from last running state.

3251

2519

if server_settings["restore"]:

3252

2520

try:

3253

2521

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

3254

if sys.version_info.major == 2:

3255

clients_data, old_client_settings = pickle.load(

3256

stored_state)

3257

else:

3258

bytes_clients_data, bytes_old_client_settings = (

3259

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

3260

# Fix bytes to strings

3261

# clients_data

3262

# .keys()

3263

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

3264

if isinstance(key, bytes)

3265

else key): value

3266

for key, value in

3267

bytes_clients_data.items()}

3268

del bytes_clients_data

3269

for key in clients_data:

3270

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

3271

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

3272

for k, v in

3273

clients_data[key].items()}

3274

clients_data[key] = value

3275

# .client_structure

3276

value["client_structure"] = [

3277

(s.decode("utf-8")

3278

if isinstance(s, bytes)

3279

else s) for s in

3280

value["client_structure"]]

3281

# .name, .host, and .checker_command

3282

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

3283

if isinstance(value[k], bytes):

3284

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

3285

if "key_id" not in value:

3286

value["key_id"] = ""

3287

elif "fingerprint" not in value:

3288

value["fingerprint"] = ""

3289

# old_client_settings

3290

# .keys()

3291

old_client_settings = {

3292

(key.decode("utf-8")

3293

if isinstance(key, bytes)

3294

else key): value

3295

for key, value in

3296

bytes_old_client_settings.items()}

3297

del bytes_old_client_settings

3298

# .host and .checker_command

3299

for value in old_client_settings.values():

3300

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

3301

if isinstance(value[attribute], bytes):

3302

value[attribute] = (value[attribute]

3303

.decode("utf-8"))

2522

clients_data, old_client_settings = (pickle.load

2523

(stored_state))

3304

2524

os.remove(stored_state_path)

3305

2525

except IOError as e:

3306

2526

if e.errno == errno.ENOENT:

3307

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

3308

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

2527

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

2528

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

3309

2529

else:

3310

2530

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

3311

2531

exc_info=e)

3312

2532

raise

3313

2533

except EOFError as e:

3314

2534

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

3315

"EOFError:",

3316

exc_info=e)

3317

2535

"EOFError:", exc_info=e)

2536

3318

2537

with PGPEngine() as pgp:

3319

for client_name, client in clients_data.items():

3320

# Skip removed clients

3321

if client_name not in client_settings:

3322

continue

3323

2538

for client_name, client in clients_data.iteritems():

3324

2539

# Decide which value to use after restoring saved state.

3325

2540

# We have three different values: Old config file,

3326

2541

# new config file, and saved state.

3331

2546

# For each value in new config, check if it

3332

2547

# differs from the old config value (Except for

3333

2548

# the "secret" attribute)

3334

if (name != "secret"

3335

and (value !=

3336

old_client_settings[client_name][name])):

2549

if (name != "secret" and

2550

value != old_client_settings[client_name]

2551

[name]):

3337

2552

client[name] = value

3338

2553

except KeyError:

3339

2554

pass

3340

2555

3341

2556

# Clients who has passed its expire date can still be

3342

# enabled if its last checker was successful. A Client

2557

# enabled if its last checker was successful. Clients

3343

2558

# whose checker succeeded before we stored its state is

3344

2559

# assumed to have successfully run all checkers during

3345

2560

# downtime.

3347

2562

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

3348

2563

if not client["last_checked_ok"]:

3349

2564

logger.warning(

3350

"disabling client {} - Client never "

3351

"performed a successful checker".format(

3352

client_name))

2565

"disabling client {0} - Client never "

2566

"performed a successful checker"

2567

.format(client_name))

3353

2568

client["enabled"] = False

3354

2569

elif client["last_checker_status"] != 0:

3355

2570

logger.warning(

3356

"disabling client {} - Client last"

3357

" checker failed with error code"

3358

" {}".format(

3359

client_name,

3360

client["last_checker_status"]))

2571

"disabling client {0} - Client "

2572

"last checker failed with error code {1}"

2573

.format(client_name,

2574

client["last_checker_status"]))

3361

2575

client["enabled"] = False

3362

2576

else:

3363

client["expires"] = (

3364

datetime.datetime.utcnow()

3365

+ client["timeout"])

2577

client["expires"] = (datetime.datetime

2578

.utcnow()

2579

+ client["timeout"])

3366

2580

logger.debug("Last checker succeeded,"

3367

" keeping {} enabled".format(

3368

client_name))

2581

" keeping {0} enabled"

2582

.format(client_name))

3369

2583

try:

3370

client["secret"] = pgp.decrypt(

3371

client["encrypted_secret"],

3372

client_settings[client_name]["secret"])

2584

client["secret"] = (

2585

pgp.decrypt(client["encrypted_secret"],

2586

client_settings[client_name]

2587

["secret"]))

3373

2588

except PGPError:

3374

2589

# If decryption fails, we use secret from new settings

3375

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

3376

client_name))

3377

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

3378

["secret"])

3379

2590

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

2591

.format(client_name))

2592

client["secret"] = (

2593

client_settings[client_name]["secret"])

2594

3380

2595

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

3381

2596

for client_name in (set(old_client_settings)

3382

2597

- set(client_settings)):

3384

2599

for client_name in (set(client_settings)

3385

2600

- set(old_client_settings)):

3386

2601

clients_data[client_name] = client_settings[client_name]

3387

2602

3388

2603

# Create all client objects

3389

for client_name, client in clients_data.items():

2604

for client_name, client in clients_data.iteritems():

3390

2605

tcp_server.clients[client_name] = client_class(

3391

name=client_name,

3392

settings=client,

3393

server_settings=server_settings)

3394

2606

name = client_name, settings = client)

2607

3395

2608

if not tcp_server.clients:

3396

2609

logger.warning("No clients defined")

3397

2610

3398

2611

if not foreground:

3399

2612

if pidfile is not None:

3400

pid = os.getpid()

3401

2613

try:

3402

2614

with pidfile:

3403

print(pid, file=pidfile)

2615

pid = os.getpid()

2616

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

3404

2617

except IOError:

3405

2618

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

3406

2619

pidfilename, pid)

3407

2620

del pidfile

3408

2621

del pidfilename

3409

3410

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

3411

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3412

lambda: main_loop.quit() and False)

3413

2622

2623

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

2624

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

2625

3414

2626

if use_dbus:

3415

3416

@alternate_dbus_interfaces(

3417

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

3418

class MandosDBusService(DBusObjectWithObjectManager):

2627

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

2628

"se.bsnet.fukt.Mandos"})

2629

class MandosDBusService(DBusObjectWithProperties):

3419

2630

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

3420

3421

2631

def __init__(self):

3422

2632

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

3423

3424

2633

_interface = "se.recompile.Mandos"

3425

2634

2635

@dbus_interface_annotations(_interface)

2636

def _foo(self):

2637

return { "org.freedesktop.DBus.Property"

2638

".EmitsChangedSignal":

2639

"false"}

2640

3426

2641

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

3427

2642

def ClientAdded(self, objpath):

3428

2643

"D-Bus signal"

3429

2644

pass

3430

2645

3431

2646

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

3432

def ClientNotFound(self, key_id, address):

2647

def ClientNotFound(self, fingerprint, address):

3433

2648

"D-Bus signal"

3434

2649

pass

3435

3436

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

3437

"true"})

2650

3438

2651

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

3439

2652

def ClientRemoved(self, objpath, name):

3440

2653

"D-Bus signal"

3441

2654

pass

3442

3443

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

3444

"true"})

2655

3445

2656

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

3446

2657

def GetAllClients(self):

3447

2658

"D-Bus method"

3448

return dbus.Array(c.dbus_object_path for c in

3449

tcp_server.clients.values())

3450

3451

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

3452

"true"})

2659

return dbus.Array(c.dbus_object_path

2660

for c in

2661

tcp_server.clients.itervalues())

2662

3453

2663

@dbus.service.method(_interface,

3454

2664

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

3455

2665

def GetAllClientsWithProperties(self):

3456

2666

"D-Bus method"

3457

2667

return dbus.Dictionary(

3458

{c.dbus_object_path: c.GetAll(

3459

"se.recompile.Mandos.Client")

3460

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

2668

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

2669

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

3461

2670

signature="oa{sv}")

3462

2671

3463

2672

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

3464

2673

def RemoveClient(self, object_path):

3465

2674

"D-Bus method"

3466

for c in tcp_server.clients.values():

2675

for c in tcp_server.clients.itervalues():

3467

2676

if c.dbus_object_path == object_path:

3468

2677

del tcp_server.clients[c.name]

3469

2678

c.remove_from_connection()

3470

# Don't signal the disabling

2679

# Don't signal anything except ClientRemoved

3471

2680

c.disable(quiet=True)

3472

# Emit D-Bus signal for removal

3473

self.client_removed_signal(c)

2681

# Emit D-Bus signal

2682

self.ClientRemoved(object_path, c.name)

3474

2683

return

3475

2684

raise KeyError(object_path)

3476

2685

3477

2686

del _interface

3478

3479

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3480

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

3481

def GetManagedObjects(self):

3482

"""D-Bus method"""

3483

return dbus.Dictionary(

3484

{client.dbus_object_path:

3485

dbus.Dictionary(

3486

{interface: client.GetAll(interface)

3487

for interface in

3488

client._get_all_interface_names()})

3489

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

3490

3491

def client_added_signal(self, client):

3492

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

3493

if use_dbus:

3494

# New standard signal

3495

self.InterfacesAdded(

3496

client.dbus_object_path,

3497

dbus.Dictionary(

3498

{interface: client.GetAll(interface)

3499

for interface in

3500

client._get_all_interface_names()}))

3501

# Old signal

3502

self.ClientAdded(client.dbus_object_path)

3503

3504

def client_removed_signal(self, client):

3505

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

3506

if use_dbus:

3507

# New standard signal

3508

self.InterfacesRemoved(

3509

client.dbus_object_path,

3510

client._get_all_interface_names())

3511

# Old signal

3512

self.ClientRemoved(client.dbus_object_path,

3513

client.name)

3514

2687

3515

2688

mandos_dbus_service = MandosDBusService()

3516

3517

# Save modules to variables to exempt the modules from being

3518

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

3519

mp = multiprocessing

3520

wn = wnull

3521

2689

3522

2690

def cleanup():

3523

2691

"Cleanup function; run on exit"

3524

if zeroconf:

3525

service.cleanup()

3526

3527

mp.active_children()

3528

wn.close()

2692

service.cleanup()

2693

2694

multiprocessing.active_children()

3529

2695

if not (tcp_server.clients or client_settings):

3530

2696

return

3531

2697

3532

2698

# Store client before exiting. Secrets are encrypted with key

3533

2699

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

3534

2700

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

3535

2701

clients = {}

3536

2702

with PGPEngine() as pgp:

3537

for client in tcp_server.clients.values():

2703

for client in tcp_server.clients.itervalues():

3538

2704

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

3539

2705

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

3540

2706

key)

3541

2707

client_dict = {}

3542

2708

3543

2709

# A list of attributes that can not be pickled

3544

2710

# + secret.

3545

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

3546

"checker", "server_settings"}

3547

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

3548

.Object):

2711

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

2712

"checker"))

2713

for name, typ in (inspect.getmembers

2714

(dbus.service.Object)):

3549

2715

exclude.add(name)

3550

2716

3551

2717

client_dict["encrypted_secret"] = (client

3552

2718

.encrypted_secret)

3553

2719

for attr in client.client_structure:

3554

2720

if attr not in exclude:

3555

2721

client_dict[attr] = getattr(client, attr)

3556

2722

3557

2723

clients[client.name] = client_dict

3558

2724

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

3559

2725

3560

2726

try:

3561

with tempfile.NamedTemporaryFile(

3562

mode='wb',

3563

suffix=".pickle",

3564

prefix='clients-',

3565

dir=os.path.dirname(stored_state_path),

3566

delete=False) as stored_state:

3567

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

3568

protocol=2)

3569

tempname = stored_state.name

2727

with (tempfile.NamedTemporaryFile

2728

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

2729

dir=os.path.dirname(stored_state_path),

2730

delete=False)) as stored_state:

2731

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

2732

tempname=stored_state.name

3570

2733

os.rename(tempname, stored_state_path)

3571

2734

except (IOError, OSError) as e:

3572

2735

if not debug:

3575

2738

except NameError:

3576

2739

pass

3577

2740

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

3578

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

2741

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

3579

2742

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

3580

2743

else:

3581

2744

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

3582

2745

exc_info=e)

3583

raise

3584

2746

raise e

2747

3585

2748

# Delete all clients, and settings from config

3586

2749

while tcp_server.clients:

3587

2750

name, client = tcp_server.clients.popitem()

3588

2751

if use_dbus:

3589

2752

client.remove_from_connection()

3590

# Don't signal the disabling

2753

# Don't signal anything except ClientRemoved

3591

2754

client.disable(quiet=True)

3592

# Emit D-Bus signal for removal

3593

2755

if use_dbus:

3594

mandos_dbus_service.client_removed_signal(client)

2756

# Emit D-Bus signal

2757

mandos_dbus_service.ClientRemoved(client

2758

.dbus_object_path,

2759

client.name)

3595

2760

client_settings.clear()

3596

2761

3597

2762

atexit.register(cleanup)

3598

3599

for client in tcp_server.clients.values():

2763

2764

for client in tcp_server.clients.itervalues():

3600

2765

if use_dbus:

3601

# Emit D-Bus signal for adding

3602

mandos_dbus_service.client_added_signal(client)

2766

# Emit D-Bus signal

2767

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3603

2768

# Need to initiate checking of clients

3604

2769

if client.enabled:

3605

2770

client.init_checker()

3606

2771

3607

2772

tcp_server.enable()

3608

2773

tcp_server.server_activate()

3609

2774

3610

2775

# Find out what port we got

3611

if zeroconf:

3612

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

2776

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

3613

2777

if use_ipv6:

3614

2778

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

3615

2779

" flowinfo %d, scope_id %d",

3617

2781

else: # IPv4

3618

2782

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

3619

2783

*tcp_server.socket.getsockname())

3620

3621

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

3622

2784

2785

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

2786

3623

2787

try:

3624

if zeroconf:

3625

# From the Avahi example code

3626

try:

3627

service.activate()

3628

except dbus.exceptions.DBusException as error:

3629

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

3630

cleanup()

3631

sys.exit(1)

3632

# End of Avahi example code

3633

3634

GLib.io_add_watch(

3635

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

3636

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3637

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

3638

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

3639

2788

# From the Avahi example code

2789

try:

2790

service.activate()

2791

except dbus.exceptions.DBusException as error:

2792

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

2793

cleanup()

2794

sys.exit(1)

2795

# End of Avahi example code

2796

2797

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

2798

lambda *args, **kwargs:

2799

(tcp_server.handle_request

2800

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

2801

3640

2802

logger.debug("Starting main loop")

3641

2803

main_loop.run()

3642

2804

except AvahiError as error:

3651

2813

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

3652

2814

cleanup()

3653

2815

3654

3655

def should_only_run_tests():

3656

parser = argparse.ArgumentParser(add_help=False)

3657

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

3658

args, unknown_args = parser.parse_known_args()

3659

run_tests = args.check

3660

if run_tests:

3661

# Remove --check argument from sys.argv

3662

sys.argv[1:] = unknown_args

3663

return run_tests

3664

3665

# Add all tests from doctest strings

3666

def load_tests(loader, tests, none):

3667

import doctest

3668

tests.addTests(doctest.DocTestSuite())

3669

return tests

3670

3671

2816

if __name__ == '__main__':

3672

try:

3673

if should_only_run_tests():

3674

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

3675

unittest.main()

3676

else:

3677

main()

3678

finally:

3679

logging.shutdown()

2817

main()