/mandos/release : revision 237.7.772

1

#!/usr/bin/python

2

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

3

#

1

#!/usr/bin/python3 -bI

2

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

3

#

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

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

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

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

78

import collections

79

import codecs

80

import unittest

81

import random

82

import shlex

71

83

72

84

import dbus

73

85

import dbus.service

74

import gobject

75

import avahi

86

import gi

87

from gi.repository import GLib

76

88

from dbus.mainloop.glib import DBusGMainLoop

77

89

import ctypes

78

90

import ctypes.util

79

91

import xml.dom.minidom

80

92

import inspect

81

import GnuPGInterface

82

83

try:

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:

84

122

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

123

except AttributeError:

86

124

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

87

127

from IN import SO_BINDTODEVICE

88

128

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.5.5"

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"

92

147

stored_state_file = "clients.pickle"

93

148

94

149

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

150

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

151

syslogger = None

98

152

99

153

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

103

156

except (OSError, AttributeError):

157

104

158

def if_nametoindex(interface):

105

159

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

106

160

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

107

161

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

108

162

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

163

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

164

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

113

165

return interface_index

114

166

115

167

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

116

184

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

117

185

"""init logger and add loglevel"""

118

186

187

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

119

191

syslogger.setFormatter(logging.Formatter

120

192

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

121

193

' %(message)s'))

122

194

logger.addHandler(syslogger)

123

195

124

196

if debug:

125

197

console = logging.StreamHandler()

126

198

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

136

208

pass

137

209

138

210

139

class PGPEngine(object):

211

class PGPEngine:

140

212

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

213

141

214

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

143

215

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

144

self.gnupg = GnuPGInterface.GnuPG()

145

self.gnupg.options.meta_interactive = False

146

self.gnupg.options.homedir = self.tempdir

147

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

148

'--quiet',

149

'--no-use-agent'])

150

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

151

235

def __enter__(self):

152

236

return self

153

237

154

238

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

155

239

self._cleanup()

156

240

return False

157

241

158

242

def __del__(self):

159

243

self._cleanup()

160

244

161

245

def _cleanup(self):

162

246

if self.tempdir is not None:

163

247

# Delete contents of tempdir

164

248

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

165

topdown = False):

249

topdown=False):

166

250

for filename in files:

167

251

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

168

252

for dirname in dirs:

170

254

# Remove tempdir

171

255

os.rmdir(self.tempdir)

172

256

self.tempdir = None

173

257

174

258

def password_encode(self, password):

175

259

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

176

260

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

177

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

178

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

179

269

def encrypt(self, data, password):

180

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

181

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

182

try:

183

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

184

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

185

attach_fhs={'stderr': devnull})

186

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

187

f.write(data)

188

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

189

ciphertext = f.read()

190

proc.wait()

191

except IOError as e:

192

raise PGPError(e)

193

self.gnupg.passphrase = None

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)

194

285

return ciphertext

195

286

196

287

def decrypt(self, data, password):

197

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

198

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

199

try:

200

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

201

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

202

attach_fhs={'stderr': devnull})

203

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

204

f.write(data)

205

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

206

decrypted_plaintext = f.read()

207

proc.wait()

208

except IOError as e:

209

raise PGPError(e)

210

self.gnupg.passphrase = None

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)

211

303

return decrypted_plaintext

212

304

213

305

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

214

332

class AvahiError(Exception):

215

333

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

216

334

self.value = value

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

335

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

336

**kwargs)

337

220

338

221

339

class AvahiServiceError(AvahiError):

222

340

pass

223

341

342

224

343

class AvahiGroupError(AvahiError):

225

344

pass

226

345

227

346

228

class AvahiService(object):

347

class AvahiService:

229

348

"""An Avahi (Zeroconf) service.

230

349

231

350

Attributes:

232

351

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

233

352

Used to optionally bind to the specified interface.

234

353

name: string; Example: 'Mandos'

235

354

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

236

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

355

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

237

356

port: integer; what port to announce

238

357

TXT: list of strings; TXT record for the service

239

358

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

245

364

server: D-Bus Server

246

365

bus: dbus.SystemBus()

247

366

"""

248

249

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

250

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

251

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

252

protocol = avahi.PROTO_UNSPEC, bus = None):

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

253

379

self.interface = interface

254

380

self.name = name

255

381

self.type = servicetype

264

390

self.server = None

265

391

self.bus = bus

266

392

self.entry_group_state_changed_match = None

267

268

def rename(self):

393

394

def rename(self, remove=True):

269

395

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

270

396

if self.rename_count >= self.max_renames:

271

397

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

272

398

" after %i retries, exiting.",

273

399

self.rename_count)

274

400

raise AvahiServiceError("Too many renames")

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

277

404

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

278

405

self.name)

279

self.remove()

406

if remove:

407

self.remove()

280

408

try:

281

409

self.add()

282

410

except dbus.exceptions.DBusException as error:

283

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

284

self.cleanup()

285

os._exit(1)

286

self.rename_count += 1

287

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

288

420

def remove(self):

289

421

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

290

422

if self.entry_group_state_changed_match is not None:

292

424

self.entry_group_state_changed_match = None

293

425

if self.group is not None:

294

426

self.group.Reset()

295

427

296

428

def add(self):

297

429

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

298

430

self.remove()

315

447

dbus.UInt16(self.port),

316

448

avahi.string_array_to_txt_array(self.TXT))

317

449

self.group.Commit()

318

450

319

451

def entry_group_state_changed(self, state, error):

320

452

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

321

453

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

322

454

323

455

if state == avahi.ENTRY_GROUP_ESTABLISHED:

324

456

logger.debug("Zeroconf service established.")

325

457

elif state == avahi.ENTRY_GROUP_COLLISION:

327

459

self.rename()

328

460

elif state == avahi.ENTRY_GROUP_FAILURE:

329

461

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

330

unicode(error))

331

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

332

.format(error))

333

462

str(error))

463

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

464

334

465

def cleanup(self):

335

466

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

336

467

if self.group is not None:

341

472

pass

342

473

self.group = None

343

474

self.remove()

344

475

345

476

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

346

477

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

347

478

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

348

bad_states = { avahi.SERVER_INVALID:

349

"Zeroconf server invalid",

350

avahi.SERVER_REGISTERING: None,

351

avahi.SERVER_COLLISION:

352

"Zeroconf server name collision",

353

avahi.SERVER_FAILURE:

354

"Zeroconf server failure" }

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

}

355

485

if state in bad_states:

356

486

if bad_states[state] is not None:

357

487

if error is None:

360

490

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

361

491

self.cleanup()

362

492

elif state == avahi.SERVER_RUNNING:

363

self.add()

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

505

else:

365

506

if error is None:

366

507

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

367

508

else:

368

509

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

369

510

370

511

def activate(self):

371

512

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

372

513

if self.server is None:

376

517

follow_name_owner_changes=True),

377

518

avahi.DBUS_INTERFACE_SERVER)

378

519

self.server.connect_to_signal("StateChanged",

379

self.server_state_changed)

520

self.server_state_changed)

380

521

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

381

522

382

523

383

524

class AvahiServiceToSyslog(AvahiService):

384

def rename(self):

525

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

385

526

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

386

ret = AvahiService.rename(self)

387

syslogger.setFormatter(logging.Formatter

388

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

389

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

390

.format(self.name)))

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

391

532

return ret

392

533

393

534

394

def timedelta_to_milliseconds(td):

395

"Convert a datetime.timedelta() to milliseconds"

396

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

397

+ (td.seconds * 1000)

398

+ (td.microseconds // 1000))

399

400

401

class Client(object):

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:

402

854

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

403

855

404

856

Attributes:

405

857

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

406

858

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

407

859

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

408

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

409

to see if the client lives.

410

'None' if no process is running.

411

checker_callback_tag: a gobject event source tag, or None

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

412

864

checker_command: string; External command which is run to check

413

865

if client lives. %() expansions are done at

414

866

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

415

867

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

416

checker_initiator_tag: a gobject event source tag, or None

868

checker_initiator_tag: a GLib event source tag, or None

417

869

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

418

870

client_structure: Object describing what attributes a client has

419

871

and is used for storing the client at exit

420

872

current_checker_command: string; current running checker_command

421

disable_initiator_tag: a gobject event source tag, or None

873

disable_initiator_tag: a GLib event source tag, or None

422

874

enabled: bool()

423

875

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

424

uniquely identify the client

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

879

host: string; available for use by the checker command

426

880

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

427

881

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

429

883

last_checker_status: integer between 0 and 255 reflecting exit

430

884

status of last checker. -1 reflects crashed

431

885

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

432

888

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

433

889

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

434

890

D-Bus identifiers

439

895

runtime_expansions: Allowed attributes for runtime expansion.

440

896

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

441

897

disabled, or None

898

server_settings: The server_settings dict from main()

442

899

"""

443

900

444

901

runtime_expansions = ("approval_delay", "approval_duration",

445

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

902

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

446

903

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

447

904

"last_approval_request", "last_checked_ok",

448

905

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

449

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

450

"extended_timeout": "15m",

451

"interval": "2m",

452

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

453

"host": "",

454

"approval_delay": "0s",

455

"approval_duration": "1s",

456

"approved_by_default": "True",

457

"enabled": "True",

458

}

459

460

def timeout_milliseconds(self):

461

"Return the 'timeout' attribute in milliseconds"

462

return timedelta_to_milliseconds(self.timeout)

463

464

def extended_timeout_milliseconds(self):

465

"Return the 'extended_timeout' attribute in milliseconds"

466

return timedelta_to_milliseconds(self.extended_timeout)

467

468

def interval_milliseconds(self):

469

"Return the 'interval' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.interval)

471

472

def approval_delay_milliseconds(self):

473

return timedelta_to_milliseconds(self.approval_delay)

474

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

475

918

@staticmethod

476

919

def config_parser(config):

477

920

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

484

927

for client_name in config.sections():

485

928

section = dict(config.items(client_name))

486

929

client = settings[client_name] = {}

487

930

488

931

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

489

932

# Reformat values from string types to Python types

490

933

client["approved_by_default"] = config.getboolean(

491

934

client_name, "approved_by_default")

492

935

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

493

936

"enabled")

494

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

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

496

944

.replace(" ", ""))

497

945

if "secret" in section:

498

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

946

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

947

.encode("utf-8"),

948

"base64")

499

949

elif "secfile" in section:

500

950

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

501

951

(section["secfile"])),

502

952

"rb") as secfile:

503

953

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

504

954

else:

505

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

955

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

506

956

.format(section))

507

957

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

508

958

client["extended_timeout"] = string_to_delta(

516

966

client["last_approval_request"] = None

517

967

client["last_checked_ok"] = None

518

968

client["last_checker_status"] = -2

519

969

520

970

return settings

521

522

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

971

972

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

523

973

self.name = name

974

if server_settings is None:

975

server_settings = {}

976

self.server_settings = server_settings

524

977

# adding all client settings

525

for setting, value in settings.iteritems():

978

for setting, value in settings.items():

526

979

setattr(self, setting, value)

527

980

528

981

if self.enabled:

529

982

if not hasattr(self, "last_enabled"):

530

983

self.last_enabled = datetime.datetime.utcnow()

534

987

else:

535

988

self.last_enabled = None

536

989

self.expires = None

537

990

538

991

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

539

# Uppercase and remove spaces from fingerprint for later

540

# comparison purposes with return value from the fingerprint()

541

# function

992

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

542

993

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

543

994

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

544

995

datetime.datetime.utcnow())

545

996

546

997

# attributes specific for this server instance

547

998

self.checker = None

548

999

self.checker_initiator_tag = None

551

1002

self.current_checker_command = None

552

1003

self.approved = None

553

1004

self.approvals_pending = 0

554

self.changedstate = (multiprocessing_manager

555

.Condition(multiprocessing_manager

556

.Lock()))

557

self.client_structure = [attr for attr in

558

self.__dict__.iterkeys()

1005

self.changedstate = multiprocessing_manager.Condition(

1006

multiprocessing_manager.Lock())

1007

self.client_structure = [attr

1008

for attr in self.__dict__.keys()

559

1009

if not attr.startswith("_")]

560

1010

self.client_structure.append("client_structure")

561

562

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

563

lambda obj:

564

isinstance(obj,

565

property)):

1011

1012

for name, t in inspect.getmembers(

1013

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

566

1014

if not name.startswith("_"):

567

1015

self.client_structure.append(name)

568

1016

569

1017

# Send notice to process children that client state has changed

570

1018

def send_changedstate(self):

571

1019

with self.changedstate:

572

1020

self.changedstate.notify_all()

573

1021

574

1022

def enable(self):

575

1023

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

576

1024

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

581

1029

self.last_enabled = datetime.datetime.utcnow()

582

1030

self.init_checker()

583

1031

self.send_changedstate()

584

1032

585

1033

def disable(self, quiet=True):

586

1034

"""Disable this client."""

587

1035

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

589

1037

if not quiet:

590

1038

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

591

1039

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

592

gobject.source_remove(self.disable_initiator_tag)

1040

GLib.source_remove(self.disable_initiator_tag)

593

1041

self.disable_initiator_tag = None

594

1042

self.expires = None

595

1043

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

596

gobject.source_remove(self.checker_initiator_tag)

1044

GLib.source_remove(self.checker_initiator_tag)

597

1045

self.checker_initiator_tag = None

598

1046

self.stop_checker()

599

1047

self.enabled = False

600

1048

if not quiet:

601

1049

self.send_changedstate()

602

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

1050

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

603

1051

return False

604

1052

605

1053

def __del__(self):

606

1054

self.disable()

607

1055

608

1056

def init_checker(self):

609

1057

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

610

1058

# and every interval from then on.

611

1059

if self.checker_initiator_tag is not None:

612

gobject.source_remove(self.checker_initiator_tag)

613

self.checker_initiator_tag = (gobject.timeout_add

614

(self.interval_milliseconds(),

615

self.start_checker))

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)

616

1065

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

617

1066

if self.disable_initiator_tag is not None:

618

gobject.source_remove(self.disable_initiator_tag)

619

self.disable_initiator_tag = (gobject.timeout_add

620

(self.timeout_milliseconds(),

621

self.disable))

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)

622

1070

# Also start a new checker *right now*.

623

1071

self.start_checker()

624

625

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

1072

1073

def checker_callback(self, source, condition, connection,

1074

command):

626

1075

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

627

1081

self.checker_callback_tag = None

628

1082

self.checker = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1083

1084

if returncode >= 0:

1085

self.last_checker_status = returncode

1086

self.last_checker_signal = None

631

1087

if self.last_checker_status == 0:

632

1088

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

633

1089

vars(self))

634

1090

self.checked_ok()

635

1091

else:

636

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

637

vars(self))

1092

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

638

1093

else:

639

1094

self.last_checker_status = -1

1095

self.last_checker_signal = -returncode

640

1096

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

641

1097

vars(self))

642

1098

return False

1099

643

1100

def checked_ok(self):

644

1101

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

645

1102

self.last_checked_ok = datetime.datetime.utcnow()

646

1103

self.last_checker_status = 0

1104

self.last_checker_signal = None

647

1105

self.bump_timeout()

648

1106

649

1107

def bump_timeout(self, timeout=None):

650

1108

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

651

1109

if timeout is None:

652

1110

timeout = self.timeout

653

1111

if self.disable_initiator_tag is not None:

654

gobject.source_remove(self.disable_initiator_tag)

1112

GLib.source_remove(self.disable_initiator_tag)

655

1113

self.disable_initiator_tag = None

656

1114

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(timedelta_to_milliseconds

659

(timeout), self.disable))

1115

self.disable_initiator_tag = GLib.timeout_add(

1116

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

660

1117

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

661

1118

662

1119

def need_approval(self):

663

1120

self.last_approval_request = datetime.datetime.utcnow()

664

1121

665

1122

def start_checker(self):

666

1123

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

667

1124

668

1125

If a checker already exists, leave it running and do

669

1126

nothing."""

670

1127

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

675

1132

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

676

1133

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

677

1134

# should be.

678

679

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

680

try:

681

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

682

except (AttributeError, OSError) as error:

683

if (isinstance(error, OSError)

684

and error.errno != errno.ECHILD):

685

raise error

686

else:

687

if pid:

688

logger.warning("Checker was a zombie")

689

gobject.source_remove(self.checker_callback_tag)

690

self.checker_callback(pid, status,

691

self.current_checker_command)

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

692

1140

# Start a new checker if needed

693

1141

if self.checker is None:

694

1142

# Escape attributes for the shell

695

escaped_attrs = dict(

696

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

697

for attr in

698

self.runtime_expansions)

1143

escaped_attrs = {

1144

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

1145

for attr in self.runtime_expansions}

699

1146

try:

700

1147

command = self.checker_command % escaped_attrs

701

1148

except TypeError as error:

702

1149

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

703

self.checker_command, exc_info=error)

704

return True # Try again later

1150

self.checker_command,

1151

exc_info=error)

1152

return True # Try again later

705

1153

self.current_checker_command = command

706

try:

707

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

708

command, self.name)

709

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

710

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

711

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

712

# always replaced by /dev/null.)

713

self.checker = subprocess.Popen(command,

714

close_fds=True,

715

shell=True, cwd="/")

716

except OSError as error:

717

logger.error("Failed to start subprocess",

718

exc_info=error)

719

self.checker_callback_tag = (gobject.child_watch_add

720

(self.checker.pid,

721

self.checker_callback,

722

data=command))

723

# The checker may have completed before the gobject

724

# watch was added. Check for this.

725

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

726

if pid:

727

gobject.source_remove(self.checker_callback_tag)

728

self.checker_callback(pid, status, command)

729

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

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

730

1181

return True

731

1182

732

1183

def stop_checker(self):

733

1184

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

734

1185

if self.checker_callback_tag:

735

gobject.source_remove(self.checker_callback_tag)

1186

GLib.source_remove(self.checker_callback_tag)

736

1187

self.checker_callback_tag = None

737

1188

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

738

1189

return

739

1190

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

740

try:

741

self.checker.terminate()

742

#time.sleep(0.5)

743

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

744

# self.checker.kill()

745

except OSError as error:

746

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

747

raise

1191

self.checker.terminate()

748

1192

self.checker = None

749

1193

750

1194

751

def dbus_service_property(dbus_interface, signature="v",

752

access="readwrite", byte_arrays=False):

1195

def dbus_service_property(dbus_interface,

1196

signature="v",

1197

access="readwrite",

1198

byte_arrays=False):

753

1199

"""Decorators for marking methods of a DBusObjectWithProperties to

754

1200

become properties on the D-Bus.

755

1201

756

1202

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

757

1203

and with one argument by "Set".

758

1204

759

1205

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

760

1206

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

761

1207

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

764

1210

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

765

1211

if byte_arrays and signature != "ay":

766

1212

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

767

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

1213

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

1214

768

1215

def decorator(func):

769

1216

func._dbus_is_property = True

770

1217

func._dbus_interface = dbus_interface

773

1220

func._dbus_name = func.__name__

774

1221

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

775

1222

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

776

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1223

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

777

1224

return func

1225

778

1226

return decorator

779

1227

780

1228

781

1229

def dbus_interface_annotations(dbus_interface):

782

1230

"""Decorator for marking functions returning interface annotations

783

1231

784

1232

Usage:

785

1233

786

1234

@dbus_interface_annotations("org.example.Interface")

787

1235

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

788

1236

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

789

1237

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

790

1238

"false"}

791

1239

"""

1240

792

1241

def decorator(func):

793

1242

func._dbus_is_interface = True

794

1243

func._dbus_interface = dbus_interface

795

1244

func._dbus_name = dbus_interface

796

1245

return func

1246

797

1247

return decorator

798

1248

799

1249

800

1250

def dbus_annotations(annotations):

801

1251

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

802

1252

Usage:

803

1253

1254

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

1255

"org.freedesktop.DBus.Property."

1256

"EmitsChangedSignal": "false"})

804

1257

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

805

1258

access="r")

806

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

807

"org.freedesktop.DBus.Property."

808

"EmitsChangedSignal": "false"})

809

1259

def Property_dbus_property(self):

810

1260

return dbus.Boolean(False)

1261

1262

See also the DBusObjectWithAnnotations class.

811

1263

"""

1264

812

1265

def decorator(func):

813

1266

func._dbus_annotations = annotations

814

1267

return func

1268

815

1269

return decorator

816

1270

817

1271

818

1272

class DBusPropertyException(dbus.exceptions.DBusException):

819

1273

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

820

1274

"""

821

def __unicode__(self):

822

return unicode(str(self))

1275

pass

823

1276

824

1277

825

1278

class DBusPropertyAccessException(DBusPropertyException):

834

1287

pass

835

1288

836

1289

837

class DBusObjectWithProperties(dbus.service.Object):

838

"""A D-Bus object with properties.

839

840

Classes inheriting from this can use the dbus_service_property

841

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

842

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

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.

843

1295

"""

844

1296

845

1297

@staticmethod

846

1298

def _is_dbus_thing(thing):

847

1299

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

848

1300

849

1301

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

850

1302

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

851

1303

"""

852

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

1304

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

853

1305

False)

854

1306

855

1307

def _get_all_dbus_things(self, thing):

856

1308

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

857

1309

"""

858

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

859

name),

1310

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

860

1311

athing.__get__(self))

861

1312

for cls in self.__class__.__mro__

862

1313

for name, athing in

863

inspect.getmembers(cls,

864

self._is_dbus_thing(thing)))

865

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

866

1387

def _get_dbus_property(self, interface_name, property_name):

867

1388

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

868

1389

property with the specified name and interface.

869

1390

"""

870

for cls in self.__class__.__mro__:

871

for name, value in (inspect.getmembers

872

(cls,

873

self._is_dbus_thing("property"))):

1391

for cls in self.__class__.__mro__:

1392

for name, value in inspect.getmembers(

1393

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

874

1394

if (value._dbus_name == property_name

875

1395

and value._dbus_interface == interface_name):

876

1396

return value.__get__(self)

877

1397

878

1398

# No such property

879

raise DBusPropertyNotFound(self.dbus_object_path + ":"

880

+ interface_name + "."

881

+ property_name)

882

883

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

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

884

1413

out_signature="v")

885

1414

def Get(self, interface_name, property_name):

886

1415

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

892

1421

if not hasattr(value, "variant_level"):

893

1422

return value

894

1423

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

895

1424

896

1425

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

897

1426

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

898

1427

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

904

1433

# The byte_arrays option is not supported yet on

905

1434

# signatures other than "ay".

906

1435

if prop._dbus_signature != "ay":

907

raise ValueError

908

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

909

for byte in value))

1436

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

1437

"'ay' signature {!r}"

1438

.format(prop._dbus_signature))

1439

value = dbus.ByteArray(bytes(value))

910

1440

prop(value)

911

912

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

1441

1442

@dbus.service.method(dbus.PROPERTIES_IFACE,

1443

in_signature="s",

913

1444

out_signature="a{sv}")

914

1445

def GetAll(self, interface_name):

915

1446

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

916

1447

standard.

917

1448

918

1449

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

919

1450

"""

920

1451

properties = {}

930

1461

if not hasattr(value, "variant_level"):

931

1462

properties[name] = value

932

1463

continue

933

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

934

value.variant_level+1)

1464

properties[name] = type(value)(

1465

value, variant_level=value.variant_level + 1)

935

1466

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

936

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

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

938

1477

out_signature="s",

939

1478

path_keyword='object_path',

940

1479

connection_keyword='connection')

941

1480

def Introspect(self, object_path, connection):

942

1481

"""Overloading of standard D-Bus method.

943

1482

944

1483

Inserts property tags and interface annotation tags.

945

1484

"""

946

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

947

connection)

1485

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1486

object_path,

1487

connection)

948

1488

try:

949

1489

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

1490

950

1491

def make_tag(document, name, prop):

951

1492

e = document.createElement("property")

952

1493

e.setAttribute("name", name)

953

1494

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

954

1495

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

955

1496

return e

1497

956

1498

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

957

1499

# Add property tags

958

1500

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

961

1503

if prop._dbus_interface

962

1504

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

963

1505

if_tag.appendChild(tag)

964

# Add annotation tags

965

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

966

for tag in if_tag.getElementsByTagName(typ):

967

annots = dict()

968

for name, prop in (self.

969

_get_all_dbus_things(typ)):

970

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

971

and prop._dbus_interface

972

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

973

annots.update(getattr

974

(prop,

975

"_dbus_annotations",

976

{}))

977

for name, value in annots.iteritems():

978

ann_tag = document.createElement(

979

"annotation")

980

ann_tag.setAttribute("name", name)

981

ann_tag.setAttribute("value", value)

982

tag.appendChild(ann_tag)

983

# Add interface annotation tags

984

for annotation, value in dict(

985

itertools.chain.from_iterable(

986

annotations().iteritems()

987

for name, annotations in

988

self._get_all_dbus_things("interface")

989

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

990

)).iteritems():

991

ann_tag = document.createElement("annotation")

992

ann_tag.setAttribute("name", annotation)

993

ann_tag.setAttribute("value", value)

994

if_tag.appendChild(ann_tag)

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)

995

1522

# Add the names to the return values for the

996

1523

# "org.freedesktop.DBus.Properties" methods

997

1524

if (if_tag.getAttribute("name")

1016

1543

return xmlstring

1017

1544

1018

1545

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

1019

1617

def datetime_to_dbus(dt, variant_level=0):

1020

1618

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

1021

1619

if dt is None:

1022

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

1023

return dbus.String(dt.isoformat(),

1024

variant_level=variant_level)

1620

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

1621

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

1025

1622

1026

1623

1027

1624

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1029

1626

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

1030

1627

interface names according to the "alt_interface_names" mapping.

1031

1628

Usage:

1032

1629

1033

1630

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

1034

1631

"net.example.AlternateInterface"})

1035

1632

class SampleDBusObject(dbus.service.Object):

1036

1633

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

1037

1634

def SampleDBusMethod():

1038

1635

pass

1039

1636

1040

1637

The above "SampleDBusMethod" on "SampleDBusObject" will be

1041

1638

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

1042

1639

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

1043

1640

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

1044

1641

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

1045

1642

1046

1643

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

1047

1644

(from DBusObjectWithProperties) and interfaces (from the

1048

1645

dbus_interface_annotations decorator).

1049

1646

"""

1647

1050

1648

def wrapper(cls):

1051

1649

for orig_interface_name, alt_interface_name in (

1052

alt_interface_names.iteritems()):

1650

alt_interface_names.items()):

1053

1651

attr = {}

1054

1652

interface_names = set()

1055

1653

# Go though all attributes of the class

1057

1655

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

1058

1656

# with the wrong interface name

1059

1657

if (not hasattr(attribute, "_dbus_interface")

1060

or not attribute._dbus_interface

1061

.startswith(orig_interface_name)):

1658

or not attribute._dbus_interface.startswith(

1659

orig_interface_name)):

1062

1660

continue

1063

1661

# Create an alternate D-Bus interface name based on

1064

1662

# the current name

1065

alt_interface = (attribute._dbus_interface

1066

.replace(orig_interface_name,

1067

alt_interface_name))

1663

alt_interface = attribute._dbus_interface.replace(

1664

orig_interface_name, alt_interface_name)

1068

1665

interface_names.add(alt_interface)

1069

1666

# Is this a D-Bus signal?

1070

1667

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

1071

# Extract the original non-method function by

1072

# black magic

1073

nonmethod_func = (dict(

1668

# Extract the original non-method undecorated

1669

# function by black magic

1670

if sys.version_info.major == 2:

1671

nonmethod_func = (dict(

1074

1672

zip(attribute.func_code.co_freevars,

1075

attribute.__closure__))["func"]

1076

.cell_contents)

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)

1077

1680

# Create a new, but exactly alike, function

1078

1681

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

1079

1682

# with the alternate D-Bus interface name

1080

new_function = (dbus.service.signal

1081

(alt_interface,

1082

attribute._dbus_signature)

1083

(types.FunctionType(

1084

nonmethod_func.func_code,

1085

nonmethod_func.func_globals,

1086

nonmethod_func.func_name,

1087

nonmethod_func.func_defaults,

1088

nonmethod_func.func_closure)))

1683

new_function = copy_function(nonmethod_func)

1684

new_function = (dbus.service.signal(

1685

alt_interface,

1686

attribute._dbus_signature)(new_function))

1089

1687

# Copy annotations, if any

1090

1688

try:

1091

new_function._dbus_annotations = (

1092

dict(attribute._dbus_annotations))

1689

new_function._dbus_annotations = dict(

1690

attribute._dbus_annotations)

1093

1691

except AttributeError:

1094

1692

pass

1693

1095

1694

# Define a creator of a function to call both the

1096

1695

# original and alternate functions, so both the

1097

1696

# original and alternate signals gets sent when

1100

1699

"""This function is a scope container to pass

1101

1700

func1 and func2 to the "call_both" function

1102

1701

outside of its arguments"""

1702

1703

@functools.wraps(func2)

1103

1704

def call_both(*args, **kwargs):

1104

1705

"""This function will emit two D-Bus

1105

1706

signals by calling func1 and func2"""

1106

1707

func1(*args, **kwargs)

1107

1708

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

1108

1715

return call_both

1109

1716

# Create the "call_both" function and add it to

1110

1717

# the class

1115

1722

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

1116

1723

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

1117

1724

# to the class.

1118

attr[attrname] = (dbus.service.method

1119

(alt_interface,

1120

attribute._dbus_in_signature,

1121

attribute._dbus_out_signature)

1122

(types.FunctionType

1123

(attribute.func_code,

1124

attribute.func_globals,

1125

attribute.func_name,

1126

attribute.func_defaults,

1127

attribute.func_closure)))

1725

attr[attrname] = (

1726

dbus.service.method(

1727

alt_interface,

1728

attribute._dbus_in_signature,

1729

attribute._dbus_out_signature)

1730

(copy_function(attribute)))

1128

1731

# Copy annotations, if any

1129

1732

try:

1130

attr[attrname]._dbus_annotations = (

1131

dict(attribute._dbus_annotations))

1733

attr[attrname]._dbus_annotations = dict(

1734

attribute._dbus_annotations)

1132

1735

except AttributeError:

1133

1736

pass

1134

1737

# Is this a D-Bus property?

1137

1740

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

1138

1741

# property with the alternate D-Bus interface

1139

1742

# name. Add it to the class.

1140

attr[attrname] = (dbus_service_property

1141

(alt_interface,

1142

attribute._dbus_signature,

1143

attribute._dbus_access,

1144

attribute

1145

._dbus_get_args_options

1146

["byte_arrays"])

1147

(types.FunctionType

1148

(attribute.func_code,

1149

attribute.func_globals,

1150

attribute.func_name,

1151

attribute.func_defaults,

1152

attribute.func_closure)))

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

1153

1749

# Copy annotations, if any

1154

1750

try:

1155

attr[attrname]._dbus_annotations = (

1156

dict(attribute._dbus_annotations))

1751

attr[attrname]._dbus_annotations = dict(

1752

attribute._dbus_annotations)

1157

1753

except AttributeError:

1158

1754

pass

1159

1755

# Is this a D-Bus interface?

1162

1758

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

1163

1759

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

1164

1760

# to the class.

1165

attr[attrname] = (dbus_interface_annotations

1166

(alt_interface)

1167

(types.FunctionType

1168

(attribute.func_code,

1169

attribute.func_globals,

1170

attribute.func_name,

1171

attribute.func_defaults,

1172

attribute.func_closure)))

1761

attr[attrname] = (

1762

dbus_interface_annotations(alt_interface)

1763

(copy_function(attribute)))

1173

1764

if deprecate:

1174

1765

# Deprecate all alternate interfaces

1175

iname="_AlternateDBusNames_interface_annotation{0}"

1766

iname = "_AlternateDBusNames_interface_annotation{}"

1176

1767

for interface_name in interface_names:

1768

1177

1769

@dbus_interface_annotations(interface_name)

1178

1770

def func(self):

1179

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

1180

"true" }

1771

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

1772

"true"}

1181

1773

# Find an unused name

1182

1774

for aname in (iname.format(i)

1183

1775

for i in itertools.count()):

1187

1779

if interface_names:

1188

1780

# Replace the class with a new subclass of it with

1189

1781

# methods, signals, etc. as created above.

1190

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

1191

(cls,), attr)

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)

1192

1788

return cls

1789

1193

1790

return wrapper

1194

1791

1195

1792

1196

1793

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

1197

"se.bsnet.fukt.Mandos"})

1794

"se.bsnet.fukt.Mandos"})

1198

1795

class ClientDBus(Client, DBusObjectWithProperties):

1199

1796

"""A Client class using D-Bus

1200

1797

1201

1798

Attributes:

1202

1799

dbus_object_path: dbus.ObjectPath

1203

1800

bus: dbus.SystemBus()

1204

1801

"""

1205

1802

1206

1803

runtime_expansions = (Client.runtime_expansions

1207

+ ("dbus_object_path",))

1208

1804

+ ("dbus_object_path", ))

1805

1806

_interface = "se.recompile.Mandos.Client"

1807

1209

1808

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

1210

1211

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

1809

1810

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

1212

1811

self.bus = bus

1213

1812

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

1214

1813

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

1215

1814

# the D-Bus

1216

client_object_name = unicode(self.name).translate(

1815

client_object_name = str(self.name).translate(

1217

1816

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

1218

1817

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

1219

self.dbus_object_path = (dbus.ObjectPath

1220

("/clients/" + client_object_name))

1818

self.dbus_object_path = dbus.ObjectPath(

1819

"/clients/" + client_object_name)

1221

1820

DBusObjectWithProperties.__init__(self, self.bus,

1222

1821

self.dbus_object_path)

1223

1224

def notifychangeproperty(transform_func,

1225

dbus_name, type_func=lambda x: x,

1226

variant_level=1):

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

1227

1828

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

1228

1829

its changes to DBus.

1229

1830

1230

1831

transform_fun: Function that takes a value and a variant_level

1231

1832

and transforms it to a D-Bus type.

1232

1833

dbus_name: D-Bus name of the variable

1234

1835

to the D-Bus. Default: no transform

1235

1836

variant_level: D-Bus variant level. Default: 1

1236

1837

"""

1237

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

1838

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

1839

1238

1840

def setter(self, value):

1239

1841

if hasattr(self, "dbus_object_path"):

1240

1842

if (not hasattr(self, attrname) or

1241

1843

type_func(getattr(self, attrname, None))

1242

1844

!= type_func(value)):

1243

dbus_value = transform_func(type_func(value),

1244

variant_level

1245

=variant_level)

1246

self.PropertyChanged(dbus.String(dbus_name),

1247

dbus_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())

1248

1860

setattr(self, attrname, value)

1249

1861

1250

1862

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

1251

1863

1252

1864

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1253

1865

approvals_pending = notifychangeproperty(dbus.Boolean,

1254

1866

"ApprovalPending",

1255

type_func = bool)

1867

type_func=bool)

1256

1868

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

1257

1869

last_enabled = notifychangeproperty(datetime_to_dbus,

1258

1870

"LastEnabled")

1259

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

1260

type_func = lambda checker:

1261

checker is not None)

1871

checker = notifychangeproperty(

1872

dbus.Boolean, "CheckerRunning",

1873

type_func=lambda checker: checker is not None)

1262

1874

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1263

1875

"LastCheckedOK")

1264

1876

last_checker_status = notifychangeproperty(dbus.Int16,

1267

1879

datetime_to_dbus, "LastApprovalRequest")

1268

1880

approved_by_default = notifychangeproperty(dbus.Boolean,

1269

1881

"ApprovedByDefault")

1270

approval_delay = notifychangeproperty(dbus.UInt64,

1271

"ApprovalDelay",

1272

type_func =

1273

timedelta_to_milliseconds)

1882

approval_delay = notifychangeproperty(

1883

dbus.UInt64, "ApprovalDelay",

1884

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

1274

1885

approval_duration = notifychangeproperty(

1275

1886

dbus.UInt64, "ApprovalDuration",

1276

type_func = timedelta_to_milliseconds)

1887

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

1277

1888

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

1278

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

1279

type_func =

1280

timedelta_to_milliseconds)

1889

timeout = notifychangeproperty(

1890

dbus.UInt64, "Timeout",

1891

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

1281

1892

extended_timeout = notifychangeproperty(

1282

1893

dbus.UInt64, "ExtendedTimeout",

1283

type_func = timedelta_to_milliseconds)

1284

interval = notifychangeproperty(dbus.UInt64,

1285

"Interval",

1286

type_func =

1287

timedelta_to_milliseconds)

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)

1288

1898

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

1289

1899

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

1900

invalidate_only=True)

1901

1290

1902

del notifychangeproperty

1291

1903

1292

1904

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

1293

1905

try:

1294

1906

self.remove_from_connection()

1297

1909

if hasattr(DBusObjectWithProperties, "__del__"):

1298

1910

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

1299

1911

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

1300

1301

def checker_callback(self, pid, condition, command,

1302

*args, **kwargs):

1303

self.checker_callback_tag = None

1304

self.checker = None

1305

if os.WIFEXITED(condition):

1306

exitstatus = os.WEXITSTATUS(condition)

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:

1307

1920

# Emit D-Bus signal

1308

1921

self.CheckerCompleted(dbus.Int16(exitstatus),

1309

dbus.Int64(condition),

1922

# This is specific to GNU libC

1923

dbus.Int64(exitstatus << 8),

1310

1924

dbus.String(command))

1311

1925

else:

1312

1926

# Emit D-Bus signal

1313

1927

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

1314

dbus.Int64(condition),

1928

dbus.Int64(

1929

# This is specific to GNU libC

1930

(exitstatus << 8)

1931

| self.last_checker_signal),

1315

1932

dbus.String(command))

1316

1317

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

1318

*args, **kwargs)

1319

1933

return ret

1934

1320

1935

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

1321

old_checker = self.checker

1322

if self.checker is not None:

1323

old_checker_pid = self.checker.pid

1324

else:

1325

old_checker_pid = None

1936

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

1326

1937

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

1327

1938

# Only if new checker process was started

1328

1939

if (self.checker is not None

1330

1941

# Emit D-Bus signal

1331

1942

self.CheckerStarted(self.current_checker_command)

1332

1943

return r

1333

1944

1334

1945

def _reset_approved(self):

1335

1946

self.approved = None

1336

1947

return False

1337

1948

1338

1949

def approve(self, value=True):

1339

1950

self.approved = value

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1951

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

1952

* 1000), self._reset_approved)

1343

1953

self.send_changedstate()

1344

1345

## D-Bus methods, signals & properties

1346

_interface = "se.recompile.Mandos.Client"

1347

1348

## Interfaces

1349

1350

@dbus_interface_annotations(_interface)

1351

def _foo(self):

1352

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

1353

"false"}

1354

1355

## Signals

1356

1954

1955

# D-Bus methods, signals & properties

1956

1957

# Interfaces

1958

1959

# Signals

1960

1357

1961

# CheckerCompleted - signal

1358

1962

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

1359

1963

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

1360

1964

"D-Bus signal"

1361

1965

pass

1362

1966

1363

1967

# CheckerStarted - signal

1364

1968

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

1365

1969

def CheckerStarted(self, command):

1366

1970

"D-Bus signal"

1367

1971

pass

1368

1972

1369

1973

# PropertyChanged - signal

1974

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

1370

1975

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

1371

1976

def PropertyChanged(self, property, value):

1372

1977

"D-Bus signal"

1373

1978

pass

1374

1979

1375

1980

# GotSecret - signal

1376

1981

@dbus.service.signal(_interface)

1377

1982

def GotSecret(self):

1380

1985

server to mandos-client

1381

1986

"""

1382

1987

pass

1383

1988

1384

1989

# Rejected - signal

1385

1990

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

1386

1991

def Rejected(self, reason):

1387

1992

"D-Bus signal"

1388

1993

pass

1389

1994

1390

1995

# NeedApproval - signal

1391

1996

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

1392

1997

def NeedApproval(self, timeout, default):

1393

1998

"D-Bus signal"

1394

1999

return self.need_approval()

1395

1396

## Methods

1397

2000

2001

# Methods

2002

1398

2003

# Approve - method

1399

2004

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

1400

2005

def Approve(self, value):

1401

2006

self.approve(value)

1402

2007

1403

2008

# CheckedOK - method

1404

2009

@dbus.service.method(_interface)

1405

2010

def CheckedOK(self):

1406

2011

self.checked_ok()

1407

2012

1408

2013

# Enable - method

2014

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

1409

2015

@dbus.service.method(_interface)

1410

2016

def Enable(self):

1411

2017

"D-Bus method"

1412

2018

self.enable()

1413

2019

1414

2020

# StartChecker - method

2021

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

1415

2022

@dbus.service.method(_interface)

1416

2023

def StartChecker(self):

1417

2024

"D-Bus method"

1418

2025

self.start_checker()

1419

2026

1420

2027

# Disable - method

2028

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

1421

2029

@dbus.service.method(_interface)

1422

2030

def Disable(self):

1423

2031

"D-Bus method"

1424

2032

self.disable()

1425

2033

1426

2034

# StopChecker - method

2035

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

1427

2036

@dbus.service.method(_interface)

1428

2037

def StopChecker(self):

1429

2038

self.stop_checker()

1430

1431

## Properties

1432

2039

2040

# Properties

2041

1433

2042

# ApprovalPending - property

1434

2043

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

1435

2044

def ApprovalPending_dbus_property(self):

1436

2045

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

1437

2046

1438

2047

# ApprovedByDefault - property

1439

@dbus_service_property(_interface, signature="b",

2048

@dbus_service_property(_interface,

2049

signature="b",

1440

2050

access="readwrite")

1441

2051

def ApprovedByDefault_dbus_property(self, value=None):

1442

2052

if value is None: # get

1443

2053

return dbus.Boolean(self.approved_by_default)

1444

2054

self.approved_by_default = bool(value)

1445

2055

1446

2056

# ApprovalDelay - property

1447

@dbus_service_property(_interface, signature="t",

2057

@dbus_service_property(_interface,

2058

signature="t",

1448

2059

access="readwrite")

1449

2060

def ApprovalDelay_dbus_property(self, value=None):

1450

2061

if value is None: # get

1451

return dbus.UInt64(self.approval_delay_milliseconds())

2062

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

2063

* 1000)

1452

2064

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

1453

2065

1454

2066

# ApprovalDuration - property

1455

@dbus_service_property(_interface, signature="t",

2067

@dbus_service_property(_interface,

2068

signature="t",

1456

2069

access="readwrite")

1457

2070

def ApprovalDuration_dbus_property(self, value=None):

1458

2071

if value is None: # get

1459

return dbus.UInt64(timedelta_to_milliseconds(

1460

self.approval_duration))

2072

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

2073

* 1000)

1461

2074

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

1462

2075

1463

2076

# Name - property

2077

@dbus_annotations(

2078

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

1464

2079

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

1465

2080

def Name_dbus_property(self):

1466

2081

return dbus.String(self.name)

1467

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

# Fingerprint - property

2091

@dbus_annotations(

2092

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

1469

2093

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

1470

2094

def Fingerprint_dbus_property(self):

1471

2095

return dbus.String(self.fingerprint)

1472

2096

1473

2097

# Host - property

1474

@dbus_service_property(_interface, signature="s",

2098

@dbus_service_property(_interface,

2099

signature="s",

1475

2100

access="readwrite")

1476

2101

def Host_dbus_property(self, value=None):

1477

2102

if value is None: # get

1478

2103

return dbus.String(self.host)

1479

self.host = unicode(value)

1480

2104

self.host = str(value)

2105

1481

2106

# Created - property

2107

@dbus_annotations(

2108

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

1482

2109

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

1483

2110

def Created_dbus_property(self):

1484

2111

return datetime_to_dbus(self.created)

1485

2112

1486

2113

# LastEnabled - property

1487

2114

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

1488

2115

def LastEnabled_dbus_property(self):

1489

2116

return datetime_to_dbus(self.last_enabled)

1490

2117

1491

2118

# Enabled - property

1492

@dbus_service_property(_interface, signature="b",

2119

@dbus_service_property(_interface,

2120

signature="b",

1493

2121

access="readwrite")

1494

2122

def Enabled_dbus_property(self, value=None):

1495

2123

if value is None: # get

1498

2126

self.enable()

1499

2127

else:

1500

2128

self.disable()

1501

2129

1502

2130

# LastCheckedOK - property

1503

@dbus_service_property(_interface, signature="s",

2131

@dbus_service_property(_interface,

2132

signature="s",

1504

2133

access="readwrite")

1505

2134

def LastCheckedOK_dbus_property(self, value=None):

1506

2135

if value is not None:

1507

2136

self.checked_ok()

1508

2137

return

1509

2138

return datetime_to_dbus(self.last_checked_ok)

1510

2139

1511

2140

# LastCheckerStatus - property

1512

@dbus_service_property(_interface, signature="n",

1513

access="read")

2141

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

1514

2142

def LastCheckerStatus_dbus_property(self):

1515

2143

return dbus.Int16(self.last_checker_status)

1516

2144

1517

2145

# Expires - property

1518

2146

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

1519

2147

def Expires_dbus_property(self):

1520

2148

return datetime_to_dbus(self.expires)

1521

2149

1522

2150

# LastApprovalRequest - property

1523

2151

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

1524

2152

def LastApprovalRequest_dbus_property(self):

1525

2153

return datetime_to_dbus(self.last_approval_request)

1526

2154

1527

2155

# Timeout - property

1528

@dbus_service_property(_interface, signature="t",

2156

@dbus_service_property(_interface,

2157

signature="t",

1529

2158

access="readwrite")

1530

2159

def Timeout_dbus_property(self, value=None):

1531

2160

if value is None: # get

1532

return dbus.UInt64(self.timeout_milliseconds())

2161

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

1533

2162

old_timeout = self.timeout

1534

2163

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

1535

2164

# Reschedule disabling

1543

2172

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

1544

2173

is None):

1545

2174

return

1546

gobject.source_remove(self.disable_initiator_tag)

1547

self.disable_initiator_tag = (

1548

gobject.timeout_add(

1549

timedelta_to_milliseconds(self.expires - now),

1550

self.disable))

1551

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

1552

2180

# ExtendedTimeout - property

1553

@dbus_service_property(_interface, signature="t",

2181

@dbus_service_property(_interface,

2182

signature="t",

1554

2183

access="readwrite")

1555

2184

def ExtendedTimeout_dbus_property(self, value=None):

1556

2185

if value is None: # get

1557

return dbus.UInt64(self.extended_timeout_milliseconds())

2186

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

2187

* 1000)

1558

2188

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

1559

2189

1560

2190

# Interval - property

1561

@dbus_service_property(_interface, signature="t",

2191

@dbus_service_property(_interface,

2192

signature="t",

1562

2193

access="readwrite")

1563

2194

def Interval_dbus_property(self, value=None):

1564

2195

if value is None: # get

1565

return dbus.UInt64(self.interval_milliseconds())

2196

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

1566

2197

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

1567

2198

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

1568

2199

return

1569

2200

if self.enabled:

1570

2201

# Reschedule checker run

1571

gobject.source_remove(self.checker_initiator_tag)

1572

self.checker_initiator_tag = (gobject.timeout_add

1573

(value, self.start_checker))

1574

self.start_checker() # Start one now, too

1575

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

1576

2207

# Checker - property

1577

@dbus_service_property(_interface, signature="s",

2208

@dbus_service_property(_interface,

2209

signature="s",

1578

2210

access="readwrite")

1579

2211

def Checker_dbus_property(self, value=None):

1580

2212

if value is None: # get

1581

2213

return dbus.String(self.checker_command)

1582

self.checker_command = unicode(value)

1583

2214

self.checker_command = str(value)

2215

1584

2216

# CheckerRunning - property

1585

@dbus_service_property(_interface, signature="b",

2217

@dbus_service_property(_interface,

2218

signature="b",

1586

2219

access="readwrite")

1587

2220

def CheckerRunning_dbus_property(self, value=None):

1588

2221

if value is None: # get

1591

2224

self.start_checker()

1592

2225

else:

1593

2226

self.stop_checker()

1594

2227

1595

2228

# ObjectPath - property

2229

@dbus_annotations(

2230

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

2231

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

1596

2232

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

1597

2233

def ObjectPath_dbus_property(self):

1598

return self.dbus_object_path # is already a dbus.ObjectPath

1599

2234

return self.dbus_object_path # is already a dbus.ObjectPath

2235

1600

2236

# Secret = property

1601

@dbus_service_property(_interface, signature="ay",

1602

access="write", byte_arrays=True)

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)

1603

2244

def Secret_dbus_property(self, value):

1604

self.secret = str(value)

1605

2245

self.secret = bytes(value)

2246

1606

2247

del _interface

1607

2248

1608

2249

1609

class ProxyClient(object):

1610

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

2250

class ProxyClient:

2251

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

1611

2252

self._pipe = child_pipe

1612

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

2253

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

1613

2254

if not self._pipe.recv():

1614

raise KeyError()

1615

2255

raise KeyError(key_id or fpr)

2256

1616

2257

def __getattribute__(self, name):

1617

2258

if name == '_pipe':

1618

2259

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

1621

2262

if data[0] == 'data':

1622

2263

return data[1]

1623

2264

if data[0] == 'function':

2265

1624

2266

def func(*args, **kwargs):

1625

2267

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

1626

2268

return self._pipe.recv()[1]

2269

1627

2270

return func

1628

2271

1629

2272

def __setattr__(self, name, value):

1630

2273

if name == '_pipe':

1631

2274

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

1634

2277

1635

2278

class ClientHandler(socketserver.BaseRequestHandler, object):

1636

2279

"""A class to handle client connections.

1637

2280

1638

2281

Instantiated once for each connection to handle it.

1639

2282

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

1640

2283

1641

2284

def handle(self):

1642

2285

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

1643

2286

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

1644

unicode(self.client_address))

2287

str(self.client_address))

1645

2288

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

1646

2289

self.server.child_pipe.fileno())

1647

1648

session = (gnutls.connection

1649

.ClientSession(self.request,

1650

gnutls.connection

1651

.X509Credentials()))

1652

1653

# Note: gnutls.connection.X509Credentials is really a

1654

# generic GnuTLS certificate credentials object so long as

1655

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

1656

# here despite using OpenPGP certificates.

1657

1658

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

1659

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

1660

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

1661

# "+DHE-DSS"))

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

1662

2297

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

1663

2298

priority = self.server.gnutls_priority

1664

2299

if priority is None:

1665

2300

priority = "NORMAL"

1666

(gnutls.library.functions

1667

.gnutls_priority_set_direct(session._c_object,

1668

priority, None))

1669

2301

gnutls.priority_set_direct(session._c_object,

2302

priority.encode("utf-8"),

2303

None)

2304

1670

2305

# Start communication using the Mandos protocol

1671

2306

# Get protocol number

1672

2307

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

1673

2308

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

1674

2309

try:

1675

2310

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

1676

raise RuntimeError

2311

raise RuntimeError(line)

1677

2312

except (ValueError, IndexError, RuntimeError) as error:

1678

2313

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

1679

2314

return

1680

2315

1681

2316

# Start GnuTLS connection

1682

2317

try:

1683

2318

session.handshake()

1684

except gnutls.errors.GNUTLSError as error:

2319

except gnutls.Error as error:

1685

2320

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

1686

2321

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

1687

2322

# established. Just abandon the request.

1688

2323

return

1689

2324

logger.debug("Handshake succeeded")

1690

2325

1691

2326

approval_required = False

1692

2327

try:

1693

try:

1694

fpr = self.fingerprint(self.peer_certificate

1695

(session))

1696

except (TypeError,

1697

gnutls.errors.GNUTLSError) as error:

1698

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

1699

return

1700

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

1701

1702

try:

1703

client = ProxyClient(child_pipe, fpr,

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,

1704

2350

self.client_address)

1705

2351

except KeyError:

1706

2352

return

1707

2353

1708

2354

if client.approval_delay:

1709

2355

delay = client.approval_delay

1710

2356

client.approvals_pending += 1

1711

2357

approval_required = True

1712

2358

1713

2359

while True:

1714

2360

if not client.enabled:

1715

2361

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

1716

client.name)

2362

client.name)

1717

2363

if self.server.use_dbus:

1718

2364

# Emit D-Bus signal

1719

2365

client.Rejected("Disabled")

1720

2366

return

1721

2367

1722

2368

if client.approved or not client.approval_delay:

1723

#We are approved or approval is disabled

2369

# We are approved or approval is disabled

1724

2370

break

1725

2371

elif client.approved is None:

1726

2372

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

1728

2374

if self.server.use_dbus:

1729

2375

# Emit D-Bus signal

1730

2376

client.NeedApproval(

1731

client.approval_delay_milliseconds(),

1732

client.approved_by_default)

2377

client.approval_delay.total_seconds()

2378

* 1000, client.approved_by_default)

1733

2379

else:

1734

2380

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

1735

2381

client.name)

1737

2383

# Emit D-Bus signal

1738

2384

client.Rejected("Denied")

1739

2385

return

1740

1741

#wait until timeout or approved

2386

2387

# wait until timeout or approved

1742

2388

time = datetime.datetime.now()

1743

2389

client.changedstate.acquire()

1744

client.changedstate.wait(

1745

float(timedelta_to_milliseconds(delay)

1746

/ 1000))

2390

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

1747

2391

client.changedstate.release()

1748

2392

time2 = datetime.datetime.now()

1749

2393

if (time2 - time) >= delay:

1759

2403

break

1760

2404

else:

1761

2405

delay -= time2 - time

1762

1763

sent_size = 0

1764

while sent_size < len(client.secret):

1765

try:

1766

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

1767

except gnutls.errors.GNUTLSError as error:

1768

logger.warning("gnutls send failed",

1769

exc_info=error)

1770

return

1771

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

1772

sent, len(client.secret)

1773

- (sent_size + sent))

1774

sent_size += sent

1775

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

1776

2414

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

1777

2415

# bump the timeout using extended_timeout

1778

2416

client.bump_timeout(client.extended_timeout)

1779

2417

if self.server.use_dbus:

1780

2418

# Emit D-Bus signal

1781

2419

client.GotSecret()

1782

2420

1783

2421

finally:

1784

2422

if approval_required:

1785

2423

client.approvals_pending -= 1

1786

2424

try:

1787

2425

session.bye()

1788

except gnutls.errors.GNUTLSError as error:

2426

except gnutls.Error as error:

1789

2427

logger.warning("GnuTLS bye failed",

1790

2428

exc_info=error)

1791

2429

1792

2430

@staticmethod

1793

2431

def peer_certificate(session):

1794

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

1795

# If not an OpenPGP certificate...

1796

if (gnutls.library.functions

1797

.gnutls_certificate_type_get(session._c_object)

1798

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1799

# ...do the normal thing

1800

return session.peer_certificate

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

1801

2448

list_size = ctypes.c_uint(1)

1802

cert_list = (gnutls.library.functions

1803

.gnutls_certificate_get_peers

2449

cert_list = (gnutls.certificate_get_peers

1804

2450

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

1805

2451

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

1806

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

1807

" certificate")

2452

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

1808

2453

if list_size.value == 0:

1809

2454

return None

1810

2455

cert = cert_list[0]

1811

2456

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

1812

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

@staticmethod

1814

2494

def fingerprint(openpgp):

1815

2495

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1816

2496

# New GnuTLS "datum" with the OpenPGP public key

1817

datum = (gnutls.library.types

1818

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

1819

ctypes.POINTER

1820

(ctypes.c_ubyte)),

1821

ctypes.c_uint(len(openpgp))))

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

1822

2501

# New empty GnuTLS certificate

1823

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1824

(gnutls.library.functions

1825

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2502

crt = gnutls.openpgp_crt_t()

2503

gnutls.openpgp_crt_init(ctypes.byref(crt))

1826

2504

# Import the OpenPGP public key into the certificate

1827

(gnutls.library.functions

1828

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

1829

gnutls.library.constants

1830

.GNUTLS_OPENPGP_FMT_RAW))

2505

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

2506

gnutls.OPENPGP_FMT_RAW)

1831

2507

# Verify the self signature in the key

1832

2508

crtverify = ctypes.c_uint()

1833

(gnutls.library.functions

1834

.gnutls_openpgp_crt_verify_self(crt, 0,

1835

ctypes.byref(crtverify)))

2509

gnutls.openpgp_crt_verify_self(crt, 0,

2510

ctypes.byref(crtverify))

1836

2511

if crtverify.value != 0:

1837

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1838

raise (gnutls.errors.CertificateSecurityError

1839

("Verify failed"))

2512

gnutls.openpgp_crt_deinit(crt)

2513

raise gnutls.CertificateSecurityError(code

2514

=crtverify.value)

1840

2515

# New buffer for the fingerprint

1841

2516

buf = ctypes.create_string_buffer(20)

1842

2517

buf_len = ctypes.c_size_t()

1843

2518

# Get the fingerprint from the certificate into the buffer

1844

(gnutls.library.functions

1845

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

1846

ctypes.byref(buf_len)))

2519

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

2520

ctypes.byref(buf_len))

1847

2521

# Deinit the certificate

1848

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2522

gnutls.openpgp_crt_deinit(crt)

1849

2523

# Convert the buffer to a Python bytestring

1850

2524

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

1851

2525

# Convert the bytestring to hexadecimal notation

1853

2527

return hex_fpr

1854

2528

1855

2529

1856

class MultiprocessingMixIn(object):

2530

class MultiprocessingMixIn:

1857

2531

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

2532

1858

2533

def sub_process_main(self, request, address):

1859

2534

try:

1860

2535

self.finish_request(request, address)

1861

2536

except Exception:

1862

2537

self.handle_error(request, address)

1863

2538

self.close_request(request)

1864

2539

1865

2540

def process_request(self, request, address):

1866

2541

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

1867

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

1868

args = (request, address))

2542

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

2543

args=(request, address))

1869

2544

proc.start()

1870

2545

return proc

1871

2546

1872

2547

1873

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2548

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1874

2549

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

2550

1875

2551

def process_request(self, request, client_address):

1876

2552

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

1877

2553

1878

2554

This function creates a new pipe in self.pipe

1879

2555

"""

1880

2556

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1881

2557

1882

2558

proc = MultiprocessingMixIn.process_request(self, request,

1883

2559

client_address)

1884

2560

self.child_pipe.close()

1885

2561

self.add_pipe(parent_pipe, proc)

1886

2562

1887

2563

def add_pipe(self, parent_pipe, proc):

1888

2564

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

1889

raise NotImplementedError

2565

raise NotImplementedError()

1890

2566

1891

2567

1892

2568

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1893

socketserver.TCPServer, object):

2569

socketserver.TCPServer):

1894

2570

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

1895

2571

1896

2572

Attributes:

1897

2573

enabled: Boolean; whether this server is activated yet

1898

2574

interface: None or a network interface name (string)

1899

2575

use_ipv6: Boolean; to use IPv6 or not

1900

2576

"""

2577

1901

2578

def __init__(self, server_address, RequestHandlerClass,

1902

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

2579

interface=None,

2580

use_ipv6=True,

2581

socketfd=None):

1903

2582

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

1904

2583

creating a new one with socket.socket().

1905

2584

"""

1911

2590

self.socketfd = socketfd

1912

2591

# Save the original socket.socket() function

1913

2592

self.socket_socket = socket.socket

2593

1914

2594

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

1915

#

2595

#

1916

2596

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

1917

2597

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

1918

2598

# patching socket.socket.)

1919

#

2599

#

1920

2600

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

1921

2601

@functools.wraps(socket.socket)

1922

2602

def socket_wrapper(*args, **kwargs):

1934

2614

# socket_wrapper(), if socketfd was set.

1935

2615

socketserver.TCPServer.__init__(self, server_address,

1936

2616

RequestHandlerClass)

1937

2617

1938

2618

def server_bind(self):

1939

2619

"""This overrides the normal server_bind() function

1940

2620

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

1941

2621

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

2622

global SO_BINDTODEVICE

1942

2623

if self.interface is not None:

1943

2624

if SO_BINDTODEVICE is None:

1944

logger.error("SO_BINDTODEVICE does not exist;"

1945

" cannot bind to interface %s",

1946

self.interface)

1947

else:

1948

try:

1949

self.socket.setsockopt(socket.SOL_SOCKET,

1950

SO_BINDTODEVICE,

1951

str(self.interface

1952

+ '\0'))

1953

except socket.error as error:

1954

if error.errno == errno.EPERM:

1955

logger.error("No permission to"

1956

" bind to interface %s",

1957

self.interface)

1958

elif error.errno == errno.ENOPROTOOPT:

1959

logger.error("SO_BINDTODEVICE not available;"

1960

" cannot bind to interface %s",

1961

self.interface)

1962

elif error.errno == errno.ENODEV:

1963

logger.error("Interface %s does not"

1964

" exist, cannot bind",

1965

self.interface)

1966

else:

1967

raise

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

1968

2646

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

1969

2647

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

2648

if self.server_address[1]:

2649

self.allow_reuse_address = True

1970

2650

if not self.server_address[0]:

1971

2651

if self.address_family == socket.AF_INET6:

1972

any_address = "::" # in6addr_any

2652

any_address = "::" # in6addr_any

1973

2653

else:

1974

any_address = socket.INADDR_ANY

2654

any_address = "0.0.0.0" # INADDR_ANY

1975

2655

self.server_address = (any_address,

1976

2656

self.server_address[1])

1977

2657

elif not self.server_address[1]:

1978

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

1979

0)

2658

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

1980

2659

# if self.interface:

1981

2660

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

1982

2661

# 0, # port

1988

2667

1989

2668

class MandosServer(IPv6_TCPServer):

1990

2669

"""Mandos server.

1991

2670

1992

2671

Attributes:

1993

2672

clients: set of Client objects

1994

2673

gnutls_priority GnuTLS priority string

1995

2674

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

1996

1997

Assumes a gobject.MainLoop event loop.

2675

2676

Assumes a GLib.MainLoop event loop.

1998

2677

"""

2678

1999

2679

def __init__(self, server_address, RequestHandlerClass,

2000

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

2001

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

2680

interface=None,

2681

use_ipv6=True,

2682

clients=None,

2683

gnutls_priority=None,

2684

use_dbus=True,

2685

socketfd=None):

2002

2686

self.enabled = False

2003

2687

self.clients = clients

2004

2688

if self.clients is None:

2007

2691

self.gnutls_priority = gnutls_priority

2008

2692

IPv6_TCPServer.__init__(self, server_address,

2009

2693

RequestHandlerClass,

2010

interface = interface,

2011

use_ipv6 = use_ipv6,

2012

socketfd = socketfd)

2694

interface=interface,

2695

use_ipv6=use_ipv6,

2696

socketfd=socketfd)

2697

2013

2698

def server_activate(self):

2014

2699

if self.enabled:

2015

2700

return socketserver.TCPServer.server_activate(self)

2016

2701

2017

2702

def enable(self):

2018

2703

self.enabled = True

2019

2704

2020

2705

def add_pipe(self, parent_pipe, proc):

2021

2706

# Call "handle_ipc" for both data and EOF events

2022

gobject.io_add_watch(parent_pipe.fileno(),

2023

gobject.IO_IN | gobject.IO_HUP,

2024

functools.partial(self.handle_ipc,

2025

parent_pipe =

2026

parent_pipe,

2027

proc = proc))

2028

2029

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

2030

proc = None, client_object=None):

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

2031

2718

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

2032

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

2719

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

2033

2720

# Wait for other process to exit

2034

2721

proc.join()

2035

2722

return False

2036

2723

2037

2724

# Read a request from the child

2038

2725

request = parent_pipe.recv()

2039

2726

command = request[0]

2040

2727

2041

2728

if command == 'init':

2042

fpr = request[1]

2043

address = request[2]

2044

2045

for c in self.clients.itervalues():

2046

if c.fingerprint == fpr:

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:

2047

2741

client = c

2048

2742

break

2049

2743

else:

2050

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

2051

"dress: %s", fpr, address)

2744

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

2745

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

2052

2746

if self.use_dbus:

2053

2747

# Emit D-Bus signal

2054

mandos_dbus_service.ClientNotFound(fpr,

2748

mandos_dbus_service.ClientNotFound(key_id or fpr,

2055

2749

address[0])

2056

2750

parent_pipe.send(False)

2057

2751

return False

2058

2059

gobject.io_add_watch(parent_pipe.fileno(),

2060

gobject.IO_IN | gobject.IO_HUP,

2061

functools.partial(self.handle_ipc,

2062

parent_pipe =

2063

parent_pipe,

2064

proc = proc,

2065

client_object =

2066

client))

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

2067

2760

parent_pipe.send(True)

2068

2761

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

2069

2762

# same fileno

2072

2765

funcname = request[1]

2073

2766

args = request[2]

2074

2767

kwargs = request[3]

2075

2768

2076

2769

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

2077

2770

funcname)(*args,

2078

**kwargs)))

2079

2771

**kwargs)))

2772

2080

2773

if command == 'getattr':

2081

2774

attrname = request[1]

2082

if callable(client_object.__getattribute__(attrname)):

2083

parent_pipe.send(('function',))

2775

if isinstance(client_object.__getattribute__(attrname),

2776

collections.abc.Callable):

2777

parent_pipe.send(('function', ))

2084

2778

else:

2085

parent_pipe.send(('data', client_object

2086

.__getattribute__(attrname)))

2087

2779

parent_pipe.send((

2780

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

2781

2088

2782

if command == 'setattr':

2089

2783

attrname = request[1]

2090

2784

value = request[2]

2091

2785

setattr(client_object, attrname, value)

2092

2786

2093

2787

return True

2094

2788

2095

2789

2790

def rfc3339_duration_to_delta(duration):

2791

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

2809

"""

2810

2811

# Parsing an RFC 3339 duration with regular expressions is not

2812

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

2813

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

2814

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

2815

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

2816

# avoid excessive use of external libraries.

2817

2818

# 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

2824

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

2825

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

2826

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

2827

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

2828

datetime.timedelta(seconds=1),

2829

frozenset((token_end, )))

2830

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

2831

datetime.timedelta(minutes=1),

2832

frozenset((token_second, token_end)))

2833

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

2834

datetime.timedelta(hours=1),

2835

frozenset((token_minute, token_end)))

2836

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

2837

None,

2838

frozenset((token_hour, token_minute,

2839

token_second)))

2840

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

2841

datetime.timedelta(days=1),

2842

frozenset((token_time, token_end)))

2843

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

2844

datetime.timedelta(weeks=4),

2845

frozenset((token_day, token_end)))

2846

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

2847

datetime.timedelta(weeks=52),

2848

frozenset((token_month, token_end)))

2849

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

2850

datetime.timedelta(weeks=1),

2851

frozenset((token_end, )))

2852

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

2853

frozenset((token_year, token_month,

2854

token_day, token_time,

2855

token_week)))

2856

# Define starting values:

2857

# Value so far

2858

value = datetime.timedelta()

2859

found_token = None

2860

# Following valid tokens

2861

followers = frozenset((token_duration, ))

2862

# String left to parse

2863

s = duration

2864

# Loop until end token is found

2865

while found_token is not token_end:

2866

# Search for any currently valid tokens

2867

for token in followers:

2868

match = token.regexp.match(s)

2869

if match is not None:

2870

# Token found

2871

if token.value is not None:

2872

# Value found, parse digits

2873

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

2874

# Add to value so far

2875

value += factor * token.value

2876

# Strip token from string

2877

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

2878

# Go to found token

2879

found_token = token

2880

# Set valid next tokens

2881

followers = found_token.followers

2882

break

2883

else:

2884

# No currently valid tokens were found

2885

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

2886

.format(duration))

2887

# End token found

2888

return value

2889

2890

2096

2891

def string_to_delta(interval):

2097

2892

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

2098

2099

>>> string_to_delta('7d')

2100

datetime.timedelta(7)

2101

>>> string_to_delta('60s')

2102

datetime.timedelta(0, 60)

2103

>>> string_to_delta('60m')

2104

datetime.timedelta(0, 3600)

2105

>>> string_to_delta('24h')

2106

datetime.timedelta(1)

2107

>>> string_to_delta('1w')

2108

datetime.timedelta(7)

2109

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

2110

datetime.timedelta(0, 330)

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

2111

2906

"""

2907

2908

try:

2909

return rfc3339_duration_to_delta(interval)

2910

except ValueError:

2911

pass

2912

2112

2913

timevalue = datetime.timedelta(0)

2113

2914

for s in interval.split():

2114

2915

try:

2115

suffix = unicode(s[-1])

2916

suffix = s[-1]

2116

2917

value = int(s[:-1])

2117

2918

if suffix == "d":

2118

2919

delta = datetime.timedelta(value)

2125

2926

elif suffix == "w":

2126

2927

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

2127

2928

else:

2128

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

2129

.format(suffix))

2130

except (ValueError, IndexError) as e:

2929

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

2930

except IndexError as e:

2131

2931

raise ValueError(*(e.args))

2132

2932

timevalue += delta

2133

2933

return timevalue

2134

2934

2135

2935

2136

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

2936

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

2137

2937

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

2138

2938

2139

2939

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

2140

2940

if os.fork():

2141

2941

sys.exit()

2149

2949

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

2150

2950

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

2151

2951

raise OSError(errno.ENODEV,

2152

"{0} not a character device"

2952

"{} not a character device"

2153

2953

.format(os.devnull))

2154

2954

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

2155

2955

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

2159

2959

2160

2960

2161

2961

def main():

2162

2962

2163

2963

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

2164

2964

# Parsing of options, both command line and config file

2165

2965

2166

2966

parser = argparse.ArgumentParser()

2167

2967

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

2168

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

2968

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

2169

2969

help="show version number and exit")

2170

2970

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

2171

2971

help="Bind to interface IF")

2177

2977

help="Run self-test")

2178

2978

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

2179

2979

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

2180

" to terminal")

2980

" to terminal", default=None)

2181

2981

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

2182

2982

help="Debug level for stdout output")

2183

2983

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

2190

2990

" files")

2191

2991

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

2192

2992

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

2193

" system bus interface")

2993

" system bus interface", default=None)

2194

2994

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

2195

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

2995

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

2996

default=None)

2196

2997

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

2197

2998

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

2198

" state")

2999

" state", default=None)

2199

3000

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

2200

3001

help="Specify a file descriptor to a network"

2201

3002

" socket to use instead of creating one")

2202

3003

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

2203

3004

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

2204

3005

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

2205

3011

options = parser.parse_args()

2206

2207

if options.check:

2208

import doctest

2209

doctest.testmod()

2210

sys.exit()

2211

3012

2212

3013

# Default values for config file for server-global settings

2213

server_defaults = { "interface": "",

2214

"address": "",

2215

"port": "",

2216

"debug": "False",

2217

"priority":

2218

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

2219

"servicename": "Mandos",

2220

"use_dbus": "True",

2221

"use_ipv6": "True",

2222

"debuglevel": "",

2223

"restore": "True",

2224

"socket": "",

2225

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

2226

}

2227

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

2228

3037

# Parse config file for server-global settings

2229

server_config = configparser.SafeConfigParser(server_defaults)

3038

server_config = configparser.ConfigParser(server_defaults)

2230

3039

del server_defaults

2231

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

2232

"mandos.conf"))

2233

# Convert the SafeConfigParser object to a dict

3040

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

3041

# Convert the ConfigParser object to a dict

2234

3042

server_settings = server_config.defaults()

2235

3043

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

2236

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

3044

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

3045

"foreground", "zeroconf"):

2237

3046

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

2238

3047

option)

2239

3048

if server_settings["port"]:

2249

3058

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

2250

3059

["socket"])

2251

3060

del server_config

2252

3061

2253

3062

# Override the settings from the config file with command line

2254

3063

# options, if set.

2255

3064

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

2256

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

2257

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

2258

"statedir", "socket"):

3065

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

3066

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

3067

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

2259

3068

value = getattr(options, option)

2260

3069

if value is not None:

2261

3070

server_settings[option] = value

2262

3071

del options

2263

3072

# Force all strings to be unicode

2264

3073

for option in server_settings.keys():

2265

if type(server_settings[option]) is str:

2266

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

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

3081

# Debug implies foreground

3082

if server_settings["debug"]:

3083

server_settings["foreground"] = True

2267

3084

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

2268

3085

2269

3086

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

2270

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

2271

3093

# For convenience

2272

3094

debug = server_settings["debug"]

2273

3095

debuglevel = server_settings["debuglevel"]

2275

3097

use_ipv6 = server_settings["use_ipv6"]

2276

3098

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

2277

3099

stored_state_file)

2278

3100

foreground = server_settings["foreground"]

3101

zeroconf = server_settings["zeroconf"]

3102

2279

3103

if debug:

2280

3104

initlogger(debug, logging.DEBUG)

2281

3105

else:

2284

3108

else:

2285

3109

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

2286

3110

initlogger(debug, level)

2287

3111

2288

3112

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

2289

syslogger.setFormatter(logging.Formatter

2290

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

2291

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

2292

.format(server_settings

2293

["servicename"])))

2294

3113

syslogger.setFormatter(

3114

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

3115

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

3116

server_settings["servicename"])))

3117

2295

3118

# Parse config file with clients

2296

client_config = configparser.SafeConfigParser(Client

2297

.client_defaults)

3119

client_config = configparser.ConfigParser(Client.client_defaults)

2298

3120

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

2299

3121

"clients.conf"))

2300

3122

2301

3123

global mandos_dbus_service

2302

3124

mandos_dbus_service = None

2303

2304

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

2305

server_settings["port"]),

2306

ClientHandler,

2307

interface=(server_settings["interface"]

2308

or None),

2309

use_ipv6=use_ipv6,

2310

gnutls_priority=

2311

server_settings["priority"],

2312

use_dbus=use_dbus,

2313

socketfd=(server_settings["socket"]

2314

or None))

2315

if not debug:

2316

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

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)

3137

if not foreground:

3138

pidfilename = "/run/mandos.pid"

3139

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

3140

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

3141

pidfile = None

2317

3142

try:

2318

pidfile = open(pidfilename, "w")

3143

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

2319

3144

except IOError as e:

2320

3145

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

2321

3146

exc_info=e)

2322

2323

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

3147

3148

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

3149

("mandos", "mandos"),

3150

("nobody", "nogroup")):

2324

3151

try:

2325

3152

uid = pwd.getpwnam(name).pw_uid

2326

gid = pwd.getpwnam(name).pw_gid

3153

gid = pwd.getpwnam(group).pw_gid

2327

3154

break

2328

3155

except KeyError:

2329

3156

continue

2333

3160

try:

2334

3161

os.setgid(gid)

2335

3162

os.setuid(uid)

3163

if debug:

3164

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

3165

gid))

2336

3166

except OSError as error:

3167

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

3168

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

2337

3169

if error.errno != errno.EPERM:

2338

raise error

2339

3170

raise

3171

2340

3172

if debug:

2341

3173

# Enable all possible GnuTLS debugging

2342

3174

2343

3175

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

2344

3176

# - GnuTLS manual

2345

gnutls.library.functions.gnutls_global_set_log_level(11)

2346

2347

@gnutls.library.types.gnutls_log_func

3177

gnutls.global_set_log_level(11)

3178

3179

@gnutls.log_func

2348

3180

def debug_gnutls(level, string):

2349

3181

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

2350

2351

(gnutls.library.functions

2352

.gnutls_global_set_log_function(debug_gnutls))

2353

3182

3183

gnutls.global_set_log_function(debug_gnutls)

3184

2354

3185

# Redirect stdin so all checkers get /dev/null

2355

3186

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

2356

3187

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

2357

3188

if null > 2:

2358

3189

os.close(null)

2359

3190

2360

3191

# Need to fork before connecting to D-Bus

2361

if not debug:

3192

if not foreground:

2362

3193

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

2363

3194

daemon()

2364

2365

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

2366

# need to inform gobject that threads will be used.

2367

gobject.threads_init()

2368

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

2369

3201

global main_loop

2370

3202

# From the Avahi example code

2371

3203

DBusGMainLoop(set_as_default=True)

2372

main_loop = gobject.MainLoop()

3204

main_loop = GLib.MainLoop()

2373

3205

bus = dbus.SystemBus()

2374

3206

# End of Avahi example code

2375

3207

if use_dbus:

2376

3208

try:

2377

3209

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

2378

bus, do_not_queue=True)

2379

old_bus_name = (dbus.service.BusName

2380

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

2381

do_not_queue=True))

2382

except dbus.exceptions.NameExistsException as e:

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:

2383

3216

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

2384

3217

use_dbus = False

2385

3218

server_settings["use_dbus"] = False

2386

3219

tcp_server.use_dbus = False

2387

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2388

service = AvahiServiceToSyslog(name =

2389

server_settings["servicename"],

2390

servicetype = "_mandos._tcp",

2391

protocol = protocol, bus = bus)

2392

if server_settings["interface"]:

2393

service.interface = (if_nametoindex

2394

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

2395

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

2396

3231

global multiprocessing_manager

2397

3232

multiprocessing_manager = multiprocessing.Manager()

2398

3233

2399

3234

client_class = Client

2400

3235

if use_dbus:

2401

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

2402

3236

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

3237

2403

3238

client_settings = Client.config_parser(client_config)

2404

3239

old_client_settings = {}

2405

3240

clients_data = {}

2406

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

2407

3250

# Get client data and settings from last running state.

2408

3251

if server_settings["restore"]:

2409

3252

try:

2410

3253

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

2411

clients_data, old_client_settings = (pickle.load

2412

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

2413

3304

os.remove(stored_state_path)

2414

3305

except IOError as e:

2415

3306

if e.errno == errno.ENOENT:

2416

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

2417

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

3307

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

3308

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

2418

3309

else:

2419

3310

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

2420

3311

exc_info=e)

2421

3312

raise

2422

3313

except EOFError as e:

2423

3314

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

2424

"EOFError:", exc_info=e)

2425

3315

"EOFError:",

3316

exc_info=e)

3317

2426

3318

with PGPEngine() as pgp:

2427

for client_name, client in clients_data.iteritems():

3319

for client_name, client in clients_data.items():

3320

# Skip removed clients

3321

if client_name not in client_settings:

3322

continue

3323

2428

3324

# Decide which value to use after restoring saved state.

2429

3325

# We have three different values: Old config file,

2430

3326

# new config file, and saved state.

2435

3331

# For each value in new config, check if it

2436

3332

# differs from the old config value (Except for

2437

3333

# the "secret" attribute)

2438

if (name != "secret" and

2439

value != old_client_settings[client_name]

2440

[name]):

3334

if (name != "secret"

3335

and (value !=

3336

old_client_settings[client_name][name])):

2441

3337

client[name] = value

2442

3338

except KeyError:

2443

3339

pass

2444

3340

2445

3341

# Clients who has passed its expire date can still be

2446

# enabled if its last checker was successful. Clients

3342

# enabled if its last checker was successful. A Client

2447

3343

# whose checker succeeded before we stored its state is

2448

3344

# assumed to have successfully run all checkers during

2449

3345

# downtime.

2451

3347

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

2452

3348

if not client["last_checked_ok"]:

2453

3349

logger.warning(

2454

"disabling client {0} - Client never "

2455

"performed a successful checker"

2456

.format(client_name))

3350

"disabling client {} - Client never "

3351

"performed a successful checker".format(

3352

client_name))

2457

3353

client["enabled"] = False

2458

3354

elif client["last_checker_status"] != 0:

2459

3355

logger.warning(

2460

"disabling client {0} - Client "

2461

"last checker failed with error code {1}"

2462

.format(client_name,

2463

client["last_checker_status"]))

3356

"disabling client {} - Client last"

3357

" checker failed with error code"

3358

" {}".format(

3359

client_name,

3360

client["last_checker_status"]))

2464

3361

client["enabled"] = False

2465

3362

else:

2466

client["expires"] = (datetime.datetime

2467

.utcnow()

2468

+ client["timeout"])

3363

client["expires"] = (

3364

datetime.datetime.utcnow()

3365

+ client["timeout"])

2469

3366

logger.debug("Last checker succeeded,"

2470

" keeping {0} enabled"

2471

.format(client_name))

3367

" keeping {} enabled".format(

3368

client_name))

2472

3369

try:

2473

client["secret"] = (

2474

pgp.decrypt(client["encrypted_secret"],

2475

client_settings[client_name]

2476

["secret"]))

3370

client["secret"] = pgp.decrypt(

3371

client["encrypted_secret"],

3372

client_settings[client_name]["secret"])

2477

3373

except PGPError:

2478

3374

# If decryption fails, we use secret from new settings

2479

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

2480

.format(client_name))

2481

client["secret"] = (

2482

client_settings[client_name]["secret"])

2483

3375

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

3376

client_name))

3377

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

3378

["secret"])

3379

2484

3380

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

2485

3381

for client_name in (set(old_client_settings)

2486

3382

- set(client_settings)):

2488

3384

for client_name in (set(client_settings)

2489

3385

- set(old_client_settings)):

2490

3386

clients_data[client_name] = client_settings[client_name]

2491

3387

2492

3388

# Create all client objects

2493

for client_name, client in clients_data.iteritems():

3389

for client_name, client in clients_data.items():

2494

3390

tcp_server.clients[client_name] = client_class(

2495

name = client_name, settings = client)

2496

3391

name=client_name,

3392

settings=client,

3393

server_settings=server_settings)

3394

2497

3395

if not tcp_server.clients:

2498

3396

logger.warning("No clients defined")

2499

2500

if not debug:

2501

try:

2502

with pidfile:

2503

pid = os.getpid()

2504

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

2505

del pidfile

2506

except IOError:

2507

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

2508

pidfilename, pid)

2509

except NameError:

2510

# "pidfile" was never created

2511

pass

3397

3398

if not foreground:

3399

if pidfile is not None:

3400

pid = os.getpid()

3401

try:

3402

with pidfile:

3403

print(pid, file=pidfile)

3404

except IOError:

3405

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

3406

pidfilename, pid)

3407

del pidfile

2512

3408

del pidfilename

2513

2514

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

2515

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

2516

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

2517

3414

if use_dbus:

2518

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

2519

"se.bsnet.fukt.Mandos"})

2520

class MandosDBusService(DBusObjectWithProperties):

3415

3416

@alternate_dbus_interfaces(

3417

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

3418

class MandosDBusService(DBusObjectWithObjectManager):

2521

3419

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

3420

2522

3421

def __init__(self):

2523

3422

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

3423

2524

3424

_interface = "se.recompile.Mandos"

2525

2526

@dbus_interface_annotations(_interface)

2527

def _foo(self):

2528

return { "org.freedesktop.DBus.Property"

2529

".EmitsChangedSignal":

2530

"false"}

2531

3425

2532

3426

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

2533

3427

def ClientAdded(self, objpath):

2534

3428

"D-Bus signal"

2535

3429

pass

2536

3430

2537

3431

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

2538

def ClientNotFound(self, fingerprint, address):

3432

def ClientNotFound(self, key_id, address):

2539

3433

"D-Bus signal"

2540

3434

pass

2541

3435

3436

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

3437

"true"})

2542

3438

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

2543

3439

def ClientRemoved(self, objpath, name):

2544

3440

"D-Bus signal"

2545

3441

pass

2546

3442

3443

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

3444

"true"})

2547

3445

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

2548

3446

def GetAllClients(self):

2549

3447

"D-Bus method"

2550

return dbus.Array(c.dbus_object_path

2551

for c in

2552

tcp_server.clients.itervalues())

2553

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

2554

3453

@dbus.service.method(_interface,

2555

3454

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

2556

3455

def GetAllClientsWithProperties(self):

2557

3456

"D-Bus method"

2558

3457

return dbus.Dictionary(

2559

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

2560

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

3458

{c.dbus_object_path: c.GetAll(

3459

"se.recompile.Mandos.Client")

3460

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

2561

3461

signature="oa{sv}")

2562

3462

2563

3463

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

2564

3464

def RemoveClient(self, object_path):

2565

3465

"D-Bus method"

2566

for c in tcp_server.clients.itervalues():

3466

for c in tcp_server.clients.values():

2567

3467

if c.dbus_object_path == object_path:

2568

3468

del tcp_server.clients[c.name]

2569

3469

c.remove_from_connection()

2570

# Don't signal anything except ClientRemoved

3470

# Don't signal the disabling

2571

3471

c.disable(quiet=True)

2572

# Emit D-Bus signal

2573

self.ClientRemoved(object_path, c.name)

3472

# Emit D-Bus signal for removal

3473

self.client_removed_signal(c)

2574

3474

return

2575

3475

raise KeyError(object_path)

2576

3476

2577

3477

del _interface

2578

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

2579

3515

mandos_dbus_service = MandosDBusService()

2580

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

2581

3522

def cleanup():

2582

3523

"Cleanup function; run on exit"

2583

service.cleanup()

2584

2585

multiprocessing.active_children()

3524

if zeroconf:

3525

service.cleanup()

3526

3527

mp.active_children()

3528

wn.close()

2586

3529

if not (tcp_server.clients or client_settings):

2587

3530

return

2588

3531

2589

3532

# Store client before exiting. Secrets are encrypted with key

2590

3533

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

2591

3534

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

2592

3535

clients = {}

2593

3536

with PGPEngine() as pgp:

2594

for client in tcp_server.clients.itervalues():

3537

for client in tcp_server.clients.values():

2595

3538

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

2596

3539

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

2597

3540

key)

2598

3541

client_dict = {}

2599

3542

2600

3543

# A list of attributes that can not be pickled

2601

3544

# + secret.

2602

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

2603

"checker"))

2604

for name, typ in (inspect.getmembers

2605

(dbus.service.Object)):

3545

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

3546

"checker", "server_settings"}

3547

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

3548

.Object):

2606

3549

exclude.add(name)

2607

3550

2608

3551

client_dict["encrypted_secret"] = (client

2609

3552

.encrypted_secret)

2610

3553

for attr in client.client_structure:

2611

3554

if attr not in exclude:

2612

3555

client_dict[attr] = getattr(client, attr)

2613

3556

2614

3557

clients[client.name] = client_dict

2615

3558

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

2616

3559

2617

3560

try:

2618

with (tempfile.NamedTemporaryFile

2619

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

2620

dir=os.path.dirname(stored_state_path),

2621

delete=False)) as stored_state:

2622

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

2623

tempname=stored_state.name

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

2624

3570

os.rename(tempname, stored_state_path)

2625

3571

except (IOError, OSError) as e:

2626

3572

if not debug:

2629

3575

except NameError:

2630

3576

pass

2631

3577

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

2632

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

3578

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

2633

3579

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

2634

3580

else:

2635

3581

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

2636

3582

exc_info=e)

2637

raise e

2638

3583

raise

3584

2639

3585

# Delete all clients, and settings from config

2640

3586

while tcp_server.clients:

2641

3587

name, client = tcp_server.clients.popitem()

2642

3588

if use_dbus:

2643

3589

client.remove_from_connection()

2644

# Don't signal anything except ClientRemoved

3590

# Don't signal the disabling

2645

3591

client.disable(quiet=True)

3592

# Emit D-Bus signal for removal

2646

3593

if use_dbus:

2647

# Emit D-Bus signal

2648

mandos_dbus_service.ClientRemoved(client

2649

.dbus_object_path,

2650

client.name)

3594

mandos_dbus_service.client_removed_signal(client)

2651

3595

client_settings.clear()

2652

3596

2653

3597

atexit.register(cleanup)

2654

2655

for client in tcp_server.clients.itervalues():

3598

3599

for client in tcp_server.clients.values():

2656

3600

if use_dbus:

2657

# Emit D-Bus signal

2658

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3601

# Emit D-Bus signal for adding

3602

mandos_dbus_service.client_added_signal(client)

2659

3603

# Need to initiate checking of clients

2660

3604

if client.enabled:

2661

3605

client.init_checker()

2662

3606

2663

3607

tcp_server.enable()

2664

3608

tcp_server.server_activate()

2665

3609

2666

3610

# Find out what port we got

2667

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

3611

if zeroconf:

3612

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

2668

3613

if use_ipv6:

2669

3614

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

2670

3615

" flowinfo %d, scope_id %d",

2672

3617

else: # IPv4

2673

3618

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

2674

3619

*tcp_server.socket.getsockname())

2675

2676

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

2677

3620

3621

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

3622

2678

3623

try:

2679

# From the Avahi example code

2680

try:

2681

service.activate()

2682

except dbus.exceptions.DBusException as error:

2683

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

2684

cleanup()

2685

sys.exit(1)

2686

# End of Avahi example code

2687

2688

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

2689

lambda *args, **kwargs:

2690

(tcp_server.handle_request

2691

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

2692

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

2693

3640

logger.debug("Starting main loop")

2694

3641

main_loop.run()

2695

3642

except AvahiError as error:

2704

3651

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

2705

3652

cleanup()

2706

3653

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

2707

3671

if __name__ == '__main__':

2708

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